Document extension functions
[openssl.git] / doc / crypto / X509_get_extension_flags.pod
1 =pod
2
3 =head1 NAME
4
5 X509_get_extension_flags, X509_get_key_usage, X509_get_extended_key_usage -
6 retrieve certificate extension flags.
7
8 =head1 SYNOPSIS
9
10    #include <openssl/x509v3.h>
11
12    uint32_t X509_get_extension_flags(X509 *x);
13    uint32_t X509_get_key_usage(X509 *x);
14    uint32_t X509_get_extended_key_usage(X509 *x);
15
16 =head1 DESCRIPTION
17
18 These functions retrieve flags related to commonly used certificate extensions.
19
20 X509_get_extension_flags() retrieves general information about a certificate,
21 it will return one or more of the following flags ored together.
22
23 =over 4
24
25 =item B<EXFLAG_V1>
26
27 The certificate is an obsolete version 1 certificate.
28
29 =item B<EXFLAG_BCONS>
30
31 The certificate contains a basic constraints extension.
32
33 =item B<EXFLAG_CA>
34
35 The certificate contains basic constraints and asserts the CA flag.
36
37 =item B<EXFLAG_PROXY>
38
39 The certificate is a valid proxy certificate.
40
41 =item B<EXFLAG_SI>
42
43 The certificate is self issued (that is subject and issuer names match).
44
45 =item B<EXFLAG_SS>
46
47 The subject and issuer names match and extension values imply it is self
48 signed.
49
50 =item B<EXFLAG_FRESHEST>
51
52 The freshest CRL extension is present in the certificate.
53
54 =item B<EXFLAG_CRITICAL>
55
56 The certificate contains an unhandled critical extension.
57
58 =item B<EXFLAG_INVALID>
59
60 Some certificate extension values are invalid or inconsistent. The
61 certificate should be rejected.
62
63 =item B<EXFLAG_KUSAGE>
64
65 The certificate contains a key usage extension. The value can be retrieved
66 using X509_get_key_usage().
67
68 =item B<EXFLAG_XKUSAGE>
69
70 The certificate contains an extended key usage extension. The value can be
71 retrieved using X509_get_extended_key_usage().
72
73 =back
74
75 X509_get_key_usage() returns the value of the key usage extension.  If key
76 usage is present will return zero or more of the flags:
77 B<KU_DIGITAL_SIGNATURE>, B<KU_NON_REPUDIATION>, B<KU_KEY_ENCIPHERMENT>,
78 B<KU_DATA_ENCIPHERMENT>, B<KU_KEY_AGREEMENT>, B<KU_KEY_CERT_SIGN>,
79 B<KU_CRL_SIGN>, B<KU_ENCIPHER_ONLY> or B<KU_DECIPHER_ONLY> corresponding to
80 individual key usage bits. If key usage is absent then B<UINT32_MAX> is
81 returned.
82
83 X509_get_extended_key_usage() returns the value of the extended key usage
84 extension. If extended key usage is present it will return zero or more of the
85 flags: B<XKU_SSL_SERVER>, B<XKU_SSL_CLIENT>, B<XKU_SMIME>, B<XKU_CODE_SIGN>
86 B<XKU_OCSP_SIGN>, B<XKU_TIMESTAMP>, B<XKU_DVCS> or B<XKU_ANYEKU>. These
87 correspond to the OIDs B<id-kp-serverAuth>, B<id-kp-clientAuth>,
88 B<id-kp-emailProtection>, B<id-kp-codeSigning>, B<id-kp-OCSPSigning>,
89 B<id-kp-timeStamping>, B<id-kp-dvcs> and B<anyExtendedKeyUsage> respectively.
90 Additionally B<XKU_SGC> is set if either Netscape or Microsoft SGC OIDs are
91 present.
92
93 =head1 NOTES
94
95 The value of the flags correspond to extension values which are cached
96 in the B<X509> structure. If the flags returned do not provide sufficient
97 information an application should examine extension values directly.
98
99 If the key usage or extended key usage extension is absent then typically usage
100 is unrestricted. For this reason X509_get_key_usage() and
101 X509_get_extended_key_usage() return B<UINT32_MAX> when the corresponding
102 extension is absent. Applications can additionally check the return value of
103 X509_get_extension_flags() and take appropriate action is an extension is
104 absent.
105
106 =head1 RETURN VALUE
107
108 These functions all return sets of flags corresponding to the certificate
109 extension values.
110
111 =head1 SEE ALSO
112
113 L<X509_check_purpose(3)>
114
115 =cut