1 /**
2  * \file oid.h
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  */
10 #ifndef MBEDTLS_OID_H
11 #define MBEDTLS_OID_H
12 #include "mbedtls/private_access.h"
13 
14 #include "mbedtls/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  */
293 #define MBEDTLS_OID_DES_CBC                     MBEDTLS_OID_ISO_IDENTIFIED_ORG \
294         MBEDTLS_OID_OIW_SECSIG_ALG "\x07"                                                                        /**< desCBC OBJECT IDENTIFIER ::= { iso(1) identified-organization(3) oiw(14) secsig(3) algorithms(2) 7 } */
295 #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 } */
296 #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 } */
297 
298 /*
299  * Key Wrapping algorithms
300  */
301 /*
302  * RFC 5649
303  */
304 #define MBEDTLS_OID_AES128_KW                   MBEDTLS_OID_AES "\x05" /** id-aes128-wrap     OBJECT IDENTIFIER ::= { aes 5 } */
305 #define MBEDTLS_OID_AES128_KWP                  MBEDTLS_OID_AES "\x08" /** id-aes128-wrap-pad OBJECT IDENTIFIER ::= { aes 8 } */
306 #define MBEDTLS_OID_AES192_KW                   MBEDTLS_OID_AES "\x19" /** id-aes192-wrap     OBJECT IDENTIFIER ::= { aes 25 } */
307 #define MBEDTLS_OID_AES192_KWP                  MBEDTLS_OID_AES "\x1c" /** id-aes192-wrap-pad OBJECT IDENTIFIER ::= { aes 28 } */
308 #define MBEDTLS_OID_AES256_KW                   MBEDTLS_OID_AES "\x2d" /** id-aes256-wrap     OBJECT IDENTIFIER ::= { aes 45 } */
309 #define MBEDTLS_OID_AES256_KWP                  MBEDTLS_OID_AES "\x30" /** id-aes256-wrap-pad OBJECT IDENTIFIER ::= { aes 48 } */
310 /*
311  * PKCS#5 OIDs
312  */
313 #define MBEDTLS_OID_PKCS5_PBKDF2                MBEDTLS_OID_PKCS5 "\x0c" /**< id-PBKDF2 OBJECT IDENTIFIER ::= {pkcs-5 12} */
314 #define MBEDTLS_OID_PKCS5_PBES2                 MBEDTLS_OID_PKCS5 "\x0d" /**< id-PBES2 OBJECT IDENTIFIER ::= {pkcs-5 13} */
315 #define MBEDTLS_OID_PKCS5_PBMAC1                MBEDTLS_OID_PKCS5 "\x0e" /**< id-PBMAC1 OBJECT IDENTIFIER ::= {pkcs-5 14} */
316 
317 /*
318  * PKCS#5 PBES1 algorithms
319  */
320 #define MBEDTLS_OID_PKCS5_PBE_MD5_DES_CBC       MBEDTLS_OID_PKCS5 "\x03" /**< pbeWithMD5AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 3} */
321 #define MBEDTLS_OID_PKCS5_PBE_MD5_RC2_CBC       MBEDTLS_OID_PKCS5 "\x06" /**< pbeWithMD5AndRC2-CBC OBJECT IDENTIFIER ::= {pkcs-5 6} */
322 #define MBEDTLS_OID_PKCS5_PBE_SHA1_DES_CBC      MBEDTLS_OID_PKCS5 "\x0a" /**< pbeWithSHA1AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 10} */
323 #define MBEDTLS_OID_PKCS5_PBE_SHA1_RC2_CBC      MBEDTLS_OID_PKCS5 "\x0b" /**< pbeWithSHA1AndRC2-CBC OBJECT IDENTIFIER ::= {pkcs-5 11} */
324 
325 /*
326  * PKCS#7 OIDs
327  */
328 #define MBEDTLS_OID_PKCS7_DATA                        MBEDTLS_OID_PKCS7 "\x01" /**< Content type is Data OBJECT IDENTIFIER ::= {pkcs-7 1} */
329 #define MBEDTLS_OID_PKCS7_SIGNED_DATA                 MBEDTLS_OID_PKCS7 "\x02" /**< Content type is Signed Data OBJECT IDENTIFIER ::= {pkcs-7 2} */
330 #define MBEDTLS_OID_PKCS7_ENVELOPED_DATA              MBEDTLS_OID_PKCS7 "\x03" /**< Content type is Enveloped Data OBJECT IDENTIFIER ::= {pkcs-7 3} */
331 #define MBEDTLS_OID_PKCS7_SIGNED_AND_ENVELOPED_DATA   MBEDTLS_OID_PKCS7 "\x04" /**< Content type is Signed and Enveloped Data OBJECT IDENTIFIER ::= {pkcs-7 4} */
332 #define MBEDTLS_OID_PKCS7_DIGESTED_DATA               MBEDTLS_OID_PKCS7 "\x05" /**< Content type is Digested Data OBJECT IDENTIFIER ::= {pkcs-7 5} */
333 #define MBEDTLS_OID_PKCS7_ENCRYPTED_DATA              MBEDTLS_OID_PKCS7 "\x06" /**< Content type is Encrypted Data OBJECT IDENTIFIER ::= {pkcs-7 6} */
334 
335 /*
336  * PKCS#8 OIDs
337  */
338 #define MBEDTLS_OID_PKCS9_CSR_EXT_REQ           MBEDTLS_OID_PKCS9 "\x0e" /**< extensionRequest OBJECT IDENTIFIER ::= {pkcs-9 14} */
339 
340 /*
341  * PKCS#12 PBE OIDs
342  */
343 #define MBEDTLS_OID_PKCS12_PBE                      MBEDTLS_OID_PKCS12 "\x01" /**< pkcs-12PbeIds OBJECT IDENTIFIER ::= {pkcs-12 1} */
344 
345 #define MBEDTLS_OID_PKCS12_PBE_SHA1_DES3_EDE_CBC    MBEDTLS_OID_PKCS12_PBE "\x03" /**< pbeWithSHAAnd3-KeyTripleDES-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 3} */
346 #define MBEDTLS_OID_PKCS12_PBE_SHA1_DES2_EDE_CBC    MBEDTLS_OID_PKCS12_PBE "\x04" /**< pbeWithSHAAnd2-KeyTripleDES-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 4} */
347 #define MBEDTLS_OID_PKCS12_PBE_SHA1_RC2_128_CBC     MBEDTLS_OID_PKCS12_PBE "\x05" /**< pbeWithSHAAnd128BitRC2-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 5} */
348 #define MBEDTLS_OID_PKCS12_PBE_SHA1_RC2_40_CBC      MBEDTLS_OID_PKCS12_PBE "\x06" /**< pbeWithSHAAnd40BitRC2-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 6} */
349 
350 /*
351  * EC key algorithms from RFC 5480
352  */
353 
354 /* id-ecPublicKey OBJECT IDENTIFIER ::= {
355  *       iso(1) member-body(2) us(840) ansi-X9-62(10045) keyType(2) 1 } */
356 #define MBEDTLS_OID_EC_ALG_UNRESTRICTED         MBEDTLS_OID_ANSI_X9_62 "\x02\01"
357 
358 /*   id-ecDH OBJECT IDENTIFIER ::= {
359  *     iso(1) identified-organization(3) certicom(132)
360  *     schemes(1) ecdh(12) } */
361 #define MBEDTLS_OID_EC_ALG_ECDH                 MBEDTLS_OID_CERTICOM "\x01\x0c"
362 
363 /*
364  * ECParameters namedCurve identifiers, from RFC 5480, RFC 5639, and SEC2
365  */
366 
367 /* secp192r1 OBJECT IDENTIFIER ::= {
368  *   iso(1) member-body(2) us(840) ansi-X9-62(10045) curves(3) prime(1) 1 } */
369 #define MBEDTLS_OID_EC_GRP_SECP192R1        MBEDTLS_OID_ANSI_X9_62 "\x03\x01\x01"
370 
371 /* secp224r1 OBJECT IDENTIFIER ::= {
372  *   iso(1) identified-organization(3) certicom(132) curve(0) 33 } */
373 #define MBEDTLS_OID_EC_GRP_SECP224R1        MBEDTLS_OID_CERTICOM "\x00\x21"
374 
375 /* secp256r1 OBJECT IDENTIFIER ::= {
376  *   iso(1) member-body(2) us(840) ansi-X9-62(10045) curves(3) prime(1) 7 } */
377 #define MBEDTLS_OID_EC_GRP_SECP256R1        MBEDTLS_OID_ANSI_X9_62 "\x03\x01\x07"
378 
379 /* secp384r1 OBJECT IDENTIFIER ::= {
380  *   iso(1) identified-organization(3) certicom(132) curve(0) 34 } */
381 #define MBEDTLS_OID_EC_GRP_SECP384R1        MBEDTLS_OID_CERTICOM "\x00\x22"
382 
383 /* secp521r1 OBJECT IDENTIFIER ::= {
384  *   iso(1) identified-organization(3) certicom(132) curve(0) 35 } */
385 #define MBEDTLS_OID_EC_GRP_SECP521R1        MBEDTLS_OID_CERTICOM "\x00\x23"
386 
387 /* secp192k1 OBJECT IDENTIFIER ::= {
388  *   iso(1) identified-organization(3) certicom(132) curve(0) 31 } */
389 #define MBEDTLS_OID_EC_GRP_SECP192K1        MBEDTLS_OID_CERTICOM "\x00\x1f"
390 
391 /* secp224k1 OBJECT IDENTIFIER ::= {
392  *   iso(1) identified-organization(3) certicom(132) curve(0) 32 } */
393 #define MBEDTLS_OID_EC_GRP_SECP224K1        MBEDTLS_OID_CERTICOM "\x00\x20"
394 
395 /* secp256k1 OBJECT IDENTIFIER ::= {
396  *   iso(1) identified-organization(3) certicom(132) curve(0) 10 } */
397 #define MBEDTLS_OID_EC_GRP_SECP256K1        MBEDTLS_OID_CERTICOM "\x00\x0a"
398 
399 /* RFC 5639 4.1
400  * ecStdCurvesAndGeneration OBJECT IDENTIFIER::= {iso(1)
401  * identified-organization(3) teletrust(36) algorithm(3) signature-
402  * algorithm(3) ecSign(2) 8}
403  * ellipticCurve OBJECT IDENTIFIER ::= {ecStdCurvesAndGeneration 1}
404  * versionOne OBJECT IDENTIFIER ::= {ellipticCurve 1} */
405 #define MBEDTLS_OID_EC_BRAINPOOL_V1         MBEDTLS_OID_TELETRUST "\x03\x03\x02\x08\x01\x01"
406 
407 /* brainpoolP256r1 OBJECT IDENTIFIER ::= {versionOne 7} */
408 #define MBEDTLS_OID_EC_GRP_BP256R1          MBEDTLS_OID_EC_BRAINPOOL_V1 "\x07"
409 
410 /* brainpoolP384r1 OBJECT IDENTIFIER ::= {versionOne 11} */
411 #define MBEDTLS_OID_EC_GRP_BP384R1          MBEDTLS_OID_EC_BRAINPOOL_V1 "\x0B"
412 
413 /* brainpoolP512r1 OBJECT IDENTIFIER ::= {versionOne 13} */
414 #define MBEDTLS_OID_EC_GRP_BP512R1          MBEDTLS_OID_EC_BRAINPOOL_V1 "\x0D"
415 
416 /*
417  * SEC1 C.1
418  *
419  * prime-field OBJECT IDENTIFIER ::= { id-fieldType 1 }
420  * id-fieldType OBJECT IDENTIFIER ::= { ansi-X9-62 fieldType(1)}
421  */
422 #define MBEDTLS_OID_ANSI_X9_62_FIELD_TYPE   MBEDTLS_OID_ANSI_X9_62 "\x01"
423 #define MBEDTLS_OID_ANSI_X9_62_PRIME_FIELD  MBEDTLS_OID_ANSI_X9_62_FIELD_TYPE "\x01"
424 
425 /*
426  * ECDSA signature identifiers, from RFC 5480
427  */
428 #define MBEDTLS_OID_ANSI_X9_62_SIG          MBEDTLS_OID_ANSI_X9_62 "\x04" /* signatures(4) */
429 #define MBEDTLS_OID_ANSI_X9_62_SIG_SHA2     MBEDTLS_OID_ANSI_X9_62_SIG "\x03" /* ecdsa-with-SHA2(3) */
430 
431 /* ecdsa-with-SHA1 OBJECT IDENTIFIER ::= {
432  *   iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4) 1 } */
433 #define MBEDTLS_OID_ECDSA_SHA1              MBEDTLS_OID_ANSI_X9_62_SIG "\x01"
434 
435 /* ecdsa-with-SHA224 OBJECT IDENTIFIER ::= {
436  *   iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
437  *   ecdsa-with-SHA2(3) 1 } */
438 #define MBEDTLS_OID_ECDSA_SHA224            MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x01"
439 
440 /* ecdsa-with-SHA256 OBJECT IDENTIFIER ::= {
441  *   iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
442  *   ecdsa-with-SHA2(3) 2 } */
443 #define MBEDTLS_OID_ECDSA_SHA256            MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x02"
444 
445 /* ecdsa-with-SHA384 OBJECT IDENTIFIER ::= {
446  *   iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
447  *   ecdsa-with-SHA2(3) 3 } */
448 #define MBEDTLS_OID_ECDSA_SHA384            MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x03"
449 
450 /* ecdsa-with-SHA512 OBJECT IDENTIFIER ::= {
451  *   iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
452  *   ecdsa-with-SHA2(3) 4 } */
453 #define MBEDTLS_OID_ECDSA_SHA512            MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x04"
454 
455 /*
456  * EC key algorithms from RFC 8410
457  */
458 
459 #define MBEDTLS_OID_X25519                  MBEDTLS_OID_THAWTE "\x6e" /**< id-X25519    OBJECT IDENTIFIER ::= { 1 3 101 110 } */
460 #define MBEDTLS_OID_X448                    MBEDTLS_OID_THAWTE "\x6f" /**< id-X448      OBJECT IDENTIFIER ::= { 1 3 101 111 } */
461 #define MBEDTLS_OID_ED25519                 MBEDTLS_OID_THAWTE "\x70" /**< id-Ed25519   OBJECT IDENTIFIER ::= { 1 3 101 112 } */
462 #define MBEDTLS_OID_ED448                   MBEDTLS_OID_THAWTE "\x71" /**< id-Ed448     OBJECT IDENTIFIER ::= { 1 3 101 113 } */
463 
464 #ifdef __cplusplus
465 extern "C" {
466 #endif
467 
468 /**
469  * \brief Base OID descriptor structure
470  */
471 typedef struct mbedtls_oid_descriptor_t {
472     const char *MBEDTLS_PRIVATE(asn1);               /*!< OID ASN.1 representation       */
473     size_t MBEDTLS_PRIVATE(asn1_len);                /*!< length of asn1                 */
474 #if !defined(MBEDTLS_X509_REMOVE_INFO)
475     const char *MBEDTLS_PRIVATE(name);               /*!< official name (e.g. from RFC)  */
476     const char *MBEDTLS_PRIVATE(description);        /*!< human friendly description     */
477 #endif
478 } mbedtls_oid_descriptor_t;
479 
480 /**
481  * \brief           Translate an ASN.1 OID into its numeric representation
482  *                  (e.g. "\x2A\x86\x48\x86\xF7\x0D" into "1.2.840.113549")
483  *
484  * \param buf       buffer to put representation in
485  * \param size      size of the buffer
486  * \param oid       OID to translate
487  *
488  * \return          Length of the string written (excluding final NULL) or
489  *                  MBEDTLS_ERR_OID_BUF_TOO_SMALL in case of error
490  */
491 int mbedtls_oid_get_numeric_string(char *buf, size_t size, const mbedtls_asn1_buf *oid);
492 
493 /**
494  * \brief           Translate a string containing a dotted-decimal
495  *                  representation of an ASN.1 OID into its encoded form
496  *                  (e.g. "1.2.840.113549" into "\x2A\x86\x48\x86\xF7\x0D").
497  *                  On success, this function allocates oid->buf from the
498  *                  heap. It must be freed by the caller using mbedtls_free().
499  *
500  * \param oid       #mbedtls_asn1_buf to populate with the DER-encoded OID
501  * \param oid_str   string representation of the OID to parse
502  * \param size      length of the OID string, not including any null terminator
503  *
504  * \return          0 if successful
505  * \return          #MBEDTLS_ERR_ASN1_INVALID_DATA if \p oid_str does not
506  *                  represent a valid OID
507  * \return          #MBEDTLS_ERR_ASN1_ALLOC_FAILED if the function fails to
508  *                  allocate oid->buf
509  */
510 int mbedtls_oid_from_numeric_string(mbedtls_asn1_buf *oid, const char *oid_str, size_t size);
511 
512 /**
513  * \brief          Translate an X.509 extension OID into local values
514  *
515  * \param oid      OID to use
516  * \param ext_type place to store the extension type
517  *
518  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
519  */
520 int mbedtls_oid_get_x509_ext_type(const mbedtls_asn1_buf *oid, int *ext_type);
521 
522 /**
523  * \brief          Translate an X.509 attribute type OID into the short name
524  *                 (e.g. the OID for an X520 Common Name into "CN")
525  *
526  * \param oid      OID to use
527  * \param short_name    place to store the string pointer
528  *
529  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
530  */
531 int mbedtls_oid_get_attr_short_name(const mbedtls_asn1_buf *oid, const char **short_name);
532 
533 /**
534  * \brief          Translate PublicKeyAlgorithm OID into pk_type
535  *
536  * \param oid      OID to use
537  * \param pk_alg   place to store public key algorithm
538  *
539  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
540  */
541 int mbedtls_oid_get_pk_alg(const mbedtls_asn1_buf *oid, mbedtls_pk_type_t *pk_alg);
542 
543 /**
544  * \brief          Translate pk_type into PublicKeyAlgorithm OID
545  *
546  * \param pk_alg   Public key type to look for
547  * \param oid      place to store ASN.1 OID string pointer
548  * \param olen     length of the OID
549  *
550  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
551  */
552 int mbedtls_oid_get_oid_by_pk_alg(mbedtls_pk_type_t pk_alg,
553                                   const char **oid, size_t *olen);
554 
555 #if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
556 /**
557  * \brief          Translate NamedCurve OID into an EC group identifier
558  *
559  * \param oid      OID to use
560  * \param grp_id   place to store group id
561  *
562  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
563  */
564 int mbedtls_oid_get_ec_grp(const mbedtls_asn1_buf *oid, mbedtls_ecp_group_id *grp_id);
565 
566 /**
567  * \brief          Translate EC group identifier into NamedCurve OID
568  *
569  * \param grp_id   EC group identifier
570  * \param oid      place to store ASN.1 OID string pointer
571  * \param olen     length of the OID
572  *
573  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
574  */
575 int mbedtls_oid_get_oid_by_ec_grp(mbedtls_ecp_group_id grp_id,
576                                   const char **oid, size_t *olen);
577 
578 /**
579  * \brief          Translate AlgorithmIdentifier OID into an EC group identifier,
580  *                 for curves that are directly encoded at this level
581  *
582  * \param oid      OID to use
583  * \param grp_id   place to store group id
584  *
585  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
586  */
587 int mbedtls_oid_get_ec_grp_algid(const mbedtls_asn1_buf *oid, mbedtls_ecp_group_id *grp_id);
588 
589 /**
590  * \brief          Translate EC group identifier into AlgorithmIdentifier OID,
591  *                 for curves that are directly encoded at this level
592  *
593  * \param grp_id   EC group identifier
594  * \param oid      place to store ASN.1 OID string pointer
595  * \param olen     length of the OID
596  *
597  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
598  */
599 int mbedtls_oid_get_oid_by_ec_grp_algid(mbedtls_ecp_group_id grp_id,
600                                         const char **oid, size_t *olen);
601 #endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
602 
603 /**
604  * \brief          Translate SignatureAlgorithm OID into md_type and pk_type
605  *
606  * \param oid      OID to use
607  * \param md_alg   place to store message digest algorithm
608  * \param pk_alg   place to store public key algorithm
609  *
610  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
611  */
612 int mbedtls_oid_get_sig_alg(const mbedtls_asn1_buf *oid,
613                             mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg);
614 
615 /**
616  * \brief          Translate SignatureAlgorithm OID into description
617  *
618  * \param oid      OID to use
619  * \param desc     place to store string pointer
620  *
621  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
622  */
623 int mbedtls_oid_get_sig_alg_desc(const mbedtls_asn1_buf *oid, const char **desc);
624 
625 /**
626  * \brief          Translate md_type and pk_type into SignatureAlgorithm OID
627  *
628  * \param md_alg   message digest algorithm
629  * \param pk_alg   public key algorithm
630  * \param oid      place to store ASN.1 OID string pointer
631  * \param olen     length of the OID
632  *
633  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
634  */
635 int mbedtls_oid_get_oid_by_sig_alg(mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg,
636                                    const char **oid, size_t *olen);
637 
638 /**
639  * \brief          Translate hmac algorithm OID into md_type
640  *
641  * \param oid      OID to use
642  * \param md_hmac  place to store message hmac algorithm
643  *
644  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
645  */
646 int mbedtls_oid_get_md_hmac(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_hmac);
647 
648 /**
649  * \brief          Translate hash algorithm OID into md_type
650  *
651  * \param oid      OID to use
652  * \param md_alg   place to store message digest algorithm
653  *
654  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
655  */
656 int mbedtls_oid_get_md_alg(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_alg);
657 
658 #if !defined(MBEDTLS_X509_REMOVE_INFO)
659 /**
660  * \brief          Translate Extended Key Usage OID into description
661  *
662  * \param oid      OID to use
663  * \param desc     place to store string pointer
664  *
665  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
666  */
667 int mbedtls_oid_get_extended_key_usage(const mbedtls_asn1_buf *oid, const char **desc);
668 #endif
669 
670 /**
671  * \brief          Translate certificate policies OID into description
672  *
673  * \param oid      OID to use
674  * \param desc     place to store string pointer
675  *
676  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
677  */
678 int mbedtls_oid_get_certificate_policies(const mbedtls_asn1_buf *oid, const char **desc);
679 
680 /**
681  * \brief          Translate md_type into hash algorithm OID
682  *
683  * \param md_alg   message digest algorithm
684  * \param oid      place to store ASN.1 OID string pointer
685  * \param olen     length of the OID
686  *
687  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
688  */
689 int mbedtls_oid_get_oid_by_md(mbedtls_md_type_t md_alg, const char **oid, size_t *olen);
690 
691 #if defined(MBEDTLS_CIPHER_C)
692 /**
693  * \brief          Translate encryption algorithm OID into cipher_type
694  *
695  * \param oid           OID to use
696  * \param cipher_alg    place to store cipher algorithm
697  *
698  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
699  */
700 int mbedtls_oid_get_cipher_alg(const mbedtls_asn1_buf *oid, mbedtls_cipher_type_t *cipher_alg);
701 #endif /* MBEDTLS_CIPHER_C */
702 
703 #if defined(MBEDTLS_PKCS12_C)
704 /**
705  * \brief          Translate PKCS#12 PBE algorithm OID into md_type and
706  *                 cipher_type
707  *
708  * \param oid           OID to use
709  * \param md_alg        place to store message digest algorithm
710  * \param cipher_alg    place to store cipher algorithm
711  *
712  * \return         0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
713  */
714 int mbedtls_oid_get_pkcs12_pbe_alg(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_alg,
715                                    mbedtls_cipher_type_t *cipher_alg);
716 #endif /* MBEDTLS_PKCS12_C */
717 
718 #ifdef __cplusplus
719 }
720 #endif
721 
722 #endif /* oid.h */
723