x509.pod 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. =pod
  2. =for comment openssl_manual_section:7
  3. =head1 NAME
  4. x509 - X.509 certificate handling
  5. =head1 SYNOPSIS
  6. #include <openssl/x509.h>
  7. =head1 DESCRIPTION
  8. An X.509 certificate is a structured grouping of information about
  9. an individual, a device, or anything one can imagine. A X.509 CRL
  10. (certificate revocation list) is a tool to help determine if a
  11. certificate is still valid. The exact definition of those can be
  12. found in the X.509 document from ITU-T, or in RFC3280 from PKIX.
  13. In OpenSSL, the type X509 is used to express such a certificate, and
  14. the type X509_CRL is used to express a CRL.
  15. A related structure is a certificate request, defined in PKCS#10 from
  16. RSA Security, Inc, also reflected in RFC2896. In OpenSSL, the type
  17. X509_REQ is used to express such a certificate request.
  18. To handle some complex parts of a certificate, there are the types
  19. X509_NAME (to express a certificate name), X509_ATTRIBUTE (to express
  20. a certificate attributes), X509_EXTENSION (to express a certificate
  21. extension) and a few more.
  22. Finally, there's the supertype X509_INFO, which can contain a CRL, a
  23. certificate and a corresponding private key.
  24. B<X509_>I<...>, B<d2i_X509_>I<...> and B<i2d_X509_>I<...> handle X.509
  25. certificates, with some exceptions, shown below.
  26. B<X509_CRL_>I<...>, B<d2i_X509_CRL_>I<...> and B<i2d_X509_CRL_>I<...>
  27. handle X.509 CRLs.
  28. B<X509_REQ_>I<...>, B<d2i_X509_REQ_>I<...> and B<i2d_X509_REQ_>I<...>
  29. handle PKCS#10 certificate requests.
  30. B<X509_NAME_>I<...> handle certificate names.
  31. B<X509_ATTRIBUTE_>I<...> handle certificate attributes.
  32. B<X509_EXTENSION_>I<...> handle certificate extensions.
  33. =head1 SEE ALSO
  34. L<X509_NAME_ENTRY_get_object(3)>,
  35. L<X509_NAME_add_entry_by_txt(3)>,
  36. L<X509_NAME_add_entry_by_NID(3)>,
  37. L<X509_NAME_print_ex(3)>,
  38. L<X509_NAME_new(3)>,
  39. L<d2i_X509(3)>,
  40. L<d2i_X509_ALGOR(3)>,
  41. L<d2i_X509_CRL(3)>,
  42. L<d2i_X509_NAME(3)>,
  43. L<d2i_X509_REQ(3)>,
  44. L<d2i_X509_SIG(3)>,
  45. L<X509v3(3)>,
  46. L<crypto(7)>
  47. =head1 COPYRIGHT
  48. Copyright 2003-2017 The OpenSSL Project Authors. All Rights Reserved.
  49. Licensed under the OpenSSL license (the "License"). You may not use
  50. this file except in compliance with the License. You can obtain a copy
  51. in the file LICENSE in the source distribution or at
  52. L<https://www.openssl.org/source/license.html>.
  53. =cut