third_party/mbedtls/repo/doxygen/input/doc_x509.h

   1 /**
   2  * \file doc_x509.h
   3  *
   4  * \brief X.509 module documentation file.
   5  */
   6 /*
   7  *
   8  *  Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
   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  *  This file is part of mbed TLS (https://tls.mbed.org)
  24  */
  25
  26 /**
  27  * @addtogroup x509_module X.509 module
  28  *
  29  * The X.509 module provides X.509 support for reading, writing and verification
  30  * of certificates.
  31  * In summary:
  32  *   - X.509 certificate (CRT) reading (see \c mbedtls_x509_crt_parse(),
  33  *     \c mbedtls_x509_crt_parse_der(), \c mbedtls_x509_crt_parse_file()).
  34  *   - X.509 certificate revocation list (CRL) reading (see
  35  *     \c mbedtls_x509_crl_parse(), \c mbedtls_x509_crl_parse_der(),
  36  *     and \c mbedtls_x509_crl_parse_file()).
  37  *   - X.509 certificate signature verification (see \c
  38  *     mbedtls_x509_crt_verify() and \c mbedtls_x509_crt_verify_with_profile().
  39  *   - X.509 certificate writing and certificate request writing (see
  40  *     \c mbedtls_x509write_crt_der() and \c mbedtls_x509write_csr_der()).
  41  *
  42  * This module can be used to build a certificate authority (CA) chain and
  43  * verify its signature. It is also used to generate Certificate Signing
  44  * Requests and X.509 certificates just as a CA would do.
  45  */