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