diff options
Diffstat (limited to 'static/freebsd/man3/SSL_free.3')
| -rw-r--r-- | static/freebsd/man3/SSL_free.3 | 135 |
1 files changed, 135 insertions, 0 deletions
diff --git a/static/freebsd/man3/SSL_free.3 b/static/freebsd/man3/SSL_free.3 new file mode 100644 index 00000000..55bcbcec --- /dev/null +++ b/static/freebsd/man3/SSL_free.3 @@ -0,0 +1,135 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is >0, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.\" +.\" Avoid warning from groff about undefined register 'F'. +.de IX +.. +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} +. \} +.\} +.rr rF +.\" +.\" Required to disable full justification in groff 1.23.0. +.if n .ds AD l +.\" ======================================================================== +.\" +.IX Title "SSL_FREE 3ossl" +.TH SSL_FREE 3ossl 2026-04-07 3.5.6 OpenSSL +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH NAME +SSL_free \- free an allocated SSL structure +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 1 +\& #include <openssl/ssl.h> +\& +\& void SSL_free(SSL *ssl); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +\&\fBSSL_free()\fR decrements the reference count of \fBssl\fR, and removes the SSL +structure pointed to by \fBssl\fR and frees up the allocated memory if the +reference count has reached 0. +If \fBssl\fR is NULL nothing is done. +.SH NOTES +.IX Header "NOTES" +\&\fBSSL_free()\fR also calls the \fBfree()\fRing procedures for indirectly affected items, if +applicable: the buffering BIO, the read and write BIOs, +cipher lists specially created for this \fBssl\fR, the \fBSSL_SESSION\fR. +Do not explicitly free these indirectly freed up items before or after +calling \fBSSL_free()\fR, as trying to free things twice may lead to program +failure. +.PP +The ssl session has reference counts from two users: the SSL object, for +which the reference count is removed by \fBSSL_free()\fR and the internal +session cache. If the session is considered bad, because +\&\fBSSL_shutdown\fR\|(3) was not called for the connection +and \fBSSL_set_shutdown\fR\|(3) was not used to set the +SSL_SENT_SHUTDOWN state, the session will also be removed +from the session cache as required by RFC2246. +.PP +When used to free a QUIC stream SSL object, the respective sending and receiving +parts of the stream are reset unless those parts have already been concluded +normally: +.IP \(bu 4 +If the stream has a sending part (in other words, if it is bidirectional or a +locally\-initiated unidirectional stream) and that part has not been concluded +via a call to \fBSSL_stream_conclude\fR\|(3) or \fBSSL_stream_reset\fR\|(3) on the QUIC +stream SSL object, a call to \fBSSL_free()\fR automatically resets the sending part of +the stream as though \fBSSL_stream_reset\fR\|(3) were called with a QUIC application +error code of 0. +.IP \(bu 4 +If the stream has a receiving part (in other words, if it is bidirectional or a +remotely\-initiated unidirectional stream), and the peer has not yet concluded +that part of the stream normally (such as via a call to +\&\fBSSL_stream_conclude\fR\|(3) on its own end), a call to \fBSSL_free()\fR automatically +requests the reset of the receiving part of the stream using a QUIC STOP_SENDING +frame with a QUIC application error code of 0. Note that as per the QUIC +protocol, this will automatically cause the peer to reset that part of the +stream in turn (which is its sending part). +.PP +A QUIC stream SSL object maintains a reference to a QUIC connection SSL object +internally, therefore a QUIC stream SSL object and its parent QUIC connection +SSL object can be freed in either order. +.SH "RETURN VALUES" +.IX Header "RETURN VALUES" +\&\fBSSL_free()\fR does not provide diagnostic information. +.PP +\&\fBSSL_new\fR\|(3), \fBSSL_clear\fR\|(3), +\&\fBSSL_shutdown\fR\|(3), \fBSSL_set_shutdown\fR\|(3), +\&\fBssl\fR\|(7) +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +.PP +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +<https://www.openssl.org/source/license.html>. |