TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / mirror / mbed-tls / 5a9b82e2347f002e32cd16ddd905874f79d23469 / . / include / polarssl / oid.h
blob: d9a1f8f7980abbff8e49d1ac291ab223fea69571 [file] [log] [blame]
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]1/**
2 * \file oid.h
3 *
4 * \brief Object Identifier (OID) database
5 *
6 * Copyright (C) 2006-2013, Brainspark B.V.
7 *
8 * This file is part of PolarSSL (http://www.polarssl.org)
9 * Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
10 *
11 * All rights reserved.
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License along
24 * with this program; if not, write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 */
27#ifndef POLARSSL_OID_H
28#define POLARSSL_OID_H
29
30#include <string.h>
Paul Bakker47fce022013-06-28 17:34:34 +0200[diff] [blame]31#include "config.h"
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]32#include "asn1.h"
Paul Bakkered27a042013-04-18 22:46:23 +0200[diff] [blame]33#include "pk.h"
Paul Bakker47fce022013-06-28 17:34:34 +0200[diff] [blame]34
35#if defined(POLARSSL_CIPHER_C)
36#include "cipher.h"
37#endif
38
39#if defined(POLARSSL_MD_C)
40#include "md.h"
41#endif
42
43#if defined(POLARSSL_X509_PARSE_C)
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]44#include "x509.h"
Paul Bakker47fce022013-06-28 17:34:34 +0200[diff] [blame]45#endif
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]46
47#define POLARSSL_ERR_OID_NOT_FOUND -0x002E /**< OID is not found. */
48
49/*
50 * Top level OID tuples
51 */
52#define OID_ISO_MEMBER_BODIES "\x2a" /* {iso(1) member-body(2)} */
53#define OID_ISO_IDENTIFIED_ORG "\x2b" /* {iso(1) identified-organization(3)} */
54#define OID_ISO_CCITT_DS "\x55" /* {joint-iso-ccitt(2) ds(5)} */
55#define OID_ISO_ITU_COUNTRY "\x60" /* {joint-iso-itu-t(2) country(16)} */
56
57/*
58 * ISO Member bodies OID parts
59 */
60#define OID_COUNTRY_US "\x86\x48" /* {us(840)} */
61#define OID_ORG_RSA_DATA_SECURITY "\x86\xf7\x0d" /* {rsadsi(113549)} */
62#define OID_RSA_COMPANY OID_ISO_MEMBER_BODIES OID_COUNTRY_US \
63 OID_ORG_RSA_DATA_SECURITY /* {iso(1) member-body(2) us(840) rsadsi(113549)} */
Manuel Pégourié-Gonnard5a9b82e2013-07-01 16:57:44 +0200[diff] [blame^]64#define OID_ORG_ANSI_X9_62 "\xce\x3d" /* ansi-X9-62(10045) */
65#define OID_ANSI_X9_62 OID_ISO_MEMBER_BODIES OID_COUNTRY_US \
66 OID_ORG_ANSI_X9_62
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]67
68/*
69 * ISO Identified organization OID parts
70 */
71#define OID_ORG_DOD "\x06" /* {dod(6)} */
Paul Bakker9b5e8852013-06-28 16:12:50 +0200[diff] [blame]72#define OID_ORG_OIW "\x0e"
73#define OID_OIW_SECSIG OID_ORG_OIW "\x03"
74#define OID_OIW_SECSIG_ALG OID_OIW_SECSIG "\x02"
75#define OID_OIW_SECSIG_SHA1 OID_OIW_SECSIG_ALG "\x1a"
Manuel Pégourié-Gonnard5a9b82e2013-07-01 16:57:44 +0200[diff] [blame^]76#define OID_ORG_CERTICOM "\x81\x04" /* certicom(132) */
77#define OID_CERTICOM OID_ISO_IDENTIFIED_ORG OID_ORG_CERTICOM
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]78
79/*
80 * ISO ITU OID parts
81 */
82#define OID_ORGANIZATION "\x01" /* {organization(1)} */
83#define OID_ISO_ITU_US_ORG OID_ISO_ITU_COUNTRY OID_COUNTRY_US OID_ORGANIZATION /* {joint-iso-itu-t(2) country(16) us(840) organization(1)} */
84
85#define OID_ORG_GOV "\x65" /* {gov(101)} */
86#define OID_GOV OID_ISO_ITU_US_ORG OID_ORG_GOV /* {joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101)} */
87
88#define OID_ORG_NETSCAPE "\x86\xF8\x42" /* {netscape(113730)} */
89#define OID_NETSCAPE OID_ISO_ITU_US_ORG OID_ORG_NETSCAPE /* Netscape OID {joint-iso-itu-t(2) country(16) us(840) organization(1) netscape(113730)} */
90
91/* ISO arc for standard certificate and CRL extensions */
92#define OID_ID_CE OID_ISO_CCITT_DS "\x1D" /**< id-ce OBJECT IDENTIFIER ::= {joint-iso-ccitt(2) ds(5) 29} */
93
94/**
95 * Private Internet Extensions
96 * { iso(1) identified-organization(3) dod(6) internet(1)
97 * security(5) mechanisms(5) pkix(7) }
98 */
99#define OID_PKIX OID_ISO_IDENTIFIED_ORG OID_ORG_DOD "\x01\x05\x05\x07"
100
101/*
102 * Arc for standard naming attributes
103 */
104#define OID_AT OID_ISO_CCITT_DS "\x04" /**< id-at OBJECT IDENTIFIER ::= {joint-iso-ccitt(2) ds(5) 4} */
105#define OID_AT_CN OID_AT "\x03" /**< id-at-commonName AttributeType:= {id-at 3} */
106#define OID_AT_COUNTRY OID_AT "\x06" /**< id-at-countryName AttributeType:= {id-at 6} */
107#define OID_AT_LOCALITY OID_AT "\x07" /**< id-at-locality AttributeType:= {id-at 7} */
108#define OID_AT_STATE OID_AT "\x08" /**< id-at-state AttributeType:= {id-at 8} */
109#define OID_AT_ORGANIZATION OID_AT "\x0A" /**< id-at-organizationName AttributeType:= {id-at 10} */
110#define OID_AT_ORG_UNIT OID_AT "\x0B" /**< id-at-organizationalUnitName AttributeType:= {id-at 11} */
111
112/*
113 * OIDs for standard certificate extensions
114 */
115#define OID_AUTHORITY_KEY_IDENTIFIER OID_ID_CE "\x23" /**< id-ce-authorityKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 35 } */
116#define OID_SUBJECT_KEY_IDENTIFIER OID_ID_CE "\x0E" /**< id-ce-subjectKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 14 } */
117#define OID_KEY_USAGE OID_ID_CE "\x0F" /**< id-ce-keyUsage OBJECT IDENTIFIER ::= { id-ce 15 } */
118#define OID_CERTIFICATE_POLICIES OID_ID_CE "\x20" /**< id-ce-certificatePolicies OBJECT IDENTIFIER ::= { id-ce 32 } */
119#define OID_POLICY_MAPPINGS OID_ID_CE "\x21" /**< id-ce-policyMappings OBJECT IDENTIFIER ::= { id-ce 33 } */
120#define OID_SUBJECT_ALT_NAME OID_ID_CE "\x11" /**< id-ce-subjectAltName OBJECT IDENTIFIER ::= { id-ce 17 } */
121#define OID_ISSUER_ALT_NAME OID_ID_CE "\x12" /**< id-ce-issuerAltName OBJECT IDENTIFIER ::= { id-ce 18 } */
122#define OID_SUBJECT_DIRECTORY_ATTRS OID_ID_CE "\x09" /**< id-ce-subjectDirectoryAttributes OBJECT IDENTIFIER ::= { id-ce 9 } */
123#define OID_BASIC_CONSTRAINTS OID_ID_CE "\x13" /**< id-ce-basicConstraints OBJECT IDENTIFIER ::= { id-ce 19 } */
124#define OID_NAME_CONSTRAINTS OID_ID_CE "\x1E" /**< id-ce-nameConstraints OBJECT IDENTIFIER ::= { id-ce 30 } */
125#define OID_POLICY_CONSTRAINTS OID_ID_CE "\x24" /**< id-ce-policyConstraints OBJECT IDENTIFIER ::= { id-ce 36 } */
126#define OID_EXTENDED_KEY_USAGE OID_ID_CE "\x25" /**< id-ce-extKeyUsage OBJECT IDENTIFIER ::= { id-ce 37 } */
127#define OID_CRL_DISTRIBUTION_POINTS OID_ID_CE "\x1F" /**< id-ce-cRLDistributionPoints OBJECT IDENTIFIER ::= { id-ce 31 } */
128#define OID_INIHIBIT_ANYPOLICY OID_ID_CE "\x36" /**< id-ce-inhibitAnyPolicy OBJECT IDENTIFIER ::= { id-ce 54 } */
129#define OID_FRESHEST_CRL OID_ID_CE "\x2E" /**< id-ce-freshestCRL OBJECT IDENTIFIER ::= { id-ce 46 } */
130
131/*
132 * Netscape certificate extensions
133 */
134#define OID_NS_CERT OID_NETSCAPE "\x01"
135#define OID_NS_CERT_TYPE OID_NS_CERT "\x01"
136#define OID_NS_BASE_URL OID_NS_CERT "\x02"
137#define OID_NS_REVOCATION_URL OID_NS_CERT "\x03"
138#define OID_NS_CA_REVOCATION_URL OID_NS_CERT "\x04"
139#define OID_NS_RENEWAL_URL OID_NS_CERT "\x07"
140#define OID_NS_CA_POLICY_URL OID_NS_CERT "\x08"
141#define OID_NS_SSL_SERVER_NAME OID_NS_CERT "\x0C"
142#define OID_NS_COMMENT OID_NS_CERT "\x0D"
143#define OID_NS_DATA_TYPE OID_NETSCAPE "\x02"
144#define OID_NS_CERT_SEQUENCE OID_NS_DATA_TYPE "\x05"
145
146/*
147 * OIDs for CRL extensions
148 */
149#define OID_PRIVATE_KEY_USAGE_PERIOD OID_ID_CE "\x10"
150#define OID_CRL_NUMBER OID_ID_CE "\x14" /**< id-ce-cRLNumber OBJECT IDENTIFIER ::= { id-ce 20 } */
151
152/*
153 * X.509 v3 Extended key usage OIDs
154 */
155#define OID_ANY_EXTENDED_KEY_USAGE OID_EXTENDED_KEY_USAGE "\x00" /**< anyExtendedKeyUsage OBJECT IDENTIFIER ::= { id-ce-extKeyUsage 0 } */
156
157#define OID_KP OID_PKIX "\x03" /**< id-kp OBJECT IDENTIFIER ::= { id-pkix 3 } */
158#define OID_SERVER_AUTH OID_KP "\x01" /**< id-kp-serverAuth OBJECT IDENTIFIER ::= { id-kp 1 } */
159#define OID_CLIENT_AUTH OID_KP "\x02" /**< id-kp-clientAuth OBJECT IDENTIFIER ::= { id-kp 2 } */
160#define OID_CODE_SIGNING OID_KP "\x03" /**< id-kp-codeSigning OBJECT IDENTIFIER ::= { id-kp 3 } */
161#define OID_EMAIL_PROTECTION OID_KP "\x04" /**< id-kp-emailProtection OBJECT IDENTIFIER ::= { id-kp 4 } */
162#define OID_TIME_STAMPING OID_KP "\x08" /**< id-kp-timeStamping OBJECT IDENTIFIER ::= { id-kp 8 } */
163#define OID_OCSP_SIGNING OID_KP "\x09" /**< id-kp-OCSPSigning OBJECT IDENTIFIER ::= { id-kp 9 } */
164
Paul Bakker9b5e8852013-06-28 16:12:50 +0200[diff] [blame]165/*
166 * PKCS definition OIDs
167 */
168
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]169#define OID_PKCS OID_RSA_COMPANY "\x01" /**< pkcs OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) 1 } */
170#define OID_PKCS1 OID_PKCS "\x01" /**< pkcs-1 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 1 } */
Paul Bakker9b5e8852013-06-28 16:12:50 +0200[diff] [blame]171#define OID_PKCS5 OID_PKCS "\x05" /**< pkcs-5 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 5 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]172#define OID_PKCS9 OID_PKCS "\x09" /**< pkcs-9 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 9 } */
Paul Bakker7749a222013-06-28 17:28:20 +0200[diff] [blame]173#define OID_PKCS12 OID_PKCS "\x0c" /**< pkcs-12 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 12 } */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]174
Paul Bakker9b5e8852013-06-28 16:12:50 +0200[diff] [blame]175/*
176 * PKCS#1 OIDs
177 */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]178#define OID_PKCS1_RSA OID_PKCS1 "\x01" /**< rsaEncryption OBJECT IDENTIFIER ::= { pkcs-1 1 } */
179#define OID_PKCS1_MD2 OID_PKCS1 "\x02" /**< md2WithRSAEncryption ::= { pkcs-1 2 } */
180#define OID_PKCS1_MD4 OID_PKCS1 "\x03" /**< md4WithRSAEncryption ::= { pkcs-1 3 } */
181#define OID_PKCS1_MD5 OID_PKCS1 "\x04" /**< md5WithRSAEncryption ::= { pkcs-1 4 } */
182#define OID_PKCS1_SHA1 OID_PKCS1 "\x05" /**< sha1WithRSAEncryption ::= { pkcs-1 5 } */
183#define OID_PKCS1_SHA224 OID_PKCS1 "\x0e" /**< sha224WithRSAEncryption ::= { pkcs-1 14 } */
184#define OID_PKCS1_SHA256 OID_PKCS1 "\x0b" /**< sha256WithRSAEncryption ::= { pkcs-1 11 } */
185#define OID_PKCS1_SHA384 OID_PKCS1 "\x0c" /**< sha384WithRSAEncryption ::= { pkcs-1 12 } */
186#define OID_PKCS1_SHA512 OID_PKCS1 "\x0d" /**< sha512WithRSAEncryption ::= { pkcs-1 13 } */
187
188#define OID_RSA_SHA_OBS "\x2B\x0E\x03\x02\x1D"
189
190#define OID_PKCS9_EMAIL OID_PKCS9 "\x01" /**< emailAddress AttributeType ::= { pkcs-9 1 } */
191
Paul Bakker9b5e8852013-06-28 16:12:50 +0200[diff] [blame]192/*
193 * Digest algorithms
194 */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]195#define OID_DIGEST_ALG_MD2 OID_RSA_COMPANY "\x02\x02" /**< id-md2 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 2 } */
196#define OID_DIGEST_ALG_MD4 OID_RSA_COMPANY "\x02\x04" /**< id-md4 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 4 } */
197#define OID_DIGEST_ALG_MD5 OID_RSA_COMPANY "\x02\x05" /**< id-md5 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 5 } */
198#define OID_DIGEST_ALG_SHA1 OID_ISO_IDENTIFIED_ORG OID_OIW_SECSIG_SHA1 /**< id-sha1 OBJECT IDENTIFIER ::= { iso(1) identified-organization(3) oiw(14) secsig(3) algorithms(2) 26 } */
199#define OID_DIGEST_ALG_SHA224 OID_GOV "\x03\x04\x02\x04" /**< id-sha224 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistalgorithm(4) hashalgs(2) 4 } */
200#define OID_DIGEST_ALG_SHA256 OID_GOV "\x03\x04\x02\x01" /**< id-sha256 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistalgorithm(4) hashalgs(2) 1 } */
201
202#define OID_DIGEST_ALG_SHA384 OID_GOV "\x03\x04\x02\x02" /**< id-sha384 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistalgorithm(4) hashalgs(2) 2 } */
203
204#define OID_DIGEST_ALG_SHA512 OID_GOV "\x03\x04\x02\x03" /**< id-sha512 OBJECT IDENTIFIER ::= { joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101) csor(3) nistalgorithm(4) hashalgs(2) 3 } */
205
Paul Bakker9b5e8852013-06-28 16:12:50 +0200[diff] [blame]206#define OID_HMAC_SHA1 OID_RSA_COMPANY "\x02\x07" /**< id-hmacWithSHA1 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) digestAlgorithm(2) 7 } */
207
208/*
209 * Encryption algorithms
210 */
211#define OID_DES_CBC OID_ISO_IDENTIFIED_ORG OID_OIW_SECSIG_ALG "\x07" /**< desCBC OBJECT IDENTIFIER ::= { iso(1) identified-organization(3) oiw(14) secsig(3) algorithms(2) 7 } */
212#define OID_DES_EDE3_CBC OID_RSA_COMPANY "\x03\x07" /**< des-ede3-cbc OBJECT IDENTIFIER ::= { iso(1) member-body(2) -- us(840) rsadsi(113549) encryptionAlgorithm(3) 7 } */
213
214/*
215 * PKCS#5 OIDs
216 */
217#define OID_PKCS5_PBKDF2 OID_PKCS5 "\x0c" /**< id-PBKDF2 OBJECT IDENTIFIER ::= {pkcs-5 12} */
218#define OID_PKCS5_PBES2 OID_PKCS5 "\x0d" /**< id-PBES2 OBJECT IDENTIFIER ::= {pkcs-5 13} */
219#define OID_PKCS5_PBMAC1 OID_PKCS5 "\x0e" /**< id-PBMAC1 OBJECT IDENTIFIER ::= {pkcs-5 14} */
220
221/*
222 * PKCS#5 PBES1 algorithms
223 */
224#define OID_PKCS5_PBE_MD2_DES_CBC OID_PKCS5 "\x01" /**< pbeWithMD2AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 1} */
225#define OID_PKCS5_PBE_MD2_RC2_CBC OID_PKCS5 "\x04" /**< pbeWithMD2AndRC2-CBC OBJECT IDENTIFIER ::= {pkcs-5 4} */
226#define OID_PKCS5_PBE_MD5_DES_CBC OID_PKCS5 "\x03" /**< pbeWithMD5AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 3} */
227#define OID_PKCS5_PBE_MD5_RC2_CBC OID_PKCS5 "\x06" /**< pbeWithMD5AndRC2-CBC OBJECT IDENTIFIER ::= {pkcs-5 6} */
228#define OID_PKCS5_PBE_SHA1_DES_CBC OID_PKCS5 "\x0a" /**< pbeWithSHA1AndDES-CBC OBJECT IDENTIFIER ::= {pkcs-5 10} */
229#define OID_PKCS5_PBE_SHA1_RC2_CBC OID_PKCS5 "\x0b" /**< pbeWithSHA1AndRC2-CBC OBJECT IDENTIFIER ::= {pkcs-5 11} */
230
Paul Bakker7749a222013-06-28 17:28:20 +0200[diff] [blame]231/*
232 * PKCS#12 PBE OIDs
233 */
234#define OID_PKCS12_PBE OID_PKCS12 "\x01" /**< pkcs-12PbeIds OBJECT IDENTIFIER ::= {pkcs-12 1} */
235
236#define OID_PKCS12_PBE_SHA1_RC4_128 OID_PKCS12_PBE "\x01" /**< pbeWithSHAAnd128BitRC4 OBJECT IDENTIFIER ::= {pkcs-12PbeIds 1} */
237#define OID_PKCS12_PBE_SHA1_RC4_40 OID_PKCS12_PBE "\x02" /**< pbeWithSHAAnd40BitRC4 OBJECT IDENTIFIER ::= {pkcs-12PbeIds 2} */
238#define OID_PKCS12_PBE_SHA1_DES3_EDE_CBC OID_PKCS12_PBE "\x03" /**< pbeWithSHAAnd3-KeyTripleDES-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 3} */
239#define OID_PKCS12_PBE_SHA1_DES2_EDE_CBC OID_PKCS12_PBE "\x04" /**< pbeWithSHAAnd2-KeyTripleDES-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 4} */
240#define OID_PKCS12_PBE_SHA1_RC2_128_CBC OID_PKCS12_PBE "\x05" /**< pbeWithSHAAnd128BitRC2-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 5} */
241#define OID_PKCS12_PBE_SHA1_RC2_40_CBC OID_PKCS12_PBE "\x06" /**< pbeWithSHAAnd40BitRC2-CBC OBJECT IDENTIFIER ::= {pkcs-12PbeIds 6} */
242
Manuel Pégourié-Gonnard5a9b82e2013-07-01 16:57:44 +0200[diff] [blame^]243/*
244 * EC key algorithms from RFC 5420
245 */
246
247/* id-ecPublicKey OBJECT IDENTIFIER ::= {
248 * iso(1) member-body(2) us(840) ansi-X9-62(10045) keyType(2) 1 } */
249#define OID_EC_ALG_UNRESTRICTED OID_ANSI_X9_62 "\x02\01"
250
251/* id-ecDH OBJECT IDENTIFIER ::= {
252 * iso(1) identified-organization(3) certicom(132)
253 * schemes(1) ecdh(12) } */
254#define OID_EC_ALG_ECDH OID_CERTICOM "\x01\x0c"
255
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]256#ifdef __cplusplus
257extern "C" {
258#endif
259
260/**
261 * \brief Base OID descriptor structure
262 */
263typedef struct {
264 const char *asn1; /*!< OID ASN.1 representation */
265 const char *name; /*!< official name (e.g. from RFC) */
266 const char *description; /*!< human friendly description */
267} oid_descriptor_t;
268
269/**
270 * \brief Translate an ASN.1 OID into its numeric representation
271 * (e.g. "\x2A\x86\x48\x86\xF7\x0D" into "1.2.840.113549")
272 *
273 * \param buf buffer to put representation in
274 * \param size size of the buffer
275 * \param oid OID to translate
276 *
277 * \return POLARSSL_ERR_DEBUG_BUF_TOO_SMALL or actual length used
278 */
279int oid_get_numeric_string( char *buf, size_t size, const asn1_buf *oid );
280
Paul Bakkered27a042013-04-18 22:46:23 +0200[diff] [blame]281#if defined(POLARSSL_X509_PARSE_C)
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]282/**
283 * \brief Translate an X.509 extension OID into local values
284 *
285 * \param oid OID to use
286 * \param ext_type place to store the extension type
287 *
288 * \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND
289 */
290int oid_get_x509_ext_type( const asn1_buf *oid, int *ext_type );
Paul Bakkered27a042013-04-18 22:46:23 +0200[diff] [blame]291#endif
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]292
293/**
294 * \brief Translate an X.509 attribute type OID into the short name
295 * (e.g. the OID for an X520 Common Name into "CN")
296 *
297 * \param oid OID to use
298 * \param short_name place to store the string pointer
299 *
300 * \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND
301 */
302int oid_get_attr_short_name( const asn1_buf *oid, const char **short_name );
303
304/**
305 * \brief Translate PublicKeyAlgorithm OID into pk_type
306 *
307 * \param oid OID to use
308 * \param pk_alg place to store public key algorithm
309 *
310 * \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND
311 */
312int oid_get_pk_alg( const asn1_buf *oid, pk_type_t *pk_alg );
313
Paul Bakker47fce022013-06-28 17:34:34 +0200[diff] [blame]314#if defined(POLARSSL_MD_C)
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]315/**
316 * \brief Translate SignatureAlgorithm OID into md_type and pk_type
317 *
318 * \param oid OID to use
319 * \param md_alg place to store message digest algorithm
320 * \param pk_alg place to store public key algorithm
321 *
322 * \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND
323 */
324int oid_get_sig_alg( const asn1_buf *oid,
325 md_type_t *md_alg, pk_type_t *pk_alg );
326
327/**
328 * \brief Translate SignatureAlgorithm OID into description
329 *
330 * \param oid OID to use
331 * \param desc place to store string pointer
332 *
333 * \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND
334 */
335int oid_get_sig_alg_desc( const asn1_buf *oid, const char **desc );
336
337/**
338 * \brief Translate md_type and pk_type into SignatureAlgorithm OID
339 *
340 * \param md_alg message digest algorithm
341 * \param pk_alg public key algorithm
342 * \param oid place to store ASN.1 OID string pointer
343 *
344 * \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND
345 */
346int oid_get_oid_by_sig_alg( pk_type_t pk_alg, md_type_t md_alg,
347 const char **oid_str );
348
349/**
350 * \brief Translate hash algorithm OID into md_type
351 *
352 * \param oid OID to use
353 * \param md_alg place to store message digest algorithm
354 *
355 * \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND
356 */
357int oid_get_md_alg( const asn1_buf *oid, md_type_t *md_alg );
Paul Bakker47fce022013-06-28 17:34:34 +0200[diff] [blame]358#endif /* POLARSSL_MD_C */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]359
360/**
361 * \brief Translate Extended Key Usage OID into description
362 *
363 * \param oid OID to use
364 * \param desc place to store string pointer
365 *
366 * \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND
367 */
368int oid_get_extended_key_usage( const asn1_buf *oid, const char **desc );
369
370/**
371 * \brief Translate md_type into hash algorithm OID
372 *
373 * \param md_alg message digest algorithm
374 * \param oid place to store ASN.1 OID string pointer
375 *
376 * \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND
377 */
378int oid_get_oid_by_md( md_type_t md_alg, const char **oid_str );
379
Paul Bakker47fce022013-06-28 17:34:34 +0200[diff] [blame]380#if defined(POLARSSL_CIPHER_C)
Paul Bakker9b5e8852013-06-28 16:12:50 +0200[diff] [blame]381/**
382 * \brief Translate encryption algorithm OID into cipher_type
383 *
384 * \param oid OID to use
385 * \param cipher_alg place to store cipher algorithm
386 *
387 * \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND
388 */
389int oid_get_cipher_alg( const asn1_buf *oid, cipher_type_t *cipher_alg );
Paul Bakker47fce022013-06-28 17:34:34 +0200[diff] [blame]390#endif /* POLARSSL_CIPHER_C */
Paul Bakker9b5e8852013-06-28 16:12:50 +0200[diff] [blame]391
Paul Bakker7749a222013-06-28 17:28:20 +0200[diff] [blame]392#if defined(POLARSSL_PKCS12_C)
393/**
394 * \brief Translate PKCS#12 PBE algorithm OID into md_type and
395 * cipher_type
396 *
397 * \param oid OID to use
398 * \param md_alg place to store message digest algorithm
399 * \param cipher_alg place to store cipher algorithm
400 *
401 * \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND
402 */
403int oid_get_pkcs12_pbe_alg( const asn1_buf *oid, md_type_t *md_alg,
404 cipher_type_t *cipher_alg );
405#endif /* POLARSSL_PKCS12_C */
406
Paul Bakkerc70b9822013-04-07 22:00:46 +0200[diff] [blame]407#ifdef __cplusplus
408}
409#endif
410
411#endif /* oid.h */