doc_x509.h 1.7 KB

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