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 * This file is provided under the Apache License 2.0, or the 12 * GNU General Public License v2.0 or later. 13 * 14 * ********** 15 * Apache License 2.0: 16 * 17 * Licensed under the Apache License, Version 2.0 (the "License"); you may 18 * not use this file except in compliance with the License. 19 * You may obtain a copy of the License at 20 * 21 * http://www.apache.org/licenses/LICENSE-2.0 22 * 23 * Unless required by applicable law or agreed to in writing, software 24 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 25 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 26 * See the License for the specific language governing permissions and 27 * limitations under the License. 28 * 29 * ********** 30 * 31 * ********** 32 * GNU General Public License v2.0 or later: 33 * 34 * This program is free software; you can redistribute it and/or modify 35 * it under the terms of the GNU General Public License as published by 36 * the Free Software Foundation; either version 2 of the License, or 37 * (at your option) any later version. 38 * 39 * This program is distributed in the hope that it will be useful, 40 * but WITHOUT ANY WARRANTY; without even the implied warranty of 41 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 42 * GNU General Public License for more details. 43 * 44 * You should have received a copy of the GNU General Public License along 45 * with this program; if not, write to the Free Software Foundation, Inc., 46 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 47 * 48 * ********** 49 */ 50 51 /** 52 * @addtogroup x509_module X.509 module 53 * 54 * The X.509 module provides X.509 support for reading, writing and verification 55 * of certificates. 56 * In summary: 57 * - X.509 certificate (CRT) reading (see \c mbedtls_x509_crt_parse(), 58 * \c mbedtls_x509_crt_parse_der(), \c mbedtls_x509_crt_parse_file()). 59 * - X.509 certificate revocation list (CRL) reading (see 60 * \c mbedtls_x509_crl_parse(), \c mbedtls_x509_crl_parse_der(), 61 * and \c mbedtls_x509_crl_parse_file()). 62 * - X.509 certificate signature verification (see \c 63 * mbedtls_x509_crt_verify() and \c mbedtls_x509_crt_verify_with_profile(). 64 * - X.509 certificate writing and certificate request writing (see 65 * \c mbedtls_x509write_crt_der() and \c mbedtls_x509write_csr_der()). 66 * 67 * This module can be used to build a certificate authority (CA) chain and 68 * verify its signature. It is also used to generate Certificate Signing 69 * Requests and X.509 certificates just as a CA would do. 70 */ 71