blob: 41b6bfe57e310eb5ad27f778b19409e0c36b24c1 [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
123/**
124 * Container for writing a certificate (CRT)
125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200126typedef struct mbedtls_x509write_cert
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200127{
128 int version;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129 mbedtls_mpi serial;
130 mbedtls_pk_context *subject_key;
131 mbedtls_pk_context *issuer_key;
132 mbedtls_asn1_named_data *subject;
133 mbedtls_asn1_named_data *issuer;
134 mbedtls_md_type_t md_alg;
135 char not_before[MBEDTLS_X509_RFC5280_UTC_TIME_LEN + 1];
136 char not_after[MBEDTLS_X509_RFC5280_UTC_TIME_LEN + 1];
137 mbedtls_asn1_named_data *extensions;
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200138}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200139mbedtls_x509write_cert;
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200140
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200141#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200142/**
Manuel Pégourié-Gonnard88db5da2015-06-15 14:34:59 +0200143 * Default security profile. Should provide a good balance between security
144 * and compatibility with current deployments.
145 */
146extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_default;
147
148/**
149 * Expected next default profile. Recommended for new deployments.
150 * Currently targets a 128-bit security level, except for RSA-2048.
151 */
152extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_next;
153
154/**
155 * NSA Suite B profile.
156 */
157extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_suiteb;
158
159/**
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200160 * \brief Parse a single DER formatted certificate and add it
161 * to the chained list.
162 *
163 * \param chain points to the start of the chain
164 * \param buf buffer holding the certificate DER data
165 * \param buflen size of the buffer
166 *
167 * \return 0 if successful, or a specific X509 or PEM error code
168 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200169int mbedtls_x509_crt_parse_der( mbedtls_x509_crt *chain, const unsigned char *buf,
Paul Bakkerddf26b42013-09-18 13:46:23 +0200170 size_t buflen );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200171
172/**
173 * \brief Parse one or more certificates and add them
174 * to the chained list. Parses permissively. If some
175 * certificates can be parsed, the result is the number
176 * of failed certificates it encountered. If none complete
177 * correctly, the first error is returned.
178 *
179 * \param chain points to the start of the chain
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +0200180 * \param buf buffer holding the certificate data in PEM or DER format
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200181 * \param buflen size of the buffer
Manuel Pégourié-Gonnard43b37cb2015-05-12 11:20:10 +0200182 * (including the terminating null byte for PEM data)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200183 *
184 * \return 0 if all certificates parsed successfully, a positive number
185 * if partly successful or a specific X509 or PEM error code
186 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200187int mbedtls_x509_crt_parse( mbedtls_x509_crt *chain, const unsigned char *buf, size_t buflen );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200188
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200189#if defined(MBEDTLS_FS_IO)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200190/**
191 * \brief Load one or more certificates and add them
192 * to the chained list. Parses permissively. If some
193 * certificates can be parsed, the result is the number
194 * of failed certificates it encountered. If none complete
195 * correctly, the first error is returned.
196 *
197 * \param chain points to the start of the chain
198 * \param path filename to read the certificates from
199 *
200 * \return 0 if all certificates parsed successfully, a positive number
201 * if partly successful or a specific X509 or PEM error code
202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200203int mbedtls_x509_crt_parse_file( mbedtls_x509_crt *chain, const char *path );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200204
205/**
206 * \brief Load one or more certificate files from a path and add them
207 * to the chained list. Parses permissively. If some
208 * certificates can be parsed, the result is the number
209 * of failed certificates it encountered. If none complete
210 * correctly, the first error is returned.
211 *
212 * \param chain points to the start of the chain
213 * \param path directory / folder to read the certificate files from
214 *
215 * \return 0 if all certificates parsed successfully, a positive number
216 * if partly successful or a specific X509 or PEM error code
217 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200218int mbedtls_x509_crt_parse_path( mbedtls_x509_crt *chain, const char *path );
219#endif /* MBEDTLS_FS_IO */
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200220
221/**
222 * \brief Returns an informational string about the
223 * certificate.
224 *
225 * \param buf Buffer to write to
226 * \param size Maximum size of buffer
227 * \param prefix A line prefix
228 * \param crt The X509 certificate to represent
229 *
Manuel Pégourié-Gonnarde244f9f2015-06-23 12:10:45 +0200230 * \return The length of the string written (not including the
231 * terminated nul byte), or a negative error code.
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200232 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200233int mbedtls_x509_crt_info( char *buf, size_t size, const char *prefix,
234 const mbedtls_x509_crt *crt );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200235
236/**
Manuel Pégourié-Gonnardb5f48ad2015-04-20 10:38:13 +0100237 * \brief Returns an informational string about the
238 * verification status of a certificate.
239 *
240 * \param buf Buffer to write to
241 * \param size Maximum size of buffer
242 * \param prefix A line prefix
243 * \param flags Verification flags created by mbedtls_x509_crt_verify()
244 *
Manuel Pégourié-Gonnarde244f9f2015-06-23 12:10:45 +0200245 * \return The length of the string written (not including the
246 * terminated nul byte), or a negative error code.
Manuel Pégourié-Gonnardb5f48ad2015-04-20 10:38:13 +0100247 */
248int mbedtls_x509_crt_verify_info( char *buf, size_t size, const char *prefix,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200249 uint32_t flags );
Manuel Pégourié-Gonnard39a183a2015-04-17 16:14:32 +0200250
251/**
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200252 * \brief Verify the certificate signature
253 *
254 * The verify callback is a user-supplied callback that
255 * can clear / modify / add flags for a certificate. If set,
256 * the verification callback is called for each
257 * certificate in the chain (from the trust-ca down to the
258 * presented crt). The parameters for the callback are:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200259 * (void *parameter, mbedtls_x509_crt *crt, int certificate_depth,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200260 * int *flags). With the flags representing current flags for
261 * that specific certificate and the certificate depth from
262 * the bottom (Peer cert depth = 0).
263 *
264 * All flags left after returning from the callback
265 * are also returned to the application. The function should
266 * return 0 for anything but a fatal error.
267 *
Manuel Pégourié-Gonnardb5f48ad2015-04-20 10:38:13 +0100268 * \note In case verification failed, the results can be displayed
269 * using \c mbedtls_x509_crt_verify_info()
270 *
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200271 * \note Same as \c mbedtls_x509_crt_verify_with_profile() with the
272 * default security profile.
273 *
Manuel Pégourié-Gonnardeeef9472016-02-22 11:36:55 +0100274 * \note It is your responsibility to provide up-to-date CRLs for
275 * all trusted CAs. If no CRL is provided for the CA that was
276 * used to sign the certificate, CRL verification is skipped
277 * silently, that is *without* setting any flag.
278 *
279 * \param crt a certificate (chain) to be verified
280 * \param trust_ca the list of trusted CAs
281 * \param ca_crl the list of CRLs for trusted CAs (see note above)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200282 * \param cn expected Common Name (can be set to
283 * NULL if the CN must not be verified)
284 * \param flags result of the verification
285 * \param f_vrfy verification function
286 * \param p_vrfy verification parameter
287 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200288 * \return 0 if successful or MBEDTLS_ERR_X509_CERT_VERIFY_FAILED
Manuel Pégourié-Gonnardb5f48ad2015-04-20 10:38:13 +0100289 * in which case *flags will have one or more
290 * MBEDTLS_X509_BADCERT_XXX or MBEDTLS_X509_BADCRL_XXX flags
291 * set,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200292 * or another error in case of a fatal error encountered
293 * during the verification process.
294 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200295int mbedtls_x509_crt_verify( mbedtls_x509_crt *crt,
296 mbedtls_x509_crt *trust_ca,
297 mbedtls_x509_crl *ca_crl,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200298 const char *cn, uint32_t *flags,
299 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerddf26b42013-09-18 13:46:23 +0200300 void *p_vrfy );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200301
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200302/**
303 * \brief Verify the certificate signature according to profile
304 *
305 * \note Same as \c mbedtls_x509_crt_verify(), but with explicit
306 * security profile.
307 *
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +0200308 * \note The restrictions on keys (RSA minimum size, allowed curves
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +0200309 * for ECDSA) apply to all certificates: trusted root,
310 * intermediate CAs if any, and end entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +0200311 *
Manuel Pégourié-Gonnardeeef9472016-02-22 11:36:55 +0100312 * \param crt a certificate (chain) to be verified
313 * \param trust_ca the list of trusted CAs
314 * \param ca_crl the list of CRLs for trusted CAs
Manuel Pégourié-Gonnard95051642015-06-15 10:39:46 +0200315 * \param profile security profile for verification
316 * \param cn expected Common Name (can be set to
317 * NULL if the CN must not be verified)
318 * \param flags result of the verification
319 * \param f_vrfy verification function
320 * \param p_vrfy verification parameter
321 *
322 * \return 0 if successful or MBEDTLS_ERR_X509_CERT_VERIFY_FAILED
323 * in which case *flags will have one or more
324 * MBEDTLS_X509_BADCERT_XXX or MBEDTLS_X509_BADCRL_XXX flags
325 * set,
326 * or another error in case of a fatal error encountered
327 * during the verification process.
328 */
329int mbedtls_x509_crt_verify_with_profile( mbedtls_x509_crt *crt,
330 mbedtls_x509_crt *trust_ca,
331 mbedtls_x509_crl *ca_crl,
332 const mbedtls_x509_crt_profile *profile,
333 const char *cn, uint32_t *flags,
334 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
335 void *p_vrfy );
336
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200337#if defined(MBEDTLS_X509_CHECK_KEY_USAGE)
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +0200338/**
339 * \brief Check usage of certificate against keyUsage extension.
340 *
341 * \param crt Leaf certificate used.
Manuel Pégourié-Gonnard655a9642015-06-23 10:48:44 +0200342 * \param usage Intended usage(s) (eg MBEDTLS_X509_KU_KEY_ENCIPHERMENT
343 * before using the certificate to perform an RSA key
344 * exchange).
345 *
346 * \note Except for decipherOnly and encipherOnly, a bit set in the
347 * usage argument means this bit MUST be set in the
348 * certificate. For decipherOnly and encipherOnly, it means
349 * that bit MAY be set.
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +0200350 *
351 * \return 0 is these uses of the certificate are allowed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200352 * MBEDTLS_ERR_X509_BAD_INPUT_DATA if the keyUsage extension
Manuel Pégourié-Gonnard655a9642015-06-23 10:48:44 +0200353 * is present but does not match the usage argument.
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +0200354 *
355 * \note You should only call this function on leaf certificates, on
356 * (intermediate) CAs the keyUsage extension is automatically
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200357 * checked by \c mbedtls_x509_crt_verify().
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +0200358 */
Manuel Pégourié-Gonnard655a9642015-06-23 10:48:44 +0200359int mbedtls_x509_crt_check_key_usage( const mbedtls_x509_crt *crt,
360 unsigned int usage );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200361#endif /* MBEDTLS_X509_CHECK_KEY_USAGE) */
Manuel Pégourié-Gonnard603116c2014-04-09 09:50:03 +0200362
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200363#if defined(MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE)
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +0200364/**
365 * \brief Check usage of certificate against extentedJeyUsage.
366 *
367 * \param crt Leaf certificate used.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200368 * \param usage_oid Intended usage (eg MBEDTLS_OID_SERVER_AUTH or MBEDTLS_OID_CLIENT_AUTH).
369 * \param usage_len Length of usage_oid (eg given by MBEDTLS_OID_SIZE()).
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +0200370 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +0200371 * \return 0 if this use of the certificate is allowed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200372 * MBEDTLS_ERR_X509_BAD_INPUT_DATA if not.
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +0200373 *
374 * \note Usually only makes sense on leaf certificates.
375 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200376int mbedtls_x509_crt_check_extended_key_usage( const mbedtls_x509_crt *crt,
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +0200377 const char *usage_oid,
378 size_t usage_len );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200379#endif /* MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE) */
Manuel Pégourié-Gonnard7afb8a02014-04-10 17:53:56 +0200380
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200381#if defined(MBEDTLS_X509_CRL_PARSE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200382/**
Manuel Pégourié-Gonnardcbf3ef32013-09-23 12:20:02 +0200383 * \brief Verify the certificate revocation status
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200384 *
385 * \param crt a certificate to be verified
386 * \param crl the CRL to verify against
387 *
388 * \return 1 if the certificate is revoked, 0 otherwise
389 *
390 */
Manuel Pégourié-Gonnardc730ed32015-06-02 10:38:50 +0100391int mbedtls_x509_crt_is_revoked( const mbedtls_x509_crt *crt, const mbedtls_x509_crl *crl );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392#endif /* MBEDTLS_X509_CRL_PARSE_C */
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200393
394/**
Paul Bakker369d2eb2013-09-18 11:58:25 +0200395 * \brief Initialize a certificate (chain)
396 *
397 * \param crt Certificate chain to initialize
398 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200399void mbedtls_x509_crt_init( mbedtls_x509_crt *crt );
Paul Bakker369d2eb2013-09-18 11:58:25 +0200400
401/**
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200402 * \brief Unallocate all certificate data
403 *
404 * \param crt Certificate chain to free
405 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200406void mbedtls_x509_crt_free( mbedtls_x509_crt *crt );
407#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200408
409/* \} name */
410/* \} addtogroup x509_module */
411
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200412#if defined(MBEDTLS_X509_CRT_WRITE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200413/**
414 * \brief Initialize a CRT writing context
415 *
416 * \param ctx CRT context to initialize
417 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200418void mbedtls_x509write_crt_init( mbedtls_x509write_cert *ctx );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200419
420/**
421 * \brief Set the verion for a Certificate
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200422 * Default: MBEDTLS_X509_CRT_VERSION_3
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200423 *
424 * \param ctx CRT context to use
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200425 * \param version version to set (MBEDTLS_X509_CRT_VERSION_1, MBEDTLS_X509_CRT_VERSION_2 or
426 * MBEDTLS_X509_CRT_VERSION_3)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200427 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200428void mbedtls_x509write_crt_set_version( mbedtls_x509write_cert *ctx, int version );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200429
430/**
431 * \brief Set the serial number for a Certificate.
432 *
433 * \param ctx CRT context to use
434 * \param serial serial number to set
435 *
436 * \return 0 if successful
437 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200438int mbedtls_x509write_crt_set_serial( mbedtls_x509write_cert *ctx, const mbedtls_mpi *serial );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200439
440/**
441 * \brief Set the validity period for a Certificate
442 * Timestamps should be in string format for UTC timezone
443 * i.e. "YYYYMMDDhhmmss"
444 * e.g. "20131231235959" for December 31st 2013
445 * at 23:59:59
446 *
447 * \param ctx CRT context to use
448 * \param not_before not_before timestamp
449 * \param not_after not_after timestamp
450 *
451 * \return 0 if timestamp was parsed successfully, or
452 * a specific error code
453 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200454int mbedtls_x509write_crt_set_validity( mbedtls_x509write_cert *ctx, const char *not_before,
Paul Bakker50dc8502013-10-28 21:19:10 +0100455 const char *not_after );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200456
457/**
458 * \brief Set the issuer name for a Certificate
459 * Issuer names should contain a comma-separated list
460 * of OID types and values:
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000461 * e.g. "C=UK,O=ARM,CN=mbed TLS CA"
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200462 *
463 * \param ctx CRT context to use
464 * \param issuer_name issuer name to set
465 *
466 * \return 0 if issuer name was parsed successfully, or
467 * a specific error code
468 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200469int mbedtls_x509write_crt_set_issuer_name( mbedtls_x509write_cert *ctx,
Paul Bakker50dc8502013-10-28 21:19:10 +0100470 const char *issuer_name );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200471
472/**
473 * \brief Set the subject name for a Certificate
474 * Subject names should contain a comma-separated list
475 * of OID types and values:
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000476 * e.g. "C=UK,O=ARM,CN=mbed TLS Server 1"
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200477 *
478 * \param ctx CRT context to use
479 * \param subject_name subject name to set
480 *
481 * \return 0 if subject name was parsed successfully, or
482 * a specific error code
483 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200484int mbedtls_x509write_crt_set_subject_name( mbedtls_x509write_cert *ctx,
Paul Bakker50dc8502013-10-28 21:19:10 +0100485 const char *subject_name );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200486
487/**
488 * \brief Set the subject public key for the certificate
489 *
490 * \param ctx CRT context to use
491 * \param key public key to include
492 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200493void mbedtls_x509write_crt_set_subject_key( mbedtls_x509write_cert *ctx, mbedtls_pk_context *key );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200494
495/**
496 * \brief Set the issuer key used for signing the certificate
497 *
498 * \param ctx CRT context to use
499 * \param key private key to sign with
500 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200501void mbedtls_x509write_crt_set_issuer_key( mbedtls_x509write_cert *ctx, mbedtls_pk_context *key );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200502
503/**
504 * \brief Set the MD algorithm to use for the signature
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200505 * (e.g. MBEDTLS_MD_SHA1)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200506 *
507 * \param ctx CRT context to use
Paul Bakkera36d23e2013-12-30 17:57:27 +0100508 * \param md_alg MD algorithm to use
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200509 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200510void mbedtls_x509write_crt_set_md_alg( mbedtls_x509write_cert *ctx, mbedtls_md_type_t md_alg );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200511
512/**
513 * \brief Generic function to add to or replace an extension in the
514 * CRT
515 *
516 * \param ctx CRT context to use
517 * \param oid OID of the extension
518 * \param oid_len length of the OID
519 * \param critical if the extension is critical (per the RFC's definition)
520 * \param val value of the extension OCTET STRING
521 * \param val_len length of the value data
522 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200523 * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200524 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200525int mbedtls_x509write_crt_set_extension( mbedtls_x509write_cert *ctx,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200526 const char *oid, size_t oid_len,
527 int critical,
528 const unsigned char *val, size_t val_len );
529
530/**
531 * \brief Set the basicConstraints extension for a CRT
532 *
533 * \param ctx CRT context to use
534 * \param is_ca is this a CA certificate
535 * \param max_pathlen maximum length of certificate chains below this
536 * certificate (only for CA certificates, -1 is
537 * inlimited)
538 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200539 * \return 0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200540 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200541int mbedtls_x509write_crt_set_basic_constraints( mbedtls_x509write_cert *ctx,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200542 int is_ca, int max_pathlen );
543
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544#if defined(MBEDTLS_SHA1_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200545/**
546 * \brief Set the subjectKeyIdentifier extension for a CRT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200547 * Requires that mbedtls_x509write_crt_set_subject_key() has been
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200548 * called before
549 *
550 * \param ctx CRT context to use
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_subject_key_identifier( mbedtls_x509write_cert *ctx );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200555
556/**
557 * \brief Set the authorityKeyIdentifier extension for a CRT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200558 * Requires that mbedtls_x509write_crt_set_issuer_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_authority_key_identifier( mbedtls_x509write_cert *ctx );
566#endif /* MBEDTLS_SHA1_C */
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200567
568/**
569 * \brief Set the Key Usage Extension flags
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200570 * (e.g. MBEDTLS_X509_KU_DIGITAL_SIGNATURE | MBEDTLS_X509_KU_KEY_CERT_SIGN)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200571 *
572 * \param ctx CRT context to use
573 * \param key_usage key usage flags to set
574 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200575 * \return 0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200576 */
Manuel Pégourié-Gonnard1cd10ad2015-06-23 11:07:37 +0200577int mbedtls_x509write_crt_set_key_usage( mbedtls_x509write_cert *ctx,
578 unsigned int key_usage );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200579
580/**
581 * \brief Set the Netscape Cert Type flags
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200582 * (e.g. MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT | MBEDTLS_X509_NS_CERT_TYPE_EMAIL)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200583 *
584 * \param ctx CRT context to use
585 * \param ns_cert_type Netscape Cert Type flags to set
586 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200587 * \return 0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200588 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200589int mbedtls_x509write_crt_set_ns_cert_type( mbedtls_x509write_cert *ctx,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200590 unsigned char ns_cert_type );
591
592/**
593 * \brief Free the contents of a CRT write context
594 *
595 * \param ctx CRT context to free
596 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200597void mbedtls_x509write_crt_free( mbedtls_x509write_cert *ctx );
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200598
599/**
600 * \brief Write a built up certificate to a X509 DER structure
601 * Note: data is written at the end of the buffer! Use the
602 * return value to determine where you should start
603 * using the buffer
604 *
Paul Bakkera36d23e2013-12-30 17:57:27 +0100605 * \param ctx certificate to write away
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200606 * \param buf buffer to write to
607 * \param size size of the buffer
608 * \param f_rng RNG function (for signature, see note)
609 * \param p_rng RNG parameter
610 *
611 * \return length of data written if successful, or a specific
612 * error code
613 *
614 * \note f_rng may be NULL if RSA is used for signature and the
615 * signature is made offline (otherwise f_rng is desirable
616 * for countermeasures against timing attacks).
617 * ECDSA signatures always require a non-NULL f_rng.
618 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200619int mbedtls_x509write_crt_der( mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200620 int (*f_rng)(void *, unsigned char *, size_t),
621 void *p_rng );
622
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200623#if defined(MBEDTLS_PEM_WRITE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200624/**
625 * \brief Write a built up certificate to a X509 PEM string
626 *
Paul Bakkera36d23e2013-12-30 17:57:27 +0100627 * \param ctx certificate to write away
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200628 * \param buf buffer to write to
629 * \param size size of the buffer
630 * \param f_rng RNG function (for signature, see note)
631 * \param p_rng RNG parameter
632 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +0200633 * \return 0 if successful, or a specific error code
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200634 *
635 * \note f_rng may be NULL if RSA is used for signature and the
636 * signature is made offline (otherwise f_rng is desirable
637 * for countermeasures against timing attacks).
638 * ECDSA signatures always require a non-NULL f_rng.
639 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200640int mbedtls_x509write_crt_pem( mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size,
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200641 int (*f_rng)(void *, unsigned char *, size_t),
642 void *p_rng );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200643#endif /* MBEDTLS_PEM_WRITE_C */
644#endif /* MBEDTLS_X509_CRT_WRITE_C */
Paul Bakker7c6b2c32013-09-16 13:49:26 +0200645
646#ifdef __cplusplus
647}
648#endif
649
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200650#endif /* mbedtls_x509_crt.h */