]>
Commit | Line | Data |
---|---|---|
5f74a405 DSH |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
5 | X509_get_version, X509_set_version, X509_REQ_get_version, X509_REQ_set_version, | |
6 | X509_CRL_get_version, X509_CRL_set_version - get or set certificate, | |
bb9ad09e | 7 | certificate request or CRL version |
5f74a405 DSH |
8 | |
9 | =head1 SYNOPSIS | |
10 | ||
11 | #include <openssl/x509.h> | |
12 | ||
e1f02308 | 13 | long X509_get_version(const X509 *x); |
5f74a405 DSH |
14 | int X509_set_version(X509 *x, long version); |
15 | ||
b26ab17f | 16 | long X509_REQ_get_version(const X509_REQ *req); |
5f74a405 DSH |
17 | int X509_REQ_set_version(X509_REQ *x, long version); |
18 | ||
b26ab17f | 19 | long X509_CRL_get_version(const X509_CRL *crl); |
5f74a405 DSH |
20 | int X509_CRL_set_version(X509_CRL *x, long version); |
21 | ||
22 | =head1 DESCRIPTION | |
23 | ||
24 | X509_get_version() returns the numerical value of the version field of | |
25 | certificate B<x>. Note: this is defined by standards (X.509 et al) to be one | |
0ad69cd6 | 26 | less than the certificate version. So a version 3 certificate will return 2 and |
5f74a405 DSH |
27 | a version 1 certificate will return 0. |
28 | ||
29 | X509_set_version() sets the numerical value of the version field of certificate | |
30 | B<x> to B<version>. | |
31 | ||
32 | Similarly X509_REQ_get_version(), X509_REQ_set_version(), | |
33 | X509_CRL_get_version() and X509_CRL_set_version() get and set the version | |
34 | number of certificate requests and CRLs. | |
35 | ||
36 | =head1 NOTES | |
37 | ||
38 | The version field of certificates, certificate requests and CRLs has a | |
39 | DEFAULT value of B<v1(0)> meaning the field should be omitted for version | |
40 | 1. This is handled transparently by these functions. | |
41 | ||
42 | =head1 RETURN VALUES | |
43 | ||
44 | X509_get_version(), X509_REQ_get_version() and X509_CRL_get_version() | |
45 | return the numerical value of the version field. | |
46 | ||
47 | X509_set_version(), X509_REQ_set_version() and X509_CRL_set_version() | |
48 | return 1 for success and 0 for failure. | |
49 | ||
50 | =head1 SEE ALSO | |
51 | ||
52 | L<d2i_X509(3)>, | |
53 | L<ERR_get_error(3)>, | |
54 | L<X509_CRL_get0_by_serial(3)>, | |
55 | L<X509_get0_signature(3)>, | |
56 | L<X509_get_ext_d2i(3)>, | |
57 | L<X509_get_extension_flags(3)>, | |
58 | L<X509_get_pubkey(3)>, | |
59 | L<X509_get_subject_name(3)>, | |
60 | L<X509_NAME_add_entry_by_txt(3)>, | |
61 | L<X509_NAME_ENTRY_get_object(3)>, | |
62 | L<X509_NAME_get_index_by_NID(3)>, | |
63 | L<X509_NAME_print_ex(3)>, | |
64 | L<X509_new(3)>, | |
65 | L<X509_sign(3)>, | |
66 | L<X509V3_get_d2i(3)>, | |
67 | L<X509_verify_cert(3)> | |
68 | ||
69 | =head1 HISTORY | |
70 | ||
5f74a405 DSH |
71 | X509_get_version(), X509_REQ_get_version() and X509_CRL_get_version() are |
72 | functions in OpenSSL 1.1.0, in previous versions they were macros. | |
73 | ||
e2f92610 RS |
74 | =head1 COPYRIGHT |
75 | ||
76 | Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved. | |
77 | ||
4746f25a | 78 | Licensed under the Apache License 2.0 (the "License"). You may not use |
e2f92610 RS |
79 | this file except in compliance with the License. You can obtain a copy |
80 | in the file LICENSE in the source distribution or at | |
81 | L<https://www.openssl.org/source/license.html>. | |
82 | ||
83 | =cut |