doc/crypto/X509_get_extension_flags.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 X509_get0_subject_key_id,
   6 X509_get_pathlen,
   7 X509_get_extension_flags, X509_get_key_usage, X509_get_extended_key_usage -
   8 retrieve certificate extension data
   9
  10 =head1 SYNOPSIS
  11
  12    #include <openssl/x509v3.h>
  13
  14    long X509_get_pathlen(X509 *x);
  15    uint32_t X509_get_extension_flags(X509 *x);
  16    uint32_t X509_get_key_usage(X509 *x);
  17    uint32_t X509_get_extended_key_usage(X509 *x);
  18    const ASN1_OCTET_STRING *X509_get0_subject_key_id(X509 *x);
  19
  20 =head1 DESCRIPTION
  21
  22 These functions retrieve information related to commonly used certificate extensions.
  23
  24 X509_get_pathlen() retrieves the path length extension from a certificate.
  25 This extension is used to limit the length of a cert chain that may be
  26 issued from that CA.
  27
  28 X509_get_extension_flags() retrieves general information about a certificate,
  29 it will return one or more of the following flags ored together.
  30
  31 =over 4
  32
  33 =item B<EXFLAG_V1>
  34
  35 The certificate is an obsolete version 1 certificate.
  36
  37 =item B<EXFLAG_BCONS>
  38
  39 The certificate contains a basic constraints extension.
  40
  41 =item B<EXFLAG_CA>
  42
  43 The certificate contains basic constraints and asserts the CA flag.
  44
  45 =item B<EXFLAG_PROXY>
  46
  47 The certificate is a valid proxy certificate.
  48
  49 =item B<EXFLAG_SI>
  50
  51 The certificate is self issued (that is subject and issuer names match).
  52
  53 =item B<EXFLAG_SS>
  54
  55 The subject and issuer names match and extension values imply it is self
  56 signed.
  57
  58 =item B<EXFLAG_FRESHEST>
  59
  60 The freshest CRL extension is present in the certificate.
  61
  62 =item B<EXFLAG_CRITICAL>
  63
  64 The certificate contains an unhandled critical extension.
  65
  66 =item B<EXFLAG_INVALID>
  67
  68 Some certificate extension values are invalid or inconsistent. The
  69 certificate should be rejected.
  70
  71 =item B<EXFLAG_KUSAGE>
  72
  73 The certificate contains a key usage extension. The value can be retrieved
  74 using X509_get_key_usage().
  75
  76 =item B<EXFLAG_XKUSAGE>
  77
  78 The certificate contains an extended key usage extension. The value can be
  79 retrieved using X509_get_extended_key_usage().
  80
  81 =back
  82
  83 X509_get_key_usage() returns the value of the key usage extension.  If key
  84 usage is present will return zero or more of the flags:
  85 B<KU_DIGITAL_SIGNATURE>, B<KU_NON_REPUDIATION>, B<KU_KEY_ENCIPHERMENT>,
  86 B<KU_DATA_ENCIPHERMENT>, B<KU_KEY_AGREEMENT>, B<KU_KEY_CERT_SIGN>,
  87 B<KU_CRL_SIGN>, B<KU_ENCIPHER_ONLY> or B<KU_DECIPHER_ONLY> corresponding to
  88 individual key usage bits. If key usage is absent then B<UINT32_MAX> is
  89 returned.
  90
  91 X509_get_extended_key_usage() returns the value of the extended key usage
  92 extension. If extended key usage is present it will return zero or more of the
  93 flags: B<XKU_SSL_SERVER>, B<XKU_SSL_CLIENT>, B<XKU_SMIME>, B<XKU_CODE_SIGN>
  94 B<XKU_OCSP_SIGN>, B<XKU_TIMESTAMP>, B<XKU_DVCS> or B<XKU_ANYEKU>. These
  95 correspond to the OIDs B<id-kp-serverAuth>, B<id-kp-clientAuth>,
  96 B<id-kp-emailProtection>, B<id-kp-codeSigning>, B<id-kp-OCSPSigning>,
  97 B<id-kp-timeStamping>, B<id-kp-dvcs> and B<anyExtendedKeyUsage> respectively.
  98 Additionally B<XKU_SGC> is set if either Netscape or Microsoft SGC OIDs are
  99 present.
 100
 101 X509_get_extended_key_usage() return an internal pointer to the subject key
 102 identifier of B<x> as an B<ASN1_OCTET_STRING> or B<NULL> if the extension
 103 is not present or cannot be parsed.
 104
 105 =head1 NOTES
 106
 107 The value of the flags correspond to extension values which are cached
 108 in the B<X509> structure. If the flags returned do not provide sufficient
 109 information an application should examine extension values directly
 110 for example using X509_get_ext_d2i().
 111
 112 If the key usage or extended key usage extension is absent then typically usage
 113 is unrestricted. For this reason X509_get_key_usage() and
 114 X509_get_extended_key_usage() return B<UINT32_MAX> when the corresponding
 115 extension is absent. Applications can additionally check the return value of
 116 X509_get_extension_flags() and take appropriate action is an extension is
 117 absent.
 118
 119 If X509_get0_subject_key_id() returns B<NULL> then the extension may be
 120 absent or malformed. Applications can determine the precise reason using
 121 X509_get_ext_d2i().
 122
 123 =head1 RETURN VALUE
 124
 125 X509_get_pathlen() returns the path length value, or -1 if the extension
 126 is not present.
 127
 128 X509_get_extension_flags(), X509_get_key_usage() and
 129 X509_get_extended_key_usage() return sets of flags corresponding to the
 130 certificate extension values.
 131
 132 X509_get0_subject_key_id() returns the subject key identifier as a
 133 pointer to an B<ASN1_OCTET_STRING> structure or B<NULL> if the extension
 134 is absent or an error occurred during parsing.
 135
 136 =head1 SEE ALSO
 137
 138 L<X509_check_purpose(3)>
 139
 140 =head1 HISTORY
 141
 142 X509_get_pathlen() was added in OpenSSL 1.1.0.
 143
 144 =head1 COPYRIGHT
 145
 146 Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
 147
 148 Licensed under the OpenSSL license (the "License").  You may not use
 149 this file except in compliance with the License.  You can obtain a copy
 150 in the file LICENSE in the source distribution or at
 151 L<https://www.openssl.org/source/license.html>.
 152
 153 =cut