secure/lib/libcrypto/man/man3/SSL_write.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
   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 >0, 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 "2020-09-22" "1.1.1h" "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_ex, 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_ex(SSL *s, const void *buf, size_t num, size_t *written);
 149 \& int SSL_write(SSL *ssl, const void *buf, int num);
 150 .Ve
 151 .SH "DESCRIPTION"
 152 .IX Header "DESCRIPTION"
 153 \&\fBSSL_write_ex()\fR and \fBSSL_write()\fR write \fBnum\fR bytes from the buffer \fBbuf\fR into
 154 the specified \fBssl\fR connection. On success \fBSSL_write_ex()\fR will store the number
 155 of bytes written in \fB*written\fR.
 156 .SH "NOTES"
 157 .IX Header "NOTES"
 158 In the paragraphs below a \*(L"write function\*(R" is defined as one of either
 159 \&\fBSSL_write_ex()\fR, or \fBSSL_write()\fR.
 160 .PP
 161 If necessary, a write function will negotiate a \s-1TLS/SSL\s0 session, if not already
 162 explicitly performed by \fBSSL_connect\fR\|(3) or \fBSSL_accept\fR\|(3). If the peer
 163 requests a re-negotiation, it will be performed transparently during
 164 the write function operation. The behaviour of the write functions depends on the
 165 underlying \s-1BIO.\s0
 166 .PP
 167 For the transparent negotiation to succeed, the \fBssl\fR must have been
 168 initialized to client or server mode. This is being done by calling
 169 \&\fBSSL_set_connect_state\fR\|(3) or \fBSSL_set_accept_state()\fR
 170 before the first call to a write function.
 171 .PP
 172 If the underlying \s-1BIO\s0 is \fBblocking\fR, the write functions will only return, once
 173 the write operation has been finished or an error occurred.
 174 .PP
 175 If the underlying \s-1BIO\s0 is \fBnonblocking\fR the write functions will also return
 176 when the underlying \s-1BIO\s0 could not satisfy the needs of the function to continue
 177 the operation. In this case a call to \fBSSL_get_error\fR\|(3) with the
 178 return value of the write function will yield \fB\s-1SSL_ERROR_WANT_READ\s0\fR
 179 or \fB\s-1SSL_ERROR_WANT_WRITE\s0\fR. As at any time a re-negotiation is possible, a
 180 call to a write function can also cause read operations! The calling process
 181 then must repeat the call after taking appropriate action to satisfy the needs
 182 of the write function. The action depends on the underlying \s-1BIO.\s0 When using a
 183 nonblocking socket, nothing is to be done, but \fBselect()\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 The write functions will only return with success when the complete contents of
 188 \&\fBbuf\fR of length \fBnum\fR has been written. This default behaviour can be changed
 189 with the \s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0 option of \fBSSL_CTX_set_mode\fR\|(3). When
 190 this flag is set the write functions will also return with success when a
 191 partial write has been successfully completed. In this case the write function
 192 operation is considered completed. The bytes are sent and a new write call with
 193 a new buffer (with the already sent bytes removed) must be started. A partial
 194 write is performed with the size of a message block, which is 16kB.
 195 .SH "WARNINGS"
 196 .IX Header "WARNINGS"
 197 When a write function call has to be repeated because \fBSSL_get_error\fR\|(3)
 198 returned \fB\s-1SSL_ERROR_WANT_READ\s0\fR or \fB\s-1SSL_ERROR_WANT_WRITE\s0\fR, it must be repeated
 199 with the same arguments.
 200 The data that was passed might have been partially processed.
 201 When \fB\s-1SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER\s0\fR was set using \fBSSL_CTX_set_mode\fR\|(3)
 202 the pointer can be different, but the data and length should still be the same.
 203 .PP
 204 You should not call \fBSSL_write()\fR with num=0, it will return an error.
 205 \&\fBSSL_write_ex()\fR can be called with num=0, but will not send application data to
 206 the peer.
 207 .SH "RETURN VALUES"
 208 .IX Header "RETURN VALUES"
 209 \&\fBSSL_write_ex()\fR will return 1 for success or 0 for failure. Success means that
 210 all requested application data bytes have been written to the \s-1SSL\s0 connection or,
 211 if \s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0 is in use, at least 1 application data byte has
 212 been written to the \s-1SSL\s0 connection. Failure means that not all the requested
 213 bytes have been written yet (if \s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0 is not in use) or
 214 no bytes could be written to the \s-1SSL\s0 connection (if
 215 \&\s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0 is in use). Failures can be retryable (e.g. the
 216 network write buffer has temporarily filled up) or non-retryable (e.g. a fatal
 217 network error). In the event of a failure call \fBSSL_get_error\fR\|(3) to find out
 218 the reason which indicates whether the call is retryable or not.
 219 .PP
 220 For \fBSSL_write()\fR the following return values can occur:
 221 .IP "> 0" 4
 222 .IX Item "> 0"
 223 The write operation was successful, the return value is the number of
 224 bytes actually written to the \s-1TLS/SSL\s0 connection.
 225 .IP "<= 0" 4
 226 .IX Item "<= 0"
 227 The write operation was not successful, because either the connection was
 228 closed, an error occurred or action must be taken by the calling process.
 229 Call \fBSSL_get_error()\fR with the return value \fBret\fR to find out the reason.
 230 .Sp
 231 Old documentation indicated a difference between 0 and \-1, and that \-1 was
 232 retryable.
 233 You should instead call \fBSSL_get_error()\fR to find out if it's retryable.
 234 .SH "SEE ALSO"
 235 .IX Header "SEE ALSO"
 236 \&\fBSSL_get_error\fR\|(3), \fBSSL_read_ex\fR\|(3), \fBSSL_read\fR\|(3)
 237 \&\fBSSL_CTX_set_mode\fR\|(3), \fBSSL_CTX_new\fR\|(3),
 238 \&\fBSSL_connect\fR\|(3), \fBSSL_accept\fR\|(3)
 239 \&\fBSSL_set_connect_state\fR\|(3),
 240 \&\fBssl\fR\|(7), \fBbio\fR\|(7)
 241 .SH "HISTORY"
 242 .IX Header "HISTORY"
 243 The \fBSSL_write_ex()\fR function was added in OpenSSL 1.1.1.
 244 .SH "COPYRIGHT"
 245 .IX Header "COPYRIGHT"
 246 Copyright 2000\-2020 The OpenSSL Project Authors. All Rights Reserved.
 247 .PP
 248 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 249 this file except in compliance with the License.  You can obtain a copy
 250 in the file \s-1LICENSE\s0 in the source distribution or at
 251 <https://www.openssl.org/source/license.html>.