crypto/external/bsd/openssl/lib/libcrypto/man/SSL_write.3

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