Blame - include/polarssl/oid.h - mirror/mbed-tls

Paul Bakker

c70b982

2013-04-07 22:00:46 +0200

[diff] [blame^]

/**

* \file oid.h

*

* \brief Object Identifier (OID) database

*

*

* This file is part of PolarSSL (http://www.polarssl.org)

9

* Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>

*

*

* 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

#include <string.h>

#include "asn1.h"

#include "md.h"

#include "x509.h"

#define POLARSSL_ERR_OID_NOT_FOUND -0x002E /**< OID is not found. */

36

37

/*

38

* Top level OID tuples

39

*/

40

#define OID_ISO_MEMBER_BODIES "\x2a" /* {iso(1) member-body(2)} */

41

#define OID_ISO_IDENTIFIED_ORG "\x2b" /* {iso(1) identified-organization(3)} */

42

#define OID_ISO_CCITT_DS "\x55" /* {joint-iso-ccitt(2) ds(5)} */

43

#define OID_ISO_ITU_COUNTRY "\x60" /* {joint-iso-itu-t(2) country(16)} */

44

45

/*

46

* ISO Member bodies OID parts

47

*/

48

#define OID_COUNTRY_US "\x86\x48" /* {us(840)} */

49

#define OID_ORG_RSA_DATA_SECURITY "\x86\xf7\x0d" /* {rsadsi(113549)} */

50

#define OID_RSA_COMPANY OID_ISO_MEMBER_BODIES OID_COUNTRY_US \

51

OID_ORG_RSA_DATA_SECURITY /* {iso(1) member-body(2) us(840) rsadsi(113549)} */

52

53

/*

54

* ISO Identified organization OID parts

55

*/

56

#define OID_ORG_DOD "\x06" /* {dod(6)} */

57

#define OID_OIW_SECSIG_SHA1 "\x0e\x03\x02\x1a"

/*

* ISO ITU OID parts

*/

#define OID_ORGANIZATION "\x01" /* {organization(1)} */

63

#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)} */

64

65

#define OID_ORG_GOV "\x65" /* {gov(101)} */

66

#define OID_GOV OID_ISO_ITU_US_ORG OID_ORG_GOV /* {joint-iso-itu-t(2) country(16) us(840) organization(1) gov(101)} */

67

68

#define OID_ORG_NETSCAPE "\x86\xF8\x42" /* {netscape(113730)} */

69

#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)} */

70

71

/* ISO arc for standard certificate and CRL extensions */

72

#define OID_ID_CE OID_ISO_CCITT_DS "\x1D" /**< id-ce OBJECT IDENTIFIER ::= {joint-iso-ccitt(2) ds(5) 29} */

73

74

/**

75

* Private Internet Extensions

76

* { iso(1) identified-organization(3) dod(6) internet(1)

77

* security(5) mechanisms(5) pkix(7) }

78

*/

79

#define OID_PKIX OID_ISO_IDENTIFIED_ORG OID_ORG_DOD "\x01\x05\x05\x07"

80

81

/*

82

* Arc for standard naming attributes

83

*/

84

#define OID_AT OID_ISO_CCITT_DS "\x04" /**< id-at OBJECT IDENTIFIER ::= {joint-iso-ccitt(2) ds(5) 4} */

85

#define OID_AT_CN OID_AT "\x03" /**< id-at-commonName AttributeType:= {id-at 3} */

86

#define OID_AT_COUNTRY OID_AT "\x06" /**< id-at-countryName AttributeType:= {id-at 6} */

87

#define OID_AT_LOCALITY OID_AT "\x07" /**< id-at-locality AttributeType:= {id-at 7} */

88

#define OID_AT_STATE OID_AT "\x08" /**< id-at-state AttributeType:= {id-at 8} */

89

#define OID_AT_ORGANIZATION OID_AT "\x0A" /**< id-at-organizationName AttributeType:= {id-at 10} */

90

#define OID_AT_ORG_UNIT OID_AT "\x0B" /**< id-at-organizationalUnitName AttributeType:= {id-at 11} */

91

92

/*

93

* OIDs for standard certificate extensions

94

*/

95

#define OID_AUTHORITY_KEY_IDENTIFIER OID_ID_CE "\x23" /**< id-ce-authorityKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 35 } */

96

#define OID_SUBJECT_KEY_IDENTIFIER OID_ID_CE "\x0E" /**< id-ce-subjectKeyIdentifier OBJECT IDENTIFIER ::= { id-ce 14 } */

97

#define OID_KEY_USAGE OID_ID_CE "\x0F" /**< id-ce-keyUsage OBJECT IDENTIFIER ::= { id-ce 15 } */

98

#define OID_CERTIFICATE_POLICIES OID_ID_CE "\x20" /**< id-ce-certificatePolicies OBJECT IDENTIFIER ::= { id-ce 32 } */

99

#define OID_POLICY_MAPPINGS OID_ID_CE "\x21" /**< id-ce-policyMappings OBJECT IDENTIFIER ::= { id-ce 33 } */

100

#define OID_SUBJECT_ALT_NAME OID_ID_CE "\x11" /**< id-ce-subjectAltName OBJECT IDENTIFIER ::= { id-ce 17 } */

101

#define OID_ISSUER_ALT_NAME OID_ID_CE "\x12" /**< id-ce-issuerAltName OBJECT IDENTIFIER ::= { id-ce 18 } */

102

#define OID_SUBJECT_DIRECTORY_ATTRS OID_ID_CE "\x09" /**< id-ce-subjectDirectoryAttributes OBJECT IDENTIFIER ::= { id-ce 9 } */

103

#define OID_BASIC_CONSTRAINTS OID_ID_CE "\x13" /**< id-ce-basicConstraints OBJECT IDENTIFIER ::= { id-ce 19 } */

104

#define OID_NAME_CONSTRAINTS OID_ID_CE "\x1E" /**< id-ce-nameConstraints OBJECT IDENTIFIER ::= { id-ce 30 } */

105

#define OID_POLICY_CONSTRAINTS OID_ID_CE "\x24" /**< id-ce-policyConstraints OBJECT IDENTIFIER ::= { id-ce 36 } */

106

#define OID_EXTENDED_KEY_USAGE OID_ID_CE "\x25" /**< id-ce-extKeyUsage OBJECT IDENTIFIER ::= { id-ce 37 } */

107

#define OID_CRL_DISTRIBUTION_POINTS OID_ID_CE "\x1F" /**< id-ce-cRLDistributionPoints OBJECT IDENTIFIER ::= { id-ce 31 } */

108

#define OID_INIHIBIT_ANYPOLICY OID_ID_CE "\x36" /**< id-ce-inhibitAnyPolicy OBJECT IDENTIFIER ::= { id-ce 54 } */

109

#define OID_FRESHEST_CRL OID_ID_CE "\x2E" /**< id-ce-freshestCRL OBJECT IDENTIFIER ::= { id-ce 46 } */

110

111

/*

112

* Netscape certificate extensions

113

*/

114

#define OID_NS_CERT OID_NETSCAPE "\x01"

115

#define OID_NS_CERT_TYPE OID_NS_CERT "\x01"

116

#define OID_NS_BASE_URL OID_NS_CERT "\x02"

117

#define OID_NS_REVOCATION_URL OID_NS_CERT "\x03"

118

#define OID_NS_CA_REVOCATION_URL OID_NS_CERT "\x04"

119

#define OID_NS_RENEWAL_URL OID_NS_CERT "\x07"

120

#define OID_NS_CA_POLICY_URL OID_NS_CERT "\x08"

121

#define OID_NS_SSL_SERVER_NAME OID_NS_CERT "\x0C"

122

#define OID_NS_COMMENT OID_NS_CERT "\x0D"

123

#define OID_NS_DATA_TYPE OID_NETSCAPE "\x02"

124

#define OID_NS_CERT_SEQUENCE OID_NS_DATA_TYPE "\x05"

125

126

/*

127

* OIDs for CRL extensions

128

*/

129

#define OID_PRIVATE_KEY_USAGE_PERIOD OID_ID_CE "\x10"

130

#define OID_CRL_NUMBER OID_ID_CE "\x14" /**< id-ce-cRLNumber OBJECT IDENTIFIER ::= { id-ce 20 } */

131

132

/*

133

* X.509 v3 Extended key usage OIDs

134

*/

135

#define OID_ANY_EXTENDED_KEY_USAGE OID_EXTENDED_KEY_USAGE "\x00" /**< anyExtendedKeyUsage OBJECT IDENTIFIER ::= { id-ce-extKeyUsage 0 } */

136

137

#define OID_KP OID_PKIX "\x03" /**< id-kp OBJECT IDENTIFIER ::= { id-pkix 3 } */

138

#define OID_SERVER_AUTH OID_KP "\x01" /**< id-kp-serverAuth OBJECT IDENTIFIER ::= { id-kp 1 } */

139

#define OID_CLIENT_AUTH OID_KP "\x02" /**< id-kp-clientAuth OBJECT IDENTIFIER ::= { id-kp 2 } */

140

#define OID_CODE_SIGNING OID_KP "\x03" /**< id-kp-codeSigning OBJECT IDENTIFIER ::= { id-kp 3 } */

141

#define OID_EMAIL_PROTECTION OID_KP "\x04" /**< id-kp-emailProtection OBJECT IDENTIFIER ::= { id-kp 4 } */

142

#define OID_TIME_STAMPING OID_KP "\x08" /**< id-kp-timeStamping OBJECT IDENTIFIER ::= { id-kp 8 } */

143

#define OID_OCSP_SIGNING OID_KP "\x09" /**< id-kp-OCSPSigning OBJECT IDENTIFIER ::= { id-kp 9 } */

144

145

#define OID_PKCS OID_RSA_COMPANY "\x01" /**< pkcs OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) 1 } */

146

#define OID_PKCS1 OID_PKCS "\x01" /**< pkcs-1 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 1 } */

147

#define OID_PKCS9 OID_PKCS "\x09" /**< pkcs-9 OBJECT IDENTIFIER ::= { iso(1) member-body(2) us(840) rsadsi(113549) pkcs(1) 9 } */

148

149

#define OID_PKCS1_RSA OID_PKCS1 "\x01" /**< rsaEncryption OBJECT IDENTIFIER ::= { pkcs-1 1 } */

150

#define OID_PKCS1_MD2 OID_PKCS1 "\x02" /**< md2WithRSAEncryption ::= { pkcs-1 2 } */

151

#define OID_PKCS1_MD4 OID_PKCS1 "\x03" /**< md4WithRSAEncryption ::= { pkcs-1 3 } */

152

#define OID_PKCS1_MD5 OID_PKCS1 "\x04" /**< md5WithRSAEncryption ::= { pkcs-1 4 } */

153

#define OID_PKCS1_SHA1 OID_PKCS1 "\x05" /**< sha1WithRSAEncryption ::= { pkcs-1 5 } */

154

#define OID_PKCS1_SHA224 OID_PKCS1 "\x0e" /**< sha224WithRSAEncryption ::= { pkcs-1 14 } */

155

#define OID_PKCS1_SHA256 OID_PKCS1 "\x0b" /**< sha256WithRSAEncryption ::= { pkcs-1 11 } */

156

#define OID_PKCS1_SHA384 OID_PKCS1 "\x0c" /**< sha384WithRSAEncryption ::= { pkcs-1 12 } */

157

#define OID_PKCS1_SHA512 OID_PKCS1 "\x0d" /**< sha512WithRSAEncryption ::= { pkcs-1 13 } */

158

159

#define OID_RSA_SHA_OBS "\x2B\x0E\x03\x02\x1D"

160

161

#define OID_PKCS9_EMAIL OID_PKCS9 "\x01" /**< emailAddress AttributeType ::= { pkcs-9 1 } */

162

163

#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 } */

164

#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 } */

165

#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 } */

166

#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 } */

167

#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 } */

168

#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 } */

169

170

#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 } */

171

172

#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 } */

#ifdef __cplusplus

extern "C" {

#endif

/**

* \brief Base OID descriptor structure

180

*/

181

typedef struct {

182

const char *asn1; /*!< OID ASN.1 representation */

183

const char *name; /*!< official name (e.g. from RFC) */

184

const char *description; /*!< human friendly description */

} oid_descriptor_t;

/**

* \brief Translate an ASN.1 OID into its numeric representation

189

* (e.g. "\x2A\x86\x48\x86\xF7\x0D" into "1.2.840.113549")

190

*

191

* \param buf buffer to put representation in

192

* \param size size of the buffer

193

* \param oid OID to translate

194

*

195

* \return POLARSSL_ERR_DEBUG_BUF_TOO_SMALL or actual length used

196

*/

197

int oid_get_numeric_string( char *buf, size_t size, const asn1_buf *oid );

198

199

/**

200

* \brief Translate an X.509 extension OID into local values

201

*

202

* \param oid OID to use

203

* \param ext_type place to store the extension type

204

*

205

* \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND

206

*/

207

int oid_get_x509_ext_type( const asn1_buf *oid, int *ext_type );

208

209

/**

210

* \brief Translate an X.509 attribute type OID into the short name

211

* (e.g. the OID for an X520 Common Name into "CN")

212

*

213

* \param oid OID to use

214

* \param short_name place to store the string pointer

215

*

216

* \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND

217

*/

218

int oid_get_attr_short_name( const asn1_buf *oid, const char **short_name );

219

220

/**

221

* \brief Translate PublicKeyAlgorithm OID into pk_type

222

*

223

* \param oid OID to use

224

* \param pk_alg place to store public key algorithm

225

*

226

* \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND

227

*/

228

int oid_get_pk_alg( const asn1_buf *oid, pk_type_t *pk_alg );

229

230

/**

231

* \brief Translate SignatureAlgorithm OID into md_type and pk_type

232

*

233

* \param oid OID to use

234

* \param md_alg place to store message digest algorithm

235

* \param pk_alg place to store public key algorithm

236

*

237

* \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND

238

*/

239

int oid_get_sig_alg( const asn1_buf *oid,

240

md_type_t *md_alg, pk_type_t *pk_alg );

241

242

/**

243

* \brief Translate SignatureAlgorithm OID into description

244

*

245

* \param oid OID to use

246

* \param desc place to store string pointer

247

*

248

* \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND

249

*/

250

int oid_get_sig_alg_desc( const asn1_buf *oid, const char **desc );

251

252

/**

253

* \brief Translate md_type and pk_type into SignatureAlgorithm OID

254

*

255

* \param md_alg message digest algorithm

256

* \param pk_alg public key algorithm

257

* \param oid place to store ASN.1 OID string pointer

258

*

259

* \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND

260

*/

261

int oid_get_oid_by_sig_alg( pk_type_t pk_alg, md_type_t md_alg,

262

const char **oid_str );

263

264

/**

265

* \brief Translate hash algorithm OID into md_type

266

*

267

* \param oid OID to use

268

* \param md_alg place to store message digest algorithm

269

*

270

* \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND

271

*/

272

int oid_get_md_alg( const asn1_buf *oid, md_type_t *md_alg );

273

274

/**

275

* \brief Translate Extended Key Usage OID into description

276

*

277

* \param oid OID to use

278

* \param desc place to store string pointer

279

*

280

* \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND

281

*/

282

int oid_get_extended_key_usage( const asn1_buf *oid, const char **desc );

283

284

/**

285

* \brief Translate md_type into hash algorithm OID

286

*

287

* \param md_alg message digest algorithm

288

* \param oid place to store ASN.1 OID string pointer

289

*

290

* \return 0 if successful, or POLARSSL_ERR_OID_NOT_FOUND

291

*/

292

int oid_get_oid_by_md( md_type_t md_alg, const char **oid_str );

#ifdef __cplusplus

}

#endif

#endif /* oid.h */