| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 1 | /** | 
| Simon Butcher | a02fe7c | 2016-01-03 16:14:14 +0000 | [diff] [blame] | 2 | * \file x509_crt.h | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 3 | * | 
|  | 4 | * \brief X.509 certificate parsing and writing | 
|  | 5 | * | 
| Manuel Pégourié-Gonnard | 6fb8187 | 2015-07-27 11:11:48 +0200 | [diff] [blame] | 6 | *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved | 
| Manuel Pégourié-Gonnard | 37ff140 | 2015-09-04 14:21:07 +0200 | [diff] [blame] | 7 | *  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 Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 20 | * | 
| Manuel Pégourié-Gonnard | fe44643 | 2015-03-06 13:17:10 +0000 | [diff] [blame] | 21 | *  This file is part of mbed TLS (https://tls.mbed.org) | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 22 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 23 | #ifndef MBEDTLS_X509_CRT_H | 
|  | 24 | #define MBEDTLS_X509_CRT_H | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 25 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 26 | #if !defined(MBEDTLS_CONFIG_FILE) | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 27 | #include "config.h" | 
| Manuel Pégourié-Gonnard | cef4ad2 | 2014-04-29 12:39:06 +0200 | [diff] [blame] | 28 | #else | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 29 | #include MBEDTLS_CONFIG_FILE | 
| Manuel Pégourié-Gonnard | cef4ad2 | 2014-04-29 12:39:06 +0200 | [diff] [blame] | 30 | #endif | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 31 |  | 
|  | 32 | #include "x509.h" | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 33 | #include "x509_crl.h" | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 34 |  | 
|  | 35 | /** | 
|  | 36 | * \addtogroup x509_module | 
|  | 37 | * \{ | 
|  | 38 | */ | 
|  | 39 |  | 
|  | 40 | #ifdef __cplusplus | 
|  | 41 | extern "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é-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 52 | typedef struct mbedtls_x509_crt | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 53 | { | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 54 | 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 Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 56 |  | 
| Manuel Pégourié-Gonnard | f4e1b64 | 2014-06-19 11:39:46 +0200 | [diff] [blame] | 57 | int version;                /**< The X.509 version. (1=v1, 2=v2, 3=v3) */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 58 | 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 Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 60 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 61 | 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 Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 63 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 64 | mbedtls_x509_name issuer;           /**< The parsed issuer data (named information object). */ | 
|  | 65 | mbedtls_x509_name subject;          /**< The parsed subject data (named information object). */ | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 66 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 67 | mbedtls_x509_time valid_from;       /**< Start time of certificate validity. */ | 
|  | 68 | mbedtls_x509_time valid_to;         /**< End time of certificate validity. */ | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 69 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 70 | mbedtls_pk_context pk;              /**< Container for the public key context. */ | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 71 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 72 | 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 Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 76 |  | 
|  | 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é-Gonnard | 1d0ca1a | 2015-03-27 16:50:00 +0100 | [diff] [blame] | 81 | unsigned int key_usage;     /**< Optional key usage extension value: See the values in x509.h */ | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 82 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 83 | mbedtls_x509_sequence ext_key_usage; /**< Optional list of extended key usage OIDs. */ | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 84 |  | 
| Manuel Pégourié-Gonnard | b28487d | 2014-04-01 12:19:09 +0200 | [diff] [blame] | 85 | unsigned char ns_cert_type; /**< Optional Netscape certificate type extension value: See the values in x509.h */ | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 86 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 87 | 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 Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 91 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 92 | struct mbedtls_x509_crt *next;     /**< Next certificate in the CA-chain. */ | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 93 | } | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 94 | mbedtls_x509_crt; | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 95 |  | 
| Manuel Pégourié-Gonnard | 88db5da | 2015-06-15 14:34:59 +0200 | [diff] [blame] | 96 | /** | 
| Manuel Pégourié-Gonnard | f8ea856 | 2015-06-15 15:33:19 +0200 | [diff] [blame] | 97 | * 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é-Gonnard | 88db5da | 2015-06-15 14:34:59 +0200 | [diff] [blame] | 103 | * Security profile for certificate verification. | 
| Manuel Pégourié-Gonnard | 9505164 | 2015-06-15 10:39:46 +0200 | [diff] [blame] | 104 | * | 
| Manuel Pégourié-Gonnard | f8ea856 | 2015-06-15 15:33:19 +0200 | [diff] [blame] | 105 | * All lists are bitfields, built by ORing flags from MBEDTLS_X509_ID_FLAG(). | 
| Manuel Pégourié-Gonnard | 9505164 | 2015-06-15 10:39:46 +0200 | [diff] [blame] | 106 | */ | 
|  | 107 | typedef struct | 
|  | 108 | { | 
| Manuel Pégourié-Gonnard | f8ea856 | 2015-06-15 15:33:19 +0200 | [diff] [blame] | 109 | 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é-Gonnard | 9505164 | 2015-06-15 10:39:46 +0200 | [diff] [blame] | 113 | } | 
|  | 114 | mbedtls_x509_crt_profile; | 
|  | 115 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 116 | #define MBEDTLS_X509_CRT_VERSION_1              0 | 
|  | 117 | #define MBEDTLS_X509_CRT_VERSION_2              1 | 
|  | 118 | #define MBEDTLS_X509_CRT_VERSION_3              2 | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 119 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 120 | #define MBEDTLS_X509_RFC5280_MAX_SERIAL_LEN 32 | 
|  | 121 | #define MBEDTLS_X509_RFC5280_UTC_TIME_LEN   15 | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 122 |  | 
|  | 123 | /** | 
|  | 124 | * Container for writing a certificate (CRT) | 
|  | 125 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 126 | typedef struct mbedtls_x509write_cert | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 127 | { | 
|  | 128 | int version; | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 129 | 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 Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 138 | } | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 139 | mbedtls_x509write_cert; | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 140 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 141 | #if defined(MBEDTLS_X509_CRT_PARSE_C) | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 142 | /** | 
| Manuel Pégourié-Gonnard | 88db5da | 2015-06-15 14:34:59 +0200 | [diff] [blame] | 143 | * Default security profile. Should provide a good balance between security | 
|  | 144 | * and compatibility with current deployments. | 
|  | 145 | */ | 
|  | 146 | extern 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 | */ | 
|  | 152 | extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_next; | 
|  | 153 |  | 
|  | 154 | /** | 
|  | 155 | * NSA Suite B profile. | 
|  | 156 | */ | 
|  | 157 | extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_suiteb; | 
|  | 158 |  | 
|  | 159 | /** | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 160 | * \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é-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 169 | int mbedtls_x509_crt_parse_der( mbedtls_x509_crt *chain, const unsigned char *buf, | 
| Paul Bakker | ddf26b4 | 2013-09-18 13:46:23 +0200 | [diff] [blame] | 170 | size_t buflen ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 171 |  | 
|  | 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é-Gonnard | 43b37cb | 2015-05-12 11:20:10 +0200 | [diff] [blame] | 180 | * \param buf      buffer holding the certificate data in PEM or DER format | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 181 | * \param buflen   size of the buffer | 
| Manuel Pégourié-Gonnard | 43b37cb | 2015-05-12 11:20:10 +0200 | [diff] [blame] | 182 | *                 (including the terminating null byte for PEM data) | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 183 | * | 
|  | 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é-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 187 | int mbedtls_x509_crt_parse( mbedtls_x509_crt *chain, const unsigned char *buf, size_t buflen ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 188 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 189 | #if defined(MBEDTLS_FS_IO) | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 190 | /** | 
|  | 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é-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 203 | int mbedtls_x509_crt_parse_file( mbedtls_x509_crt *chain, const char *path ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 204 |  | 
|  | 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é-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 218 | int mbedtls_x509_crt_parse_path( mbedtls_x509_crt *chain, const char *path ); | 
|  | 219 | #endif /* MBEDTLS_FS_IO */ | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 220 |  | 
|  | 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é-Gonnard | e244f9f | 2015-06-23 12:10:45 +0200 | [diff] [blame] | 230 | * \return         The length of the string written (not including the | 
|  | 231 | *                 terminated nul byte), or a negative error code. | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 232 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 233 | int mbedtls_x509_crt_info( char *buf, size_t size, const char *prefix, | 
|  | 234 | const mbedtls_x509_crt *crt ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 235 |  | 
|  | 236 | /** | 
| Manuel Pégourié-Gonnard | b5f48ad | 2015-04-20 10:38:13 +0100 | [diff] [blame] | 237 | * \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é-Gonnard | e244f9f | 2015-06-23 12:10:45 +0200 | [diff] [blame] | 245 | * \return         The length of the string written (not including the | 
|  | 246 | *                 terminated nul byte), or a negative error code. | 
| Manuel Pégourié-Gonnard | b5f48ad | 2015-04-20 10:38:13 +0100 | [diff] [blame] | 247 | */ | 
|  | 248 | int mbedtls_x509_crt_verify_info( char *buf, size_t size, const char *prefix, | 
| Manuel Pégourié-Gonnard | e6ef16f | 2015-05-11 19:54:43 +0200 | [diff] [blame] | 249 | uint32_t flags ); | 
| Manuel Pégourié-Gonnard | 39a183a | 2015-04-17 16:14:32 +0200 | [diff] [blame] | 250 |  | 
|  | 251 | /** | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 252 | * \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é-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 259 | *                 (void *parameter, mbedtls_x509_crt *crt, int certificate_depth, | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 260 | *                 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 | 
| Manuel Pégourié-Gonnard | c386317 | 2017-06-26 10:11:49 +0200 | [diff] [blame] | 266 | *                 return 0 for anything (including invalid certificates) | 
|  | 267 | *                 other than fatal error, as a non-zero return code | 
|  | 268 | *                 immediately aborts the verification process. For fatal | 
|  | 269 | *                 errors, a specific error code should be used (different | 
|  | 270 | *                 from MBEDTLS_ERR_X509_CERT_VERIFY_FAILED which should not | 
|  | 271 | *                 be returned at this point), or MBEDTLS_ERR_X509_FATAL_ERROR | 
|  | 272 | *                 can be used if no better code is available. | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 273 | * | 
| Manuel Pégourié-Gonnard | b5f48ad | 2015-04-20 10:38:13 +0100 | [diff] [blame] | 274 | * \note           In case verification failed, the results can be displayed | 
|  | 275 | *                 using \c mbedtls_x509_crt_verify_info() | 
|  | 276 | * | 
| Manuel Pégourié-Gonnard | 9505164 | 2015-06-15 10:39:46 +0200 | [diff] [blame] | 277 | * \note           Same as \c mbedtls_x509_crt_verify_with_profile() with the | 
|  | 278 | *                 default security profile. | 
|  | 279 | * | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 280 | * \param crt      a certificate to be verified | 
|  | 281 | * \param trust_ca the trusted CA chain | 
|  | 282 | * \param ca_crl   the CRL chain for trusted CA's | 
|  | 283 | * \param cn       expected Common Name (can be set to | 
|  | 284 | *                 NULL if the CN must not be verified) | 
|  | 285 | * \param flags    result of the verification | 
|  | 286 | * \param f_vrfy   verification function | 
|  | 287 | * \param p_vrfy   verification parameter | 
|  | 288 | * | 
| Manuel Pégourié-Gonnard | f2269b0 | 2017-07-06 15:00:32 +0200 | [diff] [blame] | 289 | * \return         0 (and flags set to 0) if the chain was verified and valid, | 
|  | 290 | *                 MBEDTLS_ERR_X509_CERT_VERIFY_FAILED if the chain was verified | 
|  | 291 | *                 but found to be invalid, in which case *flags will have one | 
|  | 292 | *                 or more MBEDTLS_X509_BADCERT_XXX or MBEDTLS_X509_BADCRL_XXX | 
|  | 293 | *                 flags set, or another error (and flags set to 0xffffffff) | 
|  | 294 | *                 in case of a fatal error encountered during the | 
|  | 295 | *                 verification process. | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 296 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 297 | int mbedtls_x509_crt_verify( mbedtls_x509_crt *crt, | 
|  | 298 | mbedtls_x509_crt *trust_ca, | 
|  | 299 | mbedtls_x509_crl *ca_crl, | 
| Manuel Pégourié-Gonnard | e6ef16f | 2015-05-11 19:54:43 +0200 | [diff] [blame] | 300 | const char *cn, uint32_t *flags, | 
|  | 301 | int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *), | 
| Paul Bakker | ddf26b4 | 2013-09-18 13:46:23 +0200 | [diff] [blame] | 302 | void *p_vrfy ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 303 |  | 
| Manuel Pégourié-Gonnard | 9505164 | 2015-06-15 10:39:46 +0200 | [diff] [blame] | 304 | /** | 
|  | 305 | * \brief          Verify the certificate signature according to profile | 
|  | 306 | * | 
|  | 307 | * \note           Same as \c mbedtls_x509_crt_verify(), but with explicit | 
|  | 308 | *                 security profile. | 
|  | 309 | * | 
| Manuel Pégourié-Gonnard | 27716cc | 2015-06-17 11:49:39 +0200 | [diff] [blame] | 310 | * \note           The restrictions on keys (RSA minimum size, allowed curves | 
| Manuel Pégourié-Gonnard | 93080df | 2015-10-23 14:08:48 +0200 | [diff] [blame] | 311 | *                 for ECDSA) apply to all certificates: trusted root, | 
|  | 312 | *                 intermediate CAs if any, and end entity certificate. | 
| Manuel Pégourié-Gonnard | 27716cc | 2015-06-17 11:49:39 +0200 | [diff] [blame] | 313 | * | 
| Manuel Pégourié-Gonnard | 9505164 | 2015-06-15 10:39:46 +0200 | [diff] [blame] | 314 | * \param crt      a certificate to be verified | 
|  | 315 | * \param trust_ca the trusted CA chain | 
|  | 316 | * \param ca_crl   the CRL chain for trusted CA's | 
|  | 317 | * \param profile  security profile for verification | 
|  | 318 | * \param cn       expected Common Name (can be set to | 
|  | 319 | *                 NULL if the CN must not be verified) | 
|  | 320 | * \param flags    result of the verification | 
|  | 321 | * \param f_vrfy   verification function | 
|  | 322 | * \param p_vrfy   verification parameter | 
|  | 323 | * | 
|  | 324 | * \return         0 if successful or MBEDTLS_ERR_X509_CERT_VERIFY_FAILED | 
|  | 325 | *                 in which case *flags will have one or more | 
|  | 326 | *                 MBEDTLS_X509_BADCERT_XXX or MBEDTLS_X509_BADCRL_XXX flags | 
|  | 327 | *                 set, | 
|  | 328 | *                 or another error in case of a fatal error encountered | 
|  | 329 | *                 during the verification process. | 
|  | 330 | */ | 
|  | 331 | int mbedtls_x509_crt_verify_with_profile( mbedtls_x509_crt *crt, | 
|  | 332 | mbedtls_x509_crt *trust_ca, | 
|  | 333 | mbedtls_x509_crl *ca_crl, | 
|  | 334 | const mbedtls_x509_crt_profile *profile, | 
|  | 335 | const char *cn, uint32_t *flags, | 
|  | 336 | int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *), | 
|  | 337 | void *p_vrfy ); | 
|  | 338 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 339 | #if defined(MBEDTLS_X509_CHECK_KEY_USAGE) | 
| Manuel Pégourié-Gonnard | 603116c | 2014-04-09 09:50:03 +0200 | [diff] [blame] | 340 | /** | 
|  | 341 | * \brief          Check usage of certificate against keyUsage extension. | 
|  | 342 | * | 
|  | 343 | * \param crt      Leaf certificate used. | 
| Manuel Pégourié-Gonnard | 655a964 | 2015-06-23 10:48:44 +0200 | [diff] [blame] | 344 | * \param usage    Intended usage(s) (eg MBEDTLS_X509_KU_KEY_ENCIPHERMENT | 
|  | 345 | *                 before using the certificate to perform an RSA key | 
|  | 346 | *                 exchange). | 
|  | 347 | * | 
|  | 348 | * \note           Except for decipherOnly and encipherOnly, a bit set in the | 
|  | 349 | *                 usage argument means this bit MUST be set in the | 
|  | 350 | *                 certificate. For decipherOnly and encipherOnly, it means | 
|  | 351 | *                 that bit MAY be set. | 
| Manuel Pégourié-Gonnard | 603116c | 2014-04-09 09:50:03 +0200 | [diff] [blame] | 352 | * | 
|  | 353 | * \return         0 is these uses of the certificate are allowed, | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 354 | *                 MBEDTLS_ERR_X509_BAD_INPUT_DATA if the keyUsage extension | 
| Manuel Pégourié-Gonnard | 655a964 | 2015-06-23 10:48:44 +0200 | [diff] [blame] | 355 | *                 is present but does not match the usage argument. | 
| Manuel Pégourié-Gonnard | 603116c | 2014-04-09 09:50:03 +0200 | [diff] [blame] | 356 | * | 
|  | 357 | * \note           You should only call this function on leaf certificates, on | 
|  | 358 | *                 (intermediate) CAs the keyUsage extension is automatically | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 359 | *                 checked by \c mbedtls_x509_crt_verify(). | 
| Manuel Pégourié-Gonnard | 603116c | 2014-04-09 09:50:03 +0200 | [diff] [blame] | 360 | */ | 
| Manuel Pégourié-Gonnard | 655a964 | 2015-06-23 10:48:44 +0200 | [diff] [blame] | 361 | int mbedtls_x509_crt_check_key_usage( const mbedtls_x509_crt *crt, | 
|  | 362 | unsigned int usage ); | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 363 | #endif /* MBEDTLS_X509_CHECK_KEY_USAGE) */ | 
| Manuel Pégourié-Gonnard | 603116c | 2014-04-09 09:50:03 +0200 | [diff] [blame] | 364 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 365 | #if defined(MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE) | 
| Manuel Pégourié-Gonnard | 7afb8a0 | 2014-04-10 17:53:56 +0200 | [diff] [blame] | 366 | /** | 
|  | 367 | * \brief          Check usage of certificate against extentedJeyUsage. | 
|  | 368 | * | 
|  | 369 | * \param crt      Leaf certificate used. | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 370 | * \param usage_oid Intended usage (eg MBEDTLS_OID_SERVER_AUTH or MBEDTLS_OID_CLIENT_AUTH). | 
|  | 371 | * \param usage_len Length of usage_oid (eg given by MBEDTLS_OID_SIZE()). | 
| Manuel Pégourié-Gonnard | 7afb8a0 | 2014-04-10 17:53:56 +0200 | [diff] [blame] | 372 | * | 
| Manuel Pégourié-Gonnard | 81abefd | 2015-05-29 12:53:47 +0200 | [diff] [blame] | 373 | * \return         0 if this use of the certificate is allowed, | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 374 | *                 MBEDTLS_ERR_X509_BAD_INPUT_DATA if not. | 
| Manuel Pégourié-Gonnard | 7afb8a0 | 2014-04-10 17:53:56 +0200 | [diff] [blame] | 375 | * | 
|  | 376 | * \note           Usually only makes sense on leaf certificates. | 
|  | 377 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 378 | int mbedtls_x509_crt_check_extended_key_usage( const mbedtls_x509_crt *crt, | 
| Manuel Pégourié-Gonnard | 7afb8a0 | 2014-04-10 17:53:56 +0200 | [diff] [blame] | 379 | const char *usage_oid, | 
|  | 380 | size_t usage_len ); | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 381 | #endif /* MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE) */ | 
| Manuel Pégourié-Gonnard | 7afb8a0 | 2014-04-10 17:53:56 +0200 | [diff] [blame] | 382 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 383 | #if defined(MBEDTLS_X509_CRL_PARSE_C) | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 384 | /** | 
| Manuel Pégourié-Gonnard | cbf3ef3 | 2013-09-23 12:20:02 +0200 | [diff] [blame] | 385 | * \brief          Verify the certificate revocation status | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 386 | * | 
|  | 387 | * \param crt      a certificate to be verified | 
|  | 388 | * \param crl      the CRL to verify against | 
|  | 389 | * | 
|  | 390 | * \return         1 if the certificate is revoked, 0 otherwise | 
|  | 391 | * | 
|  | 392 | */ | 
| Manuel Pégourié-Gonnard | c730ed3 | 2015-06-02 10:38:50 +0100 | [diff] [blame] | 393 | int mbedtls_x509_crt_is_revoked( const mbedtls_x509_crt *crt, const mbedtls_x509_crl *crl ); | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 394 | #endif /* MBEDTLS_X509_CRL_PARSE_C */ | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 395 |  | 
|  | 396 | /** | 
| Paul Bakker | 369d2eb | 2013-09-18 11:58:25 +0200 | [diff] [blame] | 397 | * \brief          Initialize a certificate (chain) | 
|  | 398 | * | 
|  | 399 | * \param crt      Certificate chain to initialize | 
|  | 400 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 401 | void mbedtls_x509_crt_init( mbedtls_x509_crt *crt ); | 
| Paul Bakker | 369d2eb | 2013-09-18 11:58:25 +0200 | [diff] [blame] | 402 |  | 
|  | 403 | /** | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 404 | * \brief          Unallocate all certificate data | 
|  | 405 | * | 
|  | 406 | * \param crt      Certificate chain to free | 
|  | 407 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 408 | void mbedtls_x509_crt_free( mbedtls_x509_crt *crt ); | 
|  | 409 | #endif /* MBEDTLS_X509_CRT_PARSE_C */ | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 410 |  | 
|  | 411 | /* \} name */ | 
|  | 412 | /* \} addtogroup x509_module */ | 
|  | 413 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 414 | #if defined(MBEDTLS_X509_CRT_WRITE_C) | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 415 | /** | 
|  | 416 | * \brief           Initialize a CRT writing context | 
|  | 417 | * | 
|  | 418 | * \param ctx       CRT context to initialize | 
|  | 419 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 420 | void mbedtls_x509write_crt_init( mbedtls_x509write_cert *ctx ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 421 |  | 
|  | 422 | /** | 
|  | 423 | * \brief           Set the verion for a Certificate | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 424 | *                  Default: MBEDTLS_X509_CRT_VERSION_3 | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 425 | * | 
|  | 426 | * \param ctx       CRT context to use | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 427 | * \param version   version to set (MBEDTLS_X509_CRT_VERSION_1, MBEDTLS_X509_CRT_VERSION_2 or | 
|  | 428 | *                                  MBEDTLS_X509_CRT_VERSION_3) | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 429 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 430 | void mbedtls_x509write_crt_set_version( mbedtls_x509write_cert *ctx, int version ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 431 |  | 
|  | 432 | /** | 
|  | 433 | * \brief           Set the serial number for a Certificate. | 
|  | 434 | * | 
|  | 435 | * \param ctx       CRT context to use | 
|  | 436 | * \param serial    serial number to set | 
|  | 437 | * | 
|  | 438 | * \return          0 if successful | 
|  | 439 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 440 | int mbedtls_x509write_crt_set_serial( mbedtls_x509write_cert *ctx, const mbedtls_mpi *serial ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 441 |  | 
|  | 442 | /** | 
|  | 443 | * \brief           Set the validity period for a Certificate | 
|  | 444 | *                  Timestamps should be in string format for UTC timezone | 
|  | 445 | *                  i.e. "YYYYMMDDhhmmss" | 
|  | 446 | *                  e.g. "20131231235959" for December 31st 2013 | 
|  | 447 | *                       at 23:59:59 | 
|  | 448 | * | 
|  | 449 | * \param ctx       CRT context to use | 
|  | 450 | * \param not_before    not_before timestamp | 
|  | 451 | * \param not_after     not_after timestamp | 
|  | 452 | * | 
|  | 453 | * \return          0 if timestamp was parsed successfully, or | 
|  | 454 | *                  a specific error code | 
|  | 455 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 456 | int mbedtls_x509write_crt_set_validity( mbedtls_x509write_cert *ctx, const char *not_before, | 
| Paul Bakker | 50dc850 | 2013-10-28 21:19:10 +0100 | [diff] [blame] | 457 | const char *not_after ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 458 |  | 
|  | 459 | /** | 
|  | 460 | * \brief           Set the issuer name for a Certificate | 
|  | 461 | *                  Issuer names should contain a comma-separated list | 
|  | 462 | *                  of OID types and values: | 
| Manuel Pégourié-Gonnard | b4fe3cb | 2015-01-22 16:11:05 +0000 | [diff] [blame] | 463 | *                  e.g. "C=UK,O=ARM,CN=mbed TLS CA" | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 464 | * | 
|  | 465 | * \param ctx           CRT context to use | 
|  | 466 | * \param issuer_name   issuer name to set | 
|  | 467 | * | 
|  | 468 | * \return          0 if issuer name was parsed successfully, or | 
|  | 469 | *                  a specific error code | 
|  | 470 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 471 | int mbedtls_x509write_crt_set_issuer_name( mbedtls_x509write_cert *ctx, | 
| Paul Bakker | 50dc850 | 2013-10-28 21:19:10 +0100 | [diff] [blame] | 472 | const char *issuer_name ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 473 |  | 
|  | 474 | /** | 
|  | 475 | * \brief           Set the subject name for a Certificate | 
|  | 476 | *                  Subject names should contain a comma-separated list | 
|  | 477 | *                  of OID types and values: | 
| Manuel Pégourié-Gonnard | b4fe3cb | 2015-01-22 16:11:05 +0000 | [diff] [blame] | 478 | *                  e.g. "C=UK,O=ARM,CN=mbed TLS Server 1" | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 479 | * | 
|  | 480 | * \param ctx           CRT context to use | 
|  | 481 | * \param subject_name  subject name to set | 
|  | 482 | * | 
|  | 483 | * \return          0 if subject name was parsed successfully, or | 
|  | 484 | *                  a specific error code | 
|  | 485 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 486 | int mbedtls_x509write_crt_set_subject_name( mbedtls_x509write_cert *ctx, | 
| Paul Bakker | 50dc850 | 2013-10-28 21:19:10 +0100 | [diff] [blame] | 487 | const char *subject_name ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 488 |  | 
|  | 489 | /** | 
|  | 490 | * \brief           Set the subject public key for the certificate | 
|  | 491 | * | 
|  | 492 | * \param ctx       CRT context to use | 
|  | 493 | * \param key       public key to include | 
|  | 494 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 495 | void mbedtls_x509write_crt_set_subject_key( mbedtls_x509write_cert *ctx, mbedtls_pk_context *key ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 496 |  | 
|  | 497 | /** | 
|  | 498 | * \brief           Set the issuer key used for signing the certificate | 
|  | 499 | * | 
|  | 500 | * \param ctx       CRT context to use | 
|  | 501 | * \param key       private key to sign with | 
|  | 502 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 503 | void mbedtls_x509write_crt_set_issuer_key( mbedtls_x509write_cert *ctx, mbedtls_pk_context *key ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 504 |  | 
|  | 505 | /** | 
|  | 506 | * \brief           Set the MD algorithm to use for the signature | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 507 | *                  (e.g. MBEDTLS_MD_SHA1) | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 508 | * | 
|  | 509 | * \param ctx       CRT context to use | 
| Paul Bakker | a36d23e | 2013-12-30 17:57:27 +0100 | [diff] [blame] | 510 | * \param md_alg    MD algorithm to use | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 511 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 512 | void mbedtls_x509write_crt_set_md_alg( mbedtls_x509write_cert *ctx, mbedtls_md_type_t md_alg ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 513 |  | 
|  | 514 | /** | 
|  | 515 | * \brief           Generic function to add to or replace an extension in the | 
|  | 516 | *                  CRT | 
|  | 517 | * | 
|  | 518 | * \param ctx       CRT context to use | 
|  | 519 | * \param oid       OID of the extension | 
|  | 520 | * \param oid_len   length of the OID | 
|  | 521 | * \param critical  if the extension is critical (per the RFC's definition) | 
|  | 522 | * \param val       value of the extension OCTET STRING | 
|  | 523 | * \param val_len   length of the value data | 
|  | 524 | * | 
| Manuel Pégourié-Gonnard | 6a8ca33 | 2015-05-28 09:33:39 +0200 | [diff] [blame] | 525 | * \return          0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 526 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 527 | int mbedtls_x509write_crt_set_extension( mbedtls_x509write_cert *ctx, | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 528 | const char *oid, size_t oid_len, | 
|  | 529 | int critical, | 
|  | 530 | const unsigned char *val, size_t val_len ); | 
|  | 531 |  | 
|  | 532 | /** | 
|  | 533 | * \brief           Set the basicConstraints extension for a CRT | 
|  | 534 | * | 
|  | 535 | * \param ctx       CRT context to use | 
|  | 536 | * \param is_ca     is this a CA certificate | 
|  | 537 | * \param max_pathlen   maximum length of certificate chains below this | 
|  | 538 | *                      certificate (only for CA certificates, -1 is | 
|  | 539 | *                      inlimited) | 
|  | 540 | * | 
| Manuel Pégourié-Gonnard | 6a8ca33 | 2015-05-28 09:33:39 +0200 | [diff] [blame] | 541 | * \return          0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 542 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 543 | int mbedtls_x509write_crt_set_basic_constraints( mbedtls_x509write_cert *ctx, | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 544 | int is_ca, int max_pathlen ); | 
|  | 545 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 546 | #if defined(MBEDTLS_SHA1_C) | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 547 | /** | 
|  | 548 | * \brief           Set the subjectKeyIdentifier extension for a CRT | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 549 | *                  Requires that mbedtls_x509write_crt_set_subject_key() has been | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 550 | *                  called before | 
|  | 551 | * | 
|  | 552 | * \param ctx       CRT context to use | 
|  | 553 | * | 
| Manuel Pégourié-Gonnard | 6a8ca33 | 2015-05-28 09:33:39 +0200 | [diff] [blame] | 554 | * \return          0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 555 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 556 | int mbedtls_x509write_crt_set_subject_key_identifier( mbedtls_x509write_cert *ctx ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 557 |  | 
|  | 558 | /** | 
|  | 559 | * \brief           Set the authorityKeyIdentifier extension for a CRT | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 560 | *                  Requires that mbedtls_x509write_crt_set_issuer_key() has been | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 561 | *                  called before | 
|  | 562 | * | 
|  | 563 | * \param ctx       CRT context to use | 
|  | 564 | * | 
| Manuel Pégourié-Gonnard | 6a8ca33 | 2015-05-28 09:33:39 +0200 | [diff] [blame] | 565 | * \return          0 if successful, or a MBEDTLS_ERR_X509_ALLOC_FAILED | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 566 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 567 | int mbedtls_x509write_crt_set_authority_key_identifier( mbedtls_x509write_cert *ctx ); | 
|  | 568 | #endif /* MBEDTLS_SHA1_C */ | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 569 |  | 
|  | 570 | /** | 
|  | 571 | * \brief           Set the Key Usage Extension flags | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 572 | *                  (e.g. MBEDTLS_X509_KU_DIGITAL_SIGNATURE | MBEDTLS_X509_KU_KEY_CERT_SIGN) | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 573 | * | 
|  | 574 | * \param ctx       CRT context to use | 
|  | 575 | * \param key_usage key usage flags to set | 
|  | 576 | * | 
| Manuel Pégourié-Gonnard | 6a8ca33 | 2015-05-28 09:33:39 +0200 | [diff] [blame] | 577 | * \return          0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 578 | */ | 
| Manuel Pégourié-Gonnard | 1cd10ad | 2015-06-23 11:07:37 +0200 | [diff] [blame] | 579 | int mbedtls_x509write_crt_set_key_usage( mbedtls_x509write_cert *ctx, | 
|  | 580 | unsigned int key_usage ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 581 |  | 
|  | 582 | /** | 
|  | 583 | * \brief           Set the Netscape Cert Type flags | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 584 | *                  (e.g. MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT | MBEDTLS_X509_NS_CERT_TYPE_EMAIL) | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 585 | * | 
|  | 586 | * \param ctx           CRT context to use | 
|  | 587 | * \param ns_cert_type  Netscape Cert Type flags to set | 
|  | 588 | * | 
| Manuel Pégourié-Gonnard | 6a8ca33 | 2015-05-28 09:33:39 +0200 | [diff] [blame] | 589 | * \return          0 if successful, or MBEDTLS_ERR_X509_ALLOC_FAILED | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 590 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 591 | int mbedtls_x509write_crt_set_ns_cert_type( mbedtls_x509write_cert *ctx, | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 592 | unsigned char ns_cert_type ); | 
|  | 593 |  | 
|  | 594 | /** | 
|  | 595 | * \brief           Free the contents of a CRT write context | 
|  | 596 | * | 
|  | 597 | * \param ctx       CRT context to free | 
|  | 598 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 599 | void mbedtls_x509write_crt_free( mbedtls_x509write_cert *ctx ); | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 600 |  | 
|  | 601 | /** | 
|  | 602 | * \brief           Write a built up certificate to a X509 DER structure | 
|  | 603 | *                  Note: data is written at the end of the buffer! Use the | 
|  | 604 | *                        return value to determine where you should start | 
|  | 605 | *                        using the buffer | 
|  | 606 | * | 
| Paul Bakker | a36d23e | 2013-12-30 17:57:27 +0100 | [diff] [blame] | 607 | * \param ctx       certificate to write away | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 608 | * \param buf       buffer to write to | 
|  | 609 | * \param size      size of the buffer | 
|  | 610 | * \param f_rng     RNG function (for signature, see note) | 
|  | 611 | * \param p_rng     RNG parameter | 
|  | 612 | * | 
|  | 613 | * \return          length of data written if successful, or a specific | 
|  | 614 | *                  error code | 
|  | 615 | * | 
|  | 616 | * \note            f_rng may be NULL if RSA is used for signature and the | 
|  | 617 | *                  signature is made offline (otherwise f_rng is desirable | 
|  | 618 | *                  for countermeasures against timing attacks). | 
|  | 619 | *                  ECDSA signatures always require a non-NULL f_rng. | 
|  | 620 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 621 | int mbedtls_x509write_crt_der( mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size, | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 622 | int (*f_rng)(void *, unsigned char *, size_t), | 
|  | 623 | void *p_rng ); | 
|  | 624 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 625 | #if defined(MBEDTLS_PEM_WRITE_C) | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 626 | /** | 
|  | 627 | * \brief           Write a built up certificate to a X509 PEM string | 
|  | 628 | * | 
| Paul Bakker | a36d23e | 2013-12-30 17:57:27 +0100 | [diff] [blame] | 629 | * \param ctx       certificate to write away | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 630 | * \param buf       buffer to write to | 
|  | 631 | * \param size      size of the buffer | 
|  | 632 | * \param f_rng     RNG function (for signature, see note) | 
|  | 633 | * \param p_rng     RNG parameter | 
|  | 634 | * | 
| Manuel Pégourié-Gonnard | 81abefd | 2015-05-29 12:53:47 +0200 | [diff] [blame] | 635 | * \return          0 if successful, or a specific error code | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 636 | * | 
|  | 637 | * \note            f_rng may be NULL if RSA is used for signature and the | 
|  | 638 | *                  signature is made offline (otherwise f_rng is desirable | 
|  | 639 | *                  for countermeasures against timing attacks). | 
|  | 640 | *                  ECDSA signatures always require a non-NULL f_rng. | 
|  | 641 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 642 | int mbedtls_x509write_crt_pem( mbedtls_x509write_cert *ctx, unsigned char *buf, size_t size, | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 643 | int (*f_rng)(void *, unsigned char *, size_t), | 
|  | 644 | void *p_rng ); | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 645 | #endif /* MBEDTLS_PEM_WRITE_C */ | 
|  | 646 | #endif /* MBEDTLS_X509_CRT_WRITE_C */ | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 647 |  | 
|  | 648 | #ifdef __cplusplus | 
|  | 649 | } | 
|  | 650 | #endif | 
|  | 651 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 652 | #endif /* mbedtls_x509_crt.h */ |