.\"	$OpenBSD: X509_cmp_time.3,v 1.9 2019/06/06 01:06:59 schwarze Exp $
.\"	OpenSSL X509_cmp_time.pod 24053693 Mar 28 14:27:37 2017 +0200
.\"
.\" This file was written by Emilia Kasper <emilia@openssl.org>
.\" Copyright (c) 2017 The OpenSSL Project.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in
.\"    the documentation and/or other materials provided with the
.\"    distribution.
.\"
.\" 3. All advertising materials mentioning features or use of this
.\"    software must display the following acknowledgment:
.\"    "This product includes software developed by the OpenSSL Project
.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
.\"
.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
.\"    endorse or promote products derived from this software without
.\"    prior written permission. For written permission, please contact
.\"    openssl-core@openssl.org.
.\"
.\" 5. Products derived from this software may not be called "OpenSSL"
.\"    nor may "OpenSSL" appear in their names without prior written
.\"    permission of the OpenSSL Project.
.\"
.\" 6. Redistributions of any form whatsoever must retain the following
.\"    acknowledgment:
.\"    "This product includes software developed by the OpenSSL Project
.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd $Mdocdate: June 6 2019 $
.Dt X509_CMP_TIME 3
.Os
.Sh NAME
.Nm X509_cmp_time ,
.Nm X509_cmp_current_time ,
.Nm X509_time_adj_ex ,
.Nm X509_time_adj
.Nd ASN.1 Time utilities
.Sh SYNOPSIS
.In openssl/x509.h
.Ft int
.Fo X509_cmp_time
.Fa "const ASN1_TIME *asn1_time"
.Fa "time_t *cmp_time"
.Fc
.Ft int
.Fo X509_cmp_current_time
.Fa "const ASN1_TIME *asn1_time"
.Fc
.Ft ASN1_TIME *
.Fo X509_time_adj_ex
.Fa "ASN1_TIME *asn1_time"
.Fa "int offset_day"
.Fa "long offset_sec"
.Fa "time_t *in_tm"
.Fc
.Ft ASN1_TIME *
.Fo X509_time_adj
.Fa "ASN1_TIME *asn1_time"
.Fa "long offset_sec"
.Fa "time_t *in_tm"
.Fc
.Sh DESCRIPTION
.Fn X509_cmp_time
parses
.Fa asn1_time
with
.Xr ASN1_time_parse 3
and compares it to
.Fa cmp_time .
.Fn X509_cmp_current_time
compares it to the current time.
.Pp
.Fn X509_time_adj_ex
sets
.Fa asn1_time
to a time
.Fa offset_day
and
.Fa offset_sec
later than
.Fa in_tm .
.Fn X509_time_adj
does the same with a 0 day offset.
If
.Fa asn1_time
is
.Dv NULL ,
a new
.Vt ASN1_TIME
structure is allocated and returned.
.Pp
In all functions, if
.Fa in_tm
is
.Dv NULL ,
the current time is used.
.Sh RETURN VALUES
.Fn X509_cmp_time
and
.Fn X509_cmp_current_time
return -1 if
.Fa asn1_time
is earlier than or equal to
.Fa cmp_time ,
1 if it is later, or 0 on error.
.Pp
.Fn X509_time_adj_ex
and
.Fn X509_time_adj
return a pointer to the updated
.Vt ASN1_TIME
structure or
.Dv NULL
on error.
.Sh SEE ALSO
.Xr ASN1_TIME_new 3 ,
.Xr ASN1_time_parse 3 ,
.Xr ASN1_TIME_set 3 ,
.Xr time 3
.Sh HISTORY
.Fn X509_cmp_current_time
first appeared in SSLeay 0.6.0 and has been available since
.Ox 2.4 .
.Pp
.Fn X509_cmp_time
and
.Fn X509_time_adj
first appeared in OpenSSL 0.9.6 and have been available since
.Ox 2.9 .
.Pp
.Fn X509_time_adj_ex
first appeared in OpenSSL 1.0.0 and has been available since
.Ox 4.9 .