1.\" $OpenBSD: X509_get_version.3,v 1.8 2020/10/21 17:17:44 tb Exp $ 2.\" OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 3.\" 4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>. 5.\" Copyright (c) 2015, 2016 The OpenSSL Project. All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in 16.\" the documentation and/or other materials provided with the 17.\" distribution. 18.\" 19.\" 3. All advertising materials mentioning features or use of this 20.\" software must display the following acknowledgment: 21.\" "This product includes software developed by the OpenSSL Project 22.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 23.\" 24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 25.\" endorse or promote products derived from this software without 26.\" prior written permission. For written permission, please contact 27.\" openssl-core@openssl.org. 28.\" 29.\" 5. Products derived from this software may not be called "OpenSSL" 30.\" nor may "OpenSSL" appear in their names without prior written 31.\" permission of the OpenSSL Project. 32.\" 33.\" 6. Redistributions of any form whatsoever must retain the following 34.\" acknowledgment: 35.\" "This product includes software developed by the OpenSSL Project 36.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" 37.\" 38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 41.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 49.\" OF THE POSSIBILITY OF SUCH DAMAGE. 50.\" 51.Dd $Mdocdate: October 21 2020 $ 52.Dt X509_GET_VERSION 3 53.Os 54.Sh NAME 55.Nm X509_get_version , 56.Nm X509_set_version , 57.Nm X509_REQ_get_version , 58.Nm X509_REQ_set_version , 59.Nm X509_CRL_get_version , 60.Nm X509_CRL_set_version 61.Nd get or set certificate, certificate request, or CRL version 62.Sh SYNOPSIS 63.In openssl/x509.h 64.Ft long 65.Fo X509_get_version 66.Fa "const X509 *x" 67.Fc 68.Ft int 69.Fo X509_set_version 70.Fa "X509 *x" 71.Fa "long version" 72.Fc 73.Ft long 74.Fo X509_REQ_get_version 75.Fa "const X509_REQ *req" 76.Fc 77.Ft int 78.Fo X509_REQ_set_version 79.Fa "X509_REQ *x" 80.Fa "long version" 81.Fc 82.Ft long 83.Fo X509_CRL_get_version 84.Fa "const X509_CRL *crl" 85.Fc 86.Ft int 87.Fo X509_CRL_set_version 88.Fa "X509_CRL *x" 89.Fa "long version" 90.Fc 91.Sh DESCRIPTION 92.Fn X509_get_version 93returns the numerical value of the version field of certificate 94.Fa x . 95Note: this is defined by standards (X.509 et al.) to be one less 96than the certificate version. 97So a version 3 certificate will return 2 and a version 1 certificate 98will return 0. 99.Pp 100.Fn X509_set_version 101sets the numerical value of the version field of certificate 102.Fa x 103to 104.Fa version . 105.Pp 106Similarly 107.Fn X509_REQ_get_version , 108.Fn X509_REQ_set_version , 109.Fn X509_CRL_get_version , 110and 111.Fn X509_CRL_set_version 112get and set the version number of certificate requests and CRLs. 113.Pp 114The version field of certificates, certificate requests, and CRLs 115has a DEFAULT value of v1(0) meaning the field should be omitted 116for version 1. 117This is handled transparently by these functions. 118.Sh RETURN VALUES 119.Fn X509_get_version , 120.Fn X509_REQ_get_version , 121and 122.Fn X509_CRL_get_version 123return the numerical value of the version field. 124.Pp 125.Fn X509_set_version , 126.Fn X509_REQ_set_version , 127and 128.Fn X509_CRL_set_version 129return 1 for success or 0 for failure. 130In some cases of failure, the reason can be determined with 131.Xr ERR_get_error 3 . 132.Sh SEE ALSO 133.Xr d2i_X509 3 , 134.Xr X509_CRL_get0_by_serial 3 , 135.Xr X509_CRL_new 3 , 136.Xr X509_get_pubkey 3 , 137.Xr X509_get_subject_name 3 , 138.Xr X509_NAME_add_entry_by_txt 3 , 139.Xr X509_NAME_ENTRY_get_object 3 , 140.Xr X509_NAME_get_index_by_NID 3 , 141.Xr X509_NAME_print_ex 3 , 142.Xr X509_new 3 , 143.Xr X509_REQ_new 3 , 144.Xr X509_sign 3 , 145.Xr X509_verify_cert 3 , 146.Xr X509V3_get_d2i 3 147.Sh HISTORY 148.Fn X509_get_version , 149.Fn X509_set_version , 150.Fn X509_REQ_get_version , 151and 152.Fn X509_REQ_set_version 153first appeared in SSLeay 0.6.5 and have been available since 154.Ox 2.4 . 155.Pp 156.Fn X509_CRL_get_version 157first appeared in OpenSSL 0.9.2b and has been available since 158.Ox 2.6 . 159.Pp 160.Fn X509_CRL_set_version 161first appeared in OpenSSL 0.9.7 and has been available since 162.Ox 3.2 . 163