TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / mirror / mbed-tls / 86e45ba0ba58fb9c88c4481253da53b6f918e2c7 / . / library / x509_oid.h
blob: 8798d0faafb507029c5cec89638edc8815dcb52b [file] [log] [blame]
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]1/**
Gilles Peskineb825dcf2025-05-07 19:41:09 +0200[diff] [blame]2 * \file x509_oid.h
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]3 *
4 * \brief Object Identifier (OID) database
5 */
6/*
7 * Copyright The Mbed TLS Contributors
8 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9 */
Gilles Peskineb825dcf2025-05-07 19:41:09 +0200[diff] [blame]10#ifndef MBEDTLS_X509_OID_H
11#define MBEDTLS_X509_OID_H
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]12#include "mbedtls/private_access.h"
13
14#include "tf-psa-crypto/build_info.h"
15
16#include "mbedtls/asn1.h"
17#include "mbedtls/pk.h"
18
19#include <stddef.h>
20
21#if defined(MBEDTLS_CIPHER_C)
22#include "mbedtls/cipher.h"
23#endif
24
25#include "mbedtls/md.h"
26
27/** OID is not found. */
28#define MBEDTLS_ERR_OID_NOT_FOUND -0x002E
29/** output buffer is too small */
30#define MBEDTLS_ERR_OID_BUF_TOO_SMALL -0x000B
31
32/* This is for the benefit of X.509, but defined here in order to avoid
33 * having a "backwards" include of x.509.h here */
34/*
35 * X.509 extension types (internal, arbitrary values for bitsets)
36 */
37#define MBEDTLS_OID_X509_EXT_AUTHORITY_KEY_IDENTIFIER (1 << 0)
38#define MBEDTLS_OID_X509_EXT_SUBJECT_KEY_IDENTIFIER (1 << 1)
39#define MBEDTLS_OID_X509_EXT_KEY_USAGE (1 << 2)
40#define MBEDTLS_OID_X509_EXT_CERTIFICATE_POLICIES (1 << 3)
41#define MBEDTLS_OID_X509_EXT_POLICY_MAPPINGS (1 << 4)
42#define MBEDTLS_OID_X509_EXT_SUBJECT_ALT_NAME (1 << 5)
43#define MBEDTLS_OID_X509_EXT_ISSUER_ALT_NAME (1 << 6)
44#define MBEDTLS_OID_X509_EXT_SUBJECT_DIRECTORY_ATTRS (1 << 7)
45#define MBEDTLS_OID_X509_EXT_BASIC_CONSTRAINTS (1 << 8)
46#define MBEDTLS_OID_X509_EXT_NAME_CONSTRAINTS (1 << 9)
47#define MBEDTLS_OID_X509_EXT_POLICY_CONSTRAINTS (1 << 10)
48#define MBEDTLS_OID_X509_EXT_EXTENDED_KEY_USAGE (1 << 11)
49#define MBEDTLS_OID_X509_EXT_CRL_DISTRIBUTION_POINTS (1 << 12)
50#define MBEDTLS_OID_X509_EXT_INIHIBIT_ANYPOLICY (1 << 13)
51#define MBEDTLS_OID_X509_EXT_FRESHEST_CRL (1 << 14)
52#define MBEDTLS_OID_X509_EXT_NS_CERT_TYPE (1 << 16)
53
54/*
55 * Maximum number of OID components allowed
56 */
57#define MBEDTLS_OID_MAX_COMPONENTS 128
58
59/*
60 * Top level OID tuples
61 */
62#define MBEDTLS_OID_ISO_MEMBER_BODIES "\x2a" /* {iso(1) member-body(2)} */
63#define MBEDTLS_OID_ISO_IDENTIFIED_ORG "\x2b" /* {iso(1) identified-organization(3)} */
64#define MBEDTLS_OID_ISO_CCITT_DS "\x55" /* {joint-iso-ccitt(2) ds(5)} */
65#define MBEDTLS_OID_ISO_ITU_COUNTRY "\x60" /* {joint-iso-itu-t(2) country(16)} */
66
67/*
68 * ISO Member bodies OID parts
69 */
70#define MBEDTLS_OID_COUNTRY_US "\x86\x48" /* {us(840)} */
71#define MBEDTLS_OID_ORG_RSA_DATA_SECURITY "\x86\xf7\x0d" /* {rsadsi(113549)} */
72#define MBEDTLS_OID_RSA_COMPANY MBEDTLS_OID_ISO_MEMBER_BODIES MBEDTLS_OID_COUNTRY_US \
73 MBEDTLS_OID_ORG_RSA_DATA_SECURITY /* {iso(1) member-body(2) us(840) rsadsi(113549)} */
74#define MBEDTLS_OID_ORG_ANSI_X9_62 "\xce\x3d" /* ansi-X9-62(10045) */
75#define MBEDTLS_OID_ANSI_X9_62 MBEDTLS_OID_ISO_MEMBER_BODIES MBEDTLS_OID_COUNTRY_US \
76 MBEDTLS_OID_ORG_ANSI_X9_62
77
78/*
79 * ISO Identified organization OID parts
80 */
81#define MBEDTLS_OID_ORG_DOD "\x06" /* {dod(6)} */
82#define MBEDTLS_OID_ORG_OIW "\x0e"
83#define MBEDTLS_OID_OIW_SECSIG MBEDTLS_OID_ORG_OIW "\x03"
84#define MBEDTLS_OID_OIW_SECSIG_ALG MBEDTLS_OID_OIW_SECSIG "\x02"
85#define MBEDTLS_OID_OIW_SECSIG_SHA1 MBEDTLS_OID_OIW_SECSIG_ALG "\x1a"
86#define MBEDTLS_OID_ORG_THAWTE "\x65" /* thawte(101) */
87#define MBEDTLS_OID_THAWTE MBEDTLS_OID_ISO_IDENTIFIED_ORG \
88 MBEDTLS_OID_ORG_THAWTE
89#define MBEDTLS_OID_ORG_CERTICOM "\x81\x04" /* certicom(132) */
90#define MBEDTLS_OID_CERTICOM MBEDTLS_OID_ISO_IDENTIFIED_ORG \
91 MBEDTLS_OID_ORG_CERTICOM
92#define MBEDTLS_OID_ORG_TELETRUST "\x24" /* teletrust(36) */
93#define MBEDTLS_OID_TELETRUST MBEDTLS_OID_ISO_IDENTIFIED_ORG \
94 MBEDTLS_OID_ORG_TELETRUST
95
96/*
97 * ISO ITU OID parts
98 */
99#define MBEDTLS_OID_ORGANIZATION "\x01" /* {organization(1)} */
100#define MBEDTLS_OID_ISO_ITU_US_ORG MBEDTLS_OID_ISO_ITU_COUNTRY MBEDTLS_OID_COUNTRY_US \
101 MBEDTLS_OID_ORGANIZATION /* {joint-iso-itu-t(2) country(16) us(840) organization(1)} */
102
103#define MBEDTLS_OID_ORG_GOV "\x65" /* {gov(101)} */
104#define MBEDTLS_OID_GOV MBEDTLS_OID_ISO_ITU_US_ORG MBEDTLS_OID_ORG_GOV /* {joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101)} */
105
106#define MBEDTLS_OID_ORG_NETSCAPE "\x86\xF8\x42" /* {netscape(113730)} */
107#define MBEDTLS_OID_NETSCAPE MBEDTLS_OID_ISO_ITU_US_ORG MBEDTLS_OID_ORG_NETSCAPE /* Netscape OID {joint-iso-itu-t(2) country(16) us(840) organization(1) netscape(113730)} */
108
109/* ISO arc for standard certificate and CRL extensions */
110#define MBEDTLS_OID_ID_CE MBEDTLS_OID_ISO_CCITT_DS "\x1D" /**< id-ce OBJECT IDENTIFIER ::= {joint-iso-ccitt(2) ds(5) 29} */
111
112#define MBEDTLS_OID_NIST_ALG MBEDTLS_OID_GOV "\x03\x04" /** { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithm(4) */
113
114/**
115 * Private Internet Extensions
116 * { iso(1) identified-organization(3) dod(6) internet(1)
117 * security(5) mechanisms(5) pkix(7) }
118 */
119#define MBEDTLS_OID_INTERNET MBEDTLS_OID_ISO_IDENTIFIED_ORG MBEDTLS_OID_ORG_DOD \
120 "\x01"
121#define MBEDTLS_OID_PKIX MBEDTLS_OID_INTERNET "\x05\x05\x07"
122
123/*
124 * Arc for standard naming attributes
125 */
126#define MBEDTLS_OID_AT MBEDTLS_OID_ISO_CCITT_DS "\x04" /**< id-at OBJECT IDENTIFIER ::= {joint-iso-ccitt(2) ds(5) 4} */
127#define MBEDTLS_OID_AT_CN MBEDTLS_OID_AT "\x03" /**< id-at-commonName AttributeType:= {id-at 3} */
128#define MBEDTLS_OID_AT_SUR_NAME MBEDTLS_OID_AT "\x04" /**< id-at-surName AttributeType:= {id-at 4} */
129#define MBEDTLS_OID_AT_SERIAL_NUMBER MBEDTLS_OID_AT "\x05" /**< id-at-serialNumber AttributeType:= {id-at 5} */
130#define MBEDTLS_OID_AT_COUNTRY MBEDTLS_OID_AT "\x06" /**< id-at-countryName AttributeType:= {id-at 6} */
131#define MBEDTLS_OID_AT_LOCALITY MBEDTLS_OID_AT "\x07" /**< id-at-locality AttributeType:= {id-at 7} */
132#define MBEDTLS_OID_AT_STATE MBEDTLS_OID_AT "\x08" /**< id-at-state AttributeType:= {id-at 8} */
133#define MBEDTLS_OID_AT_ORGANIZATION MBEDTLS_OID_AT "\x0A" /**< id-at-organizationName AttributeType:= {id-at 10} */
134#define MBEDTLS_OID_AT_ORG_UNIT MBEDTLS_OID_AT "\x0B" /**< id-at-organizationalUnitName AttributeType:= {id-at 11} */
135#define MBEDTLS_OID_AT_TITLE MBEDTLS_OID_AT "\x0C" /**< id-at-title AttributeType:= {id-at 12} */
136#define MBEDTLS_OID_AT_POSTAL_ADDRESS MBEDTLS_OID_AT "\x10" /**< id-at-postalAddress AttributeType:= {id-at 16} */
137#define MBEDTLS_OID_AT_POSTAL_CODE MBEDTLS_OID_AT "\x11" /**< id-at-postalCode AttributeType:= {id-at 17} */
138#define MBEDTLS_OID_AT_GIVEN_NAME MBEDTLS_OID_AT "\x2A" /**< id-at-givenName AttributeType:= {id-at 42} */
139#define MBEDTLS_OID_AT_INITIALS MBEDTLS_OID_AT "\x2B" /**< id-at-initials AttributeType:= {id-at 43} */
140#define MBEDTLS_OID_AT_GENERATION_QUALIFIER MBEDTLS_OID_AT "\x2C" /**< id-at-generationQualifier AttributeType:= {id-at 44} */
141#define MBEDTLS_OID_AT_UNIQUE_IDENTIFIER MBEDTLS_OID_AT "\x2D" /**< id-at-uniqueIdentifier AttributeType:= {id-at 45} */
142#define MBEDTLS_OID_AT_DN_QUALIFIER MBEDTLS_OID_AT "\x2E" /**< id-at-dnQualifier AttributeType:= {id-at 46} */
143#define MBEDTLS_OID_AT_PSEUDONYM MBEDTLS_OID_AT "\x41" /**< id-at-pseudonym AttributeType:= {id-at 65} */
144
145#define MBEDTLS_OID_UID "\x09\x92\x26\x89\x93\xF2\x2C\x64\x01\x01" /** id-domainComponent AttributeType:= {itu-t(0) data(9) pss(2342) ucl(19200300) pilot(100) pilotAttributeType(1) uid(1)} */
146#define MBEDTLS_OID_DOMAIN_COMPONENT "\x09\x92\x26\x89\x93\xF2\x2C\x64\x01\x19" /** id-domainComponent AttributeType:= {itu-t(0) data(9) pss(2342) ucl(19200300) pilot(100) pilotAttributeType(1) domainComponent(25)} */
147
148/*
149 * OIDs for standard certificate extensions
150 */
151#define MBEDTLS_OID_AUTHORITY_KEY_IDENTIFIER MBEDTLS_OID_ID_CE "\x23" /**< id-ce-authorityKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 35 } */
152#define MBEDTLS_OID_SUBJECT_KEY_IDENTIFIER MBEDTLS_OID_ID_CE "\x0E" /**< id-ce-subjectKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 14 } */
153#define MBEDTLS_OID_KEY_USAGE MBEDTLS_OID_ID_CE "\x0F" /**< id-ce-keyUsage OBJECT IDENTIFIER ::= { id-ce 15 } */
154#define MBEDTLS_OID_CERTIFICATE_POLICIES MBEDTLS_OID_ID_CE "\x20" /**< id-ce-certificatePolicies OBJECT IDENTIFIER ::= { id-ce 32 } */
155#define MBEDTLS_OID_POLICY_MAPPINGS MBEDTLS_OID_ID_CE "\x21" /**< id-ce-policyMappings OBJECT IDENTIFIER ::= { id-ce 33 } */
156#define MBEDTLS_OID_SUBJECT_ALT_NAME MBEDTLS_OID_ID_CE "\x11" /**< id-ce-subjectAltName OBJECT IDENTIFIER ::= { id-ce 17 } */
157#define MBEDTLS_OID_ISSUER_ALT_NAME MBEDTLS_OID_ID_CE "\x12" /**< id-ce-issuerAltName OBJECT IDENTIFIER ::= { id-ce 18 } */
158#define MBEDTLS_OID_SUBJECT_DIRECTORY_ATTRS MBEDTLS_OID_ID_CE "\x09" /**< id-ce-subjectDirectoryAttributes OBJECT IDENTIFIER ::= { id-ce 9 } */
159#define MBEDTLS_OID_BASIC_CONSTRAINTS MBEDTLS_OID_ID_CE "\x13" /**< id-ce-basicConstraints OBJECT IDENTIFIER ::= { id-ce 19 } */
160#define MBEDTLS_OID_NAME_CONSTRAINTS MBEDTLS_OID_ID_CE "\x1E" /**< id-ce-nameConstraints OBJECT IDENTIFIER ::= { id-ce 30 } */
161#define MBEDTLS_OID_POLICY_CONSTRAINTS MBEDTLS_OID_ID_CE "\x24" /**< id-ce-policyConstraints OBJECT IDENTIFIER ::= { id-ce 36 } */
162#define MBEDTLS_OID_EXTENDED_KEY_USAGE MBEDTLS_OID_ID_CE "\x25" /**< id-ce-extKeyUsage OBJECT IDENTIFIER ::= { id-ce 37 } */
163#define MBEDTLS_OID_CRL_DISTRIBUTION_POINTS MBEDTLS_OID_ID_CE "\x1F" /**< id-ce-cRLDistributionPoints OBJECT IDENTIFIER ::= { id-ce 31 } */
164#define MBEDTLS_OID_INIHIBIT_ANYPOLICY MBEDTLS_OID_ID_CE "\x36" /**< id-ce-inhibitAnyPolicy OBJECT IDENTIFIER ::= { id-ce 54 } */
165#define MBEDTLS_OID_FRESHEST_CRL MBEDTLS_OID_ID_CE "\x2E" /**< id-ce-freshestCRL OBJECT IDENTIFIER ::= { id-ce 46 } */
166
167/*
168 * Certificate policies
169 */
170#define MBEDTLS_OID_ANY_POLICY MBEDTLS_OID_CERTIFICATE_POLICIES "\x00" /**< anyPolicy OBJECT IDENTIFIER ::= { id-ce-certificatePolicies 0 } */
171
172/*
173 * Netscape certificate extensions
174 */
175#define MBEDTLS_OID_NS_CERT MBEDTLS_OID_NETSCAPE "\x01"
176#define MBEDTLS_OID_NS_CERT_TYPE MBEDTLS_OID_NS_CERT "\x01"
177#define MBEDTLS_OID_NS_BASE_URL MBEDTLS_OID_NS_CERT "\x02"
178#define MBEDTLS_OID_NS_REVOCATION_URL MBEDTLS_OID_NS_CERT "\x03"
179#define MBEDTLS_OID_NS_CA_REVOCATION_URL MBEDTLS_OID_NS_CERT "\x04"
180#define MBEDTLS_OID_NS_RENEWAL_URL MBEDTLS_OID_NS_CERT "\x07"
181#define MBEDTLS_OID_NS_CA_POLICY_URL MBEDTLS_OID_NS_CERT "\x08"
182#define MBEDTLS_OID_NS_SSL_SERVER_NAME MBEDTLS_OID_NS_CERT "\x0C"
183#define MBEDTLS_OID_NS_COMMENT MBEDTLS_OID_NS_CERT "\x0D"
184#define MBEDTLS_OID_NS_DATA_TYPE MBEDTLS_OID_NETSCAPE "\x02"
185#define MBEDTLS_OID_NS_CERT_SEQUENCE MBEDTLS_OID_NS_DATA_TYPE "\x05"
186
187/*
188 * OIDs for CRL extensions
189 */
190#define MBEDTLS_OID_PRIVATE_KEY_USAGE_PERIOD MBEDTLS_OID_ID_CE "\x10"
191#define MBEDTLS_OID_CRL_NUMBER MBEDTLS_OID_ID_CE "\x14" /**< id-ce-cRLNumber OBJECT IDENTIFIER ::= { id-ce 20 } */
192
193/*
194 * X.509 v3 Extended key usage OIDs
195 */
196#define MBEDTLS_OID_ANY_EXTENDED_KEY_USAGE MBEDTLS_OID_EXTENDED_KEY_USAGE "\x00" /**< anyExtendedKeyUsage OBJECT IDENTIFIER ::= { id-ce-extKeyUsage 0 } */
197
198#define MBEDTLS_OID_KP MBEDTLS_OID_PKIX "\x03" /**< id-kp OBJECT IDENTIFIER ::= { id-pkix 3 } */
199#define MBEDTLS_OID_SERVER_AUTH MBEDTLS_OID_KP "\x01" /**< id-kp-serverAuth OBJECT IDENTIFIER ::= { id-kp 1 } */
200#define MBEDTLS_OID_CLIENT_AUTH MBEDTLS_OID_KP "\x02" /**< id-kp-clientAuth OBJECT IDENTIFIER ::= { id-kp 2 } */
201#define MBEDTLS_OID_CODE_SIGNING MBEDTLS_OID_KP "\x03" /**< id-kp-codeSigning OBJECT IDENTIFIER ::= { id-kp 3 } */
202#define MBEDTLS_OID_EMAIL_PROTECTION MBEDTLS_OID_KP "\x04" /**< id-kp-emailProtection OBJECT IDENTIFIER ::= { id-kp 4 } */
203#define MBEDTLS_OID_TIME_STAMPING MBEDTLS_OID_KP "\x08" /**< id-kp-timeStamping OBJECT IDENTIFIER ::= { id-kp 8 } */
204#define MBEDTLS_OID_OCSP_SIGNING MBEDTLS_OID_KP "\x09" /**< id-kp-OCSPSigning OBJECT IDENTIFIER ::= { id-kp 9 } */
205
206/**
207 * Wi-SUN Alliance Field Area Network
208 * { iso(1) identified-organization(3) dod(6) internet(1)
209 * private(4) enterprise(1) WiSUN(45605) FieldAreaNetwork(1) }
210 */
211#define MBEDTLS_OID_WISUN_FAN MBEDTLS_OID_INTERNET "\x04\x01\x82\xe4\x25\x01"
212
213#define MBEDTLS_OID_ON MBEDTLS_OID_PKIX "\x08" /**< id-on OBJECT IDENTIFIER ::= { id-pkix 8 } */
214#define MBEDTLS_OID_ON_HW_MODULE_NAME MBEDTLS_OID_ON "\x04" /**< id-on-hardwareModuleName OBJECT IDENTIFIER ::= { id-on 4 } */
215
216/*
217 * PKCS definition OIDs
218 */
219
220#define MBEDTLS_OID_PKCS MBEDTLS_OID_RSA_COMPANY "\x01" /**< pkcs OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) 1 } */
221#define MBEDTLS_OID_PKCS1 MBEDTLS_OID_PKCS "\x01" /**< pkcs-1 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 1 } */
222#define MBEDTLS_OID_PKCS5 MBEDTLS_OID_PKCS "\x05" /**< pkcs-5 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 5 } */
223#define MBEDTLS_OID_PKCS7 MBEDTLS_OID_PKCS "\x07" /**< pkcs-7 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 7 } */
224#define MBEDTLS_OID_PKCS9 MBEDTLS_OID_PKCS "\x09" /**< pkcs-9 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 9 } */
225#define MBEDTLS_OID_PKCS12 MBEDTLS_OID_PKCS "\x0c" /**< pkcs-12 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 12 } */
226
227/*
228 * PKCS#1 OIDs
229 */
230#define MBEDTLS_OID_PKCS1_RSA MBEDTLS_OID_PKCS1 "\x01" /**< rsaEncryption OBJECT IDENTIFIER ::= { pkcs-1 1 } */
231#define MBEDTLS_OID_PKCS1_MD5 MBEDTLS_OID_PKCS1 "\x04" /**< md5WithRSAEncryption ::= { pkcs-1 4 } */
232#define MBEDTLS_OID_PKCS1_SHA1 MBEDTLS_OID_PKCS1 "\x05" /**< sha1WithRSAEncryption ::= { pkcs-1 5 } */
233#define MBEDTLS_OID_PKCS1_SHA224 MBEDTLS_OID_PKCS1 "\x0e" /**< sha224WithRSAEncryption ::= { pkcs-1 14 } */
234#define MBEDTLS_OID_PKCS1_SHA256 MBEDTLS_OID_PKCS1 "\x0b" /**< sha256WithRSAEncryption ::= { pkcs-1 11 } */
235#define MBEDTLS_OID_PKCS1_SHA384 MBEDTLS_OID_PKCS1 "\x0c" /**< sha384WithRSAEncryption ::= { pkcs-1 12 } */
236#define MBEDTLS_OID_PKCS1_SHA512 MBEDTLS_OID_PKCS1 "\x0d" /**< sha512WithRSAEncryption ::= { pkcs-1 13 } */
237
238#define MBEDTLS_OID_RSA_SHA_OBS "\x2B\x0E\x03\x02\x1D"
239
240#define MBEDTLS_OID_PKCS9_EMAIL MBEDTLS_OID_PKCS9 "\x01" /**< emailAddress AttributeType ::= { pkcs-9 1 } */
241
242/* RFC 4055 */
243#define MBEDTLS_OID_RSASSA_PSS MBEDTLS_OID_PKCS1 "\x0a" /**< id-RSASSA-PSS ::= { pkcs-1 10 } */
244#define MBEDTLS_OID_MGF1 MBEDTLS_OID_PKCS1 "\x08" /**< id-mgf1 ::= { pkcs-1 8 } */
245
246/*
247 * Digest algorithms
248 */
249#define MBEDTLS_OID_DIGEST_ALG_MD5 MBEDTLS_OID_RSA_COMPANY "\x02\x05" /**< id-mbedtls_md5 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 5 } */
250#define MBEDTLS_OID_DIGEST_ALG_SHA1 MBEDTLS_OID_ISO_IDENTIFIED_ORG \
251 MBEDTLS_OID_OIW_SECSIG_SHA1 /**< id-mbedtls_sha1 OBJECT IDENTIFIER ::= { iso(1) identified-organization(3) oiw(14) secsig(3) algorithms(2) 26 } */
252#define MBEDTLS_OID_DIGEST_ALG_SHA224 MBEDTLS_OID_NIST_ALG "\x02\x04" /**< id-sha224 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistalgorithm(4) hashalgs(2) 4 } */
253#define MBEDTLS_OID_DIGEST_ALG_SHA256 MBEDTLS_OID_NIST_ALG "\x02\x01" /**< id-mbedtls_sha256 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistalgorithm(4) hashalgs(2) 1 } */
254
255#define MBEDTLS_OID_DIGEST_ALG_SHA384 MBEDTLS_OID_NIST_ALG "\x02\x02" /**< id-sha384 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistalgorithm(4) hashalgs(2) 2 } */
256
257#define MBEDTLS_OID_DIGEST_ALG_SHA512 MBEDTLS_OID_NIST_ALG "\x02\x03" /**< id-mbedtls_sha512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistalgorithm(4) hashalgs(2) 3 } */
258
259#define MBEDTLS_OID_DIGEST_ALG_RIPEMD160 MBEDTLS_OID_TELETRUST "\x03\x02\x01" /**< id-ripemd160 OBJECT IDENTIFIER :: { iso(1) identified-organization(3) teletrust(36) algorithm(3) hashAlgorithm(2) ripemd160(1) } */
260
261#define MBEDTLS_OID_DIGEST_ALG_SHA3_224 MBEDTLS_OID_NIST_ALG "\x02\x07" /**< id-sha3-224 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) sha3-224(7) } */
262
263#define MBEDTLS_OID_DIGEST_ALG_SHA3_256 MBEDTLS_OID_NIST_ALG "\x02\x08" /**< id-sha3-256 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) sha3-256(8) } */
264
265#define MBEDTLS_OID_DIGEST_ALG_SHA3_384 MBEDTLS_OID_NIST_ALG "\x02\x09" /**< id-sha3-384 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) sha3-384(9) } */
266
267#define MBEDTLS_OID_DIGEST_ALG_SHA3_512 MBEDTLS_OID_NIST_ALG "\x02\x0a" /**< id-sha3-512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) sha3-512(10) } */
268
269
270#define MBEDTLS_OID_HMAC_SHA1 MBEDTLS_OID_RSA_COMPANY "\x02\x07" /**< id-hmacWithSHA1 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 7 } */
271
272#define MBEDTLS_OID_HMAC_SHA224 MBEDTLS_OID_RSA_COMPANY "\x02\x08" /**< id-hmacWithSHA224 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 8 } */
273
274#define MBEDTLS_OID_HMAC_SHA256 MBEDTLS_OID_RSA_COMPANY "\x02\x09" /**< id-hmacWithSHA256 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 9 } */
275
276#define MBEDTLS_OID_HMAC_SHA384 MBEDTLS_OID_RSA_COMPANY "\x02\x0A" /**< id-hmacWithSHA384 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 10 } */
277
278#define MBEDTLS_OID_HMAC_SHA512 MBEDTLS_OID_RSA_COMPANY "\x02\x0B" /**< id-hmacWithSHA512 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 11 } */
279
280#define MBEDTLS_OID_HMAC_SHA3_224 MBEDTLS_OID_NIST_ALG "\x02\x0d" /**< id-hmacWithSHA3-512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) hmacWithSHA3-224(13) } */
281
282#define MBEDTLS_OID_HMAC_SHA3_256 MBEDTLS_OID_NIST_ALG "\x02\x0e" /**< id-hmacWithSHA3-512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) hmacWithSHA3-256(14) } */
283
284#define MBEDTLS_OID_HMAC_SHA3_384 MBEDTLS_OID_NIST_ALG "\x02\x0f" /**< id-hmacWithSHA3-512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) hmacWithSHA3-384(15) } */
285
286#define MBEDTLS_OID_HMAC_SHA3_512 MBEDTLS_OID_NIST_ALG "\x02\x10" /**< id-hmacWithSHA3-512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) hmacWithSHA3-512(16) } */
287
288#define MBEDTLS_OID_HMAC_RIPEMD160 MBEDTLS_OID_INTERNET "\x05\x05\x08\x01\x04" /**< id-hmacWithSHA1 OBJECT IDENTIFIER ::= {iso(1) iso-identified-organization(3) dod(6) internet(1) security(5) mechanisms(5) ipsec(8) isakmpOakley(1) hmacRIPEMD160(4)} */
289
290/*
291 * Encryption algorithms,
292 * the following standardized object identifiers are specified at
293 * https://datatracker.ietf.org/doc/html/rfc8018#appendix-C.
294 */
295#define MBEDTLS_OID_DES_CBC MBEDTLS_OID_ISO_IDENTIFIED_ORG \
296 MBEDTLS_OID_OIW_SECSIG_ALG "\x07" /**< desCBC OBJECT IDENTIFIER ::= { iso(1) identified-organization(3) oiw(14) secsig(3) algorithms(2) 7 } */
297#define MBEDTLS_OID_DES_EDE3_CBC MBEDTLS_OID_RSA_COMPANY "\x03\x07" /**< des-ede3-cbc OBJECT IDENTIFIER ::= { iso(1) member-body(2) -- us(840) rsadsi(113549) encryptionAlgorithm(3) 7 } */
298#define MBEDTLS_OID_AES MBEDTLS_OID_NIST_ALG "\x01" /** aes OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithm(4) 1 } */
299#define MBEDTLS_OID_AES_128_CBC MBEDTLS_OID_AES "\x02" /** aes128-cbc-pad OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) aes(1) aes128-CBC-PAD(2) } */
300#define MBEDTLS_OID_AES_192_CBC MBEDTLS_OID_AES "\x16" /** aes192-cbc-pad OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) aes(1) aes192-CBC-PAD(22) } */
301#define MBEDTLS_OID_AES_256_CBC MBEDTLS_OID_AES "\x2a" /** aes256-cbc-pad OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) aes(1) aes256-CBC-PAD(42) } */
302
303/*
304 * Key Wrapping algorithms
305 */
306/*
307 * RFC 5649
308 */
309#define MBEDTLS_OID_AES128_KW MBEDTLS_OID_AES "\x05" /** id-aes128-wrap OBJECT IDENTIFIER ::= { aes 5 } */
310#define MBEDTLS_OID_AES128_KWP MBEDTLS_OID_AES "\x08" /** id-aes128-wrap-pad OBJECT IDENTIFIER ::= { aes 8 } */
311#define MBEDTLS_OID_AES192_KW MBEDTLS_OID_AES "\x19" /** id-aes192-wrap OBJECT IDENTIFIER ::= { aes 25 } */
312#define MBEDTLS_OID_AES192_KWP MBEDTLS_OID_AES "\x1c" /** id-aes192-wrap-pad OBJECT IDENTIFIER ::= { aes 28 } */
313#define MBEDTLS_OID_AES256_KW MBEDTLS_OID_AES "\x2d" /** id-aes256-wrap OBJECT IDENTIFIER ::= { aes 45 } */
314#define MBEDTLS_OID_AES256_KWP MBEDTLS_OID_AES "\x30" /** id-aes256-wrap-pad OBJECT IDENTIFIER ::= { aes 48 } */
315/*
316 * PKCS#5 OIDs
317 */
318#define MBEDTLS_OID_PKCS5_PBKDF2 MBEDTLS_OID_PKCS5 "\x0c" /**< id-PBKDF2 OBJECT IDENTIFIER ::= {pkcs-5 12} */
319#define MBEDTLS_OID_PKCS5_PBES2 MBEDTLS_OID_PKCS5 "\x0d" /**< id-PBES2 OBJECT IDENTIFIER ::= {pkcs-5 13} */
320#define MBEDTLS_OID_PKCS5_PBMAC1 MBEDTLS_OID_PKCS5 "\x0e" /**< id-PBMAC1 OBJECT IDENTIFIER ::= {pkcs-5 14} */
321
322/*
323 * PKCS#5 PBES1 algorithms
324 */
325#define MBEDTLS_OID_PKCS5_PBE_MD5_DES_CBC MBEDTLS_OID_PKCS5 "\x03" /**< pbeWithMD5AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 3} */
326#define MBEDTLS_OID_PKCS5_PBE_MD5_RC2_CBC MBEDTLS_OID_PKCS5 "\x06" /**< pbeWithMD5AndRC2-CBC OBJECT IDENTIFIER ::= {pkcs-5 6} */
327#define MBEDTLS_OID_PKCS5_PBE_SHA1_DES_CBC MBEDTLS_OID_PKCS5 "\x0a" /**< pbeWithSHA1AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 10} */
328#define MBEDTLS_OID_PKCS5_PBE_SHA1_RC2_CBC MBEDTLS_OID_PKCS5 "\x0b" /**< pbeWithSHA1AndRC2-CBC OBJECT IDENTIFIER ::= {pkcs-5 11} */
329
330/*
331 * PKCS#7 OIDs
332 */
333#define MBEDTLS_OID_PKCS7_DATA MBEDTLS_OID_PKCS7 "\x01" /**< Content type is Data OBJECT IDENTIFIER ::= {pkcs-7 1} */
334#define MBEDTLS_OID_PKCS7_SIGNED_DATA MBEDTLS_OID_PKCS7 "\x02" /**< Content type is Signed Data OBJECT IDENTIFIER ::= {pkcs-7 2} */
335#define MBEDTLS_OID_PKCS7_ENVELOPED_DATA MBEDTLS_OID_PKCS7 "\x03" /**< Content type is Enveloped Data OBJECT IDENTIFIER ::= {pkcs-7 3} */
336#define MBEDTLS_OID_PKCS7_SIGNED_AND_ENVELOPED_DATA MBEDTLS_OID_PKCS7 "\x04" /**< Content type is Signed and Enveloped Data OBJECT IDENTIFIER ::= {pkcs-7 4} */
337#define MBEDTLS_OID_PKCS7_DIGESTED_DATA MBEDTLS_OID_PKCS7 "\x05" /**< Content type is Digested Data OBJECT IDENTIFIER ::= {pkcs-7 5} */
338#define MBEDTLS_OID_PKCS7_ENCRYPTED_DATA MBEDTLS_OID_PKCS7 "\x06" /**< Content type is Encrypted Data OBJECT IDENTIFIER ::= {pkcs-7 6} */
339
340/*
341 * PKCS#8 OIDs
342 */
343#define MBEDTLS_OID_PKCS9_CSR_EXT_REQ MBEDTLS_OID_PKCS9 "\x0e" /**< extensionRequest OBJECT IDENTIFIER ::= {pkcs-9 14} */
344
345/*
346 * PKCS#12 PBE OIDs
347 */
348#define MBEDTLS_OID_PKCS12_PBE MBEDTLS_OID_PKCS12 "\x01" /**< pkcs-12PbeIds OBJECT IDENTIFIER ::= {pkcs-12 1} */
349
350#define MBEDTLS_OID_PKCS12_PBE_SHA1_DES3_EDE_CBC MBEDTLS_OID_PKCS12_PBE "\x03" /**< pbeWithSHAAnd3-KeyTripleDES-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 3} */
351#define MBEDTLS_OID_PKCS12_PBE_SHA1_DES2_EDE_CBC MBEDTLS_OID_PKCS12_PBE "\x04" /**< pbeWithSHAAnd2-KeyTripleDES-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 4} */
352#define MBEDTLS_OID_PKCS12_PBE_SHA1_RC2_128_CBC MBEDTLS_OID_PKCS12_PBE "\x05" /**< pbeWithSHAAnd128BitRC2-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 5} */
353#define MBEDTLS_OID_PKCS12_PBE_SHA1_RC2_40_CBC MBEDTLS_OID_PKCS12_PBE "\x06" /**< pbeWithSHAAnd40BitRC2-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 6} */
354
355/*
356 * EC key algorithms from RFC 5480
357 */
358
359/* id-ecPublicKey OBJECT IDENTIFIER ::= {
360 * iso(1) member-body(2) us(840) ansi-X9-62(10045) keyType(2) 1 } */
361#define MBEDTLS_OID_EC_ALG_UNRESTRICTED MBEDTLS_OID_ANSI_X9_62 "\x02\01"
362
363/* id-ecDH OBJECT IDENTIFIER ::= {
364 * iso(1) identified-organization(3) certicom(132)
365 * schemes(1) ecdh(12) } */
366#define MBEDTLS_OID_EC_ALG_ECDH MBEDTLS_OID_CERTICOM "\x01\x0c"
367
368/*
369 * ECParameters namedCurve identifiers, from RFC 5480, RFC 5639, and SEC2
370 */
371
372/* secp192r1 OBJECT IDENTIFIER ::= {
373 * iso(1) member-body(2) us(840) ansi-X9-62(10045) curves(3) prime(1) 1 } */
374#define MBEDTLS_OID_EC_GRP_SECP192R1 MBEDTLS_OID_ANSI_X9_62 "\x03\x01\x01"
375
376/* secp224r1 OBJECT IDENTIFIER ::= {
377 * iso(1) identified-organization(3) certicom(132) curve(0) 33 } */
378#define MBEDTLS_OID_EC_GRP_SECP224R1 MBEDTLS_OID_CERTICOM "\x00\x21"
379
380/* secp256r1 OBJECT IDENTIFIER ::= {
381 * iso(1) member-body(2) us(840) ansi-X9-62(10045) curves(3) prime(1) 7 } */
382#define MBEDTLS_OID_EC_GRP_SECP256R1 MBEDTLS_OID_ANSI_X9_62 "\x03\x01\x07"
383
384/* secp384r1 OBJECT IDENTIFIER ::= {
385 * iso(1) identified-organization(3) certicom(132) curve(0) 34 } */
386#define MBEDTLS_OID_EC_GRP_SECP384R1 MBEDTLS_OID_CERTICOM "\x00\x22"
387
388/* secp521r1 OBJECT IDENTIFIER ::= {
389 * iso(1) identified-organization(3) certicom(132) curve(0) 35 } */
390#define MBEDTLS_OID_EC_GRP_SECP521R1 MBEDTLS_OID_CERTICOM "\x00\x23"
391
392/* secp192k1 OBJECT IDENTIFIER ::= {
393 * iso(1) identified-organization(3) certicom(132) curve(0) 31 } */
394#define MBEDTLS_OID_EC_GRP_SECP192K1 MBEDTLS_OID_CERTICOM "\x00\x1f"
395
396/* secp224k1 OBJECT IDENTIFIER ::= {
397 * iso(1) identified-organization(3) certicom(132) curve(0) 32 } */
398#define MBEDTLS_OID_EC_GRP_SECP224K1 MBEDTLS_OID_CERTICOM "\x00\x20"
399
400/* secp256k1 OBJECT IDENTIFIER ::= {
401 * iso(1) identified-organization(3) certicom(132) curve(0) 10 } */
402#define MBEDTLS_OID_EC_GRP_SECP256K1 MBEDTLS_OID_CERTICOM "\x00\x0a"
403
404/* RFC 5639 4.1
405 * ecStdCurvesAndGeneration OBJECT IDENTIFIER::= {iso(1)
406 * identified-organization(3) teletrust(36) algorithm(3) signature-
407 * algorithm(3) ecSign(2) 8}
408 * ellipticCurve OBJECT IDENTIFIER ::= {ecStdCurvesAndGeneration 1}
409 * versionOne OBJECT IDENTIFIER ::= {ellipticCurve 1} */
410#define MBEDTLS_OID_EC_BRAINPOOL_V1 MBEDTLS_OID_TELETRUST "\x03\x03\x02\x08\x01\x01"
411
412/* brainpoolP256r1 OBJECT IDENTIFIER ::= {versionOne 7} */
413#define MBEDTLS_OID_EC_GRP_BP256R1 MBEDTLS_OID_EC_BRAINPOOL_V1 "\x07"
414
415/* brainpoolP384r1 OBJECT IDENTIFIER ::= {versionOne 11} */
416#define MBEDTLS_OID_EC_GRP_BP384R1 MBEDTLS_OID_EC_BRAINPOOL_V1 "\x0B"
417
418/* brainpoolP512r1 OBJECT IDENTIFIER ::= {versionOne 13} */
419#define MBEDTLS_OID_EC_GRP_BP512R1 MBEDTLS_OID_EC_BRAINPOOL_V1 "\x0D"
420
421/*
422 * SEC1 C.1
423 *
424 * prime-field OBJECT IDENTIFIER ::= { id-fieldType 1 }
425 * id-fieldType OBJECT IDENTIFIER ::= { ansi-X9-62 fieldType(1)}
426 */
427#define MBEDTLS_OID_ANSI_X9_62_FIELD_TYPE MBEDTLS_OID_ANSI_X9_62 "\x01"
428#define MBEDTLS_OID_ANSI_X9_62_PRIME_FIELD MBEDTLS_OID_ANSI_X9_62_FIELD_TYPE "\x01"
429
430/*
431 * ECDSA signature identifiers, from RFC 5480
432 */
433#define MBEDTLS_OID_ANSI_X9_62_SIG MBEDTLS_OID_ANSI_X9_62 "\x04" /* signatures(4) */
434#define MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 MBEDTLS_OID_ANSI_X9_62_SIG "\x03" /* ecdsa-with-SHA2(3) */
435
436/* ecdsa-with-SHA1 OBJECT IDENTIFIER ::= {
437 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4) 1 } */
438#define MBEDTLS_OID_ECDSA_SHA1 MBEDTLS_OID_ANSI_X9_62_SIG "\x01"
439
440/* ecdsa-with-SHA224 OBJECT IDENTIFIER ::= {
441 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
442 * ecdsa-with-SHA2(3) 1 } */
443#define MBEDTLS_OID_ECDSA_SHA224 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x01"
444
445/* ecdsa-with-SHA256 OBJECT IDENTIFIER ::= {
446 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
447 * ecdsa-with-SHA2(3) 2 } */
448#define MBEDTLS_OID_ECDSA_SHA256 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x02"
449
450/* ecdsa-with-SHA384 OBJECT IDENTIFIER ::= {
451 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
452 * ecdsa-with-SHA2(3) 3 } */
453#define MBEDTLS_OID_ECDSA_SHA384 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x03"
454
455/* ecdsa-with-SHA512 OBJECT IDENTIFIER ::= {
456 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
457 * ecdsa-with-SHA2(3) 4 } */
458#define MBEDTLS_OID_ECDSA_SHA512 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x04"
459
460/*
461 * EC key algorithms from RFC 8410
462 */
463
464#define MBEDTLS_OID_X25519 MBEDTLS_OID_THAWTE "\x6e" /**< id-X25519 OBJECT IDENTIFIER ::= { 1 3 101 110 } */
465#define MBEDTLS_OID_X448 MBEDTLS_OID_THAWTE "\x6f" /**< id-X448 OBJECT IDENTIFIER ::= { 1 3 101 111 } */
466#define MBEDTLS_OID_ED25519 MBEDTLS_OID_THAWTE "\x70" /**< id-Ed25519 OBJECT IDENTIFIER ::= { 1 3 101 112 } */
467#define MBEDTLS_OID_ED448 MBEDTLS_OID_THAWTE "\x71" /**< id-Ed448 OBJECT IDENTIFIER ::= { 1 3 101 113 } */
468
469#ifdef __cplusplus
470extern "C" {
471#endif
472
473/**
474 * \brief Base OID descriptor structure
475 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]476typedef struct {
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]477 const char *MBEDTLS_PRIVATE(asn1); /*!< OID ASN.1 representation */
478 size_t MBEDTLS_PRIVATE(asn1_len); /*!< length of asn1 */
479#if !defined(MBEDTLS_X509_REMOVE_INFO)
480 const char *MBEDTLS_PRIVATE(name); /*!< official name (e.g. from RFC) */
481 const char *MBEDTLS_PRIVATE(description); /*!< human friendly description */
482#endif
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]483} mbedtls_x509_oid_descriptor_t;
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]484
485/**
486 * \brief Translate an X.509 extension OID into local values
487 *
488 * \param oid OID to use
489 * \param ext_type place to store the extension type
490 *
491 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
492 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]493int mbedtls_x509_oid_get_x509_ext_type(const mbedtls_asn1_buf *oid, int *ext_type);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]494
495/**
496 * \brief Translate an X.509 attribute type OID into the short name
497 * (e.g. the OID for an X520 Common Name into "CN")
498 *
499 * \param oid OID to use
500 * \param short_name place to store the string pointer
501 *
502 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
503 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]504int mbedtls_x509_oid_get_attr_short_name(const mbedtls_asn1_buf *oid, const char **short_name);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]505
506/**
507 * \brief Translate PublicKeyAlgorithm OID into pk_type
508 *
509 * \param oid OID to use
510 * \param pk_alg place to store public key algorithm
511 *
512 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
513 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]514int mbedtls_x509_oid_get_pk_alg(const mbedtls_asn1_buf *oid, mbedtls_pk_type_t *pk_alg);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]515
516/**
517 * \brief Translate pk_type into PublicKeyAlgorithm OID
518 *
519 * \param pk_alg Public key type to look for
520 * \param oid place to store ASN.1 OID string pointer
521 * \param olen length of the OID
522 *
523 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
524 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]525int mbedtls_x509_oid_get_oid_by_pk_alg(mbedtls_pk_type_t pk_alg,
526 const char **oid, size_t *olen);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]527
528#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
529/**
530 * \brief Translate NamedCurve OID into an EC group identifier
531 *
532 * \param oid OID to use
533 * \param grp_id place to store group id
534 *
535 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
536 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]537int mbedtls_x509_oid_get_ec_grp(const mbedtls_asn1_buf *oid, mbedtls_ecp_group_id *grp_id);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]538
539/**
540 * \brief Translate EC group identifier into NamedCurve OID
541 *
542 * \param grp_id EC group identifier
543 * \param oid place to store ASN.1 OID string pointer
544 * \param olen length of the OID
545 *
546 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
547 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]548int mbedtls_x509_oid_get_oid_by_ec_grp(mbedtls_ecp_group_id grp_id,
549 const char **oid, size_t *olen);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]550
551/**
552 * \brief Translate AlgorithmIdentifier OID into an EC group identifier,
553 * for curves that are directly encoded at this level
554 *
555 * \param oid OID to use
556 * \param grp_id place to store group id
557 *
558 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
559 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]560int mbedtls_x509_oid_get_ec_grp_algid(const mbedtls_asn1_buf *oid, mbedtls_ecp_group_id *grp_id);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]561
562/**
563 * \brief Translate EC group identifier into AlgorithmIdentifier OID,
564 * for curves that are directly encoded at this level
565 *
566 * \param grp_id EC group identifier
567 * \param oid place to store ASN.1 OID string pointer
568 * \param olen length of the OID
569 *
570 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
571 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]572int mbedtls_x509_oid_get_oid_by_ec_grp_algid(mbedtls_ecp_group_id grp_id,
573 const char **oid, size_t *olen);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]574#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
575
576/**
577 * \brief Translate SignatureAlgorithm OID into md_type and pk_type
578 *
579 * \param oid OID to use
580 * \param md_alg place to store message digest algorithm
581 * \param pk_alg place to store public key algorithm
582 *
583 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
584 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]585int mbedtls_x509_oid_get_sig_alg(const mbedtls_asn1_buf *oid,
586 mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]587
588/**
589 * \brief Translate SignatureAlgorithm OID into description
590 *
591 * \param oid OID to use
592 * \param desc place to store string pointer
593 *
594 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
595 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]596int mbedtls_x509_oid_get_sig_alg_desc(const mbedtls_asn1_buf *oid, const char **desc);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]597
598/**
599 * \brief Translate md_type and pk_type into SignatureAlgorithm OID
600 *
601 * \param md_alg message digest algorithm
602 * \param pk_alg public key algorithm
603 * \param oid place to store ASN.1 OID string pointer
604 * \param olen length of the OID
605 *
606 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
607 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]608int mbedtls_x509_oid_get_oid_by_sig_alg(mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg,
609 const char **oid, size_t *olen);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]610
611/**
612 * \brief Translate hmac algorithm OID into md_type
613 *
614 * \param oid OID to use
615 * \param md_hmac place to store message hmac algorithm
616 *
617 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
618 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]619int mbedtls_x509_oid_get_md_hmac(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_hmac);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]620
621/**
622 * \brief Translate hash algorithm OID into md_type
623 *
624 * \param oid OID to use
625 * \param md_alg place to store message digest algorithm
626 *
627 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
628 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]629int mbedtls_x509_oid_get_md_alg(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_alg);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]630
631#if !defined(MBEDTLS_X509_REMOVE_INFO)
632/**
633 * \brief Translate Extended Key Usage OID into description
634 *
635 * \param oid OID to use
636 * \param desc place to store string pointer
637 *
638 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
639 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]640int mbedtls_x509_oid_get_extended_key_usage(const mbedtls_asn1_buf *oid, const char **desc);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]641#endif
642
643/**
644 * \brief Translate certificate policies OID into description
645 *
646 * \param oid OID to use
647 * \param desc place to store string pointer
648 *
649 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
650 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]651int mbedtls_x509_oid_get_certificate_policies(const mbedtls_asn1_buf *oid, const char **desc);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]652
653/**
654 * \brief Translate md_type into hash algorithm OID
655 *
656 * \param md_alg message digest algorithm
657 * \param oid place to store ASN.1 OID string pointer
658 * \param olen length of the OID
659 *
660 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
661 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]662int mbedtls_x509_oid_get_oid_by_md(mbedtls_md_type_t md_alg, const char **oid, size_t *olen);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]663
664#if defined(MBEDTLS_CIPHER_C)
665/**
666 * \brief Translate encryption algorithm OID into cipher_type
667 *
668 * \param oid OID to use
669 * \param cipher_alg place to store cipher algorithm
670 *
671 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
672 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]673int mbedtls_x509_oid_get_cipher_alg(const mbedtls_asn1_buf *oid, mbedtls_cipher_type_t *cipher_alg);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]674
675#if defined(MBEDTLS_PKCS12_C)
676/**
677 * \brief Translate PKCS#12 PBE algorithm OID into md_type and
678 * cipher_type
679 *
680 * \param oid OID to use
681 * \param md_alg place to store message digest algorithm
682 * \param cipher_alg place to store cipher algorithm
683 *
684 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
685 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame^]686int mbedtls_x509_oid_get_pkcs12_pbe_alg(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_alg,
687 mbedtls_cipher_type_t *cipher_alg);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]688#endif /* MBEDTLS_PKCS12_C */
689#endif /* MBEDTLS_CIPHER_C */
690
691#ifdef __cplusplus
692}
693#endif
694
Gilles Peskineb825dcf2025-05-07 19:41:09 +0200[diff] [blame]695#endif /* x509_oid.h */