mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2025-03-31 20:10:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

Document certificate and CRL time functions.

Browse Source 
RT#4639

Reviewed-by: Rich Salz <rsalz@openssl.org>
This commit is contained in:
Dr. Stephen Henson 2016-08-01 19:16:52 +01:00
parent b26ab17f3d
commit c2e888b54c
1 changed files with 92 additions and 0 deletions

92
doc/crypto/X509_get_notBefore.pod Normal file

@ -0,0 +1,92 @@
=pod
=head1 NAME
X509_get_notBefore, X509_get_notAfter, X509_set_notBefore,
X509_set_notAfter, X509_CRL_get_lastUpdate, X509_CRL_get_nextUpdate,
X509_CRL_set_lastUpdate, X509_CRL_set_nextUpdate - get or set certificate
or CRL dates
=head1 SYNOPSIS
#include <openssl/x509.h>
ASN1_TIME *X509_get_notBefore(const X509 *x);
ASN1_TIME *X509_get_notAfter(const X509 *x);
int X509_set_notBefore(X509 *x, const ASN1_TIME *tm);
int X509_set_notAfter(X509 *x, const ASN1_TIME *tm);
ASN1_TIME *X509_CRL_get_lastUpdate(const X509_CRL *crl);
ASN1_TIME *X509_CRL_get_nextUpdate(const X509_CRL *crl);
int X509_CRL_set_lastUpdate(X509_CRL *x, const ASN1_TIME *tm);
int X509_CRL_set_nextUpdate(X509_CRL *x, const ASN1_TIME *tm);
=head1 DESCRIPTION
X509_get_notBefore() and X509_get_notAfter() return the B<notBefore>
and B<notAfter> fields of certificate B<x> respectively. The value
returned is an internal pointer which must not be freed up after
the call.
X509_set_notBefore() and X509_set_notAfter() set the B<notBefore>
and B<notAfter> fields of B<x> to B<tm>. Ownership of the passed
parameter B<tm> is not transferred by these functions so it must
be freed up after the call.
X509_CRL_get_lastUpdate() and X509_CRL_get_nextUpdate() return the
B<lastUpdate> and B<nextUpdate> fields of B<crl>. The value
returned is an internal pointer which must not be freed up after
the call. If the B<nextUpdate> field is absent from B<crl> then
B<NULL> is returned.
X509_CRL_set_lastUpdate() and X509_CRL_set_nextUpdate() set the B<lastUpdate>
and B<nextUpdate> fields of B<crl> to B<tm>. Ownership of the passed parameter
B<tm> is not transferred by these functions so it must be freed up after the
call.
=head1 RETURN VALUES
X509_get_notBefore(), X509_get_notAfter() and X509_CRL_get_lastUpdate()
return a pointer to an B<ASN1_TIME> structure.
X509_CRL_get_lastUpdate() return a pointer to an B<ASN1_TIME> structure
or NULL if the B<lastUpdate> field is absent.
X509_set_notBefore(), X509_set_notAfter(), X509_CRL_set_lastUpdate() and
X509_CRL_set_nextUpdate() return 1 for success or 0 for failure.
=head1 SEE ALSO
L<d2i_X509(3)>,
L<ERR_get_error(3)>,
L<X509_CRL_get0_by_serial(3)>,
L<X509_get0_signature(3)>,
L<X509_get_ext_d2i(3)>,
L<X509_get_extension_flags(3)>,
L<X509_get_pubkey(3)>,
L<X509_get_subject_name(3)>,
L<X509_NAME_add_entry_by_txt(3)>,
L<X509_NAME_ENTRY_get_object(3)>,
L<X509_NAME_get_index_by_NID(3)>,
L<X509_NAME_print_ex(3)>,
L<X509_new(3)>,
L<X509_sign(3)>,
L<X509V3_get_d2i(3)>,
L<X509_verify_cert(3)>
=head1 HISTORY
These functions are available in all versions of OpenSSL.
=head1 COPYRIGHT
Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the OpenSSL license (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut