1 /** 2 * \file x509_crl.h 3 * 4 * \brief X.509 certificate revocation list parsing 5 */ 6 /* 7 * Copyright The Mbed TLS Contributors 8 * SPDX-License-Identifier: Apache-2.0 9 * 10 * Licensed under the Apache License, Version 2.0 (the "License"); you may 11 * not use this file except in compliance with the License. 12 * You may obtain a copy of the License at 13 * 14 * http://www.apache.org/licenses/LICENSE-2.0 15 * 16 * Unless required by applicable law or agreed to in writing, software 17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 19 * See the License for the specific language governing permissions and 20 * limitations under the License. 21 */ 22 #ifndef MBEDTLS_X509_CRL_H 23 #define MBEDTLS_X509_CRL_H 24 #include "mbedtls/private_access.h" 25 26 #include "mbedtls/build_info.h" 27 28 #include "mbedtls/x509.h" 29 30 #ifdef __cplusplus 31 extern "C" { 32 #endif 33 34 /** 35 * \addtogroup x509_module 36 * \{ */ 37 38 /** 39 * \name Structures and functions for parsing CRLs 40 * \{ 41 */ 42 43 /** 44 * Certificate revocation list entry. 45 * Contains the CA-specific serial numbers and revocation dates. 46 * 47 * Some fields of this structure are publicly readable. Do not modify 48 * them except via Mbed TLS library functions: the effect of modifying 49 * those fields or the data that those fields points to is unspecified. 50 */ 51 typedef struct mbedtls_x509_crl_entry { 52 /** Direct access to the whole entry inside the containing buffer. */ 53 mbedtls_x509_buf raw; 54 /** The serial number of the revoked certificate. */ 55 mbedtls_x509_buf serial; 56 /** The revocation date of this entry. */ 57 mbedtls_x509_time revocation_date; 58 /** Direct access to the list of CRL entry extensions 59 * (an ASN.1 constructed sequence). 60 * 61 * If there are no extensions, `entry_ext.len == 0` and 62 * `entry_ext.p == NULL`. */ 63 mbedtls_x509_buf entry_ext; 64 65 /** Next element in the linked list of entries. 66 * \p NULL indicates the end of the list. 67 * Do not modify this field directly. */ 68 struct mbedtls_x509_crl_entry *next; 69 } 70 mbedtls_x509_crl_entry; 71 72 /** 73 * Certificate revocation list structure. 74 * Every CRL may have multiple entries. 75 */ 76 typedef struct mbedtls_x509_crl { 77 mbedtls_x509_buf raw; /**< The raw certificate data (DER). */ 78 mbedtls_x509_buf tbs; /**< The raw certificate body (DER). The part that is To Be Signed. */ 79 80 int version; /**< CRL version (1=v1, 2=v2) */ 81 mbedtls_x509_buf sig_oid; /**< CRL signature type identifier */ 82 83 mbedtls_x509_buf issuer_raw; /**< The raw issuer data (DER). */ 84 85 mbedtls_x509_name issuer; /**< The parsed issuer data (named information object). */ 86 87 mbedtls_x509_time this_update; 88 mbedtls_x509_time next_update; 89 90 mbedtls_x509_crl_entry entry; /**< The CRL entries containing the certificate revocation times for this CA. */ 91 92 mbedtls_x509_buf crl_ext; 93 94 mbedtls_x509_buf MBEDTLS_PRIVATE(sig_oid2); 95 mbedtls_x509_buf MBEDTLS_PRIVATE(sig); 96 mbedtls_md_type_t MBEDTLS_PRIVATE(sig_md); /**< Internal representation of the MD algorithm of the signature algorithm, e.g. MBEDTLS_MD_SHA256 */ 97 mbedtls_pk_type_t MBEDTLS_PRIVATE(sig_pk); /**< Internal representation of the Public Key algorithm of the signature algorithm, e.g. MBEDTLS_PK_RSA */ 98 void *MBEDTLS_PRIVATE(sig_opts); /**< Signature options to be passed to mbedtls_pk_verify_ext(), e.g. for RSASSA-PSS */ 99 100 /** Next element in the linked list of CRL. 101 * \p NULL indicates the end of the list. 102 * Do not modify this field directly. */ 103 struct mbedtls_x509_crl *next; 104 } 105 mbedtls_x509_crl; 106 107 /** 108 * \brief Parse a DER-encoded CRL and append it to the chained list 109 * 110 * \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto 111 * subsystem must have been initialized by calling 112 * psa_crypto_init() before calling this function. 113 * 114 * \param chain points to the start of the chain 115 * \param buf buffer holding the CRL data in DER format 116 * \param buflen size of the buffer 117 * (including the terminating null byte for PEM data) 118 * 119 * \return 0 if successful, or a specific X509 or PEM error code 120 */ 121 int mbedtls_x509_crl_parse_der(mbedtls_x509_crl *chain, 122 const unsigned char *buf, size_t buflen); 123 /** 124 * \brief Parse one or more CRLs and append them to the chained list 125 * 126 * \note Multiple CRLs are accepted only if using PEM format 127 * 128 * \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto 129 * subsystem must have been initialized by calling 130 * psa_crypto_init() before calling this function. 131 * 132 * \param chain points to the start of the chain 133 * \param buf buffer holding the CRL data in PEM or DER format 134 * \param buflen size of the buffer 135 * (including the terminating null byte for PEM data) 136 * 137 * \return 0 if successful, or a specific X509 or PEM error code 138 */ 139 int mbedtls_x509_crl_parse(mbedtls_x509_crl *chain, const unsigned char *buf, size_t buflen); 140 141 #if defined(MBEDTLS_FS_IO) 142 /** 143 * \brief Load one or more CRLs and append them to the chained list 144 * 145 * \note Multiple CRLs are accepted only if using PEM format 146 * 147 * \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto 148 * subsystem must have been initialized by calling 149 * psa_crypto_init() before calling this function. 150 * 151 * \param chain points to the start of the chain 152 * \param path filename to read the CRLs from (in PEM or DER encoding) 153 * 154 * \return 0 if successful, or a specific X509 or PEM error code 155 */ 156 int mbedtls_x509_crl_parse_file(mbedtls_x509_crl *chain, const char *path); 157 #endif /* MBEDTLS_FS_IO */ 158 159 #if !defined(MBEDTLS_X509_REMOVE_INFO) 160 /** 161 * \brief Returns an informational string about the CRL. 162 * 163 * \param buf Buffer to write to 164 * \param size Maximum size of buffer 165 * \param prefix A line prefix 166 * \param crl The X509 CRL to represent 167 * 168 * \return The length of the string written (not including the 169 * terminated nul byte), or a negative error code. 170 */ 171 int mbedtls_x509_crl_info(char *buf, size_t size, const char *prefix, 172 const mbedtls_x509_crl *crl); 173 #endif /* !MBEDTLS_X509_REMOVE_INFO */ 174 175 /** 176 * \brief Initialize a CRL (chain) 177 * 178 * \param crl CRL chain to initialize 179 */ 180 void mbedtls_x509_crl_init(mbedtls_x509_crl *crl); 181 182 /** 183 * \brief Unallocate all CRL data 184 * 185 * \param crl CRL chain to free 186 */ 187 void mbedtls_x509_crl_free(mbedtls_x509_crl *crl); 188 189 /** \} name Structures and functions for parsing CRLs */ 190 /** \} addtogroup x509_module */ 191 192 #ifdef __cplusplus 193 } 194 #endif 195 196 #endif /* mbedtls_x509_crl.h */ 197