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