xref: /freebsd/crypto/openssl/doc/man3/X509_get_version.pod (revision cab6a39d7b343596a5823e65c0f7b426551ec22d)
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>. Note: this is defined by standards (X.509 et al) to be one
26less than the certificate version. So a version 3 certificate will return 2 and
27a version 1 certificate will return 0.
28
29X509_set_version() sets the numerical value of the version field of certificate
30B<x> to B<version>.
31
32Similarly X509_REQ_get_version(), X509_REQ_set_version(),
33X509_CRL_get_version() and X509_CRL_set_version() get and set the version
34number of certificate requests and CRLs.
35
36=head1 NOTES
37
38The version field of certificates, certificate requests and CRLs has a
39DEFAULT value of B<v1(0)> meaning the field should be omitted for version
401. This is handled transparently by these functions.
41
42=head1 RETURN VALUES
43
44X509_get_version(), X509_REQ_get_version() and X509_CRL_get_version()
45return the numerical value of the version field.
46
47X509_set_version(), X509_REQ_set_version() and X509_CRL_set_version()
48return 1 for success and 0 for failure.
49
50=head1 SEE ALSO
51
52L<d2i_X509(3)>,
53L<ERR_get_error(3)>,
54L<X509_CRL_get0_by_serial(3)>,
55L<X509_get0_signature(3)>,
56L<X509_get_ext_d2i(3)>,
57L<X509_get_extension_flags(3)>,
58L<X509_get_pubkey(3)>,
59L<X509_get_subject_name(3)>,
60L<X509_NAME_add_entry_by_txt(3)>,
61L<X509_NAME_ENTRY_get_object(3)>,
62L<X509_NAME_get_index_by_NID(3)>,
63L<X509_NAME_print_ex(3)>,
64L<X509_new(3)>,
65L<X509_sign(3)>,
66L<X509V3_get_d2i(3)>,
67L<X509_verify_cert(3)>
68
69=head1 HISTORY
70
71X509_get_version(), X509_REQ_get_version() and X509_CRL_get_version() are
72functions in OpenSSL 1.1.0, in previous versions they were macros.
73
74=head1 COPYRIGHT
75
76Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
77
78Licensed under the OpenSSL license (the "License").  You may not use
79this file except in compliance with the License.  You can obtain a copy
80in the file LICENSE in the source distribution or at
81L<https://www.openssl.org/source/license.html>.
82
83=cut
84