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