x509.pod 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. =pod
  2. =head1 NAME
  3. x509 - X.509 certificate handling
  4. =head1 SYNOPSIS
  5. #include <openssl/x509.h>
  6. =head1 DESCRIPTION
  7. A X.509 certificate is a structured grouping of information about
  8. an individual, a device, or anything one can imagine. A X.509 CRL
  9. (certificate revocation list) is a tool to help determine if a
  10. certificate is still valid. The exact definition of those can be
  11. found in the X.509 document from ITU-T, or in RFC3280 from PKIX.
  12. In OpenSSL, the type X509 is used to express such a certificate, and
  13. the type X509_CRL is used to express a CRL.
  14. A related structure is a certificate request, defined in PKCS#10 from
  15. RSA Security, Inc, also reflected in RFC2896. In OpenSSL, the type
  16. X509_REQ is used to express such a certificate request.
  17. To handle some complex parts of a certificate, there are the types
  18. X509_NAME (to express a certificate name), X509_ATTRIBUTE (to express
  19. a certificate attributes), X509_EXTENSION (to express a certificate
  20. extension) and a few more.
  21. Finally, there's the supertype X509_INFO, which can contain a CRL, a
  22. certificate and a corresponding private key.
  23. B<X509_>I<...>, B<d2i_X509_>I<...> and B<i2d_X509_>I<...> handle X.509
  24. certificates, with some exceptions, shown below.
  25. B<X509_CRL_>I<...>, B<d2i_X509_CRL_>I<...> and B<i2d_X509_CRL_>I<...>
  26. handle X.509 CRLs.
  27. B<X509_REQ_>I<...>, B<d2i_X509_REQ_>I<...> and B<i2d_X509_REQ_>I<...>
  28. handle PKCS#10 certificate requests.
  29. B<X509_NAME_>I<...> handle certificate names.
  30. B<X509_ATTRIBUTE_>I<...> handle certificate attributes.
  31. B<X509_EXTENSION_>I<...> handle certificate extensions.
  32. =head1 SEE ALSO
  33. L<X509_NAME_ENTRY_get_object(3)|X509_NAME_ENTRY_get_object(3)>,
  34. L<X509_NAME_add_entry_by_txt(3)|X509_NAME_add_entry_by_txt(3)>,
  35. L<X509_NAME_add_entry_by_NID(3)|X509_NAME_add_entry_by_NID(3)>,
  36. L<X509_NAME_print_ex(3)|X509_NAME_print_ex(3)>,
  37. L<X509_NAME_new(3)|X509_NAME_new(3)>,
  38. L<d2i_X509(3)|d2i_X509(3)>,
  39. L<d2i_X509_ALGOR(3)|d2i_X509_ALGOR(3)>,
  40. L<d2i_X509_CRL(3)|d2i_X509_CRL(3)>,
  41. L<d2i_X509_NAME(3)|d2i_X509_NAME(3)>,
  42. L<d2i_X509_REQ(3)|d2i_X509_REQ(3)>,
  43. L<d2i_X509_SIG(3)|d2i_X509_SIG(3)>,
  44. L<crypto(3)|crypto(3)>,
  45. L<x509v3(3)|x509v3(3)>
  46. =cut