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