$NetBSD: X509_cmp_time.3,v 1.8 2024/09/08 13:08:37 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "X509_cmp_time 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
X509_cmp_time, X509_cmp_current_time, X509_cmp_timeframe, X509_time_adj, X509_time_adj_ex, X509_gmtime_adj \- X509 time functions Header "SYNOPSIS" .Vb 8 int X509_cmp_time(const ASN1_TIME *asn1_time, time_t *in_tm); int X509_cmp_current_time(const ASN1_TIME *asn1_time); int X509_cmp_timeframe(const X509_VERIFY_PARAM *vpm, const ASN1_TIME *start, const ASN1_TIME *end); ASN1_TIME *X509_time_adj(ASN1_TIME *asn1_time, long offset_sec, time_t *in_tm); ASN1_TIME *X509_time_adj_ex(ASN1_TIME *asn1_time, int offset_day, long offset_sec, time_t *in_tm); ASN1_TIME *X509_gmtime_adj(ASN1_TIME *asn1_time, long offset_sec); .Ve Header "DESCRIPTION" \fBX509_cmp_time() compares the ASN1_TIME in asn1_time with the time in <in_tm>.

\fBX509_cmp_current_time() compares the ASN1_TIME in \fIasn1_time with the current time, expressed as time_t.

\fBX509_cmp_timeframe() compares the given time period with the reference time included in the verification parameters vpm if they are not NULL and contain \fBX509_V_FLAG_USE_CHECK_TIME; else the current time is used as reference time.

\fBX509_time_adj_ex() sets the ASN1_TIME structure asn1_time to the time \fIoffset_day and offset_sec after in_tm.

\fBX509_time_adj() sets the ASN1_TIME structure asn1_time to the time \fIoffset_sec after in_tm. This method can only handle second offsets up to the capacity of long, so the newer X509_time_adj_ex() API should be preferred.

In both methods, if asn1_time is NULL, a new ASN1_TIME structure is allocated and returned.

In all methods, if in_tm is NULL, the current time, expressed as time_t, is used.

\fIasn1_time must satisfy the ASN1_TIME format mandated by RFC 5280, i.e., its format must be either YYMMDDHHMMSSZ or YYYYMMDDHHMMSSZ.

\fBX509_gmtime_adj() sets the ASN1_TIME structure asn1_time to the time \fIoffset_sec after the current time. It is equivalent to calling \fBX509_time_adj() with the last parameter as NULL.

Header "BUGS" Unlike many standard comparison functions, X509_cmp_time() and \fBX509_cmp_current_time() return 0 on error. Header "RETURN VALUES" \fBX509_cmp_time() and X509_cmp_current_time() return -1 if asn1_time is earlier than, or equal to, in_tm (resp. current time), and 1 otherwise. These methods return 0 on error.

\fBX509_cmp_timeframe() returns 0 if vpm is not NULL and the verification parameters do not contain X509_V_FLAG_USE_CHECK_TIME but do contain X509_V_FLAG_NO_CHECK_TIME. Otherwise it returns 1 if the end time is not NULL and the reference time (which has determined as stated above) is past the end time, -1 if the start time is not NULL and the reference time is before, else 0 to indicate that the reference time is in range (implying that the end time is not before the start time if both are present).

\fBX509_time_adj(), X509_time_adj_ex() and X509_gmtime_adj() return a pointer to the updated ASN1_TIME structure, and NULL on error.

Header "HISTORY" \fBX509_cmp_timeframe() was added in OpenSSL 3.0. Header "COPYRIGHT" Copyright 2017-2022 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (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 <https://www.openssl.org/source/license.html>.