Documentation

Documentation

Includes

config.h

#include "config.h"
#include "config.h"

MBEDTLS_CONFIG_FILE

#include MBEDTLS_CONFIG_FILE
#include MBEDTLS_CONFIG_FILE

x509.h

#include "x509.h"
#include "x509.h"

Macros

Marco MBEDTLS_X509_CRL_H

#define MBEDTLS_X509_CRL_H

      

Functions

Func mbedtls_x509_crl_parse_der

int mbedtls_x509_crl_parse_der( mbedtls_x509_crl *chain,
                       const unsigned char *buf, size_t buflen );
/**
 * \brief          Parse a DER-encoded CRL and append it to the chained list
 *
 * \param chain    points to the start of the chain
 * \param buf      buffer holding the CRL data in DER format
 * \param buflen   size of the buffer
 *                 (including the terminating null byte for PEM data)
 *
 * \return         0 if successful, or a specific X509 or PEM error code
 */

Func mbedtls_x509_crl_parse

int mbedtls_x509_crl_parse( mbedtls_x509_crl *chain, const unsigned char *buf, size_t buflen );
/**
 * \brief          Parse one or more CRLs and append them to the chained list
 *
 * \note           Mutliple CRLs are accepted only if using PEM format
 *
 * \param chain    points to the start of the chain
 * \param buf      buffer holding the CRL data in PEM or DER format
 * \param buflen   size of the buffer
 *                 (including the terminating null byte for PEM data)
 *
 * \return         0 if successful, or a specific X509 or PEM error code
 */

Func mbedtls_x509_crl_parse_file

int mbedtls_x509_crl_parse_file( mbedtls_x509_crl *chain, const char *path );
/**
 * \brief          Load one or more CRLs and append them to the chained list
 *
 * \note           Mutliple CRLs are accepted only if using PEM format
 *
 * \param chain    points to the start of the chain
 * \param path     filename to read the CRLs from (in PEM or DER encoding)
 *
 * \return         0 if successful, or a specific X509 or PEM error code
 */

Func mbedtls_x509_crl_info

int mbedtls_x509_crl_info( char *buf, size_t size, const char *prefix,
                  const mbedtls_x509_crl *crl );
/**
 * \brief          Returns an informational string about the CRL.
 *
 * \param buf      Buffer to write to
 * \param size     Maximum size of buffer
 * \param prefix   A line prefix
 * \param crl      The X509 CRL to represent
 *
 * \return         The length of the string written (not including the
 *                 terminated nul byte), or a negative error code.
 */

Func mbedtls_x509_crl_init

void mbedtls_x509_crl_init( mbedtls_x509_crl *crl );
/**
 * \brief          Initialize a CRL (chain)
 *
 * \param crl      CRL chain to initialize
 */

Func mbedtls_x509_crl_free

void mbedtls_x509_crl_free( mbedtls_x509_crl *crl );
/**
 * \brief          Unallocate all CRL data
 *
 * \param crl      CRL chain to free
 */

Vars

Consts

Types

Typedefs

Typedef mbedtls_x509_crl_entry;

typedef struct mbedtls_x509_crl_entry
{
   mbedtls_x509_buf raw;

   mbedtls_x509_buf serial;

   mbedtls_x509_time revocation_date;

   mbedtls_x509_buf entry_ext;

   struct mbedtls_x509_crl_entry *next;
}
mbedtls_x509_crl_entry;
/**
 * Certificate revocation list entry.
 * Contains the CA-specific serial numbers and revocation dates.
 */

Typedef mbedtls_x509_crl;

typedef struct mbedtls_x509_crl
{
   mbedtls_x509_buf raw;          /**< The raw certificate data (DER). */
   mbedtls_x509_buf tbs;          /**< The raw certificate body (DER). The part that is To Be Signed. */

   int version;           /**< CRL version (1=v1, 2=v2) */
   mbedtls_x509_buf sig_oid;      /**< CRL signature type identifier */

   mbedtls_x509_buf issuer_raw;   /**< The raw issuer data (DER). */

   mbedtls_x509_name issuer;      /**< The parsed issuer data (named information object). */

   mbedtls_x509_time this_update;
   mbedtls_x509_time next_update;

   mbedtls_x509_crl_entry entry;  /**< The CRL entries containing the certificate revocation times for this CA. */

   mbedtls_x509_buf crl_ext;

   mbedtls_x509_buf sig_oid2;
   mbedtls_x509_buf sig;
   mbedtls_md_type_t sig_md;          /**< Internal representation of the MD algorithm of the signature algorithm, e.g. MBEDTLS_MD_SHA256 */
   mbedtls_pk_type_t sig_pk;          /**< Internal representation of the Public Key algorithm of the signature algorithm, e.g. MBEDTLS_PK_RSA */
   void *sig_opts;            /**< Signature options to be passed to mbedtls_pk_verify_ext(), e.g. for RSASSA-PSS */

   struct mbedtls_x509_crl *next;
}
mbedtls_x509_crl;
/**
 * Certificate revocation list structure.
 * Every CRL may have multiple entries.
 */