secure/lib/libcrypto/man/SSL_CTX_set_alpn_select_cb.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_CTX_SET_ALPN_SELECT_CB 3"
 132 .TH SSL_CTX_SET_ALPN_SELECT_CB 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_CTX_set_alpn_protos, SSL_set_alpn_protos, SSL_CTX_set_alpn_select_cb, SSL_CTX_set_next_proto_select_cb, SSL_CTX_set_next_protos_advertised_cb, SSL_select_next_proto, SSL_get0_alpn_selected, SSL_get0_next_proto_negotiated \&\- handle application layer protocol negotiation (ALPN)
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const unsigned char *protos,
 145 \&                             unsigned int protos_len);
 146 \& int SSL_set_alpn_protos(SSL *ssl, const unsigned char *protos,
 147 \&                         unsigned int protos_len);
 148 \& void SSL_CTX_set_alpn_select_cb(SSL_CTX *ctx,
 149 \&                                 int (*cb) (SSL *ssl,
 150 \&                                            const unsigned char **out,
 151 \&                                            unsigned char *outlen,
 152 \&                                            const unsigned char *in,
 153 \&                                            unsigned int inlen,
 154 \&                                            void *arg), void *arg);
 155 \& void SSL_get0_alpn_selected(const SSL *ssl, const unsigned char **data,
 156 \&                             unsigned int *len);
 157 \&
 158 \& void SSL_CTX_set_next_protos_advertised_cb(SSL_CTX *ctx,
 159 \&                                            int (*cb)(SSL *ssl,
 160 \&                                                      const unsigned char **out,
 161 \&                                                      unsigned int *outlen,
 162 \&                                                      void *arg),
 163 \&                                            void *arg);
 164 \& void SSL_CTX_set_next_proto_select_cb(SSL_CTX *ctx,
 165 \&                               int (*cb)(SSL *s,
 166 \&                                         unsigned char **out,
 167 \&                                         unsigned char *outlen,
 168 \&                                         const unsigned char *in,
 169 \&                                         unsigned int inlen,
 170 \&                                         void *arg),
 171 \&                               void *arg);
 172 \& int SSL_select_next_proto(unsigned char **out, unsigned char *outlen,
 173 \&                           const unsigned char *server,
 174 \&                           unsigned int server_len,
 175 \&                           const unsigned char *client,
 176 \&                           unsigned int client_len)
 177 \& void SSL_get0_next_proto_negotiated(const SSL *s, const unsigned char **data,
 178 \&                             unsigned *len);
 179 .Ve
 180 .SH "DESCRIPTION"
 181 .IX Header "DESCRIPTION"
 182 \&\fISSL_CTX_set_alpn_protos()\fR and \fISSL_set_alpn_protos()\fR are used by the client to
 183 set the list of protocols available to be negotiated. The \fBprotos\fR must be in
 184 protocol-list format, described below. The length of \fBprotos\fR is specified in
 185 \&\fBprotos_len\fR.
 186 .PP
 187 \&\fISSL_CTX_set_alpn_select_cb()\fR sets the application callback \fBcb\fR used by a
 188 server to select which protocol to use for the incoming connection. When \fBcb\fR
 189 is \s-1NULL, ALPN\s0 is not used. The \fBarg\fR value is a pointer which is passed to
 190 the application callback.
 191 .PP
 192 \&\fBcb\fR is the application defined callback. The \fBin\fR, \fBinlen\fR parameters are a
 193 vector in protocol-list format. The value of the \fBout\fR, \fBoutlen\fR vector
 194 should be set to the value of a single protocol selected from the \fBin\fR,
 195 \&\fBinlen\fR vector. The \fBout\fR buffer may point directly into \fBin\fR, or to a
 196 buffer that outlives the handshake. The \fBarg\fR parameter is the pointer set via
 197 \&\fISSL_CTX_set_alpn_select_cb()\fR.
 198 .PP
 199 \&\fISSL_select_next_proto()\fR is a helper function used to select protocols. It
 200 implements the standard protocol selection. It is expected that this function
 201 is called from the application callback \fBcb\fR. The protocol data in \fBserver\fR,
 202 \&\fBserver_len\fR and \fBclient\fR, \fBclient_len\fR must be in the protocol-list format
 203 described below. The first item in the \fBserver\fR, \fBserver_len\fR list that
 204 matches an item in the \fBclient\fR, \fBclient_len\fR list is selected, and returned
 205 in \fBout\fR, \fBoutlen\fR. The \fBout\fR value will point into either \fBserver\fR or
 206 \&\fBclient\fR, so it should be copied immediately. If no match is found, the first
 207 item in \fBclient\fR, \fBclient_len\fR is returned in \fBout\fR, \fBoutlen\fR. This
 208 function can also be used in the \s-1NPN\s0 callback.
 209 .PP
 210 \&\fISSL_CTX_set_next_proto_select_cb()\fR sets a callback \fBcb\fR that is called when a
 211 client needs to select a protocol from the server's provided list, and a
 212 user-defined pointer argument \fBarg\fR which will be passed to this callback.
 213 For the callback itself, \fBout\fR
 214 must be set to point to the selected protocol (which may be within \fBin\fR).
 215 The length of the protocol name must be written into \fBoutlen\fR. The
 216 server's advertised protocols are provided in \fBin\fR and \fBinlen\fR. The
 217 callback can assume that \fBin\fR is syntactically valid. The client must
 218 select a protocol. It is fatal to the connection if this callback returns
 219 a value other than \fB\s-1SSL_TLSEXT_ERR_OK\s0\fR. The \fBarg\fR parameter is the pointer
 220 set via \fISSL_CTX_set_next_proto_select_cb()\fR.
 221 .PP
 222 \&\fISSL_CTX_set_next_protos_advertised_cb()\fR sets a callback \fBcb\fR that is called
 223 when a \s-1TLS\s0 server needs a list of supported protocols for Next Protocol
 224 Negotiation. The returned list must be in protocol-list format, described
 225 below.  The list is
 226 returned by setting \fBout\fR to point to it and \fBoutlen\fR to its length. This
 227 memory will not be modified, but the \fB\s-1SSL\s0\fR does keep a
 228 reference to it. The callback should return \fB\s-1SSL_TLSEXT_ERR_OK\s0\fR if it
 229 wishes to advertise. Otherwise, no such extension will be included in the
 230 ServerHello.
 231 .PP
 232 \&\fISSL_get0_alpn_selected()\fR returns a pointer to the selected protocol in \fBdata\fR
 233 with length \fBlen\fR. It is not NUL-terminated. \fBdata\fR is set to \s-1NULL\s0 and \fBlen\fR
 234 is set to 0 if no protocol has been selected. \fBdata\fR must not be freed.
 235 .PP
 236 \&\fISSL_get0_next_proto_negotiated()\fR sets \fBdata\fR and \fBlen\fR to point to the
 237 client's requested protocol for this connection. If the client did not
 238 request any protocol or \s-1NPN\s0 is not enabled, then \fBdata\fR is set to \s-1NULL\s0 and
 239 \&\fBlen\fR to 0. Note that
 240 the client can request any protocol it chooses. The value returned from
 241 this function need not be a member of the list of supported protocols
 242 provided by the callback.
 243 .SH "NOTES"
 244 .IX Header "NOTES"
 245 The protocol-lists must be in wire-format, which is defined as a vector of
 246 non-empty, 8\-bit length-prefixed, byte strings. The length-prefix byte is not
 247 included in the length. Each string is limited to 255 bytes. A byte-string
 248 length of 0 is invalid. A truncated byte-string is invalid. The length of the
 249 vector is not in the vector itself, but in a separate variable.
 250 .PP
 251 Example:
 252 .PP
 253 .Vb 5
 254 \& unsigned char vector[] = {
 255 \&     6, \*(Aqs\*(Aq, \*(Aqp\*(Aq, \*(Aqd\*(Aq, \*(Aqy\*(Aq, \*(Aq/\*(Aq, \*(Aq1\*(Aq,
 256 \&     8, \*(Aqh\*(Aq, \*(Aqt\*(Aq, \*(Aqt\*(Aq, \*(Aqp\*(Aq, \*(Aq/\*(Aq, \*(Aq1\*(Aq, \*(Aq.\*(Aq, \*(Aq1\*(Aq
 257 \& };
 258 \& unsigned int length = sizeof(vector);
 259 .Ve
 260 .PP
 261 The \s-1ALPN\s0 callback is executed after the servername callback; as that servername
 262 callback may update the \s-1SSL_CTX,\s0 and subsequently, the \s-1ALPN\s0 callback.
 263 .PP
 264 If there is no \s-1ALPN\s0 proposed in the ClientHello, the \s-1ALPN\s0 callback is not
 265 invoked.
 266 .SH "RETURN VALUES"
 267 .IX Header "RETURN VALUES"
 268 \&\fISSL_CTX_set_alpn_protos()\fR and \fISSL_set_alpn_protos()\fR return 0 on success, and
 269 non\-0 on failure. \s-1WARNING:\s0 these functions reverse the return value convention.
 270 .PP
 271 \&\fISSL_select_next_proto()\fR returns one of the following:
 272 .IP "\s-1OPENSSL_NPN_NEGOTIATED\s0" 4
 273 .IX Item "OPENSSL_NPN_NEGOTIATED"
 274 A match was found and is returned in \fBout\fR, \fBoutlen\fR.
 275 .IP "\s-1OPENSSL_NPN_NO_OVERLAP\s0" 4
 276 .IX Item "OPENSSL_NPN_NO_OVERLAP"
 277 No match was found. The first item in \fBclient\fR, \fBclient_len\fR is returned in
 278 \&\fBout\fR, \fBoutlen\fR.
 279 .PP
 280 The \s-1ALPN\s0 select callback \fBcb\fR, must return one of the following:
 281 .IP "\s-1SSL_TLSEXT_ERR_OK\s0" 4
 282 .IX Item "SSL_TLSEXT_ERR_OK"
 283 \&\s-1ALPN\s0 protocol selected.
 284 .IP "\s-1SSL_TLSEXT_ERR_ALERT_FATAL\s0" 4
 285 .IX Item "SSL_TLSEXT_ERR_ALERT_FATAL"
 286 There was no overlap between the client's supplied list and the server
 287 configuration.
 288 .IP "\s-1SSL_TLSEXT_ERR_NOACK\s0" 4
 289 .IX Item "SSL_TLSEXT_ERR_NOACK"
 290 \&\s-1ALPN\s0 protocol not selected, e.g., because no \s-1ALPN\s0 protocols are configured for
 291 this connection.
 292 .PP
 293 The callback set using \fISSL_CTX_set_next_proto_select_cb()\fR should return
 294 \&\fB\s-1SSL_TLSEXT_ERR_OK\s0\fR if successful. Any other value is fatal to the connection.
 295 .PP
 296 The callback set using \fISSL_CTX_set_next_protos_advertised_cb()\fR should return
 297 \&\fB\s-1SSL_TLSEXT_ERR_OK\s0\fR if it wishes to advertise. Otherwise, no such extension
 298 will be included in the ServerHello.
 299 .SH "SEE ALSO"
 300 .IX Header "SEE ALSO"
 301 \&\fIssl\fR\|(7), \fISSL_CTX_set_tlsext_servername_callback\fR\|(3),
 302 \&\fISSL_CTX_set_tlsext_servername_arg\fR\|(3)
 303 .SH "COPYRIGHT"
 304 .IX Header "COPYRIGHT"
 305 Copyright 2016\-2017 The OpenSSL Project Authors. All Rights Reserved.
 306 .PP
 307 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 308 this file except in compliance with the License.  You can obtain a copy
 309 in the file \s-1LICENSE\s0 in the source distribution or at
 310 <https://www.openssl.org/source/license.html>.