Path: blob/main/crypto/openssl/providers/common/capabilities.c
48261 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) || \27!defined(OPENSSL_NO_ML_KEM)28typedef struct tls_group_constants_st {29unsigned int group_id; /* Group ID */30unsigned int secbits; /* Bits of security */31int mintls; /* Minimum TLS version, -1 unsupported */32int maxtls; /* Maximum TLS version (or 0 for undefined) */33int mindtls; /* Minimum DTLS version, -1 unsupported */34int maxdtls; /* Maximum DTLS version (or 0 for undefined) */35int is_kem; /* Indicates utility as KEM */36} TLS_GROUP_CONSTANTS;3738/*39* The indices of entries in this table must be independent of which TLS groups40* we do or not support. It just lists basic facts about the groups, and is41* used by (numeric slot number) reference in the "param_group_list" below.42* Therefore, there must be no #ifdefs in this table, the index of each entry43* must be independent of compile-time options.44*45* For the FFDHE groups, the security bit values are as given by46* BN_security_bits(). For the ML-KEM hybrids these are the ML-KEM security47* bits.48*/49static const TLS_GROUP_CONSTANTS group_list[] = {50/* 0 */ { OSSL_TLS_GROUP_ID_sect163k1, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },51/* 1 */ { OSSL_TLS_GROUP_ID_sect163r1, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },52/* 2 */ { OSSL_TLS_GROUP_ID_sect163r2, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },53/* 3 */ { OSSL_TLS_GROUP_ID_sect193r1, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },54/* 4 */ { OSSL_TLS_GROUP_ID_sect193r2, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },55/* 5 */ { OSSL_TLS_GROUP_ID_sect233k1, 112, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },56/* 6 */ { OSSL_TLS_GROUP_ID_sect233r1, 112, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },57/* 7 */ { OSSL_TLS_GROUP_ID_sect239k1, 112, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },58/* 8 */ { OSSL_TLS_GROUP_ID_sect283k1, 128, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },59/* 9 */ { OSSL_TLS_GROUP_ID_sect283r1, 128, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },60/* 10 */ { OSSL_TLS_GROUP_ID_sect409k1, 192, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },61/* 11 */ { OSSL_TLS_GROUP_ID_sect409r1, 192, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },62/* 12 */ { OSSL_TLS_GROUP_ID_sect571k1, 256, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },63/* 13 */ { OSSL_TLS_GROUP_ID_sect571r1, 256, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },64/* 14 */ { OSSL_TLS_GROUP_ID_secp160k1, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },65/* 15 */ { OSSL_TLS_GROUP_ID_secp160r1, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },66/* 16 */ { OSSL_TLS_GROUP_ID_secp160r2, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },67/* 17 */ { OSSL_TLS_GROUP_ID_secp192k1, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },68/* 18 */ { OSSL_TLS_GROUP_ID_secp192r1, 80, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },69/* 19 */ { OSSL_TLS_GROUP_ID_secp224k1, 112, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },70/* 20 */ { OSSL_TLS_GROUP_ID_secp224r1, 112, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },71/* 21 */ { OSSL_TLS_GROUP_ID_secp256k1, 128, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },72/* 22 */ { OSSL_TLS_GROUP_ID_secp256r1, 128, TLS1_VERSION, 0, DTLS1_VERSION, 0, 0 },73/* 23 */ { OSSL_TLS_GROUP_ID_secp384r1, 192, TLS1_VERSION, 0, DTLS1_VERSION, 0, 0 },74/* 24 */ { OSSL_TLS_GROUP_ID_secp521r1, 256, TLS1_VERSION, 0, DTLS1_VERSION, 0, 0 },75/* 25 */ { OSSL_TLS_GROUP_ID_brainpoolP256r1, 128, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },76/* 26 */ { OSSL_TLS_GROUP_ID_brainpoolP384r1, 192, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },77/* 27 */ { OSSL_TLS_GROUP_ID_brainpoolP512r1, 256, TLS1_VERSION, TLS1_2_VERSION, DTLS1_VERSION, DTLS1_2_VERSION, 0 },78/* 28 */ { OSSL_TLS_GROUP_ID_x25519, 128, TLS1_VERSION, 0, DTLS1_VERSION, 0, 0 },79/* 29 */ { OSSL_TLS_GROUP_ID_x448, 224, TLS1_VERSION, 0, DTLS1_VERSION, 0, 0 },80/* 30 */ { OSSL_TLS_GROUP_ID_brainpoolP256r1_tls13, 128, TLS1_3_VERSION, 0, -1, -1, 0 },81/* 31 */ { OSSL_TLS_GROUP_ID_brainpoolP384r1_tls13, 192, TLS1_3_VERSION, 0, -1, -1, 0 },82/* 32 */ { OSSL_TLS_GROUP_ID_brainpoolP512r1_tls13, 256, TLS1_3_VERSION, 0, -1, -1, 0 },83/* 33 */ { OSSL_TLS_GROUP_ID_ffdhe2048, 112, TLS1_3_VERSION, 0, -1, -1, 0 },84/* 34 */ { OSSL_TLS_GROUP_ID_ffdhe3072, 128, TLS1_3_VERSION, 0, -1, -1, 0 },85/* 35 */ { OSSL_TLS_GROUP_ID_ffdhe4096, 128, TLS1_3_VERSION, 0, -1, -1, 0 },86/* 36 */ { OSSL_TLS_GROUP_ID_ffdhe6144, 128, TLS1_3_VERSION, 0, -1, -1, 0 },87/* 37 */ { OSSL_TLS_GROUP_ID_ffdhe8192, 192, TLS1_3_VERSION, 0, -1, -1, 0 },88/* 38 */ { OSSL_TLS_GROUP_ID_mlkem512, ML_KEM_512_SECBITS, TLS1_3_VERSION, 0, -1, -1, 1 },89/* 39 */ { OSSL_TLS_GROUP_ID_mlkem768, ML_KEM_768_SECBITS, TLS1_3_VERSION, 0, -1, -1, 1 },90/* 40 */ { OSSL_TLS_GROUP_ID_mlkem1024, ML_KEM_1024_SECBITS, TLS1_3_VERSION, 0, -1, -1, 1 },91/* 41 */ { OSSL_TLS_GROUP_ID_X25519MLKEM768, ML_KEM_768_SECBITS, TLS1_3_VERSION, 0, -1, -1, 1 },92/* 42 */ { OSSL_TLS_GROUP_ID_SecP256r1MLKEM768, ML_KEM_768_SECBITS, TLS1_3_VERSION, 0, -1, -1, 1 },93/* 43 */ { OSSL_TLS_GROUP_ID_SecP384r1MLKEM1024, ML_KEM_1024_SECBITS, TLS1_3_VERSION, 0, -1, -1, 1 },94};9596#define TLS_GROUP_ENTRY(tlsname, realname, algorithm, idx) \97{ \98OSSL_PARAM_utf8_string(OSSL_CAPABILITY_TLS_GROUP_NAME, \99tlsname, \100sizeof(tlsname)), \101OSSL_PARAM_utf8_string(OSSL_CAPABILITY_TLS_GROUP_NAME_INTERNAL, \102realname, \103sizeof(realname)), \104OSSL_PARAM_utf8_string(OSSL_CAPABILITY_TLS_GROUP_ALG, \105algorithm, \106sizeof(algorithm)), \107OSSL_PARAM_uint(OSSL_CAPABILITY_TLS_GROUP_ID, \108(unsigned int *)&group_list[idx].group_id), \109OSSL_PARAM_uint(OSSL_CAPABILITY_TLS_GROUP_SECURITY_BITS, \110(unsigned int *)&group_list[idx].secbits), \111OSSL_PARAM_int(OSSL_CAPABILITY_TLS_GROUP_MIN_TLS, \112(unsigned int *)&group_list[idx].mintls), \113OSSL_PARAM_int(OSSL_CAPABILITY_TLS_GROUP_MAX_TLS, \114(unsigned int *)&group_list[idx].maxtls), \115OSSL_PARAM_int(OSSL_CAPABILITY_TLS_GROUP_MIN_DTLS, \116(unsigned int *)&group_list[idx].mindtls), \117OSSL_PARAM_int(OSSL_CAPABILITY_TLS_GROUP_MAX_DTLS, \118(unsigned int *)&group_list[idx].maxdtls), \119OSSL_PARAM_int(OSSL_CAPABILITY_TLS_GROUP_IS_KEM, \120(unsigned int *)&group_list[idx].is_kem), \121OSSL_PARAM_END \122}123124/*-125* - The 4th field of each entry is an index into "group_list" above.126*127* - The 3rd field is the key management algorithm name.128129* - The 2nd field is the GROUP_NAME used with the provider, needed for130* providers that implement a family of related algorithms, but required131* non-null even when the provider implements just one.132*133* - The 1st field is the TLS group name used in SSL_CTX_set_group_list(),134* aliases repeat everything but the first field.135*136* Curves 1..22 were deprecated in:137*138* https://www.rfc-editor.org/rfc/rfc8422.html139*140* leaving just:141*142* enum {143* deprecated(1..22),144* secp256r1 (23), secp384r1 (24), secp521r1 (25),145* x25519(29), x448(30),146* reserved (0xFE00..0xFEFF),147* deprecated(0xFF01..0xFF02),148* (0xFFFF)149* } NamedCurve;150*151* and those added later (FFDHE, brainpool, ML-KEM)152*/153static const OSSL_PARAM param_group_list[][11] = {154# ifndef OPENSSL_NO_EC155# if !defined(OPENSSL_NO_ML_KEM)156# if !defined(OPENSSL_NO_ECX)157TLS_GROUP_ENTRY("X25519MLKEM768", "", "X25519MLKEM768", 41),158# endif159# endif160# ifndef FIPS_MODULE161TLS_GROUP_ENTRY("x25519", "X25519", "X25519", 28),162TLS_GROUP_ENTRY("x448", "X448", "X448", 29),163# endif164TLS_GROUP_ENTRY("secp256r1", "prime256v1", "EC", 22),165TLS_GROUP_ENTRY("P-256", "prime256v1", "EC", 22), /* Alias of above */166TLS_GROUP_ENTRY("secp384r1", "secp384r1", "EC", 23),167TLS_GROUP_ENTRY("P-384", "secp384r1", "EC", 23), /* Alias of above */168TLS_GROUP_ENTRY("secp521r1", "secp521r1", "EC", 24),169TLS_GROUP_ENTRY("P-521", "secp521r1", "EC", 24), /* Alias of above */170# endif /* OPENSSL_NO_EC */171# ifndef OPENSSL_NO_DH172/* Security bit values for FFDHE groups are as per RFC 7919 */173TLS_GROUP_ENTRY("ffdhe2048", "ffdhe2048", "DH", 33),174TLS_GROUP_ENTRY("ffdhe3072", "ffdhe3072", "DH", 34),175# endif176# if !defined(OPENSSL_NO_ML_KEM)177/* https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-8 */178TLS_GROUP_ENTRY("MLKEM512", "", "ML-KEM-512", 38),179TLS_GROUP_ENTRY("MLKEM768", "", "ML-KEM-768", 39),180TLS_GROUP_ENTRY("MLKEM1024", "", "ML-KEM-1024", 40),181# endif182# ifndef OPENSSL_NO_EC183# ifndef FIPS_MODULE184TLS_GROUP_ENTRY("brainpoolP256r1", "brainpoolP256r1", "EC", 25),185TLS_GROUP_ENTRY("brainpoolP384r1", "brainpoolP384r1", "EC", 26),186TLS_GROUP_ENTRY("brainpoolP512r1", "brainpoolP512r1", "EC", 27),187TLS_GROUP_ENTRY("brainpoolP256r1tls13", "brainpoolP256r1", "EC", 30),188TLS_GROUP_ENTRY("brainpoolP384r1tls13", "brainpoolP384r1", "EC", 31),189TLS_GROUP_ENTRY("brainpoolP512r1tls13", "brainpoolP512r1", "EC", 32),190# endif191# ifndef OPENSSL_NO_ML_KEM192TLS_GROUP_ENTRY("SecP256r1MLKEM768", "", "SecP256r1MLKEM768", 42),193TLS_GROUP_ENTRY("SecP384r1MLKEM1024", "", "SecP384r1MLKEM1024", 43),194# endif195# endif196# ifndef OPENSSL_NO_DH197TLS_GROUP_ENTRY("ffdhe4096", "ffdhe4096", "DH", 35),198TLS_GROUP_ENTRY("ffdhe6144", "ffdhe6144", "DH", 36),199TLS_GROUP_ENTRY("ffdhe8192", "ffdhe8192", "DH", 37),200# endif201# ifndef OPENSSL_NO_TLS_DEPRECATED_EC202# ifndef OPENSSL_NO_EC2M203TLS_GROUP_ENTRY("sect163k1", "sect163k1", "EC", 0),204TLS_GROUP_ENTRY("K-163", "sect163k1", "EC", 0), /* Alias of above */205# endif206# ifndef FIPS_MODULE207TLS_GROUP_ENTRY("sect163r1", "sect163r1", "EC", 1),208# endif209# ifndef OPENSSL_NO_EC2M210TLS_GROUP_ENTRY("sect163r2", "sect163r2", "EC", 2),211TLS_GROUP_ENTRY("B-163", "sect163r2", "EC", 2), /* Alias of above */212# endif213# ifndef FIPS_MODULE214TLS_GROUP_ENTRY("sect193r1", "sect193r1", "EC", 3),215TLS_GROUP_ENTRY("sect193r2", "sect193r2", "EC", 4),216# endif217# ifndef OPENSSL_NO_EC2M218TLS_GROUP_ENTRY("sect233k1", "sect233k1", "EC", 5),219TLS_GROUP_ENTRY("K-233", "sect233k1", "EC", 5), /* Alias of above */220TLS_GROUP_ENTRY("sect233r1", "sect233r1", "EC", 6),221TLS_GROUP_ENTRY("B-233", "sect233r1", "EC", 6), /* Alias of above */222# endif223# ifndef FIPS_MODULE224TLS_GROUP_ENTRY("sect239k1", "sect239k1", "EC", 7),225# endif226# ifndef OPENSSL_NO_EC2M227TLS_GROUP_ENTRY("sect283k1", "sect283k1", "EC", 8),228TLS_GROUP_ENTRY("K-283", "sect283k1", "EC", 8), /* Alias of above */229TLS_GROUP_ENTRY("sect283r1", "sect283r1", "EC", 9),230TLS_GROUP_ENTRY("B-283", "sect283r1", "EC", 9), /* Alias of above */231TLS_GROUP_ENTRY("sect409k1", "sect409k1", "EC", 10),232TLS_GROUP_ENTRY("K-409", "sect409k1", "EC", 10), /* Alias of above */233TLS_GROUP_ENTRY("sect409r1", "sect409r1", "EC", 11),234TLS_GROUP_ENTRY("B-409", "sect409r1", "EC", 11), /* Alias of above */235TLS_GROUP_ENTRY("sect571k1", "sect571k1", "EC", 12),236TLS_GROUP_ENTRY("K-571", "sect571k1", "EC", 12), /* Alias of above */237TLS_GROUP_ENTRY("sect571r1", "sect571r1", "EC", 13),238TLS_GROUP_ENTRY("B-571", "sect571r1", "EC", 13), /* Alias of above */239# endif240# ifndef FIPS_MODULE241TLS_GROUP_ENTRY("secp160k1", "secp160k1", "EC", 14),242TLS_GROUP_ENTRY("secp160r1", "secp160r1", "EC", 15),243TLS_GROUP_ENTRY("secp160r2", "secp160r2", "EC", 16),244TLS_GROUP_ENTRY("secp192k1", "secp192k1", "EC", 17),245# endif246TLS_GROUP_ENTRY("secp192r1", "prime192v1", "EC", 18),247TLS_GROUP_ENTRY("P-192", "prime192v1", "EC", 18), /* Alias of above */248# ifndef FIPS_MODULE249TLS_GROUP_ENTRY("secp224k1", "secp224k1", "EC", 19),250# endif251TLS_GROUP_ENTRY("secp224r1", "secp224r1", "EC", 20),252TLS_GROUP_ENTRY("P-224", "secp224r1", "EC", 20), /* Alias of above */253# ifndef FIPS_MODULE254TLS_GROUP_ENTRY("secp256k1", "secp256k1", "EC", 21),255# endif256# endif /* !defined(OPENSSL_NO_TLS_DEPRECATED_EC) */257};258#endif /* !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH) || !defined(OPENSSL_NO_ML_KEM) */259260static int tls_group_capability(OSSL_CALLBACK *cb, void *arg)261{262#if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH) || !defined(OPENSSL_NO_ML_KEM)263size_t i;264265for (i = 0; i < OSSL_NELEM(param_group_list); i++)266if (!cb(param_group_list[i], arg))267return 0;268#endif269270return 1;271}272273/* --------------------------------------------------------------- */274275#if !defined(OPENSSL_NO_ML_DSA)276277typedef struct tls_sigalg_constants_st {278unsigned int code_point;279unsigned int sec_bits; /* Bits of security */280int min_tls; /* Minimum TLS version, -1 unsupported */281int max_tls; /* Maximum TLS version (or 0 for undefined) */282int min_dtls; /* Minimum DTLS version, -1 unsupported */283int max_dtls; /* Maximum DTLS version (or 0 for undefined) */284} TLS_SIGALG_CONSTANTS;285286static const TLS_SIGALG_CONSTANTS sigalg_constants_list[3] = {287{ 0x0904, 128, TLS1_3_VERSION, 0, -1, -1 },288{ 0x0905, 192, TLS1_3_VERSION, 0, -1, -1 },289{ 0x0906, 256, TLS1_3_VERSION, 0, -1, -1 },290};291292# define TLS_SIGALG_ENTRY(tlsname, algorithm, oid, idx) \293{ \294OSSL_PARAM_utf8_string(OSSL_CAPABILITY_TLS_SIGALG_IANA_NAME, \295tlsname, sizeof(tlsname)), \296OSSL_PARAM_utf8_string(OSSL_CAPABILITY_TLS_SIGALG_NAME, \297algorithm, sizeof(algorithm)), \298OSSL_PARAM_utf8_string(OSSL_CAPABILITY_TLS_SIGALG_OID, \299oid, sizeof(oid)), \300OSSL_PARAM_uint(OSSL_CAPABILITY_TLS_SIGALG_CODE_POINT, \301(unsigned int *)&sigalg_constants_list[idx].code_point),\302OSSL_PARAM_uint(OSSL_CAPABILITY_TLS_SIGALG_SECURITY_BITS, \303(unsigned int *)&sigalg_constants_list[idx].sec_bits), \304OSSL_PARAM_int(OSSL_CAPABILITY_TLS_SIGALG_MIN_TLS, \305(unsigned int *)&sigalg_constants_list[idx].min_tls), \306OSSL_PARAM_int(OSSL_CAPABILITY_TLS_SIGALG_MAX_TLS, \307(unsigned int *)&sigalg_constants_list[idx].max_tls), \308OSSL_PARAM_int(OSSL_CAPABILITY_TLS_SIGALG_MIN_DTLS, \309(unsigned int *)&sigalg_constants_list[idx].min_dtls), \310OSSL_PARAM_int(OSSL_CAPABILITY_TLS_SIGALG_MAX_DTLS, \311(unsigned int *)&sigalg_constants_list[idx].max_dtls), \312OSSL_PARAM_END \313}314315static const OSSL_PARAM param_sigalg_list[][10] = {316TLS_SIGALG_ENTRY("mldsa44", "ML-DSA-44", "2.16.840.1.101.3.4.3.17", 0),317TLS_SIGALG_ENTRY("mldsa65", "ML-DSA-65", "2.16.840.1.101.3.4.3.18", 1),318TLS_SIGALG_ENTRY("mldsa87", "ML-DSA-87", "2.16.840.1.101.3.4.3.19", 2),319};320#endif /* OPENSSL_NO_ML_DSA */321322static int tls_sigalg_capability(OSSL_CALLBACK *cb, void *arg)323{324#if !defined(OPENSSL_NO_ML_DSA)325size_t i;326327for (i = 0; i < OSSL_NELEM(param_sigalg_list); i++)328if (!cb(param_sigalg_list[i], arg))329return 0;330#endif331return 1;332}333334int ossl_prov_get_capabilities(void *provctx, const char *capability,335OSSL_CALLBACK *cb, void *arg)336{337if (OPENSSL_strcasecmp(capability, "TLS-GROUP") == 0)338return tls_group_capability(cb, arg);339if (OPENSSL_strcasecmp(capability, "TLS-SIGALG") == 0)340return tls_sigalg_capability(cb, arg);341342/* We don't support this capability */343return 0;344}345346347