extensions.c 30.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
/*
 * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the OpenSSL license (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */

#include "../ssl_locl.h"
#include "statem_locl.h"

13
static int final_renegotiate(SSL *s, unsigned int context, int sent,
14
                                     int *al);
15 16
static int init_server_name(SSL *s, unsigned int context);
static int final_server_name(SSL *s, unsigned int context, int sent,
17
                                     int *al);
18
#ifndef OPENSSL_NO_EC
19
static int final_ec_pt_formats(SSL *s, unsigned int context, int sent,
20 21
                                       int *al);
#endif
22 23 24
static int init_session_ticket(SSL *s, unsigned int context);
static int init_status_request(SSL *s, unsigned int context);
static int final_status_request(SSL *s, unsigned int context, int sent,
25
                                        int *al);
26
#ifndef OPENSSL_NO_NEXTPROTONEG
27
static int init_npn(SSL *s, unsigned int context);
28
#endif
29 30 31
static int init_alpn(SSL *s, unsigned int context);
static int final_alpn(SSL *s, unsigned int context, int sent, int *al);
static int init_sig_algs(SSL *s, unsigned int context);
32
#ifndef OPENSSL_NO_SRP
33
static int init_srp(SSL *s, unsigned int context);
34
#endif
35 36 37
static int init_etm(SSL *s, unsigned int context);
static int init_ems(SSL *s, unsigned int context);
static int final_ems(SSL *s, unsigned int context, int sent, int *al);
38
#ifndef OPENSSL_NO_SRTP
39
static int init_srtp(SSL *s, unsigned int context);
40 41
#endif

42
/* Structure to define a built-in extension */
43 44
typedef struct extensions_definition_st {
    /* The defined type for the extension */
45
    unsigned int type;
46 47 48 49 50
    /*
     * The context that this extension applies to, e.g. what messages and
     * protocol versions
     */
    unsigned int context;
51
    /*
52 53
     * Initialise extension before parsing. Always called for relevant contexts
     * even if extension not present
54
     */
55 56 57 58 59 60 61 62 63
    int (*init)(SSL *s, unsigned int context);
    /* Parse extension sent from client to server */
    int (*parse_ctos)(SSL *s, PACKET *pkt, int *al);
    /* Parse extension send from server to client */
    int (*parse_stoc)(SSL *s, PACKET *pkt, int *al);
    /* Construct extension sent from server to client */
    int (*construct_stoc)(SSL *s, WPACKET *pkt, int *al);
    /* Construct extension sent from client to server */
    int (*construct_ctos)(SSL *s, WPACKET *pkt, int *al);
64
    /*
65 66 67
     * Finalise extension after parsing. Always called where an extensions was
     * initialised even if the extension was not present. |sent| is set to 1 if
     * the extension was seen, or 0 otherwise.
68
     */
69
    int (*final)(SSL *s, unsigned int context, int sent, int *al);
70 71
} EXTENSION_DEFINITION;

M
Matt Caswell 已提交
72
/*
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
 * Definitions of all built-in extensions. NOTE: Changes in the number or order
 * of these extensions should be mirrored with equivalent changes to the indexes
 * defined in statem_locl.h.
 * Each extension has an initialiser, a client and
 * server side parser and a finaliser. The initialiser is called (if the
 * extension is relevant to the given context) even if we did not see the
 * extension in the message that we received. The parser functions are only
 * called if we see the extension in the message. The finalisers are always
 * called if the initialiser was called.
 * There are also server and client side constructor functions which are always
 * called during message construction if the extension is relevant for the
 * given context.
 * The initialisation, parsing, finalisation and construction functions are
 * always called in the order defined in this list. Some extensions may depend
 * on others having been processed first, so the order of this list is
 * significant.
 * The extension context is defined by a series of flags which specify which
 * messages the extension is relevant to. These flags also specify whether the
 * extension is relevant to a paricular protocol or protocol version.
M
Matt Caswell 已提交
92
 *
93
 * TODO(TLS1.3): Make sure we have a test to check the consistency of these
M
Matt Caswell 已提交
94
 */
95
#define INVALID_EXTENSION { 0x10000, 0, NULL, NULL, NULL, NULL, NULL, NULL }
96 97 98 99
static const EXTENSION_DEFINITION ext_defs[] = {
    {
        TLSEXT_TYPE_renegotiate,
        EXT_CLIENT_HELLO | EXT_TLS1_2_SERVER_HELLO | EXT_SSL3_ALLOWED
100 101 102 103
        | EXT_TLS1_2_AND_BELOW_ONLY,
        NULL, tls_parse_ctos_renegotiate, tls_parse_stoc_renegotiate,
        tls_construct_stoc_renegotiate, tls_construct_ctos_renegotiate,
        final_renegotiate
104 105 106 107
    },
    {
        TLSEXT_TYPE_server_name,
        EXT_CLIENT_HELLO | EXT_TLS1_2_SERVER_HELLO
108 109 110 111 112
        | EXT_TLS1_3_ENCRYPTED_EXTENSIONS,
        init_server_name,
        tls_parse_ctos_server_name, tls_parse_stoc_server_name,
        tls_construct_stoc_server_name, tls_construct_ctos_server_name,
        final_server_name
113 114 115 116
    },
#ifndef OPENSSL_NO_SRP
    {
        TLSEXT_TYPE_srp,
117 118
        EXT_CLIENT_HELLO | EXT_TLS1_2_AND_BELOW_ONLY,
        init_srp, tls_parse_ctos_srp, NULL, NULL, tls_construct_ctos_srp, NULL
119
    },
120 121
#else
    INVALID_EXTENSION,
122 123 124 125
#endif
#ifndef OPENSSL_NO_EC
    {
        TLSEXT_TYPE_ec_point_formats,
M
Matt Caswell 已提交
126
        EXT_CLIENT_HELLO | EXT_TLS1_2_SERVER_HELLO | EXT_TLS1_2_AND_BELOW_ONLY,
127 128 129
        NULL, tls_parse_ctos_ec_pt_formats, tls_parse_stoc_ec_pt_formats,
        tls_construct_stoc_ec_pt_formats, tls_construct_ctos_ec_pt_formats,
        final_ec_pt_formats
130 131 132
    },
    {
        TLSEXT_TYPE_supported_groups,
133 134
        EXT_CLIENT_HELLO | EXT_TLS1_3_ENCRYPTED_EXTENSIONS,
        NULL, tls_parse_ctos_supported_groups, NULL,
135
        NULL /* TODO(TLS1.3): Need to add this */,
136
        tls_construct_ctos_supported_groups, NULL
137
    },
138 139 140
#else
    INVALID_EXTENSION,
    INVALID_EXTENSION,
141 142 143
#endif
    {
        TLSEXT_TYPE_session_ticket,
144 145 146 147
        EXT_CLIENT_HELLO | EXT_TLS1_2_SERVER_HELLO | EXT_TLS1_2_AND_BELOW_ONLY,
        init_session_ticket, tls_parse_ctos_session_ticket,
        tls_parse_stoc_session_ticket, tls_construct_stoc_session_ticket,
        tls_construct_ctos_session_ticket, NULL
148 149 150
    },
    {
        TLSEXT_TYPE_signature_algorithms,
151 152 153
        EXT_CLIENT_HELLO,
        init_sig_algs, tls_parse_ctos_sig_algs, NULL, NULL,
        tls_construct_ctos_sig_algs, NULL
154
    },
155
#ifndef OPENSSL_NO_OCSP
156 157
    {
        TLSEXT_TYPE_status_request,
M
Matt Caswell 已提交
158
        EXT_CLIENT_HELLO | EXT_TLS1_2_SERVER_HELLO
159 160 161 162
        | EXT_TLS1_3_CERTIFICATE,
        init_status_request, tls_parse_ctos_status_request,
        tls_parse_stoc_status_request, tls_construct_stoc_status_request,
        tls_construct_ctos_status_request, final_status_request
163
    },
164 165
#else
    INVALID_EXTENSION,
166
#endif
167 168 169
#ifndef OPENSSL_NO_NEXTPROTONEG
    {
        TLSEXT_TYPE_next_proto_neg,
170 171 172
        EXT_CLIENT_HELLO | EXT_TLS1_2_SERVER_HELLO | EXT_TLS1_2_AND_BELOW_ONLY,
        init_npn, tls_parse_ctos_npn, tls_parse_stoc_npn,
        tls_construct_stoc_next_proto_neg, tls_construct_ctos_npn, NULL
173
    },
174 175
#else
    INVALID_EXTENSION,
176 177
#endif
    {
178 179 180 181
        /*
         * Must appear in this list after server_name so that finalisation
         * happens after server_name callbacks
         */
182 183
        TLSEXT_TYPE_application_layer_protocol_negotiation,
        EXT_CLIENT_HELLO | EXT_TLS1_2_SERVER_HELLO
184 185 186
        | EXT_TLS1_3_ENCRYPTED_EXTENSIONS,
        init_alpn, tls_parse_ctos_alpn, tls_parse_stoc_alpn,
        tls_construct_stoc_alpn, tls_construct_ctos_alpn, final_alpn
187
    },
188
#ifndef OPENSSL_NO_SRTP
189 190 191
    {
        TLSEXT_TYPE_use_srtp,
        EXT_CLIENT_HELLO | EXT_TLS1_2_SERVER_HELLO
192 193 194
        | EXT_TLS1_3_ENCRYPTED_EXTENSIONS | EXT_DTLS_ONLY,
        init_srtp, tls_parse_ctos_use_srtp, tls_parse_stoc_use_srtp,
        tls_construct_stoc_use_srtp, tls_construct_ctos_use_srtp, NULL
195
    },
196 197
#else
    INVALID_EXTENSION,
198
#endif
199 200
    {
        TLSEXT_TYPE_encrypt_then_mac,
201 202 203
        EXT_CLIENT_HELLO | EXT_TLS1_2_SERVER_HELLO | EXT_TLS1_2_AND_BELOW_ONLY,
        init_etm, tls_parse_ctos_etm, tls_parse_stoc_etm,
        tls_construct_stoc_etm, tls_construct_ctos_etm, NULL
204
    },
205
#ifndef OPENSSL_NO_CT
206 207
    {
        TLSEXT_TYPE_signed_certificate_timestamp,
208 209
        EXT_CLIENT_HELLO | EXT_TLS1_2_SERVER_HELLO
        | EXT_TLS1_3_CERTIFICATE,
210
        NULL,
211 212 213 214 215
        /*
         * No server side support for this, but can be provided by a custom
         * extension. This is an exception to the rule that custom extensions
         * cannot override built in ones.
         */
216
        NULL, tls_parse_stoc_sct, NULL, tls_construct_ctos_sct,  NULL
217
    },
218 219
#else
    INVALID_EXTENSION,
220
#endif
221 222
    {
        TLSEXT_TYPE_extended_master_secret,
223 224 225
        EXT_CLIENT_HELLO | EXT_TLS1_2_SERVER_HELLO | EXT_TLS1_2_AND_BELOW_ONLY,
        init_ems, tls_parse_ctos_ems, tls_parse_stoc_ems,
        tls_construct_stoc_ems, tls_construct_ctos_ems, final_ems
226 227 228
    },
    {
        TLSEXT_TYPE_supported_versions,
229
        EXT_CLIENT_HELLO | EXT_TLS_IMPLEMENTATION_ONLY | EXT_TLS1_3_ONLY,
230
        NULL,
231
        /* Processed inline as part of version selection */
232
        NULL, NULL, NULL, tls_construct_ctos_supported_versions, NULL
233 234
    },
    {
235 236 237 238
        /*
         * Must be in this list after supported_groups. We need that to have
         * been parsed before we do this one.
         */
239 240 241
        TLSEXT_TYPE_key_share,
        EXT_CLIENT_HELLO | EXT_TLS1_3_SERVER_HELLO
        | EXT_TLS1_3_HELLO_RETRY_REQUEST | EXT_TLS_IMPLEMENTATION_ONLY
242 243 244
        | EXT_TLS1_3_ONLY,
        NULL, tls_parse_ctos_key_share, tls_parse_stoc_key_share,
        tls_construct_stoc_key_share, tls_construct_ctos_key_share, NULL
245 246 247 248 249 250 251
    },
    {
        /*
         * Special unsolicited ServerHello extension only used when
         * SSL_OP_CRYPTOPRO_TLSEXT_BUG is set
         */
        TLSEXT_TYPE_cryptopro_bug,
252 253
        EXT_TLS1_2_SERVER_HELLO | EXT_TLS1_2_AND_BELOW_ONLY,
        NULL, NULL, NULL, tls_construct_stoc_cryptopro_bug, NULL, NULL
254 255 256 257
    },
    {
        /* Last in the list because it must be added as the last extension */
        TLSEXT_TYPE_padding,
258
        EXT_CLIENT_HELLO,
259
        NULL,
260
        /* We send this, but don't read it */
261
        NULL, NULL, NULL, tls_construct_ctos_padding, NULL
262 263 264 265 266 267
    }
};

/*
 * Verify whether we are allowed to use the extension |type| in the current
 * |context|. Returns 1 to indicate the extension is allowed or unknown or 0 to
268 269
 * indicate the extension is not allowed. If returning 1 then |*found| is set to
 * 1 if we found a definition for the extension, and |*idx| is set to its index
270
 */
271
static int verify_extension(SSL *s, unsigned int context, unsigned int type,
272 273
                            custom_ext_methods *meths, RAW_EXTENSION *rawexlist,
                            RAW_EXTENSION **found)
274 275
{
    size_t i;
276
    size_t builtin_num = OSSL_NELEM(ext_defs);
277
    const EXTENSION_DEFINITION *thisext;
278

279 280
    for (i = 0, thisext = ext_defs; i < builtin_num; i++, thisext++) {
        if (type == thisext->type) {
281
            /* Check we're allowed to use this extension in this context */
282
            if ((context & thisext->context) == 0)
283 284 285
                return 0;

            if (SSL_IS_DTLS(s)) {
286
                if ((thisext->context & EXT_TLS_ONLY) != 0)
287
                    return 0;
288
            } else if ((thisext->context & EXT_DTLS_ONLY) != 0) {
289 290 291
                    return 0;
            }

292
            *found = &rawexlist[i];
293 294 295 296
            return 1;
        }
    }

297 298 299 300 301
    if ((context & (EXT_CLIENT_HELLO | EXT_TLS1_2_SERVER_HELLO)) == 0) {
        /*
         * Custom extensions only apply to <=TLS1.2. This extension is unknown
         * in this context - we allow it
         */
302
        *found = NULL;
303 304
        return 1;
    }
305

306 307 308 309
    /* Check the custom extensions */
    if (meths != NULL) {
        for (i = builtin_num; i < builtin_num + meths->meths_count; i++) {
            if (meths->meths[i - builtin_num].ext_type == type) {
310
                *found = &rawexlist[i];
311 312
                return 1;
            }
313 314 315
        }
    }

316
    /* Unknown extension. We allow it */
317
    *found = NULL;
318
    return 1;
319 320
}

321 322 323 324 325
/*
 * Check whether the context defined for an extension |extctx| means whether
 * the extension is relevant for the current context |thisctx| or not. Returns
 * 1 if the extension is relevant for this context, and 0 otherwise
 */
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
static int extension_is_relevant(SSL *s, unsigned int extctx,
                                 unsigned int thisctx)
{
    if ((SSL_IS_DTLS(s)
                && (extctx & EXT_TLS_IMPLEMENTATION_ONLY) != 0)
            || (s->version == SSL3_VERSION
                    && (extctx & EXT_SSL3_ALLOWED) == 0)
            || (SSL_IS_TLS13(s)
                && (extctx & EXT_TLS1_2_AND_BELOW_ONLY) != 0)
            || (!SSL_IS_TLS13(s) && (extctx & EXT_TLS1_3_ONLY) != 0))
        return 0;

    return 1;
}

341 342
/*
 * Gather a list of all the extensions from the data in |packet]. |context|
343
 * tells us which message this extension is for. The raw extension data is
344 345 346 347 348
 * stored in |*res| on success. In the event of an error the alert type to use
 * is stored in |*al|. We don't actually process the content of the extensions
 * yet, except to check their types. This function also runs the initialiser
 * functions for all known extensions (whether we have collected them or not).
 * If successful the caller is responsible for freeing the contents of |*res|.
349 350 351 352 353
 *
 * Per http://tools.ietf.org/html/rfc5246#section-7.4.1.4, there may not be
 * more than one extension of the same type in a ClientHello or ServerHello.
 * This function returns 1 if all extensions are unique and we have parsed their
 * types, and 0 if the extensions contain duplicates, could not be successfully
354
 * found, or an internal error occurred. We only check duplicates for
355
 * extensions that we know about. We ignore others.
356 357
 */
int tls_collect_extensions(SSL *s, PACKET *packet, unsigned int context,
358
                           RAW_EXTENSION **res, int *al)
359 360
{
    PACKET extensions = *packet;
361
    size_t i = 0;
362
    custom_ext_methods *exts = NULL;
363
    RAW_EXTENSION *raw_extensions = NULL;
364
    const EXTENSION_DEFINITION *thisexd;
365

366 367
    *res = NULL;

368 369 370 371 372 373 374 375 376 377 378 379 380
    /*
     * Initialise server side custom extensions. Client side is done during
     * construction of extensions for the ClientHello.
     */
    if ((context & EXT_CLIENT_HELLO) != 0) {
        exts = &s->cert->srv_ext;
        custom_ext_init(&s->cert->srv_ext);
    } else if ((context & EXT_TLS1_2_SERVER_HELLO) != 0) {
        exts = &s->cert->cli_ext;
    }

    raw_extensions = OPENSSL_zalloc((OSSL_NELEM(ext_defs)
                                     + (exts != NULL ? exts->meths_count : 0))
381
                                     * sizeof(*raw_extensions));
382 383 384 385 386 387
    if (raw_extensions == NULL) {
        *al = SSL_AD_INTERNAL_ERROR;
        SSLerr(SSL_F_TLS_COLLECT_EXTENSIONS, ERR_R_MALLOC_FAILURE);
        return 0;
    }

388 389 390
    while (PACKET_remaining(&extensions) > 0) {
        unsigned int type;
        PACKET extension;
391
        RAW_EXTENSION *thisex;
392 393 394 395

        if (!PACKET_get_net_2(&extensions, &type) ||
            !PACKET_get_length_prefixed_2(&extensions, &extension)) {
            SSLerr(SSL_F_TLS_COLLECT_EXTENSIONS, SSL_R_BAD_EXTENSION);
396
            *al = SSL_AD_DECODE_ERROR;
397 398
            goto err;
        }
399 400 401 402
        /*
         * Verify this extension is allowed. We only check duplicates for
         * extensions that we recognise.
         */
403 404
        if (!verify_extension(s, context, type, exts, raw_extensions, &thisex)
                || (thisex != NULL && thisex->present == 1)) {
405
            SSLerr(SSL_F_TLS_COLLECT_EXTENSIONS, SSL_R_BAD_EXTENSION);
406
            *al = SSL_AD_ILLEGAL_PARAMETER;
407 408
            goto err;
        }
409 410 411 412
        if (thisex != NULL) {
            thisex->data = extension;
            thisex->present = 1;
            thisex->type = type;
413 414 415
        }
    }

416 417 418 419
    /*
     * Initialise all known extensions relevant to this context, whether we have
     * found them or not
     */
420 421 422 423
    for (thisexd = ext_defs, i = 0; i < OSSL_NELEM(ext_defs); i++, thisexd++) {
        if(thisexd->init != NULL && (thisexd->context & context) != 0
                && extension_is_relevant(s, thisexd->context, context)
                && !thisexd->init(s, context)) {
424
            *al = SSL_AD_INTERNAL_ERROR;
425 426 427 428
            goto err;
        }
    }

429 430 431 432 433 434 435 436
    *res = raw_extensions;
    return 1;

 err:
    OPENSSL_free(raw_extensions);
    return 0;
}

437
/*
438 439 440 441 442 443
 * Runs the parser for a given extension with index |idx|. |exts| contains the
 * list of all parsed extensions previously collected by
 * tls_collect_extensions(). The parser is only run if it is applicable for the
 * given |context| and the parser has not already been run. Returns 1 on success
 * or 0 on failure. In the event of a failure |*al| is populated with a suitable
 * alert code. If an extension is not present this counted as success.
444
 */
445
int tls_parse_extension(SSL *s, TLSEXT_INDEX idx, int context,
446
                        RAW_EXTENSION *exts, int *al)
447
{
448 449
    RAW_EXTENSION *currext = &exts[idx];
    int (*parser)(SSL *s, PACKET *pkt, int *al) = NULL;
450

451 452 453
    /* Skip if the extension is not present */
    if (!currext->present)
        return 1;
454

455 456 457 458 459
    if (s->tlsext_debug_cb)
        s->tlsext_debug_cb(s, !s->server, currext->type,
                           PACKET_data(&currext->data),
                           PACKET_remaining(&currext->data),
                           s->tlsext_debug_arg);
460

461 462 463
    /* Skip if we've already parsed this extension */
    if (currext->parsed)
        return 1;
464

465 466 467 468 469 470 471 472 473 474
    currext->parsed = 1;

    if (idx < OSSL_NELEM(ext_defs)) {
        /* We are handling a built-in extension */
        const EXTENSION_DEFINITION *extdef = &ext_defs[idx];

        /* Check if extension is defined for our protocol. If not, skip */
        if (!extension_is_relevant(s, extdef->context, context))
            return 1;

475
        parser = s->server ? extdef->parse_ctos : extdef->parse_stoc;
M
Matt Caswell 已提交
476

477 478
        if (parser != NULL)
            return parser(s, &currext->data, al);
479

480 481 482 483
        /*
         * If the parser is NULL we fall through to the custom extension
         * processing
         */
484 485
    }

486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
    /*
     * This is a custom extension. We only allow this if it is a non
     * resumed session on the server side.
     *
     * TODO(TLS1.3): We only allow old style <=TLS1.2 custom extensions.
     * We're going to need a new mechanism for TLS1.3 to specify which
     * messages to add the custom extensions to.
     */
    if ((!s->hit || !s->server)
            && (context
                & (EXT_CLIENT_HELLO | EXT_TLS1_2_SERVER_HELLO)) != 0
            && custom_ext_parse(s, s->server, currext->type,
                                PACKET_data(&currext->data),
                                PACKET_remaining(&currext->data),
                                al) <= 0)
        return 0;

503 504 505 506 507
    return 1;
}

/*
 * Parse all remaining extensions that have not yet been parsed. Also calls the
508 509 510
 * finalisation for all extensions at the end, whether we collected them or not.
 * Returns 1 for success or 0 for failure. On failure, |*al| is populated with a
 * suitable alert code.
511
 */
512
int tls_parse_all_extensions(SSL *s, int context, RAW_EXTENSION *exts, int *al)
513
{
514
    size_t i, numexts = OSSL_NELEM(ext_defs);
515
    const EXTENSION_DEFINITION *thisexd;
516

517 518 519 520 521 522 523 524
    /* Calculate the number of extensions in the extensions list */
    if ((context & EXT_CLIENT_HELLO) != 0) {
        numexts += s->cert->srv_ext.meths_count;
    } else if ((context & EXT_TLS1_2_SERVER_HELLO) != 0) {
        numexts += s->cert->cli_ext.meths_count;
    }

    /* Parse each extension in turn */
525
    for (i = 0; i < numexts; i++) {
526
        if (!tls_parse_extension(s, i, context, exts, al))
527 528
            return 0;
    }
529

530 531 532 533
    /*
     * Finalise all known extensions relevant to this context, whether we have
     * found them or not
     */
534 535 536 537
    for (i = 0, thisexd = ext_defs; i < OSSL_NELEM(ext_defs); i++, thisexd++) {
        if(thisexd->final != NULL
                && (thisexd->context & context) != 0
                && !thisexd->final(s, context, exts[i].present, al))
538 539 540
            return 0;
    }

541 542 543 544
    return 1;
}

/*
545 546
 * Construct all the extensions relevant to the current |context| and write
 * them to |pkt|. Returns 1 on success or 0 on failure. If a failure occurs then
547 548
 * |al| is populated with a suitable alert code. On a failure construction stops
 * at the first extension to fail to construct.
549
 */
M
Matt Caswell 已提交
550 551 552
int tls_construct_extensions(SSL *s, WPACKET *pkt, unsigned int context,
                             int *al)
{
553 554
    size_t i;
    int addcustom = 0, min_version, max_version = 0, reason, tmpal;
555
    const EXTENSION_DEFINITION *thisexd;
M
Matt Caswell 已提交
556

557
    /*
558
     * Normally if something goes wrong during construction it's an internal
559 560
     * error. We can always override this later.
     */
561
    tmpal = SSL_AD_INTERNAL_ERROR;
562

M
Matt Caswell 已提交
563 564 565
    if (!WPACKET_start_sub_packet_u16(pkt)
               /*
                * If extensions are of zero length then we don't even add the
566
                * extensions length bytes to a ClientHello/ServerHello in SSLv3
M
Matt Caswell 已提交
567
                */
568 569
            || ((context & (EXT_CLIENT_HELLO | EXT_TLS1_2_SERVER_HELLO)) != 0
               && s->version == SSL3_VERSION
M
Matt Caswell 已提交
570 571 572
               && !WPACKET_set_flags(pkt,
                                     WPACKET_FLAGS_ABANDON_ON_ZERO_LENGTH))) {
        SSLerr(SSL_F_TLS_CONSTRUCT_EXTENSIONS, ERR_R_INTERNAL_ERROR);
573
        goto err;
M
Matt Caswell 已提交
574 575
    }

576 577 578 579
    if ((context & EXT_CLIENT_HELLO) != 0) {
        reason = ssl_get_client_min_max_version(s, &min_version, &max_version);
        if (reason != 0) {
            SSLerr(SSL_F_TLS_CONSTRUCT_EXTENSIONS, reason);
580
            goto err;
581 582 583 584 585 586 587 588 589 590 591
        }
    }

    /* Add custom extensions first */
    if ((context & EXT_CLIENT_HELLO) != 0) {
        custom_ext_init(&s->cert->cli_ext);
        addcustom = 1;
    } else if ((context & EXT_TLS1_2_SERVER_HELLO) != 0) {
        /*
         * We already initialised the custom extensions during ClientHello
         * parsing.
M
Matt Caswell 已提交
592
         *
593 594 595 596 597 598 599
         * TODO(TLS1.3): We're going to need a new custom extension mechanism
         * for TLS1.3, so that custom extensions can specify which of the
         * multiple message they wish to add themselves to.
         */
        addcustom = 1;
    }

600
    if (addcustom && !custom_ext_add(s, s->server, pkt, &tmpal)) {
601
        SSLerr(SSL_F_TLS_CONSTRUCT_EXTENSIONS, ERR_R_INTERNAL_ERROR);
602
        goto err;
603 604
    }

605
    for (i = 0, thisexd = ext_defs; i < OSSL_NELEM(ext_defs); i++, thisexd++) {
M
Matt Caswell 已提交
606 607
        int (*construct)(SSL *s, WPACKET *pkt, int *al);

M
Matt Caswell 已提交
608
        /* Skip if not relevant for our context */
609
        if ((thisexd->context & context) == 0)
M
Matt Caswell 已提交
610 611
            continue;

612 613
        construct = s->server ? thisexd->construct_stoc
                              : thisexd->construct_ctos;
M
Matt Caswell 已提交
614 615 616

        /* Check if this extension is defined for our protocol. If not, skip */
        if ((SSL_IS_DTLS(s)
617
                    && (thisexd->context & EXT_TLS_IMPLEMENTATION_ONLY)
M
Matt Caswell 已提交
618
                       != 0)
M
Matt Caswell 已提交
619
                || (s->version == SSL3_VERSION
620
                        && (thisexd->context & EXT_SSL3_ALLOWED) == 0)
M
Matt Caswell 已提交
621
                || (SSL_IS_TLS13(s)
622
                    && (thisexd->context & EXT_TLS1_2_AND_BELOW_ONLY)
M
Matt Caswell 已提交
623
                       != 0)
M
Matt Caswell 已提交
624
                || (!SSL_IS_TLS13(s)
625
                    && (thisexd->context & EXT_TLS1_3_ONLY) != 0
M
Matt Caswell 已提交
626
                    && (context & EXT_CLIENT_HELLO) == 0)
627
                || ((thisexd->context & EXT_TLS1_3_ONLY) != 0
628 629
                    && (context & EXT_CLIENT_HELLO) != 0
                    && (SSL_IS_DTLS(s) || max_version < TLS1_3_VERSION))
M
Matt Caswell 已提交
630 631 632
                || construct == NULL)
            continue;

633 634
        if (!construct(s, pkt, &tmpal))
            goto err;
M
Matt Caswell 已提交
635 636 637 638
    }

    if (!WPACKET_close(pkt)) {
        SSLerr(SSL_F_TLS_CONSTRUCT_EXTENSIONS, ERR_R_INTERNAL_ERROR);
639
        goto err;
M
Matt Caswell 已提交
640 641 642
    }

    return 1;
643 644 645 646

 err:
    *al = tmpal;
    return 0;
M
Matt Caswell 已提交
647
}
648

649 650 651 652 653 654 655 656
/*
 * Built in extension finalisation and initialisation functions. All initialise
 * or finalise the associated extension type for the given |context|. For
 * finalisers |sent| is set to 1 if we saw the extension during parsing, and 0
 * otherwise. These functions return 1 on success or 0 on failure. In the event
 * of a failure then |*al| is populated with a suitable error code.
 */

657
static int final_renegotiate(SSL *s, unsigned int context, int sent,
658 659
                                     int *al)
{
660 661 662 663 664 665 666 667 668
    if (!s->server) {
        /*
         * Check if we can connect to a server that doesn't support safe
         * renegotiation
         */
        if (!(s->options & SSL_OP_LEGACY_SERVER_CONNECT)
                && !(s->options & SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION)
                && !sent) {
            *al = SSL_AD_HANDSHAKE_FAILURE;
M
Matt Caswell 已提交
669
            SSLerr(SSL_F_FINAL_RENEGOTIATE,
670 671 672 673
                   SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED);
            return 0;
        }

674
        return 1;
675
    }
676 677 678 679 680 681

    /* Need RI if renegotiating */
    if (s->renegotiate
            && !(s->options & SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION)
            && !sent) {
        *al = SSL_AD_HANDSHAKE_FAILURE;
M
Matt Caswell 已提交
682
        SSLerr(SSL_F_FINAL_RENEGOTIATE,
683 684 685 686
               SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED);
        return 0;
    }

687

688 689 690
    return 1;
}

691
static int init_server_name(SSL *s, unsigned int context)
692 693 694 695 696 697 698
{
    if (s->server)
        s->servername_done = 0;

    return 1;
}

699
static int final_server_name(SSL *s, unsigned int context, int sent,
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
                                     int *al)
{
    int ret = SSL_TLSEXT_ERR_NOACK;
    int altmp = SSL_AD_UNRECOGNIZED_NAME;

    if (s->ctx != NULL && s->ctx->tlsext_servername_callback != 0)
        ret = s->ctx->tlsext_servername_callback(s, &altmp,
                                                 s->ctx->tlsext_servername_arg);
    else if (s->initial_ctx != NULL
             && s->initial_ctx->tlsext_servername_callback != 0)
        ret = s->initial_ctx->tlsext_servername_callback(s, &altmp,
                                       s->initial_ctx->tlsext_servername_arg);

    switch (ret) {
    case SSL_TLSEXT_ERR_ALERT_FATAL:
        *al = altmp;
        return 0;

    case SSL_TLSEXT_ERR_ALERT_WARNING:
        *al = altmp;
        return 1;

    case SSL_TLSEXT_ERR_NOACK:
        s->servername_done = 0;
        return 1;

    default:
        return 1;
    }
}

731
#ifndef OPENSSL_NO_EC
732
static int final_ec_pt_formats(SSL *s, unsigned int context, int sent,
733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
                                       int *al)
{
    unsigned long alg_k, alg_a;

    if (s->server)
        return 1;

    alg_k = s->s3->tmp.new_cipher->algorithm_mkey;
    alg_a = s->s3->tmp.new_cipher->algorithm_auth;

    /*
     * If we are client and using an elliptic curve cryptography cipher
     * suite, then if server returns an EC point formats lists extension it
     * must contain uncompressed.
     */
748 749 750 751 752
    if (s->tlsext_ecpointformatlist != NULL
            && s->tlsext_ecpointformatlist_length > 0
            && s->session->tlsext_ecpointformatlist != NULL
            && s->session->tlsext_ecpointformatlist_length > 0
            && ((alg_k & SSL_kECDHE) || (alg_a & SSL_aECDSA))) {
753 754
        /* we are using an ECC cipher */
        size_t i;
755 756
        unsigned char *list = s->session->tlsext_ecpointformatlist;

757
        for (i = 0; i < s->session->tlsext_ecpointformatlist_length; i++) {
758
            if (*list++ == TLSEXT_ECPOINTFORMAT_uncompressed)
759 760
                break;
        }
761
        if (i == s->session->tlsext_ecpointformatlist_length) {
M
Matt Caswell 已提交
762
            SSLerr(SSL_F_FINAL_EC_PT_FORMATS,
763 764 765 766 767 768 769 770 771
                   SSL_R_TLS_INVALID_ECPOINTFORMAT_LIST);
            return 0;
        }
    }

    return 1;
}
#endif

772
static int init_session_ticket(SSL *s, unsigned int context)
773 774 775 776 777 778 779
{
    if (!s->server)
        s->tlsext_ticket_expected = 0;

    return 1;
}

780
static int init_status_request(SSL *s, unsigned int context)
781 782
{
    if (s->server)
783
        s->tlsext_status_type = TLSEXT_STATUSTYPE_nothing;
784 785 786 787

    return 1;
}

788
static int final_status_request(SSL *s, unsigned int context, int sent,
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
                                        int *al)
{
    if (s->server)
        return 1;

    /*
     * Ensure we get sensible values passed to tlsext_status_cb in the event
     * that we don't receive a status message
     */
    OPENSSL_free(s->tlsext_ocsp_resp);
    s->tlsext_ocsp_resp = NULL;
    s->tlsext_ocsp_resplen = 0;

    return 1;
}

805
#ifndef OPENSSL_NO_NEXTPROTONEG
806
static int init_npn(SSL *s, unsigned int context)
807
{
808
    s->s3->next_proto_neg_seen = 0;
809 810 811 812 813

    return 1;
}
#endif

814
static int init_alpn(SSL *s, unsigned int context)
815
{
816 817
    OPENSSL_free(s->s3->alpn_selected);
    s->s3->alpn_selected = NULL;
818 819 820 821 822 823 824 825 826
    if (s->server) {
        s->s3->alpn_selected_len = 0;
        OPENSSL_free(s->s3->alpn_proposed);
        s->s3->alpn_proposed = NULL;
        s->s3->alpn_proposed_len = 0;
    }
    return 1;
}

827
static int final_alpn(SSL *s, unsigned int context, int sent, int *al)
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861
{
    const unsigned char *selected = NULL;
    unsigned char selected_len = 0;

    if (!s->server)
        return 1;

    if (s->ctx->alpn_select_cb != NULL && s->s3->alpn_proposed != NULL) {
        int r = s->ctx->alpn_select_cb(s, &selected, &selected_len,
                                       s->s3->alpn_proposed,
                                       (unsigned int)s->s3->alpn_proposed_len,
                                       s->ctx->alpn_select_cb_arg);

        if (r == SSL_TLSEXT_ERR_OK) {
            OPENSSL_free(s->s3->alpn_selected);
            s->s3->alpn_selected = OPENSSL_memdup(selected, selected_len);
            if (s->s3->alpn_selected == NULL) {
                *al = SSL_AD_INTERNAL_ERROR;
                return 0;
            }
            s->s3->alpn_selected_len = selected_len;
#ifndef OPENSSL_NO_NEXTPROTONEG
            /* ALPN takes precedence over NPN. */
            s->s3->next_proto_neg_seen = 0;
#endif
        } else {
            *al = SSL_AD_NO_APPLICATION_PROTOCOL;
            return 0;
        }
    }

    return 1;
}

862
static int init_sig_algs(SSL *s, unsigned int context)
863 864 865 866 867 868 869 870 871
{
    /* Clear any signature algorithms extension received */
    OPENSSL_free(s->s3->tmp.peer_sigalgs);
    s->s3->tmp.peer_sigalgs = NULL;

    return 1;
}

#ifndef OPENSSL_NO_SRP
872
static int init_srp(SSL *s, unsigned int context)
873 874 875 876 877 878 879 880
{
    OPENSSL_free(s->srp_ctx.login);
    s->srp_ctx.login = NULL;

    return 1;
}
#endif

881
static int init_etm(SSL *s, unsigned int context)
882
{
883 884 885 886 887
    s->s3->flags &= ~TLS1_FLAGS_ENCRYPT_THEN_MAC;

    return 1;
}

888
static int init_ems(SSL *s, unsigned int context)
889 890 891 892 893 894 895
{
    if (!s->server)
        s->s3->flags &= ~TLS1_FLAGS_RECEIVED_EXTMS;

    return 1;
}

896
static int final_ems(SSL *s, unsigned int context, int sent, int *al)
897 898 899 900 901 902 903 904 905
{
    if (!s->server && s->hit) {
        /*
         * Check extended master secret extension is consistent with
         * original session.
         */
        if (!(s->s3->flags & TLS1_FLAGS_RECEIVED_EXTMS) !=
            !(s->session->flags & SSL_SESS_FLAG_EXTMS)) {
            *al = SSL_AD_HANDSHAKE_FAILURE;
M
Matt Caswell 已提交
906
            SSLerr(SSL_F_FINAL_EMS, SSL_R_INCONSISTENT_EXTMS);
907 908 909
            return 0;
        }
    }
910 911 912 913 914

    return 1;
}

#ifndef OPENSSL_NO_SRTP
915
static int init_srtp(SSL *s, unsigned int context)
916 917 918 919 920 921 922
{
    if (s->server)
        s->srtp_profile = NULL;

    return 1;
}
#endif