Blame doc/man3/X509_get_version.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
X509_get_version, X509_set_version, X509_REQ_get_version, X509_REQ_set_version,
Packit c4476c
X509_CRL_get_version, X509_CRL_set_version - get or set certificate,
Packit c4476c
certificate request or CRL version
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/x509.h>
Packit c4476c
Packit c4476c
 long X509_get_version(const X509 *x);
Packit c4476c
 int X509_set_version(X509 *x, long version);
Packit c4476c
Packit c4476c
 long X509_REQ_get_version(const X509_REQ *req);
Packit c4476c
 int X509_REQ_set_version(X509_REQ *x, long version);
Packit c4476c
Packit c4476c
 long X509_CRL_get_version(const X509_CRL *crl);
Packit c4476c
 int X509_CRL_set_version(X509_CRL *x, long version);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
X509_get_version() returns the numerical value of the version field of
Packit c4476c
certificate B<x>. Note: this is defined by standards (X.509 et al) to be one
Packit c4476c
less than the certificate version. So a version 3 certificate will return 2 and
Packit c4476c
a version 1 certificate will return 0.
Packit c4476c
Packit c4476c
X509_set_version() sets the numerical value of the version field of certificate
Packit c4476c
B<x> to B<version>.
Packit c4476c
Packit c4476c
Similarly X509_REQ_get_version(), X509_REQ_set_version(),
Packit c4476c
X509_CRL_get_version() and X509_CRL_set_version() get and set the version
Packit c4476c
number of certificate requests and CRLs.
Packit c4476c
Packit c4476c
=head1 NOTES
Packit c4476c
Packit c4476c
The version field of certificates, certificate requests and CRLs has a
Packit c4476c
DEFAULT value of B<v1(0)> meaning the field should be omitted for version
Packit c4476c
1. This is handled transparently by these functions.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
X509_get_version(), X509_REQ_get_version() and X509_CRL_get_version()
Packit c4476c
return the numerical value of the version field.
Packit c4476c
Packit c4476c
X509_set_version(), X509_REQ_set_version() and X509_CRL_set_version()
Packit c4476c
return 1 for success and 0 for failure.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<d2i_X509(3)>,
Packit c4476c
L<ERR_get_error(3)>,
Packit c4476c
L<X509_CRL_get0_by_serial(3)>,
Packit c4476c
L<X509_get0_signature(3)>,
Packit c4476c
L<X509_get_ext_d2i(3)>,
Packit c4476c
L<X509_get_extension_flags(3)>,
Packit c4476c
L<X509_get_pubkey(3)>,
Packit c4476c
L<X509_get_subject_name(3)>,
Packit c4476c
L<X509_NAME_add_entry_by_txt(3)>,
Packit c4476c
L<X509_NAME_ENTRY_get_object(3)>,
Packit c4476c
L<X509_NAME_get_index_by_NID(3)>,
Packit c4476c
L<X509_NAME_print_ex(3)>,
Packit c4476c
L<X509_new(3)>,
Packit c4476c
L<X509_sign(3)>,
Packit c4476c
L<X509V3_get_d2i(3)>,
Packit c4476c
L<X509_verify_cert(3)>
Packit c4476c
Packit c4476c
=head1 HISTORY
Packit c4476c
Packit c4476c
X509_get_version(), X509_REQ_get_version() and X509_CRL_get_version() are
Packit c4476c
functions in OpenSSL 1.1.0, in previous versions they were macros.
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut