blob: 06166d8b1868183e1f819f06669c29b1994dada7 [file] [log] [blame]
Paul Bakker7c6b2c32013-09-16 13:49:26 +02001/**
Simon Butcher5b331b92016-01-03 16:14:14 +00002 * \file x509_crt.h
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003 *
4 * \brief X.509 certificate parsing and writing
5 *
Manuel Pégourié-Gonnard6fb81872015-07-27 11:11:48 +02006 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02007 * SPDX-License-Identifier: Apache-2.0
8 *
9 * Licensed under the Apache License, Version 2.0 (the "License"); you may
10 * not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
12 *
13 * http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
17 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
Paul Bakker7c6b2c32013-09-16 13:49:26 +020020 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000021 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakker7c6b2c32013-09-16 13:49:26 +020022 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020023#ifndef MBEDTLS_X509_CRT_H
24#define MBEDTLS_X509_CRT_H
Paul Bakker7c6b2c32013-09-16 13:49:26 +020025
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if !defined(MBEDTLS_CONFIG_FILE)
Paul Bakker7c6b2c32013-09-16 13:49:26 +020027#include "config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020028#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020029#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020030#endif
Paul Bakker7c6b2c32013-09-16 13:49:26 +020031
32#include "x509.h"
Paul Bakker7c6b2c32013-09-16 13:49:26 +020033#include "x509_crl.h"
Paul Bakker7c6b2c32013-09-16 13:49:26 +020034
35/**
36 * \addtogroup x509_module
37 * \{
38 */
39
40#ifdef __cplusplus
41extern "C" {
42#endif
43
44/**
45 * \name Structures and functions for parsing and writing X.509 certificates
46 * \{
47 */
48
49/**
50 * Container for an X.509 certificate. The certificate may be chained.
51 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020052typedef struct mbedtls_x509_crt
Paul Bakker7c6b2c32013-09-16 13:49:26 +020053{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020054 mbedtls_x509_buf raw; /**< The raw certificate data (DER). */
55 mbedtls_x509_buf tbs; /**< The raw certificate body (DER). The part that is To Be Signed. */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020056
Manuel Pégourié-Gonnardf4e1b642014-06-19 11:39:46 +020057 int version; /**< The X.509 version. (1=v1, 2=v2, 3=v3) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020058 mbedtls_x509_buf serial; /**< Unique id for certificate issued by a specific CA. */
59 mbedtls_x509_buf sig_oid; /**< Signature algorithm, e.g. sha1RSA */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020060
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020061 mbedtls_x509_buf issuer_raw; /**< The raw issuer data (DER). Used for quick comparison. */
62 mbedtls_x509_buf subject_raw; /**< The raw subject data (DER). Used for quick comparison. */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020063
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020064 mbedtls_x509_name issuer; /**< The parsed issuer data (named information object). */
65 mbedtls_x509_name subject; /**< The parsed subject data (named information object). */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020066
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020067 mbedtls_x509_time valid_from; /**< Start time of certificate validity. */
68 mbedtls_x509_time valid_to; /**< End time of certificate validity. */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020069
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020070 mbedtls_pk_context pk; /**< Container for the public key context. */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020071
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020072 mbedtls_x509_buf issuer_id; /**< Optional X.509 v2/v3 issuer unique identifier. */
73 mbedtls_x509_buf subject_id; /**< Optional X.509 v2/v3 subject unique identifier. */
74 mbedtls_x509_buf v3_ext; /**< Optional X.509 v3 extensions. */
75 mbedtls_x509_sequence subject_alt_names; /**< Optional list of Subject Alternative Names (Only dNSName supported). */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020076
77 int ext_types; /**< Bit string containing detected and parsed extensions */
78 int ca_istrue; /**< Optional Basic Constraint extension value: 1 if this certificate belongs to a CA, 0 otherwise. */
79 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+ */
80
Manuel Pégourié-Gonnard1d0ca1a2015-03-27 16:50:00 +010081 unsigned int key_usage; /**< Optional key usage extension value: See the values in x509.h */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020082
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020083 mbedtls_x509_sequence ext_key_usage; /**< Optional list of extended key usage OIDs. */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020084
Manuel Pégourié-Gonnardb28487d2014-04-01 12:19:09 +020085 unsigned char ns_cert_type; /**< Optional Netscape certificate type extension value: See the values in x509.h */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020086
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020087 mbedtls_x509_buf sig; /**< Signature: hash of the tbs part signed with the private key. */
88 mbedtls_md_type_t sig_md; /**< Internal representation of the MD algorithm of the signature algorithm, e.g. MBEDTLS_MD_SHA256 */
89 mbedtls_pk_type_t sig_pk; /**< Internal representation of the Public Key algorithm of the signature algorithm, e.g. MBEDTLS_PK_RSA */
90 void *sig_opts; /**< Signature options to be passed to mbedtls_pk_verify_ext(), e.g. for RSASSA-PSS */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020091
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020092 struct mbedtls_x509_crt *next; /**< Next certificate in the CA-chain. */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020093}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020094mbedtls_x509_crt;
Paul Bakker7c6b2c32013-09-16 13:49:26 +020095
Manuel Pégourié-Gonnard88db5da2015-06-15 14:34:59 +020096/**
Manuel Pégourié-Gonnardf8ea8562015-06-15 15:33:19 +020097 * Build flag from an algorithm/curve identifier (pk, md, ecp)
98 * Since 0 is always XXX_NONE, ignore it.
99 */
100#define MBEDTLS_X509_ID_FLAG( id ) ( 1 << ( id - 1 ) )
101
102/**
Manuel Pégourié-Gonnard88db5da2015-06-15 14:34:59 +0200103 * Security profile for certificate verification.
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200104 *
Manuel Pégourié-Gonnardf8ea8562015-06-15 15:33:19 +0200105 * All lists are bitfields, built by ORing flags from MBEDTLS_X509_ID_FLAG().
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200106 */
107typedef struct
108{
Manuel Pégourié-Gonnardf8ea8562015-06-15 15:33:19 +0200109 uint32_t allowed_mds; /**< MDs for signatures */
110 uint32_t allowed_pks; /**< PK algs for signatures */
111 uint32_t allowed_curves; /**< Elliptic curves for ECDSA */
112 uint32_t rsa_min_bitlen; /**< Minimum size for RSA keys */
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200113}
114mbedtls_x509_crt_profile;
115
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200116#define MBEDTLS_X509_CRT_VERSION_1 0
117#define MBEDTLS_X509_CRT_VERSION_2 1
118#define MBEDTLS_X509_CRT_VERSION_3 2
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200119
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200120#define MBEDTLS_X509_RFC5280_MAX_SERIAL_LEN 32
121#define MBEDTLS_X509_RFC5280_UTC_TIME_LEN 15
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200122
Andres AGf9113192016-09-02 14:06:04 +0100123#if !defined( MBEDTLS_X509_MAX_FILE_PATH_LEN )
124#define MBEDTLS_X509_MAX_FILE_PATH_LEN 512
125#endif
126
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200127/**
128 * Container for writing a certificate (CRT)
129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200130typedef struct mbedtls_x509write_cert
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200131{
132 int version;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200133 mbedtls_mpi serial;
134 mbedtls_pk_context *subject_key;
135 mbedtls_pk_context *issuer_key;
136 mbedtls_asn1_named_data *subject;
137 mbedtls_asn1_named_data *issuer;
138 mbedtls_md_type_t md_alg;
139 char not_before[MBEDTLS_X509_RFC5280_UTC_TIME_LEN + 1];
140 char not_after[MBEDTLS_X509_RFC5280_UTC_TIME_LEN + 1];
141 mbedtls_asn1_named_data *extensions;
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200142}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200143mbedtls_x509write_cert;
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200144
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200145#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200146/**
Manuel Pégourié-Gonnard88db5da2015-06-15 14:34:59 +0200147 * Default security profile. Should provide a good balance between security
148 * and compatibility with current deployments.
149 */
150extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_default;
151
152/**
153 * Expected next default profile. Recommended for new deployments.
154 * Currently targets a 128-bit security level, except for RSA-2048.
155 */
156extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_next;
157
158/**
159 * NSA Suite B profile.
160 */
161extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_suiteb;
162
163/**
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200164 * \brief Parse a single DER formatted certificate and add it
165 * to the chained list.
166 *
167 * \param chain points to the start of the chain
168 * \param buf buffer holding the certificate DER data
169 * \param buflen size of the buffer
170 *
171 * \return 0 if successful, or a specific X509 or PEM error code
172 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200173int mbedtls_x509_crt_parse_der( mbedtls_x509_crt *chain, const unsigned char *buf,
Paul Bakkerddf26b42013-09-18 13:46:23 +0200174 size_t buflen );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200175
176/**
177 * \brief Parse one or more certificates and add them
178 * to the chained list. Parses permissively. If some
179 * certificates can be parsed, the result is the number
180 * of failed certificates it encountered. If none complete
181 * correctly, the first error is returned.
182 *
183 * \param chain points to the start of the chain
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +0200184 * \param buf buffer holding the certificate data in PEM or DER format
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200185 * \param buflen size of the buffer
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +0200186 * (including the terminating null byte for PEM data)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200187 *
188 * \return 0 if all certificates parsed successfully, a positive number
189 * if partly successful or a specific X509 or PEM error code
190 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200191int mbedtls_x509_crt_parse( mbedtls_x509_crt *chain, const unsigned char *buf, size_t buflen );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200193#if defined(MBEDTLS_FS_IO)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200194/**
195 * \brief Load one or more certificates and add them
196 * to the chained list. Parses permissively. If some
197 * certificates can be parsed, the result is the number
198 * of failed certificates it encountered. If none complete
199 * correctly, the first error is returned.
200 *
201 * \param chain points to the start of the chain
202 * \param path filename to read the certificates from
203 *
204 * \return 0 if all certificates parsed successfully, a positive number
205 * if partly successful or a specific X509 or PEM error code
206 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200207int mbedtls_x509_crt_parse_file( mbedtls_x509_crt *chain, const char *path );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200208
209/**
210 * \brief Load one or more certificate files from a path and add them
211 * to the chained list. Parses permissively. If some
212 * certificates can be parsed, the result is the number
213 * of failed certificates it encountered. If none complete
214 * correctly, the first error is returned.
215 *
216 * \param chain points to the start of the chain
217 * \param path directory / folder to read the certificate files from
218 *
219 * \return 0 if all certificates parsed successfully, a positive number
220 * if partly successful or a specific X509 or PEM error code
221 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200222int mbedtls_x509_crt_parse_path( mbedtls_x509_crt *chain, const char *path );
223#endif /* MBEDTLS_FS_IO */
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200224
225/**
226 * \brief Returns an informational string about the
227 * certificate.
228 *
229 * \param buf Buffer to write to
230 * \param size Maximum size of buffer
231 * \param prefix A line prefix
232 * \param crt The X509 certificate to represent
233 *
Manuel Pégourié-Gonnarde244f9f2015-06-23 12:10:45 +0200234 * \return The length of the string written (not including the
235 * terminated nul byte), or a negative error code.
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200236 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237int mbedtls_x509_crt_info( char *buf, size_t size, const char *prefix,
238 const mbedtls_x509_crt *crt );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200239
240/**
Manuel Pégourié-Gonnardb5f48ad2015-04-20 10:38:13 +0100241 * \brief Returns an informational string about the
242 * verification status of a certificate.
243 *
244 * \param buf Buffer to write to
245 * \param size Maximum size of buffer
246 * \param prefix A line prefix
247 * \param flags Verification flags created by mbedtls_x509_crt_verify()
248 *
Manuel Pégourié-Gonnarde244f9f2015-06-23 12:10:45 +0200249 * \return The length of the string written (not including the
250 * terminated nul byte), or a negative error code.
Manuel Pégourié-Gonnardb5f48ad2015-04-20 10:38:13 +0100251 */
252int mbedtls_x509_crt_verify_info( char *buf, size_t size, const char *prefix,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200253 uint32_t flags );
Manuel Pégourié-Gonnard39a183a2015-04-17 16:14:32 +0200254
255/**
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200256 * \brief Verify the certificate signature
257 *
258 * The verify callback is a user-supplied callback that
259 * can clear / modify / add flags for a certificate. If set,
260 * the verification callback is called for each
261 * certificate in the chain (from the trust-ca down to the
262 * presented crt). The parameters for the callback are:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200263 * (void *parameter, mbedtls_x509_crt *crt, int certificate_depth,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200264 * int *flags). With the flags representing current flags for
265 * that specific certificate and the certificate depth from
266 * the bottom (Peer cert depth = 0).
267 *
268 * All flags left after returning from the callback
269 * are also returned to the application. The function should
Manuel Pégourié-Gonnard31458a12017-06-26 10:11:49 +0200270 * return 0 for anything (including invalid certificates)
271 * other than fatal error, as a non-zero return code
272 * immediately aborts the verification process. For fatal
273 * errors, a specific error code should be used (different
274 * from MBEDTLS_ERR_X509_CERT_VERIFY_FAILED which should not
275 * be returned at this point), or MBEDTLS_ERR_X509_FATAL_ERROR
276 * can be used if no better code is available.
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200277 *
Manuel Pégourié-Gonnardb5f48ad2015-04-20 10:38:13 +0100278 * \note In case verification failed, the results can be displayed
279 * using \c mbedtls_x509_crt_verify_info()
280 *
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200281 * \note Same as \c mbedtls_x509_crt_verify_with_profile() with the
282 * default security profile.
283 *
Manuel Pégourié-Gonnardeeef9472016-02-22 11:36:55 +0100284 * \note It is your responsibility to provide up-to-date CRLs for
285 * all trusted CAs. If no CRL is provided for the CA that was
286 * used to sign the certificate, CRL verification is skipped
287 * silently, that is *without* setting any flag.
288 *
289 * \param crt a certificate (chain) to be verified
290 * \param trust_ca the list of trusted CAs
291 * \param ca_crl the list of CRLs for trusted CAs (see note above)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200292 * \param cn expected Common Name (can be set to
293 * NULL if the CN must not be verified)
294 * \param flags result of the verification
295 * \param f_vrfy verification function
296 * \param p_vrfy verification parameter
297 *
Manuel Pégourié-Gonnard760c9b92017-07-06 15:00:32 +0200298 * \return 0 (and flags set to 0) if the chain was verified and valid,
299 * MBEDTLS_ERR_X509_CERT_VERIFY_FAILED if the chain was verified
300 * but found to be invalid, in which case *flags will have one
301 * or more MBEDTLS_X509_BADCERT_XXX or MBEDTLS_X509_BADCRL_XXX
302 * flags set, or another error (and flags set to 0xffffffff)
303 * in case of a fatal error encountered during the
304 * verification process.
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200305 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200306int mbedtls_x509_crt_verify( mbedtls_x509_crt *crt,
307 mbedtls_x509_crt *trust_ca,
308 mbedtls_x509_crl *ca_crl,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200309 const char *cn, uint32_t *flags,
310 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerddf26b42013-09-18 13:46:23 +0200311 void *p_vrfy );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200312
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200313/**
314 * \brief Verify the certificate signature according to profile
315 *
316 * \note Same as \c mbedtls_x509_crt_verify(), but with explicit
317 * security profile.
318 *
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +0200319 * \note The restrictions on keys (RSA minimum size, allowed curves
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +0200320 * for ECDSA) apply to all certificates: trusted root,
321 * intermediate CAs if any, and end entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +0200322 *
Manuel Pégourié-Gonnardeeef9472016-02-22 11:36:55 +0100323 * \param crt a certificate (chain) to be verified
324 * \param trust_ca the list of trusted CAs
325 * \param ca_crl the list of CRLs for trusted CAs
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200326 * \param profile security profile for verification
327 * \param cn expected Common Name (can be set to
328 * NULL if the CN must not be verified)
329 * \param flags result of the verification
330 * \param f_vrfy verification function
331 * \param p_vrfy verification parameter
332 *
333 * \return 0 if successful or MBEDTLS_ERR_X509_CERT_VERIFY_FAILED
334 * in which case *flags will have one or more
335 * MBEDTLS_X509_BADCERT_XXX or MBEDTLS_X509_BADCRL_XXX flags
336 * set,
337 * or another error in case of a fatal error encountered
338 * during the verification process.
339 */
340int mbedtls_x509_crt_verify_with_profile( mbedtls_x509_crt *crt,
341 mbedtls_x509_crt *trust_ca,
342 mbedtls_x509_crl *ca_crl,
343 const mbedtls_x509_crt_profile *profile,
344 const char *cn, uint32_t *flags,
345 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
346 void *p_vrfy );
347
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200348#if defined(MBEDTLS_X509_CHECK_KEY_USAGE)
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +0200349/**
350 * \brief Check usage of certificate against keyUsage extension.
351 *
352 * \param crt Leaf certificate used.
Manuel Pégourié-Gonnard655a9642015-06-23 10:48:44 +0200353 * \param usage Intended usage(s) (eg MBEDTLS_X509_KU_KEY_ENCIPHERMENT
354 * before using the certificate to perform an RSA key
355 * exchange).
356 *
357 * \note Except for decipherOnly and encipherOnly, a bit set in the
358 * usage argument means this bit MUST be set in the
359 * certificate. For decipherOnly and encipherOnly, it means
360 * that bit MAY be set.
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +0200361 *
362 * \return 0 is these uses of the certificate are allowed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200363 * MBEDTLS_ERR_X509_BAD_INPUT_DATA if the keyUsage extension
Manuel Pégourié-Gonnard655a9642015-06-23 10:48:44 +0200364 * is present but does not match the usage argument.
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +0200365 *
366 * \note You should only call this function on leaf certificates, on
367 * (intermediate) CAs the keyUsage extension is automatically
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200368 * checked by \c mbedtls_x509_crt_verify().
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +0200369 */
Manuel Pégourié-Gonnard655a9642015-06-23 10:48:44 +0200370int mbedtls_x509_crt_check_key_usage( const mbedtls_x509_crt *crt,
371 unsigned int usage );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200372#endif /* MBEDTLS_X509_CHECK_KEY_USAGE) */
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +0200373
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200374#if defined(MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE)
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +0200375/**
376 * \brief Check usage of certificate against extentedJeyUsage.
377 *
378 * \param crt Leaf certificate used.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200379 * \param usage_oid Intended usage (eg MBEDTLS_OID_SERVER_AUTH or MBEDTLS_OID_CLIENT_AUTH).
380 * \param usage_len Length of usage_oid (eg given by MBEDTLS_OID_SIZE()).
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +0200381 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +0200382 * \return 0 if this use of the certificate is allowed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200383 * MBEDTLS_ERR_X509_BAD_INPUT_DATA if not.
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +0200384 *
385 * \note Usually only makes sense on leaf certificates.
386 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200387int mbedtls_x509_crt_check_extended_key_usage( const mbedtls_x509_crt *crt,
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +0200388 const char *usage_oid,
389 size_t usage_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200390#endif /* MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE) */
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +0200391
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392#if defined(MBEDTLS_X509_CRL_PARSE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200393/**
Manuel Pégourié-Gonnardcbf3ef32013-09-23 12:20:02 +0200394 * \brief Verify the certificate revocation status
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200395 *
396 * \param crt a certificate to be verified
397 * \param crl the CRL to verify against
398 *
399 * \return 1 if the certificate is revoked, 0 otherwise
400 *
401 */
Manuel Pégourié-Gonnardc730ed32015-06-02 10:38:50 +0100402int mbedtls_x509_crt_is_revoked( const mbedtls_x509_crt *crt, const mbedtls_x509_crl *crl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200403#endif /* MBEDTLS_X509_CRL_PARSE_C */
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200404
405/**
Paul Bakker369d2eb2013-09-18 11:58:25 +0200406 * \brief Initialize a certificate (chain)
407 *
408 * \param crt Certificate chain to initialize
409 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200410void mbedtls_x509_crt_init( mbedtls_x509_crt *crt );
Paul Bakker369d2eb2013-09-18 11:58:25 +0200411
412/**
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200413 * \brief Unallocate all certificate data
414 *
415 * \param crt Certificate chain to free
416 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200417void mbedtls_x509_crt_free( mbedtls_x509_crt *crt );
418#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200419
420/* \} name */
421/* \} addtogroup x509_module */
422
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200423#if defined(MBEDTLS_X509_CRT_WRITE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200424/**
425 * \brief Initialize a CRT writing context
426 *
427 * \param ctx CRT context to initialize
428 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200429void mbedtls_x509write_crt_init( mbedtls_x509write_cert *ctx );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200430
431/**
432 * \brief Set the verion for a Certificate
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200433 * Default: MBEDTLS_X509_CRT_VERSION_3
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200434 *
435 * \param ctx CRT context to use
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200436 * \param version version to set (MBEDTLS_X509_CRT_VERSION_1, MBEDTLS_X509_CRT_VERSION_2 or
437 * MBEDTLS_X509_CRT_VERSION_3)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200438 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200439void mbedtls_x509write_crt_set_version( mbedtls_x509write_cert *ctx, int version );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200440
441/**
442 * \brief Set the serial number for a Certificate.
443 *
444 * \param ctx CRT context to use
445 * \param serial serial number to set
446 *
447 * \return 0 if successful
448 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200449int mbedtls_x509write_crt_set_serial( mbedtls_x509write_cert *ctx, const mbedtls_mpi *serial );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200450
451/**
452 * \brief Set the validity period for a Certificate
453 * Timestamps should be in string format for UTC timezone
454 * i.e. "YYYYMMDDhhmmss"
455 * e.g. "20131231235959" for December 31st 2013
456 * at 23:59:59
457 *
458 * \param ctx CRT context to use
459 * \param not_before not_before timestamp
460 * \param not_after not_after timestamp
461 *
462 * \return 0 if timestamp was parsed successfully, or
463 * a specific error code
464 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200465int mbedtls_x509write_crt_set_validity( mbedtls_x509write_cert *ctx, const char *not_before,
Paul Bakker50dc8502013-10-28 21:19:10 +0100466 const char *not_after );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200467
468/**
469 * \brief Set the issuer name for a Certificate
470 * Issuer names should contain a comma-separated list
471 * of OID types and values:
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000472 * e.g. "C=UK,O=ARM,CN=mbed TLS CA"
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200473 *
474 * \param ctx CRT context to use
475 * \param issuer_name issuer name to set
476 *
477 * \return 0 if issuer name was parsed successfully, or
478 * a specific error code
479 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200480int mbedtls_x509write_crt_set_issuer_name( mbedtls_x509write_cert *ctx,
Paul Bakker50dc8502013-10-28 21:19:10 +0100481 const char *issuer_name );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200482
483/**
484 * \brief Set the subject name for a Certificate
485 * Subject names should contain a comma-separated list
486 * of OID types and values:
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000487 * e.g. "C=UK,O=ARM,CN=mbed TLS Server 1"
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200488 *
489 * \param ctx CRT context to use
490 * \param subject_name subject name to set
491 *
492 * \return 0 if subject name was parsed successfully, or
493 * a specific error code
494 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200495int mbedtls_x509write_crt_set_subject_name( mbedtls_x509write_cert *ctx,
Paul Bakker50dc8502013-10-28 21:19:10 +0100496 const char *subject_name );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200497
498/**
499 * \brief Set the subject public key for the certificate
500 *
501 * \param ctx CRT context to use
502 * \param key public key to include
503 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200504void mbedtls_x509write_crt_set_subject_key( mbedtls_x509write_cert *ctx, mbedtls_pk_context *key );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200505
506/**
507 * \brief Set the issuer key used for signing the certificate
508 *
509 * \param ctx CRT context to use
510 * \param key private key to sign with
511 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200512void mbedtls_x509write_crt_set_issuer_key( mbedtls_x509write_cert *ctx, mbedtls_pk_context *key );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200513
514/**
515 * \brief Set the MD algorithm to use for the signature
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200516 * (e.g. MBEDTLS_MD_SHA1)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200517 *
518 * \param ctx CRT context to use
Paul Bakkera36d23e2013-12-30 17:57:27 +0100519 * \param md_alg MD algorithm to use
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200520 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200521void mbedtls_x509write_crt_set_md_alg( mbedtls_x509write_cert *ctx, mbedtls_md_type_t md_alg );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200522
523/**
524 * \brief Generic function to add to or replace an extension in the
525 * CRT
526 *
527 * \param ctx CRT context to use
528 * \param oid OID of the extension
529 * \param oid_len length of the OID
530 * \param critical if the extension is critical (per the RFC's definition)
531 * \param val value of the extension OCTET STRING
532 * \param val_len length of the value data
533 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200534 * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200535 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200536int mbedtls_x509write_crt_set_extension( mbedtls_x509write_cert *ctx,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200537 const char *oid, size_t oid_len,
538 int critical,
539 const unsigned char *val, size_t val_len );
540
541/**
542 * \brief Set the basicConstraints extension for a CRT
543 *
544 * \param ctx CRT context to use
545 * \param is_ca is this a CA certificate
546 * \param max_pathlen maximum length of certificate chains below this
547 * certificate (only for CA certificates, -1 is
548 * inlimited)
549 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200550 * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200552int mbedtls_x509write_crt_set_basic_constraints( mbedtls_x509write_cert *ctx,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200553 int is_ca, int max_pathlen );
554
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200555#if defined(MBEDTLS_SHA1_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200556/**
557 * \brief Set the subjectKeyIdentifier extension for a CRT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200558 * Requires that mbedtls_x509write_crt_set_subject_key() has been
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200559 * called before
560 *
561 * \param ctx CRT context to use
562 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200563 * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200564 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565int mbedtls_x509write_crt_set_subject_key_identifier( mbedtls_x509write_cert *ctx );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200566
567/**
568 * \brief Set the authorityKeyIdentifier extension for a CRT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200569 * Requires that mbedtls_x509write_crt_set_issuer_key() has been
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200570 * called before
571 *
572 * \param ctx CRT context to use
573 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200574 * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200575 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200576int mbedtls_x509write_crt_set_authority_key_identifier( mbedtls_x509write_cert *ctx );
577#endif /* MBEDTLS_SHA1_C */
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200578
579/**
580 * \brief Set the Key Usage Extension flags
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200581 * (e.g. MBEDTLS_X509_KU_DIGITAL_SIGNATURE | MBEDTLS_X509_KU_KEY_CERT_SIGN)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200582 *
583 * \param ctx CRT context to use
584 * \param key_usage key usage flags to set
585 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200586 * \return 0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200587 */
Manuel Pégourié-Gonnard1cd10ad2015-06-23 11:07:37 +0200588int mbedtls_x509write_crt_set_key_usage( mbedtls_x509write_cert *ctx,
589 unsigned int key_usage );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200590
591/**
592 * \brief Set the Netscape Cert Type flags
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200593 * (e.g. MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT | MBEDTLS_X509_NS_CERT_TYPE_EMAIL)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200594 *
595 * \param ctx CRT context to use
596 * \param ns_cert_type Netscape Cert Type flags to set
597 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200598 * \return 0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600int mbedtls_x509write_crt_set_ns_cert_type( mbedtls_x509write_cert *ctx,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200601 unsigned char ns_cert_type );
602
603/**
604 * \brief Free the contents of a CRT write context
605 *
606 * \param ctx CRT context to free
607 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200608void mbedtls_x509write_crt_free( mbedtls_x509write_cert *ctx );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200609
610/**
611 * \brief Write a built up certificate to a X509 DER structure
612 * Note: data is written at the end of the buffer! Use the
613 * return value to determine where you should start
614 * using the buffer
615 *
Paul Bakkera36d23e2013-12-30 17:57:27 +0100616 * \param ctx certificate to write away
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200617 * \param buf buffer to write to
618 * \param size size of the buffer
619 * \param f_rng RNG function (for signature, see note)
620 * \param p_rng RNG parameter
621 *
622 * \return length of data written if successful, or a specific
623 * error code
624 *
625 * \note f_rng may be NULL if RSA is used for signature and the
626 * signature is made offline (otherwise f_rng is desirable
627 * for countermeasures against timing attacks).
628 * ECDSA signatures always require a non-NULL f_rng.
629 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200630int mbedtls_x509write_crt_der( mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200631 int (*f_rng)(void *, unsigned char *, size_t),
632 void *p_rng );
633
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200634#if defined(MBEDTLS_PEM_WRITE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200635/**
636 * \brief Write a built up certificate to a X509 PEM string
637 *
Paul Bakkera36d23e2013-12-30 17:57:27 +0100638 * \param ctx certificate to write away
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200639 * \param buf buffer to write to
640 * \param size size of the buffer
641 * \param f_rng RNG function (for signature, see note)
642 * \param p_rng RNG parameter
643 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +0200644 * \return 0 if successful, or a specific error code
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200645 *
646 * \note f_rng may be NULL if RSA is used for signature and the
647 * signature is made offline (otherwise f_rng is desirable
648 * for countermeasures against timing attacks).
649 * ECDSA signatures always require a non-NULL f_rng.
650 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200651int mbedtls_x509write_crt_pem( mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200652 int (*f_rng)(void *, unsigned char *, size_t),
653 void *p_rng );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200654#endif /* MBEDTLS_PEM_WRITE_C */
655#endif /* MBEDTLS_X509_CRT_WRITE_C */
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200656
657#ifdef __cplusplus
658}
659#endif
660
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200661#endif /* mbedtls_x509_crt.h */