ssl/statem/extensions_cust.c

   1 /*
   2  * Copyright 2014-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (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 /* Custom extension utility functions */
  11
  12 #include <assert.h>
  13 #include <openssl/ct.h>
  14 #include "../ssl_locl.h"
  15 #include "statem_locl.h"
  16
  17 typedef struct {
  18     void *add_arg;
  19     custom_ext_add_cb add_cb;
  20     custom_ext_free_cb free_cb;
  21 } custom_ext_add_cb_wrap;
  22
  23 typedef struct {
  24     void *parse_arg;
  25     custom_ext_parse_cb parse_cb;
  26 } custom_ext_parse_cb_wrap;
  27
  28 /*
  29  * Provide thin wrapper callbacks which convert new style arguments to old style
  30  */
  31 static int custom_ext_add_old_cb_wrap(SSL *s, unsigned int ext_type,
  32                                       unsigned int context,
  33                                       const unsigned char **out,
  34                                       size_t *outlen, X509 *x, size_t chainidx,
  35                                       int *al, void *add_arg)
  36 {
  37     custom_ext_add_cb_wrap *add_cb_wrap = (custom_ext_add_cb_wrap *)add_arg;
  38
  39     if (add_cb_wrap->add_cb == NULL)
  40         return 1;
  41
  42     return add_cb_wrap->add_cb(s, ext_type, out, outlen, al,
  43                                add_cb_wrap->add_arg);
  44 }
  45
  46 static void custom_ext_free_old_cb_wrap(SSL *s, unsigned int ext_type,
  47                                         unsigned int context,
  48                                         const unsigned char *out, void *add_arg)
  49 {
  50     custom_ext_add_cb_wrap *add_cb_wrap = (custom_ext_add_cb_wrap *)add_arg;
  51
  52     if (add_cb_wrap->free_cb == NULL)
  53         return;
  54
  55     add_cb_wrap->free_cb(s, ext_type, out, add_cb_wrap->add_arg);
  56 }
  57
  58 static int custom_ext_parse_old_cb_wrap(SSL *s, unsigned int ext_type,
  59                                         unsigned int context,
  60                                         const unsigned char *in,
  61                                         size_t inlen, X509 *x, size_t chainidx,
  62                                         int *al, void *parse_arg)
  63 {
  64     custom_ext_parse_cb_wrap *parse_cb_wrap =
  65         (custom_ext_parse_cb_wrap *)parse_arg;
  66
  67     if (parse_cb_wrap->parse_cb == NULL)
  68         return 1;
  69
  70     return parse_cb_wrap->parse_cb(s, ext_type, in, inlen, al,
  71                                    parse_cb_wrap->parse_arg);
  72 }
  73
  74 /*
  75  * Find a custom extension from the list. The |role| param is there to
  76  * support the legacy API where custom extensions for client and server could
  77  * be set independently on the same SSL_CTX. It is set to ENDPOINT_SERVER if we
  78  * are trying to find a method relevant to the server, ENDPOINT_CLIENT for the
  79  * client, or ENDPOINT_BOTH for either
  80  */
  81 custom_ext_method *custom_ext_find(const custom_ext_methods *exts,
  82                                    ENDPOINT role, unsigned int ext_type,
  83                                    size_t *idx)
  84 {
  85     size_t i;
  86     custom_ext_method *meth = exts->meths;
  87
  88     for (i = 0; i < exts->meths_count; i++, meth++) {
  89         if (ext_type == meth->ext_type
  90                 && (role == ENDPOINT_BOTH || role == meth->role
  91                     || meth->role == ENDPOINT_BOTH)) {
  92             if (idx != NULL)
  93                 *idx = i;
  94             return meth;
  95         }
  96     }
  97     return NULL;
  98 }
  99
 100 /*
 101  * Initialise custom extensions flags to indicate neither sent nor received.
 102  */
 103 void custom_ext_init(custom_ext_methods *exts)
 104 {
 105     size_t i;
 106     custom_ext_method *meth = exts->meths;
 107
 108     for (i = 0; i < exts->meths_count; i++, meth++)
 109         meth->ext_flags = 0;
 110 }
 111
 112 /* Pass received custom extension data to the application for parsing. */
 113 int custom_ext_parse(SSL *s, unsigned int context, unsigned int ext_type,
 114                      const unsigned char *ext_data, size_t ext_size, X509 *x,
 115                      size_t chainidx, int *al)
 116 {
 117     custom_ext_methods *exts = &s->cert->custext;
 118     custom_ext_method *meth;
 119     ENDPOINT role = ENDPOINT_BOTH;
 120
 121     if ((context & (SSL_EXT_CLIENT_HELLO | SSL_EXT_TLS1_2_SERVER_HELLO)) != 0)
 122         role = s->server ? ENDPOINT_SERVER : ENDPOINT_CLIENT;
 123
 124     meth = custom_ext_find(exts, role, ext_type, NULL);
 125     /* If not found return success */
 126     if (!meth)
 127         return 1;
 128
 129     /* Check if extension is defined for our protocol. If not, skip */
 130     if (!extension_is_relevant(s, meth->context, context))
 131         return 1;
 132
 133     if ((context & (SSL_EXT_TLS1_2_SERVER_HELLO
 134                     | SSL_EXT_TLS1_3_SERVER_HELLO
 135                     | SSL_EXT_TLS1_3_ENCRYPTED_EXTENSIONS)) != 0) {
 136         /*
 137          * If it's ServerHello or EncryptedExtensions we can't have any
 138          * extensions not sent in ClientHello.
 139          */
 140         if ((meth->ext_flags & SSL_EXT_FLAG_SENT) == 0) {
 141             *al = TLS1_AD_UNSUPPORTED_EXTENSION;
 142             return 0;
 143         }
 144     }
 145
 146     /*
 147      * Extensions received in the ClientHello are marked with the
 148      * SSL_EXT_FLAG_RECEIVED. This is so we know to add the equivalent
 149      * extensions in the ServerHello/EncryptedExtensions message
 150      */
 151     if ((context & SSL_EXT_CLIENT_HELLO) != 0)
 152         meth->ext_flags |= SSL_EXT_FLAG_RECEIVED;
 153
 154     /* If no parse function set return success */
 155     if (!meth->parse_cb)
 156         return 1;
 157
 158     return meth->parse_cb(s, ext_type, context, ext_data, ext_size, x, chainidx,
 159                           al, meth->parse_arg);
 160 }
 161
 162 /*
 163  * Request custom extension data from the application and add to the return
 164  * buffer.
 165  */
 166 int custom_ext_add(SSL *s, int context, WPACKET *pkt, X509 *x, size_t chainidx,
 167                    int maxversion, int *al)
 168 {
 169     custom_ext_methods *exts = &s->cert->custext;
 170     custom_ext_method *meth;
 171     size_t i;
 172
 173     for (i = 0; i < exts->meths_count; i++) {
 174         const unsigned char *out = NULL;
 175         size_t outlen = 0;
 176
 177         meth = exts->meths + i;
 178
 179         if (!should_add_extension(s, meth->context, context, maxversion))
 180             continue;
 181
 182         if ((context & (SSL_EXT_TLS1_2_SERVER_HELLO
 183                         | SSL_EXT_TLS1_3_SERVER_HELLO
 184                         | SSL_EXT_TLS1_3_ENCRYPTED_EXTENSIONS
 185                         | SSL_EXT_TLS1_3_CERTIFICATE
 186                         | SSL_EXT_TLS1_3_HELLO_RETRY_REQUEST)) != 0) {
 187             /* Only send extensions present in ClientHello. */
 188             if (!(meth->ext_flags & SSL_EXT_FLAG_RECEIVED))
 189                 continue;
 190         }
 191         /*
 192          * We skip it if the callback is absent - except for a ClientHello where
 193          * we add an empty extension.
 194          */
 195         if ((context & SSL_EXT_CLIENT_HELLO) == 0 && meth->add_cb == NULL)
 196             continue;
 197
 198         if (meth->add_cb != NULL) {
 199             int cb_retval = meth->add_cb(s, meth->ext_type, context, &out,
 200                                          &outlen, x, chainidx, al,
 201                                          meth->add_arg);
 202
 203             if (cb_retval < 0)
 204                 return 0;       /* error */
 205             if (cb_retval == 0)
 206                 continue;       /* skip this extension */
 207         }
 208
 209         if (!WPACKET_put_bytes_u16(pkt, meth->ext_type)
 210                 || !WPACKET_start_sub_packet_u16(pkt)
 211                 || (outlen > 0 && !WPACKET_memcpy(pkt, out, outlen))
 212                 || !WPACKET_close(pkt)) {
 213             *al = SSL_AD_INTERNAL_ERROR;
 214             return 0;
 215         }
 216         if ((context & SSL_EXT_CLIENT_HELLO) != 0) {
 217             /*
 218              * We can't send duplicates: code logic should prevent this.
 219              */
 220             assert((meth->ext_flags & SSL_EXT_FLAG_SENT) == 0);
 221             /*
 222              * Indicate extension has been sent: this is both a sanity check to
 223              * ensure we don't send duplicate extensions and indicates that it
 224              * is not an error if the extension is present in ServerHello.
 225              */
 226             meth->ext_flags |= SSL_EXT_FLAG_SENT;
 227         }
 228         if (meth->free_cb != NULL)
 229             meth->free_cb(s, meth->ext_type, context, out, meth->add_arg);
 230     }
 231     return 1;
 232 }
 233
 234 /* Copy table of custom extensions */
 235 int custom_exts_copy(custom_ext_methods *dst, const custom_ext_methods *src)
 236 {
 237     size_t i;
 238     int err = 0;
 239
 240     if (src->meths_count > 0) {
 241         dst->meths =
 242             OPENSSL_memdup(src->meths,
 243                            sizeof(*src->meths) * src->meths_count);
 244         if (dst->meths == NULL)
 245             return 0;
 246         dst->meths_count = src->meths_count;
 247
 248         for (i = 0; i < src->meths_count; i++) {
 249             custom_ext_method *methsrc = src->meths + i;
 250             custom_ext_method *methdst = dst->meths + i;
 251
 252             if (methsrc->add_cb != custom_ext_add_old_cb_wrap)
 253                 continue;
 254
 255             /*
 256              * We have found an old style API wrapper. We need to copy the
 257              * arguments too.
 258              */
 259
 260             if (err) {
 261                 methdst->add_arg = NULL;
 262                 methdst->parse_arg = NULL;
 263                 continue;
 264             }
 265
 266             methdst->add_arg = OPENSSL_memdup(methsrc->add_arg,
 267                                               sizeof(custom_ext_add_cb_wrap));
 268             methdst->parse_arg = OPENSSL_memdup(methsrc->parse_arg,
 269                                             sizeof(custom_ext_parse_cb_wrap));
 270
 271             if (methdst->add_arg == NULL || methdst->parse_arg == NULL)
 272                 err = 1;
 273         }
 274     }
 275
 276     if (err) {
 277         custom_exts_free(dst);
 278         return 0;
 279     }
 280
 281     return 1;
 282 }
 283
 284 void custom_exts_free(custom_ext_methods *exts)
 285 {
 286     size_t i;
 287     custom_ext_method *meth;
 288
 289     for (i = 0, meth = exts->meths; i < exts->meths_count; i++, meth++) {
 290         if (meth->add_cb != custom_ext_add_old_cb_wrap)
 291             continue;
 292
 293         /* Old style API wrapper. Need to free the arguments too */
 294         OPENSSL_free(meth->add_arg);
 295         OPENSSL_free(meth->parse_arg);
 296     }
 297     OPENSSL_free(exts->meths);
 298 }
 299
 300 /* Return true if a client custom extension exists, false otherwise */
 301 int SSL_CTX_has_client_custom_ext(const SSL_CTX *ctx, unsigned int ext_type)
 302 {
 303     return custom_ext_find(&ctx->cert->custext, ENDPOINT_CLIENT, ext_type,
 304                            NULL) != NULL;
 305 }
 306
 307 static int add_custom_ext_intern(SSL_CTX *ctx, ENDPOINT role,
 308                                  unsigned int ext_type,
 309                                  unsigned int context,
 310                                  SSL_custom_ext_add_cb_ex add_cb,
 311                                  SSL_custom_ext_free_cb_ex free_cb,
 312                                  void *add_arg,
 313                                  SSL_custom_ext_parse_cb_ex parse_cb,
 314                                  void *parse_arg)
 315 {
 316     custom_ext_methods *exts = &ctx->cert->custext;
 317     custom_ext_method *meth, *tmp;
 318
 319     /*
 320      * Check application error: if add_cb is not set free_cb will never be
 321      * called.
 322      */
 323     if (add_cb == NULL && free_cb != NULL)
 324         return 0;
 325
 326 #ifndef OPENSSL_NO_CT
 327     /*
 328      * We don't want applications registering callbacks for SCT extensions
 329      * whilst simultaneously using the built-in SCT validation features, as
 330      * these two things may not play well together.
 331      */
 332     if (ext_type == TLSEXT_TYPE_signed_certificate_timestamp
 333             && (context & SSL_EXT_CLIENT_HELLO) != 0
 334             && SSL_CTX_ct_is_enabled(ctx))
 335         return 0;
 336 #endif
 337
 338     /*
 339      * Don't add if extension supported internally, but make exception
 340      * for extension types that previously were not supported, but now are.
 341      */
 342     if (SSL_extension_supported(ext_type)
 343             && ext_type != TLSEXT_TYPE_signed_certificate_timestamp)
 344         return 0;
 345
 346     /* Extension type must fit in 16 bits */
 347     if (ext_type > 0xffff)
 348         return 0;
 349     /* Search for duplicate */
 350     if (custom_ext_find(exts, role, ext_type, NULL))
 351         return 0;
 352     tmp = OPENSSL_realloc(exts->meths,
 353                           (exts->meths_count + 1) * sizeof(custom_ext_method));
 354     if (tmp == NULL)
 355         return 0;
 356
 357     exts->meths = tmp;
 358     meth = exts->meths + exts->meths_count;
 359     memset(meth, 0, sizeof(*meth));
 360     meth->role = role;
 361     meth->context = context;
 362     meth->parse_cb = parse_cb;
 363     meth->add_cb = add_cb;
 364     meth->free_cb = free_cb;
 365     meth->ext_type = ext_type;
 366     meth->add_arg = add_arg;
 367     meth->parse_arg = parse_arg;
 368     exts->meths_count++;
 369     return 1;
 370 }
 371
 372 static int add_old_custom_ext(SSL_CTX *ctx, ENDPOINT role,
 373                               unsigned int ext_type,
 374                               unsigned int context,
 375                               custom_ext_add_cb add_cb,
 376                               custom_ext_free_cb free_cb,
 377                               void *add_arg,
 378                               custom_ext_parse_cb parse_cb, void *parse_arg)
 379 {
 380     custom_ext_add_cb_wrap *add_cb_wrap
 381         = OPENSSL_malloc(sizeof(*add_cb_wrap));
 382     custom_ext_parse_cb_wrap *parse_cb_wrap
 383         = OPENSSL_malloc(sizeof(*parse_cb_wrap));
 384     int ret;
 385
 386     if (add_cb_wrap == NULL || parse_cb_wrap == NULL) {
 387         OPENSSL_free(add_cb_wrap);
 388         OPENSSL_free(parse_cb_wrap);
 389         return 0;
 390     }
 391
 392     add_cb_wrap->add_arg = add_arg;
 393     add_cb_wrap->add_cb = add_cb;
 394     add_cb_wrap->free_cb = free_cb;
 395     parse_cb_wrap->parse_arg = parse_arg;
 396     parse_cb_wrap->parse_cb = parse_cb;
 397
 398     ret = add_custom_ext_intern(ctx, role, ext_type,
 399                                 context,
 400                                 custom_ext_add_old_cb_wrap,
 401                                 custom_ext_free_old_cb_wrap,
 402                                 add_cb_wrap,
 403                                 custom_ext_parse_old_cb_wrap,
 404                                 parse_cb_wrap);
 405
 406     if (!ret) {
 407         OPENSSL_free(add_cb_wrap);
 408         OPENSSL_free(parse_cb_wrap);
 409     }
 410
 411     return ret;
 412 }
 413
 414 /* Application level functions to add the old custom extension callbacks */
 415 int SSL_CTX_add_client_custom_ext(SSL_CTX *ctx, unsigned int ext_type,
 416                                   custom_ext_add_cb add_cb,
 417                                   custom_ext_free_cb free_cb,
 418                                   void *add_arg,
 419                                   custom_ext_parse_cb parse_cb, void *parse_arg)
 420 {
 421     return add_old_custom_ext(ctx, ENDPOINT_CLIENT, ext_type,
 422                               SSL_EXT_TLS1_2_AND_BELOW_ONLY
 423                               | SSL_EXT_CLIENT_HELLO
 424                               | SSL_EXT_TLS1_2_SERVER_HELLO
 425                               | SSL_EXT_IGNORE_ON_RESUMPTION,
 426                               add_cb, free_cb, add_arg, parse_cb, parse_arg);
 427 }
 428
 429 int SSL_CTX_add_server_custom_ext(SSL_CTX *ctx, unsigned int ext_type,
 430                                   custom_ext_add_cb add_cb,
 431                                   custom_ext_free_cb free_cb,
 432                                   void *add_arg,
 433                                   custom_ext_parse_cb parse_cb, void *parse_arg)
 434 {
 435     return add_old_custom_ext(ctx, ENDPOINT_SERVER, ext_type,
 436                               SSL_EXT_TLS1_2_AND_BELOW_ONLY
 437                               | SSL_EXT_CLIENT_HELLO
 438                               | SSL_EXT_TLS1_2_SERVER_HELLO
 439                               | SSL_EXT_IGNORE_ON_RESUMPTION,
 440                               add_cb, free_cb, add_arg, parse_cb, parse_arg);
 441 }
 442
 443 int SSL_CTX_add_custom_ext(SSL_CTX *ctx, unsigned int ext_type,
 444                            unsigned int context,
 445                            SSL_custom_ext_add_cb_ex add_cb,
 446                            SSL_custom_ext_free_cb_ex free_cb,
 447                            void *add_arg,
 448                            SSL_custom_ext_parse_cb_ex parse_cb, void *parse_arg)
 449 {
 450     return add_custom_ext_intern(ctx, ENDPOINT_BOTH, ext_type, context, add_cb,
 451                                  free_cb, add_arg, parse_cb, parse_arg);
 452 }
 453
 454 int SSL_extension_supported(unsigned int ext_type)
 455 {
 456     switch (ext_type) {
 457         /* Internally supported extensions. */
 458     case TLSEXT_TYPE_application_layer_protocol_negotiation:
 459 #ifndef OPENSSL_NO_EC
 460     case TLSEXT_TYPE_ec_point_formats:
 461     case TLSEXT_TYPE_supported_groups:
 462     case TLSEXT_TYPE_key_share:
 463 #endif
 464 #ifndef OPENSSL_NO_NEXTPROTONEG
 465     case TLSEXT_TYPE_next_proto_neg:
 466 #endif
 467     case TLSEXT_TYPE_padding:
 468     case TLSEXT_TYPE_renegotiate:
 469     case TLSEXT_TYPE_server_name:
 470     case TLSEXT_TYPE_session_ticket:
 471     case TLSEXT_TYPE_signature_algorithms:
 472 #ifndef OPENSSL_NO_SRP
 473     case TLSEXT_TYPE_srp:
 474 #endif
 475 #ifndef OPENSSL_NO_OCSP
 476     case TLSEXT_TYPE_status_request:
 477 #endif
 478 #ifndef OPENSSL_NO_CT
 479     case TLSEXT_TYPE_signed_certificate_timestamp:
 480 #endif
 481 #ifndef OPENSSL_NO_SRTP
 482     case TLSEXT_TYPE_use_srtp:
 483 #endif
 484     case TLSEXT_TYPE_encrypt_then_mac:
 485     case TLSEXT_TYPE_supported_versions:
 486     case TLSEXT_TYPE_extended_master_secret:
 487     case TLSEXT_TYPE_psk_kex_modes:
 488     case TLSEXT_TYPE_cookie:
 489     case TLSEXT_TYPE_early_data:
 490     case TLSEXT_TYPE_certificate_authorities:
 491     case TLSEXT_TYPE_psk:
 492         return 1;
 493     default:
 494         return 0;
 495     }
 496 }