TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / mirror / mbed-tls / f9ca8ed9ddacdff3ef9b9a9ff0902a02c072a79d / . / library / x509_oid.h
blob: 51cf96c862b5d7c83091a65e3e6016d418e11777 [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
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]14#include "mbedtls/asn1.h"
15#include "mbedtls/pk.h"
Gilles Peskine32a11122025-04-09 21:51:46 +0200[diff] [blame]16#include "mbedtls/x509.h"
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]17
18#include <stddef.h>
19
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]20#include "mbedtls/md.h"
21
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]22/*
23 * Maximum number of OID components allowed
24 */
25#define MBEDTLS_OID_MAX_COMPONENTS 128
26
27/*
28 * Top level OID tuples
29 */
30#define MBEDTLS_OID_ISO_MEMBER_BODIES "\x2a" /* {iso(1) member-body(2)} */
31#define MBEDTLS_OID_ISO_IDENTIFIED_ORG "\x2b" /* {iso(1) identified-organization(3)} */
32#define MBEDTLS_OID_ISO_CCITT_DS "\x55" /* {joint-iso-ccitt(2) ds(5)} */
33#define MBEDTLS_OID_ISO_ITU_COUNTRY "\x60" /* {joint-iso-itu-t(2) country(16)} */
34
35/*
36 * ISO Member bodies OID parts
37 */
38#define MBEDTLS_OID_COUNTRY_US "\x86\x48" /* {us(840)} */
39#define MBEDTLS_OID_ORG_RSA_DATA_SECURITY "\x86\xf7\x0d" /* {rsadsi(113549)} */
40#define MBEDTLS_OID_RSA_COMPANY MBEDTLS_OID_ISO_MEMBER_BODIES MBEDTLS_OID_COUNTRY_US \
41 MBEDTLS_OID_ORG_RSA_DATA_SECURITY /* {iso(1) member-body(2) us(840) rsadsi(113549)} */
42#define MBEDTLS_OID_ORG_ANSI_X9_62 "\xce\x3d" /* ansi-X9-62(10045) */
43#define MBEDTLS_OID_ANSI_X9_62 MBEDTLS_OID_ISO_MEMBER_BODIES MBEDTLS_OID_COUNTRY_US \
44 MBEDTLS_OID_ORG_ANSI_X9_62
45
46/*
47 * ISO Identified organization OID parts
48 */
49#define MBEDTLS_OID_ORG_DOD "\x06" /* {dod(6)} */
50#define MBEDTLS_OID_ORG_OIW "\x0e"
51#define MBEDTLS_OID_OIW_SECSIG MBEDTLS_OID_ORG_OIW "\x03"
52#define MBEDTLS_OID_OIW_SECSIG_ALG MBEDTLS_OID_OIW_SECSIG "\x02"
53#define MBEDTLS_OID_OIW_SECSIG_SHA1 MBEDTLS_OID_OIW_SECSIG_ALG "\x1a"
54#define MBEDTLS_OID_ORG_THAWTE "\x65" /* thawte(101) */
55#define MBEDTLS_OID_THAWTE MBEDTLS_OID_ISO_IDENTIFIED_ORG \
56 MBEDTLS_OID_ORG_THAWTE
57#define MBEDTLS_OID_ORG_CERTICOM "\x81\x04" /* certicom(132) */
58#define MBEDTLS_OID_CERTICOM MBEDTLS_OID_ISO_IDENTIFIED_ORG \
59 MBEDTLS_OID_ORG_CERTICOM
60#define MBEDTLS_OID_ORG_TELETRUST "\x24" /* teletrust(36) */
61#define MBEDTLS_OID_TELETRUST MBEDTLS_OID_ISO_IDENTIFIED_ORG \
62 MBEDTLS_OID_ORG_TELETRUST
63
64/*
65 * ISO ITU OID parts
66 */
67#define MBEDTLS_OID_ORGANIZATION "\x01" /* {organization(1)} */
68#define MBEDTLS_OID_ISO_ITU_US_ORG MBEDTLS_OID_ISO_ITU_COUNTRY MBEDTLS_OID_COUNTRY_US \
69 MBEDTLS_OID_ORGANIZATION /* {joint-iso-itu-t(2) country(16) us(840) organization(1)} */
70
71#define MBEDTLS_OID_ORG_GOV "\x65" /* {gov(101)} */
72#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)} */
73
74#define MBEDTLS_OID_ORG_NETSCAPE "\x86\xF8\x42" /* {netscape(113730)} */
75#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)} */
76
77/* ISO arc for standard certificate and CRL extensions */
78#define MBEDTLS_OID_ID_CE MBEDTLS_OID_ISO_CCITT_DS "\x1D" /**< id-ce OBJECT IDENTIFIER ::= {joint-iso-ccitt(2) ds(5) 29} */
79
80#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) */
81
82/**
83 * Private Internet Extensions
84 * { iso(1) identified-organization(3) dod(6) internet(1)
85 * security(5) mechanisms(5) pkix(7) }
86 */
87#define MBEDTLS_OID_INTERNET MBEDTLS_OID_ISO_IDENTIFIED_ORG MBEDTLS_OID_ORG_DOD \
88 "\x01"
89#define MBEDTLS_OID_PKIX MBEDTLS_OID_INTERNET "\x05\x05\x07"
90
91/*
92 * Arc for standard naming attributes
93 */
94#define MBEDTLS_OID_AT MBEDTLS_OID_ISO_CCITT_DS "\x04" /**< id-at OBJECT IDENTIFIER ::= {joint-iso-ccitt(2) ds(5) 4} */
95#define MBEDTLS_OID_AT_CN MBEDTLS_OID_AT "\x03" /**< id-at-commonName AttributeType:= {id-at 3} */
96#define MBEDTLS_OID_AT_SUR_NAME MBEDTLS_OID_AT "\x04" /**< id-at-surName AttributeType:= {id-at 4} */
97#define MBEDTLS_OID_AT_SERIAL_NUMBER MBEDTLS_OID_AT "\x05" /**< id-at-serialNumber AttributeType:= {id-at 5} */
98#define MBEDTLS_OID_AT_COUNTRY MBEDTLS_OID_AT "\x06" /**< id-at-countryName AttributeType:= {id-at 6} */
99#define MBEDTLS_OID_AT_LOCALITY MBEDTLS_OID_AT "\x07" /**< id-at-locality AttributeType:= {id-at 7} */
100#define MBEDTLS_OID_AT_STATE MBEDTLS_OID_AT "\x08" /**< id-at-state AttributeType:= {id-at 8} */
101#define MBEDTLS_OID_AT_ORGANIZATION MBEDTLS_OID_AT "\x0A" /**< id-at-organizationName AttributeType:= {id-at 10} */
102#define MBEDTLS_OID_AT_ORG_UNIT MBEDTLS_OID_AT "\x0B" /**< id-at-organizationalUnitName AttributeType:= {id-at 11} */
103#define MBEDTLS_OID_AT_TITLE MBEDTLS_OID_AT "\x0C" /**< id-at-title AttributeType:= {id-at 12} */
104#define MBEDTLS_OID_AT_POSTAL_ADDRESS MBEDTLS_OID_AT "\x10" /**< id-at-postalAddress AttributeType:= {id-at 16} */
105#define MBEDTLS_OID_AT_POSTAL_CODE MBEDTLS_OID_AT "\x11" /**< id-at-postalCode AttributeType:= {id-at 17} */
106#define MBEDTLS_OID_AT_GIVEN_NAME MBEDTLS_OID_AT "\x2A" /**< id-at-givenName AttributeType:= {id-at 42} */
107#define MBEDTLS_OID_AT_INITIALS MBEDTLS_OID_AT "\x2B" /**< id-at-initials AttributeType:= {id-at 43} */
108#define MBEDTLS_OID_AT_GENERATION_QUALIFIER MBEDTLS_OID_AT "\x2C" /**< id-at-generationQualifier AttributeType:= {id-at 44} */
109#define MBEDTLS_OID_AT_UNIQUE_IDENTIFIER MBEDTLS_OID_AT "\x2D" /**< id-at-uniqueIdentifier AttributeType:= {id-at 45} */
110#define MBEDTLS_OID_AT_DN_QUALIFIER MBEDTLS_OID_AT "\x2E" /**< id-at-dnQualifier AttributeType:= {id-at 46} */
111#define MBEDTLS_OID_AT_PSEUDONYM MBEDTLS_OID_AT "\x41" /**< id-at-pseudonym AttributeType:= {id-at 65} */
112
113#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)} */
114#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)} */
115
116/*
117 * OIDs for standard certificate extensions
118 */
119#define MBEDTLS_OID_AUTHORITY_KEY_IDENTIFIER MBEDTLS_OID_ID_CE "\x23" /**< id-ce-authorityKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 35 } */
120#define MBEDTLS_OID_SUBJECT_KEY_IDENTIFIER MBEDTLS_OID_ID_CE "\x0E" /**< id-ce-subjectKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 14 } */
121#define MBEDTLS_OID_KEY_USAGE MBEDTLS_OID_ID_CE "\x0F" /**< id-ce-keyUsage OBJECT IDENTIFIER ::= { id-ce 15 } */
122#define MBEDTLS_OID_CERTIFICATE_POLICIES MBEDTLS_OID_ID_CE "\x20" /**< id-ce-certificatePolicies OBJECT IDENTIFIER ::= { id-ce 32 } */
123#define MBEDTLS_OID_POLICY_MAPPINGS MBEDTLS_OID_ID_CE "\x21" /**< id-ce-policyMappings OBJECT IDENTIFIER ::= { id-ce 33 } */
124#define MBEDTLS_OID_SUBJECT_ALT_NAME MBEDTLS_OID_ID_CE "\x11" /**< id-ce-subjectAltName OBJECT IDENTIFIER ::= { id-ce 17 } */
125#define MBEDTLS_OID_ISSUER_ALT_NAME MBEDTLS_OID_ID_CE "\x12" /**< id-ce-issuerAltName OBJECT IDENTIFIER ::= { id-ce 18 } */
126#define MBEDTLS_OID_SUBJECT_DIRECTORY_ATTRS MBEDTLS_OID_ID_CE "\x09" /**< id-ce-subjectDirectoryAttributes OBJECT IDENTIFIER ::= { id-ce 9 } */
127#define MBEDTLS_OID_BASIC_CONSTRAINTS MBEDTLS_OID_ID_CE "\x13" /**< id-ce-basicConstraints OBJECT IDENTIFIER ::= { id-ce 19 } */
128#define MBEDTLS_OID_NAME_CONSTRAINTS MBEDTLS_OID_ID_CE "\x1E" /**< id-ce-nameConstraints OBJECT IDENTIFIER ::= { id-ce 30 } */
129#define MBEDTLS_OID_POLICY_CONSTRAINTS MBEDTLS_OID_ID_CE "\x24" /**< id-ce-policyConstraints OBJECT IDENTIFIER ::= { id-ce 36 } */
130#define MBEDTLS_OID_EXTENDED_KEY_USAGE MBEDTLS_OID_ID_CE "\x25" /**< id-ce-extKeyUsage OBJECT IDENTIFIER ::= { id-ce 37 } */
131#define MBEDTLS_OID_CRL_DISTRIBUTION_POINTS MBEDTLS_OID_ID_CE "\x1F" /**< id-ce-cRLDistributionPoints OBJECT IDENTIFIER ::= { id-ce 31 } */
132#define MBEDTLS_OID_INIHIBIT_ANYPOLICY MBEDTLS_OID_ID_CE "\x36" /**< id-ce-inhibitAnyPolicy OBJECT IDENTIFIER ::= { id-ce 54 } */
133#define MBEDTLS_OID_FRESHEST_CRL MBEDTLS_OID_ID_CE "\x2E" /**< id-ce-freshestCRL OBJECT IDENTIFIER ::= { id-ce 46 } */
134
135/*
136 * Certificate policies
137 */
138#define MBEDTLS_OID_ANY_POLICY MBEDTLS_OID_CERTIFICATE_POLICIES "\x00" /**< anyPolicy OBJECT IDENTIFIER ::= { id-ce-certificatePolicies 0 } */
139
140/*
141 * Netscape certificate extensions
142 */
143#define MBEDTLS_OID_NS_CERT MBEDTLS_OID_NETSCAPE "\x01"
144#define MBEDTLS_OID_NS_CERT_TYPE MBEDTLS_OID_NS_CERT "\x01"
145#define MBEDTLS_OID_NS_BASE_URL MBEDTLS_OID_NS_CERT "\x02"
146#define MBEDTLS_OID_NS_REVOCATION_URL MBEDTLS_OID_NS_CERT "\x03"
147#define MBEDTLS_OID_NS_CA_REVOCATION_URL MBEDTLS_OID_NS_CERT "\x04"
148#define MBEDTLS_OID_NS_RENEWAL_URL MBEDTLS_OID_NS_CERT "\x07"
149#define MBEDTLS_OID_NS_CA_POLICY_URL MBEDTLS_OID_NS_CERT "\x08"
150#define MBEDTLS_OID_NS_SSL_SERVER_NAME MBEDTLS_OID_NS_CERT "\x0C"
151#define MBEDTLS_OID_NS_COMMENT MBEDTLS_OID_NS_CERT "\x0D"
152#define MBEDTLS_OID_NS_DATA_TYPE MBEDTLS_OID_NETSCAPE "\x02"
153#define MBEDTLS_OID_NS_CERT_SEQUENCE MBEDTLS_OID_NS_DATA_TYPE "\x05"
154
155/*
156 * OIDs for CRL extensions
157 */
158#define MBEDTLS_OID_PRIVATE_KEY_USAGE_PERIOD MBEDTLS_OID_ID_CE "\x10"
159#define MBEDTLS_OID_CRL_NUMBER MBEDTLS_OID_ID_CE "\x14" /**< id-ce-cRLNumber OBJECT IDENTIFIER ::= { id-ce 20 } */
160
161/*
162 * X.509 v3 Extended key usage OIDs
163 */
164#define MBEDTLS_OID_ANY_EXTENDED_KEY_USAGE MBEDTLS_OID_EXTENDED_KEY_USAGE "\x00" /**< anyExtendedKeyUsage OBJECT IDENTIFIER ::= { id-ce-extKeyUsage 0 } */
165
166#define MBEDTLS_OID_KP MBEDTLS_OID_PKIX "\x03" /**< id-kp OBJECT IDENTIFIER ::= { id-pkix 3 } */
167#define MBEDTLS_OID_SERVER_AUTH MBEDTLS_OID_KP "\x01" /**< id-kp-serverAuth OBJECT IDENTIFIER ::= { id-kp 1 } */
168#define MBEDTLS_OID_CLIENT_AUTH MBEDTLS_OID_KP "\x02" /**< id-kp-clientAuth OBJECT IDENTIFIER ::= { id-kp 2 } */
169#define MBEDTLS_OID_CODE_SIGNING MBEDTLS_OID_KP "\x03" /**< id-kp-codeSigning OBJECT IDENTIFIER ::= { id-kp 3 } */
170#define MBEDTLS_OID_EMAIL_PROTECTION MBEDTLS_OID_KP "\x04" /**< id-kp-emailProtection OBJECT IDENTIFIER ::= { id-kp 4 } */
171#define MBEDTLS_OID_TIME_STAMPING MBEDTLS_OID_KP "\x08" /**< id-kp-timeStamping OBJECT IDENTIFIER ::= { id-kp 8 } */
172#define MBEDTLS_OID_OCSP_SIGNING MBEDTLS_OID_KP "\x09" /**< id-kp-OCSPSigning OBJECT IDENTIFIER ::= { id-kp 9 } */
173
174/**
175 * Wi-SUN Alliance Field Area Network
176 * { iso(1) identified-organization(3) dod(6) internet(1)
177 * private(4) enterprise(1) WiSUN(45605) FieldAreaNetwork(1) }
178 */
179#define MBEDTLS_OID_WISUN_FAN MBEDTLS_OID_INTERNET "\x04\x01\x82\xe4\x25\x01"
180
181#define MBEDTLS_OID_ON MBEDTLS_OID_PKIX "\x08" /**< id-on OBJECT IDENTIFIER ::= { id-pkix 8 } */
182#define MBEDTLS_OID_ON_HW_MODULE_NAME MBEDTLS_OID_ON "\x04" /**< id-on-hardwareModuleName OBJECT IDENTIFIER ::= { id-on 4 } */
183
184/*
185 * PKCS definition OIDs
186 */
187
188#define MBEDTLS_OID_PKCS MBEDTLS_OID_RSA_COMPANY "\x01" /**< pkcs OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) 1 } */
189#define MBEDTLS_OID_PKCS1 MBEDTLS_OID_PKCS "\x01" /**< pkcs-1 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 1 } */
190#define MBEDTLS_OID_PKCS5 MBEDTLS_OID_PKCS "\x05" /**< pkcs-5 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 5 } */
191#define MBEDTLS_OID_PKCS7 MBEDTLS_OID_PKCS "\x07" /**< pkcs-7 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 7 } */
192#define MBEDTLS_OID_PKCS9 MBEDTLS_OID_PKCS "\x09" /**< pkcs-9 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 9 } */
193#define MBEDTLS_OID_PKCS12 MBEDTLS_OID_PKCS "\x0c" /**< pkcs-12 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 12 } */
194
195/*
196 * PKCS#1 OIDs
197 */
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]198#define MBEDTLS_OID_PKCS1_MD5 MBEDTLS_OID_PKCS1 "\x04" /**< md5WithRSAEncryption ::= { pkcs-1 4 } */
199#define MBEDTLS_OID_PKCS1_SHA1 MBEDTLS_OID_PKCS1 "\x05" /**< sha1WithRSAEncryption ::= { pkcs-1 5 } */
200#define MBEDTLS_OID_PKCS1_SHA224 MBEDTLS_OID_PKCS1 "\x0e" /**< sha224WithRSAEncryption ::= { pkcs-1 14 } */
201#define MBEDTLS_OID_PKCS1_SHA256 MBEDTLS_OID_PKCS1 "\x0b" /**< sha256WithRSAEncryption ::= { pkcs-1 11 } */
202#define MBEDTLS_OID_PKCS1_SHA384 MBEDTLS_OID_PKCS1 "\x0c" /**< sha384WithRSAEncryption ::= { pkcs-1 12 } */
203#define MBEDTLS_OID_PKCS1_SHA512 MBEDTLS_OID_PKCS1 "\x0d" /**< sha512WithRSAEncryption ::= { pkcs-1 13 } */
204
205#define MBEDTLS_OID_RSA_SHA_OBS "\x2B\x0E\x03\x02\x1D"
206
207#define MBEDTLS_OID_PKCS9_EMAIL MBEDTLS_OID_PKCS9 "\x01" /**< emailAddress AttributeType ::= { pkcs-9 1 } */
208
209/* RFC 4055 */
210#define MBEDTLS_OID_RSASSA_PSS MBEDTLS_OID_PKCS1 "\x0a" /**< id-RSASSA-PSS ::= { pkcs-1 10 } */
211#define MBEDTLS_OID_MGF1 MBEDTLS_OID_PKCS1 "\x08" /**< id-mgf1 ::= { pkcs-1 8 } */
212
213/*
214 * Digest algorithms
215 */
216#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 } */
217#define MBEDTLS_OID_DIGEST_ALG_SHA1 MBEDTLS_OID_ISO_IDENTIFIED_ORG \
218 MBEDTLS_OID_OIW_SECSIG_SHA1 /**< id-mbedtls_sha1 OBJECT IDENTIFIER ::= { iso(1) identified-organization(3) oiw(14) secsig(3) algorithms(2) 26 } */
219#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 } */
220#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 } */
221
222#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 } */
223
224#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 } */
225
226#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) } */
227
228#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) } */
229
230#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) } */
231
232#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) } */
233
234#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) } */
235
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]236/*
237 * PKCS#7 OIDs
238 */
239#define MBEDTLS_OID_PKCS7_DATA MBEDTLS_OID_PKCS7 "\x01" /**< Content type is Data OBJECT IDENTIFIER ::= {pkcs-7 1} */
240#define MBEDTLS_OID_PKCS7_SIGNED_DATA MBEDTLS_OID_PKCS7 "\x02" /**< Content type is Signed Data OBJECT IDENTIFIER ::= {pkcs-7 2} */
241#define MBEDTLS_OID_PKCS7_ENVELOPED_DATA MBEDTLS_OID_PKCS7 "\x03" /**< Content type is Enveloped Data OBJECT IDENTIFIER ::= {pkcs-7 3} */
242#define MBEDTLS_OID_PKCS7_SIGNED_AND_ENVELOPED_DATA MBEDTLS_OID_PKCS7 "\x04" /**< Content type is Signed and Enveloped Data OBJECT IDENTIFIER ::= {pkcs-7 4} */
243#define MBEDTLS_OID_PKCS7_DIGESTED_DATA MBEDTLS_OID_PKCS7 "\x05" /**< Content type is Digested Data OBJECT IDENTIFIER ::= {pkcs-7 5} */
244#define MBEDTLS_OID_PKCS7_ENCRYPTED_DATA MBEDTLS_OID_PKCS7 "\x06" /**< Content type is Encrypted Data OBJECT IDENTIFIER ::= {pkcs-7 6} */
245
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]246#define MBEDTLS_OID_PKCS9_CSR_EXT_REQ MBEDTLS_OID_PKCS9 "\x0e" /**< extensionRequest OBJECT IDENTIFIER ::= {pkcs-9 14} */
247
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]248
249/*
250 * ECDSA signature identifiers, from RFC 5480
251 */
252#define MBEDTLS_OID_ANSI_X9_62_SIG MBEDTLS_OID_ANSI_X9_62 "\x04" /* signatures(4) */
253#define MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 MBEDTLS_OID_ANSI_X9_62_SIG "\x03" /* ecdsa-with-SHA2(3) */
254
255/* ecdsa-with-SHA1 OBJECT IDENTIFIER ::= {
256 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4) 1 } */
257#define MBEDTLS_OID_ECDSA_SHA1 MBEDTLS_OID_ANSI_X9_62_SIG "\x01"
258
259/* ecdsa-with-SHA224 OBJECT IDENTIFIER ::= {
260 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
261 * ecdsa-with-SHA2(3) 1 } */
262#define MBEDTLS_OID_ECDSA_SHA224 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x01"
263
264/* ecdsa-with-SHA256 OBJECT IDENTIFIER ::= {
265 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
266 * ecdsa-with-SHA2(3) 2 } */
267#define MBEDTLS_OID_ECDSA_SHA256 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x02"
268
269/* ecdsa-with-SHA384 OBJECT IDENTIFIER ::= {
270 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
271 * ecdsa-with-SHA2(3) 3 } */
272#define MBEDTLS_OID_ECDSA_SHA384 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x03"
273
274/* ecdsa-with-SHA512 OBJECT IDENTIFIER ::= {
275 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
276 * ecdsa-with-SHA2(3) 4 } */
277#define MBEDTLS_OID_ECDSA_SHA512 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x04"
278
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]279
280#ifdef __cplusplus
281extern "C" {
282#endif
283
284/**
285 * \brief Base OID descriptor structure
286 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame]287typedef struct {
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]288 const char *MBEDTLS_PRIVATE(asn1); /*!< OID ASN.1 representation */
289 size_t MBEDTLS_PRIVATE(asn1_len); /*!< length of asn1 */
290#if !defined(MBEDTLS_X509_REMOVE_INFO)
291 const char *MBEDTLS_PRIVATE(name); /*!< official name (e.g. from RFC) */
292 const char *MBEDTLS_PRIVATE(description); /*!< human friendly description */
293#endif
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame]294} mbedtls_x509_oid_descriptor_t;
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]295
296/**
297 * \brief Translate an X.509 extension OID into local values
298 *
299 * \param oid OID to use
300 * \param ext_type place to store the extension type
301 *
Gilles Peskine4c832212025-05-07 23:05:12 +0200[diff] [blame]302 * \return 0 if successful, or MBEDTLS_ERR_X509_UNKNOWN_OID
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]303 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame]304int 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]305
306/**
307 * \brief Translate an X.509 attribute type OID into the short name
308 * (e.g. the OID for an X520 Common Name into "CN")
309 *
310 * \param oid OID to use
311 * \param short_name place to store the string pointer
312 *
Gilles Peskine4c832212025-05-07 23:05:12 +0200[diff] [blame]313 * \return 0 if successful, or MBEDTLS_ERR_X509_UNKNOWN_OID
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]314 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame]315int 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]316
317/**
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]318 * \brief Translate SignatureAlgorithm OID into md_type and pk_type
319 *
320 * \param oid OID to use
321 * \param md_alg place to store message digest algorithm
322 * \param pk_alg place to store public key algorithm
323 *
Gilles Peskine4c832212025-05-07 23:05:12 +0200[diff] [blame]324 * \return 0 if successful, or MBEDTLS_ERR_X509_UNKNOWN_OID
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]325 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame]326int mbedtls_x509_oid_get_sig_alg(const mbedtls_asn1_buf *oid,
327 mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]328
329/**
330 * \brief Translate SignatureAlgorithm OID into description
331 *
332 * \param oid OID to use
333 * \param desc place to store string pointer
334 *
Gilles Peskine4c832212025-05-07 23:05:12 +0200[diff] [blame]335 * \return 0 if successful, or MBEDTLS_ERR_X509_UNKNOWN_OID
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]336 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame]337int 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]338
339/**
340 * \brief Translate md_type and pk_type into SignatureAlgorithm OID
341 *
342 * \param md_alg message digest algorithm
343 * \param pk_alg public key algorithm
344 * \param oid place to store ASN.1 OID string pointer
345 * \param olen length of the OID
346 *
Gilles Peskine4c832212025-05-07 23:05:12 +0200[diff] [blame]347 * \return 0 if successful, or MBEDTLS_ERR_X509_UNKNOWN_OID
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]348 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame]349int mbedtls_x509_oid_get_oid_by_sig_alg(mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg,
350 const char **oid, size_t *olen);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]351
352/**
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]353 * \brief Translate hash algorithm OID into md_type
354 *
355 * \param oid OID to use
356 * \param md_alg place to store message digest algorithm
357 *
Gilles Peskine4c832212025-05-07 23:05:12 +0200[diff] [blame]358 * \return 0 if successful, or MBEDTLS_ERR_X509_UNKNOWN_OID
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]359 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame]360int 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]361
362#if !defined(MBEDTLS_X509_REMOVE_INFO)
363/**
364 * \brief Translate Extended Key Usage OID into description
365 *
366 * \param oid OID to use
367 * \param desc place to store string pointer
368 *
Gilles Peskine4c832212025-05-07 23:05:12 +0200[diff] [blame]369 * \return 0 if successful, or MBEDTLS_ERR_X509_UNKNOWN_OID
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]370 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame]371int 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]372#endif
373
374/**
375 * \brief Translate certificate policies OID into description
376 *
377 * \param oid OID to use
378 * \param desc place to store string pointer
379 *
Gilles Peskine4c832212025-05-07 23:05:12 +0200[diff] [blame]380 * \return 0 if successful, or MBEDTLS_ERR_X509_UNKNOWN_OID
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]381 */
Gilles Peskine86e45ba2025-05-07 20:33:39 +0200[diff] [blame]382int mbedtls_x509_oid_get_certificate_policies(const mbedtls_asn1_buf *oid, const char **desc);
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]383
Gilles Peskine47c85792025-05-07 14:35:04 +0200[diff] [blame]384#ifdef __cplusplus
385}
386#endif
387
Gilles Peskineb825dcf2025-05-07 19:41:09 +0200[diff] [blame]388#endif /* x509_oid.h */