X509_CRL_get0_by_serial.pod 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. =pod
  2. =head1 NAME
  3. X509_CRL_get0_by_serial, X509_CRL_get0_by_cert, X509_CRL_get_REVOKED,
  4. X509_REVOKED_get0_serialNumber, X509_REVOKED_get0_revocationDate,
  5. X509_REVOKED_set_serialNumber, X509_REVOKED_set_revocationDate,
  6. X509_CRL_add0_revoked, X509_CRL_sort - CRL revoked entry utility
  7. functions
  8. =head1 SYNOPSIS
  9. #include <openssl/x509.h>
  10. int X509_CRL_get0_by_serial(X509_CRL *crl,
  11. X509_REVOKED **ret, const ASN1_INTEGER *serial);
  12. int X509_CRL_get0_by_cert(X509_CRL *crl, X509_REVOKED **ret, X509 *x);
  13. STACK_OF(X509_REVOKED) *X509_CRL_get_REVOKED(X509_CRL *crl);
  14. const ASN1_INTEGER *X509_REVOKED_get0_serialNumber(const X509_REVOKED *r);
  15. const ASN1_TIME *X509_REVOKED_get0_revocationDate(const X509_REVOKED *r);
  16. int X509_REVOKED_set_serialNumber(X509_REVOKED *r, ASN1_INTEGER *serial);
  17. int X509_REVOKED_set_revocationDate(X509_REVOKED *r, ASN1_TIME *tm);
  18. int X509_CRL_add0_revoked(X509_CRL *crl, X509_REVOKED *rev);
  19. int X509_CRL_sort(X509_CRL *crl);
  20. =head1 DESCRIPTION
  21. X509_CRL_get0_by_serial() attempts to find a revoked entry in I<crl> for
  22. serial number I<serial>. If it is successful, it sets I<*ret> to the internal
  23. pointer of the matching entry. As a result, I<*ret> B<MUST NOT> be freed
  24. after the call.
  25. X509_CRL_get0_by_cert() is similar to X509_get0_by_serial() except it
  26. looks for a revoked entry using the serial number of certificate I<x>.
  27. X509_CRL_get_REVOKED() returns an internal pointer to a STACK of all
  28. revoked entries for I<crl>.
  29. X509_REVOKED_get0_serialNumber() returns an internal pointer to the
  30. serial number of I<r>.
  31. X509_REVOKED_get0_revocationDate() returns an internal pointer to the
  32. revocation date of I<r>.
  33. X509_REVOKED_set_serialNumber() sets the serial number of I<r> to I<serial>.
  34. The supplied I<serial> pointer is not used internally so it should be
  35. freed after use.
  36. X509_REVOKED_set_revocationDate() sets the revocation date of I<r> to
  37. I<tm>. The supplied I<tm> pointer is not used internally so it should be
  38. freed after use.
  39. X509_CRL_add0_revoked() appends revoked entry I<rev> to CRL I<crl>. The
  40. pointer I<rev> is used internally so it B<MUST NOT> be freed after the call:
  41. it is freed when the parent CRL is freed.
  42. X509_CRL_sort() sorts the revoked entries of I<crl> into ascending serial
  43. number order.
  44. =head1 NOTES
  45. Applications can determine the number of revoked entries returned by
  46. X509_CRL_get_REVOKED() using sk_X509_REVOKED_num() and examine each one
  47. in turn using sk_X509_REVOKED_value().
  48. =head1 RETURN VALUES
  49. X509_CRL_get0_by_serial() and X509_CRL_get0_by_cert() return 0 for failure,
  50. 1 on success except if the revoked entry has the reason C<removeFromCRL> (8),
  51. in which case 2 is returned.
  52. X509_CRL_get_REVOKED() returns a STACK of revoked entries.
  53. X509_REVOKED_get0_serialNumber() returns an B<ASN1_INTEGER> structure.
  54. X509_REVOKED_get0_revocationDate() returns an B<ASN1_TIME> structure.
  55. X509_REVOKED_set_serialNumber(), X509_REVOKED_set_revocationDate(),
  56. X509_CRL_add0_revoked() and X509_CRL_sort() return 1 for success and 0 for
  57. failure.
  58. =head1 SEE ALSO
  59. L<d2i_X509(3)>,
  60. L<ERR_get_error(3)>,
  61. L<X509_get0_signature(3)>,
  62. L<X509_get_ext_d2i(3)>,
  63. L<X509_get_extension_flags(3)>,
  64. L<X509_get_pubkey(3)>,
  65. L<X509_get_subject_name(3)>,
  66. L<X509_get_version(3)>,
  67. L<X509_NAME_add_entry_by_txt(3)>,
  68. L<X509_NAME_ENTRY_get_object(3)>,
  69. L<X509_NAME_get_index_by_NID(3)>,
  70. L<X509_NAME_print_ex(3)>,
  71. L<X509_new(3)>,
  72. L<X509_sign(3)>,
  73. L<X509V3_get_d2i(3)>,
  74. L<X509_verify_cert(3)>
  75. =head1 COPYRIGHT
  76. Copyright 2015-2020 The OpenSSL Project Authors. All Rights Reserved.
  77. Licensed under the Apache License 2.0 (the "License"). You may not use
  78. this file except in compliance with the License. You can obtain a copy
  79. in the file LICENSE in the source distribution or at
  80. L<https://www.openssl.org/source/license.html>.
  81. =cut