xref: /openbsd-src/lib/libcrypto/man/X509_cmp_time.3 (revision 46035553bfdd96e63c94e32da0210227ec2e3cf1)
1.\"	$OpenBSD: X509_cmp_time.3,v 1.9 2019/06/06 01:06:59 schwarze Exp $
2.\"	OpenSSL X509_cmp_time.pod 24053693 Mar 28 14:27:37 2017 +0200
3.\"
4.\" This file was written by Emilia Kasper <emilia@openssl.org>
5.\" Copyright (c) 2017 The OpenSSL Project.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\"
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in
16.\"    the documentation and/or other materials provided with the
17.\"    distribution.
18.\"
19.\" 3. All advertising materials mentioning features or use of this
20.\"    software must display the following acknowledgment:
21.\"    "This product includes software developed by the OpenSSL Project
22.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23.\"
24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25.\"    endorse or promote products derived from this software without
26.\"    prior written permission. For written permission, please contact
27.\"    openssl-core@openssl.org.
28.\"
29.\" 5. Products derived from this software may not be called "OpenSSL"
30.\"    nor may "OpenSSL" appear in their names without prior written
31.\"    permission of the OpenSSL Project.
32.\"
33.\" 6. Redistributions of any form whatsoever must retain the following
34.\"    acknowledgment:
35.\"    "This product includes software developed by the OpenSSL Project
36.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37.\"
38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\"
51.Dd $Mdocdate: June 6 2019 $
52.Dt X509_CMP_TIME 3
53.Os
54.Sh NAME
55.Nm X509_cmp_time ,
56.Nm X509_cmp_current_time ,
57.Nm X509_time_adj_ex ,
58.Nm X509_time_adj
59.Nd ASN.1 Time utilities
60.Sh SYNOPSIS
61.In openssl/x509.h
62.Ft int
63.Fo X509_cmp_time
64.Fa "const ASN1_TIME *asn1_time"
65.Fa "time_t *cmp_time"
66.Fc
67.Ft int
68.Fo X509_cmp_current_time
69.Fa "const ASN1_TIME *asn1_time"
70.Fc
71.Ft ASN1_TIME *
72.Fo X509_time_adj_ex
73.Fa "ASN1_TIME *asn1_time"
74.Fa "int offset_day"
75.Fa "long offset_sec"
76.Fa "time_t *in_tm"
77.Fc
78.Ft ASN1_TIME *
79.Fo X509_time_adj
80.Fa "ASN1_TIME *asn1_time"
81.Fa "long offset_sec"
82.Fa "time_t *in_tm"
83.Fc
84.Sh DESCRIPTION
85.Fn X509_cmp_time
86parses
87.Fa asn1_time
88with
89.Xr ASN1_time_parse 3
90and compares it to
91.Fa cmp_time .
92.Fn X509_cmp_current_time
93compares it to the current time.
94.Pp
95.Fn X509_time_adj_ex
96sets
97.Fa asn1_time
98to a time
99.Fa offset_day
100and
101.Fa offset_sec
102later than
103.Fa in_tm .
104.Fn X509_time_adj
105does the same with a 0 day offset.
106If
107.Fa asn1_time
108is
109.Dv NULL ,
110a new
111.Vt ASN1_TIME
112structure is allocated and returned.
113.Pp
114In all functions, if
115.Fa in_tm
116is
117.Dv NULL ,
118the current time is used.
119.Sh RETURN VALUES
120.Fn X509_cmp_time
121and
122.Fn X509_cmp_current_time
123return -1 if
124.Fa asn1_time
125is earlier than or equal to
126.Fa cmp_time ,
1271 if it is later, or 0 on error.
128.Pp
129.Fn X509_time_adj_ex
130and
131.Fn X509_time_adj
132return a pointer to the updated
133.Vt ASN1_TIME
134structure or
135.Dv NULL
136on error.
137.Sh SEE ALSO
138.Xr ASN1_TIME_new 3 ,
139.Xr ASN1_time_parse 3 ,
140.Xr ASN1_TIME_set 3 ,
141.Xr time 3
142.Sh HISTORY
143.Fn X509_cmp_current_time
144first appeared in SSLeay 0.6.0 and has been available since
145.Ox 2.4 .
146.Pp
147.Fn X509_cmp_time
148and
149.Fn X509_time_adj
150first appeared in OpenSSL 0.9.6 and have been available since
151.Ox 2.9 .
152.Pp
153.Fn X509_time_adj_ex
154first appeared in OpenSSL 1.0.0 and has been available since
155.Ox 4.9 .
156