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