diff options
Diffstat (limited to 'src/lib/libssl/doc/SSL_want.3')
| -rw-r--r-- | src/lib/libssl/doc/SSL_want.3 | 103 |
1 files changed, 0 insertions, 103 deletions
diff --git a/src/lib/libssl/doc/SSL_want.3 b/src/lib/libssl/doc/SSL_want.3 deleted file mode 100644 index e9513c8793..0000000000 --- a/src/lib/libssl/doc/SSL_want.3 +++ /dev/null | |||
| @@ -1,103 +0,0 @@ | |||
| 1 | .\" | ||
| 2 | .\" $OpenBSD: SSL_want.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ | ||
| 3 | .\" | ||
| 4 | .Dd $Mdocdate: December 2 2014 $ | ||
| 5 | .Dt SSL_WANT 3 | ||
| 6 | .Os | ||
| 7 | .Sh NAME | ||
| 8 | .Nm SSL_want , | ||
| 9 | .Nm SSL_want_nothing , | ||
| 10 | .Nm SSL_want_read , | ||
| 11 | .Nm SSL_want_write , | ||
| 12 | .Nm SSL_want_x509_lookup | ||
| 13 | .Nd obtain state information TLS/SSL I/O operation | ||
| 14 | .Sh SYNOPSIS | ||
| 15 | .In openssl/ssl.h | ||
| 16 | .Ft int | ||
| 17 | .Fn SSL_want "const SSL *ssl" | ||
| 18 | .Ft int | ||
| 19 | .Fn SSL_want_nothing "const SSL *ssl" | ||
| 20 | .Ft int | ||
| 21 | .Fn SSL_want_read "const SSL *ssl" | ||
| 22 | .Ft int | ||
| 23 | .Fn SSL_want_write "const SSL *ssl" | ||
| 24 | .Ft int | ||
| 25 | .Fn SSL_want_x509_lookup "const SSL *ssl" | ||
| 26 | .Sh DESCRIPTION | ||
| 27 | .Fn SSL_want | ||
| 28 | returns state information for the | ||
| 29 | .Vt SSL | ||
| 30 | object | ||
| 31 | .Fa ssl . | ||
| 32 | .Pp | ||
| 33 | The other | ||
| 34 | .Fn SSL_want_* | ||
| 35 | calls are shortcuts for the possible states returned by | ||
| 36 | .Fn SSL_want . | ||
| 37 | .Sh NOTES | ||
| 38 | .Fn SSL_want | ||
| 39 | examines the internal state information of the | ||
| 40 | .Vt SSL | ||
| 41 | object. | ||
| 42 | Its return values are similar to those of | ||
| 43 | .Xr SSL_get_error 3 . | ||
| 44 | Unlike | ||
| 45 | .Xr SSL_get_error 3 , | ||
| 46 | which also evaluates the error queue, | ||
| 47 | the results are obtained by examining an internal state flag only. | ||
| 48 | The information must therefore only be used for normal operation under | ||
| 49 | non-blocking I/O. | ||
| 50 | Error conditions are not handled and must be treated using | ||
| 51 | .Xr SSL_get_error 3 . | ||
| 52 | .Pp | ||
| 53 | The result returned by | ||
| 54 | .Fn SSL_want | ||
| 55 | should always be consistent with the result of | ||
| 56 | .Xr SSL_get_error 3 . | ||
| 57 | .Sh RETURN VALUES | ||
| 58 | The following return values can currently occur for | ||
| 59 | .Fn SSL_want : | ||
| 60 | .Bl -tag -width Ds | ||
| 61 | .It .Dv SSL_NOTHING | ||
| 62 | There is no data to be written or to be read. | ||
| 63 | .It .Dv SSL_WRITING | ||
| 64 | There are data in the SSL buffer that must be written to the underlying | ||
| 65 | .Vt BIO | ||
| 66 | layer in order to complete the actual | ||
| 67 | .Fn SSL_* | ||
| 68 | operation. | ||
| 69 | A call to | ||
| 70 | .Xr SSL_get_error 3 | ||
| 71 | should return | ||
| 72 | .Dv SSL_ERROR_WANT_WRITE . | ||
| 73 | .It Dv SSL_READING | ||
| 74 | More data must be read from the underlying | ||
| 75 | .Vt BIO | ||
| 76 | layer in order to | ||
| 77 | complete the actual | ||
| 78 | .Fn SSL_* | ||
| 79 | operation. | ||
| 80 | A call to | ||
| 81 | .Xr SSL_get_error 3 | ||
| 82 | should return | ||
| 83 | .Dv SSL_ERROR_WANT_READ. | ||
| 84 | .It Dv SSL_X509_LOOKUP | ||
| 85 | The operation did not complete because an application callback set by | ||
| 86 | .Xr SSL_CTX_set_client_cert_cb 3 | ||
| 87 | has asked to be called again. | ||
| 88 | A call to | ||
| 89 | .Xr SSL_get_error 3 | ||
| 90 | should return | ||
| 91 | .Dv SSL_ERROR_WANT_X509_LOOKUP . | ||
| 92 | .El | ||
| 93 | .Pp | ||
| 94 | .Fn SSL_want_nothing , | ||
| 95 | .Fn SSL_want_read , | ||
| 96 | .Fn SSL_want_write , | ||
| 97 | and | ||
| 98 | .Fn SSL_want_x509_lookup | ||
| 99 | return 1 when the corresponding condition is true or 0 otherwise. | ||
| 100 | .Sh SEE ALSO | ||
| 101 | .Xr err 3 , | ||
| 102 | .Xr ssl 3 , | ||
| 103 | .Xr SSL_get_error 3 | ||
