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