xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/X509_get_version.3 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: X509_get_version.3,v 1.9 2024/09/08 13:08:37 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "X509_get_version 3"
X509_get_version 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
X509_get_version, X509_set_version, X509_REQ_get_version, X509_REQ_set_version, X509_CRL_get_version, X509_CRL_set_version - get or set certificate, certificate request or CRL version
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #include <openssl/x509.h> \& long X509_get_version(const X509 *x); int X509_set_version(X509 *x, long version); \& long X509_REQ_get_version(const X509_REQ *req); int X509_REQ_set_version(X509_REQ *x, long version); \& long X509_CRL_get_version(const X509_CRL *crl); int X509_CRL_set_version(X509_CRL *x, long version); .Ve
DESCRIPTION
Header "DESCRIPTION" \fBX509_get_version() returns the numerical value of the version field of certificate x. These correspond to the constants X509_VERSION_1, \fBX509_VERSION_2, and X509_VERSION_3. Note: the values of these constants are defined by standards (X.509 et al) to be one less than the certificate version. So X509_VERSION_3 has value 2 and X509_VERSION_1 has value 0.

\fBX509_set_version() sets the numerical value of the version field of certificate \fBx to version.

Similarly X509_REQ_get_version(), X509_REQ_set_version(), \fBX509_CRL_get_version() and X509_CRL_set_version() get and set the version number of certificate requests and CRLs. They use constants \fBX509_REQ_VERSION_1, X509_CRL_VERSION_1, and X509_CRL_VERSION_2.

NOTES
Header "NOTES" The version field of certificates, certificate requests and CRLs has a DEFAULT value of v1\|(0) meaning the field should be omitted for version 1. This is handled transparently by these functions.
"RETURN VALUES"
Header "RETURN VALUES" \fBX509_get_version(), X509_REQ_get_version() and X509_CRL_get_version() return the numerical value of the version field.

\fBX509_set_version(), X509_REQ_set_version() and X509_CRL_set_version() return 1 for success and 0 for failure.

"SEE ALSO"
Header "SEE ALSO" \fBd2i_X509\|(3), \fBERR_get_error\|(3), \fBX509_CRL_get0_by_serial\|(3), \fBX509_get0_signature\|(3), \fBX509_get_ext_d2i\|(3), \fBX509_get_extension_flags\|(3), \fBX509_get_pubkey\|(3), \fBX509_get_subject_name\|(3), \fBX509_NAME_add_entry_by_txt\|(3), \fBX509_NAME_ENTRY_get_object\|(3), \fBX509_NAME_get_index_by_NID\|(3), \fBX509_NAME_print_ex\|(3), \fBX509_new\|(3), \fBX509_sign\|(3), \fBX509V3_get_d2i\|(3), \fBX509_verify_cert\|(3)
HISTORY
Header "HISTORY" \fBX509_get_version(), X509_REQ_get_version() and X509_CRL_get_version() are functions in OpenSSL 1.1.0, in previous versions they were macros.
COPYRIGHT
Header "COPYRIGHT" Copyright 2015-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.