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