manpagez: man pages & more
man X509_get0_serialNumber(3)
Home | html | info | man
X509_GET_SERIALNUMBER(3ossl)        OpenSSL       X509_GET_SERIALNUMBER(3ossl)



NAME

       X509_get_serialNumber, X509_get0_serialNumber, X509_set_serialNumber,
       X509_ACERT_get0_serialNumber, X509_ACERT_set1_serialNumber - get or set
       certificate serial number


SYNOPSIS

        #include <openssl/x509.h>

        ASN1_INTEGER *X509_get_serialNumber(X509 *x);
        const ASN1_INTEGER *X509_get0_serialNumber(const X509 *x);
        int X509_set_serialNumber(X509 *x, ASN1_INTEGER *serial);

        #include <openssl/x509_acert.h>

        ASN1_INTEGER *X509_ACERT_get0_serialNumber(X509_ACERT *x);
        int X509_ACERT_set1_serialNumber(X509_ACERT *x, ASN1_INTEGER *serial);


DESCRIPTION

       X509_get_serialNumber(3) returns the serial number of certificate x as
       an ASN1_INTEGER structure which can be examined or initialised. The
       value returned is an internal pointer which MUST NOT be freed up after
       the call.

       X509_get_serialNumber(3) except
       it accepts a const parameter and returns a const result.

       X509_set_serialNumber() sets the serial number of certificate x to
       serial. A copy of the serial number is used internally so serial should
       be freed up after use.

       X509_ACERT_get0_serialNumber() performs the same operation as
       X509_get_serialNumber(3) for attribute certificates.

       X509_ACERT_set1_serialNumber() performs the same operation as
       X509_set_serialNumber() for attribute certificates.


RETURN VALUES

       X509_get_serialNumber(3), X509_get0_serialNumber() and
       X509_ACERT_get0_serialNumber() return a pointer to an ASN1_INTEGER
       structure.

       X509_set_serialNumber() and X509_ACERT_set1_serialNumber() return 1 for
       success and 0 for failure.


SEE ALSO

       d2i_X509(3), ERR_get_error(3), X509_CRL_get0_by_serial(3),
       X509_get0_signature(3), X509_get_ext_d2i(3),
       X509_get_extension_flags(3), X509_get_pubkey(3),
       X509_get_subject_name(3), X509_NAME_add_entry_by_txt(3),
       X509_NAME_ENTRY_get_object(3), X509_NAME_get_index_by_NID(3),
       X509_NAME_print_ex(3), X509_new(3), X509_sign(3), X509V3_get_d2i(3),
       X509_verify_cert(3)


HISTORY

       The X509_get_serialNumber(3) and X509_set_serialNumber() functions are
       available in all versions of OpenSSL.  The X509_get0_serialNumber()
       function was added in OpenSSL 1.1.0.  The
       X509_ACERT_get0_serialNumber() and X509_ACERT_set1_serialNumber()
       functions were added in OpenSSL 3.4.


COPYRIGHT

       Copyright 2016-2024 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>.

3.4.0                             2024-10-29      X509_GET_SERIALNUMBER(3ossl)

openssl 3.4.0 - Generated Tue Nov 19 13:44:10 CST 2024
© manpagez.com 2000-2024
Individual documents may contain additional copyright information.