ssl/ssl_ciph.c

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