xref: /freebsd/secure/lib/libcrypto/man/man3/X509_cmp_time.3 (revision f126890ac5386406dadf7c4cfa9566cbb56537c5)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "X509_CMP_TIME 3ossl"
X509_CMP_TIME 3ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
X509_cmp_time, X509_cmp_current_time, X509_cmp_timeframe, X509_time_adj, X509_time_adj_ex, X509_gmtime_adj \- X509 time functions
"SYNOPSIS"
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
"DESCRIPTION"
Header "DESCRIPTION" \fBX509_cmp_time() compares the \s-1ASN1_TIME\s0 in asn1_time with the time in <in_tm>.

\fBX509_cmp_current_time() compares the \s-1ASN1_TIME\s0 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 \s-1NULL\s0 and contain \fBX509_V_FLAG_USE_CHECK_TIME; else the current time is used as reference time.

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

\fBX509_time_adj() sets the \s-1ASN1_TIME\s0 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() \s-1API\s0 should be preferred.

In both methods, if asn1_time is \s-1NULL,\s0 a new \s-1ASN1_TIME\s0 structure is allocated and returned.

In all methods, if in_tm is \s-1NULL,\s0 the current time, expressed as time_t, is used.

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

\fBX509_gmtime_adj() sets the \s-1ASN1_TIME\s0 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 \s-1NULL.\s0

"BUGS"
Header "BUGS" Unlike many standard comparison functions, X509_cmp_time() and \fBX509_cmp_current_time() return 0 on error.
"RETURN VALUES"
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 \s-1NULL\s0 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 \s-1NULL\s0 and the reference time (which has determined as stated above) is past the end time, -1 if the start time is not \s-1NULL\s0 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 \s-1ASN1_TIME\s0 structure, and \s-1NULL\s0 on error.

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

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.