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