TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / mirror / mbed-crypto / refs/heads/dev/mbed-crypto-0.1.0-alpha / . / include / mbedcrypto / oid.h
blob: d162b10f328be282325d3bd2af1e335cf58dd016 [file] [log] [blame]
Jaeden Ameroe54e6932018-08-06 16:19:58 +0100[diff] [blame]1/**
2 * \file oid.h
3 *
4 * \brief Object Identifier (OID) database
5 */
6/*
7 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
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 * This file is part of Mbed Crypto (https://tls.mbed.org)
23 */
24#ifndef MBEDCRYPTO_OID_H
25#define MBEDCRYPTO_OID_H
26
27#if !defined(MBEDCRYPTO_CONFIG_FILE)
28#include "config.h"
29#else
30#include MBEDCRYPTO_CONFIG_FILE
31#endif
32
33#include "asn1.h"
34#include "pk.h"
35
36#include <stddef.h>
37
38#if defined(MBEDCRYPTO_CIPHER_C)
39#include "cipher.h"
40#endif
41
42#if defined(MBEDCRYPTO_MD_C)
43#include "md.h"
44#endif
45
46#if defined(MBEDCRYPTO_X509_USE_C) || defined(MBEDCRYPTO_X509_CREATE_C)
47#include "x509.h"
48#endif
49
50#define MBEDCRYPTO_ERR_OID_NOT_FOUND -0x002E /**< OID is not found. */
51#define MBEDCRYPTO_ERR_OID_BUF_TOO_SMALL -0x000B /**< output buffer is too small */
52
53/*
54 * Top level OID tuples
55 */
56#define MBEDCRYPTO_OID_ISO_MEMBER_BODIES "\x2a" /* {iso(1) member-body(2)} */
57#define MBEDCRYPTO_OID_ISO_IDENTIFIED_ORG "\x2b" /* {iso(1) identified-organization(3)} */
58#define MBEDCRYPTO_OID_ISO_CCITT_DS "\x55" /* {joint-iso-ccitt(2) ds(5)} */
59#define MBEDCRYPTO_OID_ISO_ITU_COUNTRY "\x60" /* {joint-iso-itu-t(2) country(16)} */
60
61/*
62 * ISO Member bodies OID parts
63 */
64#define MBEDCRYPTO_OID_COUNTRY_US "\x86\x48" /* {us(840)} */
65#define MBEDCRYPTO_OID_ORG_RSA_DATA_SECURITY "\x86\xf7\x0d" /* {rsadsi(113549)} */
66#define MBEDCRYPTO_OID_RSA_COMPANY MBEDCRYPTO_OID_ISO_MEMBER_BODIES MBEDCRYPTO_OID_COUNTRY_US \
67 MBEDCRYPTO_OID_ORG_RSA_DATA_SECURITY /* {iso(1) member-body(2) us(840) rsadsi(113549)} */
68#define MBEDCRYPTO_OID_ORG_ANSI_X9_62 "\xce\x3d" /* ansi-X9-62(10045) */
69#define MBEDCRYPTO_OID_ANSI_X9_62 MBEDCRYPTO_OID_ISO_MEMBER_BODIES MBEDCRYPTO_OID_COUNTRY_US \
70 MBEDCRYPTO_OID_ORG_ANSI_X9_62
71
72/*
73 * ISO Identified organization OID parts
74 */
75#define MBEDCRYPTO_OID_ORG_DOD "\x06" /* {dod(6)} */
76#define MBEDCRYPTO_OID_ORG_OIW "\x0e"
77#define MBEDCRYPTO_OID_OIW_SECSIG MBEDCRYPTO_OID_ORG_OIW "\x03"
78#define MBEDCRYPTO_OID_OIW_SECSIG_ALG MBEDCRYPTO_OID_OIW_SECSIG "\x02"
79#define MBEDCRYPTO_OID_OIW_SECSIG_SHA1 MBEDCRYPTO_OID_OIW_SECSIG_ALG "\x1a"
80#define MBEDCRYPTO_OID_ORG_CERTICOM "\x81\x04" /* certicom(132) */
81#define MBEDCRYPTO_OID_CERTICOM MBEDCRYPTO_OID_ISO_IDENTIFIED_ORG MBEDCRYPTO_OID_ORG_CERTICOM
82#define MBEDCRYPTO_OID_ORG_TELETRUST "\x24" /* teletrust(36) */
83#define MBEDCRYPTO_OID_TELETRUST MBEDCRYPTO_OID_ISO_IDENTIFIED_ORG MBEDCRYPTO_OID_ORG_TELETRUST
84
85/*
86 * ISO ITU OID parts
87 */
88#define MBEDCRYPTO_OID_ORGANIZATION "\x01" /* {organization(1)} */
89#define MBEDCRYPTO_OID_ISO_ITU_US_ORG MBEDCRYPTO_OID_ISO_ITU_COUNTRY MBEDCRYPTO_OID_COUNTRY_US MBEDCRYPTO_OID_ORGANIZATION /* {joint-iso-itu-t(2) country(16) us(840) organization(1)} */
90
91#define MBEDCRYPTO_OID_ORG_GOV "\x65" /* {gov(101)} */
92#define MBEDCRYPTO_OID_GOV MBEDCRYPTO_OID_ISO_ITU_US_ORG MBEDCRYPTO_OID_ORG_GOV /* {joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101)} */
93
94#define MBEDCRYPTO_OID_ORG_NETSCAPE "\x86\xF8\x42" /* {netscape(113730)} */
95#define MBEDCRYPTO_OID_NETSCAPE MBEDCRYPTO_OID_ISO_ITU_US_ORG MBEDCRYPTO_OID_ORG_NETSCAPE /* Netscape OID {joint-iso-itu-t(2) country(16) us(840) organization(1) netscape(113730)} */
96
97/* ISO arc for standard certificate and CRL extensions */
98#define MBEDCRYPTO_OID_ID_CE MBEDCRYPTO_OID_ISO_CCITT_DS "\x1D" /**< id-ce OBJECT IDENTIFIER ::= {joint-iso-ccitt(2) ds(5) 29} */
99
100/**
101 * Private Internet Extensions
102 * { iso(1) identified-organization(3) dod(6) internet(1)
103 * security(5) mechanisms(5) pkix(7) }
104 */
105#define MBEDCRYPTO_OID_PKIX MBEDCRYPTO_OID_ISO_IDENTIFIED_ORG MBEDCRYPTO_OID_ORG_DOD "\x01\x05\x05\x07"
106
107/*
108 * Arc for standard naming attributes
109 */
110#define MBEDCRYPTO_OID_AT MBEDCRYPTO_OID_ISO_CCITT_DS "\x04" /**< id-at OBJECT IDENTIFIER ::= {joint-iso-ccitt(2) ds(5) 4} */
111#define MBEDCRYPTO_OID_AT_CN MBEDCRYPTO_OID_AT "\x03" /**< id-at-commonName AttributeType:= {id-at 3} */
112#define MBEDCRYPTO_OID_AT_SUR_NAME MBEDCRYPTO_OID_AT "\x04" /**< id-at-surName AttributeType:= {id-at 4} */
113#define MBEDCRYPTO_OID_AT_SERIAL_NUMBER MBEDCRYPTO_OID_AT "\x05" /**< id-at-serialNumber AttributeType:= {id-at 5} */
114#define MBEDCRYPTO_OID_AT_COUNTRY MBEDCRYPTO_OID_AT "\x06" /**< id-at-countryName AttributeType:= {id-at 6} */
115#define MBEDCRYPTO_OID_AT_LOCALITY MBEDCRYPTO_OID_AT "\x07" /**< id-at-locality AttributeType:= {id-at 7} */
116#define MBEDCRYPTO_OID_AT_STATE MBEDCRYPTO_OID_AT "\x08" /**< id-at-state AttributeType:= {id-at 8} */
117#define MBEDCRYPTO_OID_AT_ORGANIZATION MBEDCRYPTO_OID_AT "\x0A" /**< id-at-organizationName AttributeType:= {id-at 10} */
118#define MBEDCRYPTO_OID_AT_ORG_UNIT MBEDCRYPTO_OID_AT "\x0B" /**< id-at-organizationalUnitName AttributeType:= {id-at 11} */
119#define MBEDCRYPTO_OID_AT_TITLE MBEDCRYPTO_OID_AT "\x0C" /**< id-at-title AttributeType:= {id-at 12} */
120#define MBEDCRYPTO_OID_AT_POSTAL_ADDRESS MBEDCRYPTO_OID_AT "\x10" /**< id-at-postalAddress AttributeType:= {id-at 16} */
121#define MBEDCRYPTO_OID_AT_POSTAL_CODE MBEDCRYPTO_OID_AT "\x11" /**< id-at-postalCode AttributeType:= {id-at 17} */
122#define MBEDCRYPTO_OID_AT_GIVEN_NAME MBEDCRYPTO_OID_AT "\x2A" /**< id-at-givenName AttributeType:= {id-at 42} */
123#define MBEDCRYPTO_OID_AT_INITIALS MBEDCRYPTO_OID_AT "\x2B" /**< id-at-initials AttributeType:= {id-at 43} */
124#define MBEDCRYPTO_OID_AT_GENERATION_QUALIFIER MBEDCRYPTO_OID_AT "\x2C" /**< id-at-generationQualifier AttributeType:= {id-at 44} */
125#define MBEDCRYPTO_OID_AT_UNIQUE_IDENTIFIER MBEDCRYPTO_OID_AT "\x2D" /**< id-at-uniqueIdentifier AttributType:= {id-at 45} */
126#define MBEDCRYPTO_OID_AT_DN_QUALIFIER MBEDCRYPTO_OID_AT "\x2E" /**< id-at-dnQualifier AttributeType:= {id-at 46} */
127#define MBEDCRYPTO_OID_AT_PSEUDONYM MBEDCRYPTO_OID_AT "\x41" /**< id-at-pseudonym AttributeType:= {id-at 65} */
128
129#define MBEDCRYPTO_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)} */
130
131/*
132 * OIDs for standard certificate extensions
133 */
134#define MBEDCRYPTO_OID_AUTHORITY_KEY_IDENTIFIER MBEDCRYPTO_OID_ID_CE "\x23" /**< id-ce-authorityKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 35 } */
135#define MBEDCRYPTO_OID_SUBJECT_KEY_IDENTIFIER MBEDCRYPTO_OID_ID_CE "\x0E" /**< id-ce-subjectKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 14 } */
136#define MBEDCRYPTO_OID_KEY_USAGE MBEDCRYPTO_OID_ID_CE "\x0F" /**< id-ce-keyUsage OBJECT IDENTIFIER ::= { id-ce 15 } */
137#define MBEDCRYPTO_OID_CERTIFICATE_POLICIES MBEDCRYPTO_OID_ID_CE "\x20" /**< id-ce-certificatePolicies OBJECT IDENTIFIER ::= { id-ce 32 } */
138#define MBEDCRYPTO_OID_POLICY_MAPPINGS MBEDCRYPTO_OID_ID_CE "\x21" /**< id-ce-policyMappings OBJECT IDENTIFIER ::= { id-ce 33 } */
139#define MBEDCRYPTO_OID_SUBJECT_ALT_NAME MBEDCRYPTO_OID_ID_CE "\x11" /**< id-ce-subjectAltName OBJECT IDENTIFIER ::= { id-ce 17 } */
140#define MBEDCRYPTO_OID_ISSUER_ALT_NAME MBEDCRYPTO_OID_ID_CE "\x12" /**< id-ce-issuerAltName OBJECT IDENTIFIER ::= { id-ce 18 } */
141#define MBEDCRYPTO_OID_SUBJECT_DIRECTORY_ATTRS MBEDCRYPTO_OID_ID_CE "\x09" /**< id-ce-subjectDirectoryAttributes OBJECT IDENTIFIER ::= { id-ce 9 } */
142#define MBEDCRYPTO_OID_BASIC_CONSTRAINTS MBEDCRYPTO_OID_ID_CE "\x13" /**< id-ce-basicConstraints OBJECT IDENTIFIER ::= { id-ce 19 } */
143#define MBEDCRYPTO_OID_NAME_CONSTRAINTS MBEDCRYPTO_OID_ID_CE "\x1E" /**< id-ce-nameConstraints OBJECT IDENTIFIER ::= { id-ce 30 } */
144#define MBEDCRYPTO_OID_POLICY_CONSTRAINTS MBEDCRYPTO_OID_ID_CE "\x24" /**< id-ce-policyConstraints OBJECT IDENTIFIER ::= { id-ce 36 } */
145#define MBEDCRYPTO_OID_EXTENDED_KEY_USAGE MBEDCRYPTO_OID_ID_CE "\x25" /**< id-ce-extKeyUsage OBJECT IDENTIFIER ::= { id-ce 37 } */
146#define MBEDCRYPTO_OID_CRL_DISTRIBUTION_POINTS MBEDCRYPTO_OID_ID_CE "\x1F" /**< id-ce-cRLDistributionPoints OBJECT IDENTIFIER ::= { id-ce 31 } */
147#define MBEDCRYPTO_OID_INIHIBIT_ANYPOLICY MBEDCRYPTO_OID_ID_CE "\x36" /**< id-ce-inhibitAnyPolicy OBJECT IDENTIFIER ::= { id-ce 54 } */
148#define MBEDCRYPTO_OID_FRESHEST_CRL MBEDCRYPTO_OID_ID_CE "\x2E" /**< id-ce-freshestCRL OBJECT IDENTIFIER ::= { id-ce 46 } */
149
150/*
151 * Netscape certificate extensions
152 */
153#define MBEDCRYPTO_OID_NS_CERT MBEDCRYPTO_OID_NETSCAPE "\x01"
154#define MBEDCRYPTO_OID_NS_CERT_TYPE MBEDCRYPTO_OID_NS_CERT "\x01"
155#define MBEDCRYPTO_OID_NS_BASE_URL MBEDCRYPTO_OID_NS_CERT "\x02"
156#define MBEDCRYPTO_OID_NS_REVOCATION_URL MBEDCRYPTO_OID_NS_CERT "\x03"
157#define MBEDCRYPTO_OID_NS_CA_REVOCATION_URL MBEDCRYPTO_OID_NS_CERT "\x04"
158#define MBEDCRYPTO_OID_NS_RENEWAL_URL MBEDCRYPTO_OID_NS_CERT "\x07"
159#define MBEDCRYPTO_OID_NS_CA_POLICY_URL MBEDCRYPTO_OID_NS_CERT "\x08"
160#define MBEDCRYPTO_OID_NS_SSL_SERVER_NAME MBEDCRYPTO_OID_NS_CERT "\x0C"
161#define MBEDCRYPTO_OID_NS_COMMENT MBEDCRYPTO_OID_NS_CERT "\x0D"
162#define MBEDCRYPTO_OID_NS_DATA_TYPE MBEDCRYPTO_OID_NETSCAPE "\x02"
163#define MBEDCRYPTO_OID_NS_CERT_SEQUENCE MBEDCRYPTO_OID_NS_DATA_TYPE "\x05"
164
165/*
166 * OIDs for CRL extensions
167 */
168#define MBEDCRYPTO_OID_PRIVATE_KEY_USAGE_PERIOD MBEDCRYPTO_OID_ID_CE "\x10"
169#define MBEDCRYPTO_OID_CRL_NUMBER MBEDCRYPTO_OID_ID_CE "\x14" /**< id-ce-cRLNumber OBJECT IDENTIFIER ::= { id-ce 20 } */
170
171/*
172 * X.509 v3 Extended key usage OIDs
173 */
174#define MBEDCRYPTO_OID_ANY_EXTENDED_KEY_USAGE MBEDCRYPTO_OID_EXTENDED_KEY_USAGE "\x00" /**< anyExtendedKeyUsage OBJECT IDENTIFIER ::= { id-ce-extKeyUsage 0 } */
175
176#define MBEDCRYPTO_OID_KP MBEDCRYPTO_OID_PKIX "\x03" /**< id-kp OBJECT IDENTIFIER ::= { id-pkix 3 } */
177#define MBEDCRYPTO_OID_SERVER_AUTH MBEDCRYPTO_OID_KP "\x01" /**< id-kp-serverAuth OBJECT IDENTIFIER ::= { id-kp 1 } */
178#define MBEDCRYPTO_OID_CLIENT_AUTH MBEDCRYPTO_OID_KP "\x02" /**< id-kp-clientAuth OBJECT IDENTIFIER ::= { id-kp 2 } */
179#define MBEDCRYPTO_OID_CODE_SIGNING MBEDCRYPTO_OID_KP "\x03" /**< id-kp-codeSigning OBJECT IDENTIFIER ::= { id-kp 3 } */
180#define MBEDCRYPTO_OID_EMAIL_PROTECTION MBEDCRYPTO_OID_KP "\x04" /**< id-kp-emailProtection OBJECT IDENTIFIER ::= { id-kp 4 } */
181#define MBEDCRYPTO_OID_TIME_STAMPING MBEDCRYPTO_OID_KP "\x08" /**< id-kp-timeStamping OBJECT IDENTIFIER ::= { id-kp 8 } */
182#define MBEDCRYPTO_OID_OCSP_SIGNING MBEDCRYPTO_OID_KP "\x09" /**< id-kp-OCSPSigning OBJECT IDENTIFIER ::= { id-kp 9 } */
183
184/*
185 * PKCS definition OIDs
186 */
187
188#define MBEDCRYPTO_OID_PKCS MBEDCRYPTO_OID_RSA_COMPANY "\x01" /**< pkcs OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) 1 } */
189#define MBEDCRYPTO_OID_PKCS1 MBEDCRYPTO_OID_PKCS "\x01" /**< pkcs-1 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 1 } */
190#define MBEDCRYPTO_OID_PKCS5 MBEDCRYPTO_OID_PKCS "\x05" /**< pkcs-5 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 5 } */
191#define MBEDCRYPTO_OID_PKCS9 MBEDCRYPTO_OID_PKCS "\x09" /**< pkcs-9 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 9 } */
192#define MBEDCRYPTO_OID_PKCS12 MBEDCRYPTO_OID_PKCS "\x0c" /**< pkcs-12 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 12 } */
193
194/*
195 * PKCS#1 OIDs
196 */
197#define MBEDCRYPTO_OID_PKCS1_RSA MBEDCRYPTO_OID_PKCS1 "\x01" /**< rsaEncryption OBJECT IDENTIFIER ::= { pkcs-1 1 } */
198#define MBEDCRYPTO_OID_PKCS1_MD2 MBEDCRYPTO_OID_PKCS1 "\x02" /**< md2WithRSAEncryption ::= { pkcs-1 2 } */
199#define MBEDCRYPTO_OID_PKCS1_MD4 MBEDCRYPTO_OID_PKCS1 "\x03" /**< md4WithRSAEncryption ::= { pkcs-1 3 } */
200#define MBEDCRYPTO_OID_PKCS1_MD5 MBEDCRYPTO_OID_PKCS1 "\x04" /**< md5WithRSAEncryption ::= { pkcs-1 4 } */
201#define MBEDCRYPTO_OID_PKCS1_SHA1 MBEDCRYPTO_OID_PKCS1 "\x05" /**< sha1WithRSAEncryption ::= { pkcs-1 5 } */
202#define MBEDCRYPTO_OID_PKCS1_SHA224 MBEDCRYPTO_OID_PKCS1 "\x0e" /**< sha224WithRSAEncryption ::= { pkcs-1 14 } */
203#define MBEDCRYPTO_OID_PKCS1_SHA256 MBEDCRYPTO_OID_PKCS1 "\x0b" /**< sha256WithRSAEncryption ::= { pkcs-1 11 } */
204#define MBEDCRYPTO_OID_PKCS1_SHA384 MBEDCRYPTO_OID_PKCS1 "\x0c" /**< sha384WithRSAEncryption ::= { pkcs-1 12 } */
205#define MBEDCRYPTO_OID_PKCS1_SHA512 MBEDCRYPTO_OID_PKCS1 "\x0d" /**< sha512WithRSAEncryption ::= { pkcs-1 13 } */
206
207#define MBEDCRYPTO_OID_RSA_SHA_OBS "\x2B\x0E\x03\x02\x1D"
208
209#define MBEDCRYPTO_OID_PKCS9_EMAIL MBEDCRYPTO_OID_PKCS9 "\x01" /**< emailAddress AttributeType ::= { pkcs-9 1 } */
210
211/* RFC 4055 */
212#define MBEDCRYPTO_OID_RSASSA_PSS MBEDCRYPTO_OID_PKCS1 "\x0a" /**< id-RSASSA-PSS ::= { pkcs-1 10 } */
213#define MBEDCRYPTO_OID_MGF1 MBEDCRYPTO_OID_PKCS1 "\x08" /**< id-mgf1 ::= { pkcs-1 8 } */
214
215/*
216 * Digest algorithms
217 */
218#define MBEDCRYPTO_OID_DIGEST_ALG_MD2 MBEDCRYPTO_OID_RSA_COMPANY "\x02\x02" /**< id-mbedcrypto_md2 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 2 } */
219#define MBEDCRYPTO_OID_DIGEST_ALG_MD4 MBEDCRYPTO_OID_RSA_COMPANY "\x02\x04" /**< id-mbedcrypto_md4 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 4 } */
220#define MBEDCRYPTO_OID_DIGEST_ALG_MD5 MBEDCRYPTO_OID_RSA_COMPANY "\x02\x05" /**< id-mbedcrypto_md5 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 5 } */
221#define MBEDCRYPTO_OID_DIGEST_ALG_SHA1 MBEDCRYPTO_OID_ISO_IDENTIFIED_ORG MBEDCRYPTO_OID_OIW_SECSIG_SHA1 /**< id-mbedcrypto_sha1 OBJECT IDENTIFIER ::= { iso(1) identified-organization(3) oiw(14) secsig(3) algorithms(2) 26 } */
222#define MBEDCRYPTO_OID_DIGEST_ALG_SHA224 MBEDCRYPTO_OID_GOV "\x03\x04\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 } */
223#define MBEDCRYPTO_OID_DIGEST_ALG_SHA256 MBEDCRYPTO_OID_GOV "\x03\x04\x02\x01" /**< id-mbedcrypto_sha256 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistalgorithm(4) hashalgs(2) 1 } */
224
225#define MBEDCRYPTO_OID_DIGEST_ALG_SHA384 MBEDCRYPTO_OID_GOV "\x03\x04\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 } */
226
227#define MBEDCRYPTO_OID_DIGEST_ALG_SHA512 MBEDCRYPTO_OID_GOV "\x03\x04\x02\x03" /**< id-mbedcrypto_sha512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistalgorithm(4) hashalgs(2) 3 } */
228
229#define MBEDCRYPTO_OID_HMAC_SHA1 MBEDCRYPTO_OID_RSA_COMPANY "\x02\x07" /**< id-hmacWithSHA1 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 7 } */
230
231#define MBEDCRYPTO_OID_HMAC_SHA224 MBEDCRYPTO_OID_RSA_COMPANY "\x02\x08" /**< id-hmacWithSHA224 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 8 } */
232
233#define MBEDCRYPTO_OID_HMAC_SHA256 MBEDCRYPTO_OID_RSA_COMPANY "\x02\x09" /**< id-hmacWithSHA256 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 9 } */
234
235#define MBEDCRYPTO_OID_HMAC_SHA384 MBEDCRYPTO_OID_RSA_COMPANY "\x02\x0A" /**< id-hmacWithSHA384 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 10 } */
236
237#define MBEDCRYPTO_OID_HMAC_SHA512 MBEDCRYPTO_OID_RSA_COMPANY "\x02\x0B" /**< id-hmacWithSHA512 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 11 } */
238
239/*
240 * Encryption algorithms
241 */
242#define MBEDCRYPTO_OID_DES_CBC MBEDCRYPTO_OID_ISO_IDENTIFIED_ORG MBEDCRYPTO_OID_OIW_SECSIG_ALG "\x07" /**< desCBC OBJECT IDENTIFIER ::= { iso(1) identified-organization(3) oiw(14) secsig(3) algorithms(2) 7 } */
243#define MBEDCRYPTO_OID_DES_EDE3_CBC MBEDCRYPTO_OID_RSA_COMPANY "\x03\x07" /**< des-ede3-cbc OBJECT IDENTIFIER ::= { iso(1) member-body(2) -- us(840) rsadsi(113549) encryptionAlgorithm(3) 7 } */
244
245/*
246 * PKCS#5 OIDs
247 */
248#define MBEDCRYPTO_OID_PKCS5_PBKDF2 MBEDCRYPTO_OID_PKCS5 "\x0c" /**< id-PBKDF2 OBJECT IDENTIFIER ::= {pkcs-5 12} */
249#define MBEDCRYPTO_OID_PKCS5_PBES2 MBEDCRYPTO_OID_PKCS5 "\x0d" /**< id-PBES2 OBJECT IDENTIFIER ::= {pkcs-5 13} */
250#define MBEDCRYPTO_OID_PKCS5_PBMAC1 MBEDCRYPTO_OID_PKCS5 "\x0e" /**< id-PBMAC1 OBJECT IDENTIFIER ::= {pkcs-5 14} */
251
252/*
253 * PKCS#5 PBES1 algorithms
254 */
255#define MBEDCRYPTO_OID_PKCS5_PBE_MD2_DES_CBC MBEDCRYPTO_OID_PKCS5 "\x01" /**< pbeWithMD2AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 1} */
256#define MBEDCRYPTO_OID_PKCS5_PBE_MD2_RC2_CBC MBEDCRYPTO_OID_PKCS5 "\x04" /**< pbeWithMD2AndRC2-CBC OBJECT IDENTIFIER ::= {pkcs-5 4} */
257#define MBEDCRYPTO_OID_PKCS5_PBE_MD5_DES_CBC MBEDCRYPTO_OID_PKCS5 "\x03" /**< pbeWithMD5AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 3} */
258#define MBEDCRYPTO_OID_PKCS5_PBE_MD5_RC2_CBC MBEDCRYPTO_OID_PKCS5 "\x06" /**< pbeWithMD5AndRC2-CBC OBJECT IDENTIFIER ::= {pkcs-5 6} */
259#define MBEDCRYPTO_OID_PKCS5_PBE_SHA1_DES_CBC MBEDCRYPTO_OID_PKCS5 "\x0a" /**< pbeWithSHA1AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 10} */
260#define MBEDCRYPTO_OID_PKCS5_PBE_SHA1_RC2_CBC MBEDCRYPTO_OID_PKCS5 "\x0b" /**< pbeWithSHA1AndRC2-CBC OBJECT IDENTIFIER ::= {pkcs-5 11} */
261
262/*
263 * PKCS#8 OIDs
264 */
265#define MBEDCRYPTO_OID_PKCS9_CSR_EXT_REQ MBEDCRYPTO_OID_PKCS9 "\x0e" /**< extensionRequest OBJECT IDENTIFIER ::= {pkcs-9 14} */
266
267/*
268 * PKCS#12 PBE OIDs
269 */
270#define MBEDCRYPTO_OID_PKCS12_PBE MBEDCRYPTO_OID_PKCS12 "\x01" /**< pkcs-12PbeIds OBJECT IDENTIFIER ::= {pkcs-12 1} */
271
272#define MBEDCRYPTO_OID_PKCS12_PBE_SHA1_RC4_128 MBEDCRYPTO_OID_PKCS12_PBE "\x01" /**< pbeWithSHAAnd128BitRC4 OBJECT IDENTIFIER ::= {pkcs-12PbeIds 1} */
273#define MBEDCRYPTO_OID_PKCS12_PBE_SHA1_RC4_40 MBEDCRYPTO_OID_PKCS12_PBE "\x02" /**< pbeWithSHAAnd40BitRC4 OBJECT IDENTIFIER ::= {pkcs-12PbeIds 2} */
274#define MBEDCRYPTO_OID_PKCS12_PBE_SHA1_DES3_EDE_CBC MBEDCRYPTO_OID_PKCS12_PBE "\x03" /**< pbeWithSHAAnd3-KeyTripleDES-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 3} */
275#define MBEDCRYPTO_OID_PKCS12_PBE_SHA1_DES2_EDE_CBC MBEDCRYPTO_OID_PKCS12_PBE "\x04" /**< pbeWithSHAAnd2-KeyTripleDES-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 4} */
276#define MBEDCRYPTO_OID_PKCS12_PBE_SHA1_RC2_128_CBC MBEDCRYPTO_OID_PKCS12_PBE "\x05" /**< pbeWithSHAAnd128BitRC2-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 5} */
277#define MBEDCRYPTO_OID_PKCS12_PBE_SHA1_RC2_40_CBC MBEDCRYPTO_OID_PKCS12_PBE "\x06" /**< pbeWithSHAAnd40BitRC2-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 6} */
278
279/*
280 * EC key algorithms from RFC 5480
281 */
282
283/* id-ecPublicKey OBJECT IDENTIFIER ::= {
284 * iso(1) member-body(2) us(840) ansi-X9-62(10045) keyType(2) 1 } */
285#define MBEDCRYPTO_OID_EC_ALG_UNRESTRICTED MBEDCRYPTO_OID_ANSI_X9_62 "\x02\01"
286
287/* id-ecDH OBJECT IDENTIFIER ::= {
288 * iso(1) identified-organization(3) certicom(132)
289 * schemes(1) ecdh(12) } */
290#define MBEDCRYPTO_OID_EC_ALG_ECDH MBEDCRYPTO_OID_CERTICOM "\x01\x0c"
291
292/*
293 * ECParameters namedCurve identifiers, from RFC 5480, RFC 5639, and SEC2
294 */
295
296/* secp192r1 OBJECT IDENTIFIER ::= {
297 * iso(1) member-body(2) us(840) ansi-X9-62(10045) curves(3) prime(1) 1 } */
298#define MBEDCRYPTO_OID_EC_GRP_SECP192R1 MBEDCRYPTO_OID_ANSI_X9_62 "\x03\x01\x01"
299
300/* secp224r1 OBJECT IDENTIFIER ::= {
301 * iso(1) identified-organization(3) certicom(132) curve(0) 33 } */
302#define MBEDCRYPTO_OID_EC_GRP_SECP224R1 MBEDCRYPTO_OID_CERTICOM "\x00\x21"
303
304/* secp256r1 OBJECT IDENTIFIER ::= {
305 * iso(1) member-body(2) us(840) ansi-X9-62(10045) curves(3) prime(1) 7 } */
306#define MBEDCRYPTO_OID_EC_GRP_SECP256R1 MBEDCRYPTO_OID_ANSI_X9_62 "\x03\x01\x07"
307
308/* secp384r1 OBJECT IDENTIFIER ::= {
309 * iso(1) identified-organization(3) certicom(132) curve(0) 34 } */
310#define MBEDCRYPTO_OID_EC_GRP_SECP384R1 MBEDCRYPTO_OID_CERTICOM "\x00\x22"
311
312/* secp521r1 OBJECT IDENTIFIER ::= {
313 * iso(1) identified-organization(3) certicom(132) curve(0) 35 } */
314#define MBEDCRYPTO_OID_EC_GRP_SECP521R1 MBEDCRYPTO_OID_CERTICOM "\x00\x23"
315
316/* secp192k1 OBJECT IDENTIFIER ::= {
317 * iso(1) identified-organization(3) certicom(132) curve(0) 31 } */
318#define MBEDCRYPTO_OID_EC_GRP_SECP192K1 MBEDCRYPTO_OID_CERTICOM "\x00\x1f"
319
320/* secp224k1 OBJECT IDENTIFIER ::= {
321 * iso(1) identified-organization(3) certicom(132) curve(0) 32 } */
322#define MBEDCRYPTO_OID_EC_GRP_SECP224K1 MBEDCRYPTO_OID_CERTICOM "\x00\x20"
323
324/* secp256k1 OBJECT IDENTIFIER ::= {
325 * iso(1) identified-organization(3) certicom(132) curve(0) 10 } */
326#define MBEDCRYPTO_OID_EC_GRP_SECP256K1 MBEDCRYPTO_OID_CERTICOM "\x00\x0a"
327
328/* RFC 5639 4.1
329 * ecStdCurvesAndGeneration OBJECT IDENTIFIER::= {iso(1)
330 * identified-organization(3) teletrust(36) algorithm(3) signature-
331 * algorithm(3) ecSign(2) 8}
332 * ellipticCurve OBJECT IDENTIFIER ::= {ecStdCurvesAndGeneration 1}
333 * versionOne OBJECT IDENTIFIER ::= {ellipticCurve 1} */
334#define MBEDCRYPTO_OID_EC_BRAINPOOL_V1 MBEDCRYPTO_OID_TELETRUST "\x03\x03\x02\x08\x01\x01"
335
336/* brainpoolP256r1 OBJECT IDENTIFIER ::= {versionOne 7} */
337#define MBEDCRYPTO_OID_EC_GRP_BP256R1 MBEDCRYPTO_OID_EC_BRAINPOOL_V1 "\x07"
338
339/* brainpoolP384r1 OBJECT IDENTIFIER ::= {versionOne 11} */
340#define MBEDCRYPTO_OID_EC_GRP_BP384R1 MBEDCRYPTO_OID_EC_BRAINPOOL_V1 "\x0B"
341
342/* brainpoolP512r1 OBJECT IDENTIFIER ::= {versionOne 13} */
343#define MBEDCRYPTO_OID_EC_GRP_BP512R1 MBEDCRYPTO_OID_EC_BRAINPOOL_V1 "\x0D"
344
345/*
346 * SEC1 C.1
347 *
348 * prime-field OBJECT IDENTIFIER ::= { id-fieldType 1 }
349 * id-fieldType OBJECT IDENTIFIER ::= { ansi-X9-62 fieldType(1)}
350 */
351#define MBEDCRYPTO_OID_ANSI_X9_62_FIELD_TYPE MBEDCRYPTO_OID_ANSI_X9_62 "\x01"
352#define MBEDCRYPTO_OID_ANSI_X9_62_PRIME_FIELD MBEDCRYPTO_OID_ANSI_X9_62_FIELD_TYPE "\x01"
353
354/*
355 * ECDSA signature identifiers, from RFC 5480
356 */
357#define MBEDCRYPTO_OID_ANSI_X9_62_SIG MBEDCRYPTO_OID_ANSI_X9_62 "\x04" /* signatures(4) */
358#define MBEDCRYPTO_OID_ANSI_X9_62_SIG_SHA2 MBEDCRYPTO_OID_ANSI_X9_62_SIG "\x03" /* ecdsa-with-SHA2(3) */
359
360/* ecdsa-with-SHA1 OBJECT IDENTIFIER ::= {
361 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4) 1 } */
362#define MBEDCRYPTO_OID_ECDSA_SHA1 MBEDCRYPTO_OID_ANSI_X9_62_SIG "\x01"
363
364/* ecdsa-with-SHA224 OBJECT IDENTIFIER ::= {
365 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
366 * ecdsa-with-SHA2(3) 1 } */
367#define MBEDCRYPTO_OID_ECDSA_SHA224 MBEDCRYPTO_OID_ANSI_X9_62_SIG_SHA2 "\x01"
368
369/* ecdsa-with-SHA256 OBJECT IDENTIFIER ::= {
370 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
371 * ecdsa-with-SHA2(3) 2 } */
372#define MBEDCRYPTO_OID_ECDSA_SHA256 MBEDCRYPTO_OID_ANSI_X9_62_SIG_SHA2 "\x02"
373
374/* ecdsa-with-SHA384 OBJECT IDENTIFIER ::= {
375 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
376 * ecdsa-with-SHA2(3) 3 } */
377#define MBEDCRYPTO_OID_ECDSA_SHA384 MBEDCRYPTO_OID_ANSI_X9_62_SIG_SHA2 "\x03"
378
379/* ecdsa-with-SHA512 OBJECT IDENTIFIER ::= {
380 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
381 * ecdsa-with-SHA2(3) 4 } */
382#define MBEDCRYPTO_OID_ECDSA_SHA512 MBEDCRYPTO_OID_ANSI_X9_62_SIG_SHA2 "\x04"
383
384#ifdef __cplusplus
385extern "C" {
386#endif
387
388/**
389 * \brief Base OID descriptor structure
390 */
391typedef struct {
392 const char *asn1; /*!< OID ASN.1 representation */
393 size_t asn1_len; /*!< length of asn1 */
394 const char *name; /*!< official name (e.g. from RFC) */
395 const char *description; /*!< human friendly description */
396} mbedcrypto_oid_descriptor_t;
397
398/**
399 * \brief Translate an ASN.1 OID into its numeric representation
400 * (e.g. "\x2A\x86\x48\x86\xF7\x0D" into "1.2.840.113549")
401 *
402 * \param buf buffer to put representation in
403 * \param size size of the buffer
404 * \param oid OID to translate
405 *
406 * \return Length of the string written (excluding final NULL) or
407 * MBEDCRYPTO_ERR_OID_BUF_TOO_SMALL in case of error
408 */
409int mbedcrypto_oid_get_numeric_string( char *buf, size_t size, const mbedcrypto_asn1_buf *oid );
410
411#if defined(MBEDCRYPTO_X509_USE_C) || defined(MBEDCRYPTO_X509_CREATE_C)
412/**
413 * \brief Translate an X.509 extension OID into local values
414 *
415 * \param oid OID to use
416 * \param ext_type place to store the extension type
417 *
418 * \return 0 if successful, or MBEDCRYPTO_ERR_OID_NOT_FOUND
419 */
420int mbedcrypto_oid_get_x509_ext_type( const mbedcrypto_asn1_buf *oid, int *ext_type );
421#endif
422
423/**
424 * \brief Translate an X.509 attribute type OID into the short name
425 * (e.g. the OID for an X520 Common Name into "CN")
426 *
427 * \param oid OID to use
428 * \param short_name place to store the string pointer
429 *
430 * \return 0 if successful, or MBEDCRYPTO_ERR_OID_NOT_FOUND
431 */
432int mbedcrypto_oid_get_attr_short_name( const mbedcrypto_asn1_buf *oid, const char **short_name );
433
434/**
435 * \brief Translate PublicKeyAlgorithm OID into pk_type
436 *
437 * \param oid OID to use
438 * \param pk_alg place to store public key algorithm
439 *
440 * \return 0 if successful, or MBEDCRYPTO_ERR_OID_NOT_FOUND
441 */
442int mbedcrypto_oid_get_pk_alg( const mbedcrypto_asn1_buf *oid, mbedcrypto_pk_type_t *pk_alg );
443
444/**
445 * \brief Translate pk_type into PublicKeyAlgorithm OID
446 *
447 * \param pk_alg Public key type to look for
448 * \param oid place to store ASN.1 OID string pointer
449 * \param olen length of the OID
450 *
451 * \return 0 if successful, or MBEDCRYPTO_ERR_OID_NOT_FOUND
452 */
453int mbedcrypto_oid_get_oid_by_pk_alg( mbedcrypto_pk_type_t pk_alg,
454 const char **oid, size_t *olen );
455
456#if defined(MBEDCRYPTO_ECP_C)
457/**
458 * \brief Translate NamedCurve OID into an EC group identifier
459 *
460 * \param oid OID to use
461 * \param grp_id place to store group id
462 *
463 * \return 0 if successful, or MBEDCRYPTO_ERR_OID_NOT_FOUND
464 */
465int mbedcrypto_oid_get_ec_grp( const mbedcrypto_asn1_buf *oid, mbedcrypto_ecp_group_id *grp_id );
466
467/**
468 * \brief Translate EC group identifier into NamedCurve OID
469 *
470 * \param grp_id EC group identifier
471 * \param oid place to store ASN.1 OID string pointer
472 * \param olen length of the OID
473 *
474 * \return 0 if successful, or MBEDCRYPTO_ERR_OID_NOT_FOUND
475 */
476int mbedcrypto_oid_get_oid_by_ec_grp( mbedcrypto_ecp_group_id grp_id,
477 const char **oid, size_t *olen );
478#endif /* MBEDCRYPTO_ECP_C */
479
480#if defined(MBEDCRYPTO_MD_C)
481/**
482 * \brief Translate SignatureAlgorithm OID into md_type and pk_type
483 *
484 * \param oid OID to use
485 * \param md_alg place to store message digest algorithm
486 * \param pk_alg place to store public key algorithm
487 *
488 * \return 0 if successful, or MBEDCRYPTO_ERR_OID_NOT_FOUND
489 */
490int mbedcrypto_oid_get_sig_alg( const mbedcrypto_asn1_buf *oid,
491 mbedcrypto_md_type_t *md_alg, mbedcrypto_pk_type_t *pk_alg );
492
493/**
494 * \brief Translate SignatureAlgorithm OID into description
495 *
496 * \param oid OID to use
497 * \param desc place to store string pointer
498 *
499 * \return 0 if successful, or MBEDCRYPTO_ERR_OID_NOT_FOUND
500 */
501int mbedcrypto_oid_get_sig_alg_desc( const mbedcrypto_asn1_buf *oid, const char **desc );
502
503/**
504 * \brief Translate md_type and pk_type into SignatureAlgorithm OID
505 *
506 * \param md_alg message digest algorithm
507 * \param pk_alg public key algorithm
508 * \param oid place to store ASN.1 OID string pointer
509 * \param olen length of the OID
510 *
511 * \return 0 if successful, or MBEDCRYPTO_ERR_OID_NOT_FOUND
512 */
513int mbedcrypto_oid_get_oid_by_sig_alg( mbedcrypto_pk_type_t pk_alg, mbedcrypto_md_type_t md_alg,
514 const char **oid, size_t *olen );
515
516/**
517 * \brief Translate hash algorithm OID into md_type
518 *
519 * \param oid OID to use
520 * \param md_alg place to store message digest algorithm
521 *
522 * \return 0 if successful, or MBEDCRYPTO_ERR_OID_NOT_FOUND
523 */
524int mbedcrypto_oid_get_md_alg( const mbedcrypto_asn1_buf *oid, mbedcrypto_md_type_t *md_alg );
525
526/**
527 * \brief Translate hmac algorithm OID into md_type
528 *
529 * \param oid OID to use
530 * \param md_hmac place to store message hmac algorithm
531 *
532 * \return 0 if successful, or MBEDCRYPTO_ERR_OID_NOT_FOUND
533 */
534int mbedcrypto_oid_get_md_hmac( const mbedcrypto_asn1_buf *oid, mbedcrypto_md_type_t *md_hmac );
535#endif /* MBEDCRYPTO_MD_C */
536
537/**
538 * \brief Translate Extended Key Usage OID into description
539 *
540 * \param oid OID to use
541 * \param desc place to store string pointer
542 *
543 * \return 0 if successful, or MBEDCRYPTO_ERR_OID_NOT_FOUND
544 */
545int mbedcrypto_oid_get_extended_key_usage( const mbedcrypto_asn1_buf *oid, const char **desc );
546
547/**
548 * \brief Translate md_type into hash algorithm OID
549 *
550 * \param md_alg message digest algorithm
551 * \param oid place to store ASN.1 OID string pointer
552 * \param olen length of the OID
553 *
554 * \return 0 if successful, or MBEDCRYPTO_ERR_OID_NOT_FOUND
555 */
556int mbedcrypto_oid_get_oid_by_md( mbedcrypto_md_type_t md_alg, const char **oid, size_t *olen );
557
558#if defined(MBEDCRYPTO_CIPHER_C)
559/**
560 * \brief Translate encryption algorithm OID into cipher_type
561 *
562 * \param oid OID to use
563 * \param cipher_alg place to store cipher algorithm
564 *
565 * \return 0 if successful, or MBEDCRYPTO_ERR_OID_NOT_FOUND
566 */
567int mbedcrypto_oid_get_cipher_alg( const mbedcrypto_asn1_buf *oid, mbedcrypto_cipher_type_t *cipher_alg );
568#endif /* MBEDCRYPTO_CIPHER_C */
569
570#if defined(MBEDCRYPTO_PKCS12_C)
571/**
572 * \brief Translate PKCS#12 PBE algorithm OID into md_type and
573 * cipher_type
574 *
575 * \param oid OID to use
576 * \param md_alg place to store message digest algorithm
577 * \param cipher_alg place to store cipher algorithm
578 *
579 * \return 0 if successful, or MBEDCRYPTO_ERR_OID_NOT_FOUND
580 */
581int mbedcrypto_oid_get_pkcs12_pbe_alg( const mbedcrypto_asn1_buf *oid, mbedcrypto_md_type_t *md_alg,
582 mbedcrypto_cipher_type_t *cipher_alg );
583#endif /* MBEDCRYPTO_PKCS12_C */
584
585#ifdef __cplusplus
586}
587#endif
588
589#endif /* oid.h */