blob: 2dbb7ec9647e7793b586da83f1d74747d247e741 [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
Darryl Greena40a1012018-01-05 15:33:17 +00005 */
6/*
Manuel Pégourié-Gonnard6fb81872015-07-27 11:11:48 +02007 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02008 * SPDX-License-Identifier: Apache-2.0
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
Paul Bakker7c6b2c32013-09-16 13:49:26 +020021 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000022 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakker7c6b2c32013-09-16 13:49:26 +020023 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020024#ifndef MBEDTLS_X509_CRT_H
25#define MBEDTLS_X509_CRT_H
Paul Bakker7c6b2c32013-09-16 13:49:26 +020026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if !defined(MBEDTLS_CONFIG_FILE)
Paul Bakker7c6b2c32013-09-16 13:49:26 +020028#include "config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020029#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020030#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020031#endif
Paul Bakker7c6b2c32013-09-16 13:49:26 +020032
33#include "x509.h"
Paul Bakker7c6b2c32013-09-16 13:49:26 +020034#include "x509_crl.h"
Paul Bakker7c6b2c32013-09-16 13:49:26 +020035
36/**
37 * \addtogroup x509_module
38 * \{
39 */
40
41#ifdef __cplusplus
42extern "C" {
43#endif
44
45/**
46 * \name Structures and functions for parsing and writing X.509 certificates
47 * \{
48 */
49
50/**
51 * Container for an X.509 certificate. The certificate may be chained.
52 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020053typedef struct mbedtls_x509_crt
Paul Bakker7c6b2c32013-09-16 13:49:26 +020054{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020055 mbedtls_x509_buf raw; /**< The raw certificate data (DER). */
56 mbedtls_x509_buf tbs; /**< The raw certificate body (DER). The part that is To Be Signed. */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020057
Manuel Pégourié-Gonnardf4e1b642014-06-19 11:39:46 +020058 int version; /**< The X.509 version. (1=v1, 2=v2, 3=v3) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020059 mbedtls_x509_buf serial; /**< Unique id for certificate issued by a specific CA. */
60 mbedtls_x509_buf sig_oid; /**< Signature algorithm, e.g. sha1RSA */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020061
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020062 mbedtls_x509_buf issuer_raw; /**< The raw issuer data (DER). Used for quick comparison. */
63 mbedtls_x509_buf subject_raw; /**< The raw subject data (DER). Used for quick comparison. */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020064
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020065 mbedtls_x509_name issuer; /**< The parsed issuer data (named information object). */
66 mbedtls_x509_name subject; /**< The parsed subject data (named information object). */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020067
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020068 mbedtls_x509_time valid_from; /**< Start time of certificate validity. */
69 mbedtls_x509_time valid_to; /**< End time of certificate validity. */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020070
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020071 mbedtls_pk_context pk; /**< Container for the public key context. */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020072
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020073 mbedtls_x509_buf issuer_id; /**< Optional X.509 v2/v3 issuer unique identifier. */
74 mbedtls_x509_buf subject_id; /**< Optional X.509 v2/v3 subject unique identifier. */
75 mbedtls_x509_buf v3_ext; /**< Optional X.509 v3 extensions. */
76 mbedtls_x509_sequence subject_alt_names; /**< Optional list of Subject Alternative Names (Only dNSName supported). */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020077
78 int ext_types; /**< Bit string containing detected and parsed extensions */
79 int ca_istrue; /**< Optional Basic Constraint extension value: 1 if this certificate belongs to a CA, 0 otherwise. */
80 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+ */
81
Manuel Pégourié-Gonnard1d0ca1a2015-03-27 16:50:00 +010082 unsigned int key_usage; /**< Optional key usage extension value: See the values in x509.h */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020083
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020084 mbedtls_x509_sequence ext_key_usage; /**< Optional list of extended key usage OIDs. */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020085
Manuel Pégourié-Gonnardb28487d2014-04-01 12:19:09 +020086 unsigned char ns_cert_type; /**< Optional Netscape certificate type extension value: See the values in x509.h */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020087
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020088 mbedtls_x509_buf sig; /**< Signature: hash of the tbs part signed with the private key. */
89 mbedtls_md_type_t sig_md; /**< Internal representation of the MD algorithm of the signature algorithm, e.g. MBEDTLS_MD_SHA256 */
90 mbedtls_pk_type_t sig_pk; /**< Internal representation of the Public Key algorithm of the signature algorithm, e.g. MBEDTLS_PK_RSA */
91 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 +020092
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020093 struct mbedtls_x509_crt *next; /**< Next certificate in the CA-chain. */
Paul Bakker7c6b2c32013-09-16 13:49:26 +020094}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020095mbedtls_x509_crt;
Paul Bakker7c6b2c32013-09-16 13:49:26 +020096
Manuel Pégourié-Gonnard88db5da2015-06-15 14:34:59 +020097/**
Manuel Pégourié-Gonnardf8ea8562015-06-15 15:33:19 +020098 * Build flag from an algorithm/curve identifier (pk, md, ecp)
99 * Since 0 is always XXX_NONE, ignore it.
100 */
101#define MBEDTLS_X509_ID_FLAG( id ) ( 1 << ( id - 1 ) )
102
103/**
Manuel Pégourié-Gonnard88db5da2015-06-15 14:34:59 +0200104 * Security profile for certificate verification.
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200105 *
Manuel Pégourié-Gonnardf8ea8562015-06-15 15:33:19 +0200106 * All lists are bitfields, built by ORing flags from MBEDTLS_X509_ID_FLAG().
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200107 */
108typedef struct
109{
Manuel Pégourié-Gonnardf8ea8562015-06-15 15:33:19 +0200110 uint32_t allowed_mds; /**< MDs for signatures */
111 uint32_t allowed_pks; /**< PK algs for signatures */
112 uint32_t allowed_curves; /**< Elliptic curves for ECDSA */
113 uint32_t rsa_min_bitlen; /**< Minimum size for RSA keys */
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200114}
115mbedtls_x509_crt_profile;
116
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200117#define MBEDTLS_X509_CRT_VERSION_1 0
118#define MBEDTLS_X509_CRT_VERSION_2 1
119#define MBEDTLS_X509_CRT_VERSION_3 2
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200120
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200121#define MBEDTLS_X509_RFC5280_MAX_SERIAL_LEN 32
122#define MBEDTLS_X509_RFC5280_UTC_TIME_LEN 15
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200123
Andres AGf9113192016-09-02 14:06:04 +0100124#if !defined( MBEDTLS_X509_MAX_FILE_PATH_LEN )
125#define MBEDTLS_X509_MAX_FILE_PATH_LEN 512
126#endif
127
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200128/**
129 * Container for writing a certificate (CRT)
130 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200131typedef struct mbedtls_x509write_cert
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200132{
133 int version;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200134 mbedtls_mpi serial;
135 mbedtls_pk_context *subject_key;
136 mbedtls_pk_context *issuer_key;
137 mbedtls_asn1_named_data *subject;
138 mbedtls_asn1_named_data *issuer;
139 mbedtls_md_type_t md_alg;
140 char not_before[MBEDTLS_X509_RFC5280_UTC_TIME_LEN + 1];
141 char not_after[MBEDTLS_X509_RFC5280_UTC_TIME_LEN + 1];
142 mbedtls_asn1_named_data *extensions;
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200143}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200144mbedtls_x509write_cert;
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200145
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200146#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200147/**
Manuel Pégourié-Gonnard88db5da2015-06-15 14:34:59 +0200148 * Default security profile. Should provide a good balance between security
149 * and compatibility with current deployments.
150 */
151extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_default;
152
153/**
154 * Expected next default profile. Recommended for new deployments.
155 * Currently targets a 128-bit security level, except for RSA-2048.
156 */
157extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_next;
158
159/**
160 * NSA Suite B profile.
161 */
162extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_suiteb;
163
164/**
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200165 * \brief Parse a single DER formatted certificate and add it
166 * to the chained list.
167 *
168 * \param chain points to the start of the chain
169 * \param buf buffer holding the certificate DER data
170 * \param buflen size of the buffer
171 *
172 * \return 0 if successful, or a specific X509 or PEM error code
173 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200174int mbedtls_x509_crt_parse_der( mbedtls_x509_crt *chain, const unsigned char *buf,
Paul Bakkerddf26b42013-09-18 13:46:23 +0200175 size_t buflen );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200176
177/**
178 * \brief Parse one or more certificates and add them
179 * to the chained list. Parses permissively. If some
180 * certificates can be parsed, the result is the number
181 * of failed certificates it encountered. If none complete
182 * correctly, the first error is returned.
183 *
184 * \param chain points to the start of the chain
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +0200185 * \param buf buffer holding the certificate data in PEM or DER format
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200186 * \param buflen size of the buffer
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +0200187 * (including the terminating null byte for PEM data)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200188 *
189 * \return 0 if all certificates parsed successfully, a positive number
190 * if partly successful or a specific X509 or PEM error code
191 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200192int mbedtls_x509_crt_parse( mbedtls_x509_crt *chain, const unsigned char *buf, size_t buflen );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194#if defined(MBEDTLS_FS_IO)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200195/**
196 * \brief Load one or more certificates and add them
197 * to the chained list. Parses permissively. If some
198 * certificates can be parsed, the result is the number
199 * of failed certificates it encountered. If none complete
200 * correctly, the first error is returned.
201 *
202 * \param chain points to the start of the chain
203 * \param path filename to read the certificates from
204 *
205 * \return 0 if all certificates parsed successfully, a positive number
206 * if partly successful or a specific X509 or PEM error code
207 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200208int mbedtls_x509_crt_parse_file( mbedtls_x509_crt *chain, const char *path );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200209
210/**
211 * \brief Load one or more certificate files from a path and add them
212 * to the chained list. Parses permissively. If some
213 * certificates can be parsed, the result is the number
214 * of failed certificates it encountered. If none complete
215 * correctly, the first error is returned.
216 *
217 * \param chain points to the start of the chain
218 * \param path directory / folder to read the certificate files from
219 *
220 * \return 0 if all certificates parsed successfully, a positive number
221 * if partly successful or a specific X509 or PEM error code
222 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200223int mbedtls_x509_crt_parse_path( mbedtls_x509_crt *chain, const char *path );
224#endif /* MBEDTLS_FS_IO */
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200225
226/**
227 * \brief Returns an informational string about the
228 * certificate.
229 *
230 * \param buf Buffer to write to
231 * \param size Maximum size of buffer
232 * \param prefix A line prefix
233 * \param crt The X509 certificate to represent
234 *
Manuel Pégourié-Gonnarde244f9f2015-06-23 12:10:45 +0200235 * \return The length of the string written (not including the
236 * terminated nul byte), or a negative error code.
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200237 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200238int mbedtls_x509_crt_info( char *buf, size_t size, const char *prefix,
239 const mbedtls_x509_crt *crt );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200240
241/**
Manuel Pégourié-Gonnardb5f48ad2015-04-20 10:38:13 +0100242 * \brief Returns an informational string about the
243 * verification status of a certificate.
244 *
245 * \param buf Buffer to write to
246 * \param size Maximum size of buffer
247 * \param prefix A line prefix
248 * \param flags Verification flags created by mbedtls_x509_crt_verify()
249 *
Manuel Pégourié-Gonnarde244f9f2015-06-23 12:10:45 +0200250 * \return The length of the string written (not including the
251 * terminated nul byte), or a negative error code.
Manuel Pégourié-Gonnardb5f48ad2015-04-20 10:38:13 +0100252 */
253int mbedtls_x509_crt_verify_info( char *buf, size_t size, const char *prefix,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200254 uint32_t flags );
Manuel Pégourié-Gonnard39a183a2015-04-17 16:14:32 +0200255
256/**
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200257 * \brief Verify the certificate signature
258 *
259 * The verify callback is a user-supplied callback that
260 * can clear / modify / add flags for a certificate. If set,
261 * the verification callback is called for each
262 * certificate in the chain (from the trust-ca down to the
263 * presented crt). The parameters for the callback are:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200264 * (void *parameter, mbedtls_x509_crt *crt, int certificate_depth,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200265 * int *flags). With the flags representing current flags for
266 * that specific certificate and the certificate depth from
267 * the bottom (Peer cert depth = 0).
268 *
269 * All flags left after returning from the callback
270 * are also returned to the application. The function should
Manuel Pégourié-Gonnard31458a12017-06-26 10:11:49 +0200271 * return 0 for anything (including invalid certificates)
272 * other than fatal error, as a non-zero return code
273 * immediately aborts the verification process. For fatal
274 * errors, a specific error code should be used (different
275 * from MBEDTLS_ERR_X509_CERT_VERIFY_FAILED which should not
276 * be returned at this point), or MBEDTLS_ERR_X509_FATAL_ERROR
277 * can be used if no better code is available.
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200278 *
Manuel Pégourié-Gonnardb5f48ad2015-04-20 10:38:13 +0100279 * \note In case verification failed, the results can be displayed
280 * using \c mbedtls_x509_crt_verify_info()
281 *
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200282 * \note Same as \c mbedtls_x509_crt_verify_with_profile() with the
283 * default security profile.
284 *
Manuel Pégourié-Gonnardeeef9472016-02-22 11:36:55 +0100285 * \note It is your responsibility to provide up-to-date CRLs for
286 * all trusted CAs. If no CRL is provided for the CA that was
287 * used to sign the certificate, CRL verification is skipped
288 * silently, that is *without* setting any flag.
289 *
290 * \param crt a certificate (chain) to be verified
291 * \param trust_ca the list of trusted CAs
292 * \param ca_crl the list of CRLs for trusted CAs (see note above)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200293 * \param cn expected Common Name (can be set to
294 * NULL if the CN must not be verified)
295 * \param flags result of the verification
296 * \param f_vrfy verification function
297 * \param p_vrfy verification parameter
298 *
Manuel Pégourié-Gonnard760c9b92017-07-06 15:00:32 +0200299 * \return 0 (and flags set to 0) if the chain was verified and valid,
300 * MBEDTLS_ERR_X509_CERT_VERIFY_FAILED if the chain was verified
301 * but found to be invalid, in which case *flags will have one
302 * or more MBEDTLS_X509_BADCERT_XXX or MBEDTLS_X509_BADCRL_XXX
303 * flags set, or another error (and flags set to 0xffffffff)
304 * in case of a fatal error encountered during the
305 * verification process.
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200306 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200307int mbedtls_x509_crt_verify( mbedtls_x509_crt *crt,
308 mbedtls_x509_crt *trust_ca,
309 mbedtls_x509_crl *ca_crl,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200310 const char *cn, uint32_t *flags,
311 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerddf26b42013-09-18 13:46:23 +0200312 void *p_vrfy );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200313
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200314/**
315 * \brief Verify the certificate signature according to profile
316 *
317 * \note Same as \c mbedtls_x509_crt_verify(), but with explicit
318 * security profile.
319 *
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +0200320 * \note The restrictions on keys (RSA minimum size, allowed curves
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +0200321 * for ECDSA) apply to all certificates: trusted root,
322 * intermediate CAs if any, and end entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +0200323 *
Manuel Pégourié-Gonnardeeef9472016-02-22 11:36:55 +0100324 * \param crt a certificate (chain) to be verified
325 * \param trust_ca the list of trusted CAs
326 * \param ca_crl the list of CRLs for trusted CAs
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200327 * \param profile security profile for verification
328 * \param cn expected Common Name (can be set to
329 * NULL if the CN must not be verified)
330 * \param flags result of the verification
331 * \param f_vrfy verification function
332 * \param p_vrfy verification parameter
333 *
334 * \return 0 if successful or MBEDTLS_ERR_X509_CERT_VERIFY_FAILED
335 * in which case *flags will have one or more
336 * MBEDTLS_X509_BADCERT_XXX or MBEDTLS_X509_BADCRL_XXX flags
337 * set,
338 * or another error in case of a fatal error encountered
339 * during the verification process.
340 */
341int mbedtls_x509_crt_verify_with_profile( mbedtls_x509_crt *crt,
342 mbedtls_x509_crt *trust_ca,
343 mbedtls_x509_crl *ca_crl,
344 const mbedtls_x509_crt_profile *profile,
345 const char *cn, uint32_t *flags,
346 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
347 void *p_vrfy );
348
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200349#if defined(MBEDTLS_X509_CHECK_KEY_USAGE)
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +0200350/**
351 * \brief Check usage of certificate against keyUsage extension.
352 *
353 * \param crt Leaf certificate used.
Manuel Pégourié-Gonnard655a9642015-06-23 10:48:44 +0200354 * \param usage Intended usage(s) (eg MBEDTLS_X509_KU_KEY_ENCIPHERMENT
355 * before using the certificate to perform an RSA key
356 * exchange).
357 *
358 * \note Except for decipherOnly and encipherOnly, a bit set in the
359 * usage argument means this bit MUST be set in the
360 * certificate. For decipherOnly and encipherOnly, it means
361 * that bit MAY be set.
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +0200362 *
363 * \return 0 is these uses of the certificate are allowed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200364 * MBEDTLS_ERR_X509_BAD_INPUT_DATA if the keyUsage extension
Manuel Pégourié-Gonnard655a9642015-06-23 10:48:44 +0200365 * is present but does not match the usage argument.
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +0200366 *
367 * \note You should only call this function on leaf certificates, on
368 * (intermediate) CAs the keyUsage extension is automatically
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200369 * checked by \c mbedtls_x509_crt_verify().
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +0200370 */
Manuel Pégourié-Gonnard655a9642015-06-23 10:48:44 +0200371int mbedtls_x509_crt_check_key_usage( const mbedtls_x509_crt *crt,
372 unsigned int usage );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200373#endif /* MBEDTLS_X509_CHECK_KEY_USAGE) */
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +0200374
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200375#if defined(MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE)
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +0200376/**
Andres Amaya Garcia5a6da632017-11-14 21:40:51 +0000377 * \brief Check usage of certificate against extendedKeyUsage.
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +0200378 *
Andres Amaya Garcia5a6da632017-11-14 21:40:51 +0000379 * \param crt Leaf certificate used.
380 * \param usage_oid Intended usage (eg MBEDTLS_OID_SERVER_AUTH or
381 * MBEDTLS_OID_CLIENT_AUTH).
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200382 * \param usage_len Length of usage_oid (eg given by MBEDTLS_OID_SIZE()).
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +0200383 *
Andres Amaya Garcia5a6da632017-11-14 21:40:51 +0000384 * \return 0 if this use of the certificate is allowed,
385 * MBEDTLS_ERR_X509_BAD_INPUT_DATA if not.
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +0200386 *
Andres Amaya Garcia5a6da632017-11-14 21:40:51 +0000387 * \note Usually only makes sense on leaf certificates.
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +0200388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200389int mbedtls_x509_crt_check_extended_key_usage( const mbedtls_x509_crt *crt,
Andres Amaya Garcia5a6da632017-11-14 21:40:51 +0000390 const char *usage_oid,
391 size_t usage_len );
Andres Amaya Garciac81fcb92017-11-14 21:40:02 +0000392#endif /* MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE */
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +0200393
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200394#if defined(MBEDTLS_X509_CRL_PARSE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200395/**
Manuel Pégourié-Gonnardcbf3ef32013-09-23 12:20:02 +0200396 * \brief Verify the certificate revocation status
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200397 *
398 * \param crt a certificate to be verified
399 * \param crl the CRL to verify against
400 *
401 * \return 1 if the certificate is revoked, 0 otherwise
402 *
403 */
Manuel Pégourié-Gonnardc730ed32015-06-02 10:38:50 +0100404int mbedtls_x509_crt_is_revoked( const mbedtls_x509_crt *crt, const mbedtls_x509_crl *crl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200405#endif /* MBEDTLS_X509_CRL_PARSE_C */
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200406
407/**
Paul Bakker369d2eb2013-09-18 11:58:25 +0200408 * \brief Initialize a certificate (chain)
409 *
410 * \param crt Certificate chain to initialize
411 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200412void mbedtls_x509_crt_init( mbedtls_x509_crt *crt );
Paul Bakker369d2eb2013-09-18 11:58:25 +0200413
414/**
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200415 * \brief Unallocate all certificate data
416 *
417 * \param crt Certificate chain to free
418 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200419void mbedtls_x509_crt_free( mbedtls_x509_crt *crt );
420#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200421
422/* \} name */
423/* \} addtogroup x509_module */
424
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200425#if defined(MBEDTLS_X509_CRT_WRITE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200426/**
427 * \brief Initialize a CRT writing context
428 *
429 * \param ctx CRT context to initialize
430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200431void mbedtls_x509write_crt_init( mbedtls_x509write_cert *ctx );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200432
433/**
434 * \brief Set the verion for a Certificate
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200435 * Default: MBEDTLS_X509_CRT_VERSION_3
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200436 *
437 * \param ctx CRT context to use
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200438 * \param version version to set (MBEDTLS_X509_CRT_VERSION_1, MBEDTLS_X509_CRT_VERSION_2 or
439 * MBEDTLS_X509_CRT_VERSION_3)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200440 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200441void mbedtls_x509write_crt_set_version( mbedtls_x509write_cert *ctx, int version );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200442
443/**
444 * \brief Set the serial number for a Certificate.
445 *
446 * \param ctx CRT context to use
447 * \param serial serial number to set
448 *
449 * \return 0 if successful
450 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200451int mbedtls_x509write_crt_set_serial( mbedtls_x509write_cert *ctx, const mbedtls_mpi *serial );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200452
453/**
454 * \brief Set the validity period for a Certificate
455 * Timestamps should be in string format for UTC timezone
456 * i.e. "YYYYMMDDhhmmss"
457 * e.g. "20131231235959" for December 31st 2013
458 * at 23:59:59
459 *
460 * \param ctx CRT context to use
461 * \param not_before not_before timestamp
462 * \param not_after not_after timestamp
463 *
464 * \return 0 if timestamp was parsed successfully, or
465 * a specific error code
466 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200467int mbedtls_x509write_crt_set_validity( mbedtls_x509write_cert *ctx, const char *not_before,
Paul Bakker50dc8502013-10-28 21:19:10 +0100468 const char *not_after );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200469
470/**
471 * \brief Set the issuer name for a Certificate
472 * Issuer names should contain a comma-separated list
473 * of OID types and values:
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000474 * e.g. "C=UK,O=ARM,CN=mbed TLS CA"
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200475 *
476 * \param ctx CRT context to use
477 * \param issuer_name issuer name to set
478 *
479 * \return 0 if issuer name was parsed successfully, or
480 * a specific error code
481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200482int mbedtls_x509write_crt_set_issuer_name( mbedtls_x509write_cert *ctx,
Paul Bakker50dc8502013-10-28 21:19:10 +0100483 const char *issuer_name );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200484
485/**
486 * \brief Set the subject name for a Certificate
487 * Subject names should contain a comma-separated list
488 * of OID types and values:
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000489 * e.g. "C=UK,O=ARM,CN=mbed TLS Server 1"
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200490 *
491 * \param ctx CRT context to use
492 * \param subject_name subject name to set
493 *
494 * \return 0 if subject name was parsed successfully, or
495 * a specific error code
496 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200497int mbedtls_x509write_crt_set_subject_name( mbedtls_x509write_cert *ctx,
Paul Bakker50dc8502013-10-28 21:19:10 +0100498 const char *subject_name );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200499
500/**
501 * \brief Set the subject public key for the certificate
502 *
503 * \param ctx CRT context to use
504 * \param key public key to include
505 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200506void mbedtls_x509write_crt_set_subject_key( mbedtls_x509write_cert *ctx, mbedtls_pk_context *key );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200507
508/**
509 * \brief Set the issuer key used for signing the certificate
510 *
511 * \param ctx CRT context to use
512 * \param key private key to sign with
513 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200514void mbedtls_x509write_crt_set_issuer_key( mbedtls_x509write_cert *ctx, mbedtls_pk_context *key );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200515
516/**
517 * \brief Set the MD algorithm to use for the signature
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200518 * (e.g. MBEDTLS_MD_SHA1)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200519 *
520 * \param ctx CRT context to use
Paul Bakkera36d23e2013-12-30 17:57:27 +0100521 * \param md_alg MD algorithm to use
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200522 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200523void mbedtls_x509write_crt_set_md_alg( mbedtls_x509write_cert *ctx, mbedtls_md_type_t md_alg );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200524
525/**
526 * \brief Generic function to add to or replace an extension in the
527 * CRT
528 *
529 * \param ctx CRT context to use
530 * \param oid OID of the extension
531 * \param oid_len length of the OID
532 * \param critical if the extension is critical (per the RFC's definition)
533 * \param val value of the extension OCTET STRING
534 * \param val_len length of the value data
535 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200536 * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200537 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200538int mbedtls_x509write_crt_set_extension( mbedtls_x509write_cert *ctx,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200539 const char *oid, size_t oid_len,
540 int critical,
541 const unsigned char *val, size_t val_len );
542
543/**
544 * \brief Set the basicConstraints extension for a CRT
545 *
546 * \param ctx CRT context to use
547 * \param is_ca is this a CA certificate
548 * \param max_pathlen maximum length of certificate chains below this
549 * certificate (only for CA certificates, -1 is
550 * inlimited)
551 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200552 * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200553 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200554int mbedtls_x509write_crt_set_basic_constraints( mbedtls_x509write_cert *ctx,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200555 int is_ca, int max_pathlen );
556
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200557#if defined(MBEDTLS_SHA1_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200558/**
559 * \brief Set the subjectKeyIdentifier extension for a CRT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200560 * Requires that mbedtls_x509write_crt_set_subject_key() has been
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200561 * called before
562 *
563 * \param ctx CRT context to use
564 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200565 * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200566 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567int mbedtls_x509write_crt_set_subject_key_identifier( mbedtls_x509write_cert *ctx );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200568
569/**
570 * \brief Set the authorityKeyIdentifier extension for a CRT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571 * Requires that mbedtls_x509write_crt_set_issuer_key() has been
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200572 * called before
573 *
574 * \param ctx CRT context to use
575 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200576 * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200577 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200578int mbedtls_x509write_crt_set_authority_key_identifier( mbedtls_x509write_cert *ctx );
579#endif /* MBEDTLS_SHA1_C */
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200580
581/**
582 * \brief Set the Key Usage Extension flags
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200583 * (e.g. MBEDTLS_X509_KU_DIGITAL_SIGNATURE | MBEDTLS_X509_KU_KEY_CERT_SIGN)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200584 *
585 * \param ctx CRT context to use
586 * \param key_usage key usage flags to set
587 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200588 * \return 0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200589 */
Manuel Pégourié-Gonnard1cd10ad2015-06-23 11:07:37 +0200590int mbedtls_x509write_crt_set_key_usage( mbedtls_x509write_cert *ctx,
591 unsigned int key_usage );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200592
593/**
594 * \brief Set the Netscape Cert Type flags
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200595 * (e.g. MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT | MBEDTLS_X509_NS_CERT_TYPE_EMAIL)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200596 *
597 * \param ctx CRT context to use
598 * \param ns_cert_type Netscape Cert Type flags to set
599 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200600 * \return 0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200601 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200602int mbedtls_x509write_crt_set_ns_cert_type( mbedtls_x509write_cert *ctx,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200603 unsigned char ns_cert_type );
604
605/**
606 * \brief Free the contents of a CRT write context
607 *
608 * \param ctx CRT context to free
609 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200610void mbedtls_x509write_crt_free( mbedtls_x509write_cert *ctx );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200611
612/**
613 * \brief Write a built up certificate to a X509 DER structure
614 * Note: data is written at the end of the buffer! Use the
615 * return value to determine where you should start
616 * using the buffer
617 *
Paul Bakkera36d23e2013-12-30 17:57:27 +0100618 * \param ctx certificate to write away
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200619 * \param buf buffer to write to
620 * \param size size of the buffer
621 * \param f_rng RNG function (for signature, see note)
622 * \param p_rng RNG parameter
623 *
624 * \return length of data written if successful, or a specific
625 * error code
626 *
627 * \note f_rng may be NULL if RSA is used for signature and the
628 * signature is made offline (otherwise f_rng is desirable
629 * for countermeasures against timing attacks).
630 * ECDSA signatures always require a non-NULL f_rng.
631 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200632int mbedtls_x509write_crt_der( mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200633 int (*f_rng)(void *, unsigned char *, size_t),
634 void *p_rng );
635
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200636#if defined(MBEDTLS_PEM_WRITE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200637/**
638 * \brief Write a built up certificate to a X509 PEM string
639 *
Paul Bakkera36d23e2013-12-30 17:57:27 +0100640 * \param ctx certificate to write away
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200641 * \param buf buffer to write to
642 * \param size size of the buffer
643 * \param f_rng RNG function (for signature, see note)
644 * \param p_rng RNG parameter
645 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +0200646 * \return 0 if successful, or a specific error code
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200647 *
648 * \note f_rng may be NULL if RSA is used for signature and the
649 * signature is made offline (otherwise f_rng is desirable
650 * for countermeasures against timing attacks).
651 * ECDSA signatures always require a non-NULL f_rng.
652 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200653int mbedtls_x509write_crt_pem( mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200654 int (*f_rng)(void *, unsigned char *, size_t),
655 void *p_rng );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200656#endif /* MBEDTLS_PEM_WRITE_C */
657#endif /* MBEDTLS_X509_CRT_WRITE_C */
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200658
659#ifdef __cplusplus
660}
661#endif
662
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200663#endif /* mbedtls_x509_crt.h */