diff options
Diffstat (limited to 'src/lib/libssl/doc/SSL_set_fd.3')
| -rw-r--r-- | src/lib/libssl/doc/SSL_set_fd.3 | 73 |
1 files changed, 0 insertions, 73 deletions
diff --git a/src/lib/libssl/doc/SSL_set_fd.3 b/src/lib/libssl/doc/SSL_set_fd.3 deleted file mode 100644 index 94e0c7614a..0000000000 --- a/src/lib/libssl/doc/SSL_set_fd.3 +++ /dev/null | |||
| @@ -1,73 +0,0 @@ | |||
| 1 | .\" | ||
| 2 | .\" $OpenBSD: SSL_set_fd.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ | ||
| 3 | .\" | ||
| 4 | .Dd $Mdocdate: December 2 2014 $ | ||
| 5 | .Dt SSL_SET_FD 3 | ||
| 6 | .Os | ||
| 7 | .Sh NAME | ||
| 8 | .Nm SSL_set_fd , | ||
| 9 | .Nm SSL_set_rfd , | ||
| 10 | .Nm SSL_set_wfd | ||
| 11 | .Nd connect the SSL object with a file descriptor | ||
| 12 | .Sh SYNOPSIS | ||
| 13 | .In openssl/ssl.h | ||
| 14 | .Ft int | ||
| 15 | .Fn SSL_set_fd "SSL *ssl" "int fd" | ||
| 16 | .Ft int | ||
| 17 | .Fn SSL_set_rfd "SSL *ssl" "int fd" | ||
| 18 | .Ft int | ||
| 19 | .Fn SSL_set_wfd "SSL *ssl" "int fd" | ||
| 20 | .Sh DESCRIPTION | ||
| 21 | .Fn SSL_set_fd | ||
| 22 | sets the file descriptor | ||
| 23 | .Fa fd | ||
| 24 | as the input/output facility for the TLS/SSL (encrypted) side of | ||
| 25 | .Fa ssl . | ||
| 26 | .Fa fd | ||
| 27 | will typically be the socket file descriptor of a network connection. | ||
| 28 | .Pp | ||
| 29 | When performing the operation, a socket | ||
| 30 | .Vt BIO | ||
| 31 | is automatically created to interface between the | ||
| 32 | .Fa ssl | ||
| 33 | and | ||
| 34 | .Fa fd . | ||
| 35 | The | ||
| 36 | .Vt BIO | ||
| 37 | and hence the SSL engine inherit the behaviour of | ||
| 38 | .Fa fd . | ||
| 39 | If | ||
| 40 | .Fa fd | ||
| 41 | is non-blocking, the | ||
| 42 | .Fa ssl | ||
| 43 | will also have non-blocking behaviour. | ||
| 44 | .Pp | ||
| 45 | If there was already a | ||
| 46 | .Vt BIO | ||
| 47 | connected to | ||
| 48 | .Fa ssl , | ||
| 49 | .Xr BIO_free 3 | ||
| 50 | will be called (for both the reading and writing side, if different). | ||
| 51 | .Pp | ||
| 52 | .Fn SSL_set_rfd | ||
| 53 | and | ||
| 54 | .Fn SSL_set_wfd | ||
| 55 | perform the respective action, but only for the read channel or the write | ||
| 56 | channel, which can be set independently. | ||
| 57 | .Sh RETURN VALUES | ||
| 58 | The following return values can occur: | ||
| 59 | .Bl -tag -width Ds | ||
| 60 | .It 0 | ||
| 61 | The operation failed. | ||
| 62 | Check the error stack to find out why. | ||
| 63 | .It 1 | ||
| 64 | The operation succeeded. | ||
| 65 | .El | ||
| 66 | .Sh SEE ALSO | ||
| 67 | .Xr bio 3 , | ||
| 68 | .Xr ssl 3 , | ||
| 69 | .Xr SSL_accept 3 , | ||
| 70 | .Xr SSL_connect 3 , | ||
| 71 | .Xr SSL_get_fd 3 , | ||
| 72 | .Xr SSL_set_bio 3 , | ||
| 73 | .Xr SSL_shutdown 3 | ||
