secure/lib/libssl/man/SSL_write.3

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