1=pod 2 3=head1 NAME 4 5X509_cmp_time, X509_cmp_current_time, X509_cmp_timeframe, 6X509_time_adj, X509_time_adj_ex 7- X509 time functions 8 9=head1 SYNOPSIS 10 11 int X509_cmp_time(const ASN1_TIME *asn1_time, time_t *in_tm); 12 int X509_cmp_current_time(const ASN1_TIME *asn1_time); 13 int X509_cmp_timeframe(const X509_VERIFY_PARAM *vpm, 14 const ASN1_TIME *start, const ASN1_TIME *end); 15 ASN1_TIME *X509_time_adj(ASN1_TIME *asn1_time, long offset_sec, time_t *in_tm); 16 ASN1_TIME *X509_time_adj_ex(ASN1_TIME *asn1_time, int offset_day, long 17 offset_sec, time_t *in_tm); 18 19=head1 DESCRIPTION 20 21X509_cmp_time() compares the ASN1_TIME in B<asn1_time> with the time 22in <in_tm>. 23 24X509_cmp_current_time() compares the ASN1_TIME in 25B<asn1_time> with the current time, expressed as time_t. 26 27X509_cmp_timeframe() compares the given time period with the reference time 28included in the verification parameters B<vpm> if they are not NULL and contain 29B<X509_V_FLAG_USE_CHECK_TIME>; else the current time is used as reference time. 30 31X509_time_adj_ex() sets the ASN1_TIME structure B<asn1_time> to the time 32B<offset_day> and B<offset_sec> after B<in_tm>. 33 34X509_time_adj() sets the ASN1_TIME structure B<asn1_time> to the time 35B<offset_sec> after B<in_tm>. This method can only handle second 36offsets up to the capacity of long, so the newer X509_time_adj_ex() 37API should be preferred. 38 39In both methods, if B<asn1_time> is NULL, a new ASN1_TIME structure 40is allocated and returned. 41 42In all methods, if B<in_tm> is NULL, the current time, expressed as 43time_t, is used. 44 45B<asn1_time> must satisfy the ASN1_TIME format mandated by RFC 5280, 46i.e., its format must be either YYMMDDHHMMSSZ or YYYYMMDDHHMMSSZ. 47 48=head1 BUGS 49 50Unlike many standard comparison functions, X509_cmp_time() and 51X509_cmp_current_time() return 0 on error. 52 53=head1 RETURN VALUES 54 55X509_cmp_time() and X509_cmp_current_time() return -1 if B<asn1_time> 56is earlier than, or equal to, B<in_tm> (resp. current time), and 1 57otherwise. These methods return 0 on error. 58 59X509_cmp_timeframe() returns 0 if B<vpm> is not NULL and the verification 60parameters do not contain B<X509_V_FLAG_USE_CHECK_TIME> 61but do contain B<X509_V_FLAG_NO_CHECK_TIME>. Otherwise it returns 621 if the end time is not NULL and the reference time (which has determined as 63stated above) is past the end time, -1 if the start time is not NULL and the 64reference time is before, else 0 to indicate that the reference time is in range 65(implying that the end time is not before the start time if both are present). 66 67X509_time_adj() and X509_time_adj_ex() return a pointer to the updated 68ASN1_TIME structure, and NULL on error. 69 70=head1 HISTORY 71 72X509_cmp_timeframe() was added in OpenSSL 3.0. 73 74=head1 COPYRIGHT 75 76Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved. 77 78Licensed under the Apache License 2.0 (the "License"). You may not use 79this file except in compliance with the License. You can obtain a copy 80in the file LICENSE in the source distribution or at 81L<https://www.openssl.org/source/license.html>. 82 83=cut 84