blob: e242dc387505fe99531a29bb179f3ec515001bb1 [file] [log] [blame]
Paul Bakker37ca75d2011-01-06 12:28:03 +00001/**
2 * @file
3 * X.509 module documentation file.
4 */
5
6/**
7 * @addtogroup x509_module X.509 module
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02008 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00009 * The X.509 module provides X.509 support which includes:
10 * - X.509 certificate (CRT) reading (see \c x509parse_crt() and
11 * \c x509parse_crtfile()).
12 * - X.509 certificate revocation list (CRL) reading (see \c x509parse_crl()
13 * and\c x509parse_crlfile()).
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020014 * - X.509 (RSA and ECC) private key reading (see \c x509parse_key() and
15 * \c x509parse_keyfile()).
Paul Bakker37ca75d2011-01-06 12:28:03 +000016 * - X.509 certificate signature verification (see \c x509parse_verify())
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020017 * - X.509 certificate writing and certificate request writing (see
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +020018 * \c mbedtls_x509write_crt_der() and \c mbedtls_x509write_csr_der()).
Paul Bakker37ca75d2011-01-06 12:28:03 +000019 *
20 * This module can be used to build a certificate authority (CA) chain and
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +020021 * verify its signature. It is also used to generate Certificate Signing
22 * Requests and X509 certificates just as a CA would do.
Paul Bakker37ca75d2011-01-06 12:28:03 +000023 */