secure/lib/libcrypto/man/man3/SSL_CTX_set_mode.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
   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 .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_CTX_SET_MODE 3"
 136 .TH SSL_CTX_SET_MODE 3 "2022-05-03" "1.1.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_CTX_set_mode, SSL_CTX_clear_mode, SSL_set_mode, SSL_clear_mode, SSL_CTX_get_mode, SSL_get_mode \- manipulate SSL engine mode
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& long SSL_CTX_set_mode(SSL_CTX *ctx, long mode);
 149 \& long SSL_CTX_clear_mode(SSL_CTX *ctx, long mode);
 150 \& long SSL_set_mode(SSL *ssl, long mode);
 151 \& long SSL_clear_mode(SSL *ssl, long mode);
 152 \&
 153 \& long SSL_CTX_get_mode(SSL_CTX *ctx);
 154 \& long SSL_get_mode(SSL *ssl);
 155 .Ve
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 \&\fBSSL_CTX_set_mode()\fR adds the mode set via bit mask in \fBmode\fR to \fBctx\fR.
 159 Options already set before are not cleared.
 160 \&\fBSSL_CTX_clear_mode()\fR removes the mode set via bit mask in \fBmode\fR from \fBctx\fR.
 161 .PP
 162 \&\fBSSL_set_mode()\fR adds the mode set via bit mask in \fBmode\fR to \fBssl\fR.
 163 Options already set before are not cleared.
 164 \&\fBSSL_clear_mode()\fR removes the mode set via bit mask in \fBmode\fR from \fBssl\fR.
 165 .PP
 166 \&\fBSSL_CTX_get_mode()\fR returns the mode set for \fBctx\fR.
 167 .PP
 168 \&\fBSSL_get_mode()\fR returns the mode set for \fBssl\fR.
 169 .SH "NOTES"
 170 .IX Header "NOTES"
 171 The following mode changes are available:
 172 .IP "\s-1SSL_MODE_ENABLE_PARTIAL_WRITE\s0" 4
 173 .IX Item "SSL_MODE_ENABLE_PARTIAL_WRITE"
 174 Allow SSL_write_ex(..., n, &r) to return with 0 < r < n (i.e. report success
 175 when just a single record has been written). This works in a similar way for
 176 \&\fBSSL_write()\fR. When not set (the default), \fBSSL_write_ex()\fR or \fBSSL_write()\fR will only
 177 report success once the complete chunk was written. Once \fBSSL_write_ex()\fR or
 178 \&\fBSSL_write()\fR returns successful, \fBr\fR bytes have been written and the next call
 179 to \fBSSL_write_ex()\fR or \fBSSL_write()\fR must only send the n\-r bytes left, imitating
 180 the behaviour of \fBwrite()\fR.
 181 .IP "\s-1SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER\s0" 4
 182 .IX Item "SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER"
 183 Make it possible to retry \fBSSL_write_ex()\fR or \fBSSL_write()\fR with changed buffer
 184 location (the buffer contents must stay the same). This is not the default to
 185 avoid the misconception that nonblocking \fBSSL_write()\fR behaves like
 186 nonblocking \fBwrite()\fR.
 187 .IP "\s-1SSL_MODE_AUTO_RETRY\s0" 4
 188 .IX Item "SSL_MODE_AUTO_RETRY"
 189 During normal operations, non-application data records might need to be sent or
 190 received that the application is not aware of.
 191 If a non-application data record was processed,
 192 \&\fBSSL_read_ex\fR\|(3) and \fBSSL_read\fR\|(3) can return with a failure and indicate the
 193 need to retry with \fB\s-1SSL_ERROR_WANT_READ\s0\fR.
 194 If such a non-application data record was processed, the flag
 195 \&\fB\s-1SSL_MODE_AUTO_RETRY\s0\fR causes it to try to process the next record instead of
 196 returning.
 197 .Sp
 198 In a nonblocking environment applications must be prepared to handle
 199 incomplete read/write operations.
 200 Setting \fB\s-1SSL_MODE_AUTO_RETRY\s0\fR for a nonblocking \fB\s-1BIO\s0\fR will process
 201 non-application data records until either no more data is available or
 202 an application data record has been processed.
 203 .Sp
 204 In a blocking environment, applications are not always prepared to
 205 deal with the functions returning intermediate reports such as retry
 206 requests, and setting the \fB\s-1SSL_MODE_AUTO_RETRY\s0\fR flag will cause the functions
 207 to only return after successfully processing an application data record or a
 208 failure.
 209 .Sp
 210 Turning off \fB\s-1SSL_MODE_AUTO_RETRY\s0\fR can be useful with blocking \fB\s-1BIO\s0\fRs in case
 211 they are used in combination with something like \fBselect()\fR or \fBpoll()\fR.
 212 Otherwise the call to \fBSSL_read()\fR or \fBSSL_read_ex()\fR might hang when a
 213 non-application record was sent and no application data was sent.
 214 .IP "\s-1SSL_MODE_RELEASE_BUFFERS\s0" 4
 215 .IX Item "SSL_MODE_RELEASE_BUFFERS"
 216 When we no longer need a read buffer or a write buffer for a given \s-1SSL,\s0
 217 then release the memory we were using to hold it.
 218 Using this flag can
 219 save around 34k per idle \s-1SSL\s0 connection.
 220 This flag has no effect on \s-1SSL\s0 v2 connections, or on \s-1DTLS\s0 connections.
 221 .IP "\s-1SSL_MODE_SEND_FALLBACK_SCSV\s0" 4
 222 .IX Item "SSL_MODE_SEND_FALLBACK_SCSV"
 223 Send \s-1TLS_FALLBACK_SCSV\s0 in the ClientHello.
 224 To be set only by applications that reconnect with a downgraded protocol
 225 version; see draft\-ietf\-tls\-downgrade\-scsv\-00 for details.
 226 .Sp
 227 \&\s-1DO NOT ENABLE THIS\s0 if your application attempts a normal handshake.
 228 Only use this in explicit fallback retries, following the guidance
 229 in draft\-ietf\-tls\-downgrade\-scsv\-00.
 230 .IP "\s-1SSL_MODE_ASYNC\s0" 4
 231 .IX Item "SSL_MODE_ASYNC"
 232 Enable asynchronous processing. \s-1TLS I/O\s0 operations may indicate a retry with
 233 \&\s-1SSL_ERROR_WANT_ASYNC\s0 with this mode set if an asynchronous capable engine is
 234 used to perform cryptographic operations. See \fBSSL_get_error\fR\|(3).
 235 .IP "\s-1SSL_MODE_DTLS_SCTP_LABEL_LENGTH_BUG\s0" 4
 236 .IX Item "SSL_MODE_DTLS_SCTP_LABEL_LENGTH_BUG"
 237 Older versions of OpenSSL had a bug in the computation of the label length
 238 used for computing the endpoint-pair shared secret. The bug was that the
 239 terminating zero was included in the length of the label. Setting this option
 240 enables this behaviour to allow interoperability with such broken
 241 implementations. Please note that setting this option breaks interoperability
 242 with correct implementations. This option only applies to \s-1DTLS\s0 over \s-1SCTP.\s0
 243 .PP
 244 All modes are off by default except for \s-1SSL_MODE_AUTO_RETRY\s0 which is on by
 245 default since 1.1.1.
 246 .SH "RETURN VALUES"
 247 .IX Header "RETURN VALUES"
 248 \&\fBSSL_CTX_set_mode()\fR and \fBSSL_set_mode()\fR return the new mode bit mask
 249 after adding \fBmode\fR.
 250 .PP
 251 \&\fBSSL_CTX_get_mode()\fR and \fBSSL_get_mode()\fR return the current bit mask.
 252 .SH "SEE ALSO"
 253 .IX Header "SEE ALSO"
 254 \&\fBssl\fR\|(7), \fBSSL_read_ex\fR\|(3), \fBSSL_read\fR\|(3), \fBSSL_write_ex\fR\|(3) or
 255 \&\fBSSL_write\fR\|(3), \fBSSL_get_error\fR\|(3)
 256 .SH "HISTORY"
 257 .IX Header "HISTORY"
 258 \&\s-1SSL_MODE_ASYNC\s0 was added in OpenSSL 1.1.0.
 259 .SH "COPYRIGHT"
 260 .IX Header "COPYRIGHT"
 261 Copyright 2001\-2020 The OpenSSL Project Authors. All Rights Reserved.
 262 .PP
 263 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 264 this file except in compliance with the License.  You can obtain a copy
 265 in the file \s-1LICENSE\s0 in the source distribution or at
 266 <https://www.openssl.org/source/license.html>.