diff options
| author | cvs2svn <admin@example.com> | 2015-08-02 21:54:23 +0000 |
|---|---|---|
| committer | cvs2svn <admin@example.com> | 2015-08-02 21:54:23 +0000 |
| commit | 67fcb4ef3942fb3a0f1e18f8ebbe7464120d485a (patch) | |
| tree | 5609c82060f75c53af0a7641d9b33a88574876cd /src/lib/libssl/doc/SSL_CTX_set_mode.3 | |
| parent | ed40f444ba01bcae1d8540f9c26d79537ab5baf2 (diff) | |
| download | openbsd-libressl-v2.2.2.tar.gz openbsd-libressl-v2.2.2.tar.bz2 openbsd-libressl-v2.2.2.zip | |
This commit was manufactured by cvs2git to create branch 'OPENBSD_5_8'.libressl-v2.2.2
Diffstat (limited to 'src/lib/libssl/doc/SSL_CTX_set_mode.3')
| -rw-r--r-- | src/lib/libssl/doc/SSL_CTX_set_mode.3 | 126 |
1 files changed, 0 insertions, 126 deletions
diff --git a/src/lib/libssl/doc/SSL_CTX_set_mode.3 b/src/lib/libssl/doc/SSL_CTX_set_mode.3 deleted file mode 100644 index 2a3fcd5531..0000000000 --- a/src/lib/libssl/doc/SSL_CTX_set_mode.3 +++ /dev/null | |||
| @@ -1,126 +0,0 @@ | |||
| 1 | .\" | ||
| 2 | .\" $OpenBSD: SSL_CTX_set_mode.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ | ||
| 3 | .\" | ||
| 4 | .Dd $Mdocdate: December 2 2014 $ | ||
| 5 | .Dt SSL_CTX_SET_MODE 3 | ||
| 6 | .Os | ||
| 7 | .Sh NAME | ||
| 8 | .Nm SSL_CTX_set_mode , | ||
| 9 | .Nm SSL_set_mode , | ||
| 10 | .Nm SSL_CTX_get_mode , | ||
| 11 | .Nm SSL_get_mode | ||
| 12 | .Nd manipulate SSL engine mode | ||
| 13 | .Sh SYNOPSIS | ||
| 14 | .In openssl/ssl.h | ||
| 15 | .Ft long | ||
| 16 | .Fn SSL_CTX_set_mode "SSL_CTX *ctx" "long mode" | ||
| 17 | .Ft long | ||
| 18 | .Fn SSL_set_mode "SSL *ssl" "long mode" | ||
| 19 | .Ft long | ||
| 20 | .Fn SSL_CTX_get_mode "SSL_CTX *ctx" | ||
| 21 | .Ft long | ||
| 22 | .Fn SSL_get_mode "SSL *ssl" | ||
| 23 | .Sh DESCRIPTION | ||
| 24 | .Fn SSL_CTX_set_mode | ||
| 25 | adds the mode set via bitmask in | ||
| 26 | .Fa mode | ||
| 27 | to | ||
| 28 | .Fa ctx . | ||
| 29 | Options already set before are not cleared. | ||
| 30 | .Pp | ||
| 31 | .Fn SSL_set_mode | ||
| 32 | adds the mode set via bitmask in | ||
| 33 | .Fa mode | ||
| 34 | to | ||
| 35 | .Fa ssl . | ||
| 36 | Options already set before are not cleared. | ||
| 37 | .Pp | ||
| 38 | .Fn SSL_CTX_get_mode | ||
| 39 | returns the mode set for | ||
| 40 | .Fa ctx . | ||
| 41 | .Pp | ||
| 42 | .Fn SSL_get_mode | ||
| 43 | returns the mode set for | ||
| 44 | .Fa ssl . | ||
| 45 | .Sh NOTES | ||
| 46 | The following mode changes are available: | ||
| 47 | .Bl -tag -width Ds | ||
| 48 | .It Dv SSL_MODE_ENABLE_PARTIAL_WRITE | ||
| 49 | Allow | ||
| 50 | .Fn SSL_write ... n | ||
| 51 | to return | ||
| 52 | .Ms r | ||
| 53 | with | ||
| 54 | .EQ | ||
| 55 | 0 < r < n | ||
| 56 | .EN | ||
| 57 | (i.e., report success when just a single record has been written). | ||
| 58 | When not set (the default), | ||
| 59 | .Xr SSL_write 3 | ||
| 60 | will only report success once the complete chunk was written. | ||
| 61 | Once | ||
| 62 | .Xr SSL_write 3 | ||
| 63 | returns with | ||
| 64 | .Ms r , | ||
| 65 | .Ms r | ||
| 66 | bytes have been successfully written and the next call to | ||
| 67 | .Xr SSL_write 3 | ||
| 68 | must only send the | ||
| 69 | .Ms n \(mi r | ||
| 70 | bytes left, imitating the behaviour of | ||
| 71 | .Xr write 2 . | ||
| 72 | .It Dv SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER | ||
| 73 | Make it possible to retry | ||
| 74 | .Xr SSL_write 3 | ||
| 75 | with changed buffer location (the buffer contents must stay the same). | ||
| 76 | This is not the default to avoid the misconception that non-blocking | ||
| 77 | .Xr SSL_write 3 | ||
| 78 | behaves like non-blocking | ||
| 79 | .Xr write 2 . | ||
| 80 | .It Dv SSL_MODE_AUTO_RETRY | ||
| 81 | Never bother the application with retries if the transport is blocking. | ||
| 82 | If a renegotiation take place during normal operation, a | ||
| 83 | .Xr SSL_read 3 | ||
| 84 | or | ||
| 85 | .Xr SSL_write 3 | ||
| 86 | would return | ||
| 87 | with \(mi1 and indicate the need to retry with | ||
| 88 | .Dv SSL_ERROR_WANT_READ . | ||
| 89 | In a non-blocking environment applications must be prepared to handle | ||
| 90 | incomplete read/write operations. | ||
| 91 | In a blocking environment, applications are not always prepared to deal with | ||
| 92 | read/write operations returning without success report. | ||
| 93 | The flag | ||
| 94 | .Dv SSL_MODE_AUTO_RETRY | ||
| 95 | will cause read/write operations to only return after the handshake and | ||
| 96 | successful completion. | ||
| 97 | .It Dv SSL_MODE_RELEASE_BUFFERS | ||
| 98 | When we no longer need a read buffer or a write buffer for a given | ||
| 99 | .Vt SSL , | ||
| 100 | then release the memory we were using to hold it. | ||
| 101 | Released memory is either appended to a list of unused RAM chunks on the | ||
| 102 | .Vt SSL_CTX , | ||
| 103 | or simply freed if the list of unused chunks would become longer than | ||
| 104 | .Va "SSL_CTX->freelist_max_len" , | ||
| 105 | which defaults to 32. | ||
| 106 | Using this flag can save around 34k per idle SSL connection. | ||
| 107 | This flag has no effect on SSL v2 connections, or on DTLS connections. | ||
| 108 | .El | ||
| 109 | .Sh RETURN VALUES | ||
| 110 | .Fn SSL_CTX_set_mode | ||
| 111 | and | ||
| 112 | .Fn SSL_set_mode | ||
| 113 | return the new mode bitmask after adding | ||
| 114 | .Fa mode . | ||
| 115 | .Pp | ||
| 116 | .Fn SSL_CTX_get_mode | ||
| 117 | and | ||
| 118 | .Fn SSL_get_mode | ||
| 119 | return the current bitmask. | ||
| 120 | .Sh SEE ALSO | ||
| 121 | .Xr ssl 3 , | ||
| 122 | .Xr SSL_read 3 , | ||
| 123 | .Xr SSL_write 3 | ||
| 124 | .Sh HISTORY | ||
| 125 | .Dv SSL_MODE_AUTO_RETRY | ||
| 126 | was added in OpenSSL 0.9.6. | ||
