secure/lib/libssl/man/SSL_write.3

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