blob: d7f1443879894e535af5b80c684e11cf6e214399 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file x509.h
Paul Bakkere0ccd0a2009-01-04 16:27:10 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief X.509 certificate and private key decoding
5 *
Paul Bakker407a0da2013-06-27 14:29:21 +02006 * Copyright (C) 2006-2013, Brainspark B.V.
Paul Bakkerb96f1542010-07-18 20:36:00 +00007 *
8 * This file is part of PolarSSL (http://www.polarssl.org)
Paul Bakker84f12b72010-07-18 10:13:04 +00009 * Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
Paul Bakkerb96f1542010-07-18 20:36:00 +000010 *
Paul Bakker77b385e2009-07-28 17:23:11 +000011 * All rights reserved.
Paul Bakkere0ccd0a2009-01-04 16:27:10 +000012 *
Paul Bakkere0ccd0a2009-01-04 16:27:10 +000013 * 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.
Paul Bakker5121ce52009-01-03 21:22:43 +000026 */
Paul Bakker40e46942009-01-03 21:51:57 +000027#ifndef POLARSSL_X509_H
28#define POLARSSL_X509_H
Paul Bakker5121ce52009-01-03 21:22:43 +000029
Paul Bakkered27a042013-04-18 22:46:23 +020030#include "config.h"
31
32#if defined(POLARSSL_X509_PARSE_C) || defined(POLARSSL_X509_WRITE_C)
Paul Bakkerefc30292011-11-10 14:43:23 +000033#include "asn1.h"
Paul Bakker314052f2011-08-15 09:07:52 +000034#include "rsa.h"
35#include "dhm.h"
Paul Bakkerc70b9822013-04-07 22:00:46 +020036#include "md.h"
Paul Bakkered27a042013-04-18 22:46:23 +020037#include "pk.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000038
Paul Bakker37ca75d2011-01-06 12:28:03 +000039/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +000040 * \addtogroup x509_module
41 * \{
Paul Bakker13e2dfe2009-07-28 07:18:38 +000042 */
Paul Bakker37ca75d2011-01-06 12:28:03 +000043
Paul Bakker37ca75d2011-01-06 12:28:03 +000044/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +000045 * \name X509 Error codes
46 * \{
Paul Bakker13e2dfe2009-07-28 07:18:38 +000047 */
Paul Bakker9d781402011-05-09 16:17:09 +000048#define POLARSSL_ERR_X509_FEATURE_UNAVAILABLE -0x2080 /**< Unavailable feature, e.g. RSA hashing/encryption combination. */
49#define POLARSSL_ERR_X509_CERT_INVALID_PEM -0x2100 /**< The PEM-encoded certificate contains invalid elements, e.g. invalid character. */
50#define POLARSSL_ERR_X509_CERT_INVALID_FORMAT -0x2180 /**< The certificate format is invalid, e.g. different type expected. */
51#define POLARSSL_ERR_X509_CERT_INVALID_VERSION -0x2200 /**< The certificate version element is invalid. */
52#define POLARSSL_ERR_X509_CERT_INVALID_SERIAL -0x2280 /**< The serial tag or value is invalid. */
53#define POLARSSL_ERR_X509_CERT_INVALID_ALG -0x2300 /**< The algorithm tag or value is invalid. */
54#define POLARSSL_ERR_X509_CERT_INVALID_NAME -0x2380 /**< The name tag or value is invalid. */
55#define POLARSSL_ERR_X509_CERT_INVALID_DATE -0x2400 /**< The date tag or value is invalid. */
56#define POLARSSL_ERR_X509_CERT_INVALID_PUBKEY -0x2480 /**< The pubkey tag or value is invalid (only RSA is supported). */
57#define POLARSSL_ERR_X509_CERT_INVALID_SIGNATURE -0x2500 /**< The signature tag or value invalid. */
58#define POLARSSL_ERR_X509_CERT_INVALID_EXTENSIONS -0x2580 /**< The extension tag or value is invalid. */
59#define POLARSSL_ERR_X509_CERT_UNKNOWN_VERSION -0x2600 /**< Certificate or CRL has an unsupported version number. */
60#define POLARSSL_ERR_X509_CERT_UNKNOWN_SIG_ALG -0x2680 /**< Signature algorithm (oid) is unsupported. */
Paul Bakkered56b222011-07-13 11:26:43 +000061#define POLARSSL_ERR_X509_UNKNOWN_PK_ALG -0x2700 /**< Key algorithm is unsupported (only RSA is supported). */
Paul Bakker9d781402011-05-09 16:17:09 +000062#define POLARSSL_ERR_X509_CERT_SIG_MISMATCH -0x2780 /**< Certificate signature algorithms do not match. (see \c ::x509_cert sig_oid) */
63#define POLARSSL_ERR_X509_CERT_VERIFY_FAILED -0x2800 /**< Certificate verification failed, e.g. CRL, CA or signature check failed. */
64#define POLARSSL_ERR_X509_KEY_INVALID_VERSION -0x2880 /**< Unsupported RSA key version */
65#define POLARSSL_ERR_X509_KEY_INVALID_FORMAT -0x2900 /**< Invalid RSA key tag or value. */
Paul Bakker6c0ceb32011-12-04 12:24:18 +000066#define POLARSSL_ERR_X509_CERT_UNKNOWN_FORMAT -0x2980 /**< Format not recognized as DER or PEM. */
Paul Bakker69e095c2011-12-10 21:55:01 +000067#define POLARSSL_ERR_X509_INVALID_INPUT -0x2A00 /**< Input invalid. */
68#define POLARSSL_ERR_X509_MALLOC_FAILED -0x2A80 /**< Allocation of memory failed. */
69#define POLARSSL_ERR_X509_FILE_IO_ERROR -0x2B00 /**< Read/write of file failed. */
Paul Bakker28144de2013-06-24 19:28:55 +020070#define POLARSSL_ERR_X509_PASSWORD_REQUIRED -0x2B80 /**< Private key password can't be empty. */
71#define POLARSSL_ERR_X509_PASSWORD_MISMATCH -0x2C00 /**< Given private key password does not allow for correct decryption. */
Paul Bakker0f5f72e2011-01-18 14:58:55 +000072/* \} name */
Paul Bakker5121ce52009-01-03 21:22:43 +000073
Paul Bakker37ca75d2011-01-06 12:28:03 +000074/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +000075 * \name X509 Verify codes
76 * \{
Paul Bakker37ca75d2011-01-06 12:28:03 +000077 */
Paul Bakkercdf07e92011-01-30 17:05:13 +000078#define BADCERT_EXPIRED 0x01 /**< The certificate validity has expired. */
79#define BADCERT_REVOKED 0x02 /**< The certificate has been revoked (is on a CRL). */
80#define BADCERT_CN_MISMATCH 0x04 /**< The certificate Common Name (CN) does not match with the expected CN. */
81#define BADCERT_NOT_TRUSTED 0x08 /**< The certificate is not correctly signed by the trusted CA. */
82#define BADCRL_NOT_TRUSTED 0x10 /**< CRL is not correctly signed by the trusted CA. */
83#define BADCRL_EXPIRED 0x20 /**< CRL is expired. */
84#define BADCERT_MISSING 0x40 /**< Certificate was missing. */
85#define BADCERT_SKIP_VERIFY 0x80 /**< Certificate verification was skipped. */
Paul Bakker915275b2012-09-28 07:10:55 +000086#define BADCERT_OTHER 0x0100 /**< Other reason (can be used by verify callback) */
Paul Bakker0f5f72e2011-01-18 14:58:55 +000087/* \} name */
Paul Bakker0f5f72e2011-01-18 14:58:55 +000088/* \} addtogroup x509_module */
Paul Bakker5121ce52009-01-03 21:22:43 +000089
90/*
Paul Bakker74111d32011-01-15 16:57:55 +000091 * X.509 v3 Key Usage Extension flags
92 */
93#define KU_DIGITAL_SIGNATURE (0x80) /* bit 0 */
94#define KU_NON_REPUDIATION (0x40) /* bit 1 */
95#define KU_KEY_ENCIPHERMENT (0x20) /* bit 2 */
96#define KU_DATA_ENCIPHERMENT (0x10) /* bit 3 */
97#define KU_KEY_AGREEMENT (0x08) /* bit 4 */
98#define KU_KEY_CERT_SIGN (0x04) /* bit 5 */
99#define KU_CRL_SIGN (0x02) /* bit 6 */
100
101/*
Paul Bakker74111d32011-01-15 16:57:55 +0000102 * Netscape certificate types
103 * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html)
104 */
105
106#define NS_CERT_TYPE_SSL_CLIENT (0x80) /* bit 0 */
107#define NS_CERT_TYPE_SSL_SERVER (0x40) /* bit 1 */
108#define NS_CERT_TYPE_EMAIL (0x20) /* bit 2 */
109#define NS_CERT_TYPE_OBJECT_SIGNING (0x10) /* bit 3 */
110#define NS_CERT_TYPE_RESERVED (0x08) /* bit 4 */
111#define NS_CERT_TYPE_SSL_CA (0x04) /* bit 5 */
112#define NS_CERT_TYPE_EMAIL_CA (0x02) /* bit 6 */
113#define NS_CERT_TYPE_OBJECT_SIGNING_CA (0x01) /* bit 7 */
114
Paul Bakkerc70b9822013-04-07 22:00:46 +0200115/*
116 * X.509 extension types
117 */
Paul Bakker74111d32011-01-15 16:57:55 +0000118#define EXT_AUTHORITY_KEY_IDENTIFIER (1 << 0)
119#define EXT_SUBJECT_KEY_IDENTIFIER (1 << 1)
120#define EXT_KEY_USAGE (1 << 2)
121#define EXT_CERTIFICATE_POLICIES (1 << 3)
122#define EXT_POLICY_MAPPINGS (1 << 4)
123#define EXT_SUBJECT_ALT_NAME (1 << 5)
124#define EXT_ISSUER_ALT_NAME (1 << 6)
125#define EXT_SUBJECT_DIRECTORY_ATTRS (1 << 7)
126#define EXT_BASIC_CONSTRAINTS (1 << 8)
127#define EXT_NAME_CONSTRAINTS (1 << 9)
128#define EXT_POLICY_CONSTRAINTS (1 << 10)
129#define EXT_EXTENDED_KEY_USAGE (1 << 11)
130#define EXT_CRL_DISTRIBUTION_POINTS (1 << 12)
131#define EXT_INIHIBIT_ANYPOLICY (1 << 13)
132#define EXT_FRESHEST_CRL (1 << 14)
133
134#define EXT_NS_CERT_TYPE (1 << 16)
Paul Bakker5121ce52009-01-03 21:22:43 +0000135
Paul Bakker6c0ceb32011-12-04 12:24:18 +0000136/*
137 * Storage format identifiers
138 * Recognized formats: PEM and DER
139 */
140#define X509_FORMAT_DER 1
141#define X509_FORMAT_PEM 2
142
Paul Bakker407a0da2013-06-27 14:29:21 +0200143#ifdef __cplusplus
144extern "C" {
145#endif
146
Paul Bakker37ca75d2011-01-06 12:28:03 +0000147/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000148 * \addtogroup x509_module
149 * \{ */
Paul Bakker37ca75d2011-01-06 12:28:03 +0000150
151/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000152 * \name Structures for parsing X.509 certificates and CRLs
153 * \{
Paul Bakker37ca75d2011-01-06 12:28:03 +0000154 */
155
156/**
157 * Type-length-value structure that allows for ASN1 using DER.
Paul Bakker5121ce52009-01-03 21:22:43 +0000158 */
Paul Bakkerefc30292011-11-10 14:43:23 +0000159typedef asn1_buf x509_buf;
Paul Bakker5121ce52009-01-03 21:22:43 +0000160
Paul Bakker37ca75d2011-01-06 12:28:03 +0000161/**
Paul Bakker74111d32011-01-15 16:57:55 +0000162 * Container for ASN1 bit strings.
163 */
Paul Bakkerefc30292011-11-10 14:43:23 +0000164typedef asn1_bitstring x509_bitstring;
Paul Bakker74111d32011-01-15 16:57:55 +0000165
166/**
Paul Bakker37ca75d2011-01-06 12:28:03 +0000167 * Container for ASN1 named information objects.
168 * It allows for Relative Distinguished Names (e.g. cn=polarssl,ou=code,etc.).
169 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000170typedef struct _x509_name
171{
Paul Bakker37ca75d2011-01-06 12:28:03 +0000172 x509_buf oid; /**< The object identifier. */
173 x509_buf val; /**< The named value. */
174 struct _x509_name *next; /**< The next named information object. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000175}
176x509_name;
177
Paul Bakker74111d32011-01-15 16:57:55 +0000178/**
179 * Container for a sequence of ASN.1 items
180 */
Paul Bakkerefc30292011-11-10 14:43:23 +0000181typedef asn1_sequence x509_sequence;
Paul Bakker74111d32011-01-15 16:57:55 +0000182
Paul Bakker37ca75d2011-01-06 12:28:03 +0000183/** Container for date and time (precision in seconds). */
Paul Bakker5121ce52009-01-03 21:22:43 +0000184typedef struct _x509_time
185{
Paul Bakker37ca75d2011-01-06 12:28:03 +0000186 int year, mon, day; /**< Date. */
187 int hour, min, sec; /**< Time. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000188}
189x509_time;
190
Paul Bakker37ca75d2011-01-06 12:28:03 +0000191/**
192 * Container for an X.509 certificate. The certificate may be chained.
193 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000194typedef struct _x509_cert
195{
Paul Bakker37ca75d2011-01-06 12:28:03 +0000196 x509_buf raw; /**< The raw certificate data (DER). */
197 x509_buf tbs; /**< The raw certificate body (DER). The part that is To Be Signed. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000198
Paul Bakker37ca75d2011-01-06 12:28:03 +0000199 int version; /**< The X.509 version. (0=v1, 1=v2, 2=v3) */
200 x509_buf serial; /**< Unique id for certificate issued by a specific CA. */
201 x509_buf sig_oid1; /**< Signature algorithm, e.g. sha1RSA */
Paul Bakker5121ce52009-01-03 21:22:43 +0000202
Paul Bakker37ca75d2011-01-06 12:28:03 +0000203 x509_buf issuer_raw; /**< The raw issuer data (DER). Used for quick comparison. */
204 x509_buf subject_raw; /**< The raw subject data (DER). Used for quick comparison. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000205
Paul Bakker37ca75d2011-01-06 12:28:03 +0000206 x509_name issuer; /**< The parsed issuer data (named information object). */
207 x509_name subject; /**< The parsed subject data (named information object). */
Paul Bakker5121ce52009-01-03 21:22:43 +0000208
Paul Bakker37ca75d2011-01-06 12:28:03 +0000209 x509_time valid_from; /**< Start time of certificate validity. */
210 x509_time valid_to; /**< End time of certificate validity. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000211
Paul Bakker37ca75d2011-01-06 12:28:03 +0000212 x509_buf pk_oid; /**< Subject public key info. Includes the public key algorithm and the key itself. */
213 rsa_context rsa; /**< Container for the RSA context. Only RSA is supported for public keys at this time. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000214
Paul Bakker37ca75d2011-01-06 12:28:03 +0000215 x509_buf issuer_id; /**< Optional X.509 v2/v3 issuer unique identifier. */
216 x509_buf subject_id; /**< Optional X.509 v2/v3 subject unique identifier. */
217 x509_buf v3_ext; /**< Optional X.509 v3 extensions. Only Basic Contraints are supported at this time. */
Paul Bakkera8cd2392012-02-11 16:09:32 +0000218 x509_sequence subject_alt_names; /**< Optional list of Subject Alternative Names (Only dNSName supported). */
Paul Bakker5121ce52009-01-03 21:22:43 +0000219
Paul Bakker74111d32011-01-15 16:57:55 +0000220 int ext_types; /**< Bit string containing detected and parsed extensions */
Paul Bakker37ca75d2011-01-06 12:28:03 +0000221 int ca_istrue; /**< Optional Basic Constraint extension value: 1 if this certificate belongs to a CA, 0 otherwise. */
Paul Bakker915275b2012-09-28 07:10:55 +0000222 int max_pathlen; /**< Optional Basic Constraint extension value: The maximum path length to the root certificate. Path length is 1 higher than RFC 5280 'meaning', so 1+ */
Paul Bakker5121ce52009-01-03 21:22:43 +0000223
Paul Bakker74111d32011-01-15 16:57:55 +0000224 unsigned char key_usage; /**< Optional key usage extension value: See the values below */
225
226 x509_sequence ext_key_usage; /**< Optional list of extended key usage OIDs. */
227
228 unsigned char ns_cert_type; /**< Optional Netscape certificate type extension value: See the values below */
229
Paul Bakker37ca75d2011-01-06 12:28:03 +0000230 x509_buf sig_oid2; /**< Signature algorithm. Must match sig_oid1. */
231 x509_buf sig; /**< Signature: hash of the tbs part signed with the private key. */
Paul Bakkerc70b9822013-04-07 22:00:46 +0200232 md_type_t sig_md; /**< Internal representation of the MD algorithm of the signature algorithm, e.g. POLARSSL_MD_SHA256 */
233 pk_type_t sig_pk /**< Internal representation of the Public Key algorithm of the signature algorithm, e.g. POLARSSL_PK_RSA */;
Paul Bakker5121ce52009-01-03 21:22:43 +0000234
Paul Bakker37ca75d2011-01-06 12:28:03 +0000235 struct _x509_cert *next; /**< Next certificate in the CA-chain. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000236}
237x509_cert;
238
Paul Bakker37ca75d2011-01-06 12:28:03 +0000239/**
240 * Certificate revocation list entry.
241 * Contains the CA-specific serial numbers and revocation dates.
242 */
Paul Bakkerd98030e2009-05-02 15:13:40 +0000243typedef struct _x509_crl_entry
244{
245 x509_buf raw;
246
247 x509_buf serial;
248
249 x509_time revocation_date;
250
251 x509_buf entry_ext;
252
253 struct _x509_crl_entry *next;
254}
255x509_crl_entry;
256
Paul Bakker37ca75d2011-01-06 12:28:03 +0000257/**
258 * Certificate revocation list structure.
259 * Every CRL may have multiple entries.
260 */
Paul Bakkerd98030e2009-05-02 15:13:40 +0000261typedef struct _x509_crl
262{
Paul Bakker37ca75d2011-01-06 12:28:03 +0000263 x509_buf raw; /**< The raw certificate data (DER). */
264 x509_buf tbs; /**< The raw certificate body (DER). The part that is To Be Signed. */
Paul Bakkerd98030e2009-05-02 15:13:40 +0000265
266 int version;
267 x509_buf sig_oid1;
268
Paul Bakker37ca75d2011-01-06 12:28:03 +0000269 x509_buf issuer_raw; /**< The raw issuer data (DER). */
Paul Bakkerd98030e2009-05-02 15:13:40 +0000270
Paul Bakker37ca75d2011-01-06 12:28:03 +0000271 x509_name issuer; /**< The parsed issuer data (named information object). */
Paul Bakkerd98030e2009-05-02 15:13:40 +0000272
Paul Bakker37ca75d2011-01-06 12:28:03 +0000273 x509_time this_update;
Paul Bakkerd98030e2009-05-02 15:13:40 +0000274 x509_time next_update;
275
Paul Bakker37ca75d2011-01-06 12:28:03 +0000276 x509_crl_entry entry; /**< The CRL entries containing the certificate revocation times for this CA. */
Paul Bakkerd98030e2009-05-02 15:13:40 +0000277
278 x509_buf crl_ext;
279
280 x509_buf sig_oid2;
281 x509_buf sig;
Paul Bakkerc70b9822013-04-07 22:00:46 +0200282 md_type_t sig_md; /**< Internal representation of the MD algorithm of the signature algorithm, e.g. POLARSSL_MD_SHA256 */
283 pk_type_t sig_pk /**< Internal representation of the Public Key algorithm of the signature algorithm, e.g. POLARSSL_PK_RSA */;
Paul Bakkerd98030e2009-05-02 15:13:40 +0000284
285 struct _x509_crl *next;
286}
287x509_crl;
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000288/** \} name Structures for parsing X.509 certificates and CRLs */
289/** \} addtogroup x509_module */
Paul Bakkerd98030e2009-05-02 15:13:40 +0000290
Paul Bakker37ca75d2011-01-06 12:28:03 +0000291/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000292 * \name Structures for writing X.509 certificates.
Paul Bakker37ca75d2011-01-06 12:28:03 +0000293 * XvP: commented out as they are not used.
294 * - <tt>typedef struct _x509_node x509_node;</tt>
295 * - <tt>typedef struct _x509_raw x509_raw;</tt>
Paul Bakker5121ce52009-01-03 21:22:43 +0000296 */
Paul Bakker37ca75d2011-01-06 12:28:03 +0000297/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000298typedef struct _x509_node
299{
300 unsigned char *data;
301 unsigned char *p;
302 unsigned char *end;
303
304 size_t len;
305}
306x509_node;
307
308typedef struct _x509_raw
309{
310 x509_node raw;
311 x509_node tbs;
312
313 x509_node version;
314 x509_node serial;
315 x509_node tbs_signalg;
316 x509_node issuer;
317 x509_node validity;
318 x509_node subject;
319 x509_node subpubkey;
320
321 x509_node signalg;
322 x509_node sign;
323}
324x509_raw;
Paul Bakker37ca75d2011-01-06 12:28:03 +0000325*/
Paul Bakker5121ce52009-01-03 21:22:43 +0000326
Paul Bakker5121ce52009-01-03 21:22:43 +0000327/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000328 * \name Functions to read in DHM parameters, a certificate, CRL or private RSA key
329 * \{
Paul Bakker37ca75d2011-01-06 12:28:03 +0000330 */
331
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000332/** \ingroup x509_module */
Paul Bakker37ca75d2011-01-06 12:28:03 +0000333/**
Paul Bakker89ecb2d2013-06-24 19:06:15 +0200334 * \brief Parse a single DER formatted certificate and add it
335 * to the chained list.
336 *
337 * \param chain points to the start of the chain
338 * \param buf buffer holding the certificate DER data
339 * \param buflen size of the buffer
340 *
341 * \return 0 if successful, or a specific X509 or PEM error code
342 */
343int x509parse_crt_der( x509_cert *chain, const unsigned char *buf, size_t buflen );
344
345/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000346 * \brief Parse one or more certificates and add them
Paul Bakker69e095c2011-12-10 21:55:01 +0000347 * to the chained list. Parses permissively. If some
348 * certificates can be parsed, the result is the number
349 * of failed certificates it encountered. If none complete
350 * correctly, the first error is returned.
Paul Bakker5121ce52009-01-03 21:22:43 +0000351 *
352 * \param chain points to the start of the chain
353 * \param buf buffer holding the certificate data
354 * \param buflen size of the buffer
355 *
Paul Bakker69e095c2011-12-10 21:55:01 +0000356 * \return 0 if all certificates parsed successfully, a positive number
357 * if partly successful or a specific X509 or PEM error code
Paul Bakker5121ce52009-01-03 21:22:43 +0000358 */
Paul Bakker69e095c2011-12-10 21:55:01 +0000359int x509parse_crt( x509_cert *chain, const unsigned char *buf, size_t buflen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000360
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000361/** \ingroup x509_module */
Paul Bakker5121ce52009-01-03 21:22:43 +0000362/**
363 * \brief Load one or more certificates and add them
Paul Bakker69e095c2011-12-10 21:55:01 +0000364 * to the chained list. Parses permissively. If some
365 * certificates can be parsed, the result is the number
366 * of failed certificates it encountered. If none complete
367 * correctly, the first error is returned.
Paul Bakker5121ce52009-01-03 21:22:43 +0000368 *
369 * \param chain points to the start of the chain
370 * \param path filename to read the certificates from
371 *
Paul Bakker69e095c2011-12-10 21:55:01 +0000372 * \return 0 if all certificates parsed successfully, a positive number
373 * if partly successful or a specific X509 or PEM error code
Paul Bakker5121ce52009-01-03 21:22:43 +0000374 */
Paul Bakker69e095c2011-12-10 21:55:01 +0000375int x509parse_crtfile( x509_cert *chain, const char *path );
Paul Bakker5121ce52009-01-03 21:22:43 +0000376
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000377/** \ingroup x509_module */
Paul Bakker5121ce52009-01-03 21:22:43 +0000378/**
Paul Bakker8d914582012-06-04 12:46:42 +0000379 * \brief Load one or more certificate files from a path and add them
380 * to the chained list. Parses permissively. If some
381 * certificates can be parsed, the result is the number
382 * of failed certificates it encountered. If none complete
383 * correctly, the first error is returned.
384 *
385 * \param chain points to the start of the chain
386 * \param path directory / folder to read the certificate files from
387 *
388 * \return 0 if all certificates parsed successfully, a positive number
389 * if partly successful or a specific X509 or PEM error code
390 */
391int x509parse_crtpath( x509_cert *chain, const char *path );
392
393/** \ingroup x509_module */
394/**
Paul Bakkerd98030e2009-05-02 15:13:40 +0000395 * \brief Parse one or more CRLs and add them
396 * to the chained list
397 *
398 * \param chain points to the start of the chain
399 * \param buf buffer holding the CRL data
400 * \param buflen size of the buffer
401 *
Paul Bakker96743fc2011-02-12 14:30:57 +0000402 * \return 0 if successful, or a specific X509 or PEM error code
Paul Bakkerd98030e2009-05-02 15:13:40 +0000403 */
Paul Bakker23986e52011-04-24 08:57:21 +0000404int x509parse_crl( x509_crl *chain, const unsigned char *buf, size_t buflen );
Paul Bakkerd98030e2009-05-02 15:13:40 +0000405
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000406/** \ingroup x509_module */
Paul Bakkerd98030e2009-05-02 15:13:40 +0000407/**
408 * \brief Load one or more CRLs and add them
409 * to the chained list
410 *
411 * \param chain points to the start of the chain
412 * \param path filename to read the CRLs from
413 *
Paul Bakker96743fc2011-02-12 14:30:57 +0000414 * \return 0 if successful, or a specific X509 or PEM error code
Paul Bakkerd98030e2009-05-02 15:13:40 +0000415 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000416int x509parse_crlfile( x509_crl *chain, const char *path );
Paul Bakkerd98030e2009-05-02 15:13:40 +0000417
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000418/** \ingroup x509_module */
Paul Bakkerd98030e2009-05-02 15:13:40 +0000419/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000420 * \brief Parse a private RSA key
421 *
422 * \param rsa RSA context to be initialized
Paul Bakkerff60ee62010-03-16 21:09:09 +0000423 * \param key input buffer
424 * \param keylen size of the buffer
Paul Bakker5121ce52009-01-03 21:22:43 +0000425 * \param pwd password for decryption (optional)
426 * \param pwdlen size of the password
427 *
Paul Bakker96743fc2011-02-12 14:30:57 +0000428 * \return 0 if successful, or a specific X509 or PEM error code
Paul Bakker5121ce52009-01-03 21:22:43 +0000429 */
Manuel Pégourié-Gonnardba4878a2013-06-27 10:51:01 +0200430int x509parse_key_rsa( rsa_context *rsa,
431 const unsigned char *key, size_t keylen,
432 const unsigned char *pwd, size_t pwdlen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000433
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000434/** \ingroup x509_module */
Paul Bakker5121ce52009-01-03 21:22:43 +0000435/**
436 * \brief Load and parse a private RSA key
437 *
438 * \param rsa RSA context to be initialized
439 * \param path filename to read the private key from
Paul Bakker37ca75d2011-01-06 12:28:03 +0000440 * \param password password to decrypt the file (can be NULL)
Paul Bakker5121ce52009-01-03 21:22:43 +0000441 *
Paul Bakker96743fc2011-02-12 14:30:57 +0000442 * \return 0 if successful, or a specific X509 or PEM error code
Paul Bakker5121ce52009-01-03 21:22:43 +0000443 */
Manuel Pégourié-Gonnardba4878a2013-06-27 10:51:01 +0200444int x509parse_keyfile_rsa( rsa_context *rsa, const char *path,
445 const char *password );
Paul Bakker1b57b062011-01-06 15:48:19 +0000446
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000447/** \ingroup x509_module */
Paul Bakker1b57b062011-01-06 15:48:19 +0000448/**
Paul Bakker917e7542011-03-25 14:23:36 +0000449 * \brief Parse a public RSA key
450 *
451 * \param rsa RSA context to be initialized
452 * \param key input buffer
453 * \param keylen size of the buffer
454 *
455 * \return 0 if successful, or a specific X509 or PEM error code
456 */
Manuel Pégourié-Gonnardba4878a2013-06-27 10:51:01 +0200457int x509parse_public_key_rsa( rsa_context *rsa,
458 const unsigned char *key, size_t keylen );
Paul Bakker917e7542011-03-25 14:23:36 +0000459
460/** \ingroup x509_module */
461/**
462 * \brief Load and parse a public RSA key
463 *
464 * \param rsa RSA context to be initialized
465 * \param path filename to read the private key from
466 *
467 * \return 0 if successful, or a specific X509 or PEM error code
468 */
Manuel Pégourié-Gonnardba4878a2013-06-27 10:51:01 +0200469int x509parse_public_keyfile_rsa( rsa_context *rsa, const char *path );
Paul Bakker917e7542011-03-25 14:23:36 +0000470
471/** \ingroup x509_module */
472/**
Paul Bakker1b57b062011-01-06 15:48:19 +0000473 * \brief Parse DHM parameters
474 *
475 * \param dhm DHM context to be initialized
476 * \param dhmin input buffer
477 * \param dhminlen size of the buffer
478 *
Paul Bakker96743fc2011-02-12 14:30:57 +0000479 * \return 0 if successful, or a specific X509 or PEM error code
Paul Bakker1b57b062011-01-06 15:48:19 +0000480 */
Paul Bakker23986e52011-04-24 08:57:21 +0000481int x509parse_dhm( dhm_context *dhm, const unsigned char *dhmin, size_t dhminlen );
Paul Bakker1b57b062011-01-06 15:48:19 +0000482
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000483/** \ingroup x509_module */
Paul Bakker1b57b062011-01-06 15:48:19 +0000484/**
485 * \brief Load and parse DHM parameters
486 *
487 * \param dhm DHM context to be initialized
488 * \param path filename to read the DHM Parameters from
489 *
Paul Bakker96743fc2011-02-12 14:30:57 +0000490 * \return 0 if successful, or a specific X509 or PEM error code
Paul Bakker1b57b062011-01-06 15:48:19 +0000491 */
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000492int x509parse_dhmfile( dhm_context *dhm, const char *path );
Paul Bakker1b57b062011-01-06 15:48:19 +0000493
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000494/** \} name Functions to read in DHM parameters, a certificate, CRL or private RSA key */
Paul Bakker37ca75d2011-01-06 12:28:03 +0000495
Paul Bakker5121ce52009-01-03 21:22:43 +0000496/**
497 * \brief Store the certificate DN in printable form into buf;
Paul Bakkerd98030e2009-05-02 15:13:40 +0000498 * no more than size characters will be written.
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000499 *
500 * \param buf Buffer to write to
501 * \param size Maximum size of buffer
502 * \param dn The X509 name to represent
503 *
504 * \return The amount of data written to the buffer, or -1 in
505 * case of an error.
Paul Bakker5121ce52009-01-03 21:22:43 +0000506 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000507int x509parse_dn_gets( char *buf, size_t size, const x509_name *dn );
Paul Bakker5121ce52009-01-03 21:22:43 +0000508
509/**
Paul Bakkerdd476992011-01-16 21:34:59 +0000510 * \brief Store the certificate serial in printable form into buf;
511 * no more than size characters will be written.
512 *
513 * \param buf Buffer to write to
514 * \param size Maximum size of buffer
515 * \param serial The X509 serial to represent
516 *
517 * \return The amount of data written to the buffer, or -1 in
518 * case of an error.
519 */
520int x509parse_serial_gets( char *buf, size_t size, const x509_buf *serial );
521
522/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000523 * \brief Returns an informational string about the
524 * certificate.
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000525 *
526 * \param buf Buffer to write to
527 * \param size Maximum size of buffer
528 * \param prefix A line prefix
529 * \param crt The X509 certificate to represent
530 *
531 * \return The amount of data written to the buffer, or -1 in
532 * case of an error.
Paul Bakker5121ce52009-01-03 21:22:43 +0000533 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000534int x509parse_cert_info( char *buf, size_t size, const char *prefix,
535 const x509_cert *crt );
Paul Bakkerd98030e2009-05-02 15:13:40 +0000536
537/**
538 * \brief Returns an informational string about the
539 * CRL.
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000540 *
541 * \param buf Buffer to write to
542 * \param size Maximum size of buffer
543 * \param prefix A line prefix
Paul Bakker37ca75d2011-01-06 12:28:03 +0000544 * \param crl The X509 CRL to represent
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000545 *
546 * \return The amount of data written to the buffer, or -1 in
547 * case of an error.
Paul Bakkerd98030e2009-05-02 15:13:40 +0000548 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000549int x509parse_crl_info( char *buf, size_t size, const char *prefix,
550 const x509_crl *crl );
Paul Bakker5121ce52009-01-03 21:22:43 +0000551
552/**
Paul Bakker74111d32011-01-15 16:57:55 +0000553 * \brief Give an known OID, return its descriptive string.
554 *
555 * \param oid buffer containing the oid
556 *
557 * \return Return a string if the OID is known,
558 * or NULL otherwise.
559 */
560const char *x509_oid_get_description( x509_buf *oid );
561
Paul Bakker9a736322012-11-14 12:39:52 +0000562/**
Paul Bakker74111d32011-01-15 16:57:55 +0000563 * \brief Give an OID, return a string version of its OID number.
Paul Bakkerd5c2b542013-04-07 22:34:26 +0200564 * (Deprecated. Use oid_get_numeric_string() instead)
Paul Bakker74111d32011-01-15 16:57:55 +0000565 *
566 * \param buf Buffer to write to
567 * \param size Maximum size of buffer
568 * \param oid Buffer containing the OID
569 *
570 * \return The amount of data written to the buffer, or -1 in
571 * case of an error.
572 */
573int x509_oid_get_numeric_string( char *buf, size_t size, x509_buf *oid );
574
575/**
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000576 * \brief Check a given x509_time against the system time and check
577 * if it is valid.
578 *
579 * \param time x509_time to check
580 *
581 * \return Return 0 if the x509_time is still valid,
Paul Bakker40ea7de2009-05-03 10:18:48 +0000582 * or 1 otherwise.
Paul Bakker5121ce52009-01-03 21:22:43 +0000583 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000584int x509parse_time_expired( const x509_time *time );
Paul Bakker5121ce52009-01-03 21:22:43 +0000585
586/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000587 * \name Functions to verify a certificate
588 * \{
Paul Bakker37ca75d2011-01-06 12:28:03 +0000589 */
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000590/** \ingroup x509_module */
Paul Bakker37ca75d2011-01-06 12:28:03 +0000591/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000592 * \brief Verify the certificate signature
593 *
Paul Bakker915275b2012-09-28 07:10:55 +0000594 * The verify callback is a user-supplied callback that
595 * can clear / modify / add flags for a certificate. If set,
596 * the verification callback is called for each
597 * certificate in the chain (from the trust-ca down to the
598 * presented crt). The parameters for the callback are:
599 * (void *parameter, x509_cert *crt, int certificate_depth,
600 * int *flags). With the flags representing current flags for
601 * that specific certificate and the certificate depth from
Paul Bakker9a736322012-11-14 12:39:52 +0000602 * the bottom (Peer cert depth = 0).
Paul Bakker915275b2012-09-28 07:10:55 +0000603 *
604 * All flags left after returning from the callback
605 * are also returned to the application. The function should
606 * return 0 for anything but a fatal error.
607 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000608 * \param crt a certificate to be verified
609 * \param trust_ca the trusted CA chain
Paul Bakker40ea7de2009-05-03 10:18:48 +0000610 * \param ca_crl the CRL chain for trusted CA's
Paul Bakker5121ce52009-01-03 21:22:43 +0000611 * \param cn expected Common Name (can be set to
612 * NULL if the CN must not be verified)
613 * \param flags result of the verification
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000614 * \param f_vrfy verification function
615 * \param p_vrfy verification parameter
Paul Bakker5121ce52009-01-03 21:22:43 +0000616 *
Paul Bakker40e46942009-01-03 21:51:57 +0000617 * \return 0 if successful or POLARSSL_ERR_X509_SIG_VERIFY_FAILED,
Paul Bakker5121ce52009-01-03 21:22:43 +0000618 * in which case *flags will have one or more of
619 * the following values set:
620 * BADCERT_EXPIRED --
621 * BADCERT_REVOKED --
622 * BADCERT_CN_MISMATCH --
623 * BADCERT_NOT_TRUSTED
Paul Bakker915275b2012-09-28 07:10:55 +0000624 * or another error in case of a fatal error encountered
625 * during the verification process.
Paul Bakker5121ce52009-01-03 21:22:43 +0000626 */
627int x509parse_verify( x509_cert *crt,
628 x509_cert *trust_ca,
Paul Bakker40ea7de2009-05-03 10:18:48 +0000629 x509_crl *ca_crl,
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000630 const char *cn, int *flags,
Paul Bakker915275b2012-09-28 07:10:55 +0000631 int (*f_vrfy)(void *, x509_cert *, int, int *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000632 void *p_vrfy );
Paul Bakker5121ce52009-01-03 21:22:43 +0000633
Paul Bakker74111d32011-01-15 16:57:55 +0000634/**
635 * \brief Verify the certificate signature
636 *
637 * \param crt a certificate to be verified
638 * \param crl the CRL to verify against
639 *
640 * \return 1 if the certificate is revoked, 0 otherwise
641 *
642 */
643int x509parse_revoked( const x509_cert *crt, const x509_crl *crl );
644
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000645/** \} name Functions to verify a certificate */
Paul Bakker37ca75d2011-01-06 12:28:03 +0000646
647
648
649/**
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000650 * \name Functions to clear a certificate, CRL or private RSA key
651 * \{
Paul Bakker37ca75d2011-01-06 12:28:03 +0000652 */
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000653/** \ingroup x509_module */
Paul Bakker5121ce52009-01-03 21:22:43 +0000654/**
655 * \brief Unallocate all certificate data
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000656 *
657 * \param crt Certificate chain to free
Paul Bakker5121ce52009-01-03 21:22:43 +0000658 */
659void x509_free( x509_cert *crt );
660
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000661/** \ingroup x509_module */
Paul Bakker5121ce52009-01-03 21:22:43 +0000662/**
Paul Bakkerd98030e2009-05-02 15:13:40 +0000663 * \brief Unallocate all CRL data
Paul Bakker13e2dfe2009-07-28 07:18:38 +0000664 *
Paul Bakker37ca75d2011-01-06 12:28:03 +0000665 * \param crl CRL chain to free
Paul Bakkerd98030e2009-05-02 15:13:40 +0000666 */
667void x509_crl_free( x509_crl *crl );
668
Paul Bakker0f5f72e2011-01-18 14:58:55 +0000669/** \} name Functions to clear a certificate, CRL or private RSA key */
Paul Bakker37ca75d2011-01-06 12:28:03 +0000670
671
Paul Bakkerd98030e2009-05-02 15:13:40 +0000672/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000673 * \brief Checkup routine
674 *
675 * \return 0 if successful, or 1 if the test failed
676 */
677int x509_self_test( int verbose );
678
679#ifdef __cplusplus
680}
681#endif
682
Paul Bakkered27a042013-04-18 22:46:23 +0200683#endif /* POLARSSL_X509_PARSE_C || POLARSSL_X509_WRITE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +0000684#endif /* x509.h */