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