doc/crypto/X509_get_extension_flags.pod

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