blob: 1d73506dc4712ddfa296e6688607e18de3251b9e [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/*
David Horstmann96435752023-04-26 11:50:14 +010067 * Maximum number of OID components allowed
68 */
69#define MBEDTLS_OID_MAX_COMPONENTS 128
70
71/*
Paul Bakkerc70b9822013-04-07 22:00:46 +020072 * Top level OID tuples
73 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020074#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)} */
Paul Bakkerc70b9822013-04-07 22:00:46 +020078
79/*
80 * ISO Member bodies OID parts
81 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020082#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 \
Gilles Peskine449bd832023-01-11 14:50:10 +010085 MBEDTLS_OID_ORG_RSA_DATA_SECURITY /* {iso(1) member-body(2) us(840) rsadsi(113549)} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020086#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 \
Gilles Peskine449bd832023-01-11 14:50:10 +010088 MBEDTLS_OID_ORG_ANSI_X9_62
Paul Bakkerc70b9822013-04-07 22:00:46 +020089
90/*
91 * ISO Identified organization OID parts
92 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020093#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_CERTICOM "\x81\x04" /* certicom(132) */
Gilles Peskine449bd832023-01-11 14:50:10 +010099#define MBEDTLS_OID_CERTICOM MBEDTLS_OID_ISO_IDENTIFIED_ORG \
100 MBEDTLS_OID_ORG_CERTICOM
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200101#define MBEDTLS_OID_ORG_TELETRUST "\x24" /* teletrust(36) */
Gilles Peskine449bd832023-01-11 14:50:10 +0100102#define MBEDTLS_OID_TELETRUST MBEDTLS_OID_ISO_IDENTIFIED_ORG \
103 MBEDTLS_OID_ORG_TELETRUST
Paul Bakkerc70b9822013-04-07 22:00:46 +0200104
105/*
106 * ISO ITU OID parts
107 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200108#define MBEDTLS_OID_ORGANIZATION "\x01" /* {organization(1)} */
Gilles Peskine449bd832023-01-11 14:50:10 +0100109#define MBEDTLS_OID_ISO_ITU_US_ORG MBEDTLS_OID_ISO_ITU_COUNTRY MBEDTLS_OID_COUNTRY_US \
110 MBEDTLS_OID_ORGANIZATION /* {joint-iso-itu-t(2) country(16) us(840) organization(1)} */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200111
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112#define MBEDTLS_OID_ORG_GOV "\x65" /* {gov(101)} */
113#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 +0200114
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200115#define MBEDTLS_OID_ORG_NETSCAPE "\x86\xF8\x42" /* {netscape(113730)} */
116#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 +0200117
118/* ISO arc for standard certificate and CRL extensions */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200119#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 +0200120
Ron Eldor488fd082018-07-15 09:38:39 +0300121#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) */
122
Paul Bakkerc70b9822013-04-07 22:00:46 +0200123/**
124 * Private Internet Extensions
125 * { iso(1) identified-organization(3) dod(6) internet(1)
126 * security(5) mechanisms(5) pkix(7) }
127 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100128#define MBEDTLS_OID_INTERNET MBEDTLS_OID_ISO_IDENTIFIED_ORG MBEDTLS_OID_ORG_DOD \
129 "\x01"
Ron Eldorb6dc1052019-04-01 18:12:23 +0300130#define MBEDTLS_OID_PKIX MBEDTLS_OID_INTERNET "\x05\x05\x07"
Paul Bakkerc70b9822013-04-07 22:00:46 +0200131
132/*
133 * Arc for standard naming attributes
134 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200135#define MBEDTLS_OID_AT MBEDTLS_OID_ISO_CCITT_DS "\x04" /**< id-at OBJECT IDENTIFIER ::= {joint-iso-ccitt(2) ds(5) 4} */
136#define MBEDTLS_OID_AT_CN MBEDTLS_OID_AT "\x03" /**< id-at-commonName AttributeType:= {id-at 3} */
137#define MBEDTLS_OID_AT_SUR_NAME MBEDTLS_OID_AT "\x04" /**< id-at-surName AttributeType:= {id-at 4} */
138#define MBEDTLS_OID_AT_SERIAL_NUMBER MBEDTLS_OID_AT "\x05" /**< id-at-serialNumber AttributeType:= {id-at 5} */
139#define MBEDTLS_OID_AT_COUNTRY MBEDTLS_OID_AT "\x06" /**< id-at-countryName AttributeType:= {id-at 6} */
140#define MBEDTLS_OID_AT_LOCALITY MBEDTLS_OID_AT "\x07" /**< id-at-locality AttributeType:= {id-at 7} */
141#define MBEDTLS_OID_AT_STATE MBEDTLS_OID_AT "\x08" /**< id-at-state AttributeType:= {id-at 8} */
142#define MBEDTLS_OID_AT_ORGANIZATION MBEDTLS_OID_AT "\x0A" /**< id-at-organizationName AttributeType:= {id-at 10} */
143#define MBEDTLS_OID_AT_ORG_UNIT MBEDTLS_OID_AT "\x0B" /**< id-at-organizationalUnitName AttributeType:= {id-at 11} */
144#define MBEDTLS_OID_AT_TITLE MBEDTLS_OID_AT "\x0C" /**< id-at-title AttributeType:= {id-at 12} */
145#define MBEDTLS_OID_AT_POSTAL_ADDRESS MBEDTLS_OID_AT "\x10" /**< id-at-postalAddress AttributeType:= {id-at 16} */
146#define MBEDTLS_OID_AT_POSTAL_CODE MBEDTLS_OID_AT "\x11" /**< id-at-postalCode AttributeType:= {id-at 17} */
147#define MBEDTLS_OID_AT_GIVEN_NAME MBEDTLS_OID_AT "\x2A" /**< id-at-givenName AttributeType:= {id-at 42} */
148#define MBEDTLS_OID_AT_INITIALS MBEDTLS_OID_AT "\x2B" /**< id-at-initials AttributeType:= {id-at 43} */
149#define MBEDTLS_OID_AT_GENERATION_QUALIFIER MBEDTLS_OID_AT "\x2C" /**< id-at-generationQualifier AttributeType:= {id-at 44} */
Tom Cosgrove1e211442022-05-26 11:51:00 +0100150#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 +0200151#define MBEDTLS_OID_AT_DN_QUALIFIER MBEDTLS_OID_AT "\x2E" /**< id-at-dnQualifier AttributeType:= {id-at 46} */
152#define MBEDTLS_OID_AT_PSEUDONYM MBEDTLS_OID_AT "\x41" /**< id-at-pseudonym AttributeType:= {id-at 65} */
Paul Bakker63844402014-04-30 15:34:12 +0200153
Micah N Gorrell21d4bdb2021-05-12 17:41:24 -0600154#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 +0200155#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 +0200156
157/*
158 * OIDs for standard certificate extensions
159 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200160#define MBEDTLS_OID_AUTHORITY_KEY_IDENTIFIER MBEDTLS_OID_ID_CE "\x23" /**< id-ce-authorityKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 35 } */
161#define MBEDTLS_OID_SUBJECT_KEY_IDENTIFIER MBEDTLS_OID_ID_CE "\x0E" /**< id-ce-subjectKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 14 } */
162#define MBEDTLS_OID_KEY_USAGE MBEDTLS_OID_ID_CE "\x0F" /**< id-ce-keyUsage OBJECT IDENTIFIER ::= { id-ce 15 } */
163#define MBEDTLS_OID_CERTIFICATE_POLICIES MBEDTLS_OID_ID_CE "\x20" /**< id-ce-certificatePolicies OBJECT IDENTIFIER ::= { id-ce 32 } */
164#define MBEDTLS_OID_POLICY_MAPPINGS MBEDTLS_OID_ID_CE "\x21" /**< id-ce-policyMappings OBJECT IDENTIFIER ::= { id-ce 33 } */
165#define MBEDTLS_OID_SUBJECT_ALT_NAME MBEDTLS_OID_ID_CE "\x11" /**< id-ce-subjectAltName OBJECT IDENTIFIER ::= { id-ce 17 } */
166#define MBEDTLS_OID_ISSUER_ALT_NAME MBEDTLS_OID_ID_CE "\x12" /**< id-ce-issuerAltName OBJECT IDENTIFIER ::= { id-ce 18 } */
167#define MBEDTLS_OID_SUBJECT_DIRECTORY_ATTRS MBEDTLS_OID_ID_CE "\x09" /**< id-ce-subjectDirectoryAttributes OBJECT IDENTIFIER ::= { id-ce 9 } */
168#define MBEDTLS_OID_BASIC_CONSTRAINTS MBEDTLS_OID_ID_CE "\x13" /**< id-ce-basicConstraints OBJECT IDENTIFIER ::= { id-ce 19 } */
169#define MBEDTLS_OID_NAME_CONSTRAINTS MBEDTLS_OID_ID_CE "\x1E" /**< id-ce-nameConstraints OBJECT IDENTIFIER ::= { id-ce 30 } */
170#define MBEDTLS_OID_POLICY_CONSTRAINTS MBEDTLS_OID_ID_CE "\x24" /**< id-ce-policyConstraints OBJECT IDENTIFIER ::= { id-ce 36 } */
171#define MBEDTLS_OID_EXTENDED_KEY_USAGE MBEDTLS_OID_ID_CE "\x25" /**< id-ce-extKeyUsage OBJECT IDENTIFIER ::= { id-ce 37 } */
172#define MBEDTLS_OID_CRL_DISTRIBUTION_POINTS MBEDTLS_OID_ID_CE "\x1F" /**< id-ce-cRLDistributionPoints OBJECT IDENTIFIER ::= { id-ce 31 } */
173#define MBEDTLS_OID_INIHIBIT_ANYPOLICY MBEDTLS_OID_ID_CE "\x36" /**< id-ce-inhibitAnyPolicy OBJECT IDENTIFIER ::= { id-ce 54 } */
174#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 +0200175
176/*
Ron Eldor11ee0712019-03-25 18:22:52 +0200177 * Certificate policies
178 */
179#define MBEDTLS_OID_ANY_POLICY MBEDTLS_OID_CERTIFICATE_POLICIES "\x00" /**< anyPolicy OBJECT IDENTIFIER ::= { id-ce-certificatePolicies 0 } */
180
181/*
Paul Bakkerc70b9822013-04-07 22:00:46 +0200182 * Netscape certificate extensions
183 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184#define MBEDTLS_OID_NS_CERT MBEDTLS_OID_NETSCAPE "\x01"
185#define MBEDTLS_OID_NS_CERT_TYPE MBEDTLS_OID_NS_CERT "\x01"
186#define MBEDTLS_OID_NS_BASE_URL MBEDTLS_OID_NS_CERT "\x02"
187#define MBEDTLS_OID_NS_REVOCATION_URL MBEDTLS_OID_NS_CERT "\x03"
188#define MBEDTLS_OID_NS_CA_REVOCATION_URL MBEDTLS_OID_NS_CERT "\x04"
189#define MBEDTLS_OID_NS_RENEWAL_URL MBEDTLS_OID_NS_CERT "\x07"
190#define MBEDTLS_OID_NS_CA_POLICY_URL MBEDTLS_OID_NS_CERT "\x08"
191#define MBEDTLS_OID_NS_SSL_SERVER_NAME MBEDTLS_OID_NS_CERT "\x0C"
192#define MBEDTLS_OID_NS_COMMENT MBEDTLS_OID_NS_CERT "\x0D"
193#define MBEDTLS_OID_NS_DATA_TYPE MBEDTLS_OID_NETSCAPE "\x02"
194#define MBEDTLS_OID_NS_CERT_SEQUENCE MBEDTLS_OID_NS_DATA_TYPE "\x05"
Paul Bakkerc70b9822013-04-07 22:00:46 +0200195
196/*
197 * OIDs for CRL extensions
198 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199#define MBEDTLS_OID_PRIVATE_KEY_USAGE_PERIOD MBEDTLS_OID_ID_CE "\x10"
200#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 +0200201
202/*
203 * X.509 v3 Extended key usage OIDs
204 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200205#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 +0200206
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200207#define MBEDTLS_OID_KP MBEDTLS_OID_PKIX "\x03" /**< id-kp OBJECT IDENTIFIER ::= { id-pkix 3 } */
208#define MBEDTLS_OID_SERVER_AUTH MBEDTLS_OID_KP "\x01" /**< id-kp-serverAuth OBJECT IDENTIFIER ::= { id-kp 1 } */
209#define MBEDTLS_OID_CLIENT_AUTH MBEDTLS_OID_KP "\x02" /**< id-kp-clientAuth OBJECT IDENTIFIER ::= { id-kp 2 } */
210#define MBEDTLS_OID_CODE_SIGNING MBEDTLS_OID_KP "\x03" /**< id-kp-codeSigning OBJECT IDENTIFIER ::= { id-kp 3 } */
211#define MBEDTLS_OID_EMAIL_PROTECTION MBEDTLS_OID_KP "\x04" /**< id-kp-emailProtection OBJECT IDENTIFIER ::= { id-kp 4 } */
212#define MBEDTLS_OID_TIME_STAMPING MBEDTLS_OID_KP "\x08" /**< id-kp-timeStamping OBJECT IDENTIFIER ::= { id-kp 8 } */
213#define MBEDTLS_OID_OCSP_SIGNING MBEDTLS_OID_KP "\x09" /**< id-kp-OCSPSigning OBJECT IDENTIFIER ::= { id-kp 9 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200214
Ron Eldorb6dc1052019-04-01 18:12:23 +0300215/**
216 * Wi-SUN Alliance Field Area Network
217 * { iso(1) identified-organization(3) dod(6) internet(1)
218 * private(4) enterprise(1) WiSUN(45605) FieldAreaNetwork(1) }
219 */
Ron Eldor3c4734a2019-03-25 14:05:23 +0200220#define MBEDTLS_OID_WISUN_FAN MBEDTLS_OID_INTERNET "\x04\x01\x82\xe4\x25\x01"
Ron Eldorb6dc1052019-04-01 18:12:23 +0300221
Ron Eldorb2dc3fa2019-03-21 13:40:13 +0200222#define MBEDTLS_OID_ON MBEDTLS_OID_PKIX "\x08" /**< id-on OBJECT IDENTIFIER ::= { id-pkix 8 } */
223#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 +0200224
225/*
Paul Bakkerc70b9822013-04-07 22:00:46 +0200226 * PKCS definition OIDs
Paul Bakker9b5e8852013-06-28 16:12:50 +0200227 */
228
229#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 +0200230#define MBEDTLS_OID_PKCS1 MBEDTLS_OID_PKCS "\x01" /**< pkcs-1 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 1 } */
231#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 +0000232#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 +0200233#define MBEDTLS_OID_PKCS9 MBEDTLS_OID_PKCS "\x09" /**< pkcs-9 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 9 } */
234#define MBEDTLS_OID_PKCS12 MBEDTLS_OID_PKCS "\x0c" /**< pkcs-12 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 12 } */
235
236/*
237 * PKCS#1 OIDs
238 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200239#define MBEDTLS_OID_PKCS1_RSA MBEDTLS_OID_PKCS1 "\x01" /**< rsaEncryption OBJECT IDENTIFIER ::= { pkcs-1 1 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240#define MBEDTLS_OID_PKCS1_MD5 MBEDTLS_OID_PKCS1 "\x04" /**< md5WithRSAEncryption ::= { pkcs-1 4 } */
241#define MBEDTLS_OID_PKCS1_SHA1 MBEDTLS_OID_PKCS1 "\x05" /**< sha1WithRSAEncryption ::= { pkcs-1 5 } */
242#define MBEDTLS_OID_PKCS1_SHA224 MBEDTLS_OID_PKCS1 "\x0e" /**< sha224WithRSAEncryption ::= { pkcs-1 14 } */
243#define MBEDTLS_OID_PKCS1_SHA256 MBEDTLS_OID_PKCS1 "\x0b" /**< sha256WithRSAEncryption ::= { pkcs-1 11 } */
244#define MBEDTLS_OID_PKCS1_SHA384 MBEDTLS_OID_PKCS1 "\x0c" /**< sha384WithRSAEncryption ::= { pkcs-1 12 } */
245#define MBEDTLS_OID_PKCS1_SHA512 MBEDTLS_OID_PKCS1 "\x0d" /**< sha512WithRSAEncryption ::= { pkcs-1 13 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200246
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200247#define MBEDTLS_OID_RSA_SHA_OBS "\x2B\x0E\x03\x02\x1D"
Paul Bakkerc70b9822013-04-07 22:00:46 +0200248
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249#define MBEDTLS_OID_PKCS9_EMAIL MBEDTLS_OID_PKCS9 "\x01" /**< emailAddress AttributeType ::= { pkcs-9 1 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200250
Manuel Pégourié-Gonnard59a75d52014-01-22 10:12:57 +0100251/* RFC 4055 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200252#define MBEDTLS_OID_RSASSA_PSS MBEDTLS_OID_PKCS1 "\x0a" /**< id-RSASSA-PSS ::= { pkcs-1 10 } */
253#define MBEDTLS_OID_MGF1 MBEDTLS_OID_PKCS1 "\x08" /**< id-mgf1 ::= { pkcs-1 8 } */
Manuel Pégourié-Gonnard59a75d52014-01-22 10:12:57 +0100254
Paul Bakker9b5e8852013-06-28 16:12:50 +0200255/*
256 * Digest algorithms
257 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200258#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 +0100259#define MBEDTLS_OID_DIGEST_ALG_SHA1 MBEDTLS_OID_ISO_IDENTIFIED_ORG \
260 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 +0300261#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 } */
262#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 +0200263
Ron Eldor488fd082018-07-15 09:38:39 +0300264#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 +0200265
Ron Eldor488fd082018-07-15 09:38:39 +0300266#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 +0200267
Jack Lloyd5d9c9632019-05-01 13:43:53 -0400268#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) } */
269
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200270#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 +0200271
Antonio Quartulli12ccef22017-12-20 07:03:55 +0800272#define MBEDTLS_OID_HMAC_SHA224 MBEDTLS_OID_RSA_COMPANY "\x02\x08" /**< id-hmacWithSHA224 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 8 } */
273
274#define MBEDTLS_OID_HMAC_SHA256 MBEDTLS_OID_RSA_COMPANY "\x02\x09" /**< id-hmacWithSHA256 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 9 } */
275
276#define MBEDTLS_OID_HMAC_SHA384 MBEDTLS_OID_RSA_COMPANY "\x02\x0A" /**< id-hmacWithSHA384 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 10 } */
277
278#define MBEDTLS_OID_HMAC_SHA512 MBEDTLS_OID_RSA_COMPANY "\x02\x0B" /**< id-hmacWithSHA512 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 11 } */
279
Paul Bakker9b5e8852013-06-28 16:12:50 +0200280/*
281 * Encryption algorithms
282 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100283#define MBEDTLS_OID_DES_CBC MBEDTLS_OID_ISO_IDENTIFIED_ORG \
284 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 +0200285#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 +0300286#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 +0200287
288/*
Ron Eldor488fd082018-07-15 09:38:39 +0300289 * Key Wrapping algorithms
290 */
291/*
292 * RFC 5649
293 */
294#define MBEDTLS_OID_AES128_KW MBEDTLS_OID_AES "\x05" /** id-aes128-wrap OBJECT IDENTIFIER ::= { aes 5 } */
295#define MBEDTLS_OID_AES128_KWP MBEDTLS_OID_AES "\x08" /** id-aes128-wrap-pad OBJECT IDENTIFIER ::= { aes 8 } */
296#define MBEDTLS_OID_AES192_KW MBEDTLS_OID_AES "\x19" /** id-aes192-wrap OBJECT IDENTIFIER ::= { aes 25 } */
297#define MBEDTLS_OID_AES192_KWP MBEDTLS_OID_AES "\x1c" /** id-aes192-wrap-pad OBJECT IDENTIFIER ::= { aes 28 } */
298#define MBEDTLS_OID_AES256_KW MBEDTLS_OID_AES "\x2d" /** id-aes256-wrap OBJECT IDENTIFIER ::= { aes 45 } */
299#define MBEDTLS_OID_AES256_KWP MBEDTLS_OID_AES "\x30" /** id-aes256-wrap-pad OBJECT IDENTIFIER ::= { aes 48 } */
300/*
Paul Bakker9b5e8852013-06-28 16:12:50 +0200301 * PKCS#5 OIDs
302 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200303#define MBEDTLS_OID_PKCS5_PBKDF2 MBEDTLS_OID_PKCS5 "\x0c" /**< id-PBKDF2 OBJECT IDENTIFIER ::= {pkcs-5 12} */
304#define MBEDTLS_OID_PKCS5_PBES2 MBEDTLS_OID_PKCS5 "\x0d" /**< id-PBES2 OBJECT IDENTIFIER ::= {pkcs-5 13} */
305#define MBEDTLS_OID_PKCS5_PBMAC1 MBEDTLS_OID_PKCS5 "\x0e" /**< id-PBMAC1 OBJECT IDENTIFIER ::= {pkcs-5 14} */
Paul Bakker9b5e8852013-06-28 16:12:50 +0200306
307/*
308 * PKCS#5 PBES1 algorithms
309 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200310#define MBEDTLS_OID_PKCS5_PBE_MD5_DES_CBC MBEDTLS_OID_PKCS5 "\x03" /**< pbeWithMD5AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 3} */
311#define MBEDTLS_OID_PKCS5_PBE_MD5_RC2_CBC MBEDTLS_OID_PKCS5 "\x06" /**< pbeWithMD5AndRC2-CBC OBJECT IDENTIFIER ::= {pkcs-5 6} */
312#define MBEDTLS_OID_PKCS5_PBE_SHA1_DES_CBC MBEDTLS_OID_PKCS5 "\x0a" /**< pbeWithSHA1AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 10} */
313#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 +0200314
Paul Bakker7749a222013-06-28 17:28:20 +0200315/*
Nayna Jainc9deb182020-11-16 19:03:12 +0000316 * PKCS#7 OIDs
317 */
318#define MBEDTLS_OID_PKCS7_DATA MBEDTLS_OID_PKCS7 "\x01" /**< Content type is Data OBJECT IDENTIFIER ::= {pkcs-7 1} */
319#define MBEDTLS_OID_PKCS7_SIGNED_DATA MBEDTLS_OID_PKCS7 "\x02" /**< Content type is Signed Data OBJECT IDENTIFIER ::= {pkcs-7 2} */
320#define MBEDTLS_OID_PKCS7_ENVELOPED_DATA MBEDTLS_OID_PKCS7 "\x03" /**< Content type is Enveloped Data OBJECT IDENTIFIER ::= {pkcs-7 3} */
321#define MBEDTLS_OID_PKCS7_SIGNED_AND_ENVELOPED_DATA MBEDTLS_OID_PKCS7 "\x04" /**< Content type is Signed and Enveloped Data OBJECT IDENTIFIER ::= {pkcs-7 4} */
322#define MBEDTLS_OID_PKCS7_DIGESTED_DATA MBEDTLS_OID_PKCS7 "\x05" /**< Content type is Digested Data OBJECT IDENTIFIER ::= {pkcs-7 5} */
323#define MBEDTLS_OID_PKCS7_ENCRYPTED_DATA MBEDTLS_OID_PKCS7 "\x06" /**< Content type is Encrypted Data OBJECT IDENTIFIER ::= {pkcs-7 6} */
324
325/*
Paul Bakkerfde42702013-08-25 14:47:27 +0200326 * PKCS#8 OIDs
327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328#define MBEDTLS_OID_PKCS9_CSR_EXT_REQ MBEDTLS_OID_PKCS9 "\x0e" /**< extensionRequest OBJECT IDENTIFIER ::= {pkcs-9 14} */
Paul Bakkerfde42702013-08-25 14:47:27 +0200329
330/*
Paul Bakker7749a222013-06-28 17:28:20 +0200331 * PKCS#12 PBE OIDs
332 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200333#define MBEDTLS_OID_PKCS12_PBE MBEDTLS_OID_PKCS12 "\x01" /**< pkcs-12PbeIds OBJECT IDENTIFIER ::= {pkcs-12 1} */
Paul Bakker7749a222013-06-28 17:28:20 +0200334
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200335#define MBEDTLS_OID_PKCS12_PBE_SHA1_DES3_EDE_CBC MBEDTLS_OID_PKCS12_PBE "\x03" /**< pbeWithSHAAnd3-KeyTripleDES-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 3} */
336#define MBEDTLS_OID_PKCS12_PBE_SHA1_DES2_EDE_CBC MBEDTLS_OID_PKCS12_PBE "\x04" /**< pbeWithSHAAnd2-KeyTripleDES-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 4} */
337#define MBEDTLS_OID_PKCS12_PBE_SHA1_RC2_128_CBC MBEDTLS_OID_PKCS12_PBE "\x05" /**< pbeWithSHAAnd128BitRC2-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 5} */
338#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 +0200339
Manuel Pégourié-Gonnard5a9b82e2013-07-01 16:57:44 +0200340/*
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200341 * EC key algorithms from RFC 5480
Manuel Pégourié-Gonnard5a9b82e2013-07-01 16:57:44 +0200342 */
343
344/* id-ecPublicKey OBJECT IDENTIFIER ::= {
345 * iso(1) member-body(2) us(840) ansi-X9-62(10045) keyType(2) 1 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200346#define MBEDTLS_OID_EC_ALG_UNRESTRICTED MBEDTLS_OID_ANSI_X9_62 "\x02\01"
Manuel Pégourié-Gonnard5a9b82e2013-07-01 16:57:44 +0200347
348/* id-ecDH OBJECT IDENTIFIER ::= {
349 * iso(1) identified-organization(3) certicom(132)
350 * schemes(1) ecdh(12) } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200351#define MBEDTLS_OID_EC_ALG_ECDH MBEDTLS_OID_CERTICOM "\x01\x0c"
Manuel Pégourié-Gonnard5a9b82e2013-07-01 16:57:44 +0200352
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200353/*
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100354 * ECParameters namedCurve identifiers, from RFC 5480, RFC 5639, and SEC2
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200355 */
356
357/* secp192r1 OBJECT IDENTIFIER ::= {
358 * 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 +0200359#define MBEDTLS_OID_EC_GRP_SECP192R1 MBEDTLS_OID_ANSI_X9_62 "\x03\x01\x01"
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200360
361/* secp224r1 OBJECT IDENTIFIER ::= {
362 * iso(1) identified-organization(3) certicom(132) curve(0) 33 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200363#define MBEDTLS_OID_EC_GRP_SECP224R1 MBEDTLS_OID_CERTICOM "\x00\x21"
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200364
365/* secp256r1 OBJECT IDENTIFIER ::= {
366 * 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 +0200367#define MBEDTLS_OID_EC_GRP_SECP256R1 MBEDTLS_OID_ANSI_X9_62 "\x03\x01\x07"
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200368
369/* secp384r1 OBJECT IDENTIFIER ::= {
370 * iso(1) identified-organization(3) certicom(132) curve(0) 34 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200371#define MBEDTLS_OID_EC_GRP_SECP384R1 MBEDTLS_OID_CERTICOM "\x00\x22"
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200372
373/* secp521r1 OBJECT IDENTIFIER ::= {
374 * iso(1) identified-organization(3) certicom(132) curve(0) 35 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200375#define MBEDTLS_OID_EC_GRP_SECP521R1 MBEDTLS_OID_CERTICOM "\x00\x23"
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200376
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100377/* secp192k1 OBJECT IDENTIFIER ::= {
378 * iso(1) identified-organization(3) certicom(132) curve(0) 31 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200379#define MBEDTLS_OID_EC_GRP_SECP192K1 MBEDTLS_OID_CERTICOM "\x00\x1f"
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100380
381/* secp224k1 OBJECT IDENTIFIER ::= {
382 * iso(1) identified-organization(3) certicom(132) curve(0) 32 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200383#define MBEDTLS_OID_EC_GRP_SECP224K1 MBEDTLS_OID_CERTICOM "\x00\x20"
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100384
385/* secp256k1 OBJECT IDENTIFIER ::= {
386 * iso(1) identified-organization(3) certicom(132) curve(0) 10 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200387#define MBEDTLS_OID_EC_GRP_SECP256K1 MBEDTLS_OID_CERTICOM "\x00\x0a"
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100388
Manuel Pégourié-Gonnard48ac3db2013-10-10 15:11:33 +0200389/* RFC 5639 4.1
390 * ecStdCurvesAndGeneration OBJECT IDENTIFIER::= {iso(1)
391 * identified-organization(3) teletrust(36) algorithm(3) signature-
392 * algorithm(3) ecSign(2) 8}
393 * ellipticCurve OBJECT IDENTIFIER ::= {ecStdCurvesAndGeneration 1}
394 * versionOne OBJECT IDENTIFIER ::= {ellipticCurve 1} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200395#define MBEDTLS_OID_EC_BRAINPOOL_V1 MBEDTLS_OID_TELETRUST "\x03\x03\x02\x08\x01\x01"
Manuel Pégourié-Gonnard48ac3db2013-10-10 15:11:33 +0200396
397/* brainpoolP256r1 OBJECT IDENTIFIER ::= {versionOne 7} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200398#define MBEDTLS_OID_EC_GRP_BP256R1 MBEDTLS_OID_EC_BRAINPOOL_V1 "\x07"
Manuel Pégourié-Gonnard48ac3db2013-10-10 15:11:33 +0200399
400/* brainpoolP384r1 OBJECT IDENTIFIER ::= {versionOne 11} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200401#define MBEDTLS_OID_EC_GRP_BP384R1 MBEDTLS_OID_EC_BRAINPOOL_V1 "\x0B"
Manuel Pégourié-Gonnard48ac3db2013-10-10 15:11:33 +0200402
403/* brainpoolP512r1 OBJECT IDENTIFIER ::= {versionOne 13} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200404#define MBEDTLS_OID_EC_GRP_BP512R1 MBEDTLS_OID_EC_BRAINPOOL_V1 "\x0D"
Manuel Pégourié-Gonnard48ac3db2013-10-10 15:11:33 +0200405
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200406/*
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100407 * SEC1 C.1
408 *
409 * prime-field OBJECT IDENTIFIER ::= { id-fieldType 1 }
410 * id-fieldType OBJECT IDENTIFIER ::= { ansi-X9-62 fieldType(1)}
411 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200412#define MBEDTLS_OID_ANSI_X9_62_FIELD_TYPE MBEDTLS_OID_ANSI_X9_62 "\x01"
413#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 +0100414
415/*
Paul Bakker75342a62014-04-08 17:35:40 +0200416 * ECDSA signature identifiers, from RFC 5480
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200417 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200418#define MBEDTLS_OID_ANSI_X9_62_SIG MBEDTLS_OID_ANSI_X9_62 "\x04" /* signatures(4) */
419#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 +0200420
421/* ecdsa-with-SHA1 OBJECT IDENTIFIER ::= {
422 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4) 1 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200423#define MBEDTLS_OID_ECDSA_SHA1 MBEDTLS_OID_ANSI_X9_62_SIG "\x01"
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200424
425/* ecdsa-with-SHA224 OBJECT IDENTIFIER ::= {
426 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
427 * ecdsa-with-SHA2(3) 1 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200428#define MBEDTLS_OID_ECDSA_SHA224 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x01"
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200429
430/* ecdsa-with-SHA256 OBJECT IDENTIFIER ::= {
431 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
432 * ecdsa-with-SHA2(3) 2 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200433#define MBEDTLS_OID_ECDSA_SHA256 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x02"
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200434
435/* ecdsa-with-SHA384 OBJECT IDENTIFIER ::= {
436 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
437 * ecdsa-with-SHA2(3) 3 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200438#define MBEDTLS_OID_ECDSA_SHA384 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x03"
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200439
440/* ecdsa-with-SHA512 OBJECT IDENTIFIER ::= {
441 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
442 * ecdsa-with-SHA2(3) 4 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200443#define MBEDTLS_OID_ECDSA_SHA512 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x04"
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200444
Paul Bakkerc70b9822013-04-07 22:00:46 +0200445#ifdef __cplusplus
446extern "C" {
447#endif
448
449/**
450 * \brief Base OID descriptor structure
451 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100452typedef struct mbedtls_oid_descriptor_t {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200453 const char *MBEDTLS_PRIVATE(asn1); /*!< OID ASN.1 representation */
454 size_t MBEDTLS_PRIVATE(asn1_len); /*!< length of asn1 */
Hanno Becker612a2f12020-10-09 09:19:39 +0100455#if !defined(MBEDTLS_X509_REMOVE_INFO)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200456 const char *MBEDTLS_PRIVATE(name); /*!< official name (e.g. from RFC) */
457 const char *MBEDTLS_PRIVATE(description); /*!< human friendly description */
Peter Kolbus9a969b62018-12-11 13:55:56 -0600458#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200459} mbedtls_oid_descriptor_t;
Paul Bakkerc70b9822013-04-07 22:00:46 +0200460
461/**
462 * \brief Translate an ASN.1 OID into its numeric representation
463 * (e.g. "\x2A\x86\x48\x86\xF7\x0D" into "1.2.840.113549")
464 *
465 * \param buf buffer to put representation in
466 * \param size size of the buffer
467 * \param oid OID to translate
468 *
Manuel Pégourié-Gonnard7afdb882014-03-28 16:06:35 +0100469 * \return Length of the string written (excluding final NULL) or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200470 * MBEDTLS_ERR_OID_BUF_TOO_SMALL in case of error
Paul Bakkerc70b9822013-04-07 22:00:46 +0200471 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100472int mbedtls_oid_get_numeric_string(char *buf, size_t size, const mbedtls_asn1_buf *oid);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200473
474/**
David Horstmann92337c02023-01-18 18:40:49 +0000475 * \brief Translate a string containing a numeric representation
476 * of an ASN.1 OID into its encoded form
477 * (e.g. "1.2.840.113549" into "\x2A\x86\x48\x86\xF7\x0D")
David Horstmann59400ff2023-02-21 15:27:16 +0000478 * On success, this function allocates oid->buf from the
David Horstmann099be742023-02-23 13:51:43 +0000479 * heap. It must be freed by the caller using mbedtls_free().
David Horstmann92337c02023-01-18 18:40:49 +0000480 *
David Horstmann59400ff2023-02-21 15:27:16 +0000481 * \param oid mbedtls_asn1_buf to populate with the DER-encoded OID
482 * \param oid_str string representation of the OID to parse
483 * \param size length of the OID string
David Horstmann92337c02023-01-18 18:40:49 +0000484 *
David Horstmann59400ff2023-02-21 15:27:16 +0000485 * \return 0 if successful
486 * \return #MBEDTLS_ERR_ASN1_INVALID_DATA if oid_str does not
487 * represent a valid OID
488 * \return #MBEDTLS_ERR_ASN1_ALLOC_FAILED if the function fails to
489 * allocate oid->buf
David Horstmann92337c02023-01-18 18:40:49 +0000490 */
David Horstmann59400ff2023-02-21 15:27:16 +0000491int mbedtls_oid_from_numeric_string(mbedtls_asn1_buf *oid, const char *oid_str, size_t size);
David Horstmann92337c02023-01-18 18:40:49 +0000492
493/**
Paul Bakkerc70b9822013-04-07 22:00:46 +0200494 * \brief Translate an X.509 extension OID into local values
495 *
496 * \param oid OID to use
497 * \param ext_type place to store the extension type
498 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200499 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200500 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100501int mbedtls_oid_get_x509_ext_type(const mbedtls_asn1_buf *oid, int *ext_type);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200502
503/**
504 * \brief Translate an X.509 attribute type OID into the short name
505 * (e.g. the OID for an X520 Common Name into "CN")
506 *
507 * \param oid OID to use
508 * \param short_name place to store the string pointer
509 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200510 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200511 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100512int mbedtls_oid_get_attr_short_name(const mbedtls_asn1_buf *oid, const char **short_name);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200513
514/**
515 * \brief Translate PublicKeyAlgorithm OID into pk_type
516 *
517 * \param oid OID to use
518 * \param pk_alg place to store public key algorithm
519 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200520 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200521 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100522int mbedtls_oid_get_pk_alg(const mbedtls_asn1_buf *oid, mbedtls_pk_type_t *pk_alg);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200523
Manuel Pégourié-Gonnardedda9042013-09-12 02:17:54 +0200524/**
525 * \brief Translate pk_type into PublicKeyAlgorithm OID
526 *
527 * \param pk_alg Public key type to look for
528 * \param oid place to store ASN.1 OID string pointer
529 * \param olen length of the OID
530 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200531 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Manuel Pégourié-Gonnardedda9042013-09-12 02:17:54 +0200532 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100533int mbedtls_oid_get_oid_by_pk_alg(mbedtls_pk_type_t pk_alg,
534 const char **oid, size_t *olen);
Manuel Pégourié-Gonnardedda9042013-09-12 02:17:54 +0200535
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200536#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200537/**
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200538 * \brief Translate NamedCurve OID into an EC group identifier
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200539 *
540 * \param oid OID to use
541 * \param grp_id place to store group id
542 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200543 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200544 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100545int 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 +0200546
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200547/**
Manuel Pégourié-Gonnardedda9042013-09-12 02:17:54 +0200548 * \brief Translate EC group identifier into NamedCurve OID
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200549 *
Manuel Pégourié-Gonnardedda9042013-09-12 02:17:54 +0200550 * \param grp_id EC group identifier
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200551 * \param oid place to store ASN.1 OID string pointer
552 * \param olen length of the OID
553 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200554 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200555 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100556int mbedtls_oid_get_oid_by_ec_grp(mbedtls_ecp_group_id grp_id,
557 const char **oid, size_t *olen);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200558#endif /* MBEDTLS_ECP_C */
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200559
Paul Bakkerc70b9822013-04-07 22:00:46 +0200560/**
561 * \brief Translate SignatureAlgorithm OID into md_type and pk_type
562 *
563 * \param oid OID to use
564 * \param md_alg place to store message digest algorithm
565 * \param pk_alg place to store public key algorithm
566 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200568 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100569int mbedtls_oid_get_sig_alg(const mbedtls_asn1_buf *oid,
570 mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200571
572/**
573 * \brief Translate SignatureAlgorithm OID into description
574 *
575 * \param oid OID to use
576 * \param desc place to store string pointer
577 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200578 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200579 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100580int mbedtls_oid_get_sig_alg_desc(const mbedtls_asn1_buf *oid, const char **desc);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200581
582/**
583 * \brief Translate md_type and pk_type into SignatureAlgorithm OID
584 *
585 * \param md_alg message digest algorithm
586 * \param pk_alg public key algorithm
587 * \param oid place to store ASN.1 OID string pointer
Paul Bakker1c3853b2013-09-10 11:43:44 +0200588 * \param olen length of the OID
Paul Bakkerc70b9822013-04-07 22:00:46 +0200589 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200590 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200591 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100592int mbedtls_oid_get_oid_by_sig_alg(mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg,
593 const char **oid, size_t *olen);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200594
595/**
Antonio Quartulli12ccef22017-12-20 07:03:55 +0800596 * \brief Translate hmac algorithm OID into md_type
597 *
598 * \param oid OID to use
599 * \param md_hmac place to store message hmac algorithm
600 *
601 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
602 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100603int mbedtls_oid_get_md_hmac(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_hmac);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200604
Manuel Pégourié-Gonnardfe2b9b52022-07-05 11:35:52 +0200605/**
606 * \brief Translate hash algorithm OID into md_type
607 *
608 * \param oid OID to use
609 * \param md_alg place to store message digest algorithm
610 *
611 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
612 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100613int 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 +0200614
Hanno Becker612a2f12020-10-09 09:19:39 +0100615#if !defined(MBEDTLS_X509_REMOVE_INFO)
Paul Bakkerc70b9822013-04-07 22:00:46 +0200616/**
617 * \brief Translate Extended Key Usage OID into description
618 *
619 * \param oid OID to use
620 * \param desc place to store string pointer
621 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200622 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200623 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100624int mbedtls_oid_get_extended_key_usage(const mbedtls_asn1_buf *oid, const char **desc);
Peter Kolbus9a969b62018-12-11 13:55:56 -0600625#endif
Paul Bakkerc70b9822013-04-07 22:00:46 +0200626
627/**
Ron Eldor11ee0712019-03-25 18:22:52 +0200628 * \brief Translate certificate policies OID into description
629 *
630 * \param oid OID to use
631 * \param desc place to store string pointer
632 *
633 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
634 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100635int mbedtls_oid_get_certificate_policies(const mbedtls_asn1_buf *oid, const char **desc);
Ron Eldor11ee0712019-03-25 18:22:52 +0200636
637/**
Paul Bakkerc70b9822013-04-07 22:00:46 +0200638 * \brief Translate md_type into hash algorithm OID
639 *
640 * \param md_alg message digest algorithm
641 * \param oid place to store ASN.1 OID string pointer
Paul Bakker1c3853b2013-09-10 11:43:44 +0200642 * \param olen length of the OID
Paul Bakkerc70b9822013-04-07 22:00:46 +0200643 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200644 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200645 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100646int 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 +0200647
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200648#if defined(MBEDTLS_CIPHER_C)
Paul Bakker9b5e8852013-06-28 16:12:50 +0200649/**
650 * \brief Translate encryption algorithm OID into cipher_type
651 *
652 * \param oid OID to use
653 * \param cipher_alg place to store cipher algorithm
654 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200655 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakker9b5e8852013-06-28 16:12:50 +0200656 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100657int 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 +0200658#endif /* MBEDTLS_CIPHER_C */
Paul Bakker9b5e8852013-06-28 16:12:50 +0200659
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200660#if defined(MBEDTLS_PKCS12_C)
Paul Bakker7749a222013-06-28 17:28:20 +0200661/**
662 * \brief Translate PKCS#12 PBE algorithm OID into md_type and
663 * cipher_type
664 *
665 * \param oid OID to use
666 * \param md_alg place to store message digest algorithm
667 * \param cipher_alg place to store cipher algorithm
668 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200669 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakker7749a222013-06-28 17:28:20 +0200670 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100671int mbedtls_oid_get_pkcs12_pbe_alg(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_alg,
672 mbedtls_cipher_type_t *cipher_alg);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200673#endif /* MBEDTLS_PKCS12_C */
Paul Bakker7749a222013-06-28 17:28:20 +0200674
Paul Bakkerc70b9822013-04-07 22:00:46 +0200675#ifdef __cplusplus
676}
677#endif
678
679#endif /* oid.h */