secure/lib/libssl/man/SSL_read.3

   1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
   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 turned on, 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_read 3"
 136 .TH SSL_read 3 "2015-06-12" "1.0.1o" "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_read \- read bytes from a TLS/SSL connection.
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& int SSL_read(SSL *ssl, void *buf, int num);
 149 .Ve
 150 .SH "DESCRIPTION"
 151 .IX Header "DESCRIPTION"
 152 \&\fISSL_read()\fR tries to read \fBnum\fR bytes from the specified \fBssl\fR into the
 153 buffer \fBbuf\fR.
 154 .SH "NOTES"
 155 .IX Header "NOTES"
 156 If necessary, \fISSL_read()\fR will negotiate a \s-1TLS/SSL\s0 session, if
 157 not already explicitly performed by \fISSL_connect\fR\|(3) or
 158 \&\fISSL_accept\fR\|(3). If the
 159 peer requests a re-negotiation, it will be performed transparently during
 160 the \fISSL_read()\fR operation. The behaviour of \fISSL_read()\fR depends on the
 161 underlying \s-1BIO. \s0
 162 .PP
 163 For the transparent negotiation to succeed, the \fBssl\fR must have been
 164 initialized to client or server mode. This is being done by calling
 165 \&\fISSL_set_connect_state\fR\|(3) or \fISSL_set_accept_state()\fR
 166 before the first call to an \fISSL_read()\fR or \fISSL_write\fR\|(3)
 167 function.
 168 .PP
 169 \&\fISSL_read()\fR works based on the \s-1SSL/TLS\s0 records. The data are received in
 170 records (with a maximum record size of 16kB for SSLv3/TLSv1). Only when a
 171 record has been completely received, it can be processed (decryption and
 172 check of integrity). Therefore data that was not retrieved at the last
 173 call of \fISSL_read()\fR can still be buffered inside the \s-1SSL\s0 layer and will be
 174 retrieved on the next call to \fISSL_read()\fR. If \fBnum\fR is higher than the
 175 number of bytes buffered, \fISSL_read()\fR will return with the bytes buffered.
 176 If no more bytes are in the buffer, \fISSL_read()\fR will trigger the processing
 177 of the next record. Only when the record has been received and processed
 178 completely, \fISSL_read()\fR will return reporting success. At most the contents
 179 of the record will be returned. As the size of an \s-1SSL/TLS\s0 record may exceed
 180 the maximum packet size of the underlying transport (e.g. \s-1TCP\s0), it may
 181 be necessary to read several packets from the transport layer before the
 182 record is complete and \fISSL_read()\fR can succeed.
 183 .PP
 184 If the underlying \s-1BIO\s0 is \fBblocking\fR, \fISSL_read()\fR will only return, once the
 185 read operation has been finished or an error occurred, except when a
 186 renegotiation take place, in which case a \s-1SSL_ERROR_WANT_READ\s0 may occur.
 187 This behaviour can be controlled with the \s-1SSL_MODE_AUTO_RETRY\s0 flag of the
 188 \&\fISSL_CTX_set_mode\fR\|(3) call.
 189 .PP
 190 If the underlying \s-1BIO\s0 is \fBnon-blocking\fR, \fISSL_read()\fR will also return
 191 when the underlying \s-1BIO\s0 could not satisfy the needs of \fISSL_read()\fR
 192 to continue the operation. In this case a call to
 193 \&\fISSL_get_error\fR\|(3) with the
 194 return value of \fISSL_read()\fR will yield \fB\s-1SSL_ERROR_WANT_READ\s0\fR or
 195 \&\fB\s-1SSL_ERROR_WANT_WRITE\s0\fR. As at any time a re-negotiation is possible, a
 196 call to \fISSL_read()\fR can also cause write operations! The calling process
 197 then must repeat the call after taking appropriate action to satisfy the
 198 needs of \fISSL_read()\fR. The action depends on the underlying \s-1BIO.\s0 When using a
 199 non-blocking socket, nothing is to be done, but \fIselect()\fR can be used to check
 200 for the required condition. When using a buffering \s-1BIO,\s0 like a \s-1BIO\s0 pair, data
 201 must be written into or retrieved out of the \s-1BIO\s0 before being able to continue.
 202 .PP
 203 \&\fISSL_pending\fR\|(3) can be used to find out whether there
 204 are buffered bytes available for immediate retrieval. In this case
 205 \&\fISSL_read()\fR can be called without blocking or actually receiving new
 206 data from the underlying socket.
 207 .SH "WARNING"
 208 .IX Header "WARNING"
 209 When an \fISSL_read()\fR operation has to be repeated because of
 210 \&\fB\s-1SSL_ERROR_WANT_READ\s0\fR or \fB\s-1SSL_ERROR_WANT_WRITE\s0\fR, it must be repeated
 211 with the same arguments.
 212 .SH "RETURN VALUES"
 213 .IX Header "RETURN VALUES"
 214 The following return values can occur:
 215 .IP ">0" 4
 216 .IX Item ">0"
 217 The read operation was successful; the return value is the number of
 218 bytes actually read from the \s-1TLS/SSL\s0 connection.
 219 .IP "0" 4
 220 The read operation was not successful. The reason may either be a clean
 221 shutdown due to a \*(L"close notify\*(R" alert sent by the peer (in which case
 222 the \s-1SSL_RECEIVED_SHUTDOWN\s0 flag in the ssl shutdown state is set
 223 (see \fISSL_shutdown\fR\|(3),
 224 \&\fISSL_set_shutdown\fR\|(3)). It is also possible, that
 225 the peer simply shut down the underlying transport and the shutdown is
 226 incomplete. Call \fISSL_get_error()\fR with the return value \fBret\fR to find out,
 227 whether an error occurred or the connection was shut down cleanly
 228 (\s-1SSL_ERROR_ZERO_RETURN\s0).
 229 .Sp
 230 SSLv2 (deprecated) does not support a shutdown alert protocol, so it can
 231 only be detected, whether the underlying connection was closed. It cannot
 232 be checked, whether the closure was initiated by the peer or by something
 233 else.
 234 .IP "<0" 4
 235 .IX Item "<0"
 236 The read operation was not successful, because either an error occurred
 237 or action must be taken by the calling process. Call \fISSL_get_error()\fR with the
 238 return value \fBret\fR to find out the reason.
 239 .SH "SEE ALSO"
 240 .IX Header "SEE ALSO"
 241 \&\fISSL_get_error\fR\|(3), \fISSL_write\fR\|(3),
 242 \&\fISSL_CTX_set_mode\fR\|(3), \fISSL_CTX_new\fR\|(3),
 243 \&\fISSL_connect\fR\|(3), \fISSL_accept\fR\|(3)
 244 \&\fISSL_set_connect_state\fR\|(3),
 245 \&\fISSL_pending\fR\|(3),
 246 \&\fISSL_shutdown\fR\|(3), \fISSL_set_shutdown\fR\|(3),
 247 \&\fIssl\fR\|(3), \fIbio\fR\|(3)