blob: 6fe6e707f5705b373dfaed578395c8bcaca73841 [file] [log] [blame]
Gilles Peskine47c85792025-05-07 14:35:04 +02001/**
Gilles Peskineb825dcf2025-05-07 19:41:09 +02002 * \file x509_oid.c
Gilles Peskine47c85792025-05-07 14:35:04 +02003 *
4 * \brief Object Identifier (OID) database
5 *
6 * Copyright The Mbed TLS Contributors
7 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
8 */
9
Gilles Peskined2fe51c2025-05-07 20:36:20 +020010#include "x509_internal.h"
Gilles Peskine47c85792025-05-07 14:35:04 +020011
12#if defined(MBEDTLS_OID_C)
13
Gilles Peskine86a47f82025-05-07 20:20:12 +020014#include "x509_oid.h"
Gilles Peskine47c85792025-05-07 14:35:04 +020015#include "mbedtls/rsa.h"
16#include "mbedtls/error_common.h"
17#include "mbedtls/pk.h"
18
19#include <stdio.h>
20#include <string.h>
21
22#include "mbedtls/platform.h"
23
24/*
25 * Macro to automatically add the size of #define'd OIDs
26 */
27#define ADD_LEN(s) s, MBEDTLS_OID_SIZE(s)
28
29/*
Gilles Peskine86e45ba2025-05-07 20:33:39 +020030 * Macro to generate mbedtls_x509_oid_descriptor_t
Gilles Peskine47c85792025-05-07 14:35:04 +020031 */
32#if !defined(MBEDTLS_X509_REMOVE_INFO)
33#define OID_DESCRIPTOR(s, name, description) { ADD_LEN(s), name, description }
34#define NULL_OID_DESCRIPTOR { NULL, 0, NULL, NULL }
35#else
36#define OID_DESCRIPTOR(s, name, description) { ADD_LEN(s) }
37#define NULL_OID_DESCRIPTOR { NULL, 0 }
38#endif
39
40/*
41 * Macro to generate an internal function for oid_XXX_from_asn1() (used by
42 * the other functions)
43 */
44#define FN_OID_TYPED_FROM_ASN1(TYPE_T, NAME, LIST) \
45 static const TYPE_T *oid_ ## NAME ## _from_asn1( \
46 const mbedtls_asn1_buf *oid) \
47 { \
48 const TYPE_T *p = (LIST); \
Gilles Peskine86e45ba2025-05-07 20:33:39 +020049 const mbedtls_x509_oid_descriptor_t *cur = \
50 (const mbedtls_x509_oid_descriptor_t *) p; \
Gilles Peskine47c85792025-05-07 14:35:04 +020051 if (p == NULL || oid == NULL) return NULL; \
52 while (cur->asn1 != NULL) { \
53 if (cur->asn1_len == oid->len && \
54 memcmp(cur->asn1, oid->p, oid->len) == 0) { \
55 return p; \
56 } \
57 p++; \
Gilles Peskine86e45ba2025-05-07 20:33:39 +020058 cur = (const mbedtls_x509_oid_descriptor_t *) p; \
Gilles Peskine47c85792025-05-07 14:35:04 +020059 } \
60 return NULL; \
61 }
62
63#if !defined(MBEDTLS_X509_REMOVE_INFO)
64/*
65 * Macro to generate a function for retrieving a single attribute from the
Gilles Peskine86e45ba2025-05-07 20:33:39 +020066 * descriptor of an mbedtls_x509_oid_descriptor_t wrapper.
Gilles Peskine47c85792025-05-07 14:35:04 +020067 */
68#define FN_OID_GET_DESCRIPTOR_ATTR1(FN_NAME, TYPE_T, TYPE_NAME, ATTR1_TYPE, ATTR1) \
69 int FN_NAME(const mbedtls_asn1_buf *oid, ATTR1_TYPE * ATTR1) \
70 { \
71 const TYPE_T *data = oid_ ## TYPE_NAME ## _from_asn1(oid); \
72 if (data == NULL) return MBEDTLS_ERR_OID_NOT_FOUND; \
73 *ATTR1 = data->descriptor.ATTR1; \
74 return 0; \
75 }
76#endif /* MBEDTLS_X509_REMOVE_INFO */
77
78/*
79 * Macro to generate a function for retrieving a single attribute from an
Gilles Peskine86e45ba2025-05-07 20:33:39 +020080 * mbedtls_x509_oid_descriptor_t wrapper.
Gilles Peskine47c85792025-05-07 14:35:04 +020081 */
82#define FN_OID_GET_ATTR1(FN_NAME, TYPE_T, TYPE_NAME, ATTR1_TYPE, ATTR1) \
83 int FN_NAME(const mbedtls_asn1_buf *oid, ATTR1_TYPE * ATTR1) \
84 { \
85 const TYPE_T *data = oid_ ## TYPE_NAME ## _from_asn1(oid); \
86 if (data == NULL) return MBEDTLS_ERR_OID_NOT_FOUND; \
87 *ATTR1 = data->ATTR1; \
88 return 0; \
89 }
90
91/*
92 * Macro to generate a function for retrieving two attributes from an
Gilles Peskine86e45ba2025-05-07 20:33:39 +020093 * mbedtls_x509_oid_descriptor_t wrapper.
Gilles Peskine47c85792025-05-07 14:35:04 +020094 */
95#define FN_OID_GET_ATTR2(FN_NAME, TYPE_T, TYPE_NAME, ATTR1_TYPE, ATTR1, \
96 ATTR2_TYPE, ATTR2) \
97 int FN_NAME(const mbedtls_asn1_buf *oid, ATTR1_TYPE * ATTR1, \
98 ATTR2_TYPE * ATTR2) \
99 { \
100 const TYPE_T *data = oid_ ## TYPE_NAME ## _from_asn1(oid); \
101 if (data == NULL) return MBEDTLS_ERR_OID_NOT_FOUND; \
102 *(ATTR1) = data->ATTR1; \
103 *(ATTR2) = data->ATTR2; \
104 return 0; \
105 }
106
107/*
108 * Macro to generate a function for retrieving the OID based on a single
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200109 * attribute from a mbedtls_x509_oid_descriptor_t wrapper.
Gilles Peskine47c85792025-05-07 14:35:04 +0200110 */
111#define FN_OID_GET_OID_BY_ATTR1(FN_NAME, TYPE_T, LIST, ATTR1_TYPE, ATTR1) \
112 int FN_NAME(ATTR1_TYPE ATTR1, const char **oid, size_t *olen) \
113 { \
114 const TYPE_T *cur = (LIST); \
115 while (cur->descriptor.asn1 != NULL) { \
116 if (cur->ATTR1 == (ATTR1)) { \
117 *oid = cur->descriptor.asn1; \
118 *olen = cur->descriptor.asn1_len; \
119 return 0; \
120 } \
121 cur++; \
122 } \
123 return MBEDTLS_ERR_OID_NOT_FOUND; \
124 }
125
126/*
127 * Macro to generate a function for retrieving the OID based on two
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200128 * attributes from a mbedtls_x509_oid_descriptor_t wrapper.
Gilles Peskine47c85792025-05-07 14:35:04 +0200129 */
130#define FN_OID_GET_OID_BY_ATTR2(FN_NAME, TYPE_T, LIST, ATTR1_TYPE, ATTR1, \
131 ATTR2_TYPE, ATTR2) \
132 int FN_NAME(ATTR1_TYPE ATTR1, ATTR2_TYPE ATTR2, const char **oid, \
133 size_t *olen) \
134 { \
135 const TYPE_T *cur = (LIST); \
136 while (cur->descriptor.asn1 != NULL) { \
137 if (cur->ATTR1 == (ATTR1) && cur->ATTR2 == (ATTR2)) { \
138 *oid = cur->descriptor.asn1; \
139 *olen = cur->descriptor.asn1_len; \
140 return 0; \
141 } \
142 cur++; \
143 } \
144 return MBEDTLS_ERR_OID_NOT_FOUND; \
145 }
146
147/*
148 * For X520 attribute types
149 */
150typedef struct {
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200151 mbedtls_x509_oid_descriptor_t descriptor;
Gilles Peskine47c85792025-05-07 14:35:04 +0200152 const char *short_name;
153} oid_x520_attr_t;
154
155static const oid_x520_attr_t oid_x520_attr_type[] =
156{
157 {
158 OID_DESCRIPTOR(MBEDTLS_OID_AT_CN, "id-at-commonName", "Common Name"),
159 "CN",
160 },
161 {
162 OID_DESCRIPTOR(MBEDTLS_OID_AT_COUNTRY, "id-at-countryName", "Country"),
163 "C",
164 },
165 {
166 OID_DESCRIPTOR(MBEDTLS_OID_AT_LOCALITY, "id-at-locality", "Locality"),
167 "L",
168 },
169 {
170 OID_DESCRIPTOR(MBEDTLS_OID_AT_STATE, "id-at-state", "State"),
171 "ST",
172 },
173 {
174 OID_DESCRIPTOR(MBEDTLS_OID_AT_ORGANIZATION, "id-at-organizationName",
175 "Organization"),
176 "O",
177 },
178 {
179 OID_DESCRIPTOR(MBEDTLS_OID_AT_ORG_UNIT, "id-at-organizationalUnitName", "Org Unit"),
180 "OU",
181 },
182 {
183 OID_DESCRIPTOR(MBEDTLS_OID_PKCS9_EMAIL,
184 "emailAddress",
185 "E-mail address"),
186 "emailAddress",
187 },
188 {
189 OID_DESCRIPTOR(MBEDTLS_OID_AT_SERIAL_NUMBER,
190 "id-at-serialNumber",
191 "Serial number"),
192 "serialNumber",
193 },
194 {
195 OID_DESCRIPTOR(MBEDTLS_OID_AT_POSTAL_ADDRESS,
196 "id-at-postalAddress",
197 "Postal address"),
198 "postalAddress",
199 },
200 {
201 OID_DESCRIPTOR(MBEDTLS_OID_AT_POSTAL_CODE, "id-at-postalCode", "Postal code"),
202 "postalCode",
203 },
204 {
205 OID_DESCRIPTOR(MBEDTLS_OID_AT_SUR_NAME, "id-at-surName", "Surname"),
206 "SN",
207 },
208 {
209 OID_DESCRIPTOR(MBEDTLS_OID_AT_GIVEN_NAME, "id-at-givenName", "Given name"),
210 "GN",
211 },
212 {
213 OID_DESCRIPTOR(MBEDTLS_OID_AT_INITIALS, "id-at-initials", "Initials"),
214 "initials",
215 },
216 {
217 OID_DESCRIPTOR(MBEDTLS_OID_AT_GENERATION_QUALIFIER,
218 "id-at-generationQualifier",
219 "Generation qualifier"),
220 "generationQualifier",
221 },
222 {
223 OID_DESCRIPTOR(MBEDTLS_OID_AT_TITLE, "id-at-title", "Title"),
224 "title",
225 },
226 {
227 OID_DESCRIPTOR(MBEDTLS_OID_AT_DN_QUALIFIER,
228 "id-at-dnQualifier",
229 "Distinguished Name qualifier"),
230 "dnQualifier",
231 },
232 {
233 OID_DESCRIPTOR(MBEDTLS_OID_AT_PSEUDONYM, "id-at-pseudonym", "Pseudonym"),
234 "pseudonym",
235 },
236 {
237 OID_DESCRIPTOR(MBEDTLS_OID_UID, "id-uid", "User Id"),
238 "uid",
239 },
240 {
241 OID_DESCRIPTOR(MBEDTLS_OID_DOMAIN_COMPONENT,
242 "id-domainComponent",
243 "Domain component"),
244 "DC",
245 },
246 {
247 OID_DESCRIPTOR(MBEDTLS_OID_AT_UNIQUE_IDENTIFIER,
248 "id-at-uniqueIdentifier",
249 "Unique Identifier"),
250 "uniqueIdentifier",
251 },
252 {
253 NULL_OID_DESCRIPTOR,
254 NULL,
255 }
256};
257
258FN_OID_TYPED_FROM_ASN1(oid_x520_attr_t, x520_attr, oid_x520_attr_type)
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200259FN_OID_GET_ATTR1(mbedtls_x509_oid_get_attr_short_name,
Gilles Peskine47c85792025-05-07 14:35:04 +0200260 oid_x520_attr_t,
261 x520_attr,
262 const char *,
263 short_name)
264
265/*
266 * For X509 extensions
267 */
268typedef struct {
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200269 mbedtls_x509_oid_descriptor_t descriptor;
Gilles Peskine47c85792025-05-07 14:35:04 +0200270 int ext_type;
271} oid_x509_ext_t;
272
273static const oid_x509_ext_t oid_x509_ext[] =
274{
275 {
276 OID_DESCRIPTOR(MBEDTLS_OID_BASIC_CONSTRAINTS,
277 "id-ce-basicConstraints",
278 "Basic Constraints"),
279 MBEDTLS_OID_X509_EXT_BASIC_CONSTRAINTS,
280 },
281 {
282 OID_DESCRIPTOR(MBEDTLS_OID_KEY_USAGE, "id-ce-keyUsage", "Key Usage"),
283 MBEDTLS_OID_X509_EXT_KEY_USAGE,
284 },
285 {
286 OID_DESCRIPTOR(MBEDTLS_OID_EXTENDED_KEY_USAGE,
287 "id-ce-extKeyUsage",
288 "Extended Key Usage"),
289 MBEDTLS_OID_X509_EXT_EXTENDED_KEY_USAGE,
290 },
291 {
292 OID_DESCRIPTOR(MBEDTLS_OID_SUBJECT_ALT_NAME,
293 "id-ce-subjectAltName",
294 "Subject Alt Name"),
295 MBEDTLS_OID_X509_EXT_SUBJECT_ALT_NAME,
296 },
297 {
298 OID_DESCRIPTOR(MBEDTLS_OID_NS_CERT_TYPE,
299 "id-netscape-certtype",
300 "Netscape Certificate Type"),
301 MBEDTLS_OID_X509_EXT_NS_CERT_TYPE,
302 },
303 {
304 OID_DESCRIPTOR(MBEDTLS_OID_CERTIFICATE_POLICIES,
305 "id-ce-certificatePolicies",
306 "Certificate Policies"),
307 MBEDTLS_OID_X509_EXT_CERTIFICATE_POLICIES,
308 },
309 {
310 OID_DESCRIPTOR(MBEDTLS_OID_SUBJECT_KEY_IDENTIFIER,
311 "id-ce-subjectKeyIdentifier",
312 "Subject Key Identifier"),
313 MBEDTLS_OID_X509_EXT_SUBJECT_KEY_IDENTIFIER,
314 },
315 {
316 OID_DESCRIPTOR(MBEDTLS_OID_AUTHORITY_KEY_IDENTIFIER,
317 "id-ce-authorityKeyIdentifier",
318 "Authority Key Identifier"),
319 MBEDTLS_OID_X509_EXT_AUTHORITY_KEY_IDENTIFIER,
320 },
321 {
322 NULL_OID_DESCRIPTOR,
323 0,
324 },
325};
326
327FN_OID_TYPED_FROM_ASN1(oid_x509_ext_t, x509_ext, oid_x509_ext)
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200328FN_OID_GET_ATTR1(mbedtls_x509_oid_get_x509_ext_type, oid_x509_ext_t, x509_ext, int, ext_type)
Gilles Peskine47c85792025-05-07 14:35:04 +0200329
330#if !defined(MBEDTLS_X509_REMOVE_INFO)
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200331static const mbedtls_x509_oid_descriptor_t oid_ext_key_usage[] =
Gilles Peskine47c85792025-05-07 14:35:04 +0200332{
333 OID_DESCRIPTOR(MBEDTLS_OID_SERVER_AUTH,
334 "id-kp-serverAuth",
335 "TLS Web Server Authentication"),
336 OID_DESCRIPTOR(MBEDTLS_OID_CLIENT_AUTH,
337 "id-kp-clientAuth",
338 "TLS Web Client Authentication"),
339 OID_DESCRIPTOR(MBEDTLS_OID_CODE_SIGNING, "id-kp-codeSigning", "Code Signing"),
340 OID_DESCRIPTOR(MBEDTLS_OID_EMAIL_PROTECTION, "id-kp-emailProtection", "E-mail Protection"),
341 OID_DESCRIPTOR(MBEDTLS_OID_TIME_STAMPING, "id-kp-timeStamping", "Time Stamping"),
342 OID_DESCRIPTOR(MBEDTLS_OID_OCSP_SIGNING, "id-kp-OCSPSigning", "OCSP Signing"),
343 OID_DESCRIPTOR(MBEDTLS_OID_WISUN_FAN,
344 "id-kp-wisun-fan-device",
345 "Wi-SUN Alliance Field Area Network (FAN)"),
346 NULL_OID_DESCRIPTOR,
347};
348
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200349FN_OID_TYPED_FROM_ASN1(mbedtls_x509_oid_descriptor_t, ext_key_usage, oid_ext_key_usage)
350FN_OID_GET_ATTR1(mbedtls_x509_oid_get_extended_key_usage,
351 mbedtls_x509_oid_descriptor_t,
Gilles Peskine47c85792025-05-07 14:35:04 +0200352 ext_key_usage,
353 const char *,
354 description)
355
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200356static const mbedtls_x509_oid_descriptor_t oid_certificate_policies[] =
Gilles Peskine47c85792025-05-07 14:35:04 +0200357{
358 OID_DESCRIPTOR(MBEDTLS_OID_ANY_POLICY, "anyPolicy", "Any Policy"),
359 NULL_OID_DESCRIPTOR,
360};
361
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200362FN_OID_TYPED_FROM_ASN1(mbedtls_x509_oid_descriptor_t, certificate_policies,
363 oid_certificate_policies)
364FN_OID_GET_ATTR1(mbedtls_x509_oid_get_certificate_policies,
365 mbedtls_x509_oid_descriptor_t,
Gilles Peskine47c85792025-05-07 14:35:04 +0200366 certificate_policies,
367 const char *,
368 description)
369#endif /* MBEDTLS_X509_REMOVE_INFO */
370
371/*
372 * For SignatureAlgorithmIdentifier
373 */
374typedef struct {
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200375 mbedtls_x509_oid_descriptor_t descriptor;
Gilles Peskine47c85792025-05-07 14:35:04 +0200376 mbedtls_md_type_t md_alg;
377 mbedtls_pk_type_t pk_alg;
378} oid_sig_alg_t;
379
380static const oid_sig_alg_t oid_sig_alg[] =
381{
382#if defined(MBEDTLS_RSA_C)
383#if defined(PSA_WANT_ALG_MD5)
384 {
385 OID_DESCRIPTOR(MBEDTLS_OID_PKCS1_MD5, "md5WithRSAEncryption", "RSA with MD5"),
386 MBEDTLS_MD_MD5, MBEDTLS_PK_RSA,
387 },
388#endif /* PSA_WANT_ALG_MD5 */
389#if defined(PSA_WANT_ALG_SHA_1)
390 {
391 OID_DESCRIPTOR(MBEDTLS_OID_PKCS1_SHA1, "sha-1WithRSAEncryption", "RSA with SHA1"),
392 MBEDTLS_MD_SHA1, MBEDTLS_PK_RSA,
393 },
394#endif /* PSA_WANT_ALG_SHA_1 */
395#if defined(PSA_WANT_ALG_SHA_224)
396 {
397 OID_DESCRIPTOR(MBEDTLS_OID_PKCS1_SHA224, "sha224WithRSAEncryption",
398 "RSA with SHA-224"),
399 MBEDTLS_MD_SHA224, MBEDTLS_PK_RSA,
400 },
401#endif /* PSA_WANT_ALG_SHA_224 */
402#if defined(PSA_WANT_ALG_SHA_256)
403 {
404 OID_DESCRIPTOR(MBEDTLS_OID_PKCS1_SHA256, "sha256WithRSAEncryption",
405 "RSA with SHA-256"),
406 MBEDTLS_MD_SHA256, MBEDTLS_PK_RSA,
407 },
408#endif /* PSA_WANT_ALG_SHA_256 */
409#if defined(PSA_WANT_ALG_SHA_384)
410 {
411 OID_DESCRIPTOR(MBEDTLS_OID_PKCS1_SHA384, "sha384WithRSAEncryption",
412 "RSA with SHA-384"),
413 MBEDTLS_MD_SHA384, MBEDTLS_PK_RSA,
414 },
415#endif /* PSA_WANT_ALG_SHA_384 */
416#if defined(PSA_WANT_ALG_SHA_512)
417 {
418 OID_DESCRIPTOR(MBEDTLS_OID_PKCS1_SHA512, "sha512WithRSAEncryption",
419 "RSA with SHA-512"),
420 MBEDTLS_MD_SHA512, MBEDTLS_PK_RSA,
421 },
422#endif /* PSA_WANT_ALG_SHA_512 */
423#if defined(PSA_WANT_ALG_SHA_1)
424 {
425 OID_DESCRIPTOR(MBEDTLS_OID_RSA_SHA_OBS, "sha-1WithRSAEncryption", "RSA with SHA1"),
426 MBEDTLS_MD_SHA1, MBEDTLS_PK_RSA,
427 },
428#endif /* PSA_WANT_ALG_SHA_1 */
429#endif /* MBEDTLS_RSA_C */
430#if defined(PSA_HAVE_ALG_SOME_ECDSA)
431#if defined(PSA_WANT_ALG_SHA_1)
432 {
433 OID_DESCRIPTOR(MBEDTLS_OID_ECDSA_SHA1, "ecdsa-with-SHA1", "ECDSA with SHA1"),
434 MBEDTLS_MD_SHA1, MBEDTLS_PK_ECDSA,
435 },
436#endif /* PSA_WANT_ALG_SHA_1 */
437#if defined(PSA_WANT_ALG_SHA_224)
438 {
439 OID_DESCRIPTOR(MBEDTLS_OID_ECDSA_SHA224, "ecdsa-with-SHA224", "ECDSA with SHA224"),
440 MBEDTLS_MD_SHA224, MBEDTLS_PK_ECDSA,
441 },
442#endif
443#if defined(PSA_WANT_ALG_SHA_256)
444 {
445 OID_DESCRIPTOR(MBEDTLS_OID_ECDSA_SHA256, "ecdsa-with-SHA256", "ECDSA with SHA256"),
446 MBEDTLS_MD_SHA256, MBEDTLS_PK_ECDSA,
447 },
448#endif /* PSA_WANT_ALG_SHA_256 */
449#if defined(PSA_WANT_ALG_SHA_384)
450 {
451 OID_DESCRIPTOR(MBEDTLS_OID_ECDSA_SHA384, "ecdsa-with-SHA384", "ECDSA with SHA384"),
452 MBEDTLS_MD_SHA384, MBEDTLS_PK_ECDSA,
453 },
454#endif /* PSA_WANT_ALG_SHA_384 */
455#if defined(PSA_WANT_ALG_SHA_512)
456 {
457 OID_DESCRIPTOR(MBEDTLS_OID_ECDSA_SHA512, "ecdsa-with-SHA512", "ECDSA with SHA512"),
458 MBEDTLS_MD_SHA512, MBEDTLS_PK_ECDSA,
459 },
460#endif /* PSA_WANT_ALG_SHA_512 */
461#endif /* PSA_HAVE_ALG_SOME_ECDSA */
462#if defined(MBEDTLS_RSA_C)
463 {
464 OID_DESCRIPTOR(MBEDTLS_OID_RSASSA_PSS, "RSASSA-PSS", "RSASSA-PSS"),
465 MBEDTLS_MD_NONE, MBEDTLS_PK_RSASSA_PSS,
466 },
467#endif /* MBEDTLS_RSA_C */
468 {
469 NULL_OID_DESCRIPTOR,
470 MBEDTLS_MD_NONE, MBEDTLS_PK_NONE,
471 },
472};
473
474FN_OID_TYPED_FROM_ASN1(oid_sig_alg_t, sig_alg, oid_sig_alg)
475
476#if !defined(MBEDTLS_X509_REMOVE_INFO)
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200477FN_OID_GET_DESCRIPTOR_ATTR1(mbedtls_x509_oid_get_sig_alg_desc,
Gilles Peskine47c85792025-05-07 14:35:04 +0200478 oid_sig_alg_t,
479 sig_alg,
480 const char *,
481 description)
482#endif
483
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200484FN_OID_GET_ATTR2(mbedtls_x509_oid_get_sig_alg,
Gilles Peskine47c85792025-05-07 14:35:04 +0200485 oid_sig_alg_t,
486 sig_alg,
487 mbedtls_md_type_t,
488 md_alg,
489 mbedtls_pk_type_t,
490 pk_alg)
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200491FN_OID_GET_OID_BY_ATTR2(mbedtls_x509_oid_get_oid_by_sig_alg,
Gilles Peskine47c85792025-05-07 14:35:04 +0200492 oid_sig_alg_t,
493 oid_sig_alg,
494 mbedtls_pk_type_t,
495 pk_alg,
496 mbedtls_md_type_t,
497 md_alg)
498
499/*
500 * For PublicKeyInfo (PKCS1, RFC 5480)
501 */
502typedef struct {
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200503 mbedtls_x509_oid_descriptor_t descriptor;
Gilles Peskine47c85792025-05-07 14:35:04 +0200504 mbedtls_pk_type_t pk_alg;
505} oid_pk_alg_t;
506
507static const oid_pk_alg_t oid_pk_alg[] =
508{
509 {
510 OID_DESCRIPTOR(MBEDTLS_OID_PKCS1_RSA, "rsaEncryption", "RSA"),
511 MBEDTLS_PK_RSA,
512 },
513 {
514 OID_DESCRIPTOR(MBEDTLS_OID_EC_ALG_UNRESTRICTED, "id-ecPublicKey", "Generic EC key"),
515 MBEDTLS_PK_ECKEY,
516 },
517 {
518 OID_DESCRIPTOR(MBEDTLS_OID_EC_ALG_ECDH, "id-ecDH", "EC key for ECDH"),
519 MBEDTLS_PK_ECKEY_DH,
520 },
521 {
522 NULL_OID_DESCRIPTOR,
523 MBEDTLS_PK_NONE,
524 },
525};
526
527FN_OID_TYPED_FROM_ASN1(oid_pk_alg_t, pk_alg, oid_pk_alg)
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200528FN_OID_GET_ATTR1(mbedtls_x509_oid_get_pk_alg, oid_pk_alg_t, pk_alg, mbedtls_pk_type_t, pk_alg)
529FN_OID_GET_OID_BY_ATTR1(mbedtls_x509_oid_get_oid_by_pk_alg,
Gilles Peskine47c85792025-05-07 14:35:04 +0200530 oid_pk_alg_t,
531 oid_pk_alg,
532 mbedtls_pk_type_t,
533 pk_alg)
534
535#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
536/*
537 * For elliptic curves that use namedCurve inside ECParams (RFC 5480)
538 */
539typedef struct {
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200540 mbedtls_x509_oid_descriptor_t descriptor;
Gilles Peskine47c85792025-05-07 14:35:04 +0200541 mbedtls_ecp_group_id grp_id;
542} oid_ecp_grp_t;
543
544static const oid_ecp_grp_t oid_ecp_grp[] =
545{
546#if defined(PSA_WANT_ECC_SECP_R1_192)
547 {
548 OID_DESCRIPTOR(MBEDTLS_OID_EC_GRP_SECP192R1, "secp192r1", "secp192r1"),
549 MBEDTLS_ECP_DP_SECP192R1,
550 },
551#endif /* PSA_WANT_ECC_SECP_R1_192 */
552#if defined(PSA_WANT_ECC_SECP_R1_224)
553 {
554 OID_DESCRIPTOR(MBEDTLS_OID_EC_GRP_SECP224R1, "secp224r1", "secp224r1"),
555 MBEDTLS_ECP_DP_SECP224R1,
556 },
557#endif /* PSA_WANT_ECC_SECP_R1_224 */
558#if defined(PSA_WANT_ECC_SECP_R1_256)
559 {
560 OID_DESCRIPTOR(MBEDTLS_OID_EC_GRP_SECP256R1, "secp256r1", "secp256r1"),
561 MBEDTLS_ECP_DP_SECP256R1,
562 },
563#endif /* PSA_WANT_ECC_SECP_R1_256 */
564#if defined(PSA_WANT_ECC_SECP_R1_384)
565 {
566 OID_DESCRIPTOR(MBEDTLS_OID_EC_GRP_SECP384R1, "secp384r1", "secp384r1"),
567 MBEDTLS_ECP_DP_SECP384R1,
568 },
569#endif /* PSA_WANT_ECC_SECP_R1_384 */
570#if defined(PSA_WANT_ECC_SECP_R1_521)
571 {
572 OID_DESCRIPTOR(MBEDTLS_OID_EC_GRP_SECP521R1, "secp521r1", "secp521r1"),
573 MBEDTLS_ECP_DP_SECP521R1,
574 },
575#endif /* PSA_WANT_ECC_SECP_R1_521 */
576#if defined(PSA_WANT_ECC_SECP_K1_192)
577 {
578 OID_DESCRIPTOR(MBEDTLS_OID_EC_GRP_SECP192K1, "secp192k1", "secp192k1"),
579 MBEDTLS_ECP_DP_SECP192K1,
580 },
581#endif /* PSA_WANT_ECC_SECP_K1_192 */
Gilles Peskine47c85792025-05-07 14:35:04 +0200582#if defined(PSA_WANT_ECC_SECP_K1_256)
583 {
584 OID_DESCRIPTOR(MBEDTLS_OID_EC_GRP_SECP256K1, "secp256k1", "secp256k1"),
585 MBEDTLS_ECP_DP_SECP256K1,
586 },
587#endif /* PSA_WANT_ECC_SECP_K1_256 */
588#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
589 {
590 OID_DESCRIPTOR(MBEDTLS_OID_EC_GRP_BP256R1, "brainpoolP256r1", "brainpool256r1"),
591 MBEDTLS_ECP_DP_BP256R1,
592 },
593#endif /* PSA_WANT_ECC_BRAINPOOL_P_R1_256 */
594#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
595 {
596 OID_DESCRIPTOR(MBEDTLS_OID_EC_GRP_BP384R1, "brainpoolP384r1", "brainpool384r1"),
597 MBEDTLS_ECP_DP_BP384R1,
598 },
599#endif /* PSA_WANT_ECC_BRAINPOOL_P_R1_384 */
600#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
601 {
602 OID_DESCRIPTOR(MBEDTLS_OID_EC_GRP_BP512R1, "brainpoolP512r1", "brainpool512r1"),
603 MBEDTLS_ECP_DP_BP512R1,
604 },
605#endif /* PSA_WANT_ECC_BRAINPOOL_P_R1_512 */
606 {
607 NULL_OID_DESCRIPTOR,
608 MBEDTLS_ECP_DP_NONE,
609 },
610};
611
612FN_OID_TYPED_FROM_ASN1(oid_ecp_grp_t, grp_id, oid_ecp_grp)
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200613FN_OID_GET_ATTR1(mbedtls_x509_oid_get_ec_grp, oid_ecp_grp_t, grp_id, mbedtls_ecp_group_id, grp_id)
614FN_OID_GET_OID_BY_ATTR1(mbedtls_x509_oid_get_oid_by_ec_grp,
Gilles Peskine47c85792025-05-07 14:35:04 +0200615 oid_ecp_grp_t,
616 oid_ecp_grp,
617 mbedtls_ecp_group_id,
618 grp_id)
619
620/*
621 * For Elliptic Curve algorithms that are directly
622 * encoded in the AlgorithmIdentifier (RFC 8410)
623 */
624typedef struct {
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200625 mbedtls_x509_oid_descriptor_t descriptor;
Gilles Peskine47c85792025-05-07 14:35:04 +0200626 mbedtls_ecp_group_id grp_id;
627} oid_ecp_grp_algid_t;
628
629static const oid_ecp_grp_algid_t oid_ecp_grp_algid[] =
630{
631#if defined(PSA_WANT_ECC_MONTGOMERY_255)
632 {
633 OID_DESCRIPTOR(MBEDTLS_OID_X25519, "X25519", "X25519"),
634 MBEDTLS_ECP_DP_CURVE25519,
635 },
636#endif /* PSA_WANT_ECC_MONTGOMERY_255 */
637#if defined(PSA_WANT_ECC_MONTGOMERY_448)
638 {
639 OID_DESCRIPTOR(MBEDTLS_OID_X448, "X448", "X448"),
640 MBEDTLS_ECP_DP_CURVE448,
641 },
642#endif /* PSA_WANT_ECC_MONTGOMERY_448 */
643 {
644 NULL_OID_DESCRIPTOR,
645 MBEDTLS_ECP_DP_NONE,
646 },
647};
648
649FN_OID_TYPED_FROM_ASN1(oid_ecp_grp_algid_t, grp_id_algid, oid_ecp_grp_algid)
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200650FN_OID_GET_ATTR1(mbedtls_x509_oid_get_ec_grp_algid,
Gilles Peskine47c85792025-05-07 14:35:04 +0200651 oid_ecp_grp_algid_t,
652 grp_id_algid,
653 mbedtls_ecp_group_id,
654 grp_id)
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200655FN_OID_GET_OID_BY_ATTR1(mbedtls_x509_oid_get_oid_by_ec_grp_algid,
Gilles Peskine47c85792025-05-07 14:35:04 +0200656 oid_ecp_grp_algid_t,
657 oid_ecp_grp_algid,
658 mbedtls_ecp_group_id,
659 grp_id)
660#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
661
662#if defined(MBEDTLS_CIPHER_C)
663/*
664 * For PKCS#5 PBES2 encryption algorithm
665 */
666typedef struct {
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200667 mbedtls_x509_oid_descriptor_t descriptor;
Gilles Peskine47c85792025-05-07 14:35:04 +0200668 mbedtls_cipher_type_t cipher_alg;
669} oid_cipher_alg_t;
670
671static const oid_cipher_alg_t oid_cipher_alg[] =
672{
673 {
674 OID_DESCRIPTOR(MBEDTLS_OID_DES_CBC, "desCBC", "DES-CBC"),
675 MBEDTLS_CIPHER_DES_CBC,
676 },
677 {
678 OID_DESCRIPTOR(MBEDTLS_OID_DES_EDE3_CBC, "des-ede3-cbc", "DES-EDE3-CBC"),
679 MBEDTLS_CIPHER_DES_EDE3_CBC,
680 },
681 {
682 OID_DESCRIPTOR(MBEDTLS_OID_AES_128_CBC, "aes128-cbc", "AES128-CBC"),
683 MBEDTLS_CIPHER_AES_128_CBC,
684 },
685 {
686 OID_DESCRIPTOR(MBEDTLS_OID_AES_192_CBC, "aes192-cbc", "AES192-CBC"),
687 MBEDTLS_CIPHER_AES_192_CBC,
688 },
689 {
690 OID_DESCRIPTOR(MBEDTLS_OID_AES_256_CBC, "aes256-cbc", "AES256-CBC"),
691 MBEDTLS_CIPHER_AES_256_CBC,
692 },
693 {
694 NULL_OID_DESCRIPTOR,
695 MBEDTLS_CIPHER_NONE,
696 },
697};
698
699FN_OID_TYPED_FROM_ASN1(oid_cipher_alg_t, cipher_alg, oid_cipher_alg)
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200700FN_OID_GET_ATTR1(mbedtls_x509_oid_get_cipher_alg,
Gilles Peskine47c85792025-05-07 14:35:04 +0200701 oid_cipher_alg_t,
702 cipher_alg,
703 mbedtls_cipher_type_t,
704 cipher_alg)
705#endif /* MBEDTLS_CIPHER_C */
706
707/*
708 * For digestAlgorithm
709 */
710typedef struct {
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200711 mbedtls_x509_oid_descriptor_t descriptor;
Gilles Peskine47c85792025-05-07 14:35:04 +0200712 mbedtls_md_type_t md_alg;
713} oid_md_alg_t;
714
715static const oid_md_alg_t oid_md_alg[] =
716{
717#if defined(PSA_WANT_ALG_MD5)
718 {
719 OID_DESCRIPTOR(MBEDTLS_OID_DIGEST_ALG_MD5, "id-md5", "MD5"),
720 MBEDTLS_MD_MD5,
721 },
722#endif
723#if defined(PSA_WANT_ALG_SHA_1)
724 {
725 OID_DESCRIPTOR(MBEDTLS_OID_DIGEST_ALG_SHA1, "id-sha1", "SHA-1"),
726 MBEDTLS_MD_SHA1,
727 },
728#endif
729#if defined(PSA_WANT_ALG_SHA_224)
730 {
731 OID_DESCRIPTOR(MBEDTLS_OID_DIGEST_ALG_SHA224, "id-sha224", "SHA-224"),
732 MBEDTLS_MD_SHA224,
733 },
734#endif
735#if defined(PSA_WANT_ALG_SHA_256)
736 {
737 OID_DESCRIPTOR(MBEDTLS_OID_DIGEST_ALG_SHA256, "id-sha256", "SHA-256"),
738 MBEDTLS_MD_SHA256,
739 },
740#endif
741#if defined(PSA_WANT_ALG_SHA_384)
742 {
743 OID_DESCRIPTOR(MBEDTLS_OID_DIGEST_ALG_SHA384, "id-sha384", "SHA-384"),
744 MBEDTLS_MD_SHA384,
745 },
746#endif
747#if defined(PSA_WANT_ALG_SHA_512)
748 {
749 OID_DESCRIPTOR(MBEDTLS_OID_DIGEST_ALG_SHA512, "id-sha512", "SHA-512"),
750 MBEDTLS_MD_SHA512,
751 },
752#endif
753#if defined(PSA_WANT_ALG_RIPEMD160)
754 {
755 OID_DESCRIPTOR(MBEDTLS_OID_DIGEST_ALG_RIPEMD160, "id-ripemd160", "RIPEMD-160"),
756 MBEDTLS_MD_RIPEMD160,
757 },
758#endif
759#if defined(PSA_WANT_ALG_SHA3_224)
760 {
761 OID_DESCRIPTOR(MBEDTLS_OID_DIGEST_ALG_SHA3_224, "id-sha3-224", "SHA-3-224"),
762 MBEDTLS_MD_SHA3_224,
763 },
764#endif
765#if defined(PSA_WANT_ALG_SHA3_256)
766 {
767 OID_DESCRIPTOR(MBEDTLS_OID_DIGEST_ALG_SHA3_256, "id-sha3-256", "SHA-3-256"),
768 MBEDTLS_MD_SHA3_256,
769 },
770#endif
771#if defined(PSA_WANT_ALG_SHA3_384)
772 {
773 OID_DESCRIPTOR(MBEDTLS_OID_DIGEST_ALG_SHA3_384, "id-sha3-384", "SHA-3-384"),
774 MBEDTLS_MD_SHA3_384,
775 },
776#endif
777#if defined(PSA_WANT_ALG_SHA3_512)
778 {
779 OID_DESCRIPTOR(MBEDTLS_OID_DIGEST_ALG_SHA3_512, "id-sha3-512", "SHA-3-512"),
780 MBEDTLS_MD_SHA3_512,
781 },
782#endif
783 {
784 NULL_OID_DESCRIPTOR,
785 MBEDTLS_MD_NONE,
786 },
787};
788
789FN_OID_TYPED_FROM_ASN1(oid_md_alg_t, md_alg, oid_md_alg)
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200790FN_OID_GET_ATTR1(mbedtls_x509_oid_get_md_alg, oid_md_alg_t, md_alg, mbedtls_md_type_t, md_alg)
791FN_OID_GET_OID_BY_ATTR1(mbedtls_x509_oid_get_oid_by_md,
Gilles Peskine47c85792025-05-07 14:35:04 +0200792 oid_md_alg_t,
793 oid_md_alg,
794 mbedtls_md_type_t,
795 md_alg)
796
797/*
798 * For HMAC digestAlgorithm
799 */
800typedef struct {
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200801 mbedtls_x509_oid_descriptor_t descriptor;
Gilles Peskine47c85792025-05-07 14:35:04 +0200802 mbedtls_md_type_t md_hmac;
803} oid_md_hmac_t;
804
805static const oid_md_hmac_t oid_md_hmac[] =
806{
807#if defined(PSA_WANT_ALG_SHA_1)
808 {
809 OID_DESCRIPTOR(MBEDTLS_OID_HMAC_SHA1, "hmacSHA1", "HMAC-SHA-1"),
810 MBEDTLS_MD_SHA1,
811 },
812#endif /* PSA_WANT_ALG_SHA_1 */
813#if defined(PSA_WANT_ALG_SHA_224)
814 {
815 OID_DESCRIPTOR(MBEDTLS_OID_HMAC_SHA224, "hmacSHA224", "HMAC-SHA-224"),
816 MBEDTLS_MD_SHA224,
817 },
818#endif /* PSA_WANT_ALG_SHA_224 */
819#if defined(PSA_WANT_ALG_SHA_256)
820 {
821 OID_DESCRIPTOR(MBEDTLS_OID_HMAC_SHA256, "hmacSHA256", "HMAC-SHA-256"),
822 MBEDTLS_MD_SHA256,
823 },
824#endif /* PSA_WANT_ALG_SHA_256 */
825#if defined(PSA_WANT_ALG_SHA_384)
826 {
827 OID_DESCRIPTOR(MBEDTLS_OID_HMAC_SHA384, "hmacSHA384", "HMAC-SHA-384"),
828 MBEDTLS_MD_SHA384,
829 },
830#endif /* PSA_WANT_ALG_SHA_384 */
831#if defined(PSA_WANT_ALG_SHA_512)
832 {
833 OID_DESCRIPTOR(MBEDTLS_OID_HMAC_SHA512, "hmacSHA512", "HMAC-SHA-512"),
834 MBEDTLS_MD_SHA512,
835 },
836#endif /* PSA_WANT_ALG_SHA_512 */
837#if defined(PSA_WANT_ALG_SHA3_224)
838 {
839 OID_DESCRIPTOR(MBEDTLS_OID_HMAC_SHA3_224, "hmacSHA3-224", "HMAC-SHA3-224"),
840 MBEDTLS_MD_SHA3_224,
841 },
842#endif /* PSA_WANT_ALG_SHA3_224 */
843#if defined(PSA_WANT_ALG_SHA3_256)
844 {
845 OID_DESCRIPTOR(MBEDTLS_OID_HMAC_SHA3_256, "hmacSHA3-256", "HMAC-SHA3-256"),
846 MBEDTLS_MD_SHA3_256,
847 },
848#endif /* PSA_WANT_ALG_SHA3_256 */
849#if defined(PSA_WANT_ALG_SHA3_384)
850 {
851 OID_DESCRIPTOR(MBEDTLS_OID_HMAC_SHA3_384, "hmacSHA3-384", "HMAC-SHA3-384"),
852 MBEDTLS_MD_SHA3_384,
853 },
854#endif /* PSA_WANT_ALG_SHA3_384 */
855#if defined(PSA_WANT_ALG_SHA3_512)
856 {
857 OID_DESCRIPTOR(MBEDTLS_OID_HMAC_SHA3_512, "hmacSHA3-512", "HMAC-SHA3-512"),
858 MBEDTLS_MD_SHA3_512,
859 },
860#endif /* PSA_WANT_ALG_SHA3_512 */
861#if defined(PSA_WANT_ALG_RIPEMD160)
862 {
863 OID_DESCRIPTOR(MBEDTLS_OID_HMAC_RIPEMD160, "hmacRIPEMD160", "HMAC-RIPEMD160"),
864 MBEDTLS_MD_RIPEMD160,
865 },
866#endif /* PSA_WANT_ALG_RIPEMD160 */
867 {
868 NULL_OID_DESCRIPTOR,
869 MBEDTLS_MD_NONE,
870 },
871};
872
873FN_OID_TYPED_FROM_ASN1(oid_md_hmac_t, md_hmac, oid_md_hmac)
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200874FN_OID_GET_ATTR1(mbedtls_x509_oid_get_md_hmac, oid_md_hmac_t, md_hmac, mbedtls_md_type_t, md_hmac)
Gilles Peskine47c85792025-05-07 14:35:04 +0200875
876#if defined(MBEDTLS_PKCS12_C) && defined(MBEDTLS_CIPHER_C)
877/*
878 * For PKCS#12 PBEs
879 */
880typedef struct {
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200881 mbedtls_x509_oid_descriptor_t descriptor;
Gilles Peskine47c85792025-05-07 14:35:04 +0200882 mbedtls_md_type_t md_alg;
883 mbedtls_cipher_type_t cipher_alg;
884} oid_pkcs12_pbe_alg_t;
885
886static const oid_pkcs12_pbe_alg_t oid_pkcs12_pbe_alg[] =
887{
888 {
889 OID_DESCRIPTOR(MBEDTLS_OID_PKCS12_PBE_SHA1_DES3_EDE_CBC,
890 "pbeWithSHAAnd3-KeyTripleDES-CBC",
891 "PBE with SHA1 and 3-Key 3DES"),
892 MBEDTLS_MD_SHA1, MBEDTLS_CIPHER_DES_EDE3_CBC,
893 },
894 {
895 OID_DESCRIPTOR(MBEDTLS_OID_PKCS12_PBE_SHA1_DES2_EDE_CBC,
896 "pbeWithSHAAnd2-KeyTripleDES-CBC",
897 "PBE with SHA1 and 2-Key 3DES"),
898 MBEDTLS_MD_SHA1, MBEDTLS_CIPHER_DES_EDE_CBC,
899 },
900 {
901 NULL_OID_DESCRIPTOR,
902 MBEDTLS_MD_NONE, MBEDTLS_CIPHER_NONE,
903 },
904};
905
906FN_OID_TYPED_FROM_ASN1(oid_pkcs12_pbe_alg_t, pkcs12_pbe_alg, oid_pkcs12_pbe_alg)
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200907FN_OID_GET_ATTR2(mbedtls_x509_oid_get_pkcs12_pbe_alg,
Gilles Peskine47c85792025-05-07 14:35:04 +0200908 oid_pkcs12_pbe_alg_t,
909 pkcs12_pbe_alg,
910 mbedtls_md_type_t,
911 md_alg,
912 mbedtls_cipher_type_t,
913 cipher_alg)
914#endif /* MBEDTLS_PKCS12_C && MBEDTLS_CIPHER_C */
915
916#endif /* MBEDTLS_OID_C */