1.\" $OpenBSD: X509_get_serialNumber.3,v 1.5 2020/06/19 12:01:20 schwarze Exp $ 2.\" full merge up to: OpenSSL df75c2bf Dec 9 01:02:36 2018 +0100 3.\" 4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>. 5.\" Copyright (c) 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: June 19 2020 $ 52.Dt X509_GET_SERIALNUMBER 3 53.Os 54.Sh NAME 55.Nm X509_get_serialNumber , 56.Nm X509_get0_serialNumber , 57.Nm X509_set_serialNumber 58.Nd get or set certificate serial number 59.Sh SYNOPSIS 60.In openssl/x509.h 61.Ft ASN1_INTEGER * 62.Fo X509_get_serialNumber 63.Fa "X509 *x" 64.Fc 65.Ft const ASN1_INTEGER * 66.Fo X509_get0_serialNumber 67.Fa "const X509 *x" 68.Fc 69.Ft int 70.Fo X509_set_serialNumber 71.Fa "X509 *x" 72.Fa "ASN1_INTEGER *serial" 73.Fc 74.Sh DESCRIPTION 75.Fn X509_get_serialNumber 76returns the serial number of certificate 77.Fa x 78as an 79.Vt ASN1_INTEGER 80structure which can be examined or initialised. 81The value returned is an internal pointer which must not be freed 82up after the call. 83.Pp 84.Fn X509_get0_serialNumber 85does the same except that it accepts a constant argument 86and returns a constant result. 87.Pp 88.Fn X509_set_serialNumber 89sets the serial number of certificate 90.Fa x 91to 92.Fa serial . 93A copy of the serial number is used internally so 94.Fa serial 95should be freed up after use. 96.Sh RETURN VALUES 97.Fn X509_get_serialNumber 98and 99.Fn X509_get0_serialNumber 100return a pointer to an 101.Vt ASN1_INTEGER 102structure. 103.Pp 104.Fn X509_set_serialNumber 105returns 1 for success or 0 for failure. 106In some cases of failure, the reason can be determined with 107.Xr ERR_get_error 3 . 108.Sh SEE ALSO 109.Xr d2i_X509 3 , 110.Xr X509_CRL_get0_by_serial 3 , 111.Xr X509_get_pubkey 3 , 112.Xr X509_NAME_add_entry_by_txt 3 , 113.Xr X509_NAME_ENTRY_get_object 3 , 114.Xr X509_NAME_get_index_by_NID 3 , 115.Xr X509_NAME_print_ex 3 , 116.Xr X509_new 3 , 117.Xr X509_sign 3 , 118.Xr X509_verify_cert 3 , 119.Xr X509V3_get_d2i 3 120.Sh HISTORY 121.Fn X509_get_serialNumber 122and 123.Fn X509_set_serialNumber 124first appeared in SSLeay 0.6.5 and have been available since 125.Ox 2.4 . 126.Pp 127.Fn X509_get0_serialNumber 128first appeared in OpenSSL 1.1.0 and has been available since 129.Ox 6.4 . 130