secure/lib/libcrypto/man/SSL_want.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 >0, 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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  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_WANT 3"
 132 .TH SSL_WANT 3 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 SSL_want, SSL_want_nothing, SSL_want_read, SSL_want_write, SSL_want_x509_lookup, SSL_want_async, SSL_want_async_job, SSL_want_client_hello_cb \- obtain state information TLS/SSL I/O operation
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& int SSL_want(const SSL *ssl);
 145 \& int SSL_want_nothing(const SSL *ssl);
 146 \& int SSL_want_read(const SSL *ssl);
 147 \& int SSL_want_write(const SSL *ssl);
 148 \& int SSL_want_x509_lookup(const SSL *ssl);
 149 \& int SSL_want_async(const SSL *ssl);
 150 \& int SSL_want_async_job(const SSL *ssl);
 151 \& int SSL_want_client_hello_cb(const SSL *ssl);
 152 .Ve
 153 .SH "DESCRIPTION"
 154 .IX Header "DESCRIPTION"
 155 \&\fISSL_want()\fR returns state information for the \s-1SSL\s0 object \fBssl\fR.
 156 .PP
 157 The other SSL_want_*() calls are shortcuts for the possible states returned
 158 by \fISSL_want()\fR.
 159 .SH "NOTES"
 160 .IX Header "NOTES"
 161 \&\fISSL_want()\fR examines the internal state information of the \s-1SSL\s0 object. Its
 162 return values are similar to that of \fISSL_get_error\fR\|(3).
 163 Unlike \fISSL_get_error\fR\|(3), which also evaluates the
 164 error queue, the results are obtained by examining an internal state flag
 165 only. The information must therefore only be used for normal operation under
 166 non-blocking I/O. Error conditions are not handled and must be treated
 167 using \fISSL_get_error\fR\|(3).
 168 .PP
 169 The result returned by \fISSL_want()\fR should always be consistent with
 170 the result of \fISSL_get_error\fR\|(3).
 171 .SH "RETURN VALUES"
 172 .IX Header "RETURN VALUES"
 173 The following return values can currently occur for \fISSL_want()\fR:
 174 .IP "\s-1SSL_NOTHING\s0" 4
 175 .IX Item "SSL_NOTHING"
 176 There is no data to be written or to be read.
 177 .IP "\s-1SSL_WRITING\s0" 4
 178 .IX Item "SSL_WRITING"
 179 There are data in the \s-1SSL\s0 buffer that must be written to the underlying
 180 \&\fB\s-1BIO\s0\fR layer in order to complete the actual SSL_*() operation.
 181 A call to \fISSL_get_error\fR\|(3) should return
 182 \&\s-1SSL_ERROR_WANT_WRITE.\s0
 183 .IP "\s-1SSL_READING\s0" 4
 184 .IX Item "SSL_READING"
 185 More data must be read from the underlying \fB\s-1BIO\s0\fR layer in order to
 186 complete the actual SSL_*() operation.
 187 A call to \fISSL_get_error\fR\|(3) should return
 188 \&\s-1SSL_ERROR_WANT_READ.\s0
 189 .IP "\s-1SSL_X509_LOOKUP\s0" 4
 190 .IX Item "SSL_X509_LOOKUP"
 191 The operation did not complete because an application callback set by
 192 \&\fISSL_CTX_set_client_cert_cb()\fR has asked to be called again.
 193 A call to \fISSL_get_error\fR\|(3) should return
 194 \&\s-1SSL_ERROR_WANT_X509_LOOKUP.\s0
 195 .IP "\s-1SSL_ASYNC_PAUSED\s0" 4
 196 .IX Item "SSL_ASYNC_PAUSED"
 197 An asynchronous operation partially completed and was then paused. See
 198 \&\fISSL_get_all_async_fds\fR\|(3). A call to \fISSL_get_error\fR\|(3) should return
 199 \&\s-1SSL_ERROR_WANT_ASYNC.\s0
 200 .IP "\s-1SSL_ASYNC_NO_JOBS\s0" 4
 201 .IX Item "SSL_ASYNC_NO_JOBS"
 202 The asynchronous job could not be started because there were no async jobs
 203 available in the pool (see \fIASYNC_init_thread\fR\|(3)). A call to \fISSL_get_error\fR\|(3)
 204 should return \s-1SSL_ERROR_WANT_ASYNC_JOB.\s0
 205 .IP "\s-1SSL_CLIENT_HELLO_CB\s0" 4
 206 .IX Item "SSL_CLIENT_HELLO_CB"
 207 The operation did not complete because an application callback set by
 208 \&\fISSL_CTX_set_client_hello_cb()\fR has asked to be called again.
 209 A call to \fISSL_get_error\fR\|(3) should return
 210 \&\s-1SSL_ERROR_WANT_CLIENT_HELLO_CB.\s0
 211 .PP
 212 \&\fISSL_want_nothing()\fR, \fISSL_want_read()\fR, \fISSL_want_write()\fR, \fISSL_want_x509_lookup()\fR,
 213 \&\fISSL_want_async()\fR, \fISSL_want_async_job()\fR, and \fISSL_want_client_hello_cb()\fR return
 214 1, when the corresponding condition is true or 0 otherwise.
 215 .SH "SEE ALSO"
 216 .IX Header "SEE ALSO"
 217 \&\fIssl\fR\|(7), \fISSL_get_error\fR\|(3)
 218 .SH "HISTORY"
 219 .IX Header "HISTORY"
 220 \&\fISSL_want_client_hello_cb()\fR and \s-1SSL_CLIENT_HELLO_CB\s0 were added in OpenSSL 1.1.1.
 221 .SH "COPYRIGHT"
 222 .IX Header "COPYRIGHT"
 223 Copyright 2001\-2017 The OpenSSL Project Authors. All Rights Reserved.
 224 .PP
 225 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 226 this file except in compliance with the License.  You can obtain a copy
 227 in the file \s-1LICENSE\s0 in the source distribution or at
 228 <https://www.openssl.org/source/license.html>.