doc/crypto/x509.pod

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