Restore compatibility with GOST2001 implementations.
[openssl.git] / ssl / statem / extensions.c
1 /*
2  * Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include <string.h>
11 #include "internal/nelem.h"
12 #include "internal/cryptlib.h"
13 #include "../ssl_locl.h"
14 #include "statem_locl.h"
15 #include "internal/cryptlib.h"
16
17 static int final_renegotiate(SSL *s, unsigned int context, int sent);
18 static int init_server_name(SSL *s, unsigned int context);
19 static int final_server_name(SSL *s, unsigned int context, int sent);
20 #ifndef OPENSSL_NO_EC
21 static int final_ec_pt_formats(SSL *s, unsigned int context, int sent);
22 #endif
23 static int init_session_ticket(SSL *s, unsigned int context);
24 #ifndef OPENSSL_NO_OCSP
25 static int init_status_request(SSL *s, unsigned int context);
26 #endif
27 #ifndef OPENSSL_NO_NEXTPROTONEG
28 static int init_npn(SSL *s, unsigned int context);
29 #endif
30 static int init_alpn(SSL *s, unsigned int context);
31 static int final_alpn(SSL *s, unsigned int context, int sent);
32 static int init_sig_algs_cert(SSL *s, unsigned int context);
33 static int init_sig_algs(SSL *s, unsigned int context);
34 static int init_certificate_authorities(SSL *s, unsigned int context);
35 static EXT_RETURN tls_construct_certificate_authorities(SSL *s, WPACKET *pkt,
36                                                         unsigned int context,
37                                                         X509 *x,
38                                                         size_t chainidx);
39 static int tls_parse_certificate_authorities(SSL *s, PACKET *pkt,
40                                              unsigned int context, X509 *x,
41                                              size_t chainidx);
42 #ifndef OPENSSL_NO_SRP
43 static int init_srp(SSL *s, unsigned int context);
44 #endif
45 static int init_etm(SSL *s, unsigned int context);
46 static int init_ems(SSL *s, unsigned int context);
47 static int final_ems(SSL *s, unsigned int context, int sent);
48 static int init_psk_kex_modes(SSL *s, unsigned int context);
49 #ifndef OPENSSL_NO_EC
50 static int final_key_share(SSL *s, unsigned int context, int sent);
51 #endif
52 #ifndef OPENSSL_NO_SRTP
53 static int init_srtp(SSL *s, unsigned int context);
54 #endif
55 static int final_sig_algs(SSL *s, unsigned int context, int sent);
56 static int final_early_data(SSL *s, unsigned int context, int sent);
57 static int final_maxfragmentlen(SSL *s, unsigned int context, int sent);
58 static int init_post_handshake_auth(SSL *s, unsigned int context);
59
60 /* Structure to define a built-in extension */
61 typedef struct extensions_definition_st {
62     /* The defined type for the extension */
63     unsigned int type;
64     /*
65      * The context that this extension applies to, e.g. what messages and
66      * protocol versions
67      */
68     unsigned int context;
69     /*
70      * Initialise extension before parsing. Always called for relevant contexts
71      * even if extension not present
72      */
73     int (*init)(SSL *s, unsigned int context);
74     /* Parse extension sent from client to server */
75     int (*parse_ctos)(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
76                       size_t chainidx);
77     /* Parse extension send from server to client */
78     int (*parse_stoc)(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
79                       size_t chainidx);
80     /* Construct extension sent from server to client */
81     EXT_RETURN (*construct_stoc)(SSL *s, WPACKET *pkt, unsigned int context,
82                                  X509 *x, size_t chainidx);
83     /* Construct extension sent from client to server */
84     EXT_RETURN (*construct_ctos)(SSL *s, WPACKET *pkt, unsigned int context,
85                                  X509 *x, size_t chainidx);
86     /*
87      * Finalise extension after parsing. Always called where an extensions was
88      * initialised even if the extension was not present. |sent| is set to 1 if
89      * the extension was seen, or 0 otherwise.
90      */
91     int (*final)(SSL *s, unsigned int context, int sent);
92 } EXTENSION_DEFINITION;
93
94 /*
95  * Definitions of all built-in extensions. NOTE: Changes in the number or order
96  * of these extensions should be mirrored with equivalent changes to the
97  * indexes ( TLSEXT_IDX_* ) defined in ssl_locl.h.
98  * Each extension has an initialiser, a client and
99  * server side parser and a finaliser. The initialiser is called (if the
100  * extension is relevant to the given context) even if we did not see the
101  * extension in the message that we received. The parser functions are only
102  * called if we see the extension in the message. The finalisers are always
103  * called if the initialiser was called.
104  * There are also server and client side constructor functions which are always
105  * called during message construction if the extension is relevant for the
106  * given context.
107  * The initialisation, parsing, finalisation and construction functions are
108  * always called in the order defined in this list. Some extensions may depend
109  * on others having been processed first, so the order of this list is
110  * significant.
111  * The extension context is defined by a series of flags which specify which
112  * messages the extension is relevant to. These flags also specify whether the
113  * extension is relevant to a particular protocol or protocol version.
114  *
115  * TODO(TLS1.3): Make sure we have a test to check the consistency of these
116  *
117  * NOTE: WebSphere Application Server 7+ cannot handle empty extensions at
118  * the end, keep these extensions before signature_algorithm.
119  */
120 #define INVALID_EXTENSION { 0x10000, 0, NULL, NULL, NULL, NULL, NULL, NULL }
121 static const EXTENSION_DEFINITION ext_defs[] = {
122     {
123         TLSEXT_TYPE_renegotiate,
124         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_2_SERVER_HELLO
125         | SSL_EXT_SSL3_ALLOWED | SSL_EXT_TLS1_2_AND_BELOW_ONLY,
126         NULL, tls_parse_ctos_renegotiate, tls_parse_stoc_renegotiate,
127         tls_construct_stoc_renegotiate, tls_construct_ctos_renegotiate,
128         final_renegotiate
129     },
130     {
131         TLSEXT_TYPE_server_name,
132         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_2_SERVER_HELLO
133         | SSL_EXT_TLS1_3_ENCRYPTED_EXTENSIONS,
134         init_server_name,
135         tls_parse_ctos_server_name, tls_parse_stoc_server_name,
136         tls_construct_stoc_server_name, tls_construct_ctos_server_name,
137         final_server_name
138     },
139     {
140         TLSEXT_TYPE_max_fragment_length,
141         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_2_SERVER_HELLO
142         | SSL_EXT_TLS1_3_ENCRYPTED_EXTENSIONS,
143         NULL, tls_parse_ctos_maxfragmentlen, tls_parse_stoc_maxfragmentlen,
144         tls_construct_stoc_maxfragmentlen, tls_construct_ctos_maxfragmentlen,
145         final_maxfragmentlen
146     },
147 #ifndef OPENSSL_NO_SRP
148     {
149         TLSEXT_TYPE_srp,
150         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_2_AND_BELOW_ONLY,
151         init_srp, tls_parse_ctos_srp, NULL, NULL, tls_construct_ctos_srp, NULL
152     },
153 #else
154     INVALID_EXTENSION,
155 #endif
156 #ifndef OPENSSL_NO_EC
157     {
158         TLSEXT_TYPE_ec_point_formats,
159         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_2_SERVER_HELLO
160         | SSL_EXT_TLS1_2_AND_BELOW_ONLY,
161         NULL, tls_parse_ctos_ec_pt_formats, tls_parse_stoc_ec_pt_formats,
162         tls_construct_stoc_ec_pt_formats, tls_construct_ctos_ec_pt_formats,
163         final_ec_pt_formats
164     },
165     {
166         /*
167          * "supported_groups" is spread across several specifications.
168          * It was originally specified as "elliptic_curves" in RFC 4492,
169          * and broadened to include named FFDH groups by RFC 7919.
170          * Both RFCs 4492 and 7919 do not include a provision for the server
171          * to indicate to the client the complete list of groups supported
172          * by the server, with the server instead just indicating the
173          * selected group for this connection in the ServerKeyExchange
174          * message.  TLS 1.3 adds a scheme for the server to indicate
175          * to the client its list of supported groups in the
176          * EncryptedExtensions message, but none of the relevant
177          * specifications permit sending supported_groups in the ServerHello.
178          * Nonetheless (possibly due to the close proximity to the
179          * "ec_point_formats" extension, which is allowed in the ServerHello),
180          * there are several servers that send this extension in the
181          * ServerHello anyway.  Up to and including the 1.1.0 release,
182          * we did not check for the presence of nonpermitted extensions,
183          * so to avoid a regression, we must permit this extension in the
184          * TLS 1.2 ServerHello as well.
185          *
186          * Note that there is no tls_parse_stoc_supported_groups function,
187          * so we do not perform any additional parsing, validation, or
188          * processing on the server's group list -- this is just a minimal
189          * change to preserve compatibility with these misbehaving servers.
190          */
191         TLSEXT_TYPE_supported_groups,
192         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_3_ENCRYPTED_EXTENSIONS
193         | SSL_EXT_TLS1_2_SERVER_HELLO,
194         NULL, tls_parse_ctos_supported_groups, NULL,
195         tls_construct_stoc_supported_groups,
196         tls_construct_ctos_supported_groups, NULL
197     },
198 #else
199     INVALID_EXTENSION,
200     INVALID_EXTENSION,
201 #endif
202     {
203         TLSEXT_TYPE_session_ticket,
204         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_2_SERVER_HELLO
205         | SSL_EXT_TLS1_2_AND_BELOW_ONLY,
206         init_session_ticket, tls_parse_ctos_session_ticket,
207         tls_parse_stoc_session_ticket, tls_construct_stoc_session_ticket,
208         tls_construct_ctos_session_ticket, NULL
209     },
210 #ifndef OPENSSL_NO_OCSP
211     {
212         TLSEXT_TYPE_status_request,
213         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_2_SERVER_HELLO
214         | SSL_EXT_TLS1_3_CERTIFICATE | SSL_EXT_TLS1_3_CERTIFICATE_REQUEST,
215         init_status_request, tls_parse_ctos_status_request,
216         tls_parse_stoc_status_request, tls_construct_stoc_status_request,
217         tls_construct_ctos_status_request, NULL
218     },
219 #else
220     INVALID_EXTENSION,
221 #endif
222 #ifndef OPENSSL_NO_NEXTPROTONEG
223     {
224         TLSEXT_TYPE_next_proto_neg,
225         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_2_SERVER_HELLO
226         | SSL_EXT_TLS1_2_AND_BELOW_ONLY,
227         init_npn, tls_parse_ctos_npn, tls_parse_stoc_npn,
228         tls_construct_stoc_next_proto_neg, tls_construct_ctos_npn, NULL
229     },
230 #else
231     INVALID_EXTENSION,
232 #endif
233     {
234         /*
235          * Must appear in this list after server_name so that finalisation
236          * happens after server_name callbacks
237          */
238         TLSEXT_TYPE_application_layer_protocol_negotiation,
239         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_2_SERVER_HELLO
240         | SSL_EXT_TLS1_3_ENCRYPTED_EXTENSIONS,
241         init_alpn, tls_parse_ctos_alpn, tls_parse_stoc_alpn,
242         tls_construct_stoc_alpn, tls_construct_ctos_alpn, final_alpn
243     },
244 #ifndef OPENSSL_NO_SRTP
245     {
246         TLSEXT_TYPE_use_srtp,
247         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_2_SERVER_HELLO
248         | SSL_EXT_TLS1_3_ENCRYPTED_EXTENSIONS | SSL_EXT_DTLS_ONLY,
249         init_srtp, tls_parse_ctos_use_srtp, tls_parse_stoc_use_srtp,
250         tls_construct_stoc_use_srtp, tls_construct_ctos_use_srtp, NULL
251     },
252 #else
253     INVALID_EXTENSION,
254 #endif
255     {
256         TLSEXT_TYPE_encrypt_then_mac,
257         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_2_SERVER_HELLO
258         | SSL_EXT_TLS1_2_AND_BELOW_ONLY,
259         init_etm, tls_parse_ctos_etm, tls_parse_stoc_etm,
260         tls_construct_stoc_etm, tls_construct_ctos_etm, NULL
261     },
262 #ifndef OPENSSL_NO_CT
263     {
264         TLSEXT_TYPE_signed_certificate_timestamp,
265         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_2_SERVER_HELLO
266         | SSL_EXT_TLS1_3_CERTIFICATE | SSL_EXT_TLS1_3_CERTIFICATE_REQUEST,
267         NULL,
268         /*
269          * No server side support for this, but can be provided by a custom
270          * extension. This is an exception to the rule that custom extensions
271          * cannot override built in ones.
272          */
273         NULL, tls_parse_stoc_sct, NULL, tls_construct_ctos_sct,  NULL
274     },
275 #else
276     INVALID_EXTENSION,
277 #endif
278     {
279         TLSEXT_TYPE_extended_master_secret,
280         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_2_SERVER_HELLO
281         | SSL_EXT_TLS1_2_AND_BELOW_ONLY,
282         init_ems, tls_parse_ctos_ems, tls_parse_stoc_ems,
283         tls_construct_stoc_ems, tls_construct_ctos_ems, final_ems
284     },
285     {
286         TLSEXT_TYPE_signature_algorithms_cert,
287         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_3_CERTIFICATE_REQUEST,
288         init_sig_algs_cert, tls_parse_ctos_sig_algs_cert,
289         tls_parse_ctos_sig_algs_cert,
290         /* We do not generate signature_algorithms_cert at present. */
291         NULL, NULL, NULL
292     },
293     {
294         TLSEXT_TYPE_post_handshake_auth,
295         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_3_ONLY,
296         init_post_handshake_auth,
297         tls_parse_ctos_post_handshake_auth, NULL,
298         NULL, tls_construct_ctos_post_handshake_auth,
299         NULL,
300     },
301     {
302         TLSEXT_TYPE_signature_algorithms,
303         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_3_CERTIFICATE_REQUEST,
304         init_sig_algs, tls_parse_ctos_sig_algs,
305         tls_parse_ctos_sig_algs, tls_construct_ctos_sig_algs,
306         tls_construct_ctos_sig_algs, final_sig_algs
307     },
308     {
309         TLSEXT_TYPE_supported_versions,
310         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_3_SERVER_HELLO
311         | SSL_EXT_TLS1_3_HELLO_RETRY_REQUEST | SSL_EXT_TLS_IMPLEMENTATION_ONLY,
312         NULL,
313         /* Processed inline as part of version selection */
314         NULL, tls_parse_stoc_supported_versions,
315         tls_construct_stoc_supported_versions,
316         tls_construct_ctos_supported_versions, NULL
317     },
318     {
319         TLSEXT_TYPE_psk_kex_modes,
320         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS_IMPLEMENTATION_ONLY
321         | SSL_EXT_TLS1_3_ONLY,
322         init_psk_kex_modes, tls_parse_ctos_psk_kex_modes, NULL, NULL,
323         tls_construct_ctos_psk_kex_modes, NULL
324     },
325 #ifndef OPENSSL_NO_EC
326     {
327         /*
328          * Must be in this list after supported_groups. We need that to have
329          * been parsed before we do this one.
330          */
331         TLSEXT_TYPE_key_share,
332         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_3_SERVER_HELLO
333         | SSL_EXT_TLS1_3_HELLO_RETRY_REQUEST | SSL_EXT_TLS_IMPLEMENTATION_ONLY
334         | SSL_EXT_TLS1_3_ONLY,
335         NULL, tls_parse_ctos_key_share, tls_parse_stoc_key_share,
336         tls_construct_stoc_key_share, tls_construct_ctos_key_share,
337         final_key_share
338     },
339 #endif
340     {
341         /* Must be after key_share */
342         TLSEXT_TYPE_cookie,
343         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_3_HELLO_RETRY_REQUEST
344         | SSL_EXT_TLS_IMPLEMENTATION_ONLY | SSL_EXT_TLS1_3_ONLY,
345         NULL, tls_parse_ctos_cookie, tls_parse_stoc_cookie,
346         tls_construct_stoc_cookie, tls_construct_ctos_cookie, NULL
347     },
348     {
349         /*
350          * Special unsolicited ServerHello extension only used when
351          * SSL_OP_CRYPTOPRO_TLSEXT_BUG is set
352          */
353         TLSEXT_TYPE_cryptopro_bug,
354         SSL_EXT_TLS1_2_SERVER_HELLO | SSL_EXT_TLS1_2_AND_BELOW_ONLY,
355         NULL, NULL, NULL, tls_construct_stoc_cryptopro_bug, NULL, NULL
356     },
357     {
358         TLSEXT_TYPE_early_data,
359         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_3_ENCRYPTED_EXTENSIONS
360         | SSL_EXT_TLS1_3_NEW_SESSION_TICKET | SSL_EXT_TLS1_3_ONLY,
361         NULL, tls_parse_ctos_early_data, tls_parse_stoc_early_data,
362         tls_construct_stoc_early_data, tls_construct_ctos_early_data,
363         final_early_data
364     },
365     {
366         TLSEXT_TYPE_certificate_authorities,
367         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_3_CERTIFICATE_REQUEST
368         | SSL_EXT_TLS1_3_ONLY,
369         init_certificate_authorities,
370         tls_parse_certificate_authorities, tls_parse_certificate_authorities,
371         tls_construct_certificate_authorities,
372         tls_construct_certificate_authorities, NULL,
373     },
374     {
375         /* Must be immediately before pre_shared_key */
376         TLSEXT_TYPE_padding,
377         SSL_EXT_CLIENT_HELLO,
378         NULL,
379         /* We send this, but don't read it */
380         NULL, NULL, NULL, tls_construct_ctos_padding, NULL
381     },
382     {
383         /* Required by the TLSv1.3 spec to always be the last extension */
384         TLSEXT_TYPE_psk,
385         SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_3_SERVER_HELLO
386         | SSL_EXT_TLS_IMPLEMENTATION_ONLY | SSL_EXT_TLS1_3_ONLY,
387         NULL, tls_parse_ctos_psk, tls_parse_stoc_psk, tls_construct_stoc_psk,
388         tls_construct_ctos_psk, NULL
389     }
390 };
391
392 /* Check whether an extension's context matches the current context */
393 static int validate_context(SSL *s, unsigned int extctx, unsigned int thisctx)
394 {
395     /* Check we're allowed to use this extension in this context */
396     if ((thisctx & extctx) == 0)
397         return 0;
398
399     if (SSL_IS_DTLS(s)) {
400         if ((extctx & SSL_EXT_TLS_ONLY) != 0)
401             return 0;
402     } else if ((extctx & SSL_EXT_DTLS_ONLY) != 0) {
403         return 0;
404     }
405
406     return 1;
407 }
408
409 int tls_validate_all_contexts(SSL *s, unsigned int thisctx, RAW_EXTENSION *exts)
410 {
411     size_t i, num_exts, builtin_num = OSSL_NELEM(ext_defs), offset;
412     RAW_EXTENSION *thisext;
413     unsigned int context;
414     ENDPOINT role = ENDPOINT_BOTH;
415
416     if ((thisctx & SSL_EXT_CLIENT_HELLO) != 0)
417         role = ENDPOINT_SERVER;
418     else if ((thisctx & SSL_EXT_TLS1_2_SERVER_HELLO) != 0)
419         role = ENDPOINT_CLIENT;
420
421     /* Calculate the number of extensions in the extensions list */
422     num_exts = builtin_num + s->cert->custext.meths_count;
423
424     for (thisext = exts, i = 0; i < num_exts; i++, thisext++) {
425         if (!thisext->present)
426             continue;
427
428         if (i < builtin_num) {
429             context = ext_defs[i].context;
430         } else {
431             custom_ext_method *meth = NULL;
432
433             meth = custom_ext_find(&s->cert->custext, role, thisext->type,
434                                    &offset);
435             if (!ossl_assert(meth != NULL))
436                 return 0;
437             context = meth->context;
438         }
439
440         if (!validate_context(s, context, thisctx))
441             return 0;
442     }
443
444     return 1;
445 }
446
447 /*
448  * Verify whether we are allowed to use the extension |type| in the current
449  * |context|. Returns 1 to indicate the extension is allowed or unknown or 0 to
450  * indicate the extension is not allowed. If returning 1 then |*found| is set to
451  * the definition for the extension we found.
452  */
453 static int verify_extension(SSL *s, unsigned int context, unsigned int type,
454                             custom_ext_methods *meths, RAW_EXTENSION *rawexlist,
455                             RAW_EXTENSION **found)
456 {
457     size_t i;
458     size_t builtin_num = OSSL_NELEM(ext_defs);
459     const EXTENSION_DEFINITION *thisext;
460
461     for (i = 0, thisext = ext_defs; i < builtin_num; i++, thisext++) {
462         if (type == thisext->type) {
463             if (!validate_context(s, thisext->context, context))
464                 return 0;
465
466             *found = &rawexlist[i];
467             return 1;
468         }
469     }
470
471     /* Check the custom extensions */
472     if (meths != NULL) {
473         size_t offset = 0;
474         ENDPOINT role = ENDPOINT_BOTH;
475         custom_ext_method *meth = NULL;
476
477         if ((context & SSL_EXT_CLIENT_HELLO) != 0)
478             role = ENDPOINT_SERVER;
479         else if ((context & SSL_EXT_TLS1_2_SERVER_HELLO) != 0)
480             role = ENDPOINT_CLIENT;
481
482         meth = custom_ext_find(meths, role, type, &offset);
483         if (meth != NULL) {
484             if (!validate_context(s, meth->context, context))
485                 return 0;
486             *found = &rawexlist[offset + builtin_num];
487             return 1;
488         }
489     }
490
491     /* Unknown extension. We allow it */
492     *found = NULL;
493     return 1;
494 }
495
496 /*
497  * Check whether the context defined for an extension |extctx| means whether
498  * the extension is relevant for the current context |thisctx| or not. Returns
499  * 1 if the extension is relevant for this context, and 0 otherwise
500  */
501 int extension_is_relevant(SSL *s, unsigned int extctx, unsigned int thisctx)
502 {
503     int is_tls13;
504
505     /*
506      * For HRR we haven't selected the version yet but we know it will be
507      * TLSv1.3
508      */
509     if ((thisctx & SSL_EXT_TLS1_3_HELLO_RETRY_REQUEST) != 0)
510         is_tls13 = 1;
511     else
512         is_tls13 = SSL_IS_TLS13(s);
513
514     if ((SSL_IS_DTLS(s)
515                 && (extctx & SSL_EXT_TLS_IMPLEMENTATION_ONLY) != 0)
516             || (s->version == SSL3_VERSION
517                     && (extctx & SSL_EXT_SSL3_ALLOWED) == 0)
518             /*
519              * Note that SSL_IS_TLS13() means "TLS 1.3 has been negotiated",
520              * which is never true when generating the ClientHello.
521              * However, version negotiation *has* occurred by the time the
522              * ClientHello extensions are being parsed.
523              * Be careful to allow TLS 1.3-only extensions when generating
524              * the ClientHello.
525              */
526             || (is_tls13 && (extctx & SSL_EXT_TLS1_2_AND_BELOW_ONLY) != 0)
527             || (!is_tls13 && (extctx & SSL_EXT_TLS1_3_ONLY) != 0
528                 && (thisctx & SSL_EXT_CLIENT_HELLO) == 0)
529             || (s->server && !is_tls13 && (extctx & SSL_EXT_TLS1_3_ONLY) != 0)
530             || (s->hit && (extctx & SSL_EXT_IGNORE_ON_RESUMPTION) != 0))
531         return 0;
532     return 1;
533 }
534
535 /*
536  * Gather a list of all the extensions from the data in |packet]. |context|
537  * tells us which message this extension is for. The raw extension data is
538  * stored in |*res| on success. We don't actually process the content of the
539  * extensions yet, except to check their types. This function also runs the
540  * initialiser functions for all known extensions if |init| is nonzero (whether
541  * we have collected them or not). If successful the caller is responsible for
542  * freeing the contents of |*res|.
543  *
544  * Per http://tools.ietf.org/html/rfc5246#section-7.4.1.4, there may not be
545  * more than one extension of the same type in a ClientHello or ServerHello.
546  * This function returns 1 if all extensions are unique and we have parsed their
547  * types, and 0 if the extensions contain duplicates, could not be successfully
548  * found, or an internal error occurred. We only check duplicates for
549  * extensions that we know about. We ignore others.
550  */
551 int tls_collect_extensions(SSL *s, PACKET *packet, unsigned int context,
552                            RAW_EXTENSION **res, size_t *len, int init)
553 {
554     PACKET extensions = *packet;
555     size_t i = 0;
556     size_t num_exts;
557     custom_ext_methods *exts = &s->cert->custext;
558     RAW_EXTENSION *raw_extensions = NULL;
559     const EXTENSION_DEFINITION *thisexd;
560
561     *res = NULL;
562
563     /*
564      * Initialise server side custom extensions. Client side is done during
565      * construction of extensions for the ClientHello.
566      */
567     if ((context & SSL_EXT_CLIENT_HELLO) != 0)
568         custom_ext_init(&s->cert->custext);
569
570     num_exts = OSSL_NELEM(ext_defs) + (exts != NULL ? exts->meths_count : 0);
571     raw_extensions = OPENSSL_zalloc(num_exts * sizeof(*raw_extensions));
572     if (raw_extensions == NULL) {
573         SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_COLLECT_EXTENSIONS,
574                  ERR_R_MALLOC_FAILURE);
575         return 0;
576     }
577
578     i = 0;
579     while (PACKET_remaining(&extensions) > 0) {
580         unsigned int type, idx;
581         PACKET extension;
582         RAW_EXTENSION *thisex;
583
584         if (!PACKET_get_net_2(&extensions, &type) ||
585             !PACKET_get_length_prefixed_2(&extensions, &extension)) {
586             SSLfatal(s, SSL_AD_DECODE_ERROR, SSL_F_TLS_COLLECT_EXTENSIONS,
587                      SSL_R_BAD_EXTENSION);
588             goto err;
589         }
590         /*
591          * Verify this extension is allowed. We only check duplicates for
592          * extensions that we recognise. We also have a special case for the
593          * PSK extension, which must be the last one in the ClientHello.
594          */
595         if (!verify_extension(s, context, type, exts, raw_extensions, &thisex)
596                 || (thisex != NULL && thisex->present == 1)
597                 || (type == TLSEXT_TYPE_psk
598                     && (context & SSL_EXT_CLIENT_HELLO) != 0
599                     && PACKET_remaining(&extensions) != 0)) {
600             SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_TLS_COLLECT_EXTENSIONS,
601                      SSL_R_BAD_EXTENSION);
602             goto err;
603         }
604         idx = thisex - raw_extensions;
605         /*-
606          * Check that we requested this extension (if appropriate). Requests can
607          * be sent in the ClientHello and CertificateRequest. Unsolicited
608          * extensions can be sent in the NewSessionTicket. We only do this for
609          * the built-in extensions. Custom extensions have a different but
610          * similar check elsewhere.
611          * Special cases:
612          * - The HRR cookie extension is unsolicited
613          * - The renegotiate extension is unsolicited (the client signals
614          *   support via an SCSV)
615          * - The signed_certificate_timestamp extension can be provided by a
616          * custom extension or by the built-in version. We let the extension
617          * itself handle unsolicited response checks.
618          */
619         if (idx < OSSL_NELEM(ext_defs)
620                 && (context & (SSL_EXT_CLIENT_HELLO
621                                | SSL_EXT_TLS1_3_CERTIFICATE_REQUEST
622                                | SSL_EXT_TLS1_3_NEW_SESSION_TICKET)) == 0
623                 && type != TLSEXT_TYPE_cookie
624                 && type != TLSEXT_TYPE_renegotiate
625                 && type != TLSEXT_TYPE_signed_certificate_timestamp
626                 && (s->ext.extflags[idx] & SSL_EXT_FLAG_SENT) == 0
627 #ifndef OPENSSL_NO_GOST
628                 && !((context & SSL_EXT_TLS1_2_SERVER_HELLO) != 0
629                      && type == TLSEXT_TYPE_cryptopro_bug)
630 #endif
631                                                                 ) {
632             SSLfatal(s, SSL_AD_UNSUPPORTED_EXTENSION,
633                      SSL_F_TLS_COLLECT_EXTENSIONS, SSL_R_UNSOLICITED_EXTENSION);
634             goto err;
635         }
636         if (thisex != NULL) {
637             thisex->data = extension;
638             thisex->present = 1;
639             thisex->type = type;
640             thisex->received_order = i++;
641             if (s->ext.debug_cb)
642                 s->ext.debug_cb(s, !s->server, thisex->type,
643                                 PACKET_data(&thisex->data),
644                                 PACKET_remaining(&thisex->data),
645                                 s->ext.debug_arg);
646         }
647     }
648
649     if (init) {
650         /*
651          * Initialise all known extensions relevant to this context,
652          * whether we have found them or not
653          */
654         for (thisexd = ext_defs, i = 0; i < OSSL_NELEM(ext_defs);
655              i++, thisexd++) {
656             if (thisexd->init != NULL && (thisexd->context & context) != 0
657                 && extension_is_relevant(s, thisexd->context, context)
658                 && !thisexd->init(s, context)) {
659                 /* SSLfatal() already called */
660                 goto err;
661             }
662         }
663     }
664
665     *res = raw_extensions;
666     if (len != NULL)
667         *len = num_exts;
668     return 1;
669
670  err:
671     OPENSSL_free(raw_extensions);
672     return 0;
673 }
674
675 /*
676  * Runs the parser for a given extension with index |idx|. |exts| contains the
677  * list of all parsed extensions previously collected by
678  * tls_collect_extensions(). The parser is only run if it is applicable for the
679  * given |context| and the parser has not already been run. If this is for a
680  * Certificate message, then we also provide the parser with the relevant
681  * Certificate |x| and its position in the |chainidx| with 0 being the first
682  * Certificate. Returns 1 on success or 0 on failure. If an extension is not
683  * present this counted as success.
684  */
685 int tls_parse_extension(SSL *s, TLSEXT_INDEX idx, int context,
686                         RAW_EXTENSION *exts, X509 *x, size_t chainidx)
687 {
688     RAW_EXTENSION *currext = &exts[idx];
689     int (*parser)(SSL *s, PACKET *pkt, unsigned int context, X509 *x,
690                   size_t chainidx) = NULL;
691
692     /* Skip if the extension is not present */
693     if (!currext->present)
694         return 1;
695
696     /* Skip if we've already parsed this extension */
697     if (currext->parsed)
698         return 1;
699
700     currext->parsed = 1;
701
702     if (idx < OSSL_NELEM(ext_defs)) {
703         /* We are handling a built-in extension */
704         const EXTENSION_DEFINITION *extdef = &ext_defs[idx];
705
706         /* Check if extension is defined for our protocol. If not, skip */
707         if (!extension_is_relevant(s, extdef->context, context))
708             return 1;
709
710         parser = s->server ? extdef->parse_ctos : extdef->parse_stoc;
711
712         if (parser != NULL)
713             return parser(s, &currext->data, context, x, chainidx);
714
715         /*
716          * If the parser is NULL we fall through to the custom extension
717          * processing
718          */
719     }
720
721     /* Parse custom extensions */
722     return custom_ext_parse(s, context, currext->type,
723                             PACKET_data(&currext->data),
724                             PACKET_remaining(&currext->data),
725                             x, chainidx);
726 }
727
728 /*
729  * Parse all remaining extensions that have not yet been parsed. Also calls the
730  * finalisation for all extensions at the end if |fin| is nonzero, whether we
731  * collected them or not. Returns 1 for success or 0 for failure. If we are
732  * working on a Certificate message then we also pass the Certificate |x| and
733  * its position in the |chainidx|, with 0 being the first certificate.
734  */
735 int tls_parse_all_extensions(SSL *s, int context, RAW_EXTENSION *exts, X509 *x,
736                              size_t chainidx, int fin)
737 {
738     size_t i, numexts = OSSL_NELEM(ext_defs);
739     const EXTENSION_DEFINITION *thisexd;
740
741     /* Calculate the number of extensions in the extensions list */
742     numexts += s->cert->custext.meths_count;
743
744     /* Parse each extension in turn */
745     for (i = 0; i < numexts; i++) {
746         if (!tls_parse_extension(s, i, context, exts, x, chainidx)) {
747             /* SSLfatal() already called */
748             return 0;
749         }
750     }
751
752     if (fin) {
753         /*
754          * Finalise all known extensions relevant to this context,
755          * whether we have found them or not
756          */
757         for (i = 0, thisexd = ext_defs; i < OSSL_NELEM(ext_defs);
758              i++, thisexd++) {
759             if (thisexd->final != NULL && (thisexd->context & context) != 0
760                 && !thisexd->final(s, context, exts[i].present)) {
761                 /* SSLfatal() already called */
762                 return 0;
763             }
764         }
765     }
766
767     return 1;
768 }
769
770 int should_add_extension(SSL *s, unsigned int extctx, unsigned int thisctx,
771                          int max_version)
772 {
773     /* Skip if not relevant for our context */
774     if ((extctx & thisctx) == 0)
775         return 0;
776
777     /* Check if this extension is defined for our protocol. If not, skip */
778     if (!extension_is_relevant(s, extctx, thisctx)
779             || ((extctx & SSL_EXT_TLS1_3_ONLY) != 0
780                 && (thisctx & SSL_EXT_CLIENT_HELLO) != 0
781                 && (SSL_IS_DTLS(s) || max_version < TLS1_3_VERSION)))
782         return 0;
783
784     return 1;
785 }
786
787 /*
788  * Construct all the extensions relevant to the current |context| and write
789  * them to |pkt|. If this is an extension for a Certificate in a Certificate
790  * message, then |x| will be set to the Certificate we are handling, and
791  * |chainidx| will indicate the position in the chainidx we are processing (with
792  * 0 being the first in the chain). Returns 1 on success or 0 on failure. On a
793  * failure construction stops at the first extension to fail to construct.
794  */
795 int tls_construct_extensions(SSL *s, WPACKET *pkt, unsigned int context,
796                              X509 *x, size_t chainidx)
797 {
798     size_t i;
799     int min_version, max_version = 0, reason;
800     const EXTENSION_DEFINITION *thisexd;
801
802     if (!WPACKET_start_sub_packet_u16(pkt)
803                /*
804                 * If extensions are of zero length then we don't even add the
805                 * extensions length bytes to a ClientHello/ServerHello
806                 * (for non-TLSv1.3).
807                 */
808             || ((context &
809                  (SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_2_SERVER_HELLO)) != 0
810                 && !WPACKET_set_flags(pkt,
811                                      WPACKET_FLAGS_ABANDON_ON_ZERO_LENGTH))) {
812         SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_CONSTRUCT_EXTENSIONS,
813                  ERR_R_INTERNAL_ERROR);
814         return 0;
815     }
816
817     if ((context & SSL_EXT_CLIENT_HELLO) != 0) {
818         reason = ssl_get_min_max_version(s, &min_version, &max_version, NULL);
819         if (reason != 0) {
820             SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_CONSTRUCT_EXTENSIONS,
821                      reason);
822             return 0;
823         }
824     }
825
826     /* Add custom extensions first */
827     if ((context & SSL_EXT_CLIENT_HELLO) != 0) {
828         /* On the server side with initialise during ClientHello parsing */
829         custom_ext_init(&s->cert->custext);
830     }
831     if (!custom_ext_add(s, context, pkt, x, chainidx, max_version)) {
832         /* SSLfatal() already called */
833         return 0;
834     }
835
836     for (i = 0, thisexd = ext_defs; i < OSSL_NELEM(ext_defs); i++, thisexd++) {
837         EXT_RETURN (*construct)(SSL *s, WPACKET *pkt, unsigned int context,
838                                 X509 *x, size_t chainidx);
839         EXT_RETURN ret;
840
841         /* Skip if not relevant for our context */
842         if (!should_add_extension(s, thisexd->context, context, max_version))
843             continue;
844
845         construct = s->server ? thisexd->construct_stoc
846                               : thisexd->construct_ctos;
847
848         if (construct == NULL)
849             continue;
850
851         ret = construct(s, pkt, context, x, chainidx);
852         if (ret == EXT_RETURN_FAIL) {
853             /* SSLfatal() already called */
854             return 0;
855         }
856         if (ret == EXT_RETURN_SENT
857                 && (context & (SSL_EXT_CLIENT_HELLO
858                                | SSL_EXT_TLS1_3_CERTIFICATE_REQUEST
859                                | SSL_EXT_TLS1_3_NEW_SESSION_TICKET)) != 0)
860             s->ext.extflags[i] |= SSL_EXT_FLAG_SENT;
861     }
862
863     if (!WPACKET_close(pkt)) {
864         SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_CONSTRUCT_EXTENSIONS,
865                  ERR_R_INTERNAL_ERROR);
866         return 0;
867     }
868
869     return 1;
870 }
871
872 /*
873  * Built in extension finalisation and initialisation functions. All initialise
874  * or finalise the associated extension type for the given |context|. For
875  * finalisers |sent| is set to 1 if we saw the extension during parsing, and 0
876  * otherwise. These functions return 1 on success or 0 on failure.
877  */
878
879 static int final_renegotiate(SSL *s, unsigned int context, int sent)
880 {
881     if (!s->server) {
882         /*
883          * Check if we can connect to a server that doesn't support safe
884          * renegotiation
885          */
886         if (!(s->options & SSL_OP_LEGACY_SERVER_CONNECT)
887                 && !(s->options & SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION)
888                 && !sent) {
889             SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_FINAL_RENEGOTIATE,
890                      SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED);
891             return 0;
892         }
893
894         return 1;
895     }
896
897     /* Need RI if renegotiating */
898     if (s->renegotiate
899             && !(s->options & SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION)
900             && !sent) {
901         SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_FINAL_RENEGOTIATE,
902                  SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED);
903         return 0;
904     }
905
906
907     return 1;
908 }
909
910 static int init_server_name(SSL *s, unsigned int context)
911 {
912     if (s->server) {
913         s->servername_done = 0;
914
915         OPENSSL_free(s->ext.hostname);
916         s->ext.hostname = NULL;
917     }
918
919     return 1;
920 }
921
922 static int final_server_name(SSL *s, unsigned int context, int sent)
923 {
924     int ret = SSL_TLSEXT_ERR_NOACK;
925     int altmp = SSL_AD_UNRECOGNIZED_NAME;
926     int was_ticket = (SSL_get_options(s) & SSL_OP_NO_TICKET) == 0;
927
928     if (!ossl_assert(s->ctx != NULL) || !ossl_assert(s->session_ctx != NULL)) {
929         SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_FINAL_SERVER_NAME,
930                  ERR_R_INTERNAL_ERROR);
931         return 0;
932     }
933
934     if (s->ctx->ext.servername_cb != NULL)
935         ret = s->ctx->ext.servername_cb(s, &altmp,
936                                         s->ctx->ext.servername_arg);
937     else if (s->session_ctx->ext.servername_cb != NULL)
938         ret = s->session_ctx->ext.servername_cb(s, &altmp,
939                                        s->session_ctx->ext.servername_arg);
940
941     /*
942      * For servers, propagate the SNI hostname from the temporary
943      * storage in the SSL to the persistent SSL_SESSION, now that we
944      * know we accepted it.
945      * Clients make this copy when parsing the server's response to
946      * the extension, which is when they find out that the negotiation
947      * was successful.
948      */
949     if (s->server) {
950         /* TODO(OpenSSL1.2) revisit !sent case */
951         if (sent && ret == SSL_TLSEXT_ERR_OK && (!s->hit || SSL_IS_TLS13(s))) {
952             /* Only store the hostname in the session if we accepted it. */
953             OPENSSL_free(s->session->ext.hostname);
954             s->session->ext.hostname = OPENSSL_strdup(s->ext.hostname);
955             if (s->session->ext.hostname == NULL && s->ext.hostname != NULL) {
956                 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_FINAL_SERVER_NAME,
957                          ERR_R_INTERNAL_ERROR);
958             }
959         }
960     }
961
962     /*
963      * If we switched contexts (whether here or in the client_hello callback),
964      * move the sess_accept increment from the session_ctx to the new
965      * context, to avoid the confusing situation of having sess_accept_good
966      * exceed sess_accept (zero) for the new context.
967      */
968     if (SSL_IS_FIRST_HANDSHAKE(s) && s->ctx != s->session_ctx) {
969         tsan_counter(&s->ctx->stats.sess_accept);
970         tsan_decr(&s->session_ctx->stats.sess_accept);
971     }
972
973     /*
974      * If we're expecting to send a ticket, and tickets were previously enabled,
975      * and now tickets are disabled, then turn off expected ticket.
976      * Also, if this is not a resumption, create a new session ID
977      */
978     if (ret == SSL_TLSEXT_ERR_OK && s->ext.ticket_expected
979             && was_ticket && (SSL_get_options(s) & SSL_OP_NO_TICKET) != 0) {
980         s->ext.ticket_expected = 0;
981         if (!s->hit) {
982             SSL_SESSION* ss = SSL_get_session(s);
983
984             if (ss != NULL) {
985                 OPENSSL_free(ss->ext.tick);
986                 ss->ext.tick = NULL;
987                 ss->ext.ticklen = 0;
988                 ss->ext.tick_lifetime_hint = 0;
989                 ss->ext.tick_age_add = 0;
990                 ss->ext.tick_identity = 0;
991                 if (!ssl_generate_session_id(s, ss)) {
992                     SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_FINAL_SERVER_NAME,
993                              ERR_R_INTERNAL_ERROR);
994                     return 0;
995                 }
996             } else {
997                 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_FINAL_SERVER_NAME,
998                          ERR_R_INTERNAL_ERROR);
999                 return 0;
1000             }
1001         }
1002     }
1003
1004     switch (ret) {
1005     case SSL_TLSEXT_ERR_ALERT_FATAL:
1006         SSLfatal(s, altmp, SSL_F_FINAL_SERVER_NAME, SSL_R_CALLBACK_FAILED);
1007         return 0;
1008
1009     case SSL_TLSEXT_ERR_ALERT_WARNING:
1010         /* TLSv1.3 doesn't have warning alerts so we suppress this */
1011         if (!SSL_IS_TLS13(s))
1012             ssl3_send_alert(s, SSL3_AL_WARNING, altmp);
1013         return 1;
1014
1015     case SSL_TLSEXT_ERR_NOACK:
1016         s->servername_done = 0;
1017         return 1;
1018
1019     default:
1020         return 1;
1021     }
1022 }
1023
1024 #ifndef OPENSSL_NO_EC
1025 static int final_ec_pt_formats(SSL *s, unsigned int context, int sent)
1026 {
1027     unsigned long alg_k, alg_a;
1028
1029     if (s->server)
1030         return 1;
1031
1032     alg_k = s->s3->tmp.new_cipher->algorithm_mkey;
1033     alg_a = s->s3->tmp.new_cipher->algorithm_auth;
1034
1035     /*
1036      * If we are client and using an elliptic curve cryptography cipher
1037      * suite, then if server returns an EC point formats lists extension it
1038      * must contain uncompressed.
1039      */
1040     if (s->ext.ecpointformats != NULL
1041             && s->ext.ecpointformats_len > 0
1042             && s->session->ext.ecpointformats != NULL
1043             && s->session->ext.ecpointformats_len > 0
1044             && ((alg_k & SSL_kECDHE) || (alg_a & SSL_aECDSA))) {
1045         /* we are using an ECC cipher */
1046         size_t i;
1047         unsigned char *list = s->session->ext.ecpointformats;
1048
1049         for (i = 0; i < s->session->ext.ecpointformats_len; i++) {
1050             if (*list++ == TLSEXT_ECPOINTFORMAT_uncompressed)
1051                 break;
1052         }
1053         if (i == s->session->ext.ecpointformats_len) {
1054             SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_FINAL_EC_PT_FORMATS,
1055                      SSL_R_TLS_INVALID_ECPOINTFORMAT_LIST);
1056             return 0;
1057         }
1058     }
1059
1060     return 1;
1061 }
1062 #endif
1063
1064 static int init_session_ticket(SSL *s, unsigned int context)
1065 {
1066     if (!s->server)
1067         s->ext.ticket_expected = 0;
1068
1069     return 1;
1070 }
1071
1072 #ifndef OPENSSL_NO_OCSP
1073 static int init_status_request(SSL *s, unsigned int context)
1074 {
1075     if (s->server) {
1076         s->ext.status_type = TLSEXT_STATUSTYPE_nothing;
1077     } else {
1078         /*
1079          * Ensure we get sensible values passed to tlsext_status_cb in the event
1080          * that we don't receive a status message
1081          */
1082         OPENSSL_free(s->ext.ocsp.resp);
1083         s->ext.ocsp.resp = NULL;
1084         s->ext.ocsp.resp_len = 0;
1085     }
1086
1087     return 1;
1088 }
1089 #endif
1090
1091 #ifndef OPENSSL_NO_NEXTPROTONEG
1092 static int init_npn(SSL *s, unsigned int context)
1093 {
1094     s->s3->npn_seen = 0;
1095
1096     return 1;
1097 }
1098 #endif
1099
1100 static int init_alpn(SSL *s, unsigned int context)
1101 {
1102     OPENSSL_free(s->s3->alpn_selected);
1103     s->s3->alpn_selected = NULL;
1104     s->s3->alpn_selected_len = 0;
1105     if (s->server) {
1106         OPENSSL_free(s->s3->alpn_proposed);
1107         s->s3->alpn_proposed = NULL;
1108         s->s3->alpn_proposed_len = 0;
1109     }
1110     return 1;
1111 }
1112
1113 static int final_alpn(SSL *s, unsigned int context, int sent)
1114 {
1115     if (!s->server && !sent && s->session->ext.alpn_selected != NULL)
1116             s->ext.early_data_ok = 0;
1117
1118     if (!s->server || !SSL_IS_TLS13(s))
1119         return 1;
1120
1121     /*
1122      * Call alpn_select callback if needed.  Has to be done after SNI and
1123      * cipher negotiation (HTTP/2 restricts permitted ciphers). In TLSv1.3
1124      * we also have to do this before we decide whether to accept early_data.
1125      * In TLSv1.3 we've already negotiated our cipher so we do this call now.
1126      * For < TLSv1.3 we defer it until after cipher negotiation.
1127      *
1128      * On failure SSLfatal() already called.
1129      */
1130     return tls_handle_alpn(s);
1131 }
1132
1133 static int init_sig_algs(SSL *s, unsigned int context)
1134 {
1135     /* Clear any signature algorithms extension received */
1136     OPENSSL_free(s->s3->tmp.peer_sigalgs);
1137     s->s3->tmp.peer_sigalgs = NULL;
1138
1139     return 1;
1140 }
1141
1142 static int init_sig_algs_cert(SSL *s, unsigned int context)
1143 {
1144     /* Clear any signature algorithms extension received */
1145     OPENSSL_free(s->s3->tmp.peer_cert_sigalgs);
1146     s->s3->tmp.peer_cert_sigalgs = NULL;
1147
1148     return 1;
1149 }
1150
1151 #ifndef OPENSSL_NO_SRP
1152 static int init_srp(SSL *s, unsigned int context)
1153 {
1154     OPENSSL_free(s->srp_ctx.login);
1155     s->srp_ctx.login = NULL;
1156
1157     return 1;
1158 }
1159 #endif
1160
1161 static int init_etm(SSL *s, unsigned int context)
1162 {
1163     s->ext.use_etm = 0;
1164
1165     return 1;
1166 }
1167
1168 static int init_ems(SSL *s, unsigned int context)
1169 {
1170     if (!s->server)
1171         s->s3->flags &= ~TLS1_FLAGS_RECEIVED_EXTMS;
1172
1173     return 1;
1174 }
1175
1176 static int final_ems(SSL *s, unsigned int context, int sent)
1177 {
1178     if (!s->server && s->hit) {
1179         /*
1180          * Check extended master secret extension is consistent with
1181          * original session.
1182          */
1183         if (!(s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS) !=
1184             !(s->session->flags & SSL_SESS_FLAG_EXTMS)) {
1185             SSLfatal(s, SSL_AD_HANDSHAKE_FAILURE, SSL_F_FINAL_EMS,
1186                      SSL_R_INCONSISTENT_EXTMS);
1187             return 0;
1188         }
1189     }
1190
1191     return 1;
1192 }
1193
1194 static int init_certificate_authorities(SSL *s, unsigned int context)
1195 {
1196     sk_X509_NAME_pop_free(s->s3->tmp.peer_ca_names, X509_NAME_free);
1197     s->s3->tmp.peer_ca_names = NULL;
1198     return 1;
1199 }
1200
1201 static EXT_RETURN tls_construct_certificate_authorities(SSL *s, WPACKET *pkt,
1202                                                         unsigned int context,
1203                                                         X509 *x,
1204                                                         size_t chainidx)
1205 {
1206     const STACK_OF(X509_NAME) *ca_sk = get_ca_names(s);
1207
1208     if (ca_sk == NULL || sk_X509_NAME_num(ca_sk) == 0)
1209         return EXT_RETURN_NOT_SENT;
1210
1211     if (!WPACKET_put_bytes_u16(pkt, TLSEXT_TYPE_certificate_authorities)
1212         || !WPACKET_start_sub_packet_u16(pkt)) {
1213         SSLfatal(s, SSL_AD_INTERNAL_ERROR,
1214                  SSL_F_TLS_CONSTRUCT_CERTIFICATE_AUTHORITIES,
1215                ERR_R_INTERNAL_ERROR);
1216         return EXT_RETURN_FAIL;
1217     }
1218
1219     if (!construct_ca_names(s, ca_sk, pkt)) {
1220         /* SSLfatal() already called */
1221         return EXT_RETURN_FAIL;
1222     }
1223
1224     if (!WPACKET_close(pkt)) {
1225         SSLfatal(s, SSL_AD_INTERNAL_ERROR,
1226                  SSL_F_TLS_CONSTRUCT_CERTIFICATE_AUTHORITIES,
1227                  ERR_R_INTERNAL_ERROR);
1228         return EXT_RETURN_FAIL;
1229     }
1230
1231     return EXT_RETURN_SENT;
1232 }
1233
1234 static int tls_parse_certificate_authorities(SSL *s, PACKET *pkt,
1235                                              unsigned int context, X509 *x,
1236                                              size_t chainidx)
1237 {
1238     if (!parse_ca_names(s, pkt))
1239         return 0;
1240     if (PACKET_remaining(pkt) != 0) {
1241         SSLfatal(s, SSL_AD_DECODE_ERROR,
1242                  SSL_F_TLS_PARSE_CERTIFICATE_AUTHORITIES, SSL_R_BAD_EXTENSION);
1243         return 0;
1244     }
1245     return 1;
1246 }
1247
1248 #ifndef OPENSSL_NO_SRTP
1249 static int init_srtp(SSL *s, unsigned int context)
1250 {
1251     if (s->server)
1252         s->srtp_profile = NULL;
1253
1254     return 1;
1255 }
1256 #endif
1257
1258 static int final_sig_algs(SSL *s, unsigned int context, int sent)
1259 {
1260     if (!sent && SSL_IS_TLS13(s) && !s->hit) {
1261         SSLfatal(s, TLS13_AD_MISSING_EXTENSION, SSL_F_FINAL_SIG_ALGS,
1262                  SSL_R_MISSING_SIGALGS_EXTENSION);
1263         return 0;
1264     }
1265
1266     return 1;
1267 }
1268
1269 #ifndef OPENSSL_NO_EC
1270 static int final_key_share(SSL *s, unsigned int context, int sent)
1271 {
1272     if (!SSL_IS_TLS13(s))
1273         return 1;
1274
1275     /* Nothing to do for key_share in an HRR */
1276     if ((context & SSL_EXT_TLS1_3_HELLO_RETRY_REQUEST) != 0)
1277         return 1;
1278
1279     /*
1280      * If
1281      *     we are a client
1282      *     AND
1283      *     we have no key_share
1284      *     AND
1285      *     (we are not resuming
1286      *      OR the kex_mode doesn't allow non key_share resumes)
1287      * THEN
1288      *     fail;
1289      */
1290     if (!s->server
1291             && !sent
1292             && (!s->hit
1293                 || (s->ext.psk_kex_mode & TLSEXT_KEX_MODE_FLAG_KE) == 0)) {
1294         /* Nothing left we can do - just fail */
1295         SSLfatal(s, SSL_AD_MISSING_EXTENSION, SSL_F_FINAL_KEY_SHARE,
1296                  SSL_R_NO_SUITABLE_KEY_SHARE);
1297         return 0;
1298     }
1299     /*
1300      * IF
1301      *     we are a server
1302      * THEN
1303      *     IF
1304      *         we have a suitable key_share
1305      *     THEN
1306      *         IF
1307      *             we are stateless AND we have no cookie
1308      *         THEN
1309      *             send a HelloRetryRequest
1310      *     ELSE
1311      *         IF
1312      *             we didn't already send a HelloRetryRequest
1313      *             AND
1314      *             the client sent a key_share extension
1315      *             AND
1316      *             (we are not resuming
1317      *              OR the kex_mode allows key_share resumes)
1318      *             AND
1319      *             a shared group exists
1320      *         THEN
1321      *             send a HelloRetryRequest
1322      *         ELSE IF
1323      *             we are not resuming
1324      *             OR
1325      *             the kex_mode doesn't allow non key_share resumes
1326      *         THEN
1327      *             fail
1328      *         ELSE IF
1329      *             we are stateless AND we have no cookie
1330      *         THEN
1331      *             send a HelloRetryRequest
1332      */
1333     if (s->server) {
1334         if (s->s3->peer_tmp != NULL) {
1335             /* We have a suitable key_share */
1336             if ((s->s3->flags & TLS1_FLAGS_STATELESS) != 0
1337                     && !s->ext.cookieok) {
1338                 if (!ossl_assert(s->hello_retry_request == SSL_HRR_NONE)) {
1339                     /*
1340                      * If we are stateless then we wouldn't know about any
1341                      * previously sent HRR - so how can this be anything other
1342                      * than 0?
1343                      */
1344                     SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_FINAL_KEY_SHARE,
1345                              ERR_R_INTERNAL_ERROR);
1346                     return 0;
1347                 }
1348                 s->hello_retry_request = SSL_HRR_PENDING;
1349                 return 1;
1350             }
1351         } else {
1352             /* No suitable key_share */
1353             if (s->hello_retry_request == SSL_HRR_NONE && sent
1354                     && (!s->hit
1355                         || (s->ext.psk_kex_mode & TLSEXT_KEX_MODE_FLAG_KE_DHE)
1356                            != 0)) {
1357                 const uint16_t *pgroups, *clntgroups;
1358                 size_t num_groups, clnt_num_groups, i;
1359                 unsigned int group_id = 0;
1360
1361                 /* Check if a shared group exists */
1362
1363                 /* Get the clients list of supported groups. */
1364                 tls1_get_peer_groups(s, &clntgroups, &clnt_num_groups);
1365                 tls1_get_supported_groups(s, &pgroups, &num_groups);
1366
1367                 /*
1368                  * Find the first group we allow that is also in client's list
1369                  */
1370                 for (i = 0; i < num_groups; i++) {
1371                     group_id = pgroups[i];
1372
1373                     if (check_in_list(s, group_id, clntgroups, clnt_num_groups,
1374                                       1))
1375                         break;
1376                 }
1377
1378                 if (i < num_groups) {
1379                     /* A shared group exists so send a HelloRetryRequest */
1380                     s->s3->group_id = group_id;
1381                     s->hello_retry_request = SSL_HRR_PENDING;
1382                     return 1;
1383                 }
1384             }
1385             if (!s->hit
1386                     || (s->ext.psk_kex_mode & TLSEXT_KEX_MODE_FLAG_KE) == 0) {
1387                 /* Nothing left we can do - just fail */
1388                 SSLfatal(s, sent ? SSL_AD_HANDSHAKE_FAILURE
1389                                  : SSL_AD_MISSING_EXTENSION,
1390                          SSL_F_FINAL_KEY_SHARE, SSL_R_NO_SUITABLE_KEY_SHARE);
1391                 return 0;
1392             }
1393
1394             if ((s->s3->flags & TLS1_FLAGS_STATELESS) != 0
1395                     && !s->ext.cookieok) {
1396                 if (!ossl_assert(s->hello_retry_request == SSL_HRR_NONE)) {
1397                     /*
1398                      * If we are stateless then we wouldn't know about any
1399                      * previously sent HRR - so how can this be anything other
1400                      * than 0?
1401                      */
1402                     SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_FINAL_KEY_SHARE,
1403                              ERR_R_INTERNAL_ERROR);
1404                     return 0;
1405                 }
1406                 s->hello_retry_request = SSL_HRR_PENDING;
1407                 return 1;
1408             }
1409         }
1410
1411         /*
1412          * We have a key_share so don't send any more HelloRetryRequest
1413          * messages
1414          */
1415         if (s->hello_retry_request == SSL_HRR_PENDING)
1416             s->hello_retry_request = SSL_HRR_COMPLETE;
1417     } else {
1418         /*
1419          * For a client side resumption with no key_share we need to generate
1420          * the handshake secret (otherwise this is done during key_share
1421          * processing).
1422          */
1423         if (!sent && !tls13_generate_handshake_secret(s, NULL, 0)) {
1424             SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_FINAL_KEY_SHARE,
1425                      ERR_R_INTERNAL_ERROR);
1426             return 0;
1427         }
1428     }
1429
1430     return 1;
1431 }
1432 #endif
1433
1434 static int init_psk_kex_modes(SSL *s, unsigned int context)
1435 {
1436     s->ext.psk_kex_mode = TLSEXT_KEX_MODE_FLAG_NONE;
1437     return 1;
1438 }
1439
1440 int tls_psk_do_binder(SSL *s, const EVP_MD *md, const unsigned char *msgstart,
1441                       size_t binderoffset, const unsigned char *binderin,
1442                       unsigned char *binderout, SSL_SESSION *sess, int sign,
1443                       int external)
1444 {
1445     EVP_PKEY *mackey = NULL;
1446     EVP_MD_CTX *mctx = NULL;
1447     unsigned char hash[EVP_MAX_MD_SIZE], binderkey[EVP_MAX_MD_SIZE];
1448     unsigned char finishedkey[EVP_MAX_MD_SIZE], tmpbinder[EVP_MAX_MD_SIZE];
1449     unsigned char *early_secret;
1450     static const unsigned char resumption_label[] = "res binder";
1451     static const unsigned char external_label[] = "ext binder";
1452     const unsigned char *label;
1453     size_t bindersize, labelsize, hashsize;
1454     int hashsizei = EVP_MD_size(md);
1455     int ret = -1;
1456     int usepskfored = 0;
1457
1458     /* Ensure cast to size_t is safe */
1459     if (!ossl_assert(hashsizei >= 0)) {
1460         SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PSK_DO_BINDER,
1461                  ERR_R_INTERNAL_ERROR);
1462         goto err;
1463     }
1464     hashsize = (size_t)hashsizei;
1465
1466     if (external
1467             && s->early_data_state == SSL_EARLY_DATA_CONNECTING
1468             && s->session->ext.max_early_data == 0
1469             && sess->ext.max_early_data > 0)
1470         usepskfored = 1;
1471
1472     if (external) {
1473         label = external_label;
1474         labelsize = sizeof(external_label) - 1;
1475     } else {
1476         label = resumption_label;
1477         labelsize = sizeof(resumption_label) - 1;
1478     }
1479
1480     /*
1481      * Generate the early_secret. On the server side we've selected a PSK to
1482      * resume with (internal or external) so we always do this. On the client
1483      * side we do this for a non-external (i.e. resumption) PSK or external PSK
1484      * that will be used for early_data so that it is in place for sending early
1485      * data. For client side external PSK not being used for early_data we
1486      * generate it but store it away for later use.
1487      */
1488     if (s->server || !external || usepskfored)
1489         early_secret = (unsigned char *)s->early_secret;
1490     else
1491         early_secret = (unsigned char *)sess->early_secret;
1492
1493     if (!tls13_generate_secret(s, md, NULL, sess->master_key,
1494                                sess->master_key_length, early_secret)) {
1495         /* SSLfatal() already called */
1496         goto err;
1497     }
1498
1499     /*
1500      * Create the handshake hash for the binder key...the messages so far are
1501      * empty!
1502      */
1503     mctx = EVP_MD_CTX_new();
1504     if (mctx == NULL
1505             || EVP_DigestInit_ex(mctx, md, NULL) <= 0
1506             || EVP_DigestFinal_ex(mctx, hash, NULL) <= 0) {
1507         SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PSK_DO_BINDER,
1508                  ERR_R_INTERNAL_ERROR);
1509         goto err;
1510     }
1511
1512     /* Generate the binder key */
1513     if (!tls13_hkdf_expand(s, md, early_secret, label, labelsize, hash,
1514                            hashsize, binderkey, hashsize, 1)) {
1515         /* SSLfatal() already called */
1516         goto err;
1517     }
1518
1519     /* Generate the finished key */
1520     if (!tls13_derive_finishedkey(s, md, binderkey, finishedkey, hashsize)) {
1521         /* SSLfatal() already called */
1522         goto err;
1523     }
1524
1525     if (EVP_DigestInit_ex(mctx, md, NULL) <= 0) {
1526         SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PSK_DO_BINDER,
1527                  ERR_R_INTERNAL_ERROR);
1528         goto err;
1529     }
1530
1531     /*
1532      * Get a hash of the ClientHello up to the start of the binders. If we are
1533      * following a HelloRetryRequest then this includes the hash of the first
1534      * ClientHello and the HelloRetryRequest itself.
1535      */
1536     if (s->hello_retry_request == SSL_HRR_PENDING) {
1537         size_t hdatalen;
1538         long hdatalen_l;
1539         void *hdata;
1540
1541         hdatalen = hdatalen_l =
1542             BIO_get_mem_data(s->s3->handshake_buffer, &hdata);
1543         if (hdatalen_l <= 0) {
1544             SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PSK_DO_BINDER,
1545                      SSL_R_BAD_HANDSHAKE_LENGTH);
1546             goto err;
1547         }
1548
1549         /*
1550          * For servers the handshake buffer data will include the second
1551          * ClientHello - which we don't want - so we need to take that bit off.
1552          */
1553         if (s->server) {
1554             PACKET hashprefix, msg;
1555
1556             /* Find how many bytes are left after the first two messages */
1557             if (!PACKET_buf_init(&hashprefix, hdata, hdatalen)
1558                     || !PACKET_forward(&hashprefix, 1)
1559                     || !PACKET_get_length_prefixed_3(&hashprefix, &msg)
1560                     || !PACKET_forward(&hashprefix, 1)
1561                     || !PACKET_get_length_prefixed_3(&hashprefix, &msg)) {
1562                 SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PSK_DO_BINDER,
1563                          ERR_R_INTERNAL_ERROR);
1564                 goto err;
1565             }
1566             hdatalen -= PACKET_remaining(&hashprefix);
1567         }
1568
1569         if (EVP_DigestUpdate(mctx, hdata, hdatalen) <= 0) {
1570             SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PSK_DO_BINDER,
1571                      ERR_R_INTERNAL_ERROR);
1572             goto err;
1573         }
1574     }
1575
1576     if (EVP_DigestUpdate(mctx, msgstart, binderoffset) <= 0
1577             || EVP_DigestFinal_ex(mctx, hash, NULL) <= 0) {
1578         SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PSK_DO_BINDER,
1579                  ERR_R_INTERNAL_ERROR);
1580         goto err;
1581     }
1582
1583     mackey = EVP_PKEY_new_raw_private_key(EVP_PKEY_HMAC, NULL, finishedkey,
1584                                           hashsize);
1585     if (mackey == NULL) {
1586         SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PSK_DO_BINDER,
1587                  ERR_R_INTERNAL_ERROR);
1588         goto err;
1589     }
1590
1591     if (!sign)
1592         binderout = tmpbinder;
1593
1594     bindersize = hashsize;
1595     if (EVP_DigestSignInit(mctx, NULL, md, NULL, mackey) <= 0
1596             || EVP_DigestSignUpdate(mctx, hash, hashsize) <= 0
1597             || EVP_DigestSignFinal(mctx, binderout, &bindersize) <= 0
1598             || bindersize != hashsize) {
1599         SSLfatal(s, SSL_AD_INTERNAL_ERROR, SSL_F_TLS_PSK_DO_BINDER,
1600                  ERR_R_INTERNAL_ERROR);
1601         goto err;
1602     }
1603
1604     if (sign) {
1605         ret = 1;
1606     } else {
1607         /* HMAC keys can't do EVP_DigestVerify* - use CRYPTO_memcmp instead */
1608         ret = (CRYPTO_memcmp(binderin, binderout, hashsize) == 0);
1609         if (!ret)
1610             SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_TLS_PSK_DO_BINDER,
1611                      SSL_R_BINDER_DOES_NOT_VERIFY);
1612     }
1613
1614  err:
1615     OPENSSL_cleanse(binderkey, sizeof(binderkey));
1616     OPENSSL_cleanse(finishedkey, sizeof(finishedkey));
1617     EVP_PKEY_free(mackey);
1618     EVP_MD_CTX_free(mctx);
1619
1620     return ret;
1621 }
1622
1623 static int final_early_data(SSL *s, unsigned int context, int sent)
1624 {
1625     if (!sent)
1626         return 1;
1627
1628     if (!s->server) {
1629         if (context == SSL_EXT_TLS1_3_ENCRYPTED_EXTENSIONS
1630                 && sent
1631                 && !s->ext.early_data_ok) {
1632             /*
1633              * If we get here then the server accepted our early_data but we
1634              * later realised that it shouldn't have done (e.g. inconsistent
1635              * ALPN)
1636              */
1637             SSLfatal(s, SSL_AD_ILLEGAL_PARAMETER, SSL_F_FINAL_EARLY_DATA,
1638                      SSL_R_BAD_EARLY_DATA);
1639             return 0;
1640         }
1641
1642         return 1;
1643     }
1644
1645     if (s->max_early_data == 0
1646             || !s->hit
1647             || s->session->ext.tick_identity != 0
1648             || s->early_data_state != SSL_EARLY_DATA_ACCEPTING
1649             || !s->ext.early_data_ok
1650             || s->hello_retry_request != SSL_HRR_NONE
1651             || (s->ctx->allow_early_data_cb != NULL
1652                 && !s->ctx->allow_early_data_cb(s,
1653                                          s->ctx->allow_early_data_cb_data))) {
1654         s->ext.early_data = SSL_EARLY_DATA_REJECTED;
1655     } else {
1656         s->ext.early_data = SSL_EARLY_DATA_ACCEPTED;
1657
1658         if (!tls13_change_cipher_state(s,
1659                     SSL3_CC_EARLY | SSL3_CHANGE_CIPHER_SERVER_READ)) {
1660             /* SSLfatal() already called */
1661             return 0;
1662         }
1663     }
1664
1665     return 1;
1666 }
1667
1668 static int final_maxfragmentlen(SSL *s, unsigned int context, int sent)
1669 {
1670     /*
1671      * Session resumption on server-side with MFL extension active
1672      *  BUT MFL extension packet was not resent (i.e. sent == 0)
1673      */
1674     if (s->server && s->hit && USE_MAX_FRAGMENT_LENGTH_EXT(s->session)
1675             && !sent ) {
1676         SSLfatal(s, SSL_AD_MISSING_EXTENSION, SSL_F_FINAL_MAXFRAGMENTLEN,
1677                  SSL_R_BAD_EXTENSION);
1678         return 0;
1679     }
1680
1681     /* Current SSL buffer is lower than requested MFL */
1682     if (s->session && USE_MAX_FRAGMENT_LENGTH_EXT(s->session)
1683             && s->max_send_fragment < GET_MAX_FRAGMENT_LENGTH(s->session))
1684         /* trigger a larger buffer reallocation */
1685         if (!ssl3_setup_buffers(s)) {
1686             /* SSLfatal() already called */
1687             return 0;
1688         }
1689
1690     return 1;
1691 }
1692
1693 static int init_post_handshake_auth(SSL *s, unsigned int context)
1694 {
1695     s->post_handshake_auth = SSL_PHA_NONE;
1696
1697     return 1;
1698 }