ssl/ssl_ciph.c

   1 /*
   2  * Copyright 1995-2022 The OpenSSL Project Authors. All Rights Reserved.
   3  * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
   4  * Copyright 2005 Nokia. All rights reserved.
   5  *
   6  * Licensed under the Apache License 2.0 (the "License").  You may not use
   7  * this file except in compliance with the License.  You can obtain a copy
   8  * in the file LICENSE in the source distribution or at
   9  * https://www.openssl.org/source/license.html
  10  */
  11
  12 #include <stdio.h>
  13 #include <ctype.h>
  14 #include <openssl/objects.h>
  15 #include <openssl/comp.h>
  16 #include <openssl/engine.h>
  17 #include <openssl/crypto.h>
  18 #include <openssl/conf.h>
  19 #include <openssl/trace.h>
  20 #include "internal/nelem.h"
  21 #include "ssl_local.h"
  22 #include "internal/thread_once.h"
  23 #include "internal/cryptlib.h"
  24
  25 /* NB: make sure indices in these tables match values above */
  26
  27 typedef struct {
  28     uint32_t mask;
  29     int nid;
  30 } ssl_cipher_table;
  31
  32 /* Table of NIDs for each cipher */
  33 static const ssl_cipher_table ssl_cipher_table_cipher[SSL_ENC_NUM_IDX] = {
  34     {SSL_DES, NID_des_cbc},     /* SSL_ENC_DES_IDX 0 */
  35     {SSL_3DES, NID_des_ede3_cbc}, /* SSL_ENC_3DES_IDX 1 */
  36     {SSL_RC4, NID_rc4},         /* SSL_ENC_RC4_IDX 2 */
  37     {SSL_RC2, NID_rc2_cbc},     /* SSL_ENC_RC2_IDX 3 */
  38     {SSL_IDEA, NID_idea_cbc},   /* SSL_ENC_IDEA_IDX 4 */
  39     {SSL_eNULL, NID_undef},     /* SSL_ENC_NULL_IDX 5 */
  40     {SSL_AES128, NID_aes_128_cbc}, /* SSL_ENC_AES128_IDX 6 */
  41     {SSL_AES256, NID_aes_256_cbc}, /* SSL_ENC_AES256_IDX 7 */
  42     {SSL_CAMELLIA128, NID_camellia_128_cbc}, /* SSL_ENC_CAMELLIA128_IDX 8 */
  43     {SSL_CAMELLIA256, NID_camellia_256_cbc}, /* SSL_ENC_CAMELLIA256_IDX 9 */
  44     {SSL_eGOST2814789CNT, NID_gost89_cnt}, /* SSL_ENC_GOST89_IDX 10 */
  45     {SSL_SEED, NID_seed_cbc},   /* SSL_ENC_SEED_IDX 11 */
  46     {SSL_AES128GCM, NID_aes_128_gcm}, /* SSL_ENC_AES128GCM_IDX 12 */
  47     {SSL_AES256GCM, NID_aes_256_gcm}, /* SSL_ENC_AES256GCM_IDX 13 */
  48     {SSL_AES128CCM, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM_IDX 14 */
  49     {SSL_AES256CCM, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM_IDX 15 */
  50     {SSL_AES128CCM8, NID_aes_128_ccm}, /* SSL_ENC_AES128CCM8_IDX 16 */
  51     {SSL_AES256CCM8, NID_aes_256_ccm}, /* SSL_ENC_AES256CCM8_IDX 17 */
  52     {SSL_eGOST2814789CNT12, NID_gost89_cnt_12}, /* SSL_ENC_GOST8912_IDX 18 */
  53     {SSL_CHACHA20POLY1305, NID_chacha20_poly1305}, /* SSL_ENC_CHACHA_IDX 19 */
  54     {SSL_ARIA128GCM, NID_aria_128_gcm}, /* SSL_ENC_ARIA128GCM_IDX 20 */
  55     {SSL_ARIA256GCM, NID_aria_256_gcm}, /* SSL_ENC_ARIA256GCM_IDX 21 */
  56     {SSL_MAGMA, NID_magma_ctr_acpkm}, /* SSL_ENC_MAGMA_IDX */
  57     {SSL_KUZNYECHIK, NID_kuznyechik_ctr_acpkm}, /* SSL_ENC_KUZNYECHIK_IDX */
  58 };
  59
  60 #define SSL_COMP_NULL_IDX       0
  61 #define SSL_COMP_ZLIB_IDX       1
  62 #define SSL_COMP_NUM_IDX        2
  63
  64 static STACK_OF(SSL_COMP) *ssl_comp_methods = NULL;
  65
  66 #ifndef OPENSSL_NO_COMP
  67 static CRYPTO_ONCE ssl_load_builtin_comp_once = CRYPTO_ONCE_STATIC_INIT;
  68 #endif
  69
  70 /* NB: make sure indices in this table matches values above */
  71 static const ssl_cipher_table ssl_cipher_table_mac[SSL_MD_NUM_IDX] = {
  72     {SSL_MD5, NID_md5},         /* SSL_MD_MD5_IDX 0 */
  73     {SSL_SHA1, NID_sha1},       /* SSL_MD_SHA1_IDX 1 */
  74     {SSL_GOST94, NID_id_GostR3411_94}, /* SSL_MD_GOST94_IDX 2 */
  75     {SSL_GOST89MAC, NID_id_Gost28147_89_MAC}, /* SSL_MD_GOST89MAC_IDX 3 */
  76     {SSL_SHA256, NID_sha256},   /* SSL_MD_SHA256_IDX 4 */
  77     {SSL_SHA384, NID_sha384},   /* SSL_MD_SHA384_IDX 5 */
  78     {SSL_GOST12_256, NID_id_GostR3411_2012_256}, /* SSL_MD_GOST12_256_IDX 6 */
  79     {SSL_GOST89MAC12, NID_gost_mac_12}, /* SSL_MD_GOST89MAC12_IDX 7 */
  80     {SSL_GOST12_512, NID_id_GostR3411_2012_512}, /* SSL_MD_GOST12_512_IDX 8 */
  81     {0, NID_md5_sha1},          /* SSL_MD_MD5_SHA1_IDX 9 */
  82     {0, NID_sha224},            /* SSL_MD_SHA224_IDX 10 */
  83     {0, NID_sha512},            /* SSL_MD_SHA512_IDX 11 */
  84     {SSL_MAGMAOMAC, NID_magma_mac}, /* sSL_MD_MAGMAOMAC_IDX */
  85     {SSL_KUZNYECHIKOMAC, NID_kuznyechik_mac} /* SSL_MD_KUZNYECHIKOMAC_IDX */
  86 };
  87
  88 /* *INDENT-OFF* */
  89 static const ssl_cipher_table ssl_cipher_table_kx[] = {
  90     {SSL_kRSA,      NID_kx_rsa},
  91     {SSL_kECDHE,    NID_kx_ecdhe},
  92     {SSL_kDHE,      NID_kx_dhe},
  93     {SSL_kECDHEPSK, NID_kx_ecdhe_psk},
  94     {SSL_kDHEPSK,   NID_kx_dhe_psk},
  95     {SSL_kRSAPSK,   NID_kx_rsa_psk},
  96     {SSL_kPSK,      NID_kx_psk},
  97     {SSL_kSRP,      NID_kx_srp},
  98     {SSL_kGOST,     NID_kx_gost},
  99     {SSL_kGOST18,   NID_kx_gost18},
 100     {SSL_kANY,      NID_kx_any}
 101 };
 102
 103 static const ssl_cipher_table ssl_cipher_table_auth[] = {
 104     {SSL_aRSA,    NID_auth_rsa},
 105     {SSL_aECDSA,  NID_auth_ecdsa},
 106     {SSL_aPSK,    NID_auth_psk},
 107     {SSL_aDSS,    NID_auth_dss},
 108     {SSL_aGOST01, NID_auth_gost01},
 109     {SSL_aGOST12, NID_auth_gost12},
 110     {SSL_aSRP,    NID_auth_srp},
 111     {SSL_aNULL,   NID_auth_null},
 112     {SSL_aANY,    NID_auth_any}
 113 };
 114 /* *INDENT-ON* */
 115
 116 /* Utility function for table lookup */
 117 static int ssl_cipher_info_find(const ssl_cipher_table * table,
 118                                 size_t table_cnt, uint32_t mask)
 119 {
 120     size_t i;
 121     for (i = 0; i < table_cnt; i++, table++) {
 122         if (table->mask == mask)
 123             return (int)i;
 124     }
 125     return -1;
 126 }
 127
 128 #define ssl_cipher_info_lookup(table, x) \
 129     ssl_cipher_info_find(table, OSSL_NELEM(table), x)
 130
 131 /*
 132  * PKEY_TYPE for GOST89MAC is known in advance, but, because implementation
 133  * is engine-provided, we'll fill it only if corresponding EVP_PKEY_METHOD is
 134  * found
 135  */
 136 static const int default_mac_pkey_id[SSL_MD_NUM_IDX] = {
 137     /* MD5, SHA, GOST94, MAC89 */
 138     EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
 139     /* SHA256, SHA384, GOST2012_256, MAC89-12 */
 140     EVP_PKEY_HMAC, EVP_PKEY_HMAC, EVP_PKEY_HMAC, NID_undef,
 141     /* GOST2012_512 */
 142     EVP_PKEY_HMAC,
 143     /* MD5/SHA1, SHA224, SHA512, MAGMAOMAC, KUZNYECHIKOMAC */
 144     NID_undef, NID_undef, NID_undef, NID_undef, NID_undef
 145 };
 146
 147 #define CIPHER_ADD      1
 148 #define CIPHER_KILL     2
 149 #define CIPHER_DEL      3
 150 #define CIPHER_ORD      4
 151 #define CIPHER_SPECIAL  5
 152 /*
 153  * Bump the ciphers to the top of the list.
 154  * This rule isn't currently supported by the public cipherstring API.
 155  */
 156 #define CIPHER_BUMP     6
 157
 158 typedef struct cipher_order_st {
 159     const SSL_CIPHER *cipher;
 160     int active;
 161     int dead;
 162     struct cipher_order_st *next, *prev;
 163 } CIPHER_ORDER;
 164
 165 static const SSL_CIPHER cipher_aliases[] = {
 166     /* "ALL" doesn't include eNULL (must be specifically enabled) */
 167     {0, SSL_TXT_ALL, NULL, 0, 0, 0, ~SSL_eNULL},
 168     /* "COMPLEMENTOFALL" */
 169     {0, SSL_TXT_CMPALL, NULL, 0, 0, 0, SSL_eNULL},
 170
 171     /*
 172      * "COMPLEMENTOFDEFAULT" (does *not* include ciphersuites not found in
 173      * ALL!)
 174      */
 175     {0, SSL_TXT_CMPDEF, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_NOT_DEFAULT},
 176
 177     /*
 178      * key exchange aliases (some of those using only a single bit here
 179      * combine multiple key exchange algs according to the RFCs, e.g. kDHE
 180      * combines DHE_DSS and DHE_RSA)
 181      */
 182     {0, SSL_TXT_kRSA, NULL, 0, SSL_kRSA},
 183
 184     {0, SSL_TXT_kEDH, NULL, 0, SSL_kDHE},
 185     {0, SSL_TXT_kDHE, NULL, 0, SSL_kDHE},
 186     {0, SSL_TXT_DH, NULL, 0, SSL_kDHE},
 187
 188     {0, SSL_TXT_kEECDH, NULL, 0, SSL_kECDHE},
 189     {0, SSL_TXT_kECDHE, NULL, 0, SSL_kECDHE},
 190     {0, SSL_TXT_ECDH, NULL, 0, SSL_kECDHE},
 191
 192     {0, SSL_TXT_kPSK, NULL, 0, SSL_kPSK},
 193     {0, SSL_TXT_kRSAPSK, NULL, 0, SSL_kRSAPSK},
 194     {0, SSL_TXT_kECDHEPSK, NULL, 0, SSL_kECDHEPSK},
 195     {0, SSL_TXT_kDHEPSK, NULL, 0, SSL_kDHEPSK},
 196     {0, SSL_TXT_kSRP, NULL, 0, SSL_kSRP},
 197     {0, SSL_TXT_kGOST, NULL, 0, SSL_kGOST},
 198     {0, SSL_TXT_kGOST18, NULL, 0, SSL_kGOST18},
 199
 200     /* server authentication aliases */
 201     {0, SSL_TXT_aRSA, NULL, 0, 0, SSL_aRSA},
 202     {0, SSL_TXT_aDSS, NULL, 0, 0, SSL_aDSS},
 203     {0, SSL_TXT_DSS, NULL, 0, 0, SSL_aDSS},
 204     {0, SSL_TXT_aNULL, NULL, 0, 0, SSL_aNULL},
 205     {0, SSL_TXT_aECDSA, NULL, 0, 0, SSL_aECDSA},
 206     {0, SSL_TXT_ECDSA, NULL, 0, 0, SSL_aECDSA},
 207     {0, SSL_TXT_aPSK, NULL, 0, 0, SSL_aPSK},
 208     {0, SSL_TXT_aGOST01, NULL, 0, 0, SSL_aGOST01},
 209     {0, SSL_TXT_aGOST12, NULL, 0, 0, SSL_aGOST12},
 210     {0, SSL_TXT_aGOST, NULL, 0, 0, SSL_aGOST01 | SSL_aGOST12},
 211     {0, SSL_TXT_aSRP, NULL, 0, 0, SSL_aSRP},
 212
 213     /* aliases combining key exchange and server authentication */
 214     {0, SSL_TXT_EDH, NULL, 0, SSL_kDHE, ~SSL_aNULL},
 215     {0, SSL_TXT_DHE, NULL, 0, SSL_kDHE, ~SSL_aNULL},
 216     {0, SSL_TXT_EECDH, NULL, 0, SSL_kECDHE, ~SSL_aNULL},
 217     {0, SSL_TXT_ECDHE, NULL, 0, SSL_kECDHE, ~SSL_aNULL},
 218     {0, SSL_TXT_NULL, NULL, 0, 0, 0, SSL_eNULL},
 219     {0, SSL_TXT_RSA, NULL, 0, SSL_kRSA, SSL_aRSA},
 220     {0, SSL_TXT_ADH, NULL, 0, SSL_kDHE, SSL_aNULL},
 221     {0, SSL_TXT_AECDH, NULL, 0, SSL_kECDHE, SSL_aNULL},
 222     {0, SSL_TXT_PSK, NULL, 0, SSL_PSK},
 223     {0, SSL_TXT_SRP, NULL, 0, SSL_kSRP},
 224
 225     /* symmetric encryption aliases */
 226     {0, SSL_TXT_3DES, NULL, 0, 0, 0, SSL_3DES},
 227     {0, SSL_TXT_RC4, NULL, 0, 0, 0, SSL_RC4},
 228     {0, SSL_TXT_RC2, NULL, 0, 0, 0, SSL_RC2},
 229     {0, SSL_TXT_IDEA, NULL, 0, 0, 0, SSL_IDEA},
 230     {0, SSL_TXT_SEED, NULL, 0, 0, 0, SSL_SEED},
 231     {0, SSL_TXT_eNULL, NULL, 0, 0, 0, SSL_eNULL},
 232     {0, SSL_TXT_GOST, NULL, 0, 0, 0,
 233      SSL_eGOST2814789CNT | SSL_eGOST2814789CNT12 | SSL_MAGMA | SSL_KUZNYECHIK},
 234     {0, SSL_TXT_AES128, NULL, 0, 0, 0,
 235      SSL_AES128 | SSL_AES128GCM | SSL_AES128CCM | SSL_AES128CCM8},
 236     {0, SSL_TXT_AES256, NULL, 0, 0, 0,
 237      SSL_AES256 | SSL_AES256GCM | SSL_AES256CCM | SSL_AES256CCM8},
 238     {0, SSL_TXT_AES, NULL, 0, 0, 0, SSL_AES},
 239     {0, SSL_TXT_AES_GCM, NULL, 0, 0, 0, SSL_AES128GCM | SSL_AES256GCM},
 240     {0, SSL_TXT_AES_CCM, NULL, 0, 0, 0,
 241      SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8},
 242     {0, SSL_TXT_AES_CCM_8, NULL, 0, 0, 0, SSL_AES128CCM8 | SSL_AES256CCM8},
 243     {0, SSL_TXT_CAMELLIA128, NULL, 0, 0, 0, SSL_CAMELLIA128},
 244     {0, SSL_TXT_CAMELLIA256, NULL, 0, 0, 0, SSL_CAMELLIA256},
 245     {0, SSL_TXT_CAMELLIA, NULL, 0, 0, 0, SSL_CAMELLIA},
 246     {0, SSL_TXT_CHACHA20, NULL, 0, 0, 0, SSL_CHACHA20},
 247     {0, SSL_TXT_GOST2012_GOST8912_GOST8912, NULL, 0, 0, 0, SSL_eGOST2814789CNT12},
 248
 249     {0, SSL_TXT_ARIA, NULL, 0, 0, 0, SSL_ARIA},
 250     {0, SSL_TXT_ARIA_GCM, NULL, 0, 0, 0, SSL_ARIA128GCM | SSL_ARIA256GCM},
 251     {0, SSL_TXT_ARIA128, NULL, 0, 0, 0, SSL_ARIA128GCM},
 252     {0, SSL_TXT_ARIA256, NULL, 0, 0, 0, SSL_ARIA256GCM},
 253     {0, SSL_TXT_CBC, NULL, 0, 0, 0, SSL_CBC},
 254
 255     /* MAC aliases */
 256     {0, SSL_TXT_MD5, NULL, 0, 0, 0, 0, SSL_MD5},
 257     {0, SSL_TXT_SHA1, NULL, 0, 0, 0, 0, SSL_SHA1},
 258     {0, SSL_TXT_SHA, NULL, 0, 0, 0, 0, SSL_SHA1},
 259     {0, SSL_TXT_GOST94, NULL, 0, 0, 0, 0, SSL_GOST94},
 260     {0, SSL_TXT_GOST89MAC, NULL, 0, 0, 0, 0, SSL_GOST89MAC | SSL_GOST89MAC12},
 261     {0, SSL_TXT_SHA256, NULL, 0, 0, 0, 0, SSL_SHA256},
 262     {0, SSL_TXT_SHA384, NULL, 0, 0, 0, 0, SSL_SHA384},
 263     {0, SSL_TXT_GOST12, NULL, 0, 0, 0, 0, SSL_GOST12_256},
 264
 265     /* protocol version aliases */
 266     {0, SSL_TXT_SSLV3, NULL, 0, 0, 0, 0, 0, SSL3_VERSION},
 267     {0, SSL_TXT_TLSV1, NULL, 0, 0, 0, 0, 0, TLS1_VERSION},
 268     {0, "TLSv1.0", NULL, 0, 0, 0, 0, 0, TLS1_VERSION},
 269     {0, SSL_TXT_TLSV1_2, NULL, 0, 0, 0, 0, 0, TLS1_2_VERSION},
 270
 271     /* strength classes */
 272     {0, SSL_TXT_LOW, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_LOW},
 273     {0, SSL_TXT_MEDIUM, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_MEDIUM},
 274     {0, SSL_TXT_HIGH, NULL, 0, 0, 0, 0, 0, 0, 0, 0, 0, SSL_HIGH},
 275     /* FIPS 140-2 approved ciphersuite */
 276     {0, SSL_TXT_FIPS, NULL, 0, 0, 0, ~SSL_eNULL, 0, 0, 0, 0, 0, SSL_FIPS},
 277
 278     /* "EDH-" aliases to "DHE-" labels (for backward compatibility) */
 279     {0, SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA, NULL, 0,
 280      SSL_kDHE, SSL_aDSS, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
 281     {0, SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA, NULL, 0,
 282      SSL_kDHE, SSL_aRSA, SSL_3DES, SSL_SHA1, 0, 0, 0, 0, SSL_HIGH | SSL_FIPS},
 283
 284 };
 285
 286 /*
 287  * Search for public key algorithm with given name and return its pkey_id if
 288  * it is available. Otherwise return 0
 289  */
 290 #ifdef OPENSSL_NO_ENGINE
 291
 292 static int get_optional_pkey_id(const char *pkey_name)
 293 {
 294     const EVP_PKEY_ASN1_METHOD *ameth;
 295     int pkey_id = 0;
 296     ameth = EVP_PKEY_asn1_find_str(NULL, pkey_name, -1);
 297     if (ameth && EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
 298                                          ameth) > 0)
 299         return pkey_id;
 300     return 0;
 301 }
 302
 303 #else
 304
 305 static int get_optional_pkey_id(const char *pkey_name)
 306 {
 307     const EVP_PKEY_ASN1_METHOD *ameth;
 308     ENGINE *tmpeng = NULL;
 309     int pkey_id = 0;
 310     ameth = EVP_PKEY_asn1_find_str(&tmpeng, pkey_name, -1);
 311     if (ameth) {
 312         if (EVP_PKEY_asn1_get0_info(&pkey_id, NULL, NULL, NULL, NULL,
 313                                     ameth) <= 0)
 314             pkey_id = 0;
 315     }
 316     tls_engine_finish(tmpeng);
 317     return pkey_id;
 318 }
 319
 320 #endif
 321
 322 int ssl_load_ciphers(SSL_CTX *ctx)
 323 {
 324     size_t i;
 325     const ssl_cipher_table *t;
 326     EVP_KEYEXCH *kex = NULL;
 327     EVP_SIGNATURE *sig = NULL;
 328
 329     ctx->disabled_enc_mask = 0;
 330     for (i = 0, t = ssl_cipher_table_cipher; i < SSL_ENC_NUM_IDX; i++, t++) {
 331         if (t->nid != NID_undef) {
 332             const EVP_CIPHER *cipher
 333                 = ssl_evp_cipher_fetch(ctx->libctx, t->nid, ctx->propq);
 334
 335             ctx->ssl_cipher_methods[i] = cipher;
 336             if (cipher == NULL)
 337                 ctx->disabled_enc_mask |= t->mask;
 338         }
 339     }
 340     ctx->disabled_mac_mask = 0;
 341     for (i = 0, t = ssl_cipher_table_mac; i < SSL_MD_NUM_IDX; i++, t++) {
 342         const EVP_MD *md
 343             = ssl_evp_md_fetch(ctx->libctx, t->nid, ctx->propq);
 344
 345         ctx->ssl_digest_methods[i] = md;
 346         if (md == NULL) {
 347             ctx->disabled_mac_mask |= t->mask;
 348         } else {
 349             int tmpsize = EVP_MD_get_size(md);
 350             if (!ossl_assert(tmpsize >= 0))
 351                 return 0;
 352             ctx->ssl_mac_secret_size[i] = tmpsize;
 353         }
 354     }
 355
 356     ctx->disabled_mkey_mask = 0;
 357     ctx->disabled_auth_mask = 0;
 358
 359     /*
 360      * We ignore any errors from the fetches below. They are expected to fail
 361      * if theose algorithms are not available.
 362      */
 363     ERR_set_mark();
 364     sig = EVP_SIGNATURE_fetch(ctx->libctx, "DSA", ctx->propq);
 365     if (sig == NULL)
 366         ctx->disabled_auth_mask |= SSL_aDSS;
 367     else
 368         EVP_SIGNATURE_free(sig);
 369     kex = EVP_KEYEXCH_fetch(ctx->libctx, "DH", ctx->propq);
 370     if (kex == NULL)
 371         ctx->disabled_mkey_mask |= SSL_kDHE | SSL_kDHEPSK;
 372     else
 373         EVP_KEYEXCH_free(kex);
 374     kex = EVP_KEYEXCH_fetch(ctx->libctx, "ECDH", ctx->propq);
 375     if (kex == NULL)
 376         ctx->disabled_mkey_mask |= SSL_kECDHE | SSL_kECDHEPSK;
 377     else
 378         EVP_KEYEXCH_free(kex);
 379     sig = EVP_SIGNATURE_fetch(ctx->libctx, "ECDSA", ctx->propq);
 380     if (sig == NULL)
 381         ctx->disabled_auth_mask |= SSL_aECDSA;
 382     else
 383         EVP_SIGNATURE_free(sig);
 384     ERR_pop_to_mark();
 385
 386 #ifdef OPENSSL_NO_PSK
 387     ctx->disabled_mkey_mask |= SSL_PSK;
 388     ctx->disabled_auth_mask |= SSL_aPSK;
 389 #endif
 390 #ifdef OPENSSL_NO_SRP
 391     ctx->disabled_mkey_mask |= SSL_kSRP;
 392 #endif
 393
 394     /*
 395      * Check for presence of GOST 34.10 algorithms, and if they are not
 396      * present, disable appropriate auth and key exchange
 397      */
 398     memcpy(ctx->ssl_mac_pkey_id, default_mac_pkey_id,
 399            sizeof(ctx->ssl_mac_pkey_id));
 400
 401     ctx->ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX] =
 402         get_optional_pkey_id(SN_id_Gost28147_89_MAC);
 403     if (ctx->ssl_mac_pkey_id[SSL_MD_GOST89MAC_IDX])
 404         ctx->ssl_mac_secret_size[SSL_MD_GOST89MAC_IDX] = 32;
 405     else
 406         ctx->disabled_mac_mask |= SSL_GOST89MAC;
 407
 408     ctx->ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX] =
 409         get_optional_pkey_id(SN_gost_mac_12);
 410     if (ctx->ssl_mac_pkey_id[SSL_MD_GOST89MAC12_IDX])
 411         ctx->ssl_mac_secret_size[SSL_MD_GOST89MAC12_IDX] = 32;
 412     else
 413         ctx->disabled_mac_mask |= SSL_GOST89MAC12;
 414
 415     ctx->ssl_mac_pkey_id[SSL_MD_MAGMAOMAC_IDX] =
 416         get_optional_pkey_id(SN_magma_mac);
 417     if (ctx->ssl_mac_pkey_id[SSL_MD_MAGMAOMAC_IDX])
 418         ctx->ssl_mac_secret_size[SSL_MD_MAGMAOMAC_IDX] = 32;
 419     else
 420         ctx->disabled_mac_mask |= SSL_MAGMAOMAC;
 421
 422     ctx->ssl_mac_pkey_id[SSL_MD_KUZNYECHIKOMAC_IDX] =
 423         get_optional_pkey_id(SN_kuznyechik_mac);
 424     if (ctx->ssl_mac_pkey_id[SSL_MD_KUZNYECHIKOMAC_IDX])
 425         ctx->ssl_mac_secret_size[SSL_MD_KUZNYECHIKOMAC_IDX] = 32;
 426     else
 427         ctx->disabled_mac_mask |= SSL_KUZNYECHIKOMAC;
 428
 429     if (!get_optional_pkey_id(SN_id_GostR3410_2001))
 430         ctx->disabled_auth_mask |= SSL_aGOST01 | SSL_aGOST12;
 431     if (!get_optional_pkey_id(SN_id_GostR3410_2012_256))
 432         ctx->disabled_auth_mask |= SSL_aGOST12;
 433     if (!get_optional_pkey_id(SN_id_GostR3410_2012_512))
 434         ctx->disabled_auth_mask |= SSL_aGOST12;
 435     /*
 436      * Disable GOST key exchange if no GOST signature algs are available *
 437      */
 438     if ((ctx->disabled_auth_mask & (SSL_aGOST01 | SSL_aGOST12)) ==
 439         (SSL_aGOST01 | SSL_aGOST12))
 440         ctx->disabled_mkey_mask |= SSL_kGOST;
 441
 442     if ((ctx->disabled_auth_mask & SSL_aGOST12) ==  SSL_aGOST12)
 443         ctx->disabled_mkey_mask |= SSL_kGOST18;
 444
 445     return 1;
 446 }
 447
 448 #ifndef OPENSSL_NO_COMP
 449
 450 static int sk_comp_cmp(const SSL_COMP *const *a, const SSL_COMP *const *b)
 451 {
 452     return ((*a)->id - (*b)->id);
 453 }
 454
 455 DEFINE_RUN_ONCE_STATIC(do_load_builtin_compressions)
 456 {
 457     SSL_COMP *comp = NULL;
 458     COMP_METHOD *method = COMP_zlib();
 459
 460     ssl_comp_methods = sk_SSL_COMP_new(sk_comp_cmp);
 461
 462     if (COMP_get_type(method) != NID_undef && ssl_comp_methods != NULL) {
 463         comp = OPENSSL_malloc(sizeof(*comp));
 464         if (comp != NULL) {
 465             comp->method = method;
 466             comp->id = SSL_COMP_ZLIB_IDX;
 467             comp->name = COMP_get_name(method);
 468             if (!sk_SSL_COMP_push(ssl_comp_methods, comp))
 469                 OPENSSL_free(comp);
 470             sk_SSL_COMP_sort(ssl_comp_methods);
 471         }
 472     }
 473     return 1;
 474 }
 475
 476 static int load_builtin_compressions(void)
 477 {
 478     return RUN_ONCE(&ssl_load_builtin_comp_once, do_load_builtin_compressions);
 479 }
 480 #endif
 481
 482 int ssl_cipher_get_evp_cipher(SSL_CTX *ctx, const SSL_CIPHER *sslc,
 483                               const EVP_CIPHER **enc)
 484 {
 485     int i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, sslc->algorithm_enc);
 486
 487     if (i == -1) {
 488         *enc = NULL;
 489     } else {
 490         if (i == SSL_ENC_NULL_IDX) {
 491             /*
 492              * We assume we don't care about this coming from an ENGINE so
 493              * just do a normal EVP_CIPHER_fetch instead of
 494              * ssl_evp_cipher_fetch()
 495              */
 496             *enc = EVP_CIPHER_fetch(ctx->libctx, "NULL", ctx->propq);
 497             if (*enc == NULL)
 498                 return 0;
 499         } else {
 500             const EVP_CIPHER *cipher = ctx->ssl_cipher_methods[i];
 501
 502             if (cipher == NULL
 503                     || !ssl_evp_cipher_up_ref(cipher))
 504                 return 0;
 505             *enc = ctx->ssl_cipher_methods[i];
 506         }
 507     }
 508     return 1;
 509 }
 510
 511 int ssl_cipher_get_evp(SSL_CTX *ctx, const SSL_SESSION *s,
 512                        const EVP_CIPHER **enc, const EVP_MD **md,
 513                        int *mac_pkey_type, size_t *mac_secret_size,
 514                        SSL_COMP **comp, int use_etm)
 515 {
 516     int i;
 517     const SSL_CIPHER *c;
 518
 519     c = s->cipher;
 520     if (c == NULL)
 521         return 0;
 522     if (comp != NULL) {
 523         SSL_COMP ctmp;
 524 #ifndef OPENSSL_NO_COMP
 525         if (!load_builtin_compressions()) {
 526             /*
 527              * Currently don't care, since a failure only means that
 528              * ssl_comp_methods is NULL, which is perfectly OK
 529              */
 530         }
 531 #endif
 532         *comp = NULL;
 533         ctmp.id = s->compress_meth;
 534         if (ssl_comp_methods != NULL) {
 535             i = sk_SSL_COMP_find(ssl_comp_methods, &ctmp);
 536             if (i >= 0)
 537                 *comp = sk_SSL_COMP_value(ssl_comp_methods, i);
 538         }
 539         /* If were only interested in comp then return success */
 540         if ((enc == NULL) && (md == NULL))
 541             return 1;
 542     }
 543
 544     if ((enc == NULL) || (md == NULL))
 545         return 0;
 546
 547     if (!ssl_cipher_get_evp_cipher(ctx, c, enc))
 548         return 0;
 549
 550     i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
 551     if (i == -1) {
 552         *md = NULL;
 553         if (mac_pkey_type != NULL)
 554             *mac_pkey_type = NID_undef;
 555         if (mac_secret_size != NULL)
 556             *mac_secret_size = 0;
 557         if (c->algorithm_mac == SSL_AEAD)
 558             mac_pkey_type = NULL;
 559     } else {
 560         const EVP_MD *digest = ctx->ssl_digest_methods[i];
 561
 562         if (digest == NULL
 563                 || !ssl_evp_md_up_ref(digest)) {
 564             ssl_evp_cipher_free(*enc);
 565             return 0;
 566         }
 567         *md = digest;
 568         if (mac_pkey_type != NULL)
 569             *mac_pkey_type = ctx->ssl_mac_pkey_id[i];
 570         if (mac_secret_size != NULL)
 571             *mac_secret_size = ctx->ssl_mac_secret_size[i];
 572     }
 573
 574     if ((*enc != NULL)
 575         && (*md != NULL
 576             || (EVP_CIPHER_get_flags(*enc) & EVP_CIPH_FLAG_AEAD_CIPHER))
 577         && (!mac_pkey_type || *mac_pkey_type != NID_undef)) {
 578         const EVP_CIPHER *evp = NULL;
 579
 580         if (use_etm
 581                 || s->ssl_version >> 8 != TLS1_VERSION_MAJOR
 582                 || s->ssl_version < TLS1_VERSION)
 583             return 1;
 584
 585         if (c->algorithm_enc == SSL_RC4
 586                 && c->algorithm_mac == SSL_MD5)
 587             evp = ssl_evp_cipher_fetch(ctx->libctx, NID_rc4_hmac_md5,
 588                                        ctx->propq);
 589         else if (c->algorithm_enc == SSL_AES128
 590                     && c->algorithm_mac == SSL_SHA1)
 591             evp = ssl_evp_cipher_fetch(ctx->libctx,
 592                                        NID_aes_128_cbc_hmac_sha1,
 593                                        ctx->propq);
 594         else if (c->algorithm_enc == SSL_AES256
 595                     && c->algorithm_mac == SSL_SHA1)
 596              evp = ssl_evp_cipher_fetch(ctx->libctx,
 597                                         NID_aes_256_cbc_hmac_sha1,
 598                                         ctx->propq);
 599         else if (c->algorithm_enc == SSL_AES128
 600                     && c->algorithm_mac == SSL_SHA256)
 601             evp = ssl_evp_cipher_fetch(ctx->libctx,
 602                                        NID_aes_128_cbc_hmac_sha256,
 603                                        ctx->propq);
 604         else if (c->algorithm_enc == SSL_AES256
 605                     && c->algorithm_mac == SSL_SHA256)
 606             evp = ssl_evp_cipher_fetch(ctx->libctx,
 607                                        NID_aes_256_cbc_hmac_sha256,
 608                                        ctx->propq);
 609
 610         if (evp != NULL) {
 611             ssl_evp_cipher_free(*enc);
 612             ssl_evp_md_free(*md);
 613             *enc = evp;
 614             *md = NULL;
 615         }
 616         return 1;
 617     }
 618
 619     return 0;
 620 }
 621
 622 const EVP_MD *ssl_md(SSL_CTX *ctx, int idx)
 623 {
 624     idx &= SSL_HANDSHAKE_MAC_MASK;
 625     if (idx < 0 || idx >= SSL_MD_NUM_IDX)
 626         return NULL;
 627     return ctx->ssl_digest_methods[idx];
 628 }
 629
 630 const EVP_MD *ssl_handshake_md(SSL *s)
 631 {
 632     return ssl_md(s->ctx, ssl_get_algorithm2(s));
 633 }
 634
 635 const EVP_MD *ssl_prf_md(SSL *s)
 636 {
 637     return ssl_md(s->ctx, ssl_get_algorithm2(s) >> TLS1_PRF_DGST_SHIFT);
 638 }
 639
 640 #define ITEM_SEP(a) \
 641         (((a) == ':') || ((a) == ' ') || ((a) == ';') || ((a) == ','))
 642
 643 static void ll_append_tail(CIPHER_ORDER **head, CIPHER_ORDER *curr,
 644                            CIPHER_ORDER **tail)
 645 {
 646     if (curr == *tail)
 647         return;
 648     if (curr == *head)
 649         *head = curr->next;
 650     if (curr->prev != NULL)
 651         curr->prev->next = curr->next;
 652     if (curr->next != NULL)
 653         curr->next->prev = curr->prev;
 654     (*tail)->next = curr;
 655     curr->prev = *tail;
 656     curr->next = NULL;
 657     *tail = curr;
 658 }
 659
 660 static void ll_append_head(CIPHER_ORDER **head, CIPHER_ORDER *curr,
 661                            CIPHER_ORDER **tail)
 662 {
 663     if (curr == *head)
 664         return;
 665     if (curr == *tail)
 666         *tail = curr->prev;
 667     if (curr->next != NULL)
 668         curr->next->prev = curr->prev;
 669     if (curr->prev != NULL)
 670         curr->prev->next = curr->next;
 671     (*head)->prev = curr;
 672     curr->next = *head;
 673     curr->prev = NULL;
 674     *head = curr;
 675 }
 676
 677 static void ssl_cipher_collect_ciphers(const SSL_METHOD *ssl_method,
 678                                        int num_of_ciphers,
 679                                        uint32_t disabled_mkey,
 680                                        uint32_t disabled_auth,
 681                                        uint32_t disabled_enc,
 682                                        uint32_t disabled_mac,
 683                                        CIPHER_ORDER *co_list,
 684                                        CIPHER_ORDER **head_p,
 685                                        CIPHER_ORDER **tail_p)
 686 {
 687     int i, co_list_num;
 688     const SSL_CIPHER *c;
 689
 690     /*
 691      * We have num_of_ciphers descriptions compiled in, depending on the
 692      * method selected (SSLv3, TLSv1 etc).
 693      * These will later be sorted in a linked list with at most num
 694      * entries.
 695      */
 696
 697     /* Get the initial list of ciphers */
 698     co_list_num = 0;            /* actual count of ciphers */
 699     for (i = 0; i < num_of_ciphers; i++) {
 700         c = ssl_method->get_cipher(i);
 701         /* drop those that use any of that is not available */
 702         if (c == NULL || !c->valid)
 703             continue;
 704         if ((c->algorithm_mkey & disabled_mkey) ||
 705             (c->algorithm_auth & disabled_auth) ||
 706             (c->algorithm_enc & disabled_enc) ||
 707             (c->algorithm_mac & disabled_mac))
 708             continue;
 709         if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) == 0) &&
 710             c->min_tls == 0)
 711             continue;
 712         if (((ssl_method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS) != 0) &&
 713             c->min_dtls == 0)
 714             continue;
 715
 716         co_list[co_list_num].cipher = c;
 717         co_list[co_list_num].next = NULL;
 718         co_list[co_list_num].prev = NULL;
 719         co_list[co_list_num].active = 0;
 720         co_list_num++;
 721     }
 722
 723     /*
 724      * Prepare linked list from list entries
 725      */
 726     if (co_list_num > 0) {
 727         co_list[0].prev = NULL;
 728
 729         if (co_list_num > 1) {
 730             co_list[0].next = &co_list[1];
 731
 732             for (i = 1; i < co_list_num - 1; i++) {
 733                 co_list[i].prev = &co_list[i - 1];
 734                 co_list[i].next = &co_list[i + 1];
 735             }
 736
 737             co_list[co_list_num - 1].prev = &co_list[co_list_num - 2];
 738         }
 739
 740         co_list[co_list_num - 1].next = NULL;
 741
 742         *head_p = &co_list[0];
 743         *tail_p = &co_list[co_list_num - 1];
 744     }
 745 }
 746
 747 static void ssl_cipher_collect_aliases(const SSL_CIPHER **ca_list,
 748                                        int num_of_group_aliases,
 749                                        uint32_t disabled_mkey,
 750                                        uint32_t disabled_auth,
 751                                        uint32_t disabled_enc,
 752                                        uint32_t disabled_mac,
 753                                        CIPHER_ORDER *head)
 754 {
 755     CIPHER_ORDER *ciph_curr;
 756     const SSL_CIPHER **ca_curr;
 757     int i;
 758     uint32_t mask_mkey = ~disabled_mkey;
 759     uint32_t mask_auth = ~disabled_auth;
 760     uint32_t mask_enc = ~disabled_enc;
 761     uint32_t mask_mac = ~disabled_mac;
 762
 763     /*
 764      * First, add the real ciphers as already collected
 765      */
 766     ciph_curr = head;
 767     ca_curr = ca_list;
 768     while (ciph_curr != NULL) {
 769         *ca_curr = ciph_curr->cipher;
 770         ca_curr++;
 771         ciph_curr = ciph_curr->next;
 772     }
 773
 774     /*
 775      * Now we add the available ones from the cipher_aliases[] table.
 776      * They represent either one or more algorithms, some of which
 777      * in any affected category must be supported (set in enabled_mask),
 778      * or represent a cipher strength value (will be added in any case because algorithms=0).
 779      */
 780     for (i = 0; i < num_of_group_aliases; i++) {
 781         uint32_t algorithm_mkey = cipher_aliases[i].algorithm_mkey;
 782         uint32_t algorithm_auth = cipher_aliases[i].algorithm_auth;
 783         uint32_t algorithm_enc = cipher_aliases[i].algorithm_enc;
 784         uint32_t algorithm_mac = cipher_aliases[i].algorithm_mac;
 785
 786         if (algorithm_mkey)
 787             if ((algorithm_mkey & mask_mkey) == 0)
 788                 continue;
 789
 790         if (algorithm_auth)
 791             if ((algorithm_auth & mask_auth) == 0)
 792                 continue;
 793
 794         if (algorithm_enc)
 795             if ((algorithm_enc & mask_enc) == 0)
 796                 continue;
 797
 798         if (algorithm_mac)
 799             if ((algorithm_mac & mask_mac) == 0)
 800                 continue;
 801
 802         *ca_curr = (SSL_CIPHER *)(cipher_aliases + i);
 803         ca_curr++;
 804     }
 805
 806     *ca_curr = NULL;            /* end of list */
 807 }
 808
 809 static void ssl_cipher_apply_rule(uint32_t cipher_id, uint32_t alg_mkey,
 810                                   uint32_t alg_auth, uint32_t alg_enc,
 811                                   uint32_t alg_mac, int min_tls,
 812                                   uint32_t algo_strength, int rule,
 813                                   int32_t strength_bits, CIPHER_ORDER **head_p,
 814                                   CIPHER_ORDER **tail_p)
 815 {
 816     CIPHER_ORDER *head, *tail, *curr, *next, *last;
 817     const SSL_CIPHER *cp;
 818     int reverse = 0;
 819
 820     OSSL_TRACE_BEGIN(TLS_CIPHER){
 821         BIO_printf(trc_out,
 822                    "Applying rule %d with %08x/%08x/%08x/%08x/%08x %08x (%d)\n",
 823                    rule, (unsigned int)alg_mkey, (unsigned int)alg_auth,
 824                    (unsigned int)alg_enc, (unsigned int)alg_mac, min_tls,
 825                    (unsigned int)algo_strength, (int)strength_bits);
 826     }
 827
 828     if (rule == CIPHER_DEL || rule == CIPHER_BUMP)
 829         reverse = 1;            /* needed to maintain sorting between currently
 830                                  * deleted ciphers */
 831
 832     head = *head_p;
 833     tail = *tail_p;
 834
 835     if (reverse) {
 836         next = tail;
 837         last = head;
 838     } else {
 839         next = head;
 840         last = tail;
 841     }
 842
 843     curr = NULL;
 844     for (;;) {
 845         if (curr == last)
 846             break;
 847
 848         curr = next;
 849
 850         if (curr == NULL)
 851             break;
 852
 853         next = reverse ? curr->prev : curr->next;
 854
 855         cp = curr->cipher;
 856
 857         /*
 858          * Selection criteria is either the value of strength_bits
 859          * or the algorithms used.
 860          */
 861         if (strength_bits >= 0) {
 862             if (strength_bits != cp->strength_bits)
 863                 continue;
 864         } else {
 865             if (trc_out != NULL) {
 866                 BIO_printf(trc_out,
 867                            "\nName: %s:"
 868                            "\nAlgo = %08x/%08x/%08x/%08x/%08x Algo_strength = %08x\n",
 869                            cp->name,
 870                            (unsigned int)cp->algorithm_mkey,
 871                            (unsigned int)cp->algorithm_auth,
 872                            (unsigned int)cp->algorithm_enc,
 873                            (unsigned int)cp->algorithm_mac,
 874                            cp->min_tls,
 875                            (unsigned int)cp->algo_strength);
 876             }
 877             if (cipher_id != 0 && (cipher_id != cp->id))
 878                 continue;
 879             if (alg_mkey && !(alg_mkey & cp->algorithm_mkey))
 880                 continue;
 881             if (alg_auth && !(alg_auth & cp->algorithm_auth))
 882                 continue;
 883             if (alg_enc && !(alg_enc & cp->algorithm_enc))
 884                 continue;
 885             if (alg_mac && !(alg_mac & cp->algorithm_mac))
 886                 continue;
 887             if (min_tls && (min_tls != cp->min_tls))
 888                 continue;
 889             if ((algo_strength & SSL_STRONG_MASK)
 890                 && !(algo_strength & SSL_STRONG_MASK & cp->algo_strength))
 891                 continue;
 892             if ((algo_strength & SSL_DEFAULT_MASK)
 893                 && !(algo_strength & SSL_DEFAULT_MASK & cp->algo_strength))
 894                 continue;
 895         }
 896
 897         if (trc_out != NULL)
 898             BIO_printf(trc_out, "Action = %d\n", rule);
 899
 900         /* add the cipher if it has not been added yet. */
 901         if (rule == CIPHER_ADD) {
 902             /* reverse == 0 */
 903             if (!curr->active) {
 904                 ll_append_tail(&head, curr, &tail);
 905                 curr->active = 1;
 906             }
 907         }
 908         /* Move the added cipher to this location */
 909         else if (rule == CIPHER_ORD) {
 910             /* reverse == 0 */
 911             if (curr->active) {
 912                 ll_append_tail(&head, curr, &tail);
 913             }
 914         } else if (rule == CIPHER_DEL) {
 915             /* reverse == 1 */
 916             if (curr->active) {
 917                 /*
 918                  * most recently deleted ciphersuites get best positions for
 919                  * any future CIPHER_ADD (note that the CIPHER_DEL loop works
 920                  * in reverse to maintain the order)
 921                  */
 922                 ll_append_head(&head, curr, &tail);
 923                 curr->active = 0;
 924             }
 925         } else if (rule == CIPHER_BUMP) {
 926             if (curr->active)
 927                 ll_append_head(&head, curr, &tail);
 928         } else if (rule == CIPHER_KILL) {
 929             /* reverse == 0 */
 930             if (head == curr)
 931                 head = curr->next;
 932             else
 933                 curr->prev->next = curr->next;
 934             if (tail == curr)
 935                 tail = curr->prev;
 936             curr->active = 0;
 937             if (curr->next != NULL)
 938                 curr->next->prev = curr->prev;
 939             if (curr->prev != NULL)
 940                 curr->prev->next = curr->next;
 941             curr->next = NULL;
 942             curr->prev = NULL;
 943         }
 944     }
 945
 946     *head_p = head;
 947     *tail_p = tail;
 948
 949     OSSL_TRACE_END(TLS_CIPHER);
 950 }
 951
 952 static int ssl_cipher_strength_sort(CIPHER_ORDER **head_p,
 953                                     CIPHER_ORDER **tail_p)
 954 {
 955     int32_t max_strength_bits;
 956     int i, *number_uses;
 957     CIPHER_ORDER *curr;
 958
 959     /*
 960      * This routine sorts the ciphers with descending strength. The sorting
 961      * must keep the pre-sorted sequence, so we apply the normal sorting
 962      * routine as '+' movement to the end of the list.
 963      */
 964     max_strength_bits = 0;
 965     curr = *head_p;
 966     while (curr != NULL) {
 967         if (curr->active && (curr->cipher->strength_bits > max_strength_bits))
 968             max_strength_bits = curr->cipher->strength_bits;
 969         curr = curr->next;
 970     }
 971
 972     number_uses = OPENSSL_zalloc(sizeof(int) * (max_strength_bits + 1));
 973     if (number_uses == NULL) {
 974         ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
 975         return 0;
 976     }
 977
 978     /*
 979      * Now find the strength_bits values actually used
 980      */
 981     curr = *head_p;
 982     while (curr != NULL) {
 983         if (curr->active)
 984             number_uses[curr->cipher->strength_bits]++;
 985         curr = curr->next;
 986     }
 987     /*
 988      * Go through the list of used strength_bits values in descending
 989      * order.
 990      */
 991     for (i = max_strength_bits; i >= 0; i--)
 992         if (number_uses[i] > 0)
 993             ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ORD, i, head_p,
 994                                   tail_p);
 995
 996     OPENSSL_free(number_uses);
 997     return 1;
 998 }
 999
1000 static int ssl_cipher_process_rulestr(const char *rule_str,
1001                                       CIPHER_ORDER **head_p,
1002                                       CIPHER_ORDER **tail_p,
1003                                       const SSL_CIPHER **ca_list, CERT *c)
1004 {
1005     uint32_t alg_mkey, alg_auth, alg_enc, alg_mac, algo_strength;
1006     int min_tls;
1007     const char *l, *buf;
1008     int j, multi, found, rule, retval, ok, buflen;
1009     uint32_t cipher_id = 0;
1010     char ch;
1011
1012     retval = 1;
1013     l = rule_str;
1014     for ( ; ; ) {
1015         ch = *l;
1016
1017         if (ch == '\0')
1018             break;              /* done */
1019         if (ch == '-') {
1020             rule = CIPHER_DEL;
1021             l++;
1022         } else if (ch == '+') {
1023             rule = CIPHER_ORD;
1024             l++;
1025         } else if (ch == '!') {
1026             rule = CIPHER_KILL;
1027             l++;
1028         } else if (ch == '@') {
1029             rule = CIPHER_SPECIAL;
1030             l++;
1031         } else {
1032             rule = CIPHER_ADD;
1033         }
1034
1035         if (ITEM_SEP(ch)) {
1036             l++;
1037             continue;
1038         }
1039
1040         alg_mkey = 0;
1041         alg_auth = 0;
1042         alg_enc = 0;
1043         alg_mac = 0;
1044         min_tls = 0;
1045         algo_strength = 0;
1046
1047         for (;;) {
1048             ch = *l;
1049             buf = l;
1050             buflen = 0;
1051 #ifndef CHARSET_EBCDIC
1052             while (((ch >= 'A') && (ch <= 'Z')) ||
1053                    ((ch >= '0') && (ch <= '9')) ||
1054                    ((ch >= 'a') && (ch <= 'z')) ||
1055                    (ch == '-') || (ch == '.') || (ch == '='))
1056 #else
1057             while (isalnum((unsigned char)ch) || (ch == '-') || (ch == '.')
1058                    || (ch == '='))
1059 #endif
1060             {
1061                 ch = *(++l);
1062                 buflen++;
1063             }
1064
1065             if (buflen == 0) {
1066                 /*
1067                  * We hit something we cannot deal with,
1068                  * it is no command or separator nor
1069                  * alphanumeric, so we call this an error.
1070                  */
1071                 ERR_raise(ERR_LIB_SSL, SSL_R_INVALID_COMMAND);
1072                 return 0;
1073             }
1074
1075             if (rule == CIPHER_SPECIAL) {
1076                 found = 0;      /* unused -- avoid compiler warning */
1077                 break;          /* special treatment */
1078             }
1079
1080             /* check for multi-part specification */
1081             if (ch == '+') {
1082                 multi = 1;
1083                 l++;
1084             } else {
1085                 multi = 0;
1086             }
1087
1088             /*
1089              * Now search for the cipher alias in the ca_list. Be careful
1090              * with the strncmp, because the "buflen" limitation
1091              * will make the rule "ADH:SOME" and the cipher
1092              * "ADH-MY-CIPHER" look like a match for buflen=3.
1093              * So additionally check whether the cipher name found
1094              * has the correct length. We can save a strlen() call:
1095              * just checking for the '\0' at the right place is
1096              * sufficient, we have to strncmp() anyway. (We cannot
1097              * use strcmp(), because buf is not '\0' terminated.)
1098              */
1099             j = found = 0;
1100             cipher_id = 0;
1101             while (ca_list[j]) {
1102                 if (strncmp(buf, ca_list[j]->name, buflen) == 0
1103                     && (ca_list[j]->name[buflen] == '\0')) {
1104                     found = 1;
1105                     break;
1106                 } else
1107                     j++;
1108             }
1109
1110             if (!found)
1111                 break;          /* ignore this entry */
1112
1113             if (ca_list[j]->algorithm_mkey) {
1114                 if (alg_mkey) {
1115                     alg_mkey &= ca_list[j]->algorithm_mkey;
1116                     if (!alg_mkey) {
1117                         found = 0;
1118                         break;
1119                     }
1120                 } else {
1121                     alg_mkey = ca_list[j]->algorithm_mkey;
1122                 }
1123             }
1124
1125             if (ca_list[j]->algorithm_auth) {
1126                 if (alg_auth) {
1127                     alg_auth &= ca_list[j]->algorithm_auth;
1128                     if (!alg_auth) {
1129                         found = 0;
1130                         break;
1131                     }
1132                 } else {
1133                     alg_auth = ca_list[j]->algorithm_auth;
1134                 }
1135             }
1136
1137             if (ca_list[j]->algorithm_enc) {
1138                 if (alg_enc) {
1139                     alg_enc &= ca_list[j]->algorithm_enc;
1140                     if (!alg_enc) {
1141                         found = 0;
1142                         break;
1143                     }
1144                 } else {
1145                     alg_enc = ca_list[j]->algorithm_enc;
1146                 }
1147             }
1148
1149             if (ca_list[j]->algorithm_mac) {
1150                 if (alg_mac) {
1151                     alg_mac &= ca_list[j]->algorithm_mac;
1152                     if (!alg_mac) {
1153                         found = 0;
1154                         break;
1155                     }
1156                 } else {
1157                     alg_mac = ca_list[j]->algorithm_mac;
1158                 }
1159             }
1160
1161             if (ca_list[j]->algo_strength & SSL_STRONG_MASK) {
1162                 if (algo_strength & SSL_STRONG_MASK) {
1163                     algo_strength &=
1164                         (ca_list[j]->algo_strength & SSL_STRONG_MASK) |
1165                         ~SSL_STRONG_MASK;
1166                     if (!(algo_strength & SSL_STRONG_MASK)) {
1167                         found = 0;
1168                         break;
1169                     }
1170                 } else {
1171                     algo_strength = ca_list[j]->algo_strength & SSL_STRONG_MASK;
1172                 }
1173             }
1174
1175             if (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) {
1176                 if (algo_strength & SSL_DEFAULT_MASK) {
1177                     algo_strength &=
1178                         (ca_list[j]->algo_strength & SSL_DEFAULT_MASK) |
1179                         ~SSL_DEFAULT_MASK;
1180                     if (!(algo_strength & SSL_DEFAULT_MASK)) {
1181                         found = 0;
1182                         break;
1183                     }
1184                 } else {
1185                     algo_strength |=
1186                         ca_list[j]->algo_strength & SSL_DEFAULT_MASK;
1187                 }
1188             }
1189
1190             if (ca_list[j]->valid) {
1191                 /*
1192                  * explicit ciphersuite found; its protocol version does not
1193                  * become part of the search pattern!
1194                  */
1195
1196                 cipher_id = ca_list[j]->id;
1197             } else {
1198                 /*
1199                  * not an explicit ciphersuite; only in this case, the
1200                  * protocol version is considered part of the search pattern
1201                  */
1202
1203                 if (ca_list[j]->min_tls) {
1204                     if (min_tls != 0 && min_tls != ca_list[j]->min_tls) {
1205                         found = 0;
1206                         break;
1207                     } else {
1208                         min_tls = ca_list[j]->min_tls;
1209                     }
1210                 }
1211             }
1212
1213             if (!multi)
1214                 break;
1215         }
1216
1217         /*
1218          * Ok, we have the rule, now apply it
1219          */
1220         if (rule == CIPHER_SPECIAL) { /* special command */
1221             ok = 0;
1222             if ((buflen == 8) && strncmp(buf, "STRENGTH", 8) == 0) {
1223                 ok = ssl_cipher_strength_sort(head_p, tail_p);
1224             } else if (buflen == 10 && strncmp(buf, "SECLEVEL=", 9) == 0) {
1225                 int level = buf[9] - '0';
1226                 if (level < 0 || level > 5) {
1227                     ERR_raise(ERR_LIB_SSL, SSL_R_INVALID_COMMAND);
1228                 } else {
1229                     c->sec_level = level;
1230                     ok = 1;
1231                 }
1232             } else {
1233                 ERR_raise(ERR_LIB_SSL, SSL_R_INVALID_COMMAND);
1234             }
1235             if (ok == 0)
1236                 retval = 0;
1237             /*
1238              * We do not support any "multi" options
1239              * together with "@", so throw away the
1240              * rest of the command, if any left, until
1241              * end or ':' is found.
1242              */
1243             while ((*l != '\0') && !ITEM_SEP(*l))
1244                 l++;
1245         } else if (found) {
1246             ssl_cipher_apply_rule(cipher_id,
1247                                   alg_mkey, alg_auth, alg_enc, alg_mac,
1248                                   min_tls, algo_strength, rule, -1, head_p,
1249                                   tail_p);
1250         } else {
1251             while ((*l != '\0') && !ITEM_SEP(*l))
1252                 l++;
1253         }
1254         if (*l == '\0')
1255             break;              /* done */
1256     }
1257
1258     return retval;
1259 }
1260
1261 static int check_suiteb_cipher_list(const SSL_METHOD *meth, CERT *c,
1262                                     const char **prule_str)
1263 {
1264     unsigned int suiteb_flags = 0, suiteb_comb2 = 0;
1265     if (strncmp(*prule_str, "SUITEB128ONLY", 13) == 0) {
1266         suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS_ONLY;
1267     } else if (strncmp(*prule_str, "SUITEB128C2", 11) == 0) {
1268         suiteb_comb2 = 1;
1269         suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1270     } else if (strncmp(*prule_str, "SUITEB128", 9) == 0) {
1271         suiteb_flags = SSL_CERT_FLAG_SUITEB_128_LOS;
1272     } else if (strncmp(*prule_str, "SUITEB192", 9) == 0) {
1273         suiteb_flags = SSL_CERT_FLAG_SUITEB_192_LOS;
1274     }
1275
1276     if (suiteb_flags) {
1277         c->cert_flags &= ~SSL_CERT_FLAG_SUITEB_128_LOS;
1278         c->cert_flags |= suiteb_flags;
1279     } else {
1280         suiteb_flags = c->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS;
1281     }
1282
1283     if (!suiteb_flags)
1284         return 1;
1285     /* Check version: if TLS 1.2 ciphers allowed we can use Suite B */
1286
1287     if (!(meth->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)) {
1288         ERR_raise(ERR_LIB_SSL, SSL_R_AT_LEAST_TLS_1_2_NEEDED_IN_SUITEB_MODE);
1289         return 0;
1290     }
1291
1292     switch (suiteb_flags) {
1293     case SSL_CERT_FLAG_SUITEB_128_LOS:
1294         if (suiteb_comb2)
1295             *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1296         else
1297             *prule_str =
1298                 "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384";
1299         break;
1300     case SSL_CERT_FLAG_SUITEB_128_LOS_ONLY:
1301         *prule_str = "ECDHE-ECDSA-AES128-GCM-SHA256";
1302         break;
1303     case SSL_CERT_FLAG_SUITEB_192_LOS:
1304         *prule_str = "ECDHE-ECDSA-AES256-GCM-SHA384";
1305         break;
1306     }
1307     return 1;
1308 }
1309
1310 static int ciphersuite_cb(const char *elem, int len, void *arg)
1311 {
1312     STACK_OF(SSL_CIPHER) *ciphersuites = (STACK_OF(SSL_CIPHER) *)arg;
1313     const SSL_CIPHER *cipher;
1314     /* Arbitrary sized temp buffer for the cipher name. Should be big enough */
1315     char name[80];
1316
1317     if (len > (int)(sizeof(name) - 1))
1318         /* Anyway return 1 so we can parse rest of the list */
1319         return 1;
1320
1321     memcpy(name, elem, len);
1322     name[len] = '\0';
1323
1324     cipher = ssl3_get_cipher_by_std_name(name);
1325     if (cipher == NULL)
1326         /* Ciphersuite not found but return 1 to parse rest of the list */
1327         return 1;
1328
1329     if (!sk_SSL_CIPHER_push(ciphersuites, cipher)) {
1330         ERR_raise(ERR_LIB_SSL, ERR_R_INTERNAL_ERROR);
1331         return 0;
1332     }
1333
1334     return 1;
1335 }
1336
1337 static __owur int set_ciphersuites(STACK_OF(SSL_CIPHER) **currciphers, const char *str)
1338 {
1339     STACK_OF(SSL_CIPHER) *newciphers = sk_SSL_CIPHER_new_null();
1340
1341     if (newciphers == NULL)
1342         return 0;
1343
1344     /* Parse the list. We explicitly allow an empty list */
1345     if (*str != '\0'
1346             && (CONF_parse_list(str, ':', 1, ciphersuite_cb, newciphers) <= 0
1347                 || sk_SSL_CIPHER_num(newciphers) == 0)) {
1348         ERR_raise(ERR_LIB_SSL, SSL_R_NO_CIPHER_MATCH);
1349         sk_SSL_CIPHER_free(newciphers);
1350         return 0;
1351     }
1352     sk_SSL_CIPHER_free(*currciphers);
1353     *currciphers = newciphers;
1354
1355     return 1;
1356 }
1357
1358 static int update_cipher_list_by_id(STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1359                                     STACK_OF(SSL_CIPHER) *cipherstack)
1360 {
1361     STACK_OF(SSL_CIPHER) *tmp_cipher_list = sk_SSL_CIPHER_dup(cipherstack);
1362
1363     if (tmp_cipher_list == NULL) {
1364         return 0;
1365     }
1366
1367     sk_SSL_CIPHER_free(*cipher_list_by_id);
1368     *cipher_list_by_id = tmp_cipher_list;
1369
1370     (void)sk_SSL_CIPHER_set_cmp_func(*cipher_list_by_id, ssl_cipher_ptr_id_cmp);
1371     sk_SSL_CIPHER_sort(*cipher_list_by_id);
1372
1373     return 1;
1374 }
1375
1376 static int update_cipher_list(SSL_CTX *ctx,
1377                               STACK_OF(SSL_CIPHER) **cipher_list,
1378                               STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1379                               STACK_OF(SSL_CIPHER) *tls13_ciphersuites)
1380 {
1381     int i;
1382     STACK_OF(SSL_CIPHER) *tmp_cipher_list = sk_SSL_CIPHER_dup(*cipher_list);
1383
1384     if (tmp_cipher_list == NULL)
1385         return 0;
1386
1387     /*
1388      * Delete any existing TLSv1.3 ciphersuites. These are always first in the
1389      * list.
1390      */
1391     while (sk_SSL_CIPHER_num(tmp_cipher_list) > 0
1392            && sk_SSL_CIPHER_value(tmp_cipher_list, 0)->min_tls
1393               == TLS1_3_VERSION)
1394         (void)sk_SSL_CIPHER_delete(tmp_cipher_list, 0);
1395
1396     /* Insert the new TLSv1.3 ciphersuites */
1397     for (i = sk_SSL_CIPHER_num(tls13_ciphersuites) - 1; i >= 0; i--) {
1398         const SSL_CIPHER *sslc = sk_SSL_CIPHER_value(tls13_ciphersuites, i);
1399
1400         /* Don't include any TLSv1.3 ciphersuites that are disabled */
1401         if ((sslc->algorithm_enc & ctx->disabled_enc_mask) == 0
1402                 && (ssl_cipher_table_mac[sslc->algorithm2
1403                                          & SSL_HANDSHAKE_MAC_MASK].mask
1404                     & ctx->disabled_mac_mask) == 0) {
1405             sk_SSL_CIPHER_unshift(tmp_cipher_list, sslc);
1406         }
1407     }
1408
1409     if (!update_cipher_list_by_id(cipher_list_by_id, tmp_cipher_list)) {
1410         sk_SSL_CIPHER_free(tmp_cipher_list);
1411         return 0;
1412     }
1413
1414     sk_SSL_CIPHER_free(*cipher_list);
1415     *cipher_list = tmp_cipher_list;
1416
1417     return 1;
1418 }
1419
1420 int SSL_CTX_set_ciphersuites(SSL_CTX *ctx, const char *str)
1421 {
1422     int ret = set_ciphersuites(&(ctx->tls13_ciphersuites), str);
1423
1424     if (ret && ctx->cipher_list != NULL)
1425         return update_cipher_list(ctx, &ctx->cipher_list, &ctx->cipher_list_by_id,
1426                                   ctx->tls13_ciphersuites);
1427
1428     return ret;
1429 }
1430
1431 int SSL_set_ciphersuites(SSL *s, const char *str)
1432 {
1433     STACK_OF(SSL_CIPHER) *cipher_list;
1434     int ret = set_ciphersuites(&(s->tls13_ciphersuites), str);
1435
1436     if (s->cipher_list == NULL) {
1437         if ((cipher_list = SSL_get_ciphers(s)) != NULL)
1438             s->cipher_list = sk_SSL_CIPHER_dup(cipher_list);
1439     }
1440     if (ret && s->cipher_list != NULL)
1441         return update_cipher_list(s->ctx, &s->cipher_list, &s->cipher_list_by_id,
1442                                   s->tls13_ciphersuites);
1443
1444     return ret;
1445 }
1446
1447 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(SSL_CTX *ctx,
1448                                              STACK_OF(SSL_CIPHER) *tls13_ciphersuites,
1449                                              STACK_OF(SSL_CIPHER) **cipher_list,
1450                                              STACK_OF(SSL_CIPHER) **cipher_list_by_id,
1451                                              const char *rule_str,
1452                                              CERT *c)
1453 {
1454     int ok, num_of_ciphers, num_of_alias_max, num_of_group_aliases, i;
1455     uint32_t disabled_mkey, disabled_auth, disabled_enc, disabled_mac;
1456     STACK_OF(SSL_CIPHER) *cipherstack;
1457     const char *rule_p;
1458     CIPHER_ORDER *co_list = NULL, *head = NULL, *tail = NULL, *curr;
1459     const SSL_CIPHER **ca_list = NULL;
1460     const SSL_METHOD *ssl_method = ctx->method;
1461
1462     /*
1463      * Return with error if nothing to do.
1464      */
1465     if (rule_str == NULL || cipher_list == NULL || cipher_list_by_id == NULL)
1466         return NULL;
1467
1468     if (!check_suiteb_cipher_list(ssl_method, c, &rule_str))
1469         return NULL;
1470
1471     /*
1472      * To reduce the work to do we only want to process the compiled
1473      * in algorithms, so we first get the mask of disabled ciphers.
1474      */
1475
1476     disabled_mkey = ctx->disabled_mkey_mask;
1477     disabled_auth = ctx->disabled_auth_mask;
1478     disabled_enc = ctx->disabled_enc_mask;
1479     disabled_mac = ctx->disabled_mac_mask;
1480
1481     /*
1482      * Now we have to collect the available ciphers from the compiled
1483      * in ciphers. We cannot get more than the number compiled in, so
1484      * it is used for allocation.
1485      */
1486     num_of_ciphers = ssl_method->num_ciphers();
1487
1488     co_list = OPENSSL_malloc(sizeof(*co_list) * num_of_ciphers);
1489     if (co_list == NULL) {
1490         ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
1491         return NULL;          /* Failure */
1492     }
1493
1494     ssl_cipher_collect_ciphers(ssl_method, num_of_ciphers,
1495                                disabled_mkey, disabled_auth, disabled_enc,
1496                                disabled_mac, co_list, &head, &tail);
1497
1498     /* Now arrange all ciphers by preference. */
1499
1500     /*
1501      * Everything else being equal, prefer ephemeral ECDH over other key
1502      * exchange mechanisms.
1503      * For consistency, prefer ECDSA over RSA (though this only matters if the
1504      * server has both certificates, and is using the DEFAULT, or a client
1505      * preference).
1506      */
1507     ssl_cipher_apply_rule(0, SSL_kECDHE, SSL_aECDSA, 0, 0, 0, 0, CIPHER_ADD,
1508                           -1, &head, &tail);
1509     ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head,
1510                           &tail);
1511     ssl_cipher_apply_rule(0, SSL_kECDHE, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head,
1512                           &tail);
1513
1514     /* Within each strength group, we prefer GCM over CHACHA... */
1515     ssl_cipher_apply_rule(0, 0, 0, SSL_AESGCM, 0, 0, 0, CIPHER_ADD, -1,
1516                           &head, &tail);
1517     ssl_cipher_apply_rule(0, 0, 0, SSL_CHACHA20, 0, 0, 0, CIPHER_ADD, -1,
1518                           &head, &tail);
1519
1520     /*
1521      * ...and generally, our preferred cipher is AES.
1522      * Note that AEADs will be bumped to take preference after sorting by
1523      * strength.
1524      */
1525     ssl_cipher_apply_rule(0, 0, 0, SSL_AES ^ SSL_AESGCM, 0, 0, 0, CIPHER_ADD,
1526                           -1, &head, &tail);
1527
1528     /* Temporarily enable everything else for sorting */
1529     ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_ADD, -1, &head, &tail);
1530
1531     /* Low priority for MD5 */
1532     ssl_cipher_apply_rule(0, 0, 0, 0, SSL_MD5, 0, 0, CIPHER_ORD, -1, &head,
1533                           &tail);
1534
1535     /*
1536      * Move anonymous ciphers to the end.  Usually, these will remain
1537      * disabled. (For applications that allow them, they aren't too bad, but
1538      * we prefer authenticated ciphers.)
1539      */
1540     ssl_cipher_apply_rule(0, 0, SSL_aNULL, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1541                           &tail);
1542
1543     ssl_cipher_apply_rule(0, SSL_kRSA, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1544                           &tail);
1545     ssl_cipher_apply_rule(0, SSL_kPSK, 0, 0, 0, 0, 0, CIPHER_ORD, -1, &head,
1546                           &tail);
1547
1548     /* RC4 is sort-of broken -- move to the end */
1549     ssl_cipher_apply_rule(0, 0, 0, SSL_RC4, 0, 0, 0, CIPHER_ORD, -1, &head,
1550                           &tail);
1551
1552     /*
1553      * Now sort by symmetric encryption strength.  The above ordering remains
1554      * in force within each class
1555      */
1556     if (!ssl_cipher_strength_sort(&head, &tail)) {
1557         OPENSSL_free(co_list);
1558         return NULL;
1559     }
1560
1561     /*
1562      * Partially overrule strength sort to prefer TLS 1.2 ciphers/PRFs.
1563      */
1564     ssl_cipher_apply_rule(0, 0, 0, 0, 0, TLS1_2_VERSION, 0, CIPHER_BUMP, -1,
1565                           &head, &tail);
1566
1567     /*
1568      * Irrespective of strength, enforce the following order:
1569      * (EC)DHE + AEAD > (EC)DHE > rest of AEAD > rest.
1570      * Within each group, ciphers remain sorted by strength and previous
1571      * preference, i.e.,
1572      * 1) ECDHE > DHE
1573      * 2) GCM > CHACHA
1574      * 3) AES > rest
1575      * 4) TLS 1.2 > legacy
1576      *
1577      * Because we now bump ciphers to the top of the list, we proceed in
1578      * reverse order of preference.
1579      */
1580     ssl_cipher_apply_rule(0, 0, 0, 0, SSL_AEAD, 0, 0, CIPHER_BUMP, -1,
1581                           &head, &tail);
1582     ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, 0, 0, 0,
1583                           CIPHER_BUMP, -1, &head, &tail);
1584     ssl_cipher_apply_rule(0, SSL_kDHE | SSL_kECDHE, 0, 0, SSL_AEAD, 0, 0,
1585                           CIPHER_BUMP, -1, &head, &tail);
1586
1587     /* Now disable everything (maintaining the ordering!) */
1588     ssl_cipher_apply_rule(0, 0, 0, 0, 0, 0, 0, CIPHER_DEL, -1, &head, &tail);
1589
1590     /*
1591      * We also need cipher aliases for selecting based on the rule_str.
1592      * There might be two types of entries in the rule_str: 1) names
1593      * of ciphers themselves 2) aliases for groups of ciphers.
1594      * For 1) we need the available ciphers and for 2) the cipher
1595      * groups of cipher_aliases added together in one list (otherwise
1596      * we would be happy with just the cipher_aliases table).
1597      */
1598     num_of_group_aliases = OSSL_NELEM(cipher_aliases);
1599     num_of_alias_max = num_of_ciphers + num_of_group_aliases + 1;
1600     ca_list = OPENSSL_malloc(sizeof(*ca_list) * num_of_alias_max);
1601     if (ca_list == NULL) {
1602         OPENSSL_free(co_list);
1603         ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
1604         return NULL;          /* Failure */
1605     }
1606     ssl_cipher_collect_aliases(ca_list, num_of_group_aliases,
1607                                disabled_mkey, disabled_auth, disabled_enc,
1608                                disabled_mac, head);
1609
1610     /*
1611      * If the rule_string begins with DEFAULT, apply the default rule
1612      * before using the (possibly available) additional rules.
1613      */
1614     ok = 1;
1615     rule_p = rule_str;
1616     if (strncmp(rule_str, "DEFAULT", 7) == 0) {
1617         ok = ssl_cipher_process_rulestr(OSSL_default_cipher_list(),
1618                                         &head, &tail, ca_list, c);
1619         rule_p += 7;
1620         if (*rule_p == ':')
1621             rule_p++;
1622     }
1623
1624     if (ok && (rule_p[0] != '\0'))
1625         ok = ssl_cipher_process_rulestr(rule_p, &head, &tail, ca_list, c);
1626
1627     OPENSSL_free(ca_list);      /* Not needed anymore */
1628
1629     if (!ok) {                  /* Rule processing failure */
1630         OPENSSL_free(co_list);
1631         return NULL;
1632     }
1633
1634     /*
1635      * Allocate new "cipherstack" for the result, return with error
1636      * if we cannot get one.
1637      */
1638     if ((cipherstack = sk_SSL_CIPHER_new_null()) == NULL) {
1639         OPENSSL_free(co_list);
1640         return NULL;
1641     }
1642
1643     /* Add TLSv1.3 ciphers first - we always prefer those if possible */
1644     for (i = 0; i < sk_SSL_CIPHER_num(tls13_ciphersuites); i++) {
1645         const SSL_CIPHER *sslc = sk_SSL_CIPHER_value(tls13_ciphersuites, i);
1646
1647         /* Don't include any TLSv1.3 ciphers that are disabled */
1648         if ((sslc->algorithm_enc & disabled_enc) != 0
1649                 || (ssl_cipher_table_mac[sslc->algorithm2
1650                                          & SSL_HANDSHAKE_MAC_MASK].mask
1651                     & ctx->disabled_mac_mask) != 0) {
1652             sk_SSL_CIPHER_delete(tls13_ciphersuites, i);
1653             i--;
1654             continue;
1655         }
1656
1657         if (!sk_SSL_CIPHER_push(cipherstack, sslc)) {
1658             OPENSSL_free(co_list);
1659             sk_SSL_CIPHER_free(cipherstack);
1660             return NULL;
1661         }
1662     }
1663
1664     OSSL_TRACE_BEGIN(TLS_CIPHER) {
1665         BIO_printf(trc_out, "cipher selection:\n");
1666     }
1667     /*
1668      * The cipher selection for the list is done. The ciphers are added
1669      * to the resulting precedence to the STACK_OF(SSL_CIPHER).
1670      */
1671     for (curr = head; curr != NULL; curr = curr->next) {
1672         if (curr->active) {
1673             if (!sk_SSL_CIPHER_push(cipherstack, curr->cipher)) {
1674                 OPENSSL_free(co_list);
1675                 sk_SSL_CIPHER_free(cipherstack);
1676                 OSSL_TRACE_CANCEL(TLS_CIPHER);
1677                 return NULL;
1678             }
1679             if (trc_out != NULL)
1680                 BIO_printf(trc_out, "<%s>\n", curr->cipher->name);
1681         }
1682     }
1683     OPENSSL_free(co_list);      /* Not needed any longer */
1684     OSSL_TRACE_END(TLS_CIPHER);
1685
1686     if (!update_cipher_list_by_id(cipher_list_by_id, cipherstack)) {
1687         sk_SSL_CIPHER_free(cipherstack);
1688         return NULL;
1689     }
1690     sk_SSL_CIPHER_free(*cipher_list);
1691     *cipher_list = cipherstack;
1692
1693     return cipherstack;
1694 }
1695
1696 char *SSL_CIPHER_description(const SSL_CIPHER *cipher, char *buf, int len)
1697 {
1698     const char *ver;
1699     const char *kx, *au, *enc, *mac;
1700     uint32_t alg_mkey, alg_auth, alg_enc, alg_mac;
1701     static const char *format = "%-30s %-7s Kx=%-8s Au=%-5s Enc=%-22s Mac=%-4s\n";
1702
1703     if (buf == NULL) {
1704         len = 128;
1705         if ((buf = OPENSSL_malloc(len)) == NULL) {
1706             ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
1707             return NULL;
1708         }
1709     } else if (len < 128) {
1710         return NULL;
1711     }
1712
1713     alg_mkey = cipher->algorithm_mkey;
1714     alg_auth = cipher->algorithm_auth;
1715     alg_enc = cipher->algorithm_enc;
1716     alg_mac = cipher->algorithm_mac;
1717
1718     ver = ssl_protocol_to_string(cipher->min_tls);
1719
1720     switch (alg_mkey) {
1721     case SSL_kRSA:
1722         kx = "RSA";
1723         break;
1724     case SSL_kDHE:
1725         kx = "DH";
1726         break;
1727     case SSL_kECDHE:
1728         kx = "ECDH";
1729         break;
1730     case SSL_kPSK:
1731         kx = "PSK";
1732         break;
1733     case SSL_kRSAPSK:
1734         kx = "RSAPSK";
1735         break;
1736     case SSL_kECDHEPSK:
1737         kx = "ECDHEPSK";
1738         break;
1739     case SSL_kDHEPSK:
1740         kx = "DHEPSK";
1741         break;
1742     case SSL_kSRP:
1743         kx = "SRP";
1744         break;
1745     case SSL_kGOST:
1746         kx = "GOST";
1747         break;
1748     case SSL_kGOST18:
1749         kx = "GOST18";
1750         break;
1751     case SSL_kANY:
1752         kx = "any";
1753         break;
1754     default:
1755         kx = "unknown";
1756     }
1757
1758     switch (alg_auth) {
1759     case SSL_aRSA:
1760         au = "RSA";
1761         break;
1762     case SSL_aDSS:
1763         au = "DSS";
1764         break;
1765     case SSL_aNULL:
1766         au = "None";
1767         break;
1768     case SSL_aECDSA:
1769         au = "ECDSA";
1770         break;
1771     case SSL_aPSK:
1772         au = "PSK";
1773         break;
1774     case SSL_aSRP:
1775         au = "SRP";
1776         break;
1777     case SSL_aGOST01:
1778         au = "GOST01";
1779         break;
1780     /* New GOST ciphersuites have both SSL_aGOST12 and SSL_aGOST01 bits */
1781     case (SSL_aGOST12 | SSL_aGOST01):
1782         au = "GOST12";
1783         break;
1784     case SSL_aANY:
1785         au = "any";
1786         break;
1787     default:
1788         au = "unknown";
1789         break;
1790     }
1791
1792     switch (alg_enc) {
1793     case SSL_DES:
1794         enc = "DES(56)";
1795         break;
1796     case SSL_3DES:
1797         enc = "3DES(168)";
1798         break;
1799     case SSL_RC4:
1800         enc = "RC4(128)";
1801         break;
1802     case SSL_RC2:
1803         enc = "RC2(128)";
1804         break;
1805     case SSL_IDEA:
1806         enc = "IDEA(128)";
1807         break;
1808     case SSL_eNULL:
1809         enc = "None";
1810         break;
1811     case SSL_AES128:
1812         enc = "AES(128)";
1813         break;
1814     case SSL_AES256:
1815         enc = "AES(256)";
1816         break;
1817     case SSL_AES128GCM:
1818         enc = "AESGCM(128)";
1819         break;
1820     case SSL_AES256GCM:
1821         enc = "AESGCM(256)";
1822         break;
1823     case SSL_AES128CCM:
1824         enc = "AESCCM(128)";
1825         break;
1826     case SSL_AES256CCM:
1827         enc = "AESCCM(256)";
1828         break;
1829     case SSL_AES128CCM8:
1830         enc = "AESCCM8(128)";
1831         break;
1832     case SSL_AES256CCM8:
1833         enc = "AESCCM8(256)";
1834         break;
1835     case SSL_CAMELLIA128:
1836         enc = "Camellia(128)";
1837         break;
1838     case SSL_CAMELLIA256:
1839         enc = "Camellia(256)";
1840         break;
1841     case SSL_ARIA128GCM:
1842         enc = "ARIAGCM(128)";
1843         break;
1844     case SSL_ARIA256GCM:
1845         enc = "ARIAGCM(256)";
1846         break;
1847     case SSL_SEED:
1848         enc = "SEED(128)";
1849         break;
1850     case SSL_eGOST2814789CNT:
1851     case SSL_eGOST2814789CNT12:
1852         enc = "GOST89(256)";
1853         break;
1854     case SSL_MAGMA:
1855         enc = "MAGMA";
1856         break;
1857     case SSL_KUZNYECHIK:
1858         enc = "KUZNYECHIK";
1859         break;
1860     case SSL_CHACHA20POLY1305:
1861         enc = "CHACHA20/POLY1305(256)";
1862         break;
1863     default:
1864         enc = "unknown";
1865         break;
1866     }
1867
1868     switch (alg_mac) {
1869     case SSL_MD5:
1870         mac = "MD5";
1871         break;
1872     case SSL_SHA1:
1873         mac = "SHA1";
1874         break;
1875     case SSL_SHA256:
1876         mac = "SHA256";
1877         break;
1878     case SSL_SHA384:
1879         mac = "SHA384";
1880         break;
1881     case SSL_AEAD:
1882         mac = "AEAD";
1883         break;
1884     case SSL_GOST89MAC:
1885     case SSL_GOST89MAC12:
1886         mac = "GOST89";
1887         break;
1888     case SSL_GOST94:
1889         mac = "GOST94";
1890         break;
1891     case SSL_GOST12_256:
1892     case SSL_GOST12_512:
1893         mac = "GOST2012";
1894         break;
1895     default:
1896         mac = "unknown";
1897         break;
1898     }
1899
1900     BIO_snprintf(buf, len, format, cipher->name, ver, kx, au, enc, mac);
1901
1902     return buf;
1903 }
1904
1905 const char *SSL_CIPHER_get_version(const SSL_CIPHER *c)
1906 {
1907     if (c == NULL)
1908         return "(NONE)";
1909
1910     /*
1911      * Backwards-compatibility crutch.  In almost all contexts we report TLS
1912      * 1.0 as "TLSv1", but for ciphers we report "TLSv1.0".
1913      */
1914     if (c->min_tls == TLS1_VERSION)
1915         return "TLSv1.0";
1916     return ssl_protocol_to_string(c->min_tls);
1917 }
1918
1919 /* return the actual cipher being used */
1920 const char *SSL_CIPHER_get_name(const SSL_CIPHER *c)
1921 {
1922     if (c != NULL)
1923         return c->name;
1924     return "(NONE)";
1925 }
1926
1927 /* return the actual cipher being used in RFC standard name */
1928 const char *SSL_CIPHER_standard_name(const SSL_CIPHER *c)
1929 {
1930     if (c != NULL)
1931         return c->stdname;
1932     return "(NONE)";
1933 }
1934
1935 /* return the OpenSSL name based on given RFC standard name */
1936 const char *OPENSSL_cipher_name(const char *stdname)
1937 {
1938     const SSL_CIPHER *c;
1939
1940     if (stdname == NULL)
1941         return "(NONE)";
1942     c = ssl3_get_cipher_by_std_name(stdname);
1943     return SSL_CIPHER_get_name(c);
1944 }
1945
1946 /* number of bits for symmetric cipher */
1947 int SSL_CIPHER_get_bits(const SSL_CIPHER *c, int *alg_bits)
1948 {
1949     int ret = 0;
1950
1951     if (c != NULL) {
1952         if (alg_bits != NULL)
1953             *alg_bits = (int)c->alg_bits;
1954         ret = (int)c->strength_bits;
1955     }
1956     return ret;
1957 }
1958
1959 uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *c)
1960 {
1961     return c->id;
1962 }
1963
1964 uint16_t SSL_CIPHER_get_protocol_id(const SSL_CIPHER *c)
1965 {
1966     return c->id & 0xFFFF;
1967 }
1968
1969 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n)
1970 {
1971     SSL_COMP *ctmp;
1972     int i, nn;
1973
1974     if ((n == 0) || (sk == NULL))
1975         return NULL;
1976     nn = sk_SSL_COMP_num(sk);
1977     for (i = 0; i < nn; i++) {
1978         ctmp = sk_SSL_COMP_value(sk, i);
1979         if (ctmp->id == n)
1980             return ctmp;
1981     }
1982     return NULL;
1983 }
1984
1985 #ifdef OPENSSL_NO_COMP
1986 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
1987 {
1988     return NULL;
1989 }
1990
1991 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
1992                                                       *meths)
1993 {
1994     return meths;
1995 }
1996
1997 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
1998 {
1999     return 1;
2000 }
2001
2002 #else
2003 STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void)
2004 {
2005     load_builtin_compressions();
2006     return ssl_comp_methods;
2007 }
2008
2009 STACK_OF(SSL_COMP) *SSL_COMP_set0_compression_methods(STACK_OF(SSL_COMP)
2010                                                       *meths)
2011 {
2012     STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
2013     ssl_comp_methods = meths;
2014     return old_meths;
2015 }
2016
2017 static void cmeth_free(SSL_COMP *cm)
2018 {
2019     OPENSSL_free(cm);
2020 }
2021
2022 void ssl_comp_free_compression_methods_int(void)
2023 {
2024     STACK_OF(SSL_COMP) *old_meths = ssl_comp_methods;
2025     ssl_comp_methods = NULL;
2026     sk_SSL_COMP_pop_free(old_meths, cmeth_free);
2027 }
2028
2029 int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm)
2030 {
2031     SSL_COMP *comp;
2032
2033     if (cm == NULL || COMP_get_type(cm) == NID_undef)
2034         return 1;
2035
2036     /*-
2037      * According to draft-ietf-tls-compression-04.txt, the
2038      * compression number ranges should be the following:
2039      *
2040      *   0 to  63:  methods defined by the IETF
2041      *  64 to 192:  external party methods assigned by IANA
2042      * 193 to 255:  reserved for private use
2043      */
2044     if (id < 193 || id > 255) {
2045         ERR_raise(ERR_LIB_SSL, SSL_R_COMPRESSION_ID_NOT_WITHIN_PRIVATE_RANGE);
2046         return 1;
2047     }
2048
2049     comp = OPENSSL_malloc(sizeof(*comp));
2050     if (comp == NULL) {
2051         ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
2052         return 1;
2053     }
2054
2055     comp->id = id;
2056     comp->method = cm;
2057     load_builtin_compressions();
2058     if (ssl_comp_methods && sk_SSL_COMP_find(ssl_comp_methods, comp) >= 0) {
2059         OPENSSL_free(comp);
2060         ERR_raise(ERR_LIB_SSL, SSL_R_DUPLICATE_COMPRESSION_ID);
2061         return 1;
2062     }
2063     if (ssl_comp_methods == NULL || !sk_SSL_COMP_push(ssl_comp_methods, comp)) {
2064         OPENSSL_free(comp);
2065         ERR_raise(ERR_LIB_SSL, ERR_R_MALLOC_FAILURE);
2066         return 1;
2067     }
2068     return 0;
2069 }
2070 #endif
2071
2072 const char *SSL_COMP_get_name(const COMP_METHOD *comp)
2073 {
2074 #ifndef OPENSSL_NO_COMP
2075     return comp ? COMP_get_name(comp) : NULL;
2076 #else
2077     return NULL;
2078 #endif
2079 }
2080
2081 const char *SSL_COMP_get0_name(const SSL_COMP *comp)
2082 {
2083 #ifndef OPENSSL_NO_COMP
2084     return comp->name;
2085 #else
2086     return NULL;
2087 #endif
2088 }
2089
2090 int SSL_COMP_get_id(const SSL_COMP *comp)
2091 {
2092 #ifndef OPENSSL_NO_COMP
2093     return comp->id;
2094 #else
2095     return -1;
2096 #endif
2097 }
2098
2099 const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl, const unsigned char *ptr,
2100                                          int all)
2101 {
2102     const SSL_CIPHER *c = ssl->method->get_cipher_by_char(ptr);
2103
2104     if (c == NULL || (!all && c->valid == 0))
2105         return NULL;
2106     return c;
2107 }
2108
2109 const SSL_CIPHER *SSL_CIPHER_find(SSL *ssl, const unsigned char *ptr)
2110 {
2111     return ssl->method->get_cipher_by_char(ptr);
2112 }
2113
2114 int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *c)
2115 {
2116     int i;
2117     if (c == NULL)
2118         return NID_undef;
2119     i = ssl_cipher_info_lookup(ssl_cipher_table_cipher, c->algorithm_enc);
2120     if (i == -1)
2121         return NID_undef;
2122     return ssl_cipher_table_cipher[i].nid;
2123 }
2124
2125 int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *c)
2126 {
2127     int i = ssl_cipher_info_lookup(ssl_cipher_table_mac, c->algorithm_mac);
2128
2129     if (i == -1)
2130         return NID_undef;
2131     return ssl_cipher_table_mac[i].nid;
2132 }
2133
2134 int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *c)
2135 {
2136     int i = ssl_cipher_info_lookup(ssl_cipher_table_kx, c->algorithm_mkey);
2137
2138     if (i == -1)
2139         return NID_undef;
2140     return ssl_cipher_table_kx[i].nid;
2141 }
2142
2143 int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *c)
2144 {
2145     int i = ssl_cipher_info_lookup(ssl_cipher_table_auth, c->algorithm_auth);
2146
2147     if (i == -1)
2148         return NID_undef;
2149     return ssl_cipher_table_auth[i].nid;
2150 }
2151
2152 const EVP_MD *SSL_CIPHER_get_handshake_digest(const SSL_CIPHER *c)
2153 {
2154     int idx = c->algorithm2 & SSL_HANDSHAKE_MAC_MASK;
2155
2156     if (idx < 0 || idx >= SSL_MD_NUM_IDX)
2157         return NULL;
2158     return EVP_get_digestbynid(ssl_cipher_table_mac[idx].nid);
2159 }
2160
2161 int SSL_CIPHER_is_aead(const SSL_CIPHER *c)
2162 {
2163     return (c->algorithm_mac & SSL_AEAD) ? 1 : 0;
2164 }
2165
2166 int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2167                             size_t *int_overhead, size_t *blocksize,
2168                             size_t *ext_overhead)
2169 {
2170     size_t mac = 0, in = 0, blk = 0, out = 0;
2171
2172     /* Some hard-coded numbers for the CCM/Poly1305 MAC overhead
2173      * because there are no handy #defines for those. */
2174     if (c->algorithm_enc & (SSL_AESGCM | SSL_ARIAGCM)) {
2175         out = EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
2176     } else if (c->algorithm_enc & (SSL_AES128CCM | SSL_AES256CCM)) {
2177         out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 16;
2178     } else if (c->algorithm_enc & (SSL_AES128CCM8 | SSL_AES256CCM8)) {
2179         out = EVP_CCM_TLS_EXPLICIT_IV_LEN + 8;
2180     } else if (c->algorithm_enc & SSL_CHACHA20POLY1305) {
2181         out = 16;
2182     } else if (c->algorithm_mac & SSL_AEAD) {
2183         /* We're supposed to have handled all the AEAD modes above */
2184         return 0;
2185     } else {
2186         /* Non-AEAD modes. Calculate MAC/cipher overhead separately */
2187         int digest_nid = SSL_CIPHER_get_digest_nid(c);
2188         const EVP_MD *e_md = EVP_get_digestbynid(digest_nid);
2189
2190         if (e_md == NULL)
2191             return 0;
2192
2193         mac = EVP_MD_get_size(e_md);
2194         if (c->algorithm_enc != SSL_eNULL) {
2195             int cipher_nid = SSL_CIPHER_get_cipher_nid(c);
2196             const EVP_CIPHER *e_ciph = EVP_get_cipherbynid(cipher_nid);
2197
2198             /* If it wasn't AEAD or SSL_eNULL, we expect it to be a
2199                known CBC cipher. */
2200             if (e_ciph == NULL ||
2201                 EVP_CIPHER_get_mode(e_ciph) != EVP_CIPH_CBC_MODE)
2202                 return 0;
2203
2204             in = 1; /* padding length byte */
2205             out = EVP_CIPHER_get_iv_length(e_ciph);
2206             blk = EVP_CIPHER_get_block_size(e_ciph);
2207         }
2208     }
2209
2210     *mac_overhead = mac;
2211     *int_overhead = in;
2212     *blocksize = blk;
2213     *ext_overhead = out;
2214
2215     return 1;
2216 }
2217
2218 int ssl_cert_is_disabled(SSL_CTX *ctx, size_t idx)
2219 {
2220     const SSL_CERT_LOOKUP *cl = ssl_cert_lookup_by_idx(idx);
2221
2222     if (cl == NULL || (cl->amask & ctx->disabled_auth_mask) != 0)
2223         return 1;
2224     return 0;
2225 }
2226
2227 /*
2228  * Default list of TLSv1.2 (and earlier) ciphers
2229  * SSL_DEFAULT_CIPHER_LIST deprecated in 3.0.0
2230  * Update both macro and function simultaneously
2231  */
2232 const char *OSSL_default_cipher_list(void)
2233 {
2234     return "ALL:!COMPLEMENTOFDEFAULT:!eNULL";
2235 }
2236
2237 /*
2238  * Default list of TLSv1.3 (and later) ciphers
2239  * TLS_DEFAULT_CIPHERSUITES deprecated in 3.0.0
2240  * Update both macro and function simultaneously
2241  */
2242 const char *OSSL_default_ciphersuites(void)
2243 {
2244     return "TLS_AES_256_GCM_SHA384:"
2245            "TLS_CHACHA20_POLY1305_SHA256:"
2246            "TLS_AES_128_GCM_SHA256";
2247 }