Mbed TLS v3.5.0
oid.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright The Mbed TLS Contributors
8  * SPDX-License-Identifier: Apache-2.0
9  *
10  * Licensed under the Apache License, Version 2.0 (the "License"); you may
11  * not use this file except in compliance with the License.
12  * You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing, software
17  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19  * See the License for the specific language governing permissions and
20  * limitations under the License.
21  */
22 #ifndef MBEDTLS_OID_H
23 #define MBEDTLS_OID_H
24 #include "mbedtls/private_access.h"
25 
26 #include "mbedtls/build_info.h"
27 
28 #include "mbedtls/asn1.h"
29 #include "mbedtls/pk.h"
30 
31 #include <stddef.h>
32 
33 #if defined(MBEDTLS_CIPHER_C)
34 #include "mbedtls/cipher.h"
35 #endif
36 
37 #include "mbedtls/md.h"
38 
40 #define MBEDTLS_ERR_OID_NOT_FOUND -0x002E
42 #define MBEDTLS_ERR_OID_BUF_TOO_SMALL -0x000B
43 
44 /* This is for the benefit of X.509, but defined here in order to avoid
45  * having a "backwards" include of x.509.h here */
46 /*
47  * X.509 extension types (internal, arbitrary values for bitsets)
48  */
49 #define MBEDTLS_OID_X509_EXT_AUTHORITY_KEY_IDENTIFIER (1 << 0)
50 #define MBEDTLS_OID_X509_EXT_SUBJECT_KEY_IDENTIFIER (1 << 1)
51 #define MBEDTLS_OID_X509_EXT_KEY_USAGE (1 << 2)
52 #define MBEDTLS_OID_X509_EXT_CERTIFICATE_POLICIES (1 << 3)
53 #define MBEDTLS_OID_X509_EXT_POLICY_MAPPINGS (1 << 4)
54 #define MBEDTLS_OID_X509_EXT_SUBJECT_ALT_NAME (1 << 5)
55 #define MBEDTLS_OID_X509_EXT_ISSUER_ALT_NAME (1 << 6)
56 #define MBEDTLS_OID_X509_EXT_SUBJECT_DIRECTORY_ATTRS (1 << 7)
57 #define MBEDTLS_OID_X509_EXT_BASIC_CONSTRAINTS (1 << 8)
58 #define MBEDTLS_OID_X509_EXT_NAME_CONSTRAINTS (1 << 9)
59 #define MBEDTLS_OID_X509_EXT_POLICY_CONSTRAINTS (1 << 10)
60 #define MBEDTLS_OID_X509_EXT_EXTENDED_KEY_USAGE (1 << 11)
61 #define MBEDTLS_OID_X509_EXT_CRL_DISTRIBUTION_POINTS (1 << 12)
62 #define MBEDTLS_OID_X509_EXT_INIHIBIT_ANYPOLICY (1 << 13)
63 #define MBEDTLS_OID_X509_EXT_FRESHEST_CRL (1 << 14)
64 #define MBEDTLS_OID_X509_EXT_NS_CERT_TYPE (1 << 16)
65 
66 /*
67  * Maximum number of OID components allowed
68  */
69 #define MBEDTLS_OID_MAX_COMPONENTS 128
70 
71 /*
72  * Top level OID tuples
73  */
74 #define MBEDTLS_OID_ISO_MEMBER_BODIES "\x2a" /* {iso(1) member-body(2)} */
75 #define MBEDTLS_OID_ISO_IDENTIFIED_ORG "\x2b" /* {iso(1) identified-organization(3)} */
76 #define MBEDTLS_OID_ISO_CCITT_DS "\x55" /* {joint-iso-ccitt(2) ds(5)} */
77 #define MBEDTLS_OID_ISO_ITU_COUNTRY "\x60" /* {joint-iso-itu-t(2) country(16)} */
78 
79 /*
80  * ISO Member bodies OID parts
81  */
82 #define MBEDTLS_OID_COUNTRY_US "\x86\x48" /* {us(840)} */
83 #define MBEDTLS_OID_ORG_RSA_DATA_SECURITY "\x86\xf7\x0d" /* {rsadsi(113549)} */
84 #define MBEDTLS_OID_RSA_COMPANY MBEDTLS_OID_ISO_MEMBER_BODIES MBEDTLS_OID_COUNTRY_US \
85  MBEDTLS_OID_ORG_RSA_DATA_SECURITY /* {iso(1) member-body(2) us(840) rsadsi(113549)} */
86 #define MBEDTLS_OID_ORG_ANSI_X9_62 "\xce\x3d" /* ansi-X9-62(10045) */
87 #define MBEDTLS_OID_ANSI_X9_62 MBEDTLS_OID_ISO_MEMBER_BODIES MBEDTLS_OID_COUNTRY_US \
88  MBEDTLS_OID_ORG_ANSI_X9_62
89 
90 /*
91  * ISO Identified organization OID parts
92  */
93 #define MBEDTLS_OID_ORG_DOD "\x06" /* {dod(6)} */
94 #define MBEDTLS_OID_ORG_OIW "\x0e"
95 #define MBEDTLS_OID_OIW_SECSIG MBEDTLS_OID_ORG_OIW "\x03"
96 #define MBEDTLS_OID_OIW_SECSIG_ALG MBEDTLS_OID_OIW_SECSIG "\x02"
97 #define MBEDTLS_OID_OIW_SECSIG_SHA1 MBEDTLS_OID_OIW_SECSIG_ALG "\x1a"
98 #define MBEDTLS_OID_ORG_THAWTE "\x65" /* thawte(101) */
99 #define MBEDTLS_OID_THAWTE MBEDTLS_OID_ISO_IDENTIFIED_ORG \
100  MBEDTLS_OID_ORG_THAWTE
101 #define MBEDTLS_OID_ORG_CERTICOM "\x81\x04" /* certicom(132) */
102 #define MBEDTLS_OID_CERTICOM MBEDTLS_OID_ISO_IDENTIFIED_ORG \
103  MBEDTLS_OID_ORG_CERTICOM
104 #define MBEDTLS_OID_ORG_TELETRUST "\x24" /* teletrust(36) */
105 #define MBEDTLS_OID_TELETRUST MBEDTLS_OID_ISO_IDENTIFIED_ORG \
106  MBEDTLS_OID_ORG_TELETRUST
107 
108 /*
109  * ISO ITU OID parts
110  */
111 #define MBEDTLS_OID_ORGANIZATION "\x01" /* {organization(1)} */
112 #define MBEDTLS_OID_ISO_ITU_US_ORG MBEDTLS_OID_ISO_ITU_COUNTRY MBEDTLS_OID_COUNTRY_US \
113  MBEDTLS_OID_ORGANIZATION /* {joint-iso-itu-t(2) country(16) us(840) organization(1)} */
114 
115 #define MBEDTLS_OID_ORG_GOV "\x65" /* {gov(101)} */
116 #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)} */
117 
118 #define MBEDTLS_OID_ORG_NETSCAPE "\x86\xF8\x42" /* {netscape(113730)} */
119 #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)} */
120 
121 /* ISO arc for standard certificate and CRL extensions */
122 #define MBEDTLS_OID_ID_CE MBEDTLS_OID_ISO_CCITT_DS "\x1D"
124 #define MBEDTLS_OID_NIST_ALG MBEDTLS_OID_GOV "\x03\x04"
131 #define MBEDTLS_OID_INTERNET MBEDTLS_OID_ISO_IDENTIFIED_ORG MBEDTLS_OID_ORG_DOD \
132  "\x01"
133 #define MBEDTLS_OID_PKIX MBEDTLS_OID_INTERNET "\x05\x05\x07"
134 
135 /*
136  * Arc for standard naming attributes
137  */
138 #define MBEDTLS_OID_AT MBEDTLS_OID_ISO_CCITT_DS "\x04"
139 #define MBEDTLS_OID_AT_CN MBEDTLS_OID_AT "\x03"
140 #define MBEDTLS_OID_AT_SUR_NAME MBEDTLS_OID_AT "\x04"
141 #define MBEDTLS_OID_AT_SERIAL_NUMBER MBEDTLS_OID_AT "\x05"
142 #define MBEDTLS_OID_AT_COUNTRY MBEDTLS_OID_AT "\x06"
143 #define MBEDTLS_OID_AT_LOCALITY MBEDTLS_OID_AT "\x07"
144 #define MBEDTLS_OID_AT_STATE MBEDTLS_OID_AT "\x08"
145 #define MBEDTLS_OID_AT_ORGANIZATION MBEDTLS_OID_AT "\x0A"
146 #define MBEDTLS_OID_AT_ORG_UNIT MBEDTLS_OID_AT "\x0B"
147 #define MBEDTLS_OID_AT_TITLE MBEDTLS_OID_AT "\x0C"
148 #define MBEDTLS_OID_AT_POSTAL_ADDRESS MBEDTLS_OID_AT "\x10"
149 #define MBEDTLS_OID_AT_POSTAL_CODE MBEDTLS_OID_AT "\x11"
150 #define MBEDTLS_OID_AT_GIVEN_NAME MBEDTLS_OID_AT "\x2A"
151 #define MBEDTLS_OID_AT_INITIALS MBEDTLS_OID_AT "\x2B"
152 #define MBEDTLS_OID_AT_GENERATION_QUALIFIER MBEDTLS_OID_AT "\x2C"
153 #define MBEDTLS_OID_AT_UNIQUE_IDENTIFIER MBEDTLS_OID_AT "\x2D"
154 #define MBEDTLS_OID_AT_DN_QUALIFIER MBEDTLS_OID_AT "\x2E"
155 #define MBEDTLS_OID_AT_PSEUDONYM MBEDTLS_OID_AT "\x41"
157 #define MBEDTLS_OID_UID "\x09\x92\x26\x89\x93\xF2\x2C\x64\x01\x01"
158 #define MBEDTLS_OID_DOMAIN_COMPONENT "\x09\x92\x26\x89\x93\xF2\x2C\x64\x01\x19"
160 /*
161  * OIDs for standard certificate extensions
162  */
163 #define MBEDTLS_OID_AUTHORITY_KEY_IDENTIFIER MBEDTLS_OID_ID_CE "\x23"
164 #define MBEDTLS_OID_SUBJECT_KEY_IDENTIFIER MBEDTLS_OID_ID_CE "\x0E"
165 #define MBEDTLS_OID_KEY_USAGE MBEDTLS_OID_ID_CE "\x0F"
166 #define MBEDTLS_OID_CERTIFICATE_POLICIES MBEDTLS_OID_ID_CE "\x20"
167 #define MBEDTLS_OID_POLICY_MAPPINGS MBEDTLS_OID_ID_CE "\x21"
168 #define MBEDTLS_OID_SUBJECT_ALT_NAME MBEDTLS_OID_ID_CE "\x11"
169 #define MBEDTLS_OID_ISSUER_ALT_NAME MBEDTLS_OID_ID_CE "\x12"
170 #define MBEDTLS_OID_SUBJECT_DIRECTORY_ATTRS MBEDTLS_OID_ID_CE "\x09"
171 #define MBEDTLS_OID_BASIC_CONSTRAINTS MBEDTLS_OID_ID_CE "\x13"
172 #define MBEDTLS_OID_NAME_CONSTRAINTS MBEDTLS_OID_ID_CE "\x1E"
173 #define MBEDTLS_OID_POLICY_CONSTRAINTS MBEDTLS_OID_ID_CE "\x24"
174 #define MBEDTLS_OID_EXTENDED_KEY_USAGE MBEDTLS_OID_ID_CE "\x25"
175 #define MBEDTLS_OID_CRL_DISTRIBUTION_POINTS MBEDTLS_OID_ID_CE "\x1F"
176 #define MBEDTLS_OID_INIHIBIT_ANYPOLICY MBEDTLS_OID_ID_CE "\x36"
177 #define MBEDTLS_OID_FRESHEST_CRL MBEDTLS_OID_ID_CE "\x2E"
179 /*
180  * Certificate policies
181  */
182 #define MBEDTLS_OID_ANY_POLICY MBEDTLS_OID_CERTIFICATE_POLICIES "\x00"
184 /*
185  * Netscape certificate extensions
186  */
187 #define MBEDTLS_OID_NS_CERT MBEDTLS_OID_NETSCAPE "\x01"
188 #define MBEDTLS_OID_NS_CERT_TYPE MBEDTLS_OID_NS_CERT "\x01"
189 #define MBEDTLS_OID_NS_BASE_URL MBEDTLS_OID_NS_CERT "\x02"
190 #define MBEDTLS_OID_NS_REVOCATION_URL MBEDTLS_OID_NS_CERT "\x03"
191 #define MBEDTLS_OID_NS_CA_REVOCATION_URL MBEDTLS_OID_NS_CERT "\x04"
192 #define MBEDTLS_OID_NS_RENEWAL_URL MBEDTLS_OID_NS_CERT "\x07"
193 #define MBEDTLS_OID_NS_CA_POLICY_URL MBEDTLS_OID_NS_CERT "\x08"
194 #define MBEDTLS_OID_NS_SSL_SERVER_NAME MBEDTLS_OID_NS_CERT "\x0C"
195 #define MBEDTLS_OID_NS_COMMENT MBEDTLS_OID_NS_CERT "\x0D"
196 #define MBEDTLS_OID_NS_DATA_TYPE MBEDTLS_OID_NETSCAPE "\x02"
197 #define MBEDTLS_OID_NS_CERT_SEQUENCE MBEDTLS_OID_NS_DATA_TYPE "\x05"
198 
199 /*
200  * OIDs for CRL extensions
201  */
202 #define MBEDTLS_OID_PRIVATE_KEY_USAGE_PERIOD MBEDTLS_OID_ID_CE "\x10"
203 #define MBEDTLS_OID_CRL_NUMBER MBEDTLS_OID_ID_CE "\x14"
205 /*
206  * X.509 v3 Extended key usage OIDs
207  */
208 #define MBEDTLS_OID_ANY_EXTENDED_KEY_USAGE MBEDTLS_OID_EXTENDED_KEY_USAGE "\x00"
210 #define MBEDTLS_OID_KP MBEDTLS_OID_PKIX "\x03"
211 #define MBEDTLS_OID_SERVER_AUTH MBEDTLS_OID_KP "\x01"
212 #define MBEDTLS_OID_CLIENT_AUTH MBEDTLS_OID_KP "\x02"
213 #define MBEDTLS_OID_CODE_SIGNING MBEDTLS_OID_KP "\x03"
214 #define MBEDTLS_OID_EMAIL_PROTECTION MBEDTLS_OID_KP "\x04"
215 #define MBEDTLS_OID_TIME_STAMPING MBEDTLS_OID_KP "\x08"
216 #define MBEDTLS_OID_OCSP_SIGNING MBEDTLS_OID_KP "\x09"
223 #define MBEDTLS_OID_WISUN_FAN MBEDTLS_OID_INTERNET "\x04\x01\x82\xe4\x25\x01"
224 
225 #define MBEDTLS_OID_ON MBEDTLS_OID_PKIX "\x08"
226 #define MBEDTLS_OID_ON_HW_MODULE_NAME MBEDTLS_OID_ON "\x04"
228 /*
229  * PKCS definition OIDs
230  */
231 
232 #define MBEDTLS_OID_PKCS MBEDTLS_OID_RSA_COMPANY "\x01"
233 #define MBEDTLS_OID_PKCS1 MBEDTLS_OID_PKCS "\x01"
234 #define MBEDTLS_OID_PKCS5 MBEDTLS_OID_PKCS "\x05"
235 #define MBEDTLS_OID_PKCS7 MBEDTLS_OID_PKCS "\x07"
236 #define MBEDTLS_OID_PKCS9 MBEDTLS_OID_PKCS "\x09"
237 #define MBEDTLS_OID_PKCS12 MBEDTLS_OID_PKCS "\x0c"
239 /*
240  * PKCS#1 OIDs
241  */
242 #define MBEDTLS_OID_PKCS1_RSA MBEDTLS_OID_PKCS1 "\x01"
243 #define MBEDTLS_OID_PKCS1_MD5 MBEDTLS_OID_PKCS1 "\x04"
244 #define MBEDTLS_OID_PKCS1_SHA1 MBEDTLS_OID_PKCS1 "\x05"
245 #define MBEDTLS_OID_PKCS1_SHA224 MBEDTLS_OID_PKCS1 "\x0e"
246 #define MBEDTLS_OID_PKCS1_SHA256 MBEDTLS_OID_PKCS1 "\x0b"
247 #define MBEDTLS_OID_PKCS1_SHA384 MBEDTLS_OID_PKCS1 "\x0c"
248 #define MBEDTLS_OID_PKCS1_SHA512 MBEDTLS_OID_PKCS1 "\x0d"
250 #define MBEDTLS_OID_RSA_SHA_OBS "\x2B\x0E\x03\x02\x1D"
251 
252 #define MBEDTLS_OID_PKCS9_EMAIL MBEDTLS_OID_PKCS9 "\x01"
254 /* RFC 4055 */
255 #define MBEDTLS_OID_RSASSA_PSS MBEDTLS_OID_PKCS1 "\x0a"
256 #define MBEDTLS_OID_MGF1 MBEDTLS_OID_PKCS1 "\x08"
258 /*
259  * Digest algorithms
260  */
261 #define MBEDTLS_OID_DIGEST_ALG_MD5 MBEDTLS_OID_RSA_COMPANY "\x02\x05"
262 #define MBEDTLS_OID_DIGEST_ALG_SHA1 MBEDTLS_OID_ISO_IDENTIFIED_ORG \
263  MBEDTLS_OID_OIW_SECSIG_SHA1
264 #define MBEDTLS_OID_DIGEST_ALG_SHA224 MBEDTLS_OID_NIST_ALG "\x02\x04"
265 #define MBEDTLS_OID_DIGEST_ALG_SHA256 MBEDTLS_OID_NIST_ALG "\x02\x01"
267 #define MBEDTLS_OID_DIGEST_ALG_SHA384 MBEDTLS_OID_NIST_ALG "\x02\x02"
269 #define MBEDTLS_OID_DIGEST_ALG_SHA512 MBEDTLS_OID_NIST_ALG "\x02\x03"
271 #define MBEDTLS_OID_DIGEST_ALG_RIPEMD160 MBEDTLS_OID_TELETRUST "\x03\x02\x01"
273 #define MBEDTLS_OID_DIGEST_ALG_SHA3_224 MBEDTLS_OID_NIST_ALG "\x02\x07"
275 #define MBEDTLS_OID_DIGEST_ALG_SHA3_256 MBEDTLS_OID_NIST_ALG "\x02\x08"
277 #define MBEDTLS_OID_DIGEST_ALG_SHA3_384 MBEDTLS_OID_NIST_ALG "\x02\x09"
279 #define MBEDTLS_OID_DIGEST_ALG_SHA3_512 MBEDTLS_OID_NIST_ALG "\x02\x0a"
282 #define MBEDTLS_OID_HMAC_SHA1 MBEDTLS_OID_RSA_COMPANY "\x02\x07"
284 #define MBEDTLS_OID_HMAC_SHA224 MBEDTLS_OID_RSA_COMPANY "\x02\x08"
286 #define MBEDTLS_OID_HMAC_SHA256 MBEDTLS_OID_RSA_COMPANY "\x02\x09"
288 #define MBEDTLS_OID_HMAC_SHA384 MBEDTLS_OID_RSA_COMPANY "\x02\x0A"
290 #define MBEDTLS_OID_HMAC_SHA512 MBEDTLS_OID_RSA_COMPANY "\x02\x0B"
292 #define MBEDTLS_OID_HMAC_SHA3_224 MBEDTLS_OID_NIST_ALG "\x02\x0d"
294 #define MBEDTLS_OID_HMAC_SHA3_256 MBEDTLS_OID_NIST_ALG "\x02\x0e"
296 #define MBEDTLS_OID_HMAC_SHA3_384 MBEDTLS_OID_NIST_ALG "\x02\x0f"
298 #define MBEDTLS_OID_HMAC_SHA3_512 MBEDTLS_OID_NIST_ALG "\x02\x10"
300 #define MBEDTLS_OID_HMAC_RIPEMD160 MBEDTLS_OID_INTERNET "\x05\x05\x08\x01\x04"
302 /*
303  * Encryption algorithms
304  */
305 #define MBEDTLS_OID_DES_CBC MBEDTLS_OID_ISO_IDENTIFIED_ORG \
306  MBEDTLS_OID_OIW_SECSIG_ALG "\x07"
307 #define MBEDTLS_OID_DES_EDE3_CBC MBEDTLS_OID_RSA_COMPANY "\x03\x07"
308 #define MBEDTLS_OID_AES MBEDTLS_OID_NIST_ALG "\x01"
310 /*
311  * Key Wrapping algorithms
312  */
313 /*
314  * RFC 5649
315  */
316 #define MBEDTLS_OID_AES128_KW MBEDTLS_OID_AES "\x05"
317 #define MBEDTLS_OID_AES128_KWP MBEDTLS_OID_AES "\x08"
318 #define MBEDTLS_OID_AES192_KW MBEDTLS_OID_AES "\x19"
319 #define MBEDTLS_OID_AES192_KWP MBEDTLS_OID_AES "\x1c"
320 #define MBEDTLS_OID_AES256_KW MBEDTLS_OID_AES "\x2d"
321 #define MBEDTLS_OID_AES256_KWP MBEDTLS_OID_AES "\x30"
322 /*
323  * PKCS#5 OIDs
324  */
325 #define MBEDTLS_OID_PKCS5_PBKDF2 MBEDTLS_OID_PKCS5 "\x0c"
326 #define MBEDTLS_OID_PKCS5_PBES2 MBEDTLS_OID_PKCS5 "\x0d"
327 #define MBEDTLS_OID_PKCS5_PBMAC1 MBEDTLS_OID_PKCS5 "\x0e"
329 /*
330  * PKCS#5 PBES1 algorithms
331  */
332 #define MBEDTLS_OID_PKCS5_PBE_MD5_DES_CBC MBEDTLS_OID_PKCS5 "\x03"
333 #define MBEDTLS_OID_PKCS5_PBE_MD5_RC2_CBC MBEDTLS_OID_PKCS5 "\x06"
334 #define MBEDTLS_OID_PKCS5_PBE_SHA1_DES_CBC MBEDTLS_OID_PKCS5 "\x0a"
335 #define MBEDTLS_OID_PKCS5_PBE_SHA1_RC2_CBC MBEDTLS_OID_PKCS5 "\x0b"
337 /*
338  * PKCS#7 OIDs
339  */
340 #define MBEDTLS_OID_PKCS7_DATA MBEDTLS_OID_PKCS7 "\x01"
341 #define MBEDTLS_OID_PKCS7_SIGNED_DATA MBEDTLS_OID_PKCS7 "\x02"
342 #define MBEDTLS_OID_PKCS7_ENVELOPED_DATA MBEDTLS_OID_PKCS7 "\x03"
343 #define MBEDTLS_OID_PKCS7_SIGNED_AND_ENVELOPED_DATA MBEDTLS_OID_PKCS7 "\x04"
344 #define MBEDTLS_OID_PKCS7_DIGESTED_DATA MBEDTLS_OID_PKCS7 "\x05"
345 #define MBEDTLS_OID_PKCS7_ENCRYPTED_DATA MBEDTLS_OID_PKCS7 "\x06"
347 /*
348  * PKCS#8 OIDs
349  */
350 #define MBEDTLS_OID_PKCS9_CSR_EXT_REQ MBEDTLS_OID_PKCS9 "\x0e"
352 /*
353  * PKCS#12 PBE OIDs
354  */
355 #define MBEDTLS_OID_PKCS12_PBE MBEDTLS_OID_PKCS12 "\x01"
357 #define MBEDTLS_OID_PKCS12_PBE_SHA1_DES3_EDE_CBC MBEDTLS_OID_PKCS12_PBE "\x03"
358 #define MBEDTLS_OID_PKCS12_PBE_SHA1_DES2_EDE_CBC MBEDTLS_OID_PKCS12_PBE "\x04"
359 #define MBEDTLS_OID_PKCS12_PBE_SHA1_RC2_128_CBC MBEDTLS_OID_PKCS12_PBE "\x05"
360 #define MBEDTLS_OID_PKCS12_PBE_SHA1_RC2_40_CBC MBEDTLS_OID_PKCS12_PBE "\x06"
362 /*
363  * EC key algorithms from RFC 5480
364  */
365 
366 /* id-ecPublicKey OBJECT IDENTIFIER ::= {
367  * iso(1) member-body(2) us(840) ansi-X9-62(10045) keyType(2) 1 } */
368 #define MBEDTLS_OID_EC_ALG_UNRESTRICTED MBEDTLS_OID_ANSI_X9_62 "\x02\01"
369 
370 /* id-ecDH OBJECT IDENTIFIER ::= {
371  * iso(1) identified-organization(3) certicom(132)
372  * schemes(1) ecdh(12) } */
373 #define MBEDTLS_OID_EC_ALG_ECDH MBEDTLS_OID_CERTICOM "\x01\x0c"
374 
375 /*
376  * ECParameters namedCurve identifiers, from RFC 5480, RFC 5639, and SEC2
377  */
378 
379 /* secp192r1 OBJECT IDENTIFIER ::= {
380  * iso(1) member-body(2) us(840) ansi-X9-62(10045) curves(3) prime(1) 1 } */
381 #define MBEDTLS_OID_EC_GRP_SECP192R1 MBEDTLS_OID_ANSI_X9_62 "\x03\x01\x01"
382 
383 /* secp224r1 OBJECT IDENTIFIER ::= {
384  * iso(1) identified-organization(3) certicom(132) curve(0) 33 } */
385 #define MBEDTLS_OID_EC_GRP_SECP224R1 MBEDTLS_OID_CERTICOM "\x00\x21"
386 
387 /* secp256r1 OBJECT IDENTIFIER ::= {
388  * iso(1) member-body(2) us(840) ansi-X9-62(10045) curves(3) prime(1) 7 } */
389 #define MBEDTLS_OID_EC_GRP_SECP256R1 MBEDTLS_OID_ANSI_X9_62 "\x03\x01\x07"
390 
391 /* secp384r1 OBJECT IDENTIFIER ::= {
392  * iso(1) identified-organization(3) certicom(132) curve(0) 34 } */
393 #define MBEDTLS_OID_EC_GRP_SECP384R1 MBEDTLS_OID_CERTICOM "\x00\x22"
394 
395 /* secp521r1 OBJECT IDENTIFIER ::= {
396  * iso(1) identified-organization(3) certicom(132) curve(0) 35 } */
397 #define MBEDTLS_OID_EC_GRP_SECP521R1 MBEDTLS_OID_CERTICOM "\x00\x23"
398 
399 /* secp192k1 OBJECT IDENTIFIER ::= {
400  * iso(1) identified-organization(3) certicom(132) curve(0) 31 } */
401 #define MBEDTLS_OID_EC_GRP_SECP192K1 MBEDTLS_OID_CERTICOM "\x00\x1f"
402 
403 /* secp224k1 OBJECT IDENTIFIER ::= {
404  * iso(1) identified-organization(3) certicom(132) curve(0) 32 } */
405 #define MBEDTLS_OID_EC_GRP_SECP224K1 MBEDTLS_OID_CERTICOM "\x00\x20"
406 
407 /* secp256k1 OBJECT IDENTIFIER ::= {
408  * iso(1) identified-organization(3) certicom(132) curve(0) 10 } */
409 #define MBEDTLS_OID_EC_GRP_SECP256K1 MBEDTLS_OID_CERTICOM "\x00\x0a"
410 
411 /* RFC 5639 4.1
412  * ecStdCurvesAndGeneration OBJECT IDENTIFIER::= {iso(1)
413  * identified-organization(3) teletrust(36) algorithm(3) signature-
414  * algorithm(3) ecSign(2) 8}
415  * ellipticCurve OBJECT IDENTIFIER ::= {ecStdCurvesAndGeneration 1}
416  * versionOne OBJECT IDENTIFIER ::= {ellipticCurve 1} */
417 #define MBEDTLS_OID_EC_BRAINPOOL_V1 MBEDTLS_OID_TELETRUST "\x03\x03\x02\x08\x01\x01"
418 
419 /* brainpoolP256r1 OBJECT IDENTIFIER ::= {versionOne 7} */
420 #define MBEDTLS_OID_EC_GRP_BP256R1 MBEDTLS_OID_EC_BRAINPOOL_V1 "\x07"
421 
422 /* brainpoolP384r1 OBJECT IDENTIFIER ::= {versionOne 11} */
423 #define MBEDTLS_OID_EC_GRP_BP384R1 MBEDTLS_OID_EC_BRAINPOOL_V1 "\x0B"
424 
425 /* brainpoolP512r1 OBJECT IDENTIFIER ::= {versionOne 13} */
426 #define MBEDTLS_OID_EC_GRP_BP512R1 MBEDTLS_OID_EC_BRAINPOOL_V1 "\x0D"
427 
428 /*
429  * SEC1 C.1
430  *
431  * prime-field OBJECT IDENTIFIER ::= { id-fieldType 1 }
432  * id-fieldType OBJECT IDENTIFIER ::= { ansi-X9-62 fieldType(1)}
433  */
434 #define MBEDTLS_OID_ANSI_X9_62_FIELD_TYPE MBEDTLS_OID_ANSI_X9_62 "\x01"
435 #define MBEDTLS_OID_ANSI_X9_62_PRIME_FIELD MBEDTLS_OID_ANSI_X9_62_FIELD_TYPE "\x01"
436 
437 /*
438  * ECDSA signature identifiers, from RFC 5480
439  */
440 #define MBEDTLS_OID_ANSI_X9_62_SIG MBEDTLS_OID_ANSI_X9_62 "\x04" /* signatures(4) */
441 #define MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 MBEDTLS_OID_ANSI_X9_62_SIG "\x03" /* ecdsa-with-SHA2(3) */
442 
443 /* ecdsa-with-SHA1 OBJECT IDENTIFIER ::= {
444  * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4) 1 } */
445 #define MBEDTLS_OID_ECDSA_SHA1 MBEDTLS_OID_ANSI_X9_62_SIG "\x01"
446 
447 /* ecdsa-with-SHA224 OBJECT IDENTIFIER ::= {
448  * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
449  * ecdsa-with-SHA2(3) 1 } */
450 #define MBEDTLS_OID_ECDSA_SHA224 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x01"
451 
452 /* ecdsa-with-SHA256 OBJECT IDENTIFIER ::= {
453  * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
454  * ecdsa-with-SHA2(3) 2 } */
455 #define MBEDTLS_OID_ECDSA_SHA256 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x02"
456 
457 /* ecdsa-with-SHA384 OBJECT IDENTIFIER ::= {
458  * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
459  * ecdsa-with-SHA2(3) 3 } */
460 #define MBEDTLS_OID_ECDSA_SHA384 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x03"
461 
462 /* ecdsa-with-SHA512 OBJECT IDENTIFIER ::= {
463  * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
464  * ecdsa-with-SHA2(3) 4 } */
465 #define MBEDTLS_OID_ECDSA_SHA512 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x04"
466 
467 /*
468  * EC key algorithms from RFC 8410
469  */
470 
471 #define MBEDTLS_OID_X25519 MBEDTLS_OID_THAWTE "\x6e"
472 #define MBEDTLS_OID_X448 MBEDTLS_OID_THAWTE "\x6f"
473 #define MBEDTLS_OID_ED25519 MBEDTLS_OID_THAWTE "\x70"
474 #define MBEDTLS_OID_ED448 MBEDTLS_OID_THAWTE "\x71"
476 #ifdef __cplusplus
477 extern "C" {
478 #endif
479 
483 typedef struct mbedtls_oid_descriptor_t {
484  const char *MBEDTLS_PRIVATE(asn1);
485  size_t MBEDTLS_PRIVATE(asn1_len);
486 #if !defined(MBEDTLS_X509_REMOVE_INFO)
487  const char *MBEDTLS_PRIVATE(name);
488  const char *MBEDTLS_PRIVATE(description);
489 #endif
491 
503 int mbedtls_oid_get_numeric_string(char *buf, size_t size, const mbedtls_asn1_buf *oid);
504 
522 int mbedtls_oid_from_numeric_string(mbedtls_asn1_buf *oid, const char *oid_str, size_t size);
523 
532 int mbedtls_oid_get_x509_ext_type(const mbedtls_asn1_buf *oid, int *ext_type);
533 
543 int mbedtls_oid_get_attr_short_name(const mbedtls_asn1_buf *oid, const char **short_name);
544 
554 
565  const char **oid, size_t *olen);
566 
567 #if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
577 
588  const char **oid, size_t *olen);
589 
600 
612  const char **oid, size_t *olen);
613 #endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
614 
625  mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg);
626 
635 int mbedtls_oid_get_sig_alg_desc(const mbedtls_asn1_buf *oid, const char **desc);
636 
648  const char **oid, size_t *olen);
649 
659 
669 
670 #if !defined(MBEDTLS_X509_REMOVE_INFO)
679 int mbedtls_oid_get_extended_key_usage(const mbedtls_asn1_buf *oid, const char **desc);
680 #endif
681 
690 int mbedtls_oid_get_certificate_policies(const mbedtls_asn1_buf *oid, const char **desc);
691 
701 int mbedtls_oid_get_oid_by_md(mbedtls_md_type_t md_alg, const char **oid, size_t *olen);
702 
703 #if defined(MBEDTLS_CIPHER_C)
713 #endif /* MBEDTLS_CIPHER_C */
714 
715 #if defined(MBEDTLS_PKCS12_C)
727  mbedtls_cipher_type_t *cipher_alg);
728 #endif /* MBEDTLS_PKCS12_C */
729 
730 #ifdef __cplusplus
731 }
732 #endif
733 
734 #endif /* oid.h */
Generic ASN.1 parsing.
This file contains an abstraction interface for use with the cipher primitives provided by the librar...
mbedtls_cipher_type_t
Supported {cipher type, cipher mode} pairs.
Definition: cipher.h:96
mbedtls_ecp_group_id
Definition: ecp.h:113
Build-time configuration info.
This file contains the generic functions for message-digest (hashing) and HMAC.
mbedtls_md_type_t
Supported message digests.
Definition: md.h:173
int mbedtls_oid_get_attr_short_name(const mbedtls_asn1_buf *oid, const char **short_name)
Translate an X.509 attribute type OID into the short name (e.g. the OID for an X520 Common Name into ...
int mbedtls_oid_get_cipher_alg(const mbedtls_asn1_buf *oid, mbedtls_cipher_type_t *cipher_alg)
Translate encryption algorithm OID into cipher_type.
int mbedtls_oid_get_oid_by_ec_grp_algid(mbedtls_ecp_group_id grp_id, const char **oid, size_t *olen)
Translate EC group identifier into AlgorithmIdentifier OID, for curves that are directly encoded at t...
int mbedtls_oid_get_pk_alg(const mbedtls_asn1_buf *oid, mbedtls_pk_type_t *pk_alg)
Translate PublicKeyAlgorithm OID into pk_type.
int mbedtls_oid_get_extended_key_usage(const mbedtls_asn1_buf *oid, const char **desc)
Translate Extended Key Usage OID into description.
int mbedtls_oid_get_oid_by_md(mbedtls_md_type_t md_alg, const char **oid, size_t *olen)
Translate md_type into hash algorithm OID.
int mbedtls_oid_get_ec_grp(const mbedtls_asn1_buf *oid, mbedtls_ecp_group_id *grp_id)
Translate NamedCurve OID into an EC group identifier.
int mbedtls_oid_from_numeric_string(mbedtls_asn1_buf *oid, const char *oid_str, size_t size)
Translate a string containing a dotted-decimal representation of an ASN.1 OID into its encoded form (...
int mbedtls_oid_get_oid_by_sig_alg(mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg, const char **oid, size_t *olen)
Translate md_type and pk_type into SignatureAlgorithm OID.
int mbedtls_oid_get_x509_ext_type(const mbedtls_asn1_buf *oid, int *ext_type)
Translate an X.509 extension OID into local values.
int mbedtls_oid_get_oid_by_ec_grp(mbedtls_ecp_group_id grp_id, const char **oid, size_t *olen)
Translate EC group identifier into NamedCurve OID.
struct mbedtls_oid_descriptor_t mbedtls_oid_descriptor_t
Base OID descriptor structure.
int mbedtls_oid_get_ec_grp_algid(const mbedtls_asn1_buf *oid, mbedtls_ecp_group_id *grp_id)
Translate AlgorithmIdentifier OID into an EC group identifier, for curves that are directly encoded a...
int mbedtls_oid_get_md_hmac(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_hmac)
Translate hmac algorithm OID into md_type.
int mbedtls_oid_get_sig_alg(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg)
Translate SignatureAlgorithm OID into md_type and pk_type.
int mbedtls_oid_get_certificate_policies(const mbedtls_asn1_buf *oid, const char **desc)
Translate certificate policies OID into description.
int mbedtls_oid_get_md_alg(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_alg)
Translate hash algorithm OID into md_type.
int mbedtls_oid_get_sig_alg_desc(const mbedtls_asn1_buf *oid, const char **desc)
Translate SignatureAlgorithm OID into description.
int mbedtls_oid_get_oid_by_pk_alg(mbedtls_pk_type_t pk_alg, const char **oid, size_t *olen)
Translate pk_type into PublicKeyAlgorithm OID.
int mbedtls_oid_get_pkcs12_pbe_alg(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_alg, mbedtls_cipher_type_t *cipher_alg)
Translate PKCS#12 PBE algorithm OID into md_type and cipher_type.
int mbedtls_oid_get_numeric_string(char *buf, size_t size, const mbedtls_asn1_buf *oid)
Translate an ASN.1 OID into its numeric representation (e.g. "\x2A\x86\x48\x86\xF7\x0D" into "1....
Public Key abstraction layer.
mbedtls_pk_type_t
Public key types.
Definition: pk.h:85
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
Base OID descriptor structure.
Definition: oid.h:483