| 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 | 
| Dave Rodgman | 16799db | 2023-11-02 19:47:20 +0000 | [diff] [blame] | 8 | *  SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later | 
| Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 9 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 10 | #ifndef MBEDTLS_X509_H | 
|  | 11 | #define MBEDTLS_X509_H | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 12 | #include "mbedtls/private_access.h" | 
| Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 13 |  | 
| Bence Szépkúti | c662b36 | 2021-05-27 11:25:03 +0200 | [diff] [blame] | 14 | #include "mbedtls/build_info.h" | 
| Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 15 |  | 
| Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 16 | #include "mbedtls/asn1.h" | 
|  | 17 | #include "mbedtls/pk.h" | 
| Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 18 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 19 | #if defined(MBEDTLS_RSA_C) | 
| Jaeden Amero | 6609aef | 2019-07-04 20:01:14 +0100 | [diff] [blame] | 20 | #include "mbedtls/rsa.h" | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 21 | #endif | 
|  | 22 |  | 
|  | 23 | /** | 
| Paul Bakker | 0f5f72e | 2011-01-18 14:58:55 +0000 | [diff] [blame] | 24 | * \addtogroup x509_module | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 25 | * \{ | 
| Paul Bakker | 13e2dfe | 2009-07-28 07:18:38 +0000 | [diff] [blame] | 26 | */ | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 27 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 28 | #if !defined(MBEDTLS_X509_MAX_INTERMEDIATE_CA) | 
| Manuel Pégourié-Gonnard | fd6c85c | 2014-11-20 16:34:20 +0100 | [diff] [blame] | 29 | /** | 
|  | 30 | * Maximum number of intermediate CAs in a verification chain. | 
|  | 31 | * That is, maximum length of the chain, excluding the end-entity certificate | 
|  | 32 | * and the trusted root certificate. | 
|  | 33 | * | 
|  | 34 | * Set this to a low value to prevent an adversary from making you waste | 
|  | 35 | * resources verifying an overlong certificate chain. | 
|  | 36 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 37 | #define MBEDTLS_X509_MAX_INTERMEDIATE_CA   8 | 
| Manuel Pégourié-Gonnard | fd6c85c | 2014-11-20 16:34:20 +0100 | [diff] [blame] | 38 | #endif | 
|  | 39 |  | 
| Paul Bakker | 7c6b2c3 | 2013-09-16 13:49:26 +0200 | [diff] [blame] | 40 | /** | 
| Paul Bakker | 0f5f72e | 2011-01-18 14:58:55 +0000 | [diff] [blame] | 41 | * \name X509 Error codes | 
|  | 42 | * \{ | 
| Paul Bakker | 13e2dfe | 2009-07-28 07:18:38 +0000 | [diff] [blame] | 43 | */ | 
| Gilles Peskine | d297157 | 2021-07-26 18:48:10 +0200 | [diff] [blame] | 44 | /** Unavailable feature, e.g. RSA hashing/encryption combination. */ | 
|  | 45 | #define MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE              -0x2080 | 
|  | 46 | /** Requested OID is unknown. */ | 
|  | 47 | #define MBEDTLS_ERR_X509_UNKNOWN_OID                      -0x2100 | 
|  | 48 | /** The CRT/CRL/CSR format is invalid, e.g. different type expected. */ | 
|  | 49 | #define MBEDTLS_ERR_X509_INVALID_FORMAT                   -0x2180 | 
|  | 50 | /** The CRT/CRL/CSR version element is invalid. */ | 
|  | 51 | #define MBEDTLS_ERR_X509_INVALID_VERSION                  -0x2200 | 
|  | 52 | /** The serial tag or value is invalid. */ | 
|  | 53 | #define MBEDTLS_ERR_X509_INVALID_SERIAL                   -0x2280 | 
|  | 54 | /** The algorithm tag or value is invalid. */ | 
|  | 55 | #define MBEDTLS_ERR_X509_INVALID_ALG                      -0x2300 | 
|  | 56 | /** The name tag or value is invalid. */ | 
|  | 57 | #define MBEDTLS_ERR_X509_INVALID_NAME                     -0x2380 | 
|  | 58 | /** The date tag or value is invalid. */ | 
|  | 59 | #define MBEDTLS_ERR_X509_INVALID_DATE                     -0x2400 | 
|  | 60 | /** The signature tag or value invalid. */ | 
|  | 61 | #define MBEDTLS_ERR_X509_INVALID_SIGNATURE                -0x2480 | 
|  | 62 | /** The extension tag or value is invalid. */ | 
|  | 63 | #define MBEDTLS_ERR_X509_INVALID_EXTENSIONS               -0x2500 | 
|  | 64 | /** CRT/CRL/CSR has an unsupported version number. */ | 
|  | 65 | #define MBEDTLS_ERR_X509_UNKNOWN_VERSION                  -0x2580 | 
|  | 66 | /** Signature algorithm (oid) is unsupported. */ | 
|  | 67 | #define MBEDTLS_ERR_X509_UNKNOWN_SIG_ALG                  -0x2600 | 
|  | 68 | /** Signature algorithms do not match. (see \c ::mbedtls_x509_crt sig_oid) */ | 
|  | 69 | #define MBEDTLS_ERR_X509_SIG_MISMATCH                     -0x2680 | 
|  | 70 | /** Certificate verification failed, e.g. CRL, CA or signature check failed. */ | 
|  | 71 | #define MBEDTLS_ERR_X509_CERT_VERIFY_FAILED               -0x2700 | 
|  | 72 | /** Format not recognized as DER or PEM. */ | 
|  | 73 | #define MBEDTLS_ERR_X509_CERT_UNKNOWN_FORMAT              -0x2780 | 
|  | 74 | /** Input invalid. */ | 
|  | 75 | #define MBEDTLS_ERR_X509_BAD_INPUT_DATA                   -0x2800 | 
|  | 76 | /** Allocation of memory failed. */ | 
|  | 77 | #define MBEDTLS_ERR_X509_ALLOC_FAILED                     -0x2880 | 
|  | 78 | /** Read/write of file failed. */ | 
|  | 79 | #define MBEDTLS_ERR_X509_FILE_IO_ERROR                    -0x2900 | 
|  | 80 | /** Destination buffer is too small. */ | 
|  | 81 | #define MBEDTLS_ERR_X509_BUFFER_TOO_SMALL                 -0x2980 | 
|  | 82 | /** A fatal error occurred, eg the chain is too long or the vrfy callback failed. */ | 
|  | 83 | #define MBEDTLS_ERR_X509_FATAL_ERROR                      -0x3000 | 
| Andrzej Kurek | 38d4fdd | 2021-12-28 16:22:52 +0100 | [diff] [blame] | 84 | /** \} name X509 Error codes */ | 
| Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 85 |  | 
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 86 | /** | 
| Paul Bakker | 0f5f72e | 2011-01-18 14:58:55 +0000 | [diff] [blame] | 87 | * \name X509 Verify codes | 
|  | 88 | * \{ | 
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 89 | */ | 
| Manuel Pégourié-Gonnard | b5f48ad | 2015-04-20 10:38:13 +0100 | [diff] [blame] | 90 | /* 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] | 91 | #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] | 92 | #define MBEDTLS_X509_BADCERT_REVOKED             0x02  /**< The certificate has been revoked (is on a CRL). */ | 
|  | 93 | #define MBEDTLS_X509_BADCERT_CN_MISMATCH         0x04  /**< The certificate Common Name (CN) does not match with the expected CN. */ | 
|  | 94 | #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] | 95 | #define MBEDTLS_X509_BADCRL_NOT_TRUSTED          0x10  /**< The CRL is not correctly signed by the trusted CA. */ | 
|  | 96 | #define MBEDTLS_X509_BADCRL_EXPIRED              0x20  /**< The CRL is expired. */ | 
| Manuel Pégourié-Gonnard | e6028c9 | 2015-04-20 12:19:02 +0100 | [diff] [blame] | 97 | #define MBEDTLS_X509_BADCERT_MISSING             0x40  /**< Certificate was missing. */ | 
|  | 98 | #define MBEDTLS_X509_BADCERT_SKIP_VERIFY         0x80  /**< Certificate verification was skipped. */ | 
|  | 99 | #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] | 100 | #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] | 101 | #define MBEDTLS_X509_BADCRL_FUTURE             0x0400  /**< The CRL is from the future */ | 
|  | 102 | #define MBEDTLS_X509_BADCERT_KEY_USAGE         0x0800  /**< Usage does not match the keyUsage extension. */ | 
|  | 103 | #define MBEDTLS_X509_BADCERT_EXT_KEY_USAGE     0x1000  /**< Usage does not match the extendedKeyUsage extension. */ | 
|  | 104 | #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] | 105 | #define MBEDTLS_X509_BADCERT_BAD_MD            0x4000  /**< The certificate is signed with an unacceptable hash. */ | 
|  | 106 | #define MBEDTLS_X509_BADCERT_BAD_PK            0x8000  /**< The certificate is signed with an unacceptable PK alg (eg RSA vs ECDSA). */ | 
|  | 107 | #define MBEDTLS_X509_BADCERT_BAD_KEY         0x010000  /**< The certificate is signed with an unacceptable key (eg bad curve, RSA too short). */ | 
|  | 108 | #define MBEDTLS_X509_BADCRL_BAD_MD           0x020000  /**< The CRL is signed with an unacceptable hash. */ | 
|  | 109 | #define MBEDTLS_X509_BADCRL_BAD_PK           0x040000  /**< The CRL is signed with an unacceptable PK alg (eg RSA vs ECDSA). */ | 
|  | 110 | #define MBEDTLS_X509_BADCRL_BAD_KEY          0x080000  /**< The CRL is signed with an unacceptable key (eg bad curve, RSA too short). */ | 
|  | 111 |  | 
| Andrzej Kurek | 38d4fdd | 2021-12-28 16:22:52 +0100 | [diff] [blame] | 112 | /** \} name X509 Verify codes */ | 
|  | 113 | /** \} addtogroup x509_module */ | 
| Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 114 |  | 
|  | 115 | /* | 
| Ron Eldor | b2dc3fa | 2019-03-21 13:40:13 +0200 | [diff] [blame] | 116 | * X.509 v3 Subject Alternative Name types. | 
|  | 117 | *      otherName                       [0]     OtherName, | 
|  | 118 | *      rfc822Name                      [1]     IA5String, | 
|  | 119 | *      dNSName                         [2]     IA5String, | 
|  | 120 | *      x400Address                     [3]     ORAddress, | 
|  | 121 | *      directoryName                   [4]     Name, | 
|  | 122 | *      ediPartyName                    [5]     EDIPartyName, | 
|  | 123 | *      uniformResourceIdentifier       [6]     IA5String, | 
|  | 124 | *      iPAddress                       [7]     OCTET STRING, | 
|  | 125 | *      registeredID                    [8]     OBJECT IDENTIFIER | 
|  | 126 | */ | 
|  | 127 | #define MBEDTLS_X509_SAN_OTHER_NAME                      0 | 
|  | 128 | #define MBEDTLS_X509_SAN_RFC822_NAME                     1 | 
|  | 129 | #define MBEDTLS_X509_SAN_DNS_NAME                        2 | 
|  | 130 | #define MBEDTLS_X509_SAN_X400_ADDRESS_NAME               3 | 
|  | 131 | #define MBEDTLS_X509_SAN_DIRECTORY_NAME                  4 | 
|  | 132 | #define MBEDTLS_X509_SAN_EDI_PARTY_NAME                  5 | 
|  | 133 | #define MBEDTLS_X509_SAN_UNIFORM_RESOURCE_IDENTIFIER     6 | 
|  | 134 | #define MBEDTLS_X509_SAN_IP_ADDRESS                      7 | 
|  | 135 | #define MBEDTLS_X509_SAN_REGISTERED_ID                   8 | 
|  | 136 |  | 
|  | 137 | /* | 
| Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 138 | * X.509 v3 Key Usage Extension flags | 
| Przemek Stekiel | 21c3728 | 2023-01-16 08:47:49 +0100 | [diff] [blame] | 139 | * Reminder: update mbedtls_x509_info_key_usage() when adding new flags. | 
| Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 140 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 141 | #define MBEDTLS_X509_KU_DIGITAL_SIGNATURE            (0x80)  /* bit 0 */ | 
|  | 142 | #define MBEDTLS_X509_KU_NON_REPUDIATION              (0x40)  /* bit 1 */ | 
| Manuel Pégourié-Gonnard | e6028c9 | 2015-04-20 12:19:02 +0100 | [diff] [blame] | 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 */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 146 | #define MBEDTLS_X509_KU_KEY_CERT_SIGN                (0x04)  /* bit 5 */ | 
|  | 147 | #define MBEDTLS_X509_KU_CRL_SIGN                     (0x02)  /* bit 6 */ | 
| Manuel Pégourié-Gonnard | 9a70225 | 2015-06-23 10:14:36 +0200 | [diff] [blame] | 148 | #define MBEDTLS_X509_KU_ENCIPHER_ONLY                (0x01)  /* bit 7 */ | 
|  | 149 | #define MBEDTLS_X509_KU_DECIPHER_ONLY              (0x8000)  /* bit 8 */ | 
| Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 150 |  | 
|  | 151 | /* | 
| Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 152 | * Netscape certificate types | 
|  | 153 | * (http://www.mozilla.org/projects/security/pki/nss/tech-notes/tn3.html) | 
|  | 154 | */ | 
|  | 155 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 156 | #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] | 157 | #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] | 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 */ | 
| Manuel Pégourié-Gonnard | e6028c9 | 2015-04-20 12:19:02 +0100 | [diff] [blame] | 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 */ | 
| Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 164 |  | 
| Paul Bakker | c70b982 | 2013-04-07 22:00:46 +0200 | [diff] [blame] | 165 | /* | 
|  | 166 | * X.509 extension types | 
| Manuel Pégourié-Gonnard | b28487d | 2014-04-01 12:19:09 +0200 | [diff] [blame] | 167 | * | 
|  | 168 | * Comments refer to the status for using certificates. Status can be | 
|  | 169 | * different for writing certificates or reading CRLs or CSRs. | 
| Manuel Pégourié-Gonnard | c49ada4 | 2019-01-28 09:20:59 +0100 | [diff] [blame] | 170 | * | 
|  | 171 | * Those are defined in oid.h as oid.c needs them in a data structure. Since | 
|  | 172 | * these were previously defined here, let's have aliases for compatibility. | 
| Paul Bakker | c70b982 | 2013-04-07 22:00:46 +0200 | [diff] [blame] | 173 | */ | 
| Manuel Pégourié-Gonnard | c49ada4 | 2019-01-28 09:20:59 +0100 | [diff] [blame] | 174 | #define MBEDTLS_X509_EXT_AUTHORITY_KEY_IDENTIFIER MBEDTLS_OID_X509_EXT_AUTHORITY_KEY_IDENTIFIER | 
|  | 175 | #define MBEDTLS_X509_EXT_SUBJECT_KEY_IDENTIFIER   MBEDTLS_OID_X509_EXT_SUBJECT_KEY_IDENTIFIER | 
|  | 176 | #define MBEDTLS_X509_EXT_KEY_USAGE                MBEDTLS_OID_X509_EXT_KEY_USAGE | 
|  | 177 | #define MBEDTLS_X509_EXT_CERTIFICATE_POLICIES     MBEDTLS_OID_X509_EXT_CERTIFICATE_POLICIES | 
|  | 178 | #define MBEDTLS_X509_EXT_POLICY_MAPPINGS          MBEDTLS_OID_X509_EXT_POLICY_MAPPINGS | 
|  | 179 | #define MBEDTLS_X509_EXT_SUBJECT_ALT_NAME         MBEDTLS_OID_X509_EXT_SUBJECT_ALT_NAME         /* Supported (DNS) */ | 
|  | 180 | #define MBEDTLS_X509_EXT_ISSUER_ALT_NAME          MBEDTLS_OID_X509_EXT_ISSUER_ALT_NAME | 
|  | 181 | #define MBEDTLS_X509_EXT_SUBJECT_DIRECTORY_ATTRS  MBEDTLS_OID_X509_EXT_SUBJECT_DIRECTORY_ATTRS | 
|  | 182 | #define MBEDTLS_X509_EXT_BASIC_CONSTRAINTS        MBEDTLS_OID_X509_EXT_BASIC_CONSTRAINTS        /* Supported */ | 
|  | 183 | #define MBEDTLS_X509_EXT_NAME_CONSTRAINTS         MBEDTLS_OID_X509_EXT_NAME_CONSTRAINTS | 
|  | 184 | #define MBEDTLS_X509_EXT_POLICY_CONSTRAINTS       MBEDTLS_OID_X509_EXT_POLICY_CONSTRAINTS | 
|  | 185 | #define MBEDTLS_X509_EXT_EXTENDED_KEY_USAGE       MBEDTLS_OID_X509_EXT_EXTENDED_KEY_USAGE | 
|  | 186 | #define MBEDTLS_X509_EXT_CRL_DISTRIBUTION_POINTS  MBEDTLS_OID_X509_EXT_CRL_DISTRIBUTION_POINTS | 
|  | 187 | #define MBEDTLS_X509_EXT_INIHIBIT_ANYPOLICY       MBEDTLS_OID_X509_EXT_INIHIBIT_ANYPOLICY | 
|  | 188 | #define MBEDTLS_X509_EXT_FRESHEST_CRL             MBEDTLS_OID_X509_EXT_FRESHEST_CRL | 
|  | 189 | #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] | 190 |  | 
| Paul Bakker | 6c0ceb3 | 2011-12-04 12:24:18 +0000 | [diff] [blame] | 191 | /* | 
|  | 192 | * Storage format identifiers | 
|  | 193 | * Recognized formats: PEM and DER | 
|  | 194 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 195 | #define MBEDTLS_X509_FORMAT_DER                 1 | 
|  | 196 | #define MBEDTLS_X509_FORMAT_PEM                 2 | 
| Paul Bakker | 6c0ceb3 | 2011-12-04 12:24:18 +0000 | [diff] [blame] | 197 |  | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 198 | #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] | 199 |  | 
| Paul Bakker | 407a0da | 2013-06-27 14:29:21 +0200 | [diff] [blame] | 200 | #ifdef __cplusplus | 
|  | 201 | extern "C" { | 
|  | 202 | #endif | 
|  | 203 |  | 
| Paul Bakker | e5eae76 | 2013-08-26 12:05:14 +0200 | [diff] [blame] | 204 | /** | 
| Paul Bakker | 0f5f72e | 2011-01-18 14:58:55 +0000 | [diff] [blame] | 205 | * \addtogroup x509_module | 
|  | 206 | * \{ */ | 
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 207 |  | 
|  | 208 | /** | 
| Paul Bakker | f9f377e | 2013-09-09 15:35:10 +0200 | [diff] [blame] | 209 | * \name Structures for parsing X.509 certificates, CRLs and CSRs | 
| Paul Bakker | 0f5f72e | 2011-01-18 14:58:55 +0000 | [diff] [blame] | 210 | * \{ | 
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 211 | */ | 
| Paul Bakker | e5eae76 | 2013-08-26 12:05:14 +0200 | [diff] [blame] | 212 |  | 
|  | 213 | /** | 
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 214 | * Type-length-value structure that allows for ASN1 using DER. | 
| Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 215 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 216 | typedef mbedtls_asn1_buf mbedtls_x509_buf; | 
| Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 217 |  | 
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 218 | /** | 
| Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 219 | * Container for ASN1 bit strings. | 
|  | 220 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 221 | typedef mbedtls_asn1_bitstring mbedtls_x509_bitstring; | 
| Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 222 |  | 
|  | 223 | /** | 
| Paul Bakker | e5eae76 | 2013-08-26 12:05:14 +0200 | [diff] [blame] | 224 | * Container for ASN1 named information objects. | 
| Manuel Pégourié-Gonnard | 83b04de | 2015-03-09 17:33:07 +0000 | [diff] [blame] | 225 | * 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] | 226 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 227 | typedef mbedtls_asn1_named_data mbedtls_x509_name; | 
| Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 228 |  | 
| Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 229 | /** | 
|  | 230 | * Container for a sequence of ASN.1 items | 
|  | 231 | */ | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 232 | typedef mbedtls_asn1_sequence mbedtls_x509_sequence; | 
| Paul Bakker | 74111d3 | 2011-01-15 16:57:55 +0000 | [diff] [blame] | 233 |  | 
| toth92g | a41954d | 2021-02-12 16:11:17 +0100 | [diff] [blame] | 234 | /* | 
|  | 235 | * Container for the fields of the Authority Key Identifier object | 
|  | 236 | */ | 
|  | 237 | typedef struct mbedtls_x509_authority { | 
|  | 238 | mbedtls_x509_buf keyIdentifier; | 
| toth92g | 8d435a0 | 2021-05-10 15:16:33 +0200 | [diff] [blame] | 239 | mbedtls_x509_sequence authorityCertIssuer; | 
| toth92g | a41954d | 2021-02-12 16:11:17 +0100 | [diff] [blame] | 240 | mbedtls_x509_buf authorityCertSerialNumber; | 
|  | 241 | mbedtls_x509_buf raw; | 
|  | 242 | } | 
|  | 243 | mbedtls_x509_authority; | 
|  | 244 |  | 
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 245 | /** Container for date and time (precision in seconds). */ | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 246 | typedef struct mbedtls_x509_time { | 
| Gilles Peskine | 842edf4 | 2021-08-04 21:56:10 +0200 | [diff] [blame] | 247 | int year, mon, day;         /**< Date. */ | 
|  | 248 | int hour, min, sec;         /**< Time. */ | 
| Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 249 | } | 
| Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 250 | mbedtls_x509_time; | 
| Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 251 |  | 
| Przemek Stekiel | cf6ff0f | 2023-01-17 10:26:40 +0100 | [diff] [blame] | 252 | /** | 
|  | 253 | * From RFC 5280 section 4.2.1.6: | 
|  | 254 | * OtherName ::= SEQUENCE { | 
|  | 255 | *      type-id    OBJECT IDENTIFIER, | 
|  | 256 | *      value      [0] EXPLICIT ANY DEFINED BY type-id } | 
|  | 257 | * | 
|  | 258 | * Future versions of the library may add new fields to this structure or | 
|  | 259 | * to its embedded union and structure. | 
|  | 260 | */ | 
|  | 261 | typedef struct mbedtls_x509_san_other_name { | 
|  | 262 | /** | 
|  | 263 | * The type_id is an OID as defined in RFC 5280. | 
|  | 264 | * To check the value of the type id, you should use | 
|  | 265 | * \p MBEDTLS_OID_CMP with a known OID mbedtls_x509_buf. | 
|  | 266 | */ | 
|  | 267 | mbedtls_x509_buf type_id;                   /**< The type id. */ | 
|  | 268 | union { | 
|  | 269 | /** | 
|  | 270 | * From RFC 4108 section 5: | 
|  | 271 | * HardwareModuleName ::= SEQUENCE { | 
|  | 272 | *                         hwType OBJECT IDENTIFIER, | 
|  | 273 | *                         hwSerialNum OCTET STRING } | 
|  | 274 | */ | 
|  | 275 | struct { | 
|  | 276 | mbedtls_x509_buf oid;               /**< The object identifier. */ | 
|  | 277 | mbedtls_x509_buf val;               /**< The named value. */ | 
|  | 278 | } | 
|  | 279 | hardware_module_name; | 
|  | 280 | } | 
|  | 281 | value; | 
|  | 282 | } | 
|  | 283 | mbedtls_x509_san_other_name; | 
|  | 284 |  | 
|  | 285 | /** | 
|  | 286 | * A structure for holding the parsed Subject Alternative Name, | 
|  | 287 | * according to type. | 
|  | 288 | * | 
|  | 289 | * Future versions of the library may add new fields to this structure or | 
|  | 290 | * to its embedded union and structure. | 
|  | 291 | */ | 
|  | 292 | typedef struct mbedtls_x509_subject_alternative_name { | 
|  | 293 | int type;                              /**< The SAN type, value of MBEDTLS_X509_SAN_XXX. */ | 
|  | 294 | union { | 
| Andrzej Kurek | 1747304 | 2023-04-30 14:11:23 -0400 | [diff] [blame] | 295 | mbedtls_x509_san_other_name other_name; | 
| Andrzej Kurek | e12b01d | 2023-01-10 06:47:38 -0500 | [diff] [blame] | 296 | mbedtls_x509_name directory_name; | 
|  | 297 | 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] | 298 | } | 
|  | 299 | san; /**< A union of the supported SAN types */ | 
|  | 300 | } | 
|  | 301 | mbedtls_x509_subject_alternative_name; | 
|  | 302 |  | 
| Andrzej Kurek | 1a75269 | 2023-04-01 09:44:11 -0400 | [diff] [blame] | 303 | typedef struct mbedtls_x509_san_list { | 
|  | 304 | mbedtls_x509_subject_alternative_name node; | 
|  | 305 | struct mbedtls_x509_san_list *next; | 
|  | 306 | } | 
|  | 307 | mbedtls_x509_san_list; | 
|  | 308 |  | 
| Paul Bakker | f9f377e | 2013-09-09 15:35:10 +0200 | [diff] [blame] | 309 | /** \} name Structures for parsing X.509 certificates, CRLs and CSRs */ | 
| Valerio Setti | 25b282e | 2024-01-17 10:55:32 +0100 | [diff] [blame] | 310 | /** \} addtogroup x509_module */ | 
| Paul Bakker | d98030e | 2009-05-02 15:13:40 +0000 | [diff] [blame] | 311 |  | 
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 312 | /** | 
| Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 313 | * \brief          Store the certificate DN in printable form into buf; | 
| Paul Bakker | d98030e | 2009-05-02 15:13:40 +0000 | [diff] [blame] | 314 | *                 no more than size characters will be written. | 
| Paul Bakker | 13e2dfe | 2009-07-28 07:18:38 +0000 | [diff] [blame] | 315 | * | 
|  | 316 | * \param buf      Buffer to write to | 
|  | 317 | * \param size     Maximum size of buffer | 
|  | 318 | * \param dn       The X509 name to represent | 
|  | 319 | * | 
| Manuel Pégourié-Gonnard | e244f9f | 2015-06-23 12:10:45 +0200 | [diff] [blame] | 320 | * \return         The length of the string written (not including the | 
|  | 321 | *                 terminated nul byte), or a negative error code. | 
| Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 322 | */ | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 323 | 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] | 324 |  | 
| Andrzej Kurek | cd17ecf | 2023-06-05 17:02:17 -0400 | [diff] [blame] | 325 | /** | 
| David Horstmann | ef950cc | 2024-02-26 13:59:43 +0000 | [diff] [blame] | 326 | * \brief            Convert the certificate DN string \p name into | 
|  | 327 | *                   a linked list of mbedtls_x509_name (equivalent to | 
|  | 328 | *                   mbedtls_asn1_named_data). | 
|  | 329 | * | 
|  | 330 | * \note             This function allocates a linked list, and places the head | 
|  | 331 | *                   pointer in \p head. This list must later be freed by a | 
|  | 332 | *                   call to mbedtls_asn1_free_named_data_list(). | 
|  | 333 | * | 
|  | 334 | * \param[out] head  Address in which to store the pointer to the head of the | 
|  | 335 | *                   allocated list of mbedtls_x509_name | 
|  | 336 | * \param[in] name   The string representation of a DN to convert | 
|  | 337 | * | 
|  | 338 | * \return           0 on success, or a negative error code. | 
|  | 339 | */ | 
|  | 340 | int mbedtls_x509_string_to_names(mbedtls_asn1_named_data **head, const char *name); | 
|  | 341 |  | 
|  | 342 | /** | 
| David Horstmann | 762f9f9 | 2024-02-19 11:07:50 +0000 | [diff] [blame] | 343 | * \brief          Return the next relative DN in an X509 name. | 
|  | 344 | * | 
|  | 345 | * \note           Intended use is to compare function result to dn->next | 
|  | 346 | *                 in order to detect boundaries of multi-valued RDNs. | 
|  | 347 | * | 
|  | 348 | * \param dn       Current node in the X509 name | 
|  | 349 | * | 
|  | 350 | * \return         Pointer to the first attribute-value pair of the | 
|  | 351 | *                 next RDN in sequence, or NULL if end is reached. | 
|  | 352 | */ | 
|  | 353 | static inline mbedtls_x509_name *mbedtls_x509_dn_get_next( | 
|  | 354 | mbedtls_x509_name *dn) | 
|  | 355 | { | 
|  | 356 | while (dn->MBEDTLS_PRIVATE(next_merged) && dn->next != NULL) { | 
|  | 357 | dn = dn->next; | 
|  | 358 | } | 
|  | 359 | return dn->next; | 
|  | 360 | } | 
|  | 361 |  | 
|  | 362 | /** | 
|  | 363 | * \brief          Store the certificate serial in printable form into buf; | 
|  | 364 | *                 no more than size characters will be written. | 
|  | 365 | * | 
|  | 366 | * \param buf      Buffer to write to | 
|  | 367 | * \param size     Maximum size of buffer | 
|  | 368 | * \param serial   The X509 serial to represent | 
|  | 369 | * | 
|  | 370 | * \return         The length of the string written (not including the | 
|  | 371 | *                 terminated nul byte), or a negative error code. | 
|  | 372 | */ | 
|  | 373 | int mbedtls_x509_serial_gets(char *buf, size_t size, const mbedtls_x509_buf *serial); | 
|  | 374 |  | 
|  | 375 | /** | 
|  | 376 | * \brief          Compare pair of mbedtls_x509_time. | 
|  | 377 | * | 
|  | 378 | * \param t1       mbedtls_x509_time to compare | 
|  | 379 | * \param t2       mbedtls_x509_time to compare | 
|  | 380 | * | 
|  | 381 | * \return         < 0 if t1 is before t2 | 
|  | 382 | *                   0 if t1 equals t2 | 
|  | 383 | *                 > 0 if t1 is after t2 | 
|  | 384 | */ | 
|  | 385 | int mbedtls_x509_time_cmp(const mbedtls_x509_time *t1, const mbedtls_x509_time *t2); | 
|  | 386 |  | 
|  | 387 | #if defined(MBEDTLS_HAVE_TIME_DATE) | 
|  | 388 | /** | 
|  | 389 | * \brief          Fill mbedtls_x509_time with provided mbedtls_time_t. | 
|  | 390 | * | 
|  | 391 | * \param tt       mbedtls_time_t to convert | 
|  | 392 | * \param now      mbedtls_x509_time to fill with converted mbedtls_time_t | 
|  | 393 | * | 
|  | 394 | * \return         \c 0 on success | 
|  | 395 | * \return         A non-zero return value on failure. | 
|  | 396 | */ | 
|  | 397 | int mbedtls_x509_time_gmtime(mbedtls_time_t tt, mbedtls_x509_time *now); | 
|  | 398 | #endif /* MBEDTLS_HAVE_TIME_DATE */ | 
|  | 399 |  | 
|  | 400 | /** | 
|  | 401 | * \brief          Check a given mbedtls_x509_time against the system time | 
|  | 402 | *                 and tell if it's in the past. | 
|  | 403 | * | 
|  | 404 | * \note           Intended usage is "if( is_past( valid_to ) ) ERROR". | 
|  | 405 | *                 Hence the return value of 1 if on internal errors. | 
|  | 406 | * | 
|  | 407 | * \param to       mbedtls_x509_time to check | 
|  | 408 | * | 
|  | 409 | * \return         1 if the given time is in the past or an error occurred, | 
|  | 410 | *                 0 otherwise. | 
|  | 411 | */ | 
|  | 412 | int mbedtls_x509_time_is_past(const mbedtls_x509_time *to); | 
|  | 413 |  | 
|  | 414 | /** | 
|  | 415 | * \brief          Check a given mbedtls_x509_time against the system time | 
|  | 416 | *                 and tell if it's in the future. | 
|  | 417 | * | 
|  | 418 | * \note           Intended usage is "if( is_future( valid_from ) ) ERROR". | 
|  | 419 | *                 Hence the return value of 1 if on internal errors. | 
|  | 420 | * | 
|  | 421 | * \param from     mbedtls_x509_time to check | 
|  | 422 | * | 
|  | 423 | * \return         1 if the given time is in the future or an error occurred, | 
|  | 424 | *                 0 otherwise. | 
|  | 425 | */ | 
|  | 426 | int mbedtls_x509_time_is_future(const mbedtls_x509_time *from); | 
|  | 427 |  | 
|  | 428 | /** | 
|  | 429 | * \brief          This function parses an item in the SubjectAlternativeNames | 
|  | 430 | *                 extension. Please note that this function might allocate | 
|  | 431 | *                 additional memory for a subject alternative name, thus | 
|  | 432 | *                 mbedtls_x509_free_subject_alt_name has to be called | 
|  | 433 | *                 to dispose of this additional memory afterwards. | 
|  | 434 | * | 
|  | 435 | * \param san_buf  The buffer holding the raw data item of the subject | 
|  | 436 | *                 alternative name. | 
|  | 437 | * \param san      The target structure to populate with the parsed presentation | 
|  | 438 | *                 of the subject alternative name encoded in \p san_buf. | 
|  | 439 | * | 
|  | 440 | * \note           Supported GeneralName types, as defined in RFC 5280: | 
|  | 441 | *                 "rfc822Name", "dnsName", "directoryName", | 
|  | 442 | *                 "uniformResourceIdentifier" and "hardware_module_name" | 
|  | 443 | *                 of type "otherName", as defined in RFC 4108. | 
|  | 444 | * | 
|  | 445 | * \note           This function should be called on a single raw data of | 
|  | 446 | *                 subject alternative name. For example, after successful | 
|  | 447 | *                 certificate parsing, one must iterate on every item in the | 
|  | 448 | *                 \c crt->subject_alt_names sequence, and pass it to | 
|  | 449 | *                 this function. | 
|  | 450 | * | 
|  | 451 | * \warning        The target structure contains pointers to the raw data of the | 
|  | 452 | *                 parsed certificate, and its lifetime is restricted by the | 
|  | 453 | *                 lifetime of the certificate. | 
|  | 454 | * | 
|  | 455 | * \return         \c 0 on success | 
|  | 456 | * \return         #MBEDTLS_ERR_X509_FEATURE_UNAVAILABLE for an unsupported | 
|  | 457 | *                 SAN type. | 
|  | 458 | * \return         Another negative value for any other failure. | 
|  | 459 | */ | 
|  | 460 | int mbedtls_x509_parse_subject_alt_name(const mbedtls_x509_buf *san_buf, | 
|  | 461 | mbedtls_x509_subject_alternative_name *san); | 
|  | 462 | /** | 
|  | 463 | * \brief          Unallocate all data related to subject alternative name | 
|  | 464 | * | 
|  | 465 | * \param san      SAN structure - extra memory owned by this structure will be freed | 
|  | 466 | */ | 
|  | 467 | void mbedtls_x509_free_subject_alt_name(mbedtls_x509_subject_alternative_name *san); | 
|  | 468 |  | 
|  | 469 | /** | 
| Andrzej Kurek | cd17ecf | 2023-06-05 17:02:17 -0400 | [diff] [blame] | 470 | * \brief          This function parses a CN string as an IP address. | 
|  | 471 | * | 
| Andrzej Kurek | c6beb3a | 2023-06-15 09:54:37 -0400 | [diff] [blame] | 472 | * \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] | 473 | * \param dst      The target buffer to populate with the binary IP address. | 
|  | 474 | *                 The buffer MUST be 16 bytes to save IPv6, and should be | 
|  | 475 | *                 4-byte aligned if the result will be used as struct in_addr. | 
|  | 476 | *                 e.g. uint32_t dst[4] | 
|  | 477 | * | 
| Andrzej Kurek | 5d9aeba | 2023-05-22 15:16:05 -0400 | [diff] [blame] | 478 | * \note           \p cn is parsed as an IPv6 address if string contains ':', | 
|  | 479 | *                 else \p cn is parsed as an IPv4 address. | 
| Andrzej Kurek | cd17ecf | 2023-06-05 17:02:17 -0400 | [diff] [blame] | 480 | * | 
|  | 481 | * \return         Length of binary IP address; num bytes written to target. | 
|  | 482 | * \return         \c 0 on failure to parse CN string as an IP address. | 
|  | 483 | */ | 
|  | 484 | size_t mbedtls_x509_crt_parse_cn_inet_pton(const char *cn, void *dst); | 
|  | 485 |  | 
| Manuel Pégourié-Gonnard | 1685368 | 2015-06-22 11:12:02 +0200 | [diff] [blame] | 486 | #define MBEDTLS_X509_SAFE_SNPRINTF                          \ | 
|  | 487 | do {                                                    \ | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 488 | if (ret < 0 || (size_t) ret >= n)                  \ | 
|  | 489 | return MBEDTLS_ERR_X509_BUFFER_TOO_SMALL;    \ | 
|  | 490 | \ | 
| Manuel Pégourié-Gonnard | 1685368 | 2015-06-22 11:12:02 +0200 | [diff] [blame] | 491 | n -= (size_t) ret;                                  \ | 
|  | 492 | p += (size_t) ret;                                  \ | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 493 | } while (0) | 
| Manuel Pégourié-Gonnard | 1685368 | 2015-06-22 11:12:02 +0200 | [diff] [blame] | 494 |  | 
| Sam Berry | f8db5b6 | 2024-07-19 14:48:40 +0100 | [diff] [blame] | 495 | /** | 
|  | 496 | * \brief           Translate an ASN.1 OID into its numeric representation | 
|  | 497 | *                  (e.g. "\x2A\x86\x48\x86\xF7\x0D" into "1.2.840.113549") | 
|  | 498 | * | 
|  | 499 | * \param buf       buffer to put representation in | 
|  | 500 | * \param size      size of the buffer | 
|  | 501 | * \param oid       OID to translate | 
|  | 502 | * | 
|  | 503 | * \return          Length of the string written (excluding final NULL) or | 
|  | 504 | *                  MBEDTLS_ERR_OID_BUF_TOO_SMALL in case of error | 
|  | 505 | */ | 
|  | 506 | int mbedtls_oid_get_numeric_string(char *buf, size_t size, const mbedtls_asn1_buf *oid); | 
|  | 507 |  | 
|  | 508 | /** | 
|  | 509 | * \brief           Translate a string containing a dotted-decimal | 
|  | 510 | *                  representation of an ASN.1 OID into its encoded form | 
|  | 511 | *                  (e.g. "1.2.840.113549" into "\x2A\x86\x48\x86\xF7\x0D"). | 
|  | 512 | *                  On success, this function allocates oid->buf from the | 
|  | 513 | *                  heap. It must be freed by the caller using mbedtls_free(). | 
|  | 514 | * | 
|  | 515 | * \param oid       #mbedtls_asn1_buf to populate with the DER-encoded OID | 
|  | 516 | * \param oid_str   string representation of the OID to parse | 
|  | 517 | * \param size      length of the OID string, not including any null terminator | 
|  | 518 | * | 
|  | 519 | * \return          0 if successful | 
|  | 520 | * \return          #MBEDTLS_ERR_ASN1_INVALID_DATA if \p oid_str does not | 
|  | 521 | *                  represent a valid OID | 
|  | 522 | * \return          #MBEDTLS_ERR_ASN1_ALLOC_FAILED if the function fails to | 
|  | 523 | *                  allocate oid->buf | 
|  | 524 | */ | 
|  | 525 | int mbedtls_oid_from_numeric_string(mbedtls_asn1_buf *oid, const char *oid_str, size_t size); | 
|  | 526 |  | 
| Paul Bakker | 30b95fa | 2013-10-01 10:09:06 +0200 | [diff] [blame] | 527 | #ifdef __cplusplus | 
|  | 528 | } | 
|  | 529 | #endif | 
|  | 530 |  | 
| Valerio Setti | 25b282e | 2024-01-17 10:55:32 +0100 | [diff] [blame] | 531 | #endif /* MBEDTLS_X509_H */ |