blob: fdc25ebf8856c600b810625ad24e27720d9a4321 [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
Dave Rodgman16799db2023-11-02 19:47:20 +00008 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakkerc70b9822013-04-07 22:00:46 +02009 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020010#ifndef MBEDTLS_OID_H
11#define MBEDTLS_OID_H
Mateusz Starzyk846f0212021-05-19 19:44:07 +020012#include "mbedtls/private_access.h"
Paul Bakkerc70b9822013-04-07 22:00:46 +020013
Bence Szépkútic662b362021-05-27 11:25:03 +020014#include "mbedtls/build_info.h"
Rich Evans00ab4702015-02-06 13:43:58 +000015
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010016#include "mbedtls/asn1.h"
17#include "mbedtls/pk.h"
Rich Evans00ab4702015-02-06 13:43:58 +000018
19#include <stddef.h>
20
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020021#if defined(MBEDTLS_CIPHER_C)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010022#include "mbedtls/cipher.h"
Paul Bakker47fce022013-06-28 17:34:34 +020023#endif
24
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010025#include "mbedtls/md.h"
Paul Bakker47fce022013-06-28 17:34:34 +020026
Gilles Peskined2971572021-07-26 18:48:10 +020027/** OID is not found. */
28#define MBEDTLS_ERR_OID_NOT_FOUND -0x002E
29/** output buffer is too small */
30#define MBEDTLS_ERR_OID_BUF_TOO_SMALL -0x000B
Paul Bakkerc70b9822013-04-07 22:00:46 +020031
Manuel Pégourié-Gonnardc49ada42019-01-28 09:20:59 +010032/* This is for the benefit of X.509, but defined here in order to avoid
33 * having a "backwards" include of x.509.h here */
34/*
35 * X.509 extension types (internal, arbitrary values for bitsets)
36 */
37#define MBEDTLS_OID_X509_EXT_AUTHORITY_KEY_IDENTIFIER (1 << 0)
38#define MBEDTLS_OID_X509_EXT_SUBJECT_KEY_IDENTIFIER (1 << 1)
39#define MBEDTLS_OID_X509_EXT_KEY_USAGE (1 << 2)
40#define MBEDTLS_OID_X509_EXT_CERTIFICATE_POLICIES (1 << 3)
41#define MBEDTLS_OID_X509_EXT_POLICY_MAPPINGS (1 << 4)
42#define MBEDTLS_OID_X509_EXT_SUBJECT_ALT_NAME (1 << 5)
43#define MBEDTLS_OID_X509_EXT_ISSUER_ALT_NAME (1 << 6)
44#define MBEDTLS_OID_X509_EXT_SUBJECT_DIRECTORY_ATTRS (1 << 7)
45#define MBEDTLS_OID_X509_EXT_BASIC_CONSTRAINTS (1 << 8)
46#define MBEDTLS_OID_X509_EXT_NAME_CONSTRAINTS (1 << 9)
47#define MBEDTLS_OID_X509_EXT_POLICY_CONSTRAINTS (1 << 10)
48#define MBEDTLS_OID_X509_EXT_EXTENDED_KEY_USAGE (1 << 11)
49#define MBEDTLS_OID_X509_EXT_CRL_DISTRIBUTION_POINTS (1 << 12)
50#define MBEDTLS_OID_X509_EXT_INIHIBIT_ANYPOLICY (1 << 13)
51#define MBEDTLS_OID_X509_EXT_FRESHEST_CRL (1 << 14)
52#define MBEDTLS_OID_X509_EXT_NS_CERT_TYPE (1 << 16)
53
Paul Bakkerc70b9822013-04-07 22:00:46 +020054/*
David Horstmann96435752023-04-26 11:50:14 +010055 * Maximum number of OID components allowed
56 */
57#define MBEDTLS_OID_MAX_COMPONENTS 128
58
59/*
Paul Bakkerc70b9822013-04-07 22:00:46 +020060 * Top level OID tuples
61 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020062#define MBEDTLS_OID_ISO_MEMBER_BODIES "\x2a" /* {iso(1) member-body(2)} */
63#define MBEDTLS_OID_ISO_IDENTIFIED_ORG "\x2b" /* {iso(1) identified-organization(3)} */
64#define MBEDTLS_OID_ISO_CCITT_DS "\x55" /* {joint-iso-ccitt(2) ds(5)} */
65#define MBEDTLS_OID_ISO_ITU_COUNTRY "\x60" /* {joint-iso-itu-t(2) country(16)} */
Paul Bakkerc70b9822013-04-07 22:00:46 +020066
67/*
68 * ISO Member bodies OID parts
69 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020070#define MBEDTLS_OID_COUNTRY_US "\x86\x48" /* {us(840)} */
71#define MBEDTLS_OID_ORG_RSA_DATA_SECURITY "\x86\xf7\x0d" /* {rsadsi(113549)} */
72#define MBEDTLS_OID_RSA_COMPANY MBEDTLS_OID_ISO_MEMBER_BODIES MBEDTLS_OID_COUNTRY_US \
Gilles Peskine449bd832023-01-11 14:50:10 +010073 MBEDTLS_OID_ORG_RSA_DATA_SECURITY /* {iso(1) member-body(2) us(840) rsadsi(113549)} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020074#define MBEDTLS_OID_ORG_ANSI_X9_62 "\xce\x3d" /* ansi-X9-62(10045) */
75#define MBEDTLS_OID_ANSI_X9_62 MBEDTLS_OID_ISO_MEMBER_BODIES MBEDTLS_OID_COUNTRY_US \
Gilles Peskine449bd832023-01-11 14:50:10 +010076 MBEDTLS_OID_ORG_ANSI_X9_62
Paul Bakkerc70b9822013-04-07 22:00:46 +020077
78/*
79 * ISO Identified organization OID parts
80 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020081#define MBEDTLS_OID_ORG_DOD "\x06" /* {dod(6)} */
82#define MBEDTLS_OID_ORG_OIW "\x0e"
83#define MBEDTLS_OID_OIW_SECSIG MBEDTLS_OID_ORG_OIW "\x03"
84#define MBEDTLS_OID_OIW_SECSIG_ALG MBEDTLS_OID_OIW_SECSIG "\x02"
85#define MBEDTLS_OID_OIW_SECSIG_SHA1 MBEDTLS_OID_OIW_SECSIG_ALG "\x1a"
Jethro Beekman01672442023-04-19 14:08:14 +020086#define MBEDTLS_OID_ORG_THAWTE "\x65" /* thawte(101) */
87#define MBEDTLS_OID_THAWTE MBEDTLS_OID_ISO_IDENTIFIED_ORG \
88 MBEDTLS_OID_ORG_THAWTE
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020089#define MBEDTLS_OID_ORG_CERTICOM "\x81\x04" /* certicom(132) */
Gilles Peskine449bd832023-01-11 14:50:10 +010090#define MBEDTLS_OID_CERTICOM MBEDTLS_OID_ISO_IDENTIFIED_ORG \
91 MBEDTLS_OID_ORG_CERTICOM
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020092#define MBEDTLS_OID_ORG_TELETRUST "\x24" /* teletrust(36) */
Gilles Peskine449bd832023-01-11 14:50:10 +010093#define MBEDTLS_OID_TELETRUST MBEDTLS_OID_ISO_IDENTIFIED_ORG \
94 MBEDTLS_OID_ORG_TELETRUST
Paul Bakkerc70b9822013-04-07 22:00:46 +020095
96/*
97 * ISO ITU OID parts
98 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020099#define MBEDTLS_OID_ORGANIZATION "\x01" /* {organization(1)} */
Gilles Peskine449bd832023-01-11 14:50:10 +0100100#define MBEDTLS_OID_ISO_ITU_US_ORG MBEDTLS_OID_ISO_ITU_COUNTRY MBEDTLS_OID_COUNTRY_US \
101 MBEDTLS_OID_ORGANIZATION /* {joint-iso-itu-t(2) country(16) us(840) organization(1)} */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200102
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103#define MBEDTLS_OID_ORG_GOV "\x65" /* {gov(101)} */
104#define MBEDTLS_OID_GOV MBEDTLS_OID_ISO_ITU_US_ORG MBEDTLS_OID_ORG_GOV /* {joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101)} */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200105
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200106#define MBEDTLS_OID_ORG_NETSCAPE "\x86\xF8\x42" /* {netscape(113730)} */
107#define MBEDTLS_OID_NETSCAPE MBEDTLS_OID_ISO_ITU_US_ORG MBEDTLS_OID_ORG_NETSCAPE /* Netscape OID {joint-iso-itu-t(2) country(16) us(840) organization(1) netscape(113730)} */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200108
109/* ISO arc for standard certificate and CRL extensions */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200110#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 +0200111
Ron Eldor488fd082018-07-15 09:38:39 +0300112#define MBEDTLS_OID_NIST_ALG MBEDTLS_OID_GOV "\x03\x04" /** { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithm(4) */
113
Paul Bakkerc70b9822013-04-07 22:00:46 +0200114/**
115 * Private Internet Extensions
116 * { iso(1) identified-organization(3) dod(6) internet(1)
117 * security(5) mechanisms(5) pkix(7) }
118 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100119#define MBEDTLS_OID_INTERNET MBEDTLS_OID_ISO_IDENTIFIED_ORG MBEDTLS_OID_ORG_DOD \
120 "\x01"
Ron Eldorb6dc1052019-04-01 18:12:23 +0300121#define MBEDTLS_OID_PKIX MBEDTLS_OID_INTERNET "\x05\x05\x07"
Paul Bakkerc70b9822013-04-07 22:00:46 +0200122
123/*
124 * Arc for standard naming attributes
125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200126#define MBEDTLS_OID_AT MBEDTLS_OID_ISO_CCITT_DS "\x04" /**< id-at OBJECT IDENTIFIER ::= {joint-iso-ccitt(2) ds(5) 4} */
127#define MBEDTLS_OID_AT_CN MBEDTLS_OID_AT "\x03" /**< id-at-commonName AttributeType:= {id-at 3} */
128#define MBEDTLS_OID_AT_SUR_NAME MBEDTLS_OID_AT "\x04" /**< id-at-surName AttributeType:= {id-at 4} */
129#define MBEDTLS_OID_AT_SERIAL_NUMBER MBEDTLS_OID_AT "\x05" /**< id-at-serialNumber AttributeType:= {id-at 5} */
130#define MBEDTLS_OID_AT_COUNTRY MBEDTLS_OID_AT "\x06" /**< id-at-countryName AttributeType:= {id-at 6} */
131#define MBEDTLS_OID_AT_LOCALITY MBEDTLS_OID_AT "\x07" /**< id-at-locality AttributeType:= {id-at 7} */
132#define MBEDTLS_OID_AT_STATE MBEDTLS_OID_AT "\x08" /**< id-at-state AttributeType:= {id-at 8} */
133#define MBEDTLS_OID_AT_ORGANIZATION MBEDTLS_OID_AT "\x0A" /**< id-at-organizationName AttributeType:= {id-at 10} */
134#define MBEDTLS_OID_AT_ORG_UNIT MBEDTLS_OID_AT "\x0B" /**< id-at-organizationalUnitName AttributeType:= {id-at 11} */
135#define MBEDTLS_OID_AT_TITLE MBEDTLS_OID_AT "\x0C" /**< id-at-title AttributeType:= {id-at 12} */
136#define MBEDTLS_OID_AT_POSTAL_ADDRESS MBEDTLS_OID_AT "\x10" /**< id-at-postalAddress AttributeType:= {id-at 16} */
137#define MBEDTLS_OID_AT_POSTAL_CODE MBEDTLS_OID_AT "\x11" /**< id-at-postalCode AttributeType:= {id-at 17} */
138#define MBEDTLS_OID_AT_GIVEN_NAME MBEDTLS_OID_AT "\x2A" /**< id-at-givenName AttributeType:= {id-at 42} */
139#define MBEDTLS_OID_AT_INITIALS MBEDTLS_OID_AT "\x2B" /**< id-at-initials AttributeType:= {id-at 43} */
140#define MBEDTLS_OID_AT_GENERATION_QUALIFIER MBEDTLS_OID_AT "\x2C" /**< id-at-generationQualifier AttributeType:= {id-at 44} */
Tom Cosgrove1e211442022-05-26 11:51:00 +0100141#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 +0200142#define MBEDTLS_OID_AT_DN_QUALIFIER MBEDTLS_OID_AT "\x2E" /**< id-at-dnQualifier AttributeType:= {id-at 46} */
143#define MBEDTLS_OID_AT_PSEUDONYM MBEDTLS_OID_AT "\x41" /**< id-at-pseudonym AttributeType:= {id-at 65} */
Paul Bakker63844402014-04-30 15:34:12 +0200144
Micah N Gorrell21d4bdb2021-05-12 17:41:24 -0600145#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 +0200146#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 +0200147
148/*
149 * OIDs for standard certificate extensions
150 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200151#define MBEDTLS_OID_AUTHORITY_KEY_IDENTIFIER MBEDTLS_OID_ID_CE "\x23" /**< id-ce-authorityKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 35 } */
152#define MBEDTLS_OID_SUBJECT_KEY_IDENTIFIER MBEDTLS_OID_ID_CE "\x0E" /**< id-ce-subjectKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 14 } */
153#define MBEDTLS_OID_KEY_USAGE MBEDTLS_OID_ID_CE "\x0F" /**< id-ce-keyUsage OBJECT IDENTIFIER ::= { id-ce 15 } */
154#define MBEDTLS_OID_CERTIFICATE_POLICIES MBEDTLS_OID_ID_CE "\x20" /**< id-ce-certificatePolicies OBJECT IDENTIFIER ::= { id-ce 32 } */
155#define MBEDTLS_OID_POLICY_MAPPINGS MBEDTLS_OID_ID_CE "\x21" /**< id-ce-policyMappings OBJECT IDENTIFIER ::= { id-ce 33 } */
156#define MBEDTLS_OID_SUBJECT_ALT_NAME MBEDTLS_OID_ID_CE "\x11" /**< id-ce-subjectAltName OBJECT IDENTIFIER ::= { id-ce 17 } */
157#define MBEDTLS_OID_ISSUER_ALT_NAME MBEDTLS_OID_ID_CE "\x12" /**< id-ce-issuerAltName OBJECT IDENTIFIER ::= { id-ce 18 } */
158#define MBEDTLS_OID_SUBJECT_DIRECTORY_ATTRS MBEDTLS_OID_ID_CE "\x09" /**< id-ce-subjectDirectoryAttributes OBJECT IDENTIFIER ::= { id-ce 9 } */
159#define MBEDTLS_OID_BASIC_CONSTRAINTS MBEDTLS_OID_ID_CE "\x13" /**< id-ce-basicConstraints OBJECT IDENTIFIER ::= { id-ce 19 } */
160#define MBEDTLS_OID_NAME_CONSTRAINTS MBEDTLS_OID_ID_CE "\x1E" /**< id-ce-nameConstraints OBJECT IDENTIFIER ::= { id-ce 30 } */
161#define MBEDTLS_OID_POLICY_CONSTRAINTS MBEDTLS_OID_ID_CE "\x24" /**< id-ce-policyConstraints OBJECT IDENTIFIER ::= { id-ce 36 } */
162#define MBEDTLS_OID_EXTENDED_KEY_USAGE MBEDTLS_OID_ID_CE "\x25" /**< id-ce-extKeyUsage OBJECT IDENTIFIER ::= { id-ce 37 } */
163#define MBEDTLS_OID_CRL_DISTRIBUTION_POINTS MBEDTLS_OID_ID_CE "\x1F" /**< id-ce-cRLDistributionPoints OBJECT IDENTIFIER ::= { id-ce 31 } */
164#define MBEDTLS_OID_INIHIBIT_ANYPOLICY MBEDTLS_OID_ID_CE "\x36" /**< id-ce-inhibitAnyPolicy OBJECT IDENTIFIER ::= { id-ce 54 } */
165#define MBEDTLS_OID_FRESHEST_CRL MBEDTLS_OID_ID_CE "\x2E" /**< id-ce-freshestCRL OBJECT IDENTIFIER ::= { id-ce 46 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200166
167/*
Ron Eldor11ee0712019-03-25 18:22:52 +0200168 * Certificate policies
169 */
170#define MBEDTLS_OID_ANY_POLICY MBEDTLS_OID_CERTIFICATE_POLICIES "\x00" /**< anyPolicy OBJECT IDENTIFIER ::= { id-ce-certificatePolicies 0 } */
171
172/*
Paul Bakkerc70b9822013-04-07 22:00:46 +0200173 * Netscape certificate extensions
174 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200175#define MBEDTLS_OID_NS_CERT MBEDTLS_OID_NETSCAPE "\x01"
176#define MBEDTLS_OID_NS_CERT_TYPE MBEDTLS_OID_NS_CERT "\x01"
177#define MBEDTLS_OID_NS_BASE_URL MBEDTLS_OID_NS_CERT "\x02"
178#define MBEDTLS_OID_NS_REVOCATION_URL MBEDTLS_OID_NS_CERT "\x03"
179#define MBEDTLS_OID_NS_CA_REVOCATION_URL MBEDTLS_OID_NS_CERT "\x04"
180#define MBEDTLS_OID_NS_RENEWAL_URL MBEDTLS_OID_NS_CERT "\x07"
181#define MBEDTLS_OID_NS_CA_POLICY_URL MBEDTLS_OID_NS_CERT "\x08"
182#define MBEDTLS_OID_NS_SSL_SERVER_NAME MBEDTLS_OID_NS_CERT "\x0C"
183#define MBEDTLS_OID_NS_COMMENT MBEDTLS_OID_NS_CERT "\x0D"
184#define MBEDTLS_OID_NS_DATA_TYPE MBEDTLS_OID_NETSCAPE "\x02"
185#define MBEDTLS_OID_NS_CERT_SEQUENCE MBEDTLS_OID_NS_DATA_TYPE "\x05"
Paul Bakkerc70b9822013-04-07 22:00:46 +0200186
187/*
188 * OIDs for CRL extensions
189 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200190#define MBEDTLS_OID_PRIVATE_KEY_USAGE_PERIOD MBEDTLS_OID_ID_CE "\x10"
191#define MBEDTLS_OID_CRL_NUMBER MBEDTLS_OID_ID_CE "\x14" /**< id-ce-cRLNumber OBJECT IDENTIFIER ::= { id-ce 20 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200192
193/*
194 * X.509 v3 Extended key usage OIDs
195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200196#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 +0200197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198#define MBEDTLS_OID_KP MBEDTLS_OID_PKIX "\x03" /**< id-kp OBJECT IDENTIFIER ::= { id-pkix 3 } */
199#define MBEDTLS_OID_SERVER_AUTH MBEDTLS_OID_KP "\x01" /**< id-kp-serverAuth OBJECT IDENTIFIER ::= { id-kp 1 } */
200#define MBEDTLS_OID_CLIENT_AUTH MBEDTLS_OID_KP "\x02" /**< id-kp-clientAuth OBJECT IDENTIFIER ::= { id-kp 2 } */
201#define MBEDTLS_OID_CODE_SIGNING MBEDTLS_OID_KP "\x03" /**< id-kp-codeSigning OBJECT IDENTIFIER ::= { id-kp 3 } */
202#define MBEDTLS_OID_EMAIL_PROTECTION MBEDTLS_OID_KP "\x04" /**< id-kp-emailProtection OBJECT IDENTIFIER ::= { id-kp 4 } */
203#define MBEDTLS_OID_TIME_STAMPING MBEDTLS_OID_KP "\x08" /**< id-kp-timeStamping OBJECT IDENTIFIER ::= { id-kp 8 } */
204#define MBEDTLS_OID_OCSP_SIGNING MBEDTLS_OID_KP "\x09" /**< id-kp-OCSPSigning OBJECT IDENTIFIER ::= { id-kp 9 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200205
Ron Eldorb6dc1052019-04-01 18:12:23 +0300206/**
207 * Wi-SUN Alliance Field Area Network
208 * { iso(1) identified-organization(3) dod(6) internet(1)
209 * private(4) enterprise(1) WiSUN(45605) FieldAreaNetwork(1) }
210 */
Ron Eldor3c4734a2019-03-25 14:05:23 +0200211#define MBEDTLS_OID_WISUN_FAN MBEDTLS_OID_INTERNET "\x04\x01\x82\xe4\x25\x01"
Ron Eldorb6dc1052019-04-01 18:12:23 +0300212
Ron Eldorb2dc3fa2019-03-21 13:40:13 +0200213#define MBEDTLS_OID_ON MBEDTLS_OID_PKIX "\x08" /**< id-on OBJECT IDENTIFIER ::= { id-pkix 8 } */
214#define MBEDTLS_OID_ON_HW_MODULE_NAME MBEDTLS_OID_ON "\x04" /**< id-on-hardwareModuleName OBJECT IDENTIFIER ::= { id-on 4 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200215
216/*
Paul Bakkerc70b9822013-04-07 22:00:46 +0200217 * PKCS definition OIDs
Paul Bakker9b5e8852013-06-28 16:12:50 +0200218 */
219
220#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 +0200221#define MBEDTLS_OID_PKCS1 MBEDTLS_OID_PKCS "\x01" /**< pkcs-1 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 1 } */
222#define MBEDTLS_OID_PKCS5 MBEDTLS_OID_PKCS "\x05" /**< pkcs-5 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 5 } */
Nayna Jainc9deb182020-11-16 19:03:12 +0000223#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 +0200224#define MBEDTLS_OID_PKCS9 MBEDTLS_OID_PKCS "\x09" /**< pkcs-9 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 9 } */
225#define MBEDTLS_OID_PKCS12 MBEDTLS_OID_PKCS "\x0c" /**< pkcs-12 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 12 } */
226
227/*
228 * PKCS#1 OIDs
229 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200230#define MBEDTLS_OID_PKCS1_RSA MBEDTLS_OID_PKCS1 "\x01" /**< rsaEncryption OBJECT IDENTIFIER ::= { pkcs-1 1 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200231#define MBEDTLS_OID_PKCS1_MD5 MBEDTLS_OID_PKCS1 "\x04" /**< md5WithRSAEncryption ::= { pkcs-1 4 } */
232#define MBEDTLS_OID_PKCS1_SHA1 MBEDTLS_OID_PKCS1 "\x05" /**< sha1WithRSAEncryption ::= { pkcs-1 5 } */
233#define MBEDTLS_OID_PKCS1_SHA224 MBEDTLS_OID_PKCS1 "\x0e" /**< sha224WithRSAEncryption ::= { pkcs-1 14 } */
234#define MBEDTLS_OID_PKCS1_SHA256 MBEDTLS_OID_PKCS1 "\x0b" /**< sha256WithRSAEncryption ::= { pkcs-1 11 } */
235#define MBEDTLS_OID_PKCS1_SHA384 MBEDTLS_OID_PKCS1 "\x0c" /**< sha384WithRSAEncryption ::= { pkcs-1 12 } */
236#define MBEDTLS_OID_PKCS1_SHA512 MBEDTLS_OID_PKCS1 "\x0d" /**< sha512WithRSAEncryption ::= { pkcs-1 13 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200238#define MBEDTLS_OID_RSA_SHA_OBS "\x2B\x0E\x03\x02\x1D"
Paul Bakkerc70b9822013-04-07 22:00:46 +0200239
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240#define MBEDTLS_OID_PKCS9_EMAIL MBEDTLS_OID_PKCS9 "\x01" /**< emailAddress AttributeType ::= { pkcs-9 1 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200241
Manuel Pégourié-Gonnard59a75d52014-01-22 10:12:57 +0100242/* RFC 4055 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243#define MBEDTLS_OID_RSASSA_PSS MBEDTLS_OID_PKCS1 "\x0a" /**< id-RSASSA-PSS ::= { pkcs-1 10 } */
244#define MBEDTLS_OID_MGF1 MBEDTLS_OID_PKCS1 "\x08" /**< id-mgf1 ::= { pkcs-1 8 } */
Manuel Pégourié-Gonnard59a75d52014-01-22 10:12:57 +0100245
Paul Bakker9b5e8852013-06-28 16:12:50 +0200246/*
247 * Digest algorithms
248 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249#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 +0100250#define MBEDTLS_OID_DIGEST_ALG_SHA1 MBEDTLS_OID_ISO_IDENTIFIED_ORG \
251 MBEDTLS_OID_OIW_SECSIG_SHA1 /**< id-mbedtls_sha1 OBJECT IDENTIFIER ::= { iso(1) identified-organization(3) oiw(14) secsig(3) algorithms(2) 26 } */
Ron Eldor488fd082018-07-15 09:38:39 +0300252#define MBEDTLS_OID_DIGEST_ALG_SHA224 MBEDTLS_OID_NIST_ALG "\x02\x04" /**< id-sha224 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistalgorithm(4) hashalgs(2) 4 } */
253#define MBEDTLS_OID_DIGEST_ALG_SHA256 MBEDTLS_OID_NIST_ALG "\x02\x01" /**< id-mbedtls_sha256 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistalgorithm(4) hashalgs(2) 1 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200254
Ron Eldor488fd082018-07-15 09:38:39 +0300255#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 +0200256
Ron Eldor488fd082018-07-15 09:38:39 +0300257#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 +0200258
Jack Lloyd5d9c9632019-05-01 13:43:53 -0400259#define MBEDTLS_OID_DIGEST_ALG_RIPEMD160 MBEDTLS_OID_TELETRUST "\x03\x02\x01" /**< id-ripemd160 OBJECT IDENTIFIER :: { iso(1) identified-organization(3) teletrust(36) algorithm(3) hashAlgorithm(2) ripemd160(1) } */
260
Dave Rodgman2d626cc2023-07-27 14:43:55 +0100261#define MBEDTLS_OID_DIGEST_ALG_SHA3_224 MBEDTLS_OID_NIST_ALG "\x02\x07" /**< id-sha3-224 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) sha3-224(7) } */
Dave Rodgman527f48f2023-07-05 18:57:30 +0100262
Dave Rodgman2d626cc2023-07-27 14:43:55 +0100263#define MBEDTLS_OID_DIGEST_ALG_SHA3_256 MBEDTLS_OID_NIST_ALG "\x02\x08" /**< id-sha3-256 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) sha3-256(8) } */
Dave Rodgman527f48f2023-07-05 18:57:30 +0100264
Dave Rodgman2d626cc2023-07-27 14:43:55 +0100265#define MBEDTLS_OID_DIGEST_ALG_SHA3_384 MBEDTLS_OID_NIST_ALG "\x02\x09" /**< id-sha3-384 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) sha3-384(9) } */
Dave Rodgman527f48f2023-07-05 18:57:30 +0100266
Dave Rodgman2d626cc2023-07-27 14:43:55 +0100267#define MBEDTLS_OID_DIGEST_ALG_SHA3_512 MBEDTLS_OID_NIST_ALG "\x02\x0a" /**< id-sha3-512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) sha3-512(10) } */
Dave Rodgman527f48f2023-07-05 18:57:30 +0100268
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
Dave Rodgman5cc67a32023-07-27 14:44:35 +0100280#define MBEDTLS_OID_HMAC_SHA3_224 MBEDTLS_OID_NIST_ALG "\x02\x0d" /**< id-hmacWithSHA3-512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) hmacWithSHA3-224(13) } */
281
282#define MBEDTLS_OID_HMAC_SHA3_256 MBEDTLS_OID_NIST_ALG "\x02\x0e" /**< id-hmacWithSHA3-512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) hmacWithSHA3-256(14) } */
283
284#define MBEDTLS_OID_HMAC_SHA3_384 MBEDTLS_OID_NIST_ALG "\x02\x0f" /**< id-hmacWithSHA3-512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) hmacWithSHA3-384(15) } */
285
286#define MBEDTLS_OID_HMAC_SHA3_512 MBEDTLS_OID_NIST_ALG "\x02\x10" /**< id-hmacWithSHA3-512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) hashalgs(2) hmacWithSHA3-512(16) } */
287
Dave Rodgmanf2e3eb82023-07-27 15:46:05 +0100288#define MBEDTLS_OID_HMAC_RIPEMD160 MBEDTLS_OID_INTERNET "\x05\x05\x08\x01\x04" /**< id-hmacWithSHA1 OBJECT IDENTIFIER ::= {iso(1) iso-identified-organization(3) dod(6) internet(1) security(5) mechanisms(5) ipsec(8) isakmpOakley(1) hmacRIPEMD160(4)} */
289
Paul Bakker9b5e8852013-06-28 16:12:50 +0200290/*
Ryan Everettae0b4bd2024-01-10 19:19:10 +0000291 * Encryption algorithms,
292 * the following standardized object identifiers are specified at
293 * https://datatracker.ietf.org/doc/html/rfc8018#appendix-C.
Paul Bakker9b5e8852013-06-28 16:12:50 +0200294 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100295#define MBEDTLS_OID_DES_CBC MBEDTLS_OID_ISO_IDENTIFIED_ORG \
296 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 +0200297#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 +0300298#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 } */
Maciej Zwoliński720c6382023-05-16 12:02:47 +0200299#define MBEDTLS_OID_AES_128_CBC MBEDTLS_OID_AES "\x02" /** aes128-cbc-pad OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) aes(1) aes128-CBC-PAD(2) } */
300#define MBEDTLS_OID_AES_192_CBC MBEDTLS_OID_AES "\x16" /** aes192-cbc-pad OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) aes(1) aes192-CBC-PAD(22) } */
301#define MBEDTLS_OID_AES_256_CBC MBEDTLS_OID_AES "\x2a" /** aes256-cbc-pad OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistAlgorithms(4) aes(1) aes256-CBC-PAD(42) } */
Paul Bakker9b5e8852013-06-28 16:12:50 +0200302
303/*
Ron Eldor488fd082018-07-15 09:38:39 +0300304 * Key Wrapping algorithms
305 */
306/*
307 * RFC 5649
308 */
309#define MBEDTLS_OID_AES128_KW MBEDTLS_OID_AES "\x05" /** id-aes128-wrap OBJECT IDENTIFIER ::= { aes 5 } */
310#define MBEDTLS_OID_AES128_KWP MBEDTLS_OID_AES "\x08" /** id-aes128-wrap-pad OBJECT IDENTIFIER ::= { aes 8 } */
311#define MBEDTLS_OID_AES192_KW MBEDTLS_OID_AES "\x19" /** id-aes192-wrap OBJECT IDENTIFIER ::= { aes 25 } */
312#define MBEDTLS_OID_AES192_KWP MBEDTLS_OID_AES "\x1c" /** id-aes192-wrap-pad OBJECT IDENTIFIER ::= { aes 28 } */
313#define MBEDTLS_OID_AES256_KW MBEDTLS_OID_AES "\x2d" /** id-aes256-wrap OBJECT IDENTIFIER ::= { aes 45 } */
314#define MBEDTLS_OID_AES256_KWP MBEDTLS_OID_AES "\x30" /** id-aes256-wrap-pad OBJECT IDENTIFIER ::= { aes 48 } */
315/*
Paul Bakker9b5e8852013-06-28 16:12:50 +0200316 * PKCS#5 OIDs
317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200318#define MBEDTLS_OID_PKCS5_PBKDF2 MBEDTLS_OID_PKCS5 "\x0c" /**< id-PBKDF2 OBJECT IDENTIFIER ::= {pkcs-5 12} */
319#define MBEDTLS_OID_PKCS5_PBES2 MBEDTLS_OID_PKCS5 "\x0d" /**< id-PBES2 OBJECT IDENTIFIER ::= {pkcs-5 13} */
320#define MBEDTLS_OID_PKCS5_PBMAC1 MBEDTLS_OID_PKCS5 "\x0e" /**< id-PBMAC1 OBJECT IDENTIFIER ::= {pkcs-5 14} */
Paul Bakker9b5e8852013-06-28 16:12:50 +0200321
322/*
323 * PKCS#5 PBES1 algorithms
324 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200325#define MBEDTLS_OID_PKCS5_PBE_MD5_DES_CBC MBEDTLS_OID_PKCS5 "\x03" /**< pbeWithMD5AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 3} */
326#define MBEDTLS_OID_PKCS5_PBE_MD5_RC2_CBC MBEDTLS_OID_PKCS5 "\x06" /**< pbeWithMD5AndRC2-CBC OBJECT IDENTIFIER ::= {pkcs-5 6} */
327#define MBEDTLS_OID_PKCS5_PBE_SHA1_DES_CBC MBEDTLS_OID_PKCS5 "\x0a" /**< pbeWithSHA1AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 10} */
328#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 +0200329
Paul Bakker7749a222013-06-28 17:28:20 +0200330/*
Nayna Jainc9deb182020-11-16 19:03:12 +0000331 * PKCS#7 OIDs
332 */
333#define MBEDTLS_OID_PKCS7_DATA MBEDTLS_OID_PKCS7 "\x01" /**< Content type is Data OBJECT IDENTIFIER ::= {pkcs-7 1} */
334#define MBEDTLS_OID_PKCS7_SIGNED_DATA MBEDTLS_OID_PKCS7 "\x02" /**< Content type is Signed Data OBJECT IDENTIFIER ::= {pkcs-7 2} */
335#define MBEDTLS_OID_PKCS7_ENVELOPED_DATA MBEDTLS_OID_PKCS7 "\x03" /**< Content type is Enveloped Data OBJECT IDENTIFIER ::= {pkcs-7 3} */
336#define MBEDTLS_OID_PKCS7_SIGNED_AND_ENVELOPED_DATA MBEDTLS_OID_PKCS7 "\x04" /**< Content type is Signed and Enveloped Data OBJECT IDENTIFIER ::= {pkcs-7 4} */
337#define MBEDTLS_OID_PKCS7_DIGESTED_DATA MBEDTLS_OID_PKCS7 "\x05" /**< Content type is Digested Data OBJECT IDENTIFIER ::= {pkcs-7 5} */
338#define MBEDTLS_OID_PKCS7_ENCRYPTED_DATA MBEDTLS_OID_PKCS7 "\x06" /**< Content type is Encrypted Data OBJECT IDENTIFIER ::= {pkcs-7 6} */
339
340/*
Paul Bakkerfde42702013-08-25 14:47:27 +0200341 * PKCS#8 OIDs
342 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200343#define MBEDTLS_OID_PKCS9_CSR_EXT_REQ MBEDTLS_OID_PKCS9 "\x0e" /**< extensionRequest OBJECT IDENTIFIER ::= {pkcs-9 14} */
Paul Bakkerfde42702013-08-25 14:47:27 +0200344
345/*
Paul Bakker7749a222013-06-28 17:28:20 +0200346 * PKCS#12 PBE OIDs
347 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200348#define MBEDTLS_OID_PKCS12_PBE MBEDTLS_OID_PKCS12 "\x01" /**< pkcs-12PbeIds OBJECT IDENTIFIER ::= {pkcs-12 1} */
Paul Bakker7749a222013-06-28 17:28:20 +0200349
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200350#define MBEDTLS_OID_PKCS12_PBE_SHA1_DES3_EDE_CBC MBEDTLS_OID_PKCS12_PBE "\x03" /**< pbeWithSHAAnd3-KeyTripleDES-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 3} */
351#define MBEDTLS_OID_PKCS12_PBE_SHA1_DES2_EDE_CBC MBEDTLS_OID_PKCS12_PBE "\x04" /**< pbeWithSHAAnd2-KeyTripleDES-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 4} */
352#define MBEDTLS_OID_PKCS12_PBE_SHA1_RC2_128_CBC MBEDTLS_OID_PKCS12_PBE "\x05" /**< pbeWithSHAAnd128BitRC2-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 5} */
353#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 +0200354
Manuel Pégourié-Gonnard5a9b82e2013-07-01 16:57:44 +0200355/*
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200356 * EC key algorithms from RFC 5480
Manuel Pégourié-Gonnard5a9b82e2013-07-01 16:57:44 +0200357 */
358
359/* id-ecPublicKey OBJECT IDENTIFIER ::= {
360 * iso(1) member-body(2) us(840) ansi-X9-62(10045) keyType(2) 1 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200361#define MBEDTLS_OID_EC_ALG_UNRESTRICTED MBEDTLS_OID_ANSI_X9_62 "\x02\01"
Manuel Pégourié-Gonnard5a9b82e2013-07-01 16:57:44 +0200362
363/* id-ecDH OBJECT IDENTIFIER ::= {
364 * iso(1) identified-organization(3) certicom(132)
365 * schemes(1) ecdh(12) } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200366#define MBEDTLS_OID_EC_ALG_ECDH MBEDTLS_OID_CERTICOM "\x01\x0c"
Manuel Pégourié-Gonnard5a9b82e2013-07-01 16:57:44 +0200367
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200368/*
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100369 * ECParameters namedCurve identifiers, from RFC 5480, RFC 5639, and SEC2
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200370 */
371
372/* secp192r1 OBJECT IDENTIFIER ::= {
373 * 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 +0200374#define MBEDTLS_OID_EC_GRP_SECP192R1 MBEDTLS_OID_ANSI_X9_62 "\x03\x01\x01"
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200375
376/* secp224r1 OBJECT IDENTIFIER ::= {
377 * iso(1) identified-organization(3) certicom(132) curve(0) 33 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200378#define MBEDTLS_OID_EC_GRP_SECP224R1 MBEDTLS_OID_CERTICOM "\x00\x21"
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200379
380/* secp256r1 OBJECT IDENTIFIER ::= {
381 * 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 +0200382#define MBEDTLS_OID_EC_GRP_SECP256R1 MBEDTLS_OID_ANSI_X9_62 "\x03\x01\x07"
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200383
384/* secp384r1 OBJECT IDENTIFIER ::= {
385 * iso(1) identified-organization(3) certicom(132) curve(0) 34 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200386#define MBEDTLS_OID_EC_GRP_SECP384R1 MBEDTLS_OID_CERTICOM "\x00\x22"
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200387
388/* secp521r1 OBJECT IDENTIFIER ::= {
389 * iso(1) identified-organization(3) certicom(132) curve(0) 35 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200390#define MBEDTLS_OID_EC_GRP_SECP521R1 MBEDTLS_OID_CERTICOM "\x00\x23"
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200391
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100392/* secp192k1 OBJECT IDENTIFIER ::= {
393 * iso(1) identified-organization(3) certicom(132) curve(0) 31 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200394#define MBEDTLS_OID_EC_GRP_SECP192K1 MBEDTLS_OID_CERTICOM "\x00\x1f"
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100395
396/* secp224k1 OBJECT IDENTIFIER ::= {
397 * iso(1) identified-organization(3) certicom(132) curve(0) 32 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200398#define MBEDTLS_OID_EC_GRP_SECP224K1 MBEDTLS_OID_CERTICOM "\x00\x20"
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100399
400/* secp256k1 OBJECT IDENTIFIER ::= {
401 * iso(1) identified-organization(3) certicom(132) curve(0) 10 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200402#define MBEDTLS_OID_EC_GRP_SECP256K1 MBEDTLS_OID_CERTICOM "\x00\x0a"
Manuel Pégourié-Gonnard9bcff392014-01-10 18:26:48 +0100403
Manuel Pégourié-Gonnard48ac3db2013-10-10 15:11:33 +0200404/* RFC 5639 4.1
405 * ecStdCurvesAndGeneration OBJECT IDENTIFIER::= {iso(1)
406 * identified-organization(3) teletrust(36) algorithm(3) signature-
407 * algorithm(3) ecSign(2) 8}
408 * ellipticCurve OBJECT IDENTIFIER ::= {ecStdCurvesAndGeneration 1}
409 * versionOne OBJECT IDENTIFIER ::= {ellipticCurve 1} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200410#define MBEDTLS_OID_EC_BRAINPOOL_V1 MBEDTLS_OID_TELETRUST "\x03\x03\x02\x08\x01\x01"
Manuel Pégourié-Gonnard48ac3db2013-10-10 15:11:33 +0200411
412/* brainpoolP256r1 OBJECT IDENTIFIER ::= {versionOne 7} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200413#define MBEDTLS_OID_EC_GRP_BP256R1 MBEDTLS_OID_EC_BRAINPOOL_V1 "\x07"
Manuel Pégourié-Gonnard48ac3db2013-10-10 15:11:33 +0200414
415/* brainpoolP384r1 OBJECT IDENTIFIER ::= {versionOne 11} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200416#define MBEDTLS_OID_EC_GRP_BP384R1 MBEDTLS_OID_EC_BRAINPOOL_V1 "\x0B"
Manuel Pégourié-Gonnard48ac3db2013-10-10 15:11:33 +0200417
418/* brainpoolP512r1 OBJECT IDENTIFIER ::= {versionOne 13} */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200419#define MBEDTLS_OID_EC_GRP_BP512R1 MBEDTLS_OID_EC_BRAINPOOL_V1 "\x0D"
Manuel Pégourié-Gonnard48ac3db2013-10-10 15:11:33 +0200420
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200421/*
Manuel Pégourié-Gonnardeab20d22014-03-14 17:58:42 +0100422 * SEC1 C.1
423 *
424 * prime-field OBJECT IDENTIFIER ::= { id-fieldType 1 }
425 * id-fieldType OBJECT IDENTIFIER ::= { ansi-X9-62 fieldType(1)}
426 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200427#define MBEDTLS_OID_ANSI_X9_62_FIELD_TYPE MBEDTLS_OID_ANSI_X9_62 "\x01"
428#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 +0100429
430/*
Paul Bakker75342a62014-04-08 17:35:40 +0200431 * ECDSA signature identifiers, from RFC 5480
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200432 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200433#define MBEDTLS_OID_ANSI_X9_62_SIG MBEDTLS_OID_ANSI_X9_62 "\x04" /* signatures(4) */
434#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 +0200435
436/* ecdsa-with-SHA1 OBJECT IDENTIFIER ::= {
437 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4) 1 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200438#define MBEDTLS_OID_ECDSA_SHA1 MBEDTLS_OID_ANSI_X9_62_SIG "\x01"
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200439
440/* ecdsa-with-SHA224 OBJECT IDENTIFIER ::= {
441 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
442 * ecdsa-with-SHA2(3) 1 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200443#define MBEDTLS_OID_ECDSA_SHA224 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x01"
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200444
445/* ecdsa-with-SHA256 OBJECT IDENTIFIER ::= {
446 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
447 * ecdsa-with-SHA2(3) 2 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200448#define MBEDTLS_OID_ECDSA_SHA256 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x02"
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200449
450/* ecdsa-with-SHA384 OBJECT IDENTIFIER ::= {
451 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
452 * ecdsa-with-SHA2(3) 3 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200453#define MBEDTLS_OID_ECDSA_SHA384 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x03"
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200454
455/* ecdsa-with-SHA512 OBJECT IDENTIFIER ::= {
456 * iso(1) member-body(2) us(840) ansi-X9-62(10045) signatures(4)
457 * ecdsa-with-SHA2(3) 4 } */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200458#define MBEDTLS_OID_ECDSA_SHA512 MBEDTLS_OID_ANSI_X9_62_SIG_SHA2 "\x04"
Manuel Pégourié-Gonnard1e60cd02013-07-10 10:28:53 +0200459
Jethro Beekman01672442023-04-19 14:08:14 +0200460/*
461 * EC key algorithms from RFC 8410
462 */
463
464#define MBEDTLS_OID_X25519 MBEDTLS_OID_THAWTE "\x6e" /**< id-X25519 OBJECT IDENTIFIER ::= { 1 3 101 110 } */
465#define MBEDTLS_OID_X448 MBEDTLS_OID_THAWTE "\x6f" /**< id-X448 OBJECT IDENTIFIER ::= { 1 3 101 111 } */
466#define MBEDTLS_OID_ED25519 MBEDTLS_OID_THAWTE "\x70" /**< id-Ed25519 OBJECT IDENTIFIER ::= { 1 3 101 112 } */
467#define MBEDTLS_OID_ED448 MBEDTLS_OID_THAWTE "\x71" /**< id-Ed448 OBJECT IDENTIFIER ::= { 1 3 101 113 } */
468
Paul Bakkerc70b9822013-04-07 22:00:46 +0200469#ifdef __cplusplus
470extern "C" {
471#endif
472
473/**
474 * \brief Base OID descriptor structure
475 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100476typedef struct mbedtls_oid_descriptor_t {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200477 const char *MBEDTLS_PRIVATE(asn1); /*!< OID ASN.1 representation */
478 size_t MBEDTLS_PRIVATE(asn1_len); /*!< length of asn1 */
Hanno Becker612a2f12020-10-09 09:19:39 +0100479#if !defined(MBEDTLS_X509_REMOVE_INFO)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200480 const char *MBEDTLS_PRIVATE(name); /*!< official name (e.g. from RFC) */
481 const char *MBEDTLS_PRIVATE(description); /*!< human friendly description */
Peter Kolbus9a969b62018-12-11 13:55:56 -0600482#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200483} mbedtls_oid_descriptor_t;
Paul Bakkerc70b9822013-04-07 22:00:46 +0200484
485/**
486 * \brief Translate an ASN.1 OID into its numeric representation
487 * (e.g. "\x2A\x86\x48\x86\xF7\x0D" into "1.2.840.113549")
488 *
489 * \param buf buffer to put representation in
490 * \param size size of the buffer
491 * \param oid OID to translate
492 *
Manuel Pégourié-Gonnard7afdb882014-03-28 16:06:35 +0100493 * \return Length of the string written (excluding final NULL) or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200494 * MBEDTLS_ERR_OID_BUF_TOO_SMALL in case of error
Paul Bakkerc70b9822013-04-07 22:00:46 +0200495 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100496int mbedtls_oid_get_numeric_string(char *buf, size_t size, const mbedtls_asn1_buf *oid);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200497
498/**
David Horstmannb97b6892023-05-31 14:41:11 +0100499 * \brief Translate a string containing a dotted-decimal
500 * representation of an ASN.1 OID into its encoded form
501 * (e.g. "1.2.840.113549" into "\x2A\x86\x48\x86\xF7\x0D").
David Horstmann59400ff2023-02-21 15:27:16 +0000502 * On success, this function allocates oid->buf from the
David Horstmann099be742023-02-23 13:51:43 +0000503 * heap. It must be freed by the caller using mbedtls_free().
David Horstmann92337c02023-01-18 18:40:49 +0000504 *
David Horstmannd1a203a2023-06-01 15:02:15 +0100505 * \param oid #mbedtls_asn1_buf to populate with the DER-encoded OID
David Horstmannbf95e9a2023-06-01 15:33:15 +0100506 * \param oid_str string representation of the OID to parse
507 * \param size length of the OID string, not including any null terminator
David Horstmann92337c02023-01-18 18:40:49 +0000508 *
David Horstmann59400ff2023-02-21 15:27:16 +0000509 * \return 0 if successful
David Horstmannd1a203a2023-06-01 15:02:15 +0100510 * \return #MBEDTLS_ERR_ASN1_INVALID_DATA if \p oid_str does not
David Horstmann59400ff2023-02-21 15:27:16 +0000511 * represent a valid OID
512 * \return #MBEDTLS_ERR_ASN1_ALLOC_FAILED if the function fails to
513 * allocate oid->buf
David Horstmann92337c02023-01-18 18:40:49 +0000514 */
David Horstmann59400ff2023-02-21 15:27:16 +0000515int mbedtls_oid_from_numeric_string(mbedtls_asn1_buf *oid, const char *oid_str, size_t size);
David Horstmann92337c02023-01-18 18:40:49 +0000516
517/**
Paul Bakkerc70b9822013-04-07 22:00:46 +0200518 * \brief Translate an X.509 extension OID into local values
519 *
520 * \param oid OID to use
521 * \param ext_type place to store the extension type
522 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200523 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200524 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100525int mbedtls_oid_get_x509_ext_type(const mbedtls_asn1_buf *oid, int *ext_type);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200526
527/**
528 * \brief Translate an X.509 attribute type OID into the short name
529 * (e.g. the OID for an X520 Common Name into "CN")
530 *
531 * \param oid OID to use
532 * \param short_name place to store the string pointer
533 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200534 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200535 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100536int mbedtls_oid_get_attr_short_name(const mbedtls_asn1_buf *oid, const char **short_name);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200537
538/**
539 * \brief Translate PublicKeyAlgorithm OID into pk_type
540 *
541 * \param oid OID to use
542 * \param pk_alg place to store public key algorithm
543 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200545 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100546int mbedtls_oid_get_pk_alg(const mbedtls_asn1_buf *oid, mbedtls_pk_type_t *pk_alg);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200547
Manuel Pégourié-Gonnardedda9042013-09-12 02:17:54 +0200548/**
549 * \brief Translate pk_type into PublicKeyAlgorithm OID
550 *
551 * \param pk_alg Public key type to look for
552 * \param oid place to store ASN.1 OID string pointer
553 * \param olen length of the OID
554 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200555 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Manuel Pégourié-Gonnardedda9042013-09-12 02:17:54 +0200556 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100557int mbedtls_oid_get_oid_by_pk_alg(mbedtls_pk_type_t pk_alg,
558 const char **oid, size_t *olen);
Manuel Pégourié-Gonnardedda9042013-09-12 02:17:54 +0200559
Valerio Setti81d75122023-06-14 14:49:33 +0200560#if defined(MBEDTLS_PK_HAVE_ECC_KEYS)
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200561/**
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200562 * \brief Translate NamedCurve OID into an EC group identifier
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200563 *
564 * \param oid OID to use
565 * \param grp_id place to store group id
566 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Manuel Pégourié-Gonnardf0b30d02013-07-01 17:34:57 +0200568 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100569int 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 +0200570
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200571/**
Manuel Pégourié-Gonnardedda9042013-09-12 02:17:54 +0200572 * \brief Translate EC group identifier into NamedCurve OID
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200573 *
Manuel Pégourié-Gonnardedda9042013-09-12 02:17:54 +0200574 * \param grp_id EC group identifier
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200575 * \param oid place to store ASN.1 OID string pointer
576 * \param olen length of the OID
577 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200578 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200579 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100580int mbedtls_oid_get_oid_by_ec_grp(mbedtls_ecp_group_id grp_id,
581 const char **oid, size_t *olen);
Jethro Beekman01672442023-04-19 14:08:14 +0200582
583/**
584 * \brief Translate AlgorithmIdentifier OID into an EC group identifier,
585 * for curves that are directly encoded at this level
586 *
587 * \param oid OID to use
588 * \param grp_id place to store group id
589 *
590 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
591 */
592int mbedtls_oid_get_ec_grp_algid(const mbedtls_asn1_buf *oid, mbedtls_ecp_group_id *grp_id);
593
594/**
595 * \brief Translate EC group identifier into AlgorithmIdentifier OID,
596 * for curves that are directly encoded at this level
597 *
598 * \param grp_id EC group identifier
599 * \param oid place to store ASN.1 OID string pointer
600 * \param olen length of the OID
601 *
602 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
603 */
604int mbedtls_oid_get_oid_by_ec_grp_algid(mbedtls_ecp_group_id grp_id,
605 const char **oid, size_t *olen);
Valerio Setti81d75122023-06-14 14:49:33 +0200606#endif /* MBEDTLS_PK_HAVE_ECC_KEYS */
Manuel Pégourié-Gonnard3837dae2013-09-12 01:39:07 +0200607
Paul Bakkerc70b9822013-04-07 22:00:46 +0200608/**
609 * \brief Translate SignatureAlgorithm OID into md_type and pk_type
610 *
611 * \param oid OID to use
612 * \param md_alg place to store message digest algorithm
613 * \param pk_alg place to store public key algorithm
614 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200615 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200616 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100617int mbedtls_oid_get_sig_alg(const mbedtls_asn1_buf *oid,
618 mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200619
620/**
621 * \brief Translate SignatureAlgorithm OID into description
622 *
623 * \param oid OID to use
624 * \param desc place to store string pointer
625 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200626 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200627 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100628int mbedtls_oid_get_sig_alg_desc(const mbedtls_asn1_buf *oid, const char **desc);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200629
630/**
631 * \brief Translate md_type and pk_type into SignatureAlgorithm OID
632 *
633 * \param md_alg message digest algorithm
634 * \param pk_alg public key algorithm
635 * \param oid place to store ASN.1 OID string pointer
Paul Bakker1c3853b2013-09-10 11:43:44 +0200636 * \param olen length of the OID
Paul Bakkerc70b9822013-04-07 22:00:46 +0200637 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200638 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200639 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100640int mbedtls_oid_get_oid_by_sig_alg(mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg,
641 const char **oid, size_t *olen);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200642
643/**
Antonio Quartulli12ccef22017-12-20 07:03:55 +0800644 * \brief Translate hmac algorithm OID into md_type
645 *
646 * \param oid OID to use
647 * \param md_hmac place to store message hmac algorithm
648 *
649 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
650 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100651int mbedtls_oid_get_md_hmac(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_hmac);
Paul Bakkerc70b9822013-04-07 22:00:46 +0200652
Manuel Pégourié-Gonnardfe2b9b52022-07-05 11:35:52 +0200653/**
654 * \brief Translate hash algorithm OID into md_type
655 *
656 * \param oid OID to use
657 * \param md_alg place to store message digest algorithm
658 *
659 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
660 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100661int 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 +0200662
Hanno Becker612a2f12020-10-09 09:19:39 +0100663#if !defined(MBEDTLS_X509_REMOVE_INFO)
Paul Bakkerc70b9822013-04-07 22:00:46 +0200664/**
665 * \brief Translate Extended Key Usage OID into description
666 *
667 * \param oid OID to use
668 * \param desc place to store string pointer
669 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200670 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200671 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100672int mbedtls_oid_get_extended_key_usage(const mbedtls_asn1_buf *oid, const char **desc);
Peter Kolbus9a969b62018-12-11 13:55:56 -0600673#endif
Paul Bakkerc70b9822013-04-07 22:00:46 +0200674
675/**
Ron Eldor11ee0712019-03-25 18:22:52 +0200676 * \brief Translate certificate policies OID into description
677 *
678 * \param oid OID to use
679 * \param desc place to store string pointer
680 *
681 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
682 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100683int mbedtls_oid_get_certificate_policies(const mbedtls_asn1_buf *oid, const char **desc);
Ron Eldor11ee0712019-03-25 18:22:52 +0200684
685/**
Paul Bakkerc70b9822013-04-07 22:00:46 +0200686 * \brief Translate md_type into hash algorithm OID
687 *
688 * \param md_alg message digest algorithm
689 * \param oid place to store ASN.1 OID string pointer
Paul Bakker1c3853b2013-09-10 11:43:44 +0200690 * \param olen length of the OID
Paul Bakkerc70b9822013-04-07 22:00:46 +0200691 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200692 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakkerc70b9822013-04-07 22:00:46 +0200693 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100694int 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 +0200695
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200696#if defined(MBEDTLS_CIPHER_C)
Paul Bakker9b5e8852013-06-28 16:12:50 +0200697/**
698 * \brief Translate encryption algorithm OID into cipher_type
699 *
700 * \param oid OID to use
701 * \param cipher_alg place to store cipher algorithm
702 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200703 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakker9b5e8852013-06-28 16:12:50 +0200704 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100705int mbedtls_oid_get_cipher_alg(const mbedtls_asn1_buf *oid, mbedtls_cipher_type_t *cipher_alg);
Paul Bakker9b5e8852013-06-28 16:12:50 +0200706
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200707#if defined(MBEDTLS_PKCS12_C)
Paul Bakker7749a222013-06-28 17:28:20 +0200708/**
709 * \brief Translate PKCS#12 PBE algorithm OID into md_type and
710 * cipher_type
711 *
712 * \param oid OID to use
713 * \param md_alg place to store message digest algorithm
714 * \param cipher_alg place to store cipher algorithm
715 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200716 * \return 0 if successful, or MBEDTLS_ERR_OID_NOT_FOUND
Paul Bakker7749a222013-06-28 17:28:20 +0200717 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100718int mbedtls_oid_get_pkcs12_pbe_alg(const mbedtls_asn1_buf *oid, mbedtls_md_type_t *md_alg,
719 mbedtls_cipher_type_t *cipher_alg);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200720#endif /* MBEDTLS_PKCS12_C */
Valerio Settie581e142023-12-29 16:35:07 +0100721#endif /* MBEDTLS_CIPHER_C */
Paul Bakker7749a222013-06-28 17:28:20 +0200722
Paul Bakkerc70b9822013-04-07 22:00:46 +0200723#ifdef __cplusplus
724}
725#endif
726
727#endif /* oid.h */