1.\" $OpenBSD: X509_get_serialNumber.3,v 1.4 2019/06/14 13:59:32 schwarze Exp $ 2.\" OpenSSL bb9ad09e Jun 6 00:43:05 2016 -0400 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 14 2019 $ 52.Dt X509_GET_SERIALNUMBER 3 53.Os 54.Sh NAME 55.Nm X509_get_serialNumber , 56.Nm X509_set_serialNumber 57.Nd get or set certificate serial number 58.Sh SYNOPSIS 59.In openssl/x509.h 60.Ft ASN1_INTEGER * 61.Fo X509_get_serialNumber 62.Fa "X509 *x" 63.Fc 64.Ft int 65.Fo X509_set_serialNumber 66.Fa "X509 *x" 67.Fa "ASN1_INTEGER *serial" 68.Fc 69.Sh DESCRIPTION 70.Fn X509_get_serialNumber 71returns the serial number of certificate 72.Fa x 73as an 74.Vt ASN1_INTEGER 75structure which can be examined or initialised. 76The value returned is an internal pointer which must not be freed 77up after the call. 78.Pp 79.Fn X509_set_serialNumber 80sets the serial number of certificate 81.Fa x 82to 83.Fa serial . 84A copy of the serial number is used internally so 85.Fa serial 86should be freed up after use. 87.Sh RETURN VALUES 88.Fn X509_get_serialNumber 89returns an 90.Vt ASN1_INTEGER 91structure. 92.Pp 93.Fn X509_set_serialNumber 94returns 1 for success or 0 for failure. 95In some cases of failure, the reason can be determined with 96.Xr ERR_get_error 3 . 97.Sh SEE ALSO 98.Xr d2i_X509 3 , 99.Xr X509_CRL_get0_by_serial 3 , 100.Xr X509_get_pubkey 3 , 101.Xr X509_NAME_add_entry_by_txt 3 , 102.Xr X509_NAME_ENTRY_get_object 3 , 103.Xr X509_NAME_get_index_by_NID 3 , 104.Xr X509_NAME_print_ex 3 , 105.Xr X509_new 3 , 106.Xr X509_sign 3 , 107.Xr X509_verify_cert 3 , 108.Xr X509V3_get_d2i 3 109.Sh HISTORY 110.Fn X509_get_serialNumber 111and 112.Fn X509_set_serialNumber 113first appeared in SSLeay 0.6.5 and have been available since 114.Ox 2.4 . 115