doc_x509.h

00001 /**
00002  * @file
00003  * X.509 module documentation file.
00004  *
00005  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
00006  *  SPDX-License-Identifier: Apache-2.0
00007  *
00008  *  Licensed under the Apache License, Version 2.0 (the "License"); you may
00009  *  not use this file except in compliance with the License.
00010  *  You may obtain a copy of the License at
00011  *
00012  *  http://www.apache.org/licenses/LICENSE-2.0
00013  *
00014  *  Unless required by applicable law or agreed to in writing, software
00015  *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
00016  *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00017  *  See the License for the specific language governing permissions and
00018  *  limitations under the License.
00019  *
00020  *  This file is part of mbed TLS (https://tls.mbed.org)
00021  */
00022 
00023 /**
00024  * @addtogroup x509_module X.509 module
00025  *
00026  * The X.509 module provides X.509 support for reading, writing and verification
00027  * of certificates.
00028  * In summary:
00029  *   - X.509 certificate (CRT) reading (see \c mbedtls_x509_crt_parse(),
00030  *     \c mbedtls_x509_crt_parse_der(), \c mbedtls_x509_crt_parse_file()).
00031  *   - X.509 certificate revocation list (CRL) reading (see
00032  *     \c mbedtls_x509_crl_parse(), \c mbedtls_x509_crl_parse_der(),
00033  *     and \c mbedtls_x509_crl_parse_file()).
00034  *   - X.509 certificate signature verification (see \c
00035  *     mbedtls_x509_crt_verify() and \c mbedtls_x509_crt_verify_with_profile().
00036  *   - X.509 certificate writing and certificate request writing (see
00037  *     \c mbedtls_x509write_crt_der() and \c mbedtls_x509write_csr_der()).
00038  *
00039  * This module can be used to build a certificate authority (CA) chain and
00040  * verify its signature. It is also used to generate Certificate Signing
00041  * Requests and X.509 certificates just as a CA would do.
00042  */