Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1 | /** |
| 2 | * \file x509.h |
Paul Bakker | e0ccd0a | 2009-01-04 16:27:10 +0000 | [diff] [blame] | 3 | * |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 4 | * \brief X.509 generic defines and structures |
Darryl Green | a40a101 | 2018-01-05 15:33:17 +0000 | [diff] [blame] | 5 | */ |
| 6 | /* |
Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 7 | * Copyright The Mbed TLS Contributors |
Manuel Pégourié-Gonnard | 37ff140 | 2015-09-04 14:21:07 +0200 | [diff] [blame] | 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. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 21 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 22 | #ifndef MBEDTLS_X509_H |
| 23 | #define MBEDTLS_X509_H |
Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 24 | #include "mbedtls/private_access.h" |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 25 | |
Bence Szépkúti | c662b36 | 2021-05-27 11:25:03 +0200 | [diff] [blame] | 26 | #include "mbedtls/build_info.h" |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 27 | |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 28 | #include "mbedtls/asn1.h" |
| 29 | #include "mbedtls/pk.h" |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 30 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 31 | #if defined(MBEDTLS_RSA_C) |
Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 32 | #include "mbedtls/rsa.h" |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 33 | #endif |
| 34 | |
| 35 | /** |
Paul Bakker | 0f5f72e | 2011-01-18 14:58:55 +0000 | [diff] [blame] | 36 | * \addtogroup x509_module |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 37 | * \{ |
Paul Bakker | 13e2dfe | 2009-07-28 07:18:38 +0000 | [diff] [blame] | 38 | */ |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 39 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 40 | #if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA) |
Manuel Pégourié-Gonnard | fd6c85c | 2014-11-20 16:34:20 +0100 | [diff] [blame] | 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 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 49 | #define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 |
Manuel Pégourié-Gonnard | fd6c85c | 2014-11-20 16:34:20 +0100 | [diff] [blame] | 50 | #endif |
| 51 | |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 52 | /** |
Paul Bakker | 0f5f72e | 2011-01-18 14:58:55 +0000 | [diff] [blame] | 53 | * \name X509 Error codes |
| 54 | * \{ |
Paul Bakker | 13e2dfe | 2009-07-28 07:18:38 +0000 | [diff] [blame] | 55 | */ |
Gilles Peskine | d297157 | 2021-07-26 18:48:10 +0200 | [diff] [blame] | 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 |
Andrzej Kurek | 38d4fdd | 2021-12-28 16:22:52 +0100 | [diff] [blame] | 96 | /** \} name X509 Error codes */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 97 | |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 98 | /** |
Paul Bakker | 0f5f72e | 2011-01-18 14:58:55 +0000 | [diff] [blame] | 99 | * \name X509 Verify codes |
| 100 | * \{ |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 101 | */ |
Manuel Pégourié-Gonnard | b5f48ad | 2015-04-20 10:38:13 +0100 | [diff] [blame] | 102 | /* Reminder: update x509_crt_verify_strings[] in library/x509_crt.c */ |
Manuel Pégourié-Gonnard | e6028c9 | 2015-04-20 12:19:02 +0100 | [diff] [blame] | 103 | #define MBEDTLS_X509_BADCERT_EXPIRED 0x01 /**< The certificate validity has expired. */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 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. */ |
Manuel Pégourié-Gonnard | b5f48ad | 2015-04-20 10:38:13 +0100 | [diff] [blame] | 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. */ |
Manuel Pégourié-Gonnard | e6028c9 | 2015-04-20 12:19:02 +0100 | [diff] [blame] | 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) */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 112 | #define MBEDTLS_X509_BADCERT_FUTURE 0x0200 /**< The certificate validity starts in the future. */ |
Manuel Pégourié-Gonnard | e6028c9 | 2015-04-20 12:19:02 +0100 | [diff] [blame] | 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. */ |
Manuel Pégourié-Gonnard | 9505164 | 2015-06-15 10:39:46 +0200 | [diff] [blame] | 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 | |
Andrzej Kurek | 38d4fdd | 2021-12-28 16:22:52 +0100 | [diff] [blame] | 124 | /** \} name X509 Verify codes */ |
| 125 | /** \} addtogroup x509_module */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 126 | |
| 127 | /* |
Ron Eldor | b2dc3fa | 2019-03-21 13:40:13 +0200 | [diff] [blame] | 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 | /* |
Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 150 | * X.509 v3 Key Usage Extension flags |
Przemek Stekiel | 21c3728 | 2023-01-16 08:47:49 +0100 | [diff] [blame] | 151 | * Reminder: update mbedtls_x509_info_key_usage() when adding new flags. |
Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 152 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 153 | #define MBEDTLS_X509_KU_DIGITAL_SIGNATURE (0x80) /* bit 0 */ |
| 154 | #define MBEDTLS_X509_KU_NON_REPUDIATION (0x40) /* bit 1 */ |
Manuel Pégourié-Gonnard | e6028c9 | 2015-04-20 12:19:02 +0100 | [diff] [blame] | 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 */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 158 | #define MBEDTLS_X509_KU_KEY_CERT_SIGN (0x04) /* bit 5 */ |
| 159 | #define MBEDTLS_X509_KU_CRL_SIGN (0x02) /* bit 6 */ |
Manuel Pégourié-Gonnard | 9a70225 | 2015-06-23 10:14:36 +0200 | [diff] [blame] | 160 | #define MBEDTLS_X509_KU_ENCIPHER_ONLY (0x01) /* bit 7 */ |
| 161 | #define MBEDTLS_X509_KU_DECIPHER_ONLY (0x8000) /* bit 8 */ |
Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 162 | |
| 163 | /* |
Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 164 | * Netscape certificate types |
| 165 | * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html) |
| 166 | */ |
| 167 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 168 | #define MBEDTLS_X509_NS_CERT_TYPE_SSL_CLIENT (0x80) /* bit 0 */ |
Manuel Pégourié-Gonnard | e6028c9 | 2015-04-20 12:19:02 +0100 | [diff] [blame] | 169 | #define MBEDTLS_X509_NS_CERT_TYPE_SSL_SERVER (0x40) /* bit 1 */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 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 */ |
Manuel Pégourié-Gonnard | e6028c9 | 2015-04-20 12:19:02 +0100 | [diff] [blame] | 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 */ |
Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 176 | |
Paul Bakker | c70b982 | 2013-04-07 22:00:46 +0200 | [diff] [blame] | 177 | /* |
| 178 | * X.509 extension types |
Manuel Pégourié-Gonnard | b28487d | 2014-04-01 12:19:09 +0200 | [diff] [blame] | 179 | * |
| 180 | * Comments refer to the status for using certificates. Status can be |
| 181 | * different for writing certificates or reading CRLs or CSRs. |
Manuel Pégourié-Gonnard | c49ada4 | 2019-01-28 09:20:59 +0100 | [diff] [blame] | 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. |
Paul Bakker | c70b982 | 2013-04-07 22:00:46 +0200 | [diff] [blame] | 185 | */ |
Manuel Pégourié-Gonnard | c49ada4 | 2019-01-28 09:20:59 +0100 | [diff] [blame] | 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 |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 202 | |
Paul Bakker | 6c0ceb3 | 2011-12-04 12:24:18 +0000 | [diff] [blame] | 203 | /* |
| 204 | * Storage format identifiers |
| 205 | * Recognized formats: PEM and DER |
| 206 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 207 | #define MBEDTLS_X509_FORMAT_DER 1 |
| 208 | #define MBEDTLS_X509_FORMAT_PEM 2 |
Paul Bakker | 6c0ceb3 | 2011-12-04 12:24:18 +0000 | [diff] [blame] | 209 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 210 | #define MBEDTLS_X509_MAX_DN_NAME_SIZE 256 /**< Maximum value size of a DN entry */ |
Paul Bakker | 8dcb2d7 | 2014-08-08 12:22:30 +0200 | [diff] [blame] | 211 | |
Paul Bakker | 407a0da | 2013-06-27 14:29:21 +0200 | [diff] [blame] | 212 | #ifdef __cplusplus |
| 213 | extern "C" { |
| 214 | #endif |
| 215 | |
Paul Bakker | e5eae76 | 2013-08-26 12:05:14 +0200 | [diff] [blame] | 216 | /** |
Paul Bakker | 0f5f72e | 2011-01-18 14:58:55 +0000 | [diff] [blame] | 217 | * \addtogroup x509_module |
| 218 | * \{ */ |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 219 | |
| 220 | /** |
Paul Bakker | f9f377e | 2013-09-09 15:35:10 +0200 | [diff] [blame] | 221 | * \name Structures for parsing X.509 certificates, CRLs and CSRs |
Paul Bakker | 0f5f72e | 2011-01-18 14:58:55 +0000 | [diff] [blame] | 222 | * \{ |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 223 | */ |
Paul Bakker | e5eae76 | 2013-08-26 12:05:14 +0200 | [diff] [blame] | 224 | |
| 225 | /** |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 226 | * Type-length-value structure that allows for ASN1 using DER. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 227 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 228 | typedef mbedtls_asn1_buf mbedtls_x509_buf; |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 229 | |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 230 | /** |
Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 231 | * Container for ASN1 bit strings. |
| 232 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 233 | typedef mbedtls_asn1_bitstring mbedtls_x509_bitstring; |
Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 234 | |
| 235 | /** |
Paul Bakker | e5eae76 | 2013-08-26 12:05:14 +0200 | [diff] [blame] | 236 | * Container for ASN1 named information objects. |
Manuel Pégourié-Gonnard | 83b04de | 2015-03-09 17:33:07 +0000 | [diff] [blame] | 237 | * It allows for Relative Distinguished Names (e.g. cn=localhost,ou=code,etc.). |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 238 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 239 | typedef mbedtls_asn1_named_data mbedtls_x509_name; |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 240 | |
Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 241 | /** |
| 242 | * Container for a sequence of ASN.1 items |
| 243 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 244 | typedef mbedtls_asn1_sequence mbedtls_x509_sequence; |
Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 245 | |
toth92g | a41954d | 2021-02-12 16:11:17 +0100 | [diff] [blame] | 246 | /* |
| 247 | * Container for the fields of the Authority Key Identifier object |
| 248 | */ |
| 249 | typedef struct mbedtls_x509_authority { |
| 250 | mbedtls_x509_buf keyIdentifier; |
toth92g | 8d435a0 | 2021-05-10 15:16:33 +0200 | [diff] [blame] | 251 | mbedtls_x509_sequence authorityCertIssuer; |
toth92g | a41954d | 2021-02-12 16:11:17 +0100 | [diff] [blame] | 252 | mbedtls_x509_buf authorityCertSerialNumber; |
| 253 | mbedtls_x509_buf raw; |
| 254 | } |
| 255 | mbedtls_x509_authority; |
| 256 | |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 257 | /** Container for date and time (precision in seconds). */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 258 | typedef struct mbedtls_x509_time { |
Gilles Peskine | 842edf4 | 2021-08-04 21:56:10 +0200 | [diff] [blame] | 259 | int year, mon, day; /**< Date. */ |
| 260 | int hour, min, sec; /**< Time. */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 261 | } |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 262 | mbedtls_x509_time; |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 263 | |
Przemek Stekiel | cf6ff0f | 2023-01-17 10:26:40 +0100 | [diff] [blame] | 264 | /** |
| 265 | * From RFC 5280 section 4.2.1.6: |
| 266 | * OtherName ::= SEQUENCE { |
| 267 | * type-id OBJECT IDENTIFIER, |
| 268 | * value [0] EXPLICIT ANY DEFINED BY type-id } |
| 269 | * |
| 270 | * Future versions of the library may add new fields to this structure or |
| 271 | * to its embedded union and structure. |
| 272 | */ |
| 273 | typedef struct mbedtls_x509_san_other_name { |
| 274 | /** |
| 275 | * The type_id is an OID as defined in RFC 5280. |
| 276 | * To check the value of the type id, you should use |
| 277 | * \p MBEDTLS_OID_CMP with a known OID mbedtls_x509_buf. |
| 278 | */ |
| 279 | mbedtls_x509_buf type_id; /**< The type id. */ |
| 280 | union { |
| 281 | /** |
| 282 | * From RFC 4108 section 5: |
| 283 | * HardwareModuleName ::= SEQUENCE { |
| 284 | * hwType OBJECT IDENTIFIER, |
| 285 | * hwSerialNum OCTET STRING } |
| 286 | */ |
| 287 | struct { |
| 288 | mbedtls_x509_buf oid; /**< The object identifier. */ |
| 289 | mbedtls_x509_buf val; /**< The named value. */ |
| 290 | } |
| 291 | hardware_module_name; |
| 292 | } |
| 293 | value; |
| 294 | } |
| 295 | mbedtls_x509_san_other_name; |
| 296 | |
| 297 | /** |
| 298 | * A structure for holding the parsed Subject Alternative Name, |
| 299 | * according to type. |
| 300 | * |
| 301 | * Future versions of the library may add new fields to this structure or |
| 302 | * to its embedded union and structure. |
| 303 | */ |
| 304 | typedef struct mbedtls_x509_subject_alternative_name { |
| 305 | int type; /**< The SAN type, value of MBEDTLS_X509_SAN_XXX. */ |
| 306 | union { |
Andrzej Kurek | 1747304 | 2023-04-30 14:11:23 -0400 | [diff] [blame] | 307 | mbedtls_x509_san_other_name other_name; |
Andrzej Kurek | e12b01d | 2023-01-10 06:47:38 -0500 | [diff] [blame] | 308 | mbedtls_x509_name directory_name; |
| 309 | mbedtls_x509_buf unstructured_name; /**< The buffer for the unstructured types. rfc822Name, dnsName and uniformResourceIdentifier are currently supported. */ |
Przemek Stekiel | cf6ff0f | 2023-01-17 10:26:40 +0100 | [diff] [blame] | 310 | } |
| 311 | san; /**< A union of the supported SAN types */ |
| 312 | } |
| 313 | mbedtls_x509_subject_alternative_name; |
| 314 | |
Andrzej Kurek | 1a75269 | 2023-04-01 09:44:11 -0400 | [diff] [blame] | 315 | typedef struct mbedtls_x509_san_list { |
| 316 | mbedtls_x509_subject_alternative_name node; |
| 317 | struct mbedtls_x509_san_list *next; |
| 318 | } |
| 319 | mbedtls_x509_san_list; |
| 320 | |
Paul Bakker | f9f377e | 2013-09-09 15:35:10 +0200 | [diff] [blame] | 321 | /** \} name Structures for parsing X.509 certificates, CRLs and CSRs */ |
Paul Bakker | d98030e | 2009-05-02 15:13:40 +0000 | [diff] [blame] | 322 | |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 323 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 324 | * \brief Store the certificate DN in printable form into buf; |
Paul Bakker | d98030e | 2009-05-02 15:13:40 +0000 | [diff] [blame] | 325 | * no more than size characters will be written. |
Paul Bakker | 13e2dfe | 2009-07-28 07:18:38 +0000 | [diff] [blame] | 326 | * |
| 327 | * \param buf Buffer to write to |
| 328 | * \param size Maximum size of buffer |
| 329 | * \param dn The X509 name to represent |
| 330 | * |
Manuel Pégourié-Gonnard | e244f9f | 2015-06-23 12:10:45 +0200 | [diff] [blame] | 331 | * \return The length of the string written (not including the |
| 332 | * terminated nul byte), or a negative error code. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 333 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 334 | int mbedtls_x509_dn_gets(char *buf, size_t size, const mbedtls_x509_name *dn); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 335 | |
| 336 | /** |
Werner Lewis | b3acb05 | 2022-06-17 15:59:58 +0100 | [diff] [blame] | 337 | * \brief Return the next relative DN in an X509 name. |
| 338 | * |
Glenn Strauss | 01d2f52 | 2022-06-27 14:12:44 -0400 | [diff] [blame] | 339 | * \note Intended use is to compare function result to dn->next |
| 340 | * in order to detect boundaries of multi-valued RDNs. |
| 341 | * |
Werner Lewis | b3acb05 | 2022-06-17 15:59:58 +0100 | [diff] [blame] | 342 | * \param dn Current node in the X509 name |
| 343 | * |
| 344 | * \return Pointer to the first attribute-value pair of the |
| 345 | * next RDN in sequence, or NULL if end is reached. |
| 346 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 347 | static inline mbedtls_x509_name *mbedtls_x509_dn_get_next( |
| 348 | mbedtls_x509_name *dn) |
Glenn Strauss | 01d2f52 | 2022-06-27 14:12:44 -0400 | [diff] [blame] | 349 | { |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 350 | while (dn->MBEDTLS_PRIVATE(next_merged) && dn->next != NULL) { |
Glenn Strauss | 01d2f52 | 2022-06-27 14:12:44 -0400 | [diff] [blame] | 351 | dn = dn->next; |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 352 | } |
| 353 | return dn->next; |
Glenn Strauss | 01d2f52 | 2022-06-27 14:12:44 -0400 | [diff] [blame] | 354 | } |
Werner Lewis | b3acb05 | 2022-06-17 15:59:58 +0100 | [diff] [blame] | 355 | |
| 356 | /** |
Paul Bakker | dd47699 | 2011-01-16 21:34:59 +0000 | [diff] [blame] | 357 | * \brief Store the certificate serial in printable form into buf; |
| 358 | * no more than size characters will be written. |
| 359 | * |
| 360 | * \param buf Buffer to write to |
| 361 | * \param size Maximum size of buffer |
| 362 | * \param serial The X509 serial to represent |
| 363 | * |
Manuel Pégourié-Gonnard | e244f9f | 2015-06-23 12:10:45 +0200 | [diff] [blame] | 364 | * \return The length of the string written (not including the |
| 365 | * terminated nul byte), or a negative error code. |
Paul Bakker | dd47699 | 2011-01-16 21:34:59 +0000 | [diff] [blame] | 366 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 367 | int mbedtls_x509_serial_gets(char *buf, size_t size, const mbedtls_x509_buf *serial); |
Paul Bakker | dd47699 | 2011-01-16 21:34:59 +0000 | [diff] [blame] | 368 | |
| 369 | /** |
Glenn Strauss | 416dc03 | 2022-06-30 00:38:53 -0400 | [diff] [blame] | 370 | * \brief Compare pair of mbedtls_x509_time. |
| 371 | * |
| 372 | * \param t1 mbedtls_x509_time to compare |
| 373 | * \param t2 mbedtls_x509_time to compare |
| 374 | * |
| 375 | * \return < 0 if t1 is before t2 |
| 376 | * 0 if t1 equals t2 |
| 377 | * > 0 if t1 is after t2 |
| 378 | */ |
| 379 | int mbedtls_x509_time_cmp(const mbedtls_x509_time *t1, const mbedtls_x509_time *t2); |
| 380 | |
Glenn Strauss | 61d9930 | 2022-06-30 05:25:56 -0400 | [diff] [blame] | 381 | #if defined(MBEDTLS_HAVE_TIME_DATE) |
| 382 | /** |
| 383 | * \brief Fill mbedtls_x509_time with provided mbedtls_time_t. |
| 384 | * |
| 385 | * \param tt mbedtls_time_t to convert |
| 386 | * \param now mbedtls_x509_time to fill with converted mbedtls_time_t |
| 387 | * |
| 388 | * \return \c 0 on success |
| 389 | * \return A non-zero return value on failure. |
| 390 | */ |
| 391 | int mbedtls_x509_time_gmtime(mbedtls_time_t tt, mbedtls_x509_time *now); |
| 392 | #endif /* MBEDTLS_HAVE_TIME_DATE */ |
| 393 | |
Glenn Strauss | 416dc03 | 2022-06-30 00:38:53 -0400 | [diff] [blame] | 394 | /** |
Manuel Pégourié-Gonnard | e7e8984 | 2015-06-22 19:15:32 +0200 | [diff] [blame] | 395 | * \brief Check a given mbedtls_x509_time against the system time |
| 396 | * and tell if it's in the past. |
| 397 | * |
| 398 | * \note Intended usage is "if( is_past( valid_to ) ) ERROR". |
| 399 | * Hence the return value of 1 if on internal errors. |
Paul Bakker | 13e2dfe | 2009-07-28 07:18:38 +0000 | [diff] [blame] | 400 | * |
Hanno Becker | 61937d4 | 2017-04-26 15:01:23 +0100 | [diff] [blame] | 401 | * \param to mbedtls_x509_time to check |
Paul Bakker | 13e2dfe | 2009-07-28 07:18:38 +0000 | [diff] [blame] | 402 | * |
Antonin Décimo | 36e89b5 | 2019-01-23 15:24:37 +0100 | [diff] [blame] | 403 | * \return 1 if the given time is in the past or an error occurred, |
Manuel Pégourié-Gonnard | e7e8984 | 2015-06-22 19:15:32 +0200 | [diff] [blame] | 404 | * 0 otherwise. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 405 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 406 | int mbedtls_x509_time_is_past(const mbedtls_x509_time *to); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 407 | |
| 408 | /** |
Manuel Pégourié-Gonnard | e7e8984 | 2015-06-22 19:15:32 +0200 | [diff] [blame] | 409 | * \brief Check a given mbedtls_x509_time against the system time |
| 410 | * and tell if it's in the future. |
| 411 | * |
| 412 | * \note Intended usage is "if( is_future( valid_from ) ) ERROR". |
| 413 | * Hence the return value of 1 if on internal errors. |
Manuel Pégourié-Gonnard | 6304f78 | 2014-03-10 12:26:11 +0100 | [diff] [blame] | 414 | * |
Hanno Becker | 61937d4 | 2017-04-26 15:01:23 +0100 | [diff] [blame] | 415 | * \param from mbedtls_x509_time to check |
Manuel Pégourié-Gonnard | 6304f78 | 2014-03-10 12:26:11 +0100 | [diff] [blame] | 416 | * |
Antonin Décimo | 36e89b5 | 2019-01-23 15:24:37 +0100 | [diff] [blame] | 417 | * \return 1 if the given time is in the future or an error occurred, |
Manuel Pégourié-Gonnard | e7e8984 | 2015-06-22 19:15:32 +0200 | [diff] [blame] | 418 | * 0 otherwise. |
Manuel Pégourié-Gonnard | 6304f78 | 2014-03-10 12:26:11 +0100 | [diff] [blame] | 419 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 420 | int mbedtls_x509_time_is_future(const mbedtls_x509_time *from); |
Manuel Pégourié-Gonnard | 6304f78 | 2014-03-10 12:26:11 +0100 | [diff] [blame] | 421 | |
Przemek Stekiel | cf6ff0f | 2023-01-17 10:26:40 +0100 | [diff] [blame] | 422 | /** |
| 423 | * \brief This function parses an item in the SubjectAlternativeNames |
Andrzej Kurek | 5f0c6e8 | 2023-02-27 16:03:41 -0500 | [diff] [blame] | 424 | * extension. Please note that this function might allocate |
| 425 | * additional memory for a subject alternative name, thus |
| 426 | * mbedtls_x509_free_subject_alt_name has to be called |
Andrzej Kurek | c27ba3a | 2023-03-06 10:48:30 +0100 | [diff] [blame] | 427 | * to dispose of this additional memory afterwards. |
Przemek Stekiel | cf6ff0f | 2023-01-17 10:26:40 +0100 | [diff] [blame] | 428 | * |
| 429 | * \param san_buf The buffer holding the raw data item of the subject |
| 430 | * alternative name. |
| 431 | * \param san The target structure to populate with the parsed presentation |
Andrzej Kurek | 3bedb5b | 2022-02-17 14:39:00 -0500 | [diff] [blame] | 432 | * of the subject alternative name encoded in \p san_buf. |
Przemek Stekiel | cf6ff0f | 2023-01-17 10:26:40 +0100 | [diff] [blame] | 433 | * |
Andrzej Kurek | 81b0b89 | 2023-02-16 06:55:10 -0500 | [diff] [blame] | 434 | * \note Supported GeneralName types, as defined in RFC 5280: |
Andrzej Kurek | 1747304 | 2023-04-30 14:11:23 -0400 | [diff] [blame] | 435 | * "rfc822Name", "dnsName", "directoryName", |
| 436 | * "uniformResourceIdentifier" and "hardware_module_name" |
Andrzej Kurek | 81b0b89 | 2023-02-16 06:55:10 -0500 | [diff] [blame] | 437 | * of type "otherName", as defined in RFC 4108. |
Przemek Stekiel | cf6ff0f | 2023-01-17 10:26:40 +0100 | [diff] [blame] | 438 | * |
| 439 | * \note This function should be called on a single raw data of |
| 440 | * subject alternative name. For example, after successful |
| 441 | * certificate parsing, one must iterate on every item in the |
Andrzej Kurek | 3bedb5b | 2022-02-17 14:39:00 -0500 | [diff] [blame] | 442 | * \c crt->subject_alt_names sequence, and pass it to |
Przemek Stekiel | cf6ff0f | 2023-01-17 10:26:40 +0100 | [diff] [blame] | 443 | * this function. |
| 444 | * |
| 445 | * \warning The target structure contains pointers to the raw data of the |
| 446 | * parsed certificate, and its lifetime is restricted by the |
| 447 | * lifetime of the certificate. |
| 448 | * |
| 449 | * \return \c 0 on success |
| 450 | * \return #MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE for an unsupported |
| 451 | * SAN type. |
| 452 | * \return Another negative value for any other failure. |
| 453 | */ |
| 454 | int mbedtls_x509_parse_subject_alt_name(const mbedtls_x509_buf *san_buf, |
| 455 | mbedtls_x509_subject_alternative_name *san); |
Andrzej Kurek | d40c2b6 | 2023-02-13 07:01:59 -0500 | [diff] [blame] | 456 | /** |
| 457 | * \brief Unallocate all data related to subject alternative name |
| 458 | * |
Andrzej Kurek | c27ba3a | 2023-03-06 10:48:30 +0100 | [diff] [blame] | 459 | * \param san SAN structure - extra memory owned by this structure will be freed |
Andrzej Kurek | d40c2b6 | 2023-02-13 07:01:59 -0500 | [diff] [blame] | 460 | */ |
| 461 | void mbedtls_x509_free_subject_alt_name(mbedtls_x509_subject_alternative_name *san); |
Przemek Stekiel | cf6ff0f | 2023-01-17 10:26:40 +0100 | [diff] [blame] | 462 | |
Andrzej Kurek | a0defed | 2021-12-30 12:33:31 +0100 | [diff] [blame] | 463 | /** \} addtogroup x509_module */ |
| 464 | |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 465 | /* |
Paul Bakker | 86d0c19 | 2013-09-18 11:11:02 +0200 | [diff] [blame] | 466 | * Internal module functions. You probably do not want to use these unless you |
| 467 | * know you do. |
Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 468 | */ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 469 | int mbedtls_x509_get_name(unsigned char **p, const unsigned char *end, |
| 470 | mbedtls_x509_name *cur); |
| 471 | int mbedtls_x509_get_alg_null(unsigned char **p, const unsigned char *end, |
| 472 | mbedtls_x509_buf *alg); |
| 473 | int mbedtls_x509_get_alg(unsigned char **p, const unsigned char *end, |
| 474 | mbedtls_x509_buf *alg, mbedtls_x509_buf *params); |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 475 | #if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT) |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 476 | int mbedtls_x509_get_rsassa_pss_params(const mbedtls_x509_buf *params, |
| 477 | mbedtls_md_type_t *md_alg, mbedtls_md_type_t *mgf_md, |
| 478 | int *salt_len); |
Manuel Pégourié-Gonnard | 9df5c96 | 2014-01-24 14:37:29 +0100 | [diff] [blame] | 479 | #endif |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 480 | int mbedtls_x509_get_sig(unsigned char **p, const unsigned char *end, mbedtls_x509_buf *sig); |
| 481 | int mbedtls_x509_get_sig_alg(const mbedtls_x509_buf *sig_oid, const mbedtls_x509_buf *sig_params, |
| 482 | mbedtls_md_type_t *md_alg, mbedtls_pk_type_t *pk_alg, |
| 483 | void **sig_opts); |
| 484 | int mbedtls_x509_get_time(unsigned char **p, const unsigned char *end, |
| 485 | mbedtls_x509_time *t); |
| 486 | int mbedtls_x509_get_serial(unsigned char **p, const unsigned char *end, |
| 487 | mbedtls_x509_buf *serial); |
| 488 | int mbedtls_x509_get_ext(unsigned char **p, const unsigned char *end, |
| 489 | mbedtls_x509_buf *ext, int tag); |
Hanno Becker | 612a2f1 | 2020-10-09 09:19:39 +0100 | [diff] [blame] | 490 | #if !defined(MBEDTLS_X509_REMOVE_INFO) |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 491 | int mbedtls_x509_sig_alg_gets(char *buf, size_t size, const mbedtls_x509_buf *sig_oid, |
| 492 | mbedtls_pk_type_t pk_alg, mbedtls_md_type_t md_alg, |
| 493 | const void *sig_opts); |
Peter Kolbus | 9a969b6 | 2018-12-11 13:55:56 -0600 | [diff] [blame] | 494 | #endif |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 495 | int mbedtls_x509_key_size_helper(char *buf, size_t buf_size, const char *name); |
| 496 | int mbedtls_x509_string_to_names(mbedtls_asn1_named_data **head, const char *name); |
| 497 | int mbedtls_x509_set_extension(mbedtls_asn1_named_data **head, const char *oid, size_t oid_len, |
| 498 | int critical, const unsigned char *val, |
| 499 | size_t val_len); |
| 500 | int mbedtls_x509_write_extensions(unsigned char **p, unsigned char *start, |
| 501 | mbedtls_asn1_named_data *first); |
| 502 | int mbedtls_x509_write_names(unsigned char **p, unsigned char *start, |
| 503 | mbedtls_asn1_named_data *first); |
| 504 | int mbedtls_x509_write_sig(unsigned char **p, unsigned char *start, |
| 505 | const char *oid, size_t oid_len, |
Marek Jansta | 8bde649 | 2022-11-07 12:38:38 +0100 | [diff] [blame] | 506 | unsigned char *sig, size_t size, |
| 507 | mbedtls_pk_type_t pk_alg); |
Przemek Stekiel | 21c3728 | 2023-01-16 08:47:49 +0100 | [diff] [blame] | 508 | int mbedtls_x509_get_ns_cert_type(unsigned char **p, |
| 509 | const unsigned char *end, |
| 510 | unsigned char *ns_cert_type); |
| 511 | int mbedtls_x509_get_key_usage(unsigned char **p, |
| 512 | const unsigned char *end, |
| 513 | unsigned int *key_usage); |
| 514 | int mbedtls_x509_get_subject_alt_name(unsigned char **p, |
| 515 | const unsigned char *end, |
| 516 | mbedtls_x509_sequence *subject_alt_name); |
Przemek Stekiel | 21903ec | 2023-02-21 08:32:37 +0100 | [diff] [blame] | 517 | int mbedtls_x509_get_subject_alt_name_ext(unsigned char **p, |
| 518 | const unsigned char *end, |
| 519 | mbedtls_x509_sequence *subject_alt_name); |
Przemek Stekiel | 21c3728 | 2023-01-16 08:47:49 +0100 | [diff] [blame] | 520 | int mbedtls_x509_info_subject_alt_name(char **buf, size_t *size, |
| 521 | const mbedtls_x509_sequence |
| 522 | *subject_alt_name, |
| 523 | const char *prefix); |
| 524 | int mbedtls_x509_info_cert_type(char **buf, size_t *size, |
| 525 | unsigned char ns_cert_type); |
| 526 | int mbedtls_x509_info_key_usage(char **buf, size_t *size, |
| 527 | unsigned int key_usage); |
Paul Bakker | 30b95fa | 2013-10-01 10:09:06 +0200 | [diff] [blame] | 528 | |
Andrzej Kurek | c508dc2 | 2023-07-07 08:20:02 -0400 | [diff] [blame] | 529 | int mbedtls_x509_write_set_san_common(mbedtls_asn1_named_data **extensions, |
| 530 | const mbedtls_x509_san_list *san_list); |
| 531 | |
Andrzej Kurek | cd17ecf | 2023-06-05 17:02:17 -0400 | [diff] [blame] | 532 | /** |
| 533 | * \brief This function parses a CN string as an IP address. |
| 534 | * |
Andrzej Kurek | c6beb3a | 2023-06-15 09:54:37 -0400 | [diff] [blame] | 535 | * \param cn The CN string to parse. CN string MUST be null-terminated. |
Andrzej Kurek | cd17ecf | 2023-06-05 17:02:17 -0400 | [diff] [blame] | 536 | * \param dst The target buffer to populate with the binary IP address. |
| 537 | * The buffer MUST be 16 bytes to save IPv6, and should be |
| 538 | * 4-byte aligned if the result will be used as struct in_addr. |
| 539 | * e.g. uint32_t dst[4] |
| 540 | * |
Andrzej Kurek | 5d9aeba | 2023-05-22 15:16:05 -0400 | [diff] [blame] | 541 | * \note \p cn is parsed as an IPv6 address if string contains ':', |
| 542 | * else \p cn is parsed as an IPv4 address. |
Andrzej Kurek | cd17ecf | 2023-06-05 17:02:17 -0400 | [diff] [blame] | 543 | * |
| 544 | * \return Length of binary IP address; num bytes written to target. |
| 545 | * \return \c 0 on failure to parse CN string as an IP address. |
| 546 | */ |
| 547 | size_t mbedtls_x509_crt_parse_cn_inet_pton(const char *cn, void *dst); |
| 548 | |
Manuel Pégourié-Gonnard | 1685368 | 2015-06-22 11:12:02 +0200 | [diff] [blame] | 549 | #define MBEDTLS_X509_SAFE_SNPRINTF \ |
| 550 | do { \ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 551 | if (ret < 0 || (size_t) ret >= n) \ |
| 552 | return MBEDTLS_ERR_X509_BUFFER_TOO_SMALL; \ |
| 553 | \ |
Manuel Pégourié-Gonnard | 1685368 | 2015-06-22 11:12:02 +0200 | [diff] [blame] | 554 | n -= (size_t) ret; \ |
| 555 | p += (size_t) ret; \ |
Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 556 | } while (0) |
Manuel Pégourié-Gonnard | 1685368 | 2015-06-22 11:12:02 +0200 | [diff] [blame] | 557 | |
Paul Bakker | 30b95fa | 2013-10-01 10:09:06 +0200 | [diff] [blame] | 558 | #ifdef __cplusplus |
| 559 | } |
| 560 | #endif |
| 561 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 562 | #endif /* x509.h */ |