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