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