doc/crypto/X509_get_serialNumber.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 X509_get_serialNumber, X509_set_serialNumber - get or set certificate serial
   6 number.
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/x509.h>
  11
  12  ASN1_INTEGER *X509_get_serialNumber(X509 *x);
  13  int X509_set_serialNumber(X509 *x, ASN1_INTEGER *serial);
  14
  15 =head1 DESCRIPTION
  16
  17 X509_get_serialNumber() returns the serial number of certificate B<x> as an
  18 B<ASN1_INTEGER> structure which can be examined or initialised. The value
  19 returned is an internal pointer which B<MUST NOT> be freed up after the call.
  20
  21 X509_set_serialNumber() sets the serial number of certificate B<x> to
  22 B<serial>. A copy of the serial number is used internally so B<serial> should
  23 be freed up after use.
  24
  25 =head1 RETURN VALUES
  26
  27 X509_get_serialNumber() returns an B<ASN1_INTEGER> structure.
  28
  29 X509_set_serialNumber() returns 1 for success and 0 for failure.
  30
  31 =head1 SEE ALSO
  32
  33 L<d2i_X509(3)>,
  34 L<ERR_get_error(3)>,
  35 L<X509_CRL_get0_by_serial(3)>,
  36 L<X509_get0_signature(3)>,
  37 L<X509_get_ext_d2i(3)>,
  38 L<X509_get_extension_flags(3)>,
  39 L<X509_get_pubkey(3)>,
  40 L<X509_get_subject_name(3)>,
  41 L<X509_NAME_add_entry_by_txt(3)>,
  42 L<X509_NAME_ENTRY_get_object(3)>,
  43 L<X509_NAME_get_index_by_NID(3)>,
  44 L<X509_NAME_print_ex(3)>,
  45 L<X509_new(3)>,
  46 L<X509_sign(3)>,
  47 L<X509V3_get_d2i(3)>,
  48 L<X509_verify_cert(3)>
  49
  50 =head1 HISTORY
  51
  52 X509_get_serialNumber() and X509_set_serialNumber() are available in
  53 all versions of OpenSSL.
  54
  55 =cut