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

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
   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_STATELESS_COOKIE_GENERATE_CB 3"
 136 .TH SSL_CTX_SET_STATELESS_COOKIE_GENERATE_CB 3 "2020-09-22" "1.1.1h" "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_stateless_cookie_generate_cb, SSL_CTX_set_stateless_cookie_verify_cb, SSL_CTX_set_cookie_generate_cb, SSL_CTX_set_cookie_verify_cb \&\- Callback functions for stateless TLS1.3 cookies
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& void SSL_CTX_set_stateless_cookie_generate_cb(
 149 \&     SSL_CTX *ctx,
 150 \&     int (*gen_stateless_cookie_cb) (SSL *ssl,
 151 \&                                     unsigned char *cookie,
 152 \&                                     size_t *cookie_len));
 153 \& void SSL_CTX_set_stateless_cookie_verify_cb(
 154 \&     SSL_CTX *ctx,
 155 \&     int (*verify_stateless_cookie_cb) (SSL *ssl,
 156 \&                                        const unsigned char *cookie,
 157 \&                                        size_t cookie_len));
 158 \&
 159 \& void SSL_CTX_set_cookie_generate_cb(SSL_CTX *ctx,
 160 \&                                     int (*app_gen_cookie_cb) (SSL *ssl,
 161 \&                                                               unsigned char
 162 \&                                                               *cookie,
 163 \&                                                               unsigned int
 164 \&                                                               *cookie_len));
 165 \& void SSL_CTX_set_cookie_verify_cb(SSL_CTX *ctx,
 166 \&                                   int (*app_verify_cookie_cb) (SSL *ssl,
 167 \&                                                                const unsigned
 168 \&                                                                char *cookie,
 169 \&                                                                unsigned int
 170 \&                                                                cookie_len));
 171 .Ve
 172 .SH "DESCRIPTION"
 173 .IX Header "DESCRIPTION"
 174 \&\fBSSL_CTX_set_stateless_cookie_generate_cb()\fR sets the callback used by
 175 \&\fBSSL_stateless\fR\|(3) to generate the application-controlled portion of the cookie
 176 provided to clients in the HelloRetryRequest transmitted as a response to a
 177 ClientHello with a missing or invalid cookie. \fBgen_stateless_cookie_cb()\fR must
 178 write at most \s-1SSL_COOKIE_LENGTH\s0 bytes into \fBcookie\fR, and must write the number
 179 of bytes written to \fBcookie_len\fR. If a cookie cannot be generated, a zero
 180 return value can be used to abort the handshake.
 181 .PP
 182 \&\fBSSL_CTX_set_stateless_cookie_verify_cb()\fR sets the callback used by
 183 \&\fBSSL_stateless\fR\|(3) to determine whether the application-controlled portion of a
 184 ClientHello cookie is valid. The cookie data is pointed to by \fBcookie\fR and is of
 185 length \fBcookie_len\fR. A nonzero return value from \fBverify_stateless_cookie_cb()\fR
 186 communicates that the cookie is valid. The integrity of the entire cookie,
 187 including the application-controlled portion, is automatically verified by \s-1HMAC\s0
 188 before \fBverify_stateless_cookie_cb()\fR is called.
 189 .PP
 190 \&\fBSSL_CTX_set_cookie_generate_cb()\fR sets the callback used by \fBDTLSv1_listen\fR\|(3)
 191 to generate the cookie provided to clients in the HelloVerifyRequest transmitted
 192 as a response to a ClientHello with a missing or invalid cookie.
 193 \&\fBapp_gen_cookie_cb()\fR  must write at most \s-1DTLS1_COOKIE_LENGTH\s0 bytes into
 194 \&\fBcookie\fR, and must write the number of bytes written to \fBcookie_len\fR. If a
 195 cookie cannot be generated, a zero return value can be used to abort the
 196 handshake.
 197 .PP
 198 \&\fBSSL_CTX_set_cookie_verify_cb()\fR sets the callback used by \fBDTLSv1_listen\fR\|(3) to
 199 determine whether the cookie in a ClientHello is valid. The cookie data is
 200 pointed to by \fBcookie\fR and is of length \fBcookie_len\fR. A nonzero return value
 201 from \fBapp_verify_cookie_cb()\fR communicates that the cookie is valid. The
 202 integrity of the cookie is not verified by OpenSSL. This is an application
 203 responsibility.
 204 .SH "RETURN VALUES"
 205 .IX Header "RETURN VALUES"
 206 Neither function returns a value.
 207 .SH "SEE ALSO"
 208 .IX Header "SEE ALSO"
 209 \&\fBSSL_stateless\fR\|(3),
 210 \&\fBDTLSv1_listen\fR\|(3)
 211 .SH "HISTORY"
 212 .IX Header "HISTORY"
 213 \&\fBSSL_CTX_set_stateless_cookie_generate_cb()\fR and
 214 \&\fBSSL_CTX_set_stateless_cookie_verify_cb()\fR were added in OpenSSL 1.1.1.
 215 .SH "COPYRIGHT"
 216 .IX Header "COPYRIGHT"
 217 Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
 218 .PP
 219 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 220 this file except in compliance with the License.  You can obtain a copy
 221 in the file \s-1LICENSE\s0 in the source distribution or at
 222 <https://www.openssl.org/source/license.html>.