openssl: Adjust manual pages for 1.0.1o.
[dragonfly.git] / secure / lib / libssl / man / SSL_write.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 .    if \nF \{
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74 .    \" fudge factors for nroff and troff
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 .    \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "SSL_write 3"
136 .TH SSL_write 3 "2015-06-12" "1.0.1o" "OpenSSL"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 SSL_write \- write bytes to a TLS/SSL connection.
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 .Vb 1
146 \& #include <openssl/ssl.h>
147 \&
148 \& int SSL_write(SSL *ssl, const void *buf, int num);
149 .Ve
150 .SH "DESCRIPTION"
151 .IX Header "DESCRIPTION"
152 \&\fISSL_write()\fR writes \fBnum\fR bytes from the buffer \fBbuf\fR into the specified
153 \&\fBssl\fR connection.
154 .SH "NOTES"
155 .IX Header "NOTES"
156 If necessary, \fISSL_write()\fR will negotiate a \s-1TLS/SSL\s0 session, if
157 not already explicitly performed by \fISSL_connect\fR\|(3) or
158 \&\fISSL_accept\fR\|(3). If the
159 peer requests a re-negotiation, it will be performed transparently during
160 the \fISSL_write()\fR operation. The behaviour of \fISSL_write()\fR depends on the
161 underlying \s-1BIO. \s0
162 .PP
163 For the transparent negotiation to succeed, the \fBssl\fR must have been
164 initialized to client or server mode. This is being done by calling
165 \&\fISSL_set_connect_state\fR\|(3) or \fISSL_set_accept_state()\fR
166 before the first call to an \fISSL_read\fR\|(3) or \fISSL_write()\fR function.
167 .PP
168 If the underlying \s-1BIO\s0 is \fBblocking\fR, \fISSL_write()\fR will only return, once the
169 write operation has been finished or an error occurred, except when a
170 renegotiation take place, in which case a \s-1SSL_ERROR_WANT_READ\s0 may occur. 
171 This behaviour can be controlled with the \s-1SSL_MODE_AUTO_RETRY\s0 flag of the
172 \&\fISSL_CTX_set_mode\fR\|(3) call.
173 .PP
174 If the underlying \s-1BIO\s0 is \fBnon-blocking\fR, \fISSL_write()\fR will also return,
175 when the underlying \s-1BIO\s0 could not satisfy the needs of \fISSL_write()\fR
176 to continue the operation. In this case a call to
177 \&\fISSL_get_error\fR\|(3) with the
178 return value of \fISSL_write()\fR will yield \fB\s-1SSL_ERROR_WANT_READ\s0\fR or
179 \&\fB\s-1SSL_ERROR_WANT_WRITE\s0\fR. As at any time a re-negotiation is possible, a
180 call to \fISSL_write()\fR can also cause read operations! The calling process
181 then must repeat the call after taking appropriate action to satisfy the
182 needs of \fISSL_write()\fR. The action depends on the underlying \s-1BIO.\s0 When using a
183 non-blocking socket, nothing is to be done, but \fIselect()\fR can be used to check
184 for the required condition. When using a buffering \s-1BIO,\s0 like a \s-1BIO\s0 pair, data
185 must be written into or retrieved out of the \s-1BIO\s0 before being able to continue.
186 .PP
187 \&\fISSL_write()\fR will only return with success, when the complete contents
188 of \fBbuf\fR of length \fBnum\fR has been written. This default behaviour
189 can be changed with the \s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0 option of
190 \&\fISSL_CTX_set_mode\fR\|(3). When this flag is set,
191 \&\fISSL_write()\fR will also return with success, when a partial write has been
192 successfully completed. In this case the \fISSL_write()\fR operation is considered
193 completed. The bytes are sent and a new \fISSL_write()\fR operation with a new
194 buffer (with the already sent bytes removed) must be started.
195 A partial write is performed with the size of a message block, which is
196 16kB for SSLv3/TLSv1.
197 .SH "WARNING"
198 .IX Header "WARNING"
199 When an \fISSL_write()\fR operation has to be repeated because of
200 \&\fB\s-1SSL_ERROR_WANT_READ\s0\fR or \fB\s-1SSL_ERROR_WANT_WRITE\s0\fR, it must be repeated
201 with the same arguments.
202 .PP
203 When calling \fISSL_write()\fR with num=0 bytes to be sent the behaviour is
204 undefined.
205 .SH "RETURN VALUES"
206 .IX Header "RETURN VALUES"
207 The following return values can occur:
208 .IP ">0" 4
209 .IX Item ">0"
210 The write operation was successful, the return value is the number of
211 bytes actually written to the \s-1TLS/SSL\s0 connection.
212 .IP "0" 4
213 The write operation was not successful. Probably the underlying connection
214 was closed. Call \fISSL_get_error()\fR with the return value \fBret\fR to find out,
215 whether an error occurred or the connection was shut down cleanly
216 (\s-1SSL_ERROR_ZERO_RETURN\s0).
217 .Sp
218 SSLv2 (deprecated) does not support a shutdown alert protocol, so it can
219 only be detected, whether the underlying connection was closed. It cannot
220 be checked, why the closure happened.
221 .IP "<0" 4
222 .IX Item "<0"
223 The write operation was not successful, because either an error occurred
224 or action must be taken by the calling process. Call \fISSL_get_error()\fR with the
225 return value \fBret\fR to find out the reason.
226 .SH "SEE ALSO"
227 .IX Header "SEE ALSO"
228 \&\fISSL_get_error\fR\|(3), \fISSL_read\fR\|(3),
229 \&\fISSL_CTX_set_mode\fR\|(3), \fISSL_CTX_new\fR\|(3),
230 \&\fISSL_connect\fR\|(3), \fISSL_accept\fR\|(3)
231 \&\fISSL_set_connect_state\fR\|(3),
232 \&\fIssl\fR\|(3), \fIbio\fR\|(3)