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