1 /** 2 * \file x509.h 3 * 4 * \brief X.509 generic defines and structures 5 * 6 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved 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. 20 * 21 * This file is part of mbed TLS (https://tls.mbed.org) 22 */ 23 #ifndef MBEDTLS_X509_H 24 #define MBEDTLS_X509_H 25 26 #if !defined(MBEDTLS_CONFIG_FILE) 27 #include "config.h" 28 #else 29 #include MBEDTLS_CONFIG_FILE 30 #endif 31 32 #include "asn1.h" 33 #include "pk.h" 34 35 #if defined(MBEDTLS_RSA_C) 36 #include "rsa.h" 37 #endif 38 39 /** 40 * \addtogroup x509_module 41 * \{ 42 */ 43 44 #if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA) 45 /** 46 * Maximum number of intermediate CAs in a verification chain. 47 * That is, maximum length of the chain, excluding the end-entity certificate 48 * and the trusted root certificate. 49 * 50 * Set this to a low value to prevent an adversary from making you waste 51 * resources verifying an overlong certificate chain. 52 */ 53 #define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 54 #endif 55 56 /** 57 * \name X509 Error codes 58 * \{ 59 */ 60 #define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE -0x2080 /**< Unavailable feature, e.g. RSA hashing/encryption combination. */ 61 #define MBEDTLS_ERR_X509_UNKNOWN_OID -0x2100 /**< Requested OID is unknown. */ 62 #define MBEDTLS_ERR_X509_INVALID_FORMAT -0x2180 /**< The CRT/CRL/CSR format is invalid, e.g. different type expected. */ 63 #define MBEDTLS_ERR_X509_INVALID_VERSION -0x2200 /**< The CRT/CRL/CSR version element is invalid. */ 64 #define MBEDTLS_ERR_X509_INVALID_SERIAL -0x2280 /**< The serial tag or value is invalid. */ 65 #define MBEDTLS_ERR_X509_INVALID_ALG -0x2300 /**< The algorithm tag or value is invalid. */ 66 #define MBEDTLS_ERR_X509_INVALID_NAME -0x2380 /**< The name tag or value is invalid. */ 67 #define MBEDTLS_ERR_X509_INVALID_DATE -0x2400 /**< The date tag or value is invalid. */ 68 #define MBEDTLS_ERR_X509_INVALID_SIGNATURE -0x2480 /**< The signature tag or value invalid. */ 69 #define MBEDTLS_ERR_X509_INVALID_EXTENSIONS -0x2500 /**< The extension tag or value is invalid. */ 70 #define MBEDTLS_ERR_X509_UNKNOWN_VERSION -0x2580 /**< CRT/CRL/CSR has an unsupported version number. */ 71 #define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG -0x2600 /**< Signature algorithm (oid) is unsupported. */ 72 #define MBEDTLS_ERR_X509_SIG_MISMATCH -0x2680 /**< Signature algorithms do not match. (see \c ::mbedtls_x509_crt sig_oid) */ 73 #define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED -0x2700 /**< Certificate verification failed, e.g. CRL, CA or signature check failed. */ 74 #define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT -0x2780 /**< Format not recognized as DER or PEM. */ 75 #define MBEDTLS_ERR_X509_BAD_INPUT_DATA -0x2800 /**< Input invalid. */ 76 #define MBEDTLS_ERR_X509_ALLOC_FAILED -0x2880 /**< Allocation of memory failed. */ 77 #define MBEDTLS_ERR_X509_FILE_IO_ERROR -0x2900 /**< Read/write of file failed. */ 78 #define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL -0x2980 /**< Destination buffer is too small. */ 79 /* \} name */ 80 81 /** 82 * \name X509 Verify codes 83 * \{ 84 */ 85 /* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */ 86 #define MBEDTLS_X509_BADCERT_EXPIRED 0x01 /**< The certificate validity has expired. */ 87 #define MBEDTLS_X509_BADCERT_REVOKED 0x02 /**< The certificate has been revoked (is on a CRL). */ 88 #define MBEDTLS_X509_BADCERT_CN_MISMATCH 0x04 /**< The certificate Common Name (CN) does not match with the expected CN. */ 89 #define MBEDTLS_X509_BADCERT_NOT_TRUSTED 0x08 /**< The certificate is not correctly signed by the trusted CA. */ 90 #define MBEDTLS_X509_BADCRL_NOT_TRUSTED 0x10 /**< The CRL is not correctly signed by the trusted CA. */ 91 #define MBEDTLS_X509_BADCRL_EXPIRED 0x20 /**< The CRL is expired. */ 92 #define MBEDTLS_X509_BADCERT_MISSING 0x40 /**< Certificate was missing. */ 93 #define MBEDTLS_X509_BADCERT_SKIP_VERIFY 0x80 /**< Certificate verification was skipped. */ 94 #define MBEDTLS_X509_BADCERT_OTHER 0x0100 /**< Other reason (can be used by verify callback) */ 95 #define MBEDTLS_X509_BADCERT_FUTURE 0x0200 /**< The certificate validity starts in the future. */ 96 #define MBEDTLS_X509_BADCRL_FUTURE 0x0400 /**< The CRL is from the future */ 97 #define MBEDTLS_X509_BADCERT_KEY_USAGE 0x0800 /**< Usage does not match the keyUsage extension. */ 98 #define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE 0x1000 /**< Usage does not match the extendedKeyUsage extension. */ 99 #define MBEDTLS_X509_BADCERT_NS_CERT_TYPE 0x2000 /**< Usage does not match the nsCertType extension. */ 100 #define MBEDTLS_X509_BADCERT_BAD_MD 0x4000 /**< The certificate is signed with an unacceptable hash. */ 101 #define MBEDTLS_X509_BADCERT_BAD_PK 0x8000 /**< The certificate is signed with an unacceptable PK alg (eg RSA vs ECDSA). */ 102 #define MBEDTLS_X509_BADCERT_BAD_KEY 0x010000 /**< The certificate is signed with an unacceptable key (eg bad curve, RSA too short). */ 103 #define MBEDTLS_X509_BADCRL_BAD_MD 0x020000 /**< The CRL is signed with an unacceptable hash. */ 104 #define MBEDTLS_X509_BADCRL_BAD_PK 0x040000 /**< The CRL is signed with an unacceptable PK alg (eg RSA vs ECDSA). */ 105 #define MBEDTLS_X509_BADCRL_BAD_KEY 0x080000 /**< The CRL is signed with an unacceptable key (eg bad curve, RSA too short). */ 106 107 /* \} name */ 108 /* \} addtogroup x509_module */ 109 110 /* 111 * X.509 v3 Key Usage Extension flags 112 * Reminder: update x509_info_key_usage() when adding new flags. 113 */ 114 #define MBEDTLS_X509_KU_DIGITAL_SIGNATURE (0x80) /* bit 0 */ 115 #define MBEDTLS_X509_KU_NON_REPUDIATION (0x40) /* bit 1 */ 116 #define MBEDTLS_X509_KU_KEY_ENCIPHERMENT (0x20) /* bit 2 */ 117 #define MBEDTLS_X509_KU_DATA_ENCIPHERMENT (0x10) /* bit 3 */ 118 #define MBEDTLS_X509_KU_KEY_AGREEMENT (0x08) /* bit 4 */ 119 #define MBEDTLS_X509_KU_KEY_CERT_SIGN (0x04) /* bit 5 */ 120 #define MBEDTLS_X509_KU_CRL_SIGN (0x02) /* bit 6 */ 121 #define MBEDTLS_X509_KU_ENCIPHER_ONLY (0x01) /* bit 7 */ 122 #define MBEDTLS_X509_KU_DECIPHER_ONLY (0x8000) /* bit 8 */ 123 124 /* 125 * Netscape certificate types 126 * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html) 127 */ 128 129 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT (0x80) /* bit 0 */ 130 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER (0x40) /* bit 1 */ 131 #define MBEDTLS_X509_NS_CERT_TYPE_EMAIL (0x20) /* bit 2 */ 132 #define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING (0x10) /* bit 3 */ 133 #define MBEDTLS_X509_NS_CERT_TYPE_RESERVED (0x08) /* bit 4 */ 134 #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CA (0x04) /* bit 5 */ 135 #define MBEDTLS_X509_NS_CERT_TYPE_EMAIL_CA (0x02) /* bit 6 */ 136 #define MBEDTLS_X509_NS_CERT_TYPE_OBJECT_SIGNING_CA (0x01) /* bit 7 */ 137 138 /* 139 * X.509 extension types 140 * 141 * Comments refer to the status for using certificates. Status can be 142 * different for writing certificates or reading CRLs or CSRs. 143 */ 144 #define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER (1 << 0) 145 #define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER (1 << 1) 146 #define MBEDTLS_X509_EXT_KEY_USAGE (1 << 2) 147 #define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES (1 << 3) 148 #define MBEDTLS_X509_EXT_POLICY_MAPPINGS (1 << 4) 149 #define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME (1 << 5) /* Supported (DNS) */ 150 #define MBEDTLS_X509_EXT_ISSUER_ALT_NAME (1 << 6) 151 #define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS (1 << 7) 152 #define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS (1 << 8) /* Supported */ 153 #define MBEDTLS_X509_EXT_NAME_CONSTRAINTS (1 << 9) 154 #define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS (1 << 10) 155 #define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE (1 << 11) 156 #define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS (1 << 12) 157 #define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY (1 << 13) 158 #define MBEDTLS_X509_EXT_FRESHEST_CRL (1 << 14) 159 160 #define MBEDTLS_X509_EXT_NS_CERT_TYPE (1 << 16) /* Parsed (and then ?) */ 161 162 /* 163 * Storage format identifiers 164 * Recognized formats: PEM and DER 165 */ 166 #define MBEDTLS_X509_FORMAT_DER 1 167 #define MBEDTLS_X509_FORMAT_PEM 2 168 169 #define MBEDTLS_X509_MAX_DN_NAME_SIZE 256 /**< Maximum value size of a DN entry */ 170 171 #ifdef __cplusplus 172 extern "C" { 173 #endif 174 175 /** 176 * \addtogroup x509_module 177 * \{ */ 178 179 /** 180 * \name Structures for parsing X.509 certificates, CRLs and CSRs 181 * \{ 182 */ 183 184 /** 185 * Type-length-value structure that allows for ASN1 using DER. 186 */ 187 typedef mbedtls_asn1_buf mbedtls_x509_buf; 188 189 /** 190 * Container for ASN1 bit strings. 191 */ 192 typedef mbedtls_asn1_bitstring mbedtls_x509_bitstring; 193 194 /** 195 * Container for ASN1 named information objects. 196 * It allows for Relative Distinguished Names (e.g. cn=localhost,ou=code,etc.). 197 */ 198 typedef mbedtls_asn1_named_data mbedtls_x509_name; 199 200 /** 201 * Container for a sequence of ASN.1 items 202 */ 203 typedef mbedtls_asn1_sequence mbedtls_x509_sequence; 204 205 /** Container for date and time (precision in seconds). */ 206 typedef struct mbedtls_x509_time 207 { 208 int year, mon, day; /**< Date. */ 209 int hour, min, sec; /**< Time. */ 210 } 211 mbedtls_x509_time; 212 213 /** \} name Structures for parsing X.509 certificates, CRLs and CSRs */ 214 /** \} addtogroup x509_module */ 215 216 /** 217 * \brief Store the certificate DN in printable form into buf; 218 * no more than size characters will be written. 219 * 220 * \param buf Buffer to write to 221 * \param size Maximum size of buffer 222 * \param dn The X509 name to represent 223 * 224 * \return The length of the string written (not including the 225 * terminated nul byte), or a negative error code. 226 */ 227 int mbedtls_x509_dn_gets( char *buf, size_t size, const mbedtls_x509_name *dn ); 228 229 /** 230 * \brief Store the certificate serial in printable form into buf; 231 * no more than size characters will be written. 232 * 233 * \param buf Buffer to write to 234 * \param size Maximum size of buffer 235 * \param serial The X509 serial to represent 236 * 237 * \return The length of the string written (not including the 238 * terminated nul byte), or a negative error code. 239 */ 240 int mbedtls_x509_serial_gets( char *buf, size_t size, const mbedtls_x509_buf *serial ); 241 242 /** 243 * \brief Check a given mbedtls_x509_time against the system time 244 * and tell if it's in the past. 245 * 246 * \note Intended usage is "if( is_past( valid_to ) ) ERROR". 247 * Hence the return value of 1 if on internal errors. 248 * 249 * \param time mbedtls_x509_time to check 250 * 251 * \return 1 if the given time is in the past or an error occured, 252 * 0 otherwise. 253 */ 254 int mbedtls_x509_time_is_past( const mbedtls_x509_time *time ); 255 256 /** 257 * \brief Check a given mbedtls_x509_time against the system time 258 * and tell if it's in the future. 259 * 260 * \note Intended usage is "if( is_future( valid_from ) ) ERROR". 261 * Hence the return value of 1 if on internal errors. 262 * 263 * \param time mbedtls_x509_time to check 264 * 265 * \return 1 if the given time is in the future or an error occured, 266 * 0 otherwise. 267 */ 268 int mbedtls_x509_time_is_future( const mbedtls_x509_time *time ); 269 270 /** 271 * \brief Checkup routine 272 * 273 * \return 0 if successful, or 1 if the test failed 274 */ 275 int mbedtls_x509_self_test( int verbose ); 276 277 /* 278 * Internal module functions. You probably do not want to use these unless you 279 * know you do. 280 */ 281 int mbedtls_x509_get_name( unsigned char **p, const unsigned char *end, 282 mbedtls_x509_name *cur ); 283 int mbedtls_x509_get_alg_null( unsigned char **p, const unsigned char *end, 284 mbedtls_x509_buf *alg ); 285 int mbedtls_x509_get_alg( unsigned char **p, const unsigned char *end, 286 mbedtls_x509_buf *alg, mbedtls_x509_buf *params ); 287 #if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) 288 int mbedtls_x509_get_rsassa_pss_params( const mbedtls_x509_buf *params, 289 mbedtls_md_type_t *md_alg, mbedtls_md_type_t *mgf_md, 290 int *salt_len ); 291 #endif 292 int mbedtls_x509_get_sig( unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig ); 293 int mbedtls_x509_get_sig_alg( const mbedtls_x509_buf *sig_oid, const mbedtls_x509_buf *sig_params, 294 mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg, 295 void **sig_opts ); 296 int mbedtls_x509_get_time( unsigned char **p, const unsigned char *end, 297 mbedtls_x509_time *time ); 298 int mbedtls_x509_get_serial( unsigned char **p, const unsigned char *end, 299 mbedtls_x509_buf *serial ); 300 int mbedtls_x509_get_ext( unsigned char **p, const unsigned char *end, 301 mbedtls_x509_buf *ext, int tag ); 302 int mbedtls_x509_sig_alg_gets( char *buf, size_t size, const mbedtls_x509_buf *sig_oid, 303 mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg, 304 const void *sig_opts ); 305 int mbedtls_x509_key_size_helper( char *buf, size_t buf_size, const char *name ); 306 int mbedtls_x509_string_to_names( mbedtls_asn1_named_data **head, const char *name ); 307 int mbedtls_x509_set_extension( mbedtls_asn1_named_data **head, const char *oid, size_t oid_len, 308 int critical, const unsigned char *val, 309 size_t val_len ); 310 int mbedtls_x509_write_extensions( unsigned char **p, unsigned char *start, 311 mbedtls_asn1_named_data *first ); 312 int mbedtls_x509_write_names( unsigned char **p, unsigned char *start, 313 mbedtls_asn1_named_data *first ); 314 int mbedtls_x509_write_sig( unsigned char **p, unsigned char *start, 315 const char *oid, size_t oid_len, 316 unsigned char *sig, size_t size ); 317 318 #define MBEDTLS_X509_SAFE_SNPRINTF \ 319 do { \ 320 if( ret < 0 || (size_t) ret >= n ) \ 321 return( MBEDTLS_ERR_X509_BUFFER_TOO_SMALL ); \ 322 \ 323 n -= (size_t) ret; \ 324 p += (size_t) ret; \ 325 } while( 0 ) 326 327 #ifdef __cplusplus 328 } 329 #endif 330 331 #endif /* x509.h */ 332
