Path: blob/main/crypto/openssl/providers/common/capabilities.c
105418 views
/*1* Copyright 2019-2025 The OpenSSL Project Authors. All Rights Reserved.2*3* Licensed under the Apache License 2.0 (the "License"). You may not use4* this file except in compliance with the License. You can obtain a copy5* in the file LICENSE in the source distribution or at6* https://www.openssl.org/source/license.html7*/89#include <assert.h>10#include <string.h>11#include <openssl/core_dispatch.h>12#include <openssl/core_names.h>13/* For TLS1_VERSION etc */14#include <openssl/prov_ssl.h>15#include <openssl/params.h>16#include "internal/nelem.h"17#include "internal/tlsgroups.h"18#include "prov/providercommon.h"19#include "internal/e_os.h"20#include "crypto/ml_kem.h"2122/*23* If none of EC, DH OR ML-KEM are available then we have no TLS-GROUP24* capabilities.25*/26#if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH) || !defined(OPENSSL_NO_ML_KEM)27typedef struct tls_group_constants_st {28unsigned int group_id; /* Group ID */29unsigned int secbits; /* Bits of security */30int mintls; /* Minimum TLS version, -1 unsupported */31int maxtls; /* Maximum TLS version (or 0 for undefined) */32int mindtls; /* Minimum DTLS version, -1 unsupported */33int maxdtls; /* Maximum DTLS version (or 0 for undefined) */34int is_kem; /* Indicates utility as KEM */35} TLS_GROUP_CONSTANTS;3637/*38* The indices of entries in this table must be independent of which TLS groups39* we do or not support. It just lists basic facts about the groups, and is40* used by (numeric slot number) reference in the "param_group_list" below.41* Therefore, there must be no #ifdefs in this table, the index of each entry42* must be independent of compile-time options.43*44* For the FFDHE groups, the security bit values are as given by45* BN_security_bits(). For the ML-KEM hybrids these are the ML-KEM security46* bits.47*/48static const TLS_GROUP_CONSTANTS group_list[] = {49/* 0 */ { OSSL_TLS_GROUP_ID_sect163k1, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },50/* 1 */ { OSSL_TLS_GROUP_ID_sect163r1, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },51/* 2 */ { OSSL_TLS_GROUP_ID_sect163r2, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },52/* 3 */ { OSSL_TLS_GROUP_ID_sect193r1, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },53/* 4 */ { OSSL_TLS_GROUP_ID_sect193r2, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },54/* 5 */ { OSSL_TLS_GROUP_ID_sect233k1, 112, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },55/* 6 */ { OSSL_TLS_GROUP_ID_sect233r1, 112, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },56/* 7 */ { OSSL_TLS_GROUP_ID_sect239k1, 112, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },57/* 8 */ { OSSL_TLS_GROUP_ID_sect283k1, 128, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },58/* 9 */ { OSSL_TLS_GROUP_ID_sect283r1, 128, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },59/* 10 */ { OSSL_TLS_GROUP_ID_sect409k1, 192, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },60/* 11 */ { OSSL_TLS_GROUP_ID_sect409r1, 192, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },61/* 12 */ { OSSL_TLS_GROUP_ID_sect571k1, 256, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },62/* 13 */ { OSSL_TLS_GROUP_ID_sect571r1, 256, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },63/* 14 */ { OSSL_TLS_GROUP_ID_secp160k1, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },64/* 15 */ { OSSL_TLS_GROUP_ID_secp160r1, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },65/* 16 */ { OSSL_TLS_GROUP_ID_secp160r2, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },66/* 17 */ { OSSL_TLS_GROUP_ID_secp192k1, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },67/* 18 */ { OSSL_TLS_GROUP_ID_secp192r1, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },68/* 19 */ { OSSL_TLS_GROUP_ID_secp224k1, 112, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },69/* 20 */ { OSSL_TLS_GROUP_ID_secp224r1, 112, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },70/* 21 */ { OSSL_TLS_GROUP_ID_secp256k1, 128, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },71/* 22 */ { OSSL_TLS_GROUP_ID_secp256r1, 128, TLS1_VERSION, 0, DTLS1_VERSION, 0, 0 },72/* 23 */ { OSSL_TLS_GROUP_ID_secp384r1, 192, TLS1_VERSION, 0, DTLS1_VERSION, 0, 0 },73/* 24 */ { OSSL_TLS_GROUP_ID_secp521r1, 256, TLS1_VERSION, 0, DTLS1_VERSION, 0, 0 },74/* 25 */ { OSSL_TLS_GROUP_ID_brainpoolP256r1, 128, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },75/* 26 */ { OSSL_TLS_GROUP_ID_brainpoolP384r1, 192, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },76/* 27 */ { OSSL_TLS_GROUP_ID_brainpoolP512r1, 256, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },77/* 28 */ { OSSL_TLS_GROUP_ID_x25519, 128, TLS1_VERSION, 0, DTLS1_VERSION, 0, 0 },78/* 29 */ { OSSL_TLS_GROUP_ID_x448, 224, TLS1_VERSION, 0, DTLS1_VERSION, 0, 0 },79/* 30 */ { OSSL_TLS_GROUP_ID_brainpoolP256r1_tls13, 128, TLS1_3_VERSION, 0, -1, -1, 0 },80/* 31 */ { OSSL_TLS_GROUP_ID_brainpoolP384r1_tls13, 192, TLS1_3_VERSION, 0, -1, -1, 0 },81/* 32 */ { OSSL_TLS_GROUP_ID_brainpoolP512r1_tls13, 256, TLS1_3_VERSION, 0, -1, -1, 0 },82/* 33 */ { OSSL_TLS_GROUP_ID_ffdhe2048, 112, TLS1_3_VERSION, 0, -1, -1, 0 },83/* 34 */ { OSSL_TLS_GROUP_ID_ffdhe3072, 128, TLS1_3_VERSION, 0, -1, -1, 0 },84/* 35 */ { OSSL_TLS_GROUP_ID_ffdhe4096, 128, TLS1_3_VERSION, 0, -1, -1, 0 },85/* 36 */ { OSSL_TLS_GROUP_ID_ffdhe6144, 128, TLS1_3_VERSION, 0, -1, -1, 0 },86/* 37 */ { OSSL_TLS_GROUP_ID_ffdhe8192, 192, TLS1_3_VERSION, 0, -1, -1, 0 },87/* 38 */ { OSSL_TLS_GROUP_ID_mlkem512, ML_KEM_512_SECBITS, TLS1_3_VERSION, 0, -1, -1, 1 },88/* 39 */ { OSSL_TLS_GROUP_ID_mlkem768, ML_KEM_768_SECBITS, TLS1_3_VERSION, 0, -1, -1, 1 },89/* 40 */ { OSSL_TLS_GROUP_ID_mlkem1024, ML_KEM_1024_SECBITS, TLS1_3_VERSION, 0, -1, -1, 1 },90/* 41 */ { OSSL_TLS_GROUP_ID_X25519MLKEM768, ML_KEM_768_SECBITS, TLS1_3_VERSION, 0, -1, -1, 1 },91/* 42 */ { OSSL_TLS_GROUP_ID_SecP256r1MLKEM768, ML_KEM_768_SECBITS, TLS1_3_VERSION, 0, -1, -1, 1 },92/* 43 */ { OSSL_TLS_GROUP_ID_SecP384r1MLKEM1024, ML_KEM_1024_SECBITS, TLS1_3_VERSION, 0, -1, -1, 1 },93};9495#define TLS_GROUP_ENTRY(tlsname, realname, algorithm, idx) \96{ \97OSSL_PARAM_utf8_string(OSSL_CAPABILITY_TLS_GROUP_NAME, \98tlsname, \99sizeof(tlsname)), \100OSSL_PARAM_utf8_string(OSSL_CAPABILITY_TLS_GROUP_NAME_INTERNAL, \101realname, \102sizeof(realname)), \103OSSL_PARAM_utf8_string(OSSL_CAPABILITY_TLS_GROUP_ALG, \104algorithm, \105sizeof(algorithm)), \106OSSL_PARAM_uint(OSSL_CAPABILITY_TLS_GROUP_ID, \107(unsigned int *)&group_list[idx].group_id), \108OSSL_PARAM_uint(OSSL_CAPABILITY_TLS_GROUP_SECURITY_BITS, \109(unsigned int *)&group_list[idx].secbits), \110OSSL_PARAM_int(OSSL_CAPABILITY_TLS_GROUP_MIN_TLS, \111(unsigned int *)&group_list[idx].mintls), \112OSSL_PARAM_int(OSSL_CAPABILITY_TLS_GROUP_MAX_TLS, \113(unsigned int *)&group_list[idx].maxtls), \114OSSL_PARAM_int(OSSL_CAPABILITY_TLS_GROUP_MIN_DTLS, \115(unsigned int *)&group_list[idx].mindtls), \116OSSL_PARAM_int(OSSL_CAPABILITY_TLS_GROUP_MAX_DTLS, \117(unsigned int *)&group_list[idx].maxdtls), \118OSSL_PARAM_int(OSSL_CAPABILITY_TLS_GROUP_IS_KEM, \119(unsigned int *)&group_list[idx].is_kem), \120OSSL_PARAM_END \121}122123/*-124* - The 4th field of each entry is an index into "group_list" above.125*126* - The 3rd field is the key management algorithm name.127128* - The 2nd field is the GROUP_NAME used with the provider, needed for129* providers that implement a family of related algorithms, but required130* non-null even when the provider implements just one.131*132* - The 1st field is the TLS group name used in SSL_CTX_set_group_list(),133* aliases repeat everything but the first field.134*135* Curves 1..22 were deprecated in:136*137* https://www.rfc-editor.org/rfc/rfc8422.html138*139* leaving just:140*141* enum {142* deprecated(1..22),143* secp256r1 (23), secp384r1 (24), secp521r1 (25),144* x25519(29), x448(30),145* reserved (0xFE00..0xFEFF),146* deprecated(0xFF01..0xFF02),147* (0xFFFF)148* } NamedCurve;149*150* and those added later (FFDHE, brainpool, ML-KEM)151*/152static const OSSL_PARAM param_group_list[][11] = {153#ifndef OPENSSL_NO_EC154#if !defined(OPENSSL_NO_ML_KEM)155#if !defined(OPENSSL_NO_ECX)156TLS_GROUP_ENTRY("X25519MLKEM768", "", "X25519MLKEM768", 41),157#endif158#endif159#ifndef FIPS_MODULE160TLS_GROUP_ENTRY("x25519", "X25519", "X25519", 28),161TLS_GROUP_ENTRY("x448", "X448", "X448", 29),162#endif163TLS_GROUP_ENTRY("secp256r1", "prime256v1", "EC", 22),164TLS_GROUP_ENTRY("P-256", "prime256v1", "EC", 22), /* Alias of above */165TLS_GROUP_ENTRY("secp384r1", "secp384r1", "EC", 23),166TLS_GROUP_ENTRY("P-384", "secp384r1", "EC", 23), /* Alias of above */167TLS_GROUP_ENTRY("secp521r1", "secp521r1", "EC", 24),168TLS_GROUP_ENTRY("P-521", "secp521r1", "EC", 24), /* Alias of above */169#endif /* OPENSSL_NO_EC */170#ifndef OPENSSL_NO_DH171/* Security bit values for FFDHE groups are as per RFC 7919 */172TLS_GROUP_ENTRY("ffdhe2048", "ffdhe2048", "DH", 33),173TLS_GROUP_ENTRY("ffdhe3072", "ffdhe3072", "DH", 34),174#endif175#if !defined(OPENSSL_NO_ML_KEM)176/* https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-8 */177TLS_GROUP_ENTRY("MLKEM512", "", "ML-KEM-512", 38),178TLS_GROUP_ENTRY("MLKEM768", "", "ML-KEM-768", 39),179TLS_GROUP_ENTRY("MLKEM1024", "", "ML-KEM-1024", 40),180#endif181#ifndef OPENSSL_NO_EC182#ifndef FIPS_MODULE183TLS_GROUP_ENTRY("brainpoolP256r1", "brainpoolP256r1", "EC", 25),184TLS_GROUP_ENTRY("brainpoolP384r1", "brainpoolP384r1", "EC", 26),185TLS_GROUP_ENTRY("brainpoolP512r1", "brainpoolP512r1", "EC", 27),186TLS_GROUP_ENTRY("brainpoolP256r1tls13", "brainpoolP256r1", "EC", 30),187TLS_GROUP_ENTRY("brainpoolP384r1tls13", "brainpoolP384r1", "EC", 31),188TLS_GROUP_ENTRY("brainpoolP512r1tls13", "brainpoolP512r1", "EC", 32),189#endif190#ifndef OPENSSL_NO_ML_KEM191TLS_GROUP_ENTRY("SecP256r1MLKEM768", "", "SecP256r1MLKEM768", 42),192TLS_GROUP_ENTRY("SecP384r1MLKEM1024", "", "SecP384r1MLKEM1024", 43),193#endif194#endif195#ifndef OPENSSL_NO_DH196TLS_GROUP_ENTRY("ffdhe4096", "ffdhe4096", "DH", 35),197TLS_GROUP_ENTRY("ffdhe6144", "ffdhe6144", "DH", 36),198TLS_GROUP_ENTRY("ffdhe8192", "ffdhe8192", "DH", 37),199#endif200#ifndef OPENSSL_NO_TLS_DEPRECATED_EC201#ifndef OPENSSL_NO_EC2M202TLS_GROUP_ENTRY("sect163k1", "sect163k1", "EC", 0),203TLS_GROUP_ENTRY("K-163", "sect163k1", "EC", 0), /* Alias of above */204#endif205#ifndef FIPS_MODULE206TLS_GROUP_ENTRY("sect163r1", "sect163r1", "EC", 1),207#endif208#ifndef OPENSSL_NO_EC2M209TLS_GROUP_ENTRY("sect163r2", "sect163r2", "EC", 2),210TLS_GROUP_ENTRY("B-163", "sect163r2", "EC", 2), /* Alias of above */211#endif212#ifndef FIPS_MODULE213TLS_GROUP_ENTRY("sect193r1", "sect193r1", "EC", 3),214TLS_GROUP_ENTRY("sect193r2", "sect193r2", "EC", 4),215#endif216#ifndef OPENSSL_NO_EC2M217TLS_GROUP_ENTRY("sect233k1", "sect233k1", "EC", 5),218TLS_GROUP_ENTRY("K-233", "sect233k1", "EC", 5), /* Alias of above */219TLS_GROUP_ENTRY("sect233r1", "sect233r1", "EC", 6),220TLS_GROUP_ENTRY("B-233", "sect233r1", "EC", 6), /* Alias of above */221#endif222#ifndef FIPS_MODULE223TLS_GROUP_ENTRY("sect239k1", "sect239k1", "EC", 7),224#endif225#ifndef OPENSSL_NO_EC2M226TLS_GROUP_ENTRY("sect283k1", "sect283k1", "EC", 8),227TLS_GROUP_ENTRY("K-283", "sect283k1", "EC", 8), /* Alias of above */228TLS_GROUP_ENTRY("sect283r1", "sect283r1", "EC", 9),229TLS_GROUP_ENTRY("B-283", "sect283r1", "EC", 9), /* Alias of above */230TLS_GROUP_ENTRY("sect409k1", "sect409k1", "EC", 10),231TLS_GROUP_ENTRY("K-409", "sect409k1", "EC", 10), /* Alias of above */232TLS_GROUP_ENTRY("sect409r1", "sect409r1", "EC", 11),233TLS_GROUP_ENTRY("B-409", "sect409r1", "EC", 11), /* Alias of above */234TLS_GROUP_ENTRY("sect571k1", "sect571k1", "EC", 12),235TLS_GROUP_ENTRY("K-571", "sect571k1", "EC", 12), /* Alias of above */236TLS_GROUP_ENTRY("sect571r1", "sect571r1", "EC", 13),237TLS_GROUP_ENTRY("B-571", "sect571r1", "EC", 13), /* Alias of above */238#endif239#ifndef FIPS_MODULE240TLS_GROUP_ENTRY("secp160k1", "secp160k1", "EC", 14),241TLS_GROUP_ENTRY("secp160r1", "secp160r1", "EC", 15),242TLS_GROUP_ENTRY("secp160r2", "secp160r2", "EC", 16),243TLS_GROUP_ENTRY("secp192k1", "secp192k1", "EC", 17),244#endif245TLS_GROUP_ENTRY("secp192r1", "prime192v1", "EC", 18),246TLS_GROUP_ENTRY("P-192", "prime192v1", "EC", 18), /* Alias of above */247#ifndef FIPS_MODULE248TLS_GROUP_ENTRY("secp224k1", "secp224k1", "EC", 19),249#endif250TLS_GROUP_ENTRY("secp224r1", "secp224r1", "EC", 20),251TLS_GROUP_ENTRY("P-224", "secp224r1", "EC", 20), /* Alias of above */252#ifndef FIPS_MODULE253TLS_GROUP_ENTRY("secp256k1", "secp256k1", "EC", 21),254#endif255#endif /* !defined(OPENSSL_NO_TLS_DEPRECATED_EC) */256};257#endif /* !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH) || !defined(OPENSSL_NO_ML_KEM) */258259static int tls_group_capability(OSSL_CALLBACK *cb, void *arg)260{261#if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH) || !defined(OPENSSL_NO_ML_KEM)262size_t i;263264for (i = 0; i < OSSL_NELEM(param_group_list); i++)265if (!cb(param_group_list[i], arg))266return 0;267#endif268269return 1;270}271272/* --------------------------------------------------------------- */273274#if !defined(OPENSSL_NO_ML_DSA)275276typedef struct tls_sigalg_constants_st {277unsigned int code_point;278unsigned int sec_bits; /* Bits of security */279int min_tls; /* Minimum TLS version, -1 unsupported */280int max_tls; /* Maximum TLS version (or 0 for undefined) */281int min_dtls; /* Minimum DTLS version, -1 unsupported */282int max_dtls; /* Maximum DTLS version (or 0 for undefined) */283} TLS_SIGALG_CONSTANTS;284285static const TLS_SIGALG_CONSTANTS sigalg_constants_list[3] = {286{ 0x0904, 128, TLS1_3_VERSION, 0, -1, -1 },287{ 0x0905, 192, TLS1_3_VERSION, 0, -1, -1 },288{ 0x0906, 256, TLS1_3_VERSION, 0, -1, -1 },289};290291#define TLS_SIGALG_ENTRY(tlsname, algorithm, oid, idx) \292{ \293OSSL_PARAM_utf8_string(OSSL_CAPABILITY_TLS_SIGALG_IANA_NAME, \294tlsname, sizeof(tlsname)), \295OSSL_PARAM_utf8_string(OSSL_CAPABILITY_TLS_SIGALG_NAME, \296algorithm, sizeof(algorithm)), \297OSSL_PARAM_utf8_string(OSSL_CAPABILITY_TLS_SIGALG_OID, \298oid, sizeof(oid)), \299OSSL_PARAM_uint(OSSL_CAPABILITY_TLS_SIGALG_CODE_POINT, \300(unsigned int *)&sigalg_constants_list[idx].code_point), \301OSSL_PARAM_uint(OSSL_CAPABILITY_TLS_SIGALG_SECURITY_BITS, \302(unsigned int *)&sigalg_constants_list[idx].sec_bits), \303OSSL_PARAM_int(OSSL_CAPABILITY_TLS_SIGALG_MIN_TLS, \304(unsigned int *)&sigalg_constants_list[idx].min_tls), \305OSSL_PARAM_int(OSSL_CAPABILITY_TLS_SIGALG_MAX_TLS, \306(unsigned int *)&sigalg_constants_list[idx].max_tls), \307OSSL_PARAM_int(OSSL_CAPABILITY_TLS_SIGALG_MIN_DTLS, \308(unsigned int *)&sigalg_constants_list[idx].min_dtls), \309OSSL_PARAM_int(OSSL_CAPABILITY_TLS_SIGALG_MAX_DTLS, \310(unsigned int *)&sigalg_constants_list[idx].max_dtls), \311OSSL_PARAM_END \312}313314static const OSSL_PARAM param_sigalg_list[][10] = {315TLS_SIGALG_ENTRY("mldsa44", "ML-DSA-44", "2.16.840.1.101.3.4.3.17", 0),316TLS_SIGALG_ENTRY("mldsa65", "ML-DSA-65", "2.16.840.1.101.3.4.3.18", 1),317TLS_SIGALG_ENTRY("mldsa87", "ML-DSA-87", "2.16.840.1.101.3.4.3.19", 2),318};319#endif /* OPENSSL_NO_ML_DSA */320321static int tls_sigalg_capability(OSSL_CALLBACK *cb, void *arg)322{323#if !defined(OPENSSL_NO_ML_DSA)324size_t i;325326for (i = 0; i < OSSL_NELEM(param_sigalg_list); i++)327if (!cb(param_sigalg_list[i], arg))328return 0;329#endif330return 1;331}332333int ossl_prov_get_capabilities(void *provctx, const char *capability,334OSSL_CALLBACK *cb, void *arg)335{336if (OPENSSL_strcasecmp(capability, "TLS-GROUP") == 0)337return tls_group_capability(cb, arg);338if (OPENSSL_strcasecmp(capability, "TLS-SIGALG") == 0)339return tls_sigalg_capability(cb, arg);340341/* We don't support this capability */342return 0;343}344345346