diff options
Diffstat (limited to '')
| -rw-r--r-- | src/lib/libssl/doc/SSL_accept.3 | 113 |
1 files changed, 0 insertions, 113 deletions
diff --git a/src/lib/libssl/doc/SSL_accept.3 b/src/lib/libssl/doc/SSL_accept.3 deleted file mode 100644 index 06465d1955..0000000000 --- a/src/lib/libssl/doc/SSL_accept.3 +++ /dev/null | |||
| @@ -1,113 +0,0 @@ | |||
| 1 | .\" | ||
| 2 | .\" $OpenBSD: SSL_accept.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ | ||
| 3 | .\" | ||
| 4 | .Dd $Mdocdate: December 2 2014 $ | ||
| 5 | .Dt SSL_ACCEPT 3 | ||
| 6 | .Os | ||
| 7 | .Sh NAME | ||
| 8 | .Nm SSL_accept | ||
| 9 | .Nd wait for a TLS/SSL client to initiate a TLS/SSL handshake | ||
| 10 | .Sh SYNOPSIS | ||
| 11 | .In openssl/ssl.h | ||
| 12 | .Ft int | ||
| 13 | .Fn SSL_accept "SSL *ssl" | ||
| 14 | .Sh DESCRIPTION | ||
| 15 | .Fn SSL_accept | ||
| 16 | waits for a TLS/SSL client to initiate the TLS/SSL handshake. | ||
| 17 | The communication channel must already have been set and assigned to the | ||
| 18 | .Fa ssl | ||
| 19 | object by setting an underlying | ||
| 20 | .Vt BIO . | ||
| 21 | .Sh NOTES | ||
| 22 | The behaviour of | ||
| 23 | .Fn SSL_accept | ||
| 24 | depends on the underlying | ||
| 25 | .Vt BIO . | ||
| 26 | .Pp | ||
| 27 | If the underlying | ||
| 28 | .Vt BIO | ||
| 29 | is | ||
| 30 | .Em blocking , | ||
| 31 | .Fn SSL_accept | ||
| 32 | will only return once the handshake has been finished or an error occurred, | ||
| 33 | except for SGC (Server Gated Cryptography). | ||
| 34 | For SGC, | ||
| 35 | .Fn SSL_accept | ||
| 36 | may return with \(mi1, but | ||
| 37 | .Fn SSL_get_error | ||
| 38 | will yield | ||
| 39 | .Dv SSL_ERROR_WANT_READ/WRITE | ||
| 40 | and | ||
| 41 | .Fn SSL_accept | ||
| 42 | should be called again. | ||
| 43 | .Pp | ||
| 44 | If the underlying | ||
| 45 | .Vt BIO | ||
| 46 | is | ||
| 47 | .Em non-blocking , | ||
| 48 | .Fn SSL_accept | ||
| 49 | will also return when the underlying | ||
| 50 | .Vt BIO | ||
| 51 | could not satisfy the needs of | ||
| 52 | .Fn SSL_accept | ||
| 53 | to continue the handshake, indicating the problem by the return value \(mi1. | ||
| 54 | In this case a call to | ||
| 55 | .Xr SSL_get_error 3 | ||
| 56 | with the | ||
| 57 | return value of | ||
| 58 | .Fn SSL_accept | ||
| 59 | will yield | ||
| 60 | .Dv SSL_ERROR_WANT_READ | ||
| 61 | or | ||
| 62 | .Dv SSL_ERROR_WANT_WRITE . | ||
| 63 | The calling process then must repeat the call after taking appropriate action | ||
| 64 | to satisfy the needs of | ||
| 65 | .Fn SSL_accept . | ||
| 66 | The action depends on the underlying | ||
| 67 | .Dv BIO . | ||
| 68 | When using a non-blocking socket, nothing is to be done, but | ||
| 69 | .Xr select 2 | ||
| 70 | can be used to check for the required condition. | ||
| 71 | When using a buffering | ||
| 72 | .Vt BIO , | ||
| 73 | like a | ||
| 74 | .Vt BIO | ||
| 75 | pair, data must be written into or retrieved out of the | ||
| 76 | .Vt BIO | ||
| 77 | before being able to continue. | ||
| 78 | .Sh RETURN VALUES | ||
| 79 | The following return values can occur: | ||
| 80 | .Bl -tag -width Ds | ||
| 81 | .It 0 | ||
| 82 | The TLS/SSL handshake was not successful but was shut down controlled and by | ||
| 83 | the specifications of the TLS/SSL protocol. | ||
| 84 | Call | ||
| 85 | .Xr SSL_get_error 3 | ||
| 86 | with the return value | ||
| 87 | .Fa ret | ||
| 88 | to find out the reason. | ||
| 89 | .It 1 | ||
| 90 | The TLS/SSL handshake was successfully completed, | ||
| 91 | and a TLS/SSL connection has been established. | ||
| 92 | .It <0 | ||
| 93 | The TLS/SSL handshake was not successful because a fatal error occurred either | ||
| 94 | at the protocol level or a connection failure occurred. | ||
| 95 | The shutdown was not clean. | ||
| 96 | It can also occur of action is need to continue the operation for non-blocking | ||
| 97 | .Vt BIO Ns | ||
| 98 | s. | ||
| 99 | Call | ||
| 100 | .Xr SSL_get_error 3 | ||
| 101 | with the return value | ||
| 102 | .Fa ret | ||
| 103 | to find out the reason. | ||
| 104 | .El | ||
| 105 | .Sh SEE ALSO | ||
| 106 | .Xr bio 3 , | ||
| 107 | .Xr ssl 3 , | ||
| 108 | .Xr SSL_connect 3 , | ||
| 109 | .Xr SSL_CTX_new 3 , | ||
| 110 | .Xr SSL_do_handshake 3 , | ||
| 111 | .Xr SSL_get_error 3 , | ||
| 112 | .Xr SSL_set_connect_state 3 , | ||
| 113 | .Xr SSL_shutdown 3 | ||
