From 425e972dfaf867affb5b3d438d9ca67bb6aeed65 Mon Sep 17 00:00:00 2001 From: Matt Caswell Date: Wed, 10 Aug 2022 09:53:12 +0100 Subject: Add some documentation for X509_gmtime_adj() Other very similar functions were documented, but this one was missing. Reviewed-by: Hugo Landau Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/18974) --- doc/man3/X509_cmp_time.pod | 37 +++++++++++++++++++++---------------- util/missingcrypto.txt | 1 - 2 files changed, 21 insertions(+), 17 deletions(-) diff --git a/doc/man3/X509_cmp_time.pod b/doc/man3/X509_cmp_time.pod index 73ef9e3fbc..30a09f25f9 100644 --- a/doc/man3/X509_cmp_time.pod +++ b/doc/man3/X509_cmp_time.pod @@ -3,7 +3,7 @@ =head1 NAME X509_cmp_time, X509_cmp_current_time, X509_cmp_timeframe, -X509_time_adj, X509_time_adj_ex +X509_time_adj, X509_time_adj_ex, X509_gmtime_adj - X509 time functions =head1 SYNOPSIS @@ -15,36 +15,41 @@ X509_time_adj, X509_time_adj_ex 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); =head1 DESCRIPTION -X509_cmp_time() compares the ASN1_TIME in B with the time +X509_cmp_time() compares the ASN1_TIME in I with the time in . X509_cmp_current_time() compares the ASN1_TIME in -B with the current time, expressed as time_t. +I with the current time, expressed as time_t. X509_cmp_timeframe() compares the given time period with the reference time -included in the verification parameters B if they are not NULL and contain +included in the verification parameters I if they are not NULL and contain B; else the current time is used as reference time. -X509_time_adj_ex() sets the ASN1_TIME structure B to the time -B and B after B. +X509_time_adj_ex() sets the ASN1_TIME structure I to the time +I and I after I. -X509_time_adj() sets the ASN1_TIME structure B to the time -B after B. This method can only handle second +X509_time_adj() sets the ASN1_TIME structure I to the time +I after I. 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 B is NULL, a new ASN1_TIME structure +In both methods, if I is NULL, a new ASN1_TIME structure is allocated and returned. -In all methods, if B is NULL, the current time, expressed as +In all methods, if I is NULL, the current time, expressed as time_t, is used. -B must satisfy the ASN1_TIME format mandated by RFC 5280, +I must satisfy the ASN1_TIME format mandated by RFC 5280, i.e., its format must be either YYMMDDHHMMSSZ or YYYYMMDDHHMMSSZ. +X509_gmtime_adj() sets the ASN1_TIME structure I to the time +I after the current time. It is equivalent to calling +X509_time_adj() with the last parameter as NULL. + =head1 BUGS Unlike many standard comparison functions, X509_cmp_time() and @@ -52,11 +57,11 @@ X509_cmp_current_time() return 0 on error. =head1 RETURN VALUES -X509_cmp_time() and X509_cmp_current_time() return -1 if B -is earlier than, or equal to, B (resp. current time), and 1 +X509_cmp_time() and X509_cmp_current_time() return -1 if I +is earlier than, or equal to, I (resp. current time), and 1 otherwise. These methods return 0 on error. -X509_cmp_timeframe() returns 0 if B is not NULL and the verification +X509_cmp_timeframe() returns 0 if I is not NULL and the verification parameters do not contain B but do contain B. Otherwise it returns 1 if the end time is not NULL and the reference time (which has determined as @@ -64,8 +69,8 @@ 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). -X509_time_adj() and X509_time_adj_ex() return a pointer to the updated -ASN1_TIME structure, and NULL on error. +X509_time_adj(), X509_time_adj_ex() and X509_gmtime_adj() return a pointer to +the updated ASN1_TIME structure, and NULL on error. =head1 HISTORY diff --git a/util/missingcrypto.txt b/util/missingcrypto.txt index a0937d4d98..af8a57fa2c 100644 --- a/util/missingcrypto.txt +++ b/util/missingcrypto.txt @@ -1324,7 +1324,6 @@ X509_get_default_cert_file_env(3) X509_get_default_private_dir(3) X509_get_pubkey_parameters(3) X509_get_signature_type(3) -X509_gmtime_adj(3) X509_issuer_and_serial_hash(3) X509_issuer_name_hash(3) X509_issuer_name_hash_old(3) -- cgit v1.2.3