xref: /aosp_15_r20/external/mbedtls/doxygen/input/doc_x509.h (revision 62c56f9862f102b96d72393aff6076c951fb8148)
1 /**
2  * \file doc_x509.h
3  *
4  * \brief X.509 module documentation file.
5  */
6 /*
7  *
8  *  Copyright The Mbed TLS Contributors
9  *  SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
10  */
11 
12 /**
13  * @addtogroup x509_module X.509 module
14  *
15  * The X.509 module provides X.509 support for reading, writing and verification
16  * of certificates.
17  * In summary:
18  *   - X.509 certificate (CRT) reading (see \c mbedtls_x509_crt_parse(),
19  *     \c mbedtls_x509_crt_parse_der(), \c mbedtls_x509_crt_parse_file()).
20  *   - X.509 certificate revocation list (CRL) reading (see
21  *     \c mbedtls_x509_crl_parse(), \c mbedtls_x509_crl_parse_der(),
22  *     and \c mbedtls_x509_crl_parse_file()).
23  *   - X.509 certificate signature verification (see \c
24  *     mbedtls_x509_crt_verify() and \c mbedtls_x509_crt_verify_with_profile().
25  *   - X.509 certificate writing and certificate request writing (see
26  *     \c mbedtls_x509write_crt_der() and \c mbedtls_x509write_csr_der()).
27  *
28  * This module can be used to build a certificate authority (CA) chain and
29  * verify its signature. It is also used to generate Certificate Signing
30  * Requests and X.509 certificates just as a CA would do.
31  */
32