X509_get_serialNumber.pod 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. =pod
  2. =head1 NAME
  3. X509_get_serialNumber,
  4. X509_get0_serialNumber,
  5. X509_set_serialNumber
  6. - get or set certificate serial number
  7. =head1 SYNOPSIS
  8. #include <openssl/x509.h>
  9. ASN1_INTEGER *X509_get_serialNumber(X509 *x);
  10. const ASN1_INTEGER *X509_get0_serialNumber(const X509 *x);
  11. int X509_set_serialNumber(X509 *x, ASN1_INTEGER *serial);
  12. =head1 DESCRIPTION
  13. X509_get_serialNumber() returns the serial number of certificate B<x> as an
  14. B<ASN1_INTEGER> structure which can be examined or initialised. The value
  15. returned is an internal pointer which B<MUST NOT> be freed up after the call.
  16. X509_get0_serialNumber() is the same as X509_get_serialNumber() except it
  17. accepts a const parameter and returns a const result.
  18. X509_set_serialNumber() sets the serial number of certificate B<x> to
  19. B<serial>. A copy of the serial number is used internally so B<serial> should
  20. be freed up after use.
  21. =head1 RETURN VALUES
  22. X509_get_serialNumber() and X509_get0_serialNumber() return an B<ASN1_INTEGER>
  23. structure.
  24. X509_set_serialNumber() returns 1 for success and 0 for failure.
  25. =head1 SEE ALSO
  26. L<d2i_X509(3)>,
  27. L<ERR_get_error(3)>,
  28. L<X509_CRL_get0_by_serial(3)>,
  29. L<X509_get0_signature(3)>,
  30. L<X509_get_ext_d2i(3)>,
  31. L<X509_get_extension_flags(3)>,
  32. L<X509_get_pubkey(3)>,
  33. L<X509_get_subject_name(3)>,
  34. L<X509_NAME_add_entry_by_txt(3)>,
  35. L<X509_NAME_ENTRY_get_object(3)>,
  36. L<X509_NAME_get_index_by_NID(3)>,
  37. L<X509_NAME_print_ex(3)>,
  38. L<X509_new(3)>,
  39. L<X509_sign(3)>,
  40. L<X509V3_get_d2i(3)>,
  41. L<X509_verify_cert(3)>
  42. =head1 HISTORY
  43. The X509_get_serialNumber() and X509_set_serialNumber() functions are
  44. available in all versions of OpenSSL.
  45. The X509_get0_serialNumber() function was added in OpenSSL 1.1.0.
  46. =head1 COPYRIGHT
  47. Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
  48. Licensed under the Apache License 2.0 (the "License"). You may not use
  49. this file except in compliance with the License. You can obtain a copy
  50. in the file LICENSE in the source distribution or at
  51. L<https://www.openssl.org/source/license.html>.
  52. =cut