diff options
author | schwarze <> | 2016-12-04 12:27:43 +0000 |
---|---|---|
committer | schwarze <> | 2016-12-04 12:27:43 +0000 |
commit | 9d7dbc5ee41b7cbb9e16e3542a0ef4b5e4546728 (patch) | |
tree | 992b91df608831dd3b94e2249b168af5e4e09c0d | |
parent | 8b4a8b7f4cd7579b4b12dfade02c11cf7db6284f (diff) | |
download | openbsd-9d7dbc5ee41b7cbb9e16e3542a0ef4b5e4546728.tar.gz openbsd-9d7dbc5ee41b7cbb9e16e3542a0ef4b5e4546728.tar.bz2 openbsd-9d7dbc5ee41b7cbb9e16e3542a0ef4b5e4546728.zip |
Add Copyright and license.
Stop talking about SSLv2 and SSLv3.
Some minor tweaks.
-rw-r--r-- | src/lib/libssl/man/SSL_write.3 | 73 |
1 files changed, 59 insertions, 14 deletions
diff --git a/src/lib/libssl/man/SSL_write.3 b/src/lib/libssl/man/SSL_write.3 index a4db3d37de..b3cf9bfaec 100644 --- a/src/lib/libssl/man/SSL_write.3 +++ b/src/lib/libssl/man/SSL_write.3 | |||
@@ -1,7 +1,54 @@ | |||
1 | .\" $OpenBSD: SSL_write.3,v 1.2 2016/12/04 12:27:43 schwarze Exp $ | ||
2 | .\" OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 | ||
1 | .\" | 3 | .\" |
2 | .\" $OpenBSD: SSL_write.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 The OpenSSL Project. All rights reserved. | ||
3 | .\" | 6 | .\" |
4 | .Dd $Mdocdate: November 5 2016 $ | 7 | .\" Redistribution and use in source and binary forms, with or without |
8 | .\" modification, are permitted provided that the following conditions | ||
9 | .\" are met: | ||
10 | .\" | ||
11 | .\" 1. Redistributions of source code must retain the above copyright | ||
12 | .\" notice, this list of conditions and the following disclaimer. | ||
13 | .\" | ||
14 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
15 | .\" notice, this list of conditions and the following disclaimer in | ||
16 | .\" the documentation and/or other materials provided with the | ||
17 | .\" distribution. | ||
18 | .\" | ||
19 | .\" 3. All advertising materials mentioning features or use of this | ||
20 | .\" software must display the following acknowledgment: | ||
21 | .\" "This product includes software developed by the OpenSSL Project | ||
22 | .\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" | ||
23 | .\" | ||
24 | .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to | ||
25 | .\" endorse or promote products derived from this software without | ||
26 | .\" prior written permission. For written permission, please contact | ||
27 | .\" openssl-core@openssl.org. | ||
28 | .\" | ||
29 | .\" 5. Products derived from this software may not be called "OpenSSL" | ||
30 | .\" nor may "OpenSSL" appear in their names without prior written | ||
31 | .\" permission of the OpenSSL Project. | ||
32 | .\" | ||
33 | .\" 6. Redistributions of any form whatsoever must retain the following | ||
34 | .\" acknowledgment: | ||
35 | .\" "This product includes software developed by the OpenSSL Project | ||
36 | .\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" | ||
37 | .\" | ||
38 | .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY | ||
39 | .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
40 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
41 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR | ||
42 | .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
43 | .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | ||
44 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
45 | .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
46 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | ||
47 | .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | ||
49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | ||
50 | .\" | ||
51 | .Dd $Mdocdate: December 4 2016 $ | ||
5 | .Dt SSL_WRITE 3 | 52 | .Dt SSL_WRITE 3 |
6 | .Os | 53 | .Os |
7 | .Sh NAME | 54 | .Sh NAME |
@@ -20,7 +67,7 @@ bytes from the buffer | |||
20 | into the specified | 67 | into the specified |
21 | .Fa ssl | 68 | .Fa ssl |
22 | connection. | 69 | connection. |
23 | .Sh NOTES | 70 | .Pp |
24 | If necessary, | 71 | If necessary, |
25 | .Fn SSL_write | 72 | .Fn SSL_write |
26 | will negotiate a TLS/SSL session, if not already explicitly performed by | 73 | will negotiate a TLS/SSL session, if not already explicitly performed by |
@@ -101,7 +148,7 @@ pair, data must be written into or retrieved out of the BIO before being able | |||
101 | to continue. | 148 | to continue. |
102 | .Pp | 149 | .Pp |
103 | .Fn SSL_write | 150 | .Fn SSL_write |
104 | will only return with success, when the complete contents of | 151 | will only return with success when the complete contents of |
105 | .Fa buf | 152 | .Fa buf |
106 | of length | 153 | of length |
107 | .Fa num | 154 | .Fa num |
@@ -121,12 +168,14 @@ The bytes are sent and a new | |||
121 | .Fn SSL_write | 168 | .Fn SSL_write |
122 | operation with a new buffer (with the already sent bytes removed) must be | 169 | operation with a new buffer (with the already sent bytes removed) must be |
123 | started. | 170 | started. |
124 | A partial write is performed with the size of a message block, which is 16kB | 171 | A partial write is performed with the size of a message block, |
125 | for SSLv3/TLSv1. | 172 | which is 16kB. |
126 | .Sh WARNING | 173 | .Pp |
127 | When an | 174 | When an |
128 | .Fn SSL_write | 175 | .Fn SSL_write |
129 | operation has to be repeated because of | 176 | operation has to be repeated because |
177 | .Xr SSL_get_error 3 | ||
178 | returned | ||
130 | .Dv SSL_ERROR_WANT_READ | 179 | .Dv SSL_ERROR_WANT_READ |
131 | or | 180 | or |
132 | .Dv SSL_ERROR_WANT_WRITE , | 181 | .Dv SSL_ERROR_WANT_WRITE , |
@@ -135,8 +184,8 @@ it must be repeated with the same arguments. | |||
135 | When calling | 184 | When calling |
136 | .Fn SSL_write | 185 | .Fn SSL_write |
137 | with | 186 | with |
138 | .Fa num Ns | 187 | .Fa num Ns =0 |
139 | =0 bytes to be sent the behaviour is undefined. | 188 | bytes to be sent, the behaviour is undefined. |
140 | .Sh RETURN VALUES | 189 | .Sh RETURN VALUES |
141 | The following return values can occur: | 190 | The following return values can occur: |
142 | .Bl -tag -width Ds | 191 | .Bl -tag -width Ds |
@@ -152,10 +201,6 @@ Call | |||
152 | with the return value to find out whether an error occurred or the connection | 201 | with the return value to find out whether an error occurred or the connection |
153 | was shut down cleanly | 202 | was shut down cleanly |
154 | .Pq Dv SSL_ERROR_ZERO_RETURN . | 203 | .Pq Dv SSL_ERROR_ZERO_RETURN . |
155 | .Pp | ||
156 | SSLv2 (deprecated) does not support a shutdown alert protocol, so it can only | ||
157 | be detected whether the underlying connection was closed. | ||
158 | It cannot be checked why the closure happened. | ||
159 | .It <0 | 204 | .It <0 |
160 | The write operation was not successful, because either an error occurred or | 205 | The write operation was not successful, because either an error occurred or |
161 | action must be taken by the calling process. | 206 | action must be taken by the calling process. |