secure/lib/libssl/man/SSL_write.3

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