doc/man3/X509_get0_notBefore.pod

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