providers/common/capabilities.c

   1 /*
   2  * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <assert.h>
  11 #include <string.h>
  12 #include <openssl/core_dispatch.h>
  13 #include <openssl/core_names.h>
  14 /* For TLS1_VERSION etc */
  15 #include <openssl/ssl.h>
  16 #include <openssl/params.h>
  17 #include "internal/nelem.h"
  18 #include "internal/tlsgroups.h"
  19 #include "prov/providercommon.h"
  20 #include "e_os.h"
  21
  22 /* If neither ec or dh is available then we have no TLS-GROUP capabilities */
  23 #if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
  24 typedef struct tls_group_constants_st {
  25     unsigned int group_id;   /* Group ID */
  26     unsigned int secbits;    /* Bits of security */
  27     int mintls;              /* Minimum TLS version, -1 unsupported */
  28     int maxtls;              /* Maximum TLS version (or 0 for undefined) */
  29     int mindtls;             /* Minimum DTLS version, -1 unsupported */
  30     int maxdtls;             /* Maximum DTLS version (or 0 for undefined) */
  31 } TLS_GROUP_CONSTANTS;
  32
  33 static const TLS_GROUP_CONSTANTS group_list[35] = {
  34     { OSSL_TLS_GROUP_ID_sect163k1, 80, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  35     { OSSL_TLS_GROUP_ID_sect163r1, 80, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  36     { OSSL_TLS_GROUP_ID_sect163r2, 80, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  37     { OSSL_TLS_GROUP_ID_sect193r1, 80, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  38     { OSSL_TLS_GROUP_ID_sect193r2, 80, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  39     { OSSL_TLS_GROUP_ID_sect233k1, 112, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  40     { OSSL_TLS_GROUP_ID_sect233r1, 112, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  41     { OSSL_TLS_GROUP_ID_sect239k1, 112, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  42     { OSSL_TLS_GROUP_ID_sect283k1, 128, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  43     { OSSL_TLS_GROUP_ID_sect283r1, 128, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  44     { OSSL_TLS_GROUP_ID_sect409k1, 192, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  45     { OSSL_TLS_GROUP_ID_sect409r1, 192, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  46     { OSSL_TLS_GROUP_ID_sect571k1, 256, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  47     { OSSL_TLS_GROUP_ID_sect571r1, 256, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  48     { OSSL_TLS_GROUP_ID_secp160k1, 80, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  49     { OSSL_TLS_GROUP_ID_secp160r1, 80, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  50     { OSSL_TLS_GROUP_ID_secp160r2, 80, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  51     { OSSL_TLS_GROUP_ID_secp192k1, 80, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  52     { OSSL_TLS_GROUP_ID_secp192r1, 80, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  53     { OSSL_TLS_GROUP_ID_secp224k1, 112, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  54     { OSSL_TLS_GROUP_ID_secp224r1, 112, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  55     { OSSL_TLS_GROUP_ID_secp256k1, 128, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  56     { OSSL_TLS_GROUP_ID_secp256r1, 128, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  57     { OSSL_TLS_GROUP_ID_secp384r1, 192, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  58     { OSSL_TLS_GROUP_ID_secp521r1, 256, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  59     { OSSL_TLS_GROUP_ID_brainpoolP256r1, 128, TLS1_VERSION, TLS1_2_VERSION,
  60       DTLS1_VERSION, DTLS1_2_VERSION },
  61     { OSSL_TLS_GROUP_ID_brainpoolP384r1, 192, TLS1_VERSION, TLS1_2_VERSION,
  62       DTLS1_VERSION, DTLS1_2_VERSION },
  63     { OSSL_TLS_GROUP_ID_brainpoolP512r1, 256, TLS1_VERSION, TLS1_2_VERSION,
  64       DTLS1_VERSION, DTLS1_2_VERSION },
  65     { OSSL_TLS_GROUP_ID_x25519, 128, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  66     { OSSL_TLS_GROUP_ID_x448, 224, TLS1_VERSION, 0, DTLS1_VERSION, 0 },
  67     /* Security bit values as given by BN_security_bits() */
  68     { OSSL_TLS_GROUP_ID_ffdhe2048, 112, TLS1_3_VERSION, 0, -1, -1 },
  69     { OSSL_TLS_GROUP_ID_ffdhe3072, 128, TLS1_3_VERSION, 0, -1, -1 },
  70     { OSSL_TLS_GROUP_ID_ffdhe4096, 128, TLS1_3_VERSION, 0, -1, -1 },
  71     { OSSL_TLS_GROUP_ID_ffdhe6144, 128, TLS1_3_VERSION, 0, -1, -1 },
  72     { OSSL_TLS_GROUP_ID_ffdhe8192, 192, TLS1_3_VERSION, 0, -1, -1 },
  73 };
  74
  75 #define TLS_GROUP_ENTRY(tlsname, realname, algorithm, idx) \
  76     { \
  77         OSSL_PARAM_utf8_string(OSSL_CAPABILITY_TLS_GROUP_NAME, \
  78                                tlsname, \
  79                                sizeof(tlsname)), \
  80         OSSL_PARAM_utf8_string(OSSL_CAPABILITY_TLS_GROUP_NAME_INTERNAL, \
  81                                realname, \
  82                                sizeof(realname)), \
  83         OSSL_PARAM_utf8_string(OSSL_CAPABILITY_TLS_GROUP_ALG, \
  84                                algorithm, \
  85                                sizeof(algorithm)), \
  86         OSSL_PARAM_uint(OSSL_CAPABILITY_TLS_GROUP_ID, \
  87                         (unsigned int *)&group_list[idx].group_id), \
  88         OSSL_PARAM_uint(OSSL_CAPABILITY_TLS_GROUP_SECURITY_BITS, \
  89                         (unsigned int *)&group_list[idx].secbits), \
  90         OSSL_PARAM_int(OSSL_CAPABILITY_TLS_GROUP_MIN_TLS, \
  91                         (unsigned int *)&group_list[idx].mintls), \
  92         OSSL_PARAM_int(OSSL_CAPABILITY_TLS_GROUP_MAX_TLS, \
  93                         (unsigned int *)&group_list[idx].maxtls), \
  94         OSSL_PARAM_int(OSSL_CAPABILITY_TLS_GROUP_MIN_DTLS, \
  95                         (unsigned int *)&group_list[idx].mindtls), \
  96         OSSL_PARAM_int(OSSL_CAPABILITY_TLS_GROUP_MAX_DTLS, \
  97                         (unsigned int *)&group_list[idx].maxdtls), \
  98         OSSL_PARAM_END \
  99     }
 100
 101 static const OSSL_PARAM param_group_list[][10] = {
 102 # ifndef OPENSSL_NO_EC
 103 #  ifndef OPENSSL_NO_EC2M
 104     TLS_GROUP_ENTRY("sect163k1", "sect163k1", "EC", 0),
 105 #  endif
 106 #  ifndef FIPS_MODULE
 107     TLS_GROUP_ENTRY("sect163r1", "sect163r1", "EC", 1),
 108 #  endif
 109 #  ifndef OPENSSL_NO_EC2M
 110     TLS_GROUP_ENTRY("sect163r2", "sect163r2", "EC", 2),
 111 #  endif
 112 #  ifndef FIPS_MODULE
 113     TLS_GROUP_ENTRY("sect193r1", "sect193r1", "EC", 3),
 114     TLS_GROUP_ENTRY("sect193r2", "sect193r2", "EC", 4),
 115 #  endif
 116 #  ifndef OPENSSL_NO_EC2M
 117     TLS_GROUP_ENTRY("sect233k1", "sect233k1", "EC", 5),
 118     TLS_GROUP_ENTRY("sect233r1", "sect233r1", "EC", 6),
 119 #  endif
 120 #  ifndef FIPS_MODULE
 121     TLS_GROUP_ENTRY("sect239k1", "sect239k1", "EC", 7),
 122 #  endif
 123 #  ifndef OPENSSL_NO_EC2M
 124     TLS_GROUP_ENTRY("sect283k1", "sect283k1", "EC", 8),
 125     TLS_GROUP_ENTRY("sect283r1", "sect283r1", "EC", 9),
 126     TLS_GROUP_ENTRY("sect409k1", "sect409k1", "EC", 10),
 127     TLS_GROUP_ENTRY("sect409r1", "sect409r1", "EC", 11),
 128     TLS_GROUP_ENTRY("sect571k1", "sect571k1", "EC", 12),
 129     TLS_GROUP_ENTRY("sect571r1", "sect571r1", "EC", 13),
 130 #  endif
 131 #  ifndef FIPS_MODULE
 132     TLS_GROUP_ENTRY("secp160k1", "secp160k1", "EC", 14),
 133     TLS_GROUP_ENTRY("secp160r1", "secp160r1", "EC", 15),
 134     TLS_GROUP_ENTRY("secp160r2", "secp160r2", "EC", 16),
 135     TLS_GROUP_ENTRY("secp192k1", "secp192k1", "EC", 17),
 136 #  endif
 137     TLS_GROUP_ENTRY("secp192r1", "prime192v1", "EC", 18),
 138 #  ifndef FIPS_MODULE
 139     TLS_GROUP_ENTRY("secp224k1", "secp224k1", "EC", 19),
 140 #  endif
 141     TLS_GROUP_ENTRY("secp224r1", "secp224r1", "EC", 20),
 142 #  ifndef FIPS_MODULE
 143     TLS_GROUP_ENTRY("secp256k1", "secp256k1", "EC", 21),
 144 #  endif
 145     TLS_GROUP_ENTRY("secp256r1", "prime256v1", "EC", 22),
 146     TLS_GROUP_ENTRY("secp384r1", "secp384r1", "EC", 23),
 147     TLS_GROUP_ENTRY("secp521r1", "secp521r1", "EC", 24),
 148 #  ifndef FIPS_MODULE
 149     TLS_GROUP_ENTRY("brainpoolP256r1", "brainpoolP256r1", "EC", 25),
 150     TLS_GROUP_ENTRY("brainpoolP384r1", "brainpoolP384r1", "EC", 26),
 151     TLS_GROUP_ENTRY("brainpoolP512r1", "brainpoolP512r1", "EC", 27),
 152 #  endif
 153     TLS_GROUP_ENTRY("x25519", "x25519", "X25519", 28),
 154     TLS_GROUP_ENTRY("x448", "x448", "X448", 29),
 155 # endif /* OPENSSL_NO_EC */
 156 # ifndef OPENSSL_NO_DH
 157     /* Security bit values for FFDHE groups are as per RFC 7919 */
 158     TLS_GROUP_ENTRY("ffdhe2048", "ffdhe2048", "DH", 30),
 159     TLS_GROUP_ENTRY("ffdhe3072", "ffdhe3072", "DH", 31),
 160     TLS_GROUP_ENTRY("ffdhe4096", "ffdhe4096", "DH", 32),
 161     TLS_GROUP_ENTRY("ffdhe6144", "ffdhe6144", "DH", 33),
 162     TLS_GROUP_ENTRY("ffdhe8192", "ffdhe8192", "DH", 34),
 163 # endif
 164 };
 165 #endif /* !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH) */
 166
 167 static int tls_group_capability(OSSL_CALLBACK *cb, void *arg)
 168 {
 169 #if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
 170     size_t i;
 171
 172 # if !defined(OPENSSL_NO_EC) \
 173     && !defined(OPENSSL_NO_EC2M) \
 174     && !defined(OPENSSL_NO_DH) \
 175     && !defined(FIPS_MODULE)
 176     assert(OSSL_NELEM(param_group_list) == OSSL_NELEM(group_list));
 177 # endif
 178
 179     for (i = 0; i < OSSL_NELEM(param_group_list); i++)
 180         if (!cb(param_group_list[i], arg))
 181             return 0;
 182 #endif
 183
 184     return 1;
 185 }
 186
 187 int provider_get_capabilities(void *provctx, const char *capability,
 188                               OSSL_CALLBACK *cb, void *arg)
 189 {
 190     if (strcasecmp(capability, "TLS-GROUP") == 0)
 191         return tls_group_capability(cb, arg);
 192
 193     /* We don't support this capability */
 194     return 0;
 195 }