| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 1 | /** |
| Jaeden Amero | 25facdd | 2018-01-23 15:36:58 +0000 | [diff] [blame] | 2 | * \file doc_x509.h |
| 3 | * |
| 4 | * \brief X.509 module documentation file. |
| 5 | */ |
| 6 | /* |
| Manuel Pégourié-Gonnard | 8119dad | 2015-08-06 10:59:26 +0200 | [diff] [blame] | 7 | * |
| Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 8 | * Copyright The Mbed TLS Contributors |
| Dave Rodgman | 16799db | 2023-11-02 19:47:20 +0000 | [diff] [blame] | 9 | * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 10 | */ |
| 11 | |
| 12 | /** |
| 13 | * @addtogroup x509_module X.509 module |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 14 | * |
| Simon Butcher | 5b331b9 | 2016-01-03 16:14:14 +0000 | [diff] [blame] | 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()). |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 27 | * |
| 28 | * This module can be used to build a certificate authority (CA) chain and |
| Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 29 | * verify its signature. It is also used to generate Certificate Signing |
| Simon Butcher | 5b331b9 | 2016-01-03 16:14:14 +0000 | [diff] [blame] | 30 | * Requests and X.509 certificates just as a CA would do. |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 31 | */ |