1a8e1175bSopenharmony_ci/**
2a8e1175bSopenharmony_ci * \file doc_x509.h
3a8e1175bSopenharmony_ci *
4a8e1175bSopenharmony_ci * \brief X.509 module documentation file.
5a8e1175bSopenharmony_ci */
6a8e1175bSopenharmony_ci/*
7a8e1175bSopenharmony_ci *
8a8e1175bSopenharmony_ci *  Copyright The Mbed TLS Contributors
9a8e1175bSopenharmony_ci *  SPDX-License-Identifier: Apache-2.0
10a8e1175bSopenharmony_ci *
11a8e1175bSopenharmony_ci *  Licensed under the Apache License, Version 2.0 (the "License"); you may
12a8e1175bSopenharmony_ci *  not use this file except in compliance with the License.
13a8e1175bSopenharmony_ci *  You may obtain a copy of the License at
14a8e1175bSopenharmony_ci *
15a8e1175bSopenharmony_ci *  http://www.apache.org/licenses/LICENSE-2.0
16a8e1175bSopenharmony_ci *
17a8e1175bSopenharmony_ci *  Unless required by applicable law or agreed to in writing, software
18a8e1175bSopenharmony_ci *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
19a8e1175bSopenharmony_ci *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20a8e1175bSopenharmony_ci *  See the License for the specific language governing permissions and
21a8e1175bSopenharmony_ci *  limitations under the License.
22a8e1175bSopenharmony_ci */
23a8e1175bSopenharmony_ci
24a8e1175bSopenharmony_ci/**
25a8e1175bSopenharmony_ci * @addtogroup x509_module X.509 module
26a8e1175bSopenharmony_ci *
27a8e1175bSopenharmony_ci * The X.509 module provides X.509 support for reading, writing and verification
28a8e1175bSopenharmony_ci * of certificates.
29a8e1175bSopenharmony_ci * In summary:
30a8e1175bSopenharmony_ci *   - X.509 certificate (CRT) reading (see \c mbedtls_x509_crt_parse(),
31a8e1175bSopenharmony_ci *     \c mbedtls_x509_crt_parse_der(), \c mbedtls_x509_crt_parse_file()).
32a8e1175bSopenharmony_ci *   - X.509 certificate revocation list (CRL) reading (see
33a8e1175bSopenharmony_ci *     \c mbedtls_x509_crl_parse(), \c mbedtls_x509_crl_parse_der(),
34a8e1175bSopenharmony_ci *     and \c mbedtls_x509_crl_parse_file()).
35a8e1175bSopenharmony_ci *   - X.509 certificate signature verification (see \c
36a8e1175bSopenharmony_ci *     mbedtls_x509_crt_verify() and \c mbedtls_x509_crt_verify_with_profile().
37a8e1175bSopenharmony_ci *   - X.509 certificate writing and certificate request writing (see
38a8e1175bSopenharmony_ci *     \c mbedtls_x509write_crt_der() and \c mbedtls_x509write_csr_der()).
39a8e1175bSopenharmony_ci *
40a8e1175bSopenharmony_ci * This module can be used to build a certificate authority (CA) chain and
41a8e1175bSopenharmony_ci * verify its signature. It is also used to generate Certificate Signing
42a8e1175bSopenharmony_ci * Requests and X.509 certificates just as a CA would do.
43a8e1175bSopenharmony_ci */
44