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