| 1 |
|
.\" $MidnightBSD$ |
| 2 |
< |
.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) |
| 2 |
> |
.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) |
| 3 |
|
.\" |
| 4 |
|
.\" Standard preamble: |
| 5 |
|
.\" ======================================================================== |
| 47 |
|
.ie \n(.g .ds Aq \(aq |
| 48 |
|
.el .ds Aq ' |
| 49 |
|
.\" |
| 50 |
< |
.\" If the F register is turned on, we'll generate index entries on stderr for |
| 50 |
> |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 51 |
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 52 |
|
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 53 |
|
.\" output yourself in some meaningful fashion. |
| 55 |
|
.\" Avoid warning from groff about undefined register 'F'. |
| 56 |
|
.de IX |
| 57 |
|
.. |
| 58 |
< |
.nr rF 0 |
| 59 |
< |
.if \n(.g .if rF .nr rF 1 |
| 60 |
< |
.if (\n(rF:(\n(.g==0)) \{ |
| 61 |
< |
. if \nF \{ |
| 62 |
< |
. de IX |
| 63 |
< |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 58 |
> |
.if !\nF .nr F 0 |
| 59 |
> |
.if \nF>0 \{\ |
| 60 |
> |
. de IX |
| 61 |
> |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 62 |
|
.. |
| 63 |
< |
. if !\nF==2 \{ |
| 64 |
< |
. nr % 0 |
| 65 |
< |
. nr F 2 |
| 68 |
< |
. \} |
| 63 |
> |
. if !\nF==2 \{\ |
| 64 |
> |
. nr % 0 |
| 65 |
> |
. nr F 2 |
| 66 |
|
. \} |
| 67 |
|
.\} |
| 71 |
– |
.rr rF |
| 68 |
|
.\" |
| 69 |
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 70 |
|
.\" Fear. Run. Save yourself. No user-serviceable parts. |
| 130 |
|
.\" ======================================================================== |
| 131 |
|
.\" |
| 132 |
|
.IX Title "BIO_f_ssl 3" |
| 133 |
< |
.TH BIO_f_ssl 3 "2016-09-22" "1.0.1u" "OpenSSL" |
| 133 |
> |
.TH BIO_f_ssl 3 "2018-11-20" "1.0.2q" "OpenSSL" |
| 134 |
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 135 |
|
.\" way too many mistakes in technical documents. |
| 136 |
|
.if n .ad l |
| 169 |
|
.SH "DESCRIPTION" |
| 170 |
|
.IX Header "DESCRIPTION" |
| 171 |
|
\&\fIBIO_f_ssl()\fR returns the \s-1SSL BIO\s0 method. This is a filter \s-1BIO\s0 which |
| 172 |
< |
is a wrapper round the OpenSSL \s-1SSL\s0 routines adding a \s-1BIO \s0\*(L"flavour\*(R" to |
| 173 |
< |
\&\s-1SSL I/O. \s0 |
| 172 |
> |
is a wrapper round the OpenSSL \s-1SSL\s0 routines adding a \s-1BIO\s0 \*(L"flavour\*(R" to |
| 173 |
> |
\&\s-1SSL I/O.\s0 |
| 174 |
|
.PP |
| 175 |
|
I/O performed on an \s-1SSL BIO\s0 communicates using the \s-1SSL\s0 protocol with |
| 176 |
|
the SSLs read and write BIOs. If an \s-1SSL\s0 connection is not established |
| 187 |
|
If the close flag is set when an \s-1SSL BIO\s0 is freed then the internal |
| 188 |
|
\&\s-1SSL\s0 structure is also freed using \fISSL_free()\fR. |
| 189 |
|
.PP |
| 190 |
< |
\&\fIBIO_set_ssl()\fR sets the internal \s-1SSL\s0 pointer of \s-1BIO \s0\fBb\fR to \fBssl\fR using |
| 190 |
> |
\&\fIBIO_set_ssl()\fR sets the internal \s-1SSL\s0 pointer of \s-1BIO\s0 \fBb\fR to \fBssl\fR using |
| 191 |
|
the close flag \fBc\fR. |
| 192 |
|
.PP |
| 193 |
< |
\&\fIBIO_get_ssl()\fR retrieves the \s-1SSL\s0 pointer of \s-1BIO \s0\fBb\fR, it can then be |
| 193 |
> |
\&\fIBIO_get_ssl()\fR retrieves the \s-1SSL\s0 pointer of \s-1BIO\s0 \fBb\fR, it can then be |
| 194 |
|
manipulated using the standard \s-1SSL\s0 library functions. |
| 195 |
|
.PP |
| 196 |
|
\&\fIBIO_set_ssl_mode()\fR sets the \s-1SSL BIO\s0 mode to \fBclient\fR. If \fBclient\fR |
| 208 |
|
\&\fIBIO_get_num_renegotiates()\fR returns the total number of session |
| 209 |
|
renegotiations due to I/O or timeout. |
| 210 |
|
.PP |
| 211 |
< |
\&\fIBIO_new_ssl()\fR allocates an \s-1SSL BIO\s0 using \s-1SSL_CTX \s0\fBctx\fR and using |
| 211 |
> |
\&\fIBIO_new_ssl()\fR allocates an \s-1SSL BIO\s0 using \s-1SSL_CTX\s0 \fBctx\fR and using |
| 212 |
|
client mode if \fBclient\fR is non zero. |
| 213 |
|
.PP |
| 214 |
|
\&\fIBIO_new_ssl_connect()\fR creates a new \s-1BIO\s0 chain consisting of an |
| 215 |
< |
\&\s-1SSL BIO \s0(using \fBctx\fR) followed by a connect \s-1BIO.\s0 |
| 215 |
> |
\&\s-1SSL BIO\s0 (using \fBctx\fR) followed by a connect \s-1BIO.\s0 |
| 216 |
|
.PP |
| 217 |
|
\&\fIBIO_new_buffer_ssl_connect()\fR creates a new \s-1BIO\s0 chain consisting |
| 218 |
< |
of a buffering \s-1BIO,\s0 an \s-1SSL BIO \s0(using \fBctx\fR) and a connect |
| 218 |
> |
of a buffering \s-1BIO,\s0 an \s-1SSL BIO\s0 (using \fBctx\fR) and a connect |
| 219 |
|
\&\s-1BIO.\s0 |
| 220 |
|
.PP |
| 221 |
|
\&\fIBIO_ssl_copy_session_id()\fR copies an \s-1SSL\s0 session id between |
| 241 |
|
is non blocking they can still request a retry in exceptional |
| 242 |
|
circumstances. Specifically this will happen if a session |
| 243 |
|
renegotiation takes place during a \fIBIO_read()\fR operation, one |
| 244 |
< |
case where this happens is when \s-1SGC\s0 or step up occurs. |
| 244 |
> |
case where this happens is when step up occurs. |
| 245 |
|
.PP |
| 246 |
|
In OpenSSL 0.9.6 and later the \s-1SSL\s0 flag \s-1SSL_AUTO_RETRY\s0 can be |
| 247 |
|
set to disable this behaviour. That is when this flag is set |
