blob: b2f5dd196b4ca7d91652692ac9aa53229776c84f [file] [log] [blame]
Paul Bakkerc70b9822013-04-07 22:00:46 +02001/**
2 * \file oid.h
3 *
4 * \brief Object Identifier (OID) database
Darryl Greena40a1012018-01-05 15:33:17 +00005 */
6/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02007 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02008 * 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.
Paul Bakkerc70b9822013-04-07 22:00:46 +020021 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020022#ifndef MBEDTLS_OID_H
23#define MBEDTLS_OID_H
Mateusz Starzyk846f0212021-05-19 19:44:07 +020024#include "mbedtls/private_access.h"
Paul Bakkerc70b9822013-04-07 22:00:46 +020025
Bence Szépkútic662b362021-05-27 11:25:03 +020026#include "mbedtls/build_info.h"
Rich Evans00ab4702015-02-06 13:43:58 +000027
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010028#include "mbedtls/asn1.h"
29#include "mbedtls/pk.h"
Rich Evans00ab4702015-02-06 13:43:58 +000030
31#include <stddef.h>
32
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020033#if defined(MBEDTLS_CIPHER_C)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010034#include "mbedtls/cipher.h"
Paul Bakker47fce022013-06-28 17:34:34 +020035#endif
36
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010037#include "mbedtls/md.h"
Paul Bakker47fce022013-06-28 17:34:34 +020038
Gilles Peskined2971572021-07-26 18:48:10 +020039/** OID is not found. */
40#define MBEDTLS_ERR_OID_NOT_FOUND -0x002E
41/** output buffer is too small */
42#define MBEDTLS_ERR_OID_BUF_TOO_SMALL -0x000B
Paul Bakkerc70b9822013-04-07 22:00:46 +020043
Manuel Pégourié-Gonnardc49ada42019-01-28 09:20:59 +010044/* 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
Paul Bakkerc70b9822013-04-07 22:00:46 +020066/*
67 * Top level OID tuples
68 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020069#define MBEDTLS_OID_ISO_MEMBER_BODIES "\x2a" /* {iso(1) member-body(2)} */
70#define MBEDTLS_OID_ISO_IDENTIFIED_ORG "\x2b" /* {iso(1) identified-organization(3)} */
71#define MBEDTLS_OID_ISO_CCITT_DS "\x55" /* {joint-iso-ccitt(2) ds(5)} */
72#define MBEDTLS_OID_ISO_ITU_COUNTRY "\x60" /* {joint-iso-itu-t(2) country(16)} */
Paul Bakkerc70b9822013-04-07 22:00:46 +020073
74/*
75 * ISO Member bodies OID parts
76 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020077#define MBEDTLS_OID_COUNTRY_US "\x86\x48" /* {us(840)} */
78#define MBEDTLS_OID_ORG_RSA_DATA_SECURITY "\x86\xf7\x0d" /* {rsadsi(113549)} */
79#define MBEDTLS_OID_RSA_COMPANY MBEDTLS_OID_ISO_MEMBER_BODIES MBEDTLS_OID_COUNTRY_US \
Gilles Peskine449bd832023-01-11 14:50:10 +010080 MBEDTLS_OID_ORG_RSA_DATA_SECURITY /* {iso(1) member-body(2) us(840) rsadsi(113549)} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020081#define MBEDTLS_OID_ORG_ANSI_X9_62 "\xce\x3d" /* ansi-X9-62(10045) */
82#define MBEDTLS_OID_ANSI_X9_62 MBEDTLS_OID_ISO_MEMBER_BODIES MBEDTLS_OID_COUNTRY_US \
Gilles Peskine449bd832023-01-11 14:50:10 +010083 MBEDTLS_OID_ORG_ANSI_X9_62
Paul Bakkerc70b9822013-04-07 22:00:46 +020084
85/*
86 * ISO Identified organization OID parts
87 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020088#define MBEDTLS_OID_ORG_DOD "\x06" /* {dod(6)} */
89#define MBEDTLS_OID_ORG_OIW "\x0e"
90#define MBEDTLS_OID_OIW_SECSIG MBEDTLS_OID_ORG_OIW "\x03"
91#define MBEDTLS_OID_OIW_SECSIG_ALG MBEDTLS_OID_OIW_SECSIG "\x02"
92#define MBEDTLS_OID_OIW_SECSIG_SHA1 MBEDTLS_OID_OIW_SECSIG_ALG "\x1a"
93#define MBEDTLS_OID_ORG_CERTICOM "\x81\x04" /* certicom(132) */
Gilles Peskine449bd832023-01-11 14:50:10 +010094#define MBEDTLS_OID_CERTICOM MBEDTLS_OID_ISO_IDENTIFIED_ORG \
95 MBEDTLS_OID_ORG_CERTICOM
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020096#define MBEDTLS_OID_ORG_TELETRUST "\x24" /* teletrust(36) */
Gilles Peskine449bd832023-01-11 14:50:10 +010097#define MBEDTLS_OID_TELETRUST MBEDTLS_OID_ISO_IDENTIFIED_ORG \
98 MBEDTLS_OID_ORG_TELETRUST
Paul Bakkerc70b9822013-04-07 22:00:46 +020099
100/*
101 * ISO ITU OID parts
102 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103#define MBEDTLS_OID_ORGANIZATION "\x01" /* {organization(1)} */
Gilles Peskine449bd832023-01-11 14:50:10 +0100104#define MBEDTLS_OID_ISO_ITU_US_ORG MBEDTLS_OID_ISO_ITU_COUNTRY MBEDTLS_OID_COUNTRY_US \
105 MBEDTLS_OID_ORGANIZATION /* {joint-iso-itu-t(2) country(16) us(840) organization(1)} */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200106
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200107#define MBEDTLS_OID_ORG_GOV "\x65" /* {gov(101)} */
108#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)} */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200109
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200110#define MBEDTLS_OID_ORG_NETSCAPE "\x86\xF8\x42" /* {netscape(113730)} */
111#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)} */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200112
113/* ISO arc for standard certificate and CRL extensions */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200114#define MBEDTLS_OID_ID_CE MBEDTLS_OID_ISO_CCITT_DS "\x1D" /**< id-ce OBJECT IDENTIFIER ::= {joint-iso-ccitt(2) ds(5) 29} */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200115
Ron Eldor488fd082018-07-15 09:38:39 +0300116#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) */
117
Paul Bakkerc70b9822013-04-07 22:00:46 +0200118/**
119 * Private Internet Extensions
120 * { iso(1) identified-organization(3) dod(6) internet(1)
121 * security(5) mechanisms(5) pkix(7) }
122 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100123#define MBEDTLS_OID_INTERNET MBEDTLS_OID_ISO_IDENTIFIED_ORG MBEDTLS_OID_ORG_DOD \
124 "\x01"
Ron Eldorb6dc1052019-04-01 18:12:23 +0300125#define MBEDTLS_OID_PKIX MBEDTLS_OID_INTERNET "\x05\x05\x07"
Paul Bakkerc70b9822013-04-07 22:00:46 +0200126
127/*
128 * Arc for standard naming attributes
129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200130#define MBEDTLS_OID_AT MBEDTLS_OID_ISO_CCITT_DS "\x04" /**< id-at OBJECT IDENTIFIER ::= {joint-iso-ccitt(2) ds(5) 4} */
131#define MBEDTLS_OID_AT_CN MBEDTLS_OID_AT "\x03" /**< id-at-commonName AttributeType:= {id-at 3} */
132#define MBEDTLS_OID_AT_SUR_NAME MBEDTLS_OID_AT "\x04" /**< id-at-surName AttributeType:= {id-at 4} */
133#define MBEDTLS_OID_AT_SERIAL_NUMBER MBEDTLS_OID_AT "\x05" /**< id-at-serialNumber AttributeType:= {id-at 5} */
134#define MBEDTLS_OID_AT_COUNTRY MBEDTLS_OID_AT "\x06" /**< id-at-countryName AttributeType:= {id-at 6} */
135#define MBEDTLS_OID_AT_LOCALITY MBEDTLS_OID_AT "\x07" /**< id-at-locality AttributeType:= {id-at 7} */
136#define MBEDTLS_OID_AT_STATE MBEDTLS_OID_AT "\x08" /**< id-at-state AttributeType:= {id-at 8} */
137#define MBEDTLS_OID_AT_ORGANIZATION MBEDTLS_OID_AT "\x0A" /**< id-at-organizationName AttributeType:= {id-at 10} */
138#define MBEDTLS_OID_AT_ORG_UNIT MBEDTLS_OID_AT "\x0B" /**< id-at-organizationalUnitName AttributeType:= {id-at 11} */
139#define MBEDTLS_OID_AT_TITLE MBEDTLS_OID_AT "\x0C" /**< id-at-title AttributeType:= {id-at 12} */
140#define MBEDTLS_OID_AT_POSTAL_ADDRESS MBEDTLS_OID_AT "\x10" /**< id-at-postalAddress AttributeType:= {id-at 16} */
141#define MBEDTLS_OID_AT_POSTAL_CODE MBEDTLS_OID_AT "\x11" /**< id-at-postalCode AttributeType:= {id-at 17} */
142#define MBEDTLS_OID_AT_GIVEN_NAME MBEDTLS_OID_AT "\x2A" /**< id-at-givenName AttributeType:= {id-at 42} */
143#define MBEDTLS_OID_AT_INITIALS MBEDTLS_OID_AT "\x2B" /**< id-at-initials AttributeType:= {id-at 43} */
144#define MBEDTLS_OID_AT_GENERATION_QUALIFIER MBEDTLS_OID_AT "\x2C" /**< id-at-generationQualifier AttributeType:= {id-at 44} */
Tom Cosgrove1e211442022-05-26 11:51:00 +0100145#define MBEDTLS_OID_AT_UNIQUE_IDENTIFIER MBEDTLS_OID_AT "\x2D" /**< id-at-uniqueIdentifier AttributeType:= {id-at 45} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200146#define MBEDTLS_OID_AT_DN_QUALIFIER MBEDTLS_OID_AT "\x2E" /**< id-at-dnQualifier AttributeType:= {id-at 46} */
147#define MBEDTLS_OID_AT_PSEUDONYM MBEDTLS_OID_AT "\x41" /**< id-at-pseudonym AttributeType:= {id-at 65} */
Paul Bakker63844402014-04-30 15:34:12 +0200148
Micah N Gorrell21d4bdb2021-05-12 17:41:24 -0600149#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)} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200150#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)} */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200151
152/*
153 * OIDs for standard certificate extensions
154 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200155#define MBEDTLS_OID_AUTHORITY_KEY_IDENTIFIER MBEDTLS_OID_ID_CE "\x23" /**< id-ce-authorityKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 35 } */
156#define MBEDTLS_OID_SUBJECT_KEY_IDENTIFIER MBEDTLS_OID_ID_CE "\x0E" /**< id-ce-subjectKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 14 } */
157#define MBEDTLS_OID_KEY_USAGE MBEDTLS_OID_ID_CE "\x0F" /**< id-ce-keyUsage OBJECT IDENTIFIER ::= { id-ce 15 } */
158#define MBEDTLS_OID_CERTIFICATE_POLICIES MBEDTLS_OID_ID_CE "\x20" /**< id-ce-certificatePolicies OBJECT IDENTIFIER ::= { id-ce 32 } */
159#define MBEDTLS_OID_POLICY_MAPPINGS MBEDTLS_OID_ID_CE "\x21" /**< id-ce-policyMappings OBJECT IDENTIFIER ::= { id-ce 33 } */
160#define MBEDTLS_OID_SUBJECT_ALT_NAME MBEDTLS_OID_ID_CE "\x11" /**< id-ce-subjectAltName OBJECT IDENTIFIER ::= { id-ce 17 } */
161#define MBEDTLS_OID_ISSUER_ALT_NAME MBEDTLS_OID_ID_CE "\x12" /**< id-ce-issuerAltName OBJECT IDENTIFIER ::= { id-ce 18 } */
162#define MBEDTLS_OID_SUBJECT_DIRECTORY_ATTRS MBEDTLS_OID_ID_CE "\x09" /**< id-ce-subjectDirectoryAttributes OBJECT IDENTIFIER ::= { id-ce 9 } */
163#define MBEDTLS_OID_BASIC_CONSTRAINTS MBEDTLS_OID_ID_CE "\x13" /**< id-ce-basicConstraints OBJECT IDENTIFIER ::= { id-ce 19 } */
164#define MBEDTLS_OID_NAME_CONSTRAINTS MBEDTLS_OID_ID_CE "\x1E" /**< id-ce-nameConstraints OBJECT IDENTIFIER ::= { id-ce 30 } */
165#define MBEDTLS_OID_POLICY_CONSTRAINTS MBEDTLS_OID_ID_CE "\x24" /**< id-ce-policyConstraints OBJECT IDENTIFIER ::= { id-ce 36 } */
166#define MBEDTLS_OID_EXTENDED_KEY_USAGE MBEDTLS_OID_ID_CE "\x25" /**< id-ce-extKeyUsage OBJECT IDENTIFIER ::= { id-ce 37 } */
167#define MBEDTLS_OID_CRL_DISTRIBUTION_POINTS MBEDTLS_OID_ID_CE "\x1F" /**< id-ce-cRLDistributionPoints OBJECT IDENTIFIER ::= { id-ce 31 } */
168#define MBEDTLS_OID_INIHIBIT_ANYPOLICY MBEDTLS_OID_ID_CE "\x36" /**< id-ce-inhibitAnyPolicy OBJECT IDENTIFIER ::= { id-ce 54 } */
169#define MBEDTLS_OID_FRESHEST_CRL MBEDTLS_OID_ID_CE "\x2E" /**< id-ce-freshestCRL OBJECT IDENTIFIER ::= { id-ce 46 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200170
171/*
Ron Eldor11ee0712019-03-25 18:22:52 +0200172 * Certificate policies
173 */
174#define MBEDTLS_OID_ANY_POLICY MBEDTLS_OID_CERTIFICATE_POLICIES "\x00" /**< anyPolicy OBJECT IDENTIFIER ::= { id-ce-certificatePolicies 0 } */
175
176/*
Paul Bakkerc70b9822013-04-07 22:00:46 +0200177 * Netscape certificate extensions
178 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200179#define MBEDTLS_OID_NS_CERT MBEDTLS_OID_NETSCAPE "\x01"
180#define MBEDTLS_OID_NS_CERT_TYPE MBEDTLS_OID_NS_CERT "\x01"
181#define MBEDTLS_OID_NS_BASE_URL MBEDTLS_OID_NS_CERT "\x02"
182#define MBEDTLS_OID_NS_REVOCATION_URL MBEDTLS_OID_NS_CERT "\x03"
183#define MBEDTLS_OID_NS_CA_REVOCATION_URL MBEDTLS_OID_NS_CERT "\x04"
184#define MBEDTLS_OID_NS_RENEWAL_URL MBEDTLS_OID_NS_CERT "\x07"
185#define MBEDTLS_OID_NS_CA_POLICY_URL MBEDTLS_OID_NS_CERT "\x08"
186#define MBEDTLS_OID_NS_SSL_SERVER_NAME MBEDTLS_OID_NS_CERT "\x0C"
187#define MBEDTLS_OID_NS_COMMENT MBEDTLS_OID_NS_CERT "\x0D"
188#define MBEDTLS_OID_NS_DATA_TYPE MBEDTLS_OID_NETSCAPE "\x02"
189#define MBEDTLS_OID_NS_CERT_SEQUENCE MBEDTLS_OID_NS_DATA_TYPE "\x05"
Paul Bakkerc70b9822013-04-07 22:00:46 +0200190
191/*
192 * OIDs for CRL extensions
193 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194#define MBEDTLS_OID_PRIVATE_KEY_USAGE_PERIOD MBEDTLS_OID_ID_CE "\x10"
195#define MBEDTLS_OID_CRL_NUMBER MBEDTLS_OID_ID_CE "\x14" /**< id-ce-cRLNumber OBJECT IDENTIFIER ::= { id-ce 20 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200196
197/*
198 * X.509 v3 Extended key usage OIDs
199 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200200#define MBEDTLS_OID_ANY_EXTENDED_KEY_USAGE MBEDTLS_OID_EXTENDED_KEY_USAGE "\x00" /**< anyExtendedKeyUsage OBJECT IDENTIFIER ::= { id-ce-extKeyUsage 0 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200201
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202#define MBEDTLS_OID_KP MBEDTLS_OID_PKIX "\x03" /**< id-kp OBJECT IDENTIFIER ::= { id-pkix 3 } */
203#define MBEDTLS_OID_SERVER_AUTH MBEDTLS_OID_KP "\x01" /**< id-kp-serverAuth OBJECT IDENTIFIER ::= { id-kp 1 } */
204#define MBEDTLS_OID_CLIENT_AUTH MBEDTLS_OID_KP "\x02" /**< id-kp-clientAuth OBJECT IDENTIFIER ::= { id-kp 2 } */
205#define MBEDTLS_OID_CODE_SIGNING MBEDTLS_OID_KP "\x03" /**< id-kp-codeSigning OBJECT IDENTIFIER ::= { id-kp 3 } */
206#define MBEDTLS_OID_EMAIL_PROTECTION MBEDTLS_OID_KP "\x04" /**< id-kp-emailProtection OBJECT IDENTIFIER ::= { id-kp 4 } */
207#define MBEDTLS_OID_TIME_STAMPING MBEDTLS_OID_KP "\x08" /**< id-kp-timeStamping OBJECT IDENTIFIER ::= { id-kp 8 } */
208#define MBEDTLS_OID_OCSP_SIGNING MBEDTLS_OID_KP "\x09" /**< id-kp-OCSPSigning OBJECT IDENTIFIER ::= { id-kp 9 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200209
Ron Eldorb6dc1052019-04-01 18:12:23 +0300210/**
211 * Wi-SUN Alliance Field Area Network
212 * { iso(1) identified-organization(3) dod(6) internet(1)
213 * private(4) enterprise(1) WiSUN(45605) FieldAreaNetwork(1) }
214 */
Ron Eldor3c4734a2019-03-25 14:05:23 +0200215#define MBEDTLS_OID_WISUN_FAN MBEDTLS_OID_INTERNET "\x04\x01\x82\xe4\x25\x01"
Ron Eldorb6dc1052019-04-01 18:12:23 +0300216
Ron Eldorb2dc3fa2019-03-21 13:40:13 +0200217#define MBEDTLS_OID_ON MBEDTLS_OID_PKIX "\x08" /**< id-on OBJECT IDENTIFIER ::= { id-pkix 8 } */
218#define MBEDTLS_OID_ON_HW_MODULE_NAME MBEDTLS_OID_ON "\x04" /**< id-on-hardwareModuleName OBJECT IDENTIFIER ::= { id-on 4 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200219
220/*
Paul Bakkerc70b9822013-04-07 22:00:46 +0200221 * PKCS definition OIDs
Paul Bakker9b5e8852013-06-28 16:12:50 +0200222 */
223
224#define MBEDTLS_OID_PKCS MBEDTLS_OID_RSA_COMPANY "\x01" /**< pkcs OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) 1 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#define MBEDTLS_OID_PKCS1 MBEDTLS_OID_PKCS "\x01" /**< pkcs-1 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 1 } */
226#define MBEDTLS_OID_PKCS5 MBEDTLS_OID_PKCS "\x05" /**< pkcs-5 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 5 } */
Nayna Jainc9deb182020-11-16 19:03:12 +0000227#define MBEDTLS_OID_PKCS7 MBEDTLS_OID_PKCS "\x07" /**< pkcs-7 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 7 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200228#define MBEDTLS_OID_PKCS9 MBEDTLS_OID_PKCS "\x09" /**< pkcs-9 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 9 } */
229#define MBEDTLS_OID_PKCS12 MBEDTLS_OID_PKCS "\x0c" /**< pkcs-12 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 12 } */
230
231/*
232 * PKCS#1 OIDs
233 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234#define MBEDTLS_OID_PKCS1_RSA MBEDTLS_OID_PKCS1 "\x01" /**< rsaEncryption OBJECT IDENTIFIER ::= { pkcs-1 1 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200235#define MBEDTLS_OID_PKCS1_MD5 MBEDTLS_OID_PKCS1 "\x04" /**< md5WithRSAEncryption ::= { pkcs-1 4 } */
236#define MBEDTLS_OID_PKCS1_SHA1 MBEDTLS_OID_PKCS1 "\x05" /**< sha1WithRSAEncryption ::= { pkcs-1 5 } */
237#define MBEDTLS_OID_PKCS1_SHA224 MBEDTLS_OID_PKCS1 "\x0e" /**< sha224WithRSAEncryption ::= { pkcs-1 14 } */
238#define MBEDTLS_OID_PKCS1_SHA256 MBEDTLS_OID_PKCS1 "\x0b" /**< sha256WithRSAEncryption ::= { pkcs-1 11 } */
239#define MBEDTLS_OID_PKCS1_SHA384 MBEDTLS_OID_PKCS1 "\x0c" /**< sha384WithRSAEncryption ::= { pkcs-1 12 } */
240#define MBEDTLS_OID_PKCS1_SHA512 MBEDTLS_OID_PKCS1 "\x0d" /**< sha512WithRSAEncryption ::= { pkcs-1 13 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200241
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242#define MBEDTLS_OID_RSA_SHA_OBS "\x2B\x0E\x03\x02\x1D"
Paul Bakkerc70b9822013-04-07 22:00:46 +0200243
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200244#define MBEDTLS_OID_PKCS9_EMAIL MBEDTLS_OID_PKCS9 "\x01" /**< emailAddress AttributeType ::= { pkcs-9 1 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200245
Manuel Pégourié-Gonnard59a75d52014-01-22 10:12:57 +0100246/* RFC 4055 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200247#define MBEDTLS_OID_RSASSA_PSS MBEDTLS_OID_PKCS1 "\x0a" /**< id-RSASSA-PSS ::= { pkcs-1 10 } */
248#define MBEDTLS_OID_MGF1 MBEDTLS_OID_PKCS1 "\x08" /**< id-mgf1 ::= { pkcs-1 8 } */
Manuel Pégourié-Gonnard59a75d52014-01-22 10:12:57 +0100249
Paul Bakker9b5e8852013-06-28 16:12:50 +0200250/*
251 * Digest algorithms
252 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253#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 } */
Gilles Peskine449bd832023-01-11 14:50:10 +0100254#define MBEDTLS_OID_DIGEST_ALG_SHA1 MBEDTLS_OID_ISO_IDENTIFIED_ORG \
255 MBEDTLS_OID_OIW_SECSIG_SHA1 /**< id-mbedtls_sha1 OBJECT IDENTIFIER ::= { iso(1) identified-organization(3) oiw(14) secsig(3) algorithms(2) 26 } */
Ron Eldor488fd082018-07-15 09:38:39 +0300256#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 } */
257#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 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200258
Ron Eldor488fd082018-07-15 09:38:39 +0300259#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 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200260
Ron Eldor488fd082018-07-15 09:38:39 +0300261#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 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200262
Jack Lloyd5d9c9632019-05-01 13:43:53 -0400263#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) } */
264
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200265#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 } */
Paul Bakker9b5e8852013-06-28 16:12:50 +0200266
Antonio Quartulli12ccef22017-12-20 07:03:55 +0800267#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 } */
268
269#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 } */
270
271#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 } */
272
273#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 } */
274
Paul Bakker9b5e8852013-06-28 16:12:50 +0200275/*
276 * Encryption algorithms
277 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100278#define MBEDTLS_OID_DES_CBC MBEDTLS_OID_ISO_IDENTIFIED_ORG \
279 MBEDTLS_OID_OIW_SECSIG_ALG "\x07" /**< desCBC OBJECT IDENTIFIER ::= { iso(1) identified-organization(3) oiw(14) secsig(3) algorithms(2) 7 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200280#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 } */
Ron Eldor488fd082018-07-15 09:38:39 +0300281#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 } */
Paul Bakker9b5e8852013-06-28 16:12:50 +0200282
283/*
Ron Eldor488fd082018-07-15 09:38:39 +0300284 * Key Wrapping algorithms
285 */
286/*
287 * RFC 5649
288 */
289#define MBEDTLS_OID_AES128_KW MBEDTLS_OID_AES "\x05" /** id-aes128-wrap OBJECT IDENTIFIER ::= { aes 5 } */
290#define MBEDTLS_OID_AES128_KWP MBEDTLS_OID_AES "\x08" /** id-aes128-wrap-pad OBJECT IDENTIFIER ::= { aes 8 } */
291#define MBEDTLS_OID_AES192_KW MBEDTLS_OID_AES "\x19" /** id-aes192-wrap OBJECT IDENTIFIER ::= { aes 25 } */
292#define MBEDTLS_OID_AES192_KWP MBEDTLS_OID_AES "\x1c" /** id-aes192-wrap-pad OBJECT IDENTIFIER ::= { aes 28 } */
293#define MBEDTLS_OID_AES256_KW MBEDTLS_OID_AES "\x2d" /** id-aes256-wrap OBJECT IDENTIFIER ::= { aes 45 } */
294#define MBEDTLS_OID_AES256_KWP MBEDTLS_OID_AES "\x30" /** id-aes256-wrap-pad OBJECT IDENTIFIER ::= { aes 48 } */
295/*
Paul Bakker9b5e8852013-06-28 16:12:50 +0200296 * PKCS#5 OIDs
297 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200298#define MBEDTLS_OID_PKCS5_PBKDF2 MBEDTLS_OID_PKCS5 "\x0c" /**< id-PBKDF2 OBJECT IDENTIFIER ::= {pkcs-5 12} */
299#define MBEDTLS_OID_PKCS5_PBES2 MBEDTLS_OID_PKCS5 "\x0d" /**< id-PBES2 OBJECT IDENTIFIER ::= {pkcs-5 13} */
300#define MBEDTLS_OID_PKCS5_PBMAC1 MBEDTLS_OID_PKCS5 "\x0e" /**< id-PBMAC1 OBJECT IDENTIFIER ::= {pkcs-5 14} */
Paul Bakker9b5e8852013-06-28 16:12:50 +0200301
302/*
303 * PKCS#5 PBES1 algorithms
304 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200305#define MBEDTLS_OID_PKCS5_PBE_MD5_DES_CBC MBEDTLS_OID_PKCS5 "\x03" /**< pbeWithMD5AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 3} */
306#define MBEDTLS_OID_PKCS5_PBE_MD5_RC2_CBC MBEDTLS_OID_PKCS5 "\x06" /**< pbeWithMD5AndRC2-CBC OBJECT IDENTIFIER ::= {pkcs-5 6} */
307#define MBEDTLS_OID_PKCS5_PBE_SHA1_DES_CBC MBEDTLS_OID_PKCS5 "\x0a" /**< pbeWithSHA1AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 10} */
308#define MBEDTLS_OID_PKCS5_PBE_SHA1_RC2_CBC MBEDTLS_OID_PKCS5 "\x0b" /**< pbeWithSHA1AndRC2-CBC OBJECT IDENTIFIER ::= {pkcs-5 11} */
Paul Bakker9b5e8852013-06-28 16:12:50 +0200309
Paul Bakker7749a222013-06-28 17:28:20 +0200310/*
Nayna Jainc9deb182020-11-16 19:03:12 +0000311 * PKCS#7 OIDs
312 */
313#define MBEDTLS_OID_PKCS7_DATA MBEDTLS_OID_PKCS7 "\x01" /**< Content type is Data OBJECT IDENTIFIER ::= {pkcs-7 1} */
314#define MBEDTLS_OID_PKCS7_SIGNED_DATA MBEDTLS_OID_PKCS7 "\x02" /**< Content type is Signed Data OBJECT IDENTIFIER ::= {pkcs-7 2} */
315#define MBEDTLS_OID_PKCS7_ENVELOPED_DATA MBEDTLS_OID_PKCS7 "\x03" /**< Content type is Enveloped Data OBJECT IDENTIFIER ::= {pkcs-7 3} */
316#define MBEDTLS_OID_PKCS7_SIGNED_AND_ENVELOPED_DATA MBEDTLS_OID_PKCS7 "\x04" /**< Content type is Signed and Enveloped Data OBJECT IDENTIFIER ::= {pkcs-7 4} */
317#define MBEDTLS_OID_PKCS7_DIGESTED_DATA MBEDTLS_OID_PKCS7 "\x05" /**< Content type is Digested Data OBJECT IDENTIFIER ::= {pkcs-7 5} */
318#define MBEDTLS_OID_PKCS7_ENCRYPTED_DATA MBEDTLS_OID_PKCS7 "\x06" /**< Content type is Encrypted Data OBJECT IDENTIFIER ::= {pkcs-7 6} */
319
320/*
Paul Bakkerfde42702013-08-25 14:47:27 +0200321 * PKCS#8 OIDs
322 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200323#define MBEDTLS_OID_PKCS9_CSR_EXT_REQ MBEDTLS_OID_PKCS9 "\x0e" /**< extensionRequest OBJECT IDENTIFIER ::= {pkcs-9 14} */
Paul Bakkerfde42702013-08-25 14:47:27 +0200324
325/*
Paul Bakker7749a222013-06-28 17:28:20 +0200326 * PKCS#12 PBE OIDs
327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328#define MBEDTLS_OID_PKCS12_PBE MBEDTLS_OID_PKCS12 "\x01" /**< pkcs-12PbeIds OBJECT IDENTIFIER ::= {pkcs-12 1} */
Paul Bakker7749a222013-06-28 17:28:20 +0200329
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200330#define MBEDTLS_OID_PKCS12_PBE_SHA1_DES3_EDE_CBC MBEDTLS_OID_PKCS12_PBE "\x03" /**< pbeWithSHAAnd3-KeyTripleDES-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 3} */
331#define MBEDTLS_OID_PKCS12_PBE_SHA1_DES2_EDE_CBC MBEDTLS_OID_PKCS12_PBE "\x04" /**< pbeWithSHAAnd2-KeyTripleDES-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 4} */
332#define MBEDTLS_OID_PKCS12_PBE_SHA1_RC2_128_CBC MBEDTLS_OID_PKCS12_PBE "\x05" /**< pbeWithSHAAnd128BitRC2-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 5} */
333#define MBEDTLS_OID_PKCS12_PBE_SHA1_RC2_40_CBC MBEDTLS_OID_PKCS12_PBE "\x06" /**< pbeWithSHAAnd40BitRC2-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 6} */
Paul Bakker7749a222013-06-28 17:28:20 +0200334
Manuel Pégourié-Gonnard5a9b82e2013-07-01 16:57:44 +0200335/*
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200336 * EC key algorithms from RFC 5480
Manuel Pégourié-Gonnard5a9b82e2013-07-01 16:57:44 +0200337 */
338
339/* id-ecPublicKey OBJECT IDENTIFIER ::= {
340 * iso(1) member-body(2) us(840) ansi-X9-62(10045) keyType(2) 1 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341#define MBEDTLS_OID_EC_ALG_UNRESTRICTED MBEDTLS_OID_ANSI_X9_62 "\x02\01"
Manuel Pégourié-Gonnard5a9b82e2013-07-01 16:57:44 +0200342
343/* id-ecDH OBJECT IDENTIFIER ::= {
344 * iso(1) identified-organization(3) certicom(132)
345 * schemes(1) ecdh(12) } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200346#define MBEDTLS_OID_EC_ALG_ECDH MBEDTLS_OID_CERTICOM "\x01\x0c"
Manuel Pégourié-Gonnard5a9b82e2013-07-01 16:57:44 +0200347
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200348/*
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100349 * ECParameters namedCurve identifiers, from RFC 5480, RFC 5639, and SEC2
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200350 */
351
352/* secp192r1 OBJECT IDENTIFIER ::= {
353 * iso(1) member-body(2) us(840) ansi-X9-62(10045) curves(3) prime(1) 1 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200354#define MBEDTLS_OID_EC_GRP_SECP192R1 MBEDTLS_OID_ANSI_X9_62 "\x03\x01\x01"
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200355
356/* secp224r1 OBJECT IDENTIFIER ::= {
357 * iso(1) identified-organization(3) certicom(132) curve(0) 33 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200358#define MBEDTLS_OID_EC_GRP_SECP224R1 MBEDTLS_OID_CERTICOM "\x00\x21"
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200359
360/* secp256r1 OBJECT IDENTIFIER ::= {
361 * iso(1) member-body(2) us(840) ansi-X9-62(10045) curves(3) prime(1) 7 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200362#define MBEDTLS_OID_EC_GRP_SECP256R1 MBEDTLS_OID_ANSI_X9_62 "\x03\x01\x07"
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200363
364/* secp384r1 OBJECT IDENTIFIER ::= {
365 * iso(1) identified-organization(3) certicom(132) curve(0) 34 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200366#define MBEDTLS_OID_EC_GRP_SECP384R1 MBEDTLS_OID_CERTICOM "\x00\x22"
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200367
368/* secp521r1 OBJECT IDENTIFIER ::= {
369 * iso(1) identified-organization(3) certicom(132) curve(0) 35 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200370#define MBEDTLS_OID_EC_GRP_SECP521R1 MBEDTLS_OID_CERTICOM "\x00\x23"
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200371
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100372/* secp192k1 OBJECT IDENTIFIER ::= {
373 * iso(1) identified-organization(3) certicom(132) curve(0) 31 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200374#define MBEDTLS_OID_EC_GRP_SECP192K1 MBEDTLS_OID_CERTICOM "\x00\x1f"
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100375
376/* secp224k1 OBJECT IDENTIFIER ::= {
377 * iso(1) identified-organization(3) certicom(132) curve(0) 32 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200378#define MBEDTLS_OID_EC_GRP_SECP224K1 MBEDTLS_OID_CERTICOM "\x00\x20"
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100379
380/* secp256k1 OBJECT IDENTIFIER ::= {
381 * iso(1) identified-organization(3) certicom(132) curve(0) 10 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200382#define MBEDTLS_OID_EC_GRP_SECP256K1 MBEDTLS_OID_CERTICOM "\x00\x0a"
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100383
Manuel Pégourié-Gonnard48ac3db2013-10-10 15:11:33 +0200384/* RFC 5639 4.1
385 * ecStdCurvesAndGeneration OBJECT IDENTIFIER::= {iso(1)
386 * identified-organization(3) teletrust(36) algorithm(3) signature-
387 * algorithm(3) ecSign(2) 8}
388 * ellipticCurve OBJECT IDENTIFIER ::= {ecStdCurvesAndGeneration 1}
389 * versionOne OBJECT IDENTIFIER ::= {ellipticCurve 1} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200390#define MBEDTLS_OID_EC_BRAINPOOL_V1 MBEDTLS_OID_TELETRUST "\x03\x03\x02\x08\x01\x01"
Manuel Pégourié-Gonnard48ac3db2013-10-10 15:11:33 +0200391
392/* brainpoolP256r1 OBJECT IDENTIFIER ::= {versionOne 7} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200393#define MBEDTLS_OID_EC_GRP_BP256R1 MBEDTLS_OID_EC_BRAINPOOL_V1 "\x07"
Manuel Pégourié-Gonnard48ac3db2013-10-10 15:11:33 +0200394
395/* brainpoolP384r1 OBJECT IDENTIFIER ::= {versionOne 11} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200396#define MBEDTLS_OID_EC_GRP_BP384R1 MBEDTLS_OID_EC_BRAINPOOL_V1 "\x0B"
Manuel Pégourié-Gonnard48ac3db2013-10-10 15:11:33 +0200397
398/* brainpoolP512r1 OBJECT IDENTIFIER ::= {versionOne 13} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200399#define MBEDTLS_OID_EC_GRP_BP512R1 MBEDTLS_OID_EC_BRAINPOOL_V1 "\x0D"
Manuel Pégourié-Gonnard48ac3db2013-10-10 15:11:33 +0200400
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200401/*
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100402 * SEC1 C.1
403 *
404 * prime-field OBJECT IDENTIFIER ::= { id-fieldType 1 }
405 * id-fieldType OBJECT IDENTIFIER ::= { ansi-X9-62 fieldType(1)}
406 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200407#define MBEDTLS_OID_ANSI_X9_62_FIELD_TYPE MBEDTLS_OID_ANSI_X9_62 "\x01"
408#define MBEDTLS_OID_ANSI_X9_62_PRIME_FIELD MBEDTLS_OID_ANSI_X9_62_FIELD_TYPE "\x01"
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100409
410/*
Paul Bakker75342a62014-04-08 17:35:40 +0200411 * ECDSA signature identifiers, from RFC 5480
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200412 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200413#define MBEDTLS_OID_ANSI_X9_62_SIG MBEDTLS_OID_ANSI_X9_62 "\x04" /* signatures(4) */
414#define MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 MBEDTLS_OID_ANSI_X9_62_SIG "\x03" /* ecdsa-with-SHA2(3) */
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200415
416/* ecdsa-with-SHA1 OBJECT IDENTIFIER ::= {
417 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4) 1 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200418#define MBEDTLS_OID_ECDSA_SHA1 MBEDTLS_OID_ANSI_X9_62_SIG "\x01"
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200419
420/* ecdsa-with-SHA224 OBJECT IDENTIFIER ::= {
421 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
422 * ecdsa-with-SHA2(3) 1 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200423#define MBEDTLS_OID_ECDSA_SHA224 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x01"
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200424
425/* ecdsa-with-SHA256 OBJECT IDENTIFIER ::= {
426 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
427 * ecdsa-with-SHA2(3) 2 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200428#define MBEDTLS_OID_ECDSA_SHA256 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x02"
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200429
430/* ecdsa-with-SHA384 OBJECT IDENTIFIER ::= {
431 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
432 * ecdsa-with-SHA2(3) 3 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200433#define MBEDTLS_OID_ECDSA_SHA384 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x03"
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200434
435/* ecdsa-with-SHA512 OBJECT IDENTIFIER ::= {
436 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
437 * ecdsa-with-SHA2(3) 4 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200438#define MBEDTLS_OID_ECDSA_SHA512 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x04"
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200439
Paul Bakkerc70b9822013-04-07 22:00:46 +0200440#ifdef __cplusplus
441extern "C" {
442#endif
443
444/**
445 * \brief Base OID descriptor structure
446 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100447typedef struct mbedtls_oid_descriptor_t {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200448 const char *MBEDTLS_PRIVATE(asn1); /*!< OID ASN.1 representation */
449 size_t MBEDTLS_PRIVATE(asn1_len); /*!< length of asn1 */
Hanno Becker612a2f12020-10-09 09:19:39 +0100450#if !defined(MBEDTLS_X509_REMOVE_INFO)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200451 const char *MBEDTLS_PRIVATE(name); /*!< official name (e.g. from RFC) */
452 const char *MBEDTLS_PRIVATE(description); /*!< human friendly description */
Peter Kolbus9a969b62018-12-11 13:55:56 -0600453#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200454} mbedtls_oid_descriptor_t;
Paul Bakkerc70b9822013-04-07 22:00:46 +0200455
456/**
457 * \brief Translate an ASN.1 OID into its numeric representation
458 * (e.g. "\x2A\x86\x48\x86\xF7\x0D" into "1.2.840.113549")
459 *
460 * \param buf buffer to put representation in
461 * \param size size of the buffer
462 * \param oid OID to translate
463 *
Manuel Pégourié-Gonnard7afdb882014-03-28 16:06:35 +0100464 * \return Length of the string written (excluding final NULL) or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200465 * MBEDTLS_ERR_OID_BUF_TOO_SMALL in case of error
Paul Bakkerc70b9822013-04-07 22:00:46 +0200466 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100467int mbedtls_oid_get_numeric_string(char *buf, size_t size, const mbedtls_asn1_buf *oid);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200468
469/**
David Horstmann92337c02023-01-18 18:40:49 +0000470 * \brief Translate a string containing a numeric representation
471 * of an ASN.1 OID into its encoded form
472 * (e.g. "1.2.840.113549" into "\x2A\x86\x48\x86\xF7\x0D")
David Horstmann59400ff2023-02-21 15:27:16 +0000473 * On success, this function allocates oid->buf from the
David Horstmann099be742023-02-23 13:51:43 +0000474 * heap. It must be freed by the caller using mbedtls_free().
David Horstmann92337c02023-01-18 18:40:49 +0000475 *
David Horstmann59400ff2023-02-21 15:27:16 +0000476 * \param oid mbedtls_asn1_buf to populate with the DER-encoded OID
477 * \param oid_str string representation of the OID to parse
478 * \param size length of the OID string
David Horstmann92337c02023-01-18 18:40:49 +0000479 *
David Horstmann59400ff2023-02-21 15:27:16 +0000480 * \return 0 if successful
481 * \return #MBEDTLS_ERR_ASN1_INVALID_DATA if oid_str does not
482 * represent a valid OID
483 * \return #MBEDTLS_ERR_ASN1_ALLOC_FAILED if the function fails to
484 * allocate oid->buf
David Horstmann92337c02023-01-18 18:40:49 +0000485 */
David Horstmann59400ff2023-02-21 15:27:16 +0000486int mbedtls_oid_from_numeric_string(mbedtls_asn1_buf *oid, const char *oid_str, size_t size);
David Horstmann92337c02023-01-18 18:40:49 +0000487
488/**
Paul Bakkerc70b9822013-04-07 22:00:46 +0200489 * \brief Translate an X.509 extension OID into local values
490 *
491 * \param oid OID to use
492 * \param ext_type place to store the extension type
493 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200494 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200495 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100496int mbedtls_oid_get_x509_ext_type(const mbedtls_asn1_buf *oid, int *ext_type);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200497
498/**
499 * \brief Translate an X.509 attribute type OID into the short name
500 * (e.g. the OID for an X520 Common Name into "CN")
501 *
502 * \param oid OID to use
503 * \param short_name place to store the string pointer
504 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200505 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200506 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100507int mbedtls_oid_get_attr_short_name(const mbedtls_asn1_buf *oid, const char **short_name);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200508
509/**
510 * \brief Translate PublicKeyAlgorithm OID into pk_type
511 *
512 * \param oid OID to use
513 * \param pk_alg place to store public key algorithm
514 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200515 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200516 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100517int mbedtls_oid_get_pk_alg(const mbedtls_asn1_buf *oid, mbedtls_pk_type_t *pk_alg);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200518
Manuel Pégourié-Gonnardedda9042013-09-12 02:17:54 +0200519/**
520 * \brief Translate pk_type into PublicKeyAlgorithm OID
521 *
522 * \param pk_alg Public key type to look for
523 * \param oid place to store ASN.1 OID string pointer
524 * \param olen length of the OID
525 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Manuel Pégourié-Gonnardedda9042013-09-12 02:17:54 +0200527 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100528int mbedtls_oid_get_oid_by_pk_alg(mbedtls_pk_type_t pk_alg,
529 const char **oid, size_t *olen);
Manuel Pégourié-Gonnardedda9042013-09-12 02:17:54 +0200530
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200531#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200532/**
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200533 * \brief Translate NamedCurve OID into an EC group identifier
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200534 *
535 * \param oid OID to use
536 * \param grp_id place to store group id
537 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200538 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200539 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100540int mbedtls_oid_get_ec_grp(const mbedtls_asn1_buf *oid, mbedtls_ecp_group_id *grp_id);
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200541
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200542/**
Manuel Pégourié-Gonnardedda9042013-09-12 02:17:54 +0200543 * \brief Translate EC group identifier into NamedCurve OID
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200544 *
Manuel Pégourié-Gonnardedda9042013-09-12 02:17:54 +0200545 * \param grp_id EC group identifier
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200546 * \param oid place to store ASN.1 OID string pointer
547 * \param olen length of the OID
548 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200549 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200550 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100551int mbedtls_oid_get_oid_by_ec_grp(mbedtls_ecp_group_id grp_id,
552 const char **oid, size_t *olen);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200553#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200554
Paul Bakkerc70b9822013-04-07 22:00:46 +0200555/**
556 * \brief Translate SignatureAlgorithm OID into md_type and pk_type
557 *
558 * \param oid OID to use
559 * \param md_alg place to store message digest algorithm
560 * \param pk_alg place to store public key algorithm
561 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200562 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200563 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100564int mbedtls_oid_get_sig_alg(const mbedtls_asn1_buf *oid,
565 mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200566
567/**
568 * \brief Translate SignatureAlgorithm OID into description
569 *
570 * \param oid OID to use
571 * \param desc place to store string pointer
572 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200573 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200574 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100575int mbedtls_oid_get_sig_alg_desc(const mbedtls_asn1_buf *oid, const char **desc);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200576
577/**
578 * \brief Translate md_type and pk_type into SignatureAlgorithm OID
579 *
580 * \param md_alg message digest algorithm
581 * \param pk_alg public key algorithm
582 * \param oid place to store ASN.1 OID string pointer
Paul Bakker1c3853b2013-09-10 11:43:44 +0200583 * \param olen length of the OID
Paul Bakkerc70b9822013-04-07 22:00:46 +0200584 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200585 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200586 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100587int mbedtls_oid_get_oid_by_sig_alg(mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg,
588 const char **oid, size_t *olen);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200589
590/**
Antonio Quartulli12ccef22017-12-20 07:03:55 +0800591 * \brief Translate hmac algorithm OID into md_type
592 *
593 * \param oid OID to use
594 * \param md_hmac place to store message hmac algorithm
595 *
596 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
597 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100598int mbedtls_oid_get_md_hmac(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_hmac);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200599
Manuel Pégourié-Gonnardfe2b9b52022-07-05 11:35:52 +0200600/**
601 * \brief Translate hash algorithm OID into md_type
602 *
603 * \param oid OID to use
604 * \param md_alg place to store message digest algorithm
605 *
606 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
607 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100608int mbedtls_oid_get_md_alg(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_alg);
Manuel Pégourié-Gonnardfe2b9b52022-07-05 11:35:52 +0200609
Hanno Becker612a2f12020-10-09 09:19:39 +0100610#if !defined(MBEDTLS_X509_REMOVE_INFO)
Paul Bakkerc70b9822013-04-07 22:00:46 +0200611/**
612 * \brief Translate Extended Key Usage OID into description
613 *
614 * \param oid OID to use
615 * \param desc place to store string pointer
616 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200618 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100619int mbedtls_oid_get_extended_key_usage(const mbedtls_asn1_buf *oid, const char **desc);
Peter Kolbus9a969b62018-12-11 13:55:56 -0600620#endif
Paul Bakkerc70b9822013-04-07 22:00:46 +0200621
622/**
Ron Eldor11ee0712019-03-25 18:22:52 +0200623 * \brief Translate certificate policies OID into description
624 *
625 * \param oid OID to use
626 * \param desc place to store string pointer
627 *
628 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
629 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100630int mbedtls_oid_get_certificate_policies(const mbedtls_asn1_buf *oid, const char **desc);
Ron Eldor11ee0712019-03-25 18:22:52 +0200631
632/**
Paul Bakkerc70b9822013-04-07 22:00:46 +0200633 * \brief Translate md_type into hash algorithm OID
634 *
635 * \param md_alg message digest algorithm
636 * \param oid place to store ASN.1 OID string pointer
Paul Bakker1c3853b2013-09-10 11:43:44 +0200637 * \param olen length of the OID
Paul Bakkerc70b9822013-04-07 22:00:46 +0200638 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200639 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200640 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100641int mbedtls_oid_get_oid_by_md(mbedtls_md_type_t md_alg, const char **oid, size_t *olen);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200642
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200643#if defined(MBEDTLS_CIPHER_C)
Paul Bakker9b5e8852013-06-28 16:12:50 +0200644/**
645 * \brief Translate encryption algorithm OID into cipher_type
646 *
647 * \param oid OID to use
648 * \param cipher_alg place to store cipher algorithm
649 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200650 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakker9b5e8852013-06-28 16:12:50 +0200651 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100652int mbedtls_oid_get_cipher_alg(const mbedtls_asn1_buf *oid, mbedtls_cipher_type_t *cipher_alg);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200653#endif /* MBEDTLS_CIPHER_C */
Paul Bakker9b5e8852013-06-28 16:12:50 +0200654
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200655#if defined(MBEDTLS_PKCS12_C)
Paul Bakker7749a222013-06-28 17:28:20 +0200656/**
657 * \brief Translate PKCS#12 PBE algorithm OID into md_type and
658 * cipher_type
659 *
660 * \param oid OID to use
661 * \param md_alg place to store message digest algorithm
662 * \param cipher_alg place to store cipher algorithm
663 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200664 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakker7749a222013-06-28 17:28:20 +0200665 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100666int mbedtls_oid_get_pkcs12_pbe_alg(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_alg,
667 mbedtls_cipher_type_t *cipher_alg);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200668#endif /* MBEDTLS_PKCS12_C */
Paul Bakker7749a222013-06-28 17:28:20 +0200669
Paul Bakkerc70b9822013-04-07 22:00:46 +0200670#ifdef __cplusplus
671}
672#endif
673
674#endif /* oid.h */