X509_get0_notBefore.pod 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. =pod
  2. =head1 NAME
  3. X509_get0_notBefore, X509_getm_notBefore, X509_get0_notAfter,
  4. X509_getm_notAfter, X509_set1_notBefore, X509_set1_notAfter,
  5. X509_CRL_get0_lastUpdate, X509_CRL_get0_nextUpdate, X509_CRL_set1_lastUpdate,
  6. X509_CRL_set1_nextUpdate - get or set certificate or CRL dates
  7. =head1 SYNOPSIS
  8. #include <openssl/x509.h>
  9. const ASN1_TIME *X509_get0_notBefore(const X509 *x);
  10. const ASN1_TIME *X509_get0_notAfter(const X509 *x);
  11. ASN1_TIME *X509_getm_notBefore(const X509 *x);
  12. ASN1_TIME *X509_getm_notAfter(const X509 *x);
  13. int X509_set1_notBefore(X509 *x, const ASN1_TIME *tm);
  14. int X509_set1_notAfter(X509 *x, const ASN1_TIME *tm);
  15. const ASN1_TIME *X509_CRL_get0_lastUpdate(const X509_CRL *crl);
  16. const ASN1_TIME *X509_CRL_get0_nextUpdate(const X509_CRL *crl);
  17. int X509_CRL_set1_lastUpdate(X509_CRL *x, const ASN1_TIME *tm);
  18. int X509_CRL_set1_nextUpdate(X509_CRL *x, const ASN1_TIME *tm);
  19. =head1 DESCRIPTION
  20. X509_get0_notBefore() and X509_get0_notAfter() return the B<notBefore>
  21. and B<notAfter> fields of certificate I<x> respectively. The value
  22. returned is an internal pointer which must not be freed up after
  23. the call.
  24. X509_getm_notBefore() and X509_getm_notAfter() are similar to
  25. X509_get0_notBefore() and X509_get0_notAfter() except they return
  26. non-constant mutable references to the associated date field of
  27. the certificate.
  28. X509_set1_notBefore() and X509_set1_notAfter() set the B<notBefore>
  29. and B<notAfter> fields of I<x> to I<tm>. Ownership of the passed
  30. parameter I<tm> is not transferred by these functions so it must
  31. be freed up after the call.
  32. X509_CRL_get0_lastUpdate() and X509_CRL_get0_nextUpdate() return the
  33. B<lastUpdate> and B<nextUpdate> fields of I<crl>. The value
  34. returned is an internal pointer which must not be freed up after
  35. the call. If the B<nextUpdate> field is absent from I<crl> then
  36. NULL is returned.
  37. X509_CRL_set1_lastUpdate() and X509_CRL_set1_nextUpdate() set the B<lastUpdate>
  38. and B<nextUpdate> fields of I<crl> to I<tm>. Ownership of the passed parameter
  39. I<tm> is not transferred by these functions so it must be freed up after the
  40. call.
  41. For X509_CRL_set1_nextUpdate() the I<tm> argument may be NULL,
  42. which implies removal of the optional B<nextUpdate> field.
  43. =head1 RETURN VALUES
  44. X509_get0_notBefore(), X509_get0_notAfter() and X509_CRL_get0_lastUpdate()
  45. return a pointer to an B<ASN1_TIME> structure.
  46. X509_CRL_get0_lastUpdate() return a pointer to an B<ASN1_TIME> structure
  47. or NULL if the B<lastUpdate> field is absent.
  48. X509_set1_notBefore(), X509_set1_notAfter(), X509_CRL_set1_lastUpdate() and
  49. X509_CRL_set1_nextUpdate() return 1 for success or 0 for failure.
  50. =head1 SEE ALSO
  51. L<d2i_X509(3)>,
  52. L<ERR_get_error(3)>,
  53. L<X509_CRL_get0_by_serial(3)>,
  54. L<X509_get0_signature(3)>,
  55. L<X509_get_ext_d2i(3)>,
  56. L<X509_get_extension_flags(3)>,
  57. L<X509_get_pubkey(3)>,
  58. L<X509_get_subject_name(3)>,
  59. L<X509_NAME_add_entry_by_txt(3)>,
  60. L<X509_NAME_ENTRY_get_object(3)>,
  61. L<X509_NAME_get_index_by_NID(3)>,
  62. L<X509_NAME_print_ex(3)>,
  63. L<X509_new(3)>,
  64. L<X509_sign(3)>,
  65. L<X509V3_get_d2i(3)>,
  66. L<X509_verify_cert(3)>
  67. =head1 HISTORY
  68. These functions are available in all versions of OpenSSL.
  69. X509_get_notBefore() and X509_get_notAfter() were deprecated in OpenSSL
  70. 1.1.0
  71. =head1 COPYRIGHT
  72. Copyright 2016-2023 The OpenSSL Project Authors. All Rights Reserved.
  73. Licensed under the Apache License 2.0 (the "License"). You may not use
  74. this file except in compliance with the License. You can obtain a copy
  75. in the file LICENSE in the source distribution or at
  76. L<https://www.openssl.org/source/license.html>.
  77. =cut