Adapt 80-test_cmp_http.t and its data for random accept ports
[openssl.git] / doc / man3 / ASN1_TIME_set.pod
1 =pod
2
3 =head1 NAME
4
5 ASN1_TIME_set, ASN1_UTCTIME_set, ASN1_GENERALIZEDTIME_set,
6 ASN1_TIME_adj, ASN1_UTCTIME_adj, ASN1_GENERALIZEDTIME_adj,
7 ASN1_TIME_check, ASN1_UTCTIME_check, ASN1_GENERALIZEDTIME_check,
8 ASN1_TIME_set_string, ASN1_UTCTIME_set_string, ASN1_GENERALIZEDTIME_set_string,
9 ASN1_TIME_set_string_X509,
10 ASN1_TIME_normalize,
11 ASN1_TIME_to_tm,
12 ASN1_TIME_print, ASN1_UTCTIME_print, ASN1_GENERALIZEDTIME_print,
13 ASN1_TIME_diff,
14 ASN1_TIME_cmp_time_t, ASN1_UTCTIME_cmp_time_t,
15 ASN1_TIME_compare,
16 ASN1_TIME_to_generalizedtime,
17 ASN1_TIME_dup, ASN1_UTCTIME_dup, ASN1_GENERALIZEDTIME_dup - ASN.1 Time functions
18
19 =head1 SYNOPSIS
20
21  ASN1_TIME *ASN1_TIME_set(ASN1_TIME *s, time_t t);
22  ASN1_UTCTIME *ASN1_UTCTIME_set(ASN1_UTCTIME *s, time_t t);
23  ASN1_GENERALIZEDTIME *ASN1_GENERALIZEDTIME_set(ASN1_GENERALIZEDTIME *s,
24                                                 time_t t);
25
26  ASN1_TIME *ASN1_TIME_adj(ASN1_TIME *s, time_t t, int offset_day,
27                           long offset_sec);
28  ASN1_UTCTIME *ASN1_UTCTIME_adj(ASN1_UTCTIME *s, time_t t,
29                                 int offset_day, long offset_sec);
30  ASN1_GENERALIZEDTIME *ASN1_GENERALIZEDTIME_adj(ASN1_GENERALIZEDTIME *s,
31                                                 time_t t, int offset_day,
32                                                 long offset_sec);
33
34  int ASN1_TIME_set_string(ASN1_TIME *s, const char *str);
35  int ASN1_TIME_set_string_X509(ASN1_TIME *s, const char *str);
36  int ASN1_UTCTIME_set_string(ASN1_UTCTIME *s, const char *str);
37  int ASN1_GENERALIZEDTIME_set_string(ASN1_GENERALIZEDTIME *s,
38                                      const char *str);
39
40  int ASN1_TIME_normalize(ASN1_TIME *s);
41
42  int ASN1_TIME_check(const ASN1_TIME *t);
43  int ASN1_UTCTIME_check(const ASN1_UTCTIME *t);
44  int ASN1_GENERALIZEDTIME_check(const ASN1_GENERALIZEDTIME *t);
45
46  int ASN1_TIME_print(BIO *b, const ASN1_TIME *s);
47  int ASN1_UTCTIME_print(BIO *b, const ASN1_UTCTIME *s);
48  int ASN1_GENERALIZEDTIME_print(BIO *b, const ASN1_GENERALIZEDTIME *s);
49
50  int ASN1_TIME_to_tm(const ASN1_TIME *s, struct tm *tm);
51  int ASN1_TIME_diff(int *pday, int *psec, const ASN1_TIME *from,
52                     const ASN1_TIME *to);
53
54  int ASN1_TIME_cmp_time_t(const ASN1_TIME *s, time_t t);
55  int ASN1_UTCTIME_cmp_time_t(const ASN1_UTCTIME *s, time_t t);
56
57  int ASN1_TIME_compare(const ASN1_TIME *a, const ASN1_TIME *b);
58
59  ASN1_GENERALIZEDTIME *ASN1_TIME_to_generalizedtime(ASN1_TIME *t,
60                                                     ASN1_GENERALIZEDTIME **out);
61
62  ASN1_TIME *ASN1_TIME_dup(const ASN1_TIME *t);
63  ASN1_UTCTIME *ASN1_UTCTIME_dup(const ASN1_UTCTIME *t);
64  ASN1_GENERALIZEDTIME *ASN1_GENERALIZEDTIME_dup(const ASN1_GENERALIZEDTIME *t);
65
66 =head1 DESCRIPTION
67
68 The ASN1_TIME_set(), ASN1_UTCTIME_set() and ASN1_GENERALIZEDTIME_set()
69 functions set the structure I<s> to the time represented by the time_t
70 value I<t>. If I<s> is NULL a new time structure is allocated and returned.
71
72 The ASN1_TIME_adj(), ASN1_UTCTIME_adj() and ASN1_GENERALIZEDTIME_adj()
73 functions set the time structure I<s> to the time represented
74 by the time I<offset_day> and I<offset_sec> after the time_t value I<t>.
75 The values of I<offset_day> or I<offset_sec> can be negative to set a
76 time before I<t>. The I<offset_sec> value can also exceed the number of
77 seconds in a day. If I<s> is NULL a new structure is allocated
78 and returned.
79
80 The ASN1_TIME_set_string(), ASN1_UTCTIME_set_string() and
81 ASN1_GENERALIZEDTIME_set_string() functions set the time structure I<s>
82 to the time represented by string I<str> which must be in appropriate ASN.1
83 time format (for example YYMMDDHHMMSSZ or YYYYMMDDHHMMSSZ). If I<s> is NULL
84 this function performs a format check on I<str> only. The string I<str>
85 is copied into I<s>.
86
87 ASN1_TIME_set_string_X509() sets B<ASN1_TIME> structure I<s> to the time
88 represented by string I<str> which must be in appropriate time format
89 that RFC 5280 requires, which means it only allows YYMMDDHHMMSSZ and
90 YYYYMMDDHHMMSSZ (leap second is rejected), all other ASN.1 time format
91 are not allowed. If I<s> is NULL this function performs a format check
92 on I<str> only.
93
94 The ASN1_TIME_normalize() function converts an B<ASN1_GENERALIZEDTIME> or
95 B<ASN1_UTCTIME> into a time value that can be used in a certificate. It
96 should be used after the ASN1_TIME_set_string() functions and before
97 ASN1_TIME_print() functions to get consistent (i.e. GMT) results.
98
99 The ASN1_TIME_check(), ASN1_UTCTIME_check() and ASN1_GENERALIZEDTIME_check()
100 functions check the syntax of the time structure I<s>.
101
102 The ASN1_TIME_print(), ASN1_UTCTIME_print() and ASN1_GENERALIZEDTIME_print()
103 functions print the time structure I<s> to BIO I<b> in human readable
104 format. It will be of the format MMM DD HH:MM:SS YYYY [GMT], for example
105 "Feb  3 00:55:52 2015 GMT", which does not include a newline.
106 If the time structure has invalid format it prints out "Bad time value" and
107 returns an error. The output for generalized time may include a fractional part
108 following the second.
109
110 ASN1_TIME_to_tm() converts the time I<s> to the standard I<tm> structure.
111 If I<s> is NULL, then the current time is converted. The output time is GMT.
112 The I<tm_sec>, I<tm_min>, I<tm_hour>, I<tm_mday>, I<tm_wday>, I<tm_yday>,
113 I<tm_mon> and I<tm_year> fields of I<tm> structure are set to proper values,
114 whereas all other fields are set to 0. If I<tm> is NULL this function performs
115 a format check on I<s> only. If I<s> is in Generalized format with fractional
116 seconds, e.g. YYYYMMDDHHMMSS.SSSZ, the fractional seconds will be lost while
117 converting I<s> to I<tm> structure.
118
119 ASN1_TIME_diff() sets I<*pday> and I<*psec> to the time difference between
120 I<from> and I<to>. If I<to> represents a time later than I<from> then
121 one or both (depending on the time difference) of I<*pday> and I<*psec>
122 will be positive. If I<to> represents a time earlier than I<from> then
123 one or both of I<*pday> and I<*psec> will be negative. If I<to> and I<from>
124 represent the same time then I<*pday> and I<*psec> will both be zero.
125 If both I<*pday> and I<*psec> are nonzero they will always have the same
126 sign. The value of I<*psec> will always be less than the number of seconds
127 in a day. If I<from> or I<to> is NULL the current time is used.
128
129 The ASN1_TIME_cmp_time_t() and ASN1_UTCTIME_cmp_time_t() functions compare
130 the two times represented by the time structure I<s> and the time_t I<t>.
131
132 The ASN1_TIME_compare() function compares the two times represented by the
133 time structures I<a> and I<b>.
134
135 The ASN1_TIME_to_generalizedtime() function converts an B<ASN1_TIME> to an
136 B<ASN1_GENERALIZEDTIME>, regardless of year. If either I<out> or
137 I<*out> are NULL, then a new object is allocated and must be freed after use.
138
139 The ASN1_TIME_dup(), ASN1_UTCTIME_dup() and ASN1_GENERALIZEDTIME_dup() functions
140 duplicate the time structure I<t> and return the duplicated result
141 correspondingly.
142
143 =head1 NOTES
144
145 The B<ASN1_TIME> structure corresponds to the ASN.1 structure B<Time>
146 defined in RFC5280 et al. The time setting functions obey the rules outlined
147 in RFC5280: if the date can be represented by UTCTime it is used, else
148 GeneralizedTime is used.
149
150 The B<ASN1_TIME>, B<ASN1_UTCTIME> and B<ASN1_GENERALIZEDTIME> structures are
151 represented as an B<ASN1_STRING> internally and can be freed up using
152 ASN1_STRING_free().
153
154 The B<ASN1_TIME> structure can represent years from 0000 to 9999 but no attempt
155 is made to correct ancient calendar changes (for example from Julian to
156 Gregorian calendars).
157
158 B<ASN1_UTCTIME> is limited to a year range of 1950 through 2049.
159
160 Some applications add offset times directly to a time_t value and pass the
161 results to ASN1_TIME_set() (or equivalent). This can cause problems as the
162 time_t value can overflow on some systems resulting in unexpected results.
163 New applications should use ASN1_TIME_adj() instead and pass the offset value
164 in the I<offset_sec> and I<offset_day> parameters instead of directly
165 manipulating a time_t value.
166
167 ASN1_TIME_adj() may change the type from B<ASN1_GENERALIZEDTIME> to
168 B<ASN1_UTCTIME>, or vice versa, based on the resulting year.
169 ASN1_GENERALIZEDTIME_adj() and ASN1_UTCTIME_adj() will not modify the type
170 of the return structure.
171
172 It is recommended that functions starting with B<ASN1_TIME> be used instead of
173 those starting with B<ASN1_UTCTIME> or B<ASN1_GENERALIZEDTIME>. The functions
174 starting with B<ASN1_UTCTIME> and B<ASN1_GENERALIZEDTIME> act only on that
175 specific time format. The functions starting with B<ASN1_TIME> will operate on
176 either format.
177
178 =head1 BUGS
179
180 ASN1_TIME_print(), ASN1_UTCTIME_print() and ASN1_GENERALIZEDTIME_print()
181 do not print out the timezone: it either prints out "GMT" or nothing. But all
182 certificates complying with RFC5280 et al use GMT anyway.
183
184 ASN1_TIME_print(), ASN1_UTCTIME_print() and ASN1_GENERALIZEDTIME_print()
185 do not distinguish if they fail because of an I/O error or invalid time format.
186
187 Use the ASN1_TIME_normalize() function to normalize the time value before
188 printing to get GMT results.
189
190 =head1 RETURN VALUES
191
192 ASN1_TIME_set(), ASN1_UTCTIME_set(), ASN1_GENERALIZEDTIME_set(),
193 ASN1_TIME_adj(), ASN1_UTCTIME_adj() and ASN1_GENERALIZEDTIME_set() return
194 a pointer to a time structure or NULL if an error occurred.
195
196 ASN1_TIME_set_string(), ASN1_UTCTIME_set_string(),
197 ASN1_GENERALIZEDTIME_set_string() and ASN1_TIME_set_string_X509() return
198 1 if the time value is successfully set and 0 otherwise.
199
200 ASN1_TIME_normalize() returns 1 on success, and 0 on error.
201
202 ASN1_TIME_check(), ASN1_UTCTIME_check and ASN1_GENERALIZEDTIME_check() return 1
203 if the structure is syntactically correct and 0 otherwise.
204
205 ASN1_TIME_print(), ASN1_UTCTIME_print() and ASN1_GENERALIZEDTIME_print()
206 return 1 if the time is successfully printed out and
207 0 if an I/O error occurred an error occurred (I/O error or invalid time format).
208
209 ASN1_TIME_to_tm() returns 1 if the time is successfully parsed and 0 if an
210 error occurred (invalid time format).
211
212 ASN1_TIME_diff() returns 1 for success and 0 for failure. It can fail if the
213 passed-in time structure has invalid syntax, for example.
214
215 ASN1_TIME_cmp_time_t() and ASN1_UTCTIME_cmp_time_t() return -1 if I<s> is
216 before I<t>, 0 if I<s> equals I<t>, or 1 if I<s> is after I<t>. -2 is returned
217 on error.
218
219 ASN1_TIME_compare() returns -1 if I<a> is before I<b>, 0 if I<a> equals I<b>,
220 or 1 if I<a> is after I<b>. -2 is returned on error.
221
222 ASN1_TIME_to_generalizedtime() returns a pointer to the appropriate time
223 structure on success or NULL if an error occurred.
224
225 ASN1_TIME_dup(), ASN1_UTCTIME_dup() and ASN1_GENERALIZEDTIME_dup() return a
226 pointer to a time structure or NULL if an error occurred.
227
228 =head1 EXAMPLES
229
230 Set a time structure to one hour after the current time and print it out:
231
232  #include <time.h>
233  #include <openssl/asn1.h>
234
235  ASN1_TIME *tm;
236  time_t t;
237  BIO *b;
238
239  t = time(NULL);
240  tm = ASN1_TIME_adj(NULL, t, 0, 60 * 60);
241  b = BIO_new_fp(stdout, BIO_NOCLOSE);
242  ASN1_TIME_print(b, tm);
243  ASN1_STRING_free(tm);
244  BIO_free(b);
245
246 Determine if one time is later or sooner than the current time:
247
248  int day, sec;
249
250  if (!ASN1_TIME_diff(&day, &sec, NULL, to))
251      /* Invalid time format */
252
253  if (day > 0 || sec > 0)
254      printf("Later\n");
255  else if (day < 0 || sec < 0)
256      printf("Sooner\n");
257  else
258      printf("Same\n");
259
260 =head1 HISTORY
261
262 The ASN1_TIME_to_tm() function was added in OpenSSL 1.1.1.
263 The ASN1_TIME_set_string_X509() function was added in OpenSSL 1.1.1.
264 The ASN1_TIME_normalize() function was added in OpenSSL 1.1.1.
265 The ASN1_TIME_cmp_time_t() function was added in OpenSSL 1.1.1.
266 The ASN1_TIME_compare() function was added in OpenSSL 1.1.1.
267
268 =head1 COPYRIGHT
269
270 Copyright 2015-2021 The OpenSSL Project Authors. All Rights Reserved.
271
272 Licensed under the Apache License 2.0 (the "License").  You may not use
273 this file except in compliance with the License.  You can obtain a copy
274 in the file LICENSE in the source distribution or at
275 L<https://www.openssl.org/source/license.html>.
276
277 =cut