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