diff options
author | schwarze <> | 2016-12-01 22:45:28 +0000 |
---|---|---|
committer | schwarze <> | 2016-12-01 22:45:28 +0000 |
commit | 72158b75d42817546fba56c787b103bab2dd0d46 (patch) | |
tree | 6014aee9b6eb8980b100344a2e549799e1fa4f15 /src | |
parent | 08d43f4b696ce3f27f1d32153740ead67133a5aa (diff) | |
download | openbsd-72158b75d42817546fba56c787b103bab2dd0d46.tar.gz openbsd-72158b75d42817546fba56c787b103bab2dd0d46.tar.bz2 openbsd-72158b75d42817546fba56c787b103bab2dd0d46.zip |
Add Copyright and license.
Talk about TLS_method() rather than SSLv23_method().
Rename WARNINGS section to CAVEATS.
Diffstat (limited to 'src')
-rw-r--r-- | src/lib/libssl/man/SSL_clear.3 | 94 |
1 files changed, 71 insertions, 23 deletions
diff --git a/src/lib/libssl/man/SSL_clear.3 b/src/lib/libssl/man/SSL_clear.3 index a9e318320f..38194154f0 100644 --- a/src/lib/libssl/man/SSL_clear.3 +++ b/src/lib/libssl/man/SSL_clear.3 | |||
@@ -1,7 +1,55 @@ | |||
1 | .\" $OpenBSD: SSL_clear.3,v 1.2 2016/12/01 22:45:28 schwarze Exp $ | ||
2 | .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 | ||
1 | .\" | 3 | .\" |
2 | .\" $OpenBSD: SSL_clear.3,v 1.1 2016/11/05 15:32:20 schwarze Exp $ | 4 | .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>. |
5 | .\" Copyright (c) 2000, 2001, 2002, 2011, 2015 The OpenSSL Project. | ||
6 | .\" All rights reserved. | ||
3 | .\" | 7 | .\" |
4 | .Dd $Mdocdate: November 5 2016 $ | 8 | .\" Redistribution and use in source and binary forms, with or without |
9 | .\" modification, are permitted provided that the following conditions | ||
10 | .\" are met: | ||
11 | .\" | ||
12 | .\" 1. Redistributions of source code must retain the above copyright | ||
13 | .\" notice, this list of conditions and the following disclaimer. | ||
14 | .\" | ||
15 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
16 | .\" notice, this list of conditions and the following disclaimer in | ||
17 | .\" the documentation and/or other materials provided with the | ||
18 | .\" distribution. | ||
19 | .\" | ||
20 | .\" 3. All advertising materials mentioning features or use of this | ||
21 | .\" software must display the following acknowledgment: | ||
22 | .\" "This product includes software developed by the OpenSSL Project | ||
23 | .\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" | ||
24 | .\" | ||
25 | .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to | ||
26 | .\" endorse or promote products derived from this software without | ||
27 | .\" prior written permission. For written permission, please contact | ||
28 | .\" openssl-core@openssl.org. | ||
29 | .\" | ||
30 | .\" 5. Products derived from this software may not be called "OpenSSL" | ||
31 | .\" nor may "OpenSSL" appear in their names without prior written | ||
32 | .\" permission of the OpenSSL Project. | ||
33 | .\" | ||
34 | .\" 6. Redistributions of any form whatsoever must retain the following | ||
35 | .\" acknowledgment: | ||
36 | .\" "This product includes software developed by the OpenSSL Project | ||
37 | .\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" | ||
38 | .\" | ||
39 | .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY | ||
40 | .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
41 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
42 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR | ||
43 | .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
44 | .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | ||
45 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
46 | .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
47 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | ||
48 | .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
49 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | ||
50 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | ||
51 | .\" | ||
52 | .Dd $Mdocdate: December 1 2016 $ | ||
5 | .Dt SSL_CLEAR 3 | 53 | .Dt SSL_CLEAR 3 |
6 | .Os | 54 | .Os |
7 | .Sh NAME | 55 | .Sh NAME |
@@ -16,7 +64,7 @@ Reset | |||
16 | .Fa ssl | 64 | .Fa ssl |
17 | to allow another connection. | 65 | to allow another connection. |
18 | All settings (method, ciphers, BIOs) are kept. | 66 | All settings (method, ciphers, BIOs) are kept. |
19 | .Sh NOTES | 67 | .Pp |
20 | .Fn SSL_clear | 68 | .Fn SSL_clear |
21 | is used to prepare an | 69 | is used to prepare an |
22 | .Vt SSL | 70 | .Vt SSL |
@@ -45,30 +93,11 @@ So if the session was a TLSv1 session, a | |||
45 | client object will use a TLSv1 client method for the next handshake and a | 93 | client object will use a TLSv1 client method for the next handshake and a |
46 | .Vt SSL | 94 | .Vt SSL |
47 | server object will use a TLSv1 server method, even if | 95 | server object will use a TLSv1 server method, even if |
48 | .Fn SSLv23_*_method Ns s | 96 | .Fn TLS_*_method Ns s |
49 | were chosen on startup. | 97 | were chosen on startup. |
50 | This might lead to connection failures (see | 98 | This might lead to connection failures (see |
51 | .Xr SSL_new 3 ) | 99 | .Xr SSL_new 3 ) |
52 | for a description of the method's properties. | 100 | for a description of the method's properties. |
53 | .Sh WARNINGS | ||
54 | .Fn SSL_clear | ||
55 | resets the | ||
56 | .Vt SSL | ||
57 | object to allow for another connection. | ||
58 | The reset operation however keeps several settings of the last sessions | ||
59 | (some of these settings were made automatically during the last handshake). | ||
60 | It only makes sense for a new connection with the exact same peer that shares | ||
61 | these settings, | ||
62 | and may fail if that peer changes its settings between connections. | ||
63 | Use the sequence | ||
64 | .Xr SSL_get_session 3 ; | ||
65 | .Xr SSL_new 3 ; | ||
66 | .Xr SSL_set_session 3 ; | ||
67 | .Xr SSL_free 3 | ||
68 | instead to avoid such failures (or simply | ||
69 | .Xr SSL_free 3 ; | ||
70 | .Xr SSL_new 3 | ||
71 | if session reuse is not desired). | ||
72 | .Sh RETURN VALUES | 101 | .Sh RETURN VALUES |
73 | The following return values can occur: | 102 | The following return values can occur: |
74 | .Bl -tag -width Ds | 103 | .Bl -tag -width Ds |
@@ -90,3 +119,22 @@ operation was successful. | |||
90 | .Xr SSL_new 3 , | 119 | .Xr SSL_new 3 , |
91 | .Xr SSL_set_shutdown 3 , | 120 | .Xr SSL_set_shutdown 3 , |
92 | .Xr SSL_shutdown 3 | 121 | .Xr SSL_shutdown 3 |
122 | .Sh CAVEATS | ||
123 | .Fn SSL_clear | ||
124 | resets the | ||
125 | .Vt SSL | ||
126 | object to allow for another connection. | ||
127 | The reset operation however keeps several settings of the last sessions | ||
128 | (some of these settings were made automatically during the last handshake). | ||
129 | It only makes sense for a new connection with the exact same peer that shares | ||
130 | these settings, | ||
131 | and may fail if that peer changes its settings between connections. | ||
132 | Use the sequence | ||
133 | .Xr SSL_get_session 3 ; | ||
134 | .Xr SSL_new 3 ; | ||
135 | .Xr SSL_set_session 3 ; | ||
136 | .Xr SSL_free 3 | ||
137 | instead to avoid such failures (or simply | ||
138 | .Xr SSL_free 3 ; | ||
139 | .Xr SSL_new 3 | ||
140 | if session reuse is not desired). | ||