5f041a575c926979348cd10c15d9d5eeaca30f0c
[openssl.git] / doc / man3 / ASN1_TIME_set.pod
1 =pod
2
3 =head1 NAME
4
5 ASN1_TIME_set, ASN1_TIME_adj, ASN1_TIME_check,
6 ASN1_TIME_set_string, ASN1_TIME_set_string_X509,
7 ASN1_TIME_print, ASN1_TIME_to_tm, ASN1_TIME_diff - ASN.1 Time functions
8
9 =head1 SYNOPSIS
10
11  ASN1_TIME *ASN1_TIME_set(ASN1_TIME *s, time_t t);
12  ASN1_TIME *ASN1_TIME_adj(ASN1_TIME *s, time_t t,
13                           int offset_day, long offset_sec);
14  int ASN1_TIME_set_string(ASN1_TIME *s, const char *str);
15  int ASN1_TIME_set_string_X509(ASN1_TIME *s, const char *str);
16  int ASN1_TIME_check(const ASN1_TIME *t);
17  int ASN1_TIME_print(BIO *b, const ASN1_TIME *s);
18  int ASN1_TIME_to_tm(const ASN1_TIME *s, struct tm *tm);
19
20  int ASN1_TIME_diff(int *pday, int *psec,
21                     const ASN1_TIME *from, const ASN1_TIME *to);
22
23 =head1 DESCRIPTION
24
25 The function ASN1_TIME_set() sets the ASN1_TIME structure B<s> to the
26 time represented by the time_t value B<t>. If B<s> is NULL a new ASN1_TIME
27 structure is allocated and returned.
28
29 ASN1_TIME_adj() sets the ASN1_TIME structure B<s> to the time represented
30 by the time B<offset_day> and B<offset_sec> after the time_t value B<t>.
31 The values of B<offset_day> or B<offset_sec> can be negative to set a
32 time before B<t>. The B<offset_sec> value can also exceed the number of
33 seconds in a day. If B<s> is NULL a new ASN1_TIME structure is allocated
34 and returned.
35
36 ASN1_TIME_set_string() sets ASN1_TIME structure B<s> to the time
37 represented by string B<str> which must be in appropriate ASN.1 time
38 format (for example YYMMDDHHMMSSZ or YYYYMMDDHHMMSSZ). If B<s> is NULL
39 this function performs a format check on B<str> only.
40
41 ASN1_TIME_set_string_X509() sets ASN1_TIME structure B<s> to the time
42 represented by string B<str> which must be in appropriate time format
43 that RFC 5280 requires, which means it only allows YYMMDDHHMMSSZ and
44 YYYYMMDDHHMMSSZ (leap second is rejected), all other ASN.1 time format
45 are not allowed. If B<s> is NULL this function performs a format check
46 on B<str> only.
47
48 ASN1_TIME_check() checks the syntax of ASN1_TIME structure B<s>.
49
50 ASN1_TIME_print() prints out the time B<s> to BIO B<b> in human readable
51 format. It will be of the format MMM DD HH:MM:SS YYYY [GMT], for example
52 "Feb  3 00:55:52 2015 GMT" it does not include a newline. If the time
53 structure has invalid format it prints out "Bad time value" and returns
54 an error.
55
56 ASN1_TIME_to_tm() converts the time B<s> to the standard B<tm> structure.
57 If B<s> is NULL, then the current time is converted. The output time is GMT.
58 Only the B<tm_sec>, B<tm_min>, B<tm_hour>, B<tm_mday>, B<tm_mon> and B<tm_year>
59 fields are updated.
60
61 ASN1_TIME_diff() sets B<*pday> and B<*psec> to the time difference between
62 B<from> and B<to>. If B<to> represents a time later than B<from> then
63 one or both (depending on the time difference) of B<*pday> and B<*psec>
64 will be positive. If B<to> represents a time earlier than B<from> then
65 one or both of B<*pday> and B<*psec> will be negative. If B<to> and B<from>
66 represent the same time then B<*pday> and B<*psec> will both be zero.
67 If both B<*pday> and B<*psec> are non-zero they will always have the same
68 sign. The value of B<*psec> will always be less than the number of seconds
69 in a day. If B<from> or B<to> is NULL the current time is used.
70
71 =head1 NOTES
72
73 The ASN1_TIME structure corresponds to the ASN.1 structure B<Time>
74 defined in RFC5280 et al. The time setting functions obey the rules outlined
75 in RFC5280: if the date can be represented by UTCTime it is used, else
76 GeneralizedTime is used.
77
78 The ASN1_TIME structure is represented as an ASN1_STRING internally and can
79 be freed up using ASN1_STRING_free().
80
81 The ASN1_TIME structure can represent years from 0000 to 9999 but no attempt
82 is made to correct ancient calendar changes (for example from Julian to
83 Gregorian calendars).
84
85 Some applications add offset times directly to a time_t value and pass the
86 results to ASN1_TIME_set() (or equivalent). This can cause problems as the
87 time_t value can overflow on some systems resulting in unexpected results.
88 New applications should use ASN1_TIME_adj() instead and pass the offset value
89 in the B<offset_sec> and B<offset_day> parameters instead of directly
90 manipulating a time_t value.
91
92 =head1 BUGS
93
94 ASN1_TIME_print() currently does not print out the time zone: it either prints
95 out "GMT" or nothing. But all certificates complying with RFC5280 et al use GMT
96 anyway.
97
98 =head1 EXAMPLES
99
100 Set a time structure to one hour after the current time and print it out:
101
102  #include <time.h>
103  #include <openssl/asn1.h>
104
105  ASN1_TIME *tm;
106  time_t t;
107  BIO *b;
108
109  t = time(NULL);
110  tm = ASN1_TIME_adj(NULL, t, 0, 60 * 60);
111  b = BIO_new_fp(stdout, BIO_NOCLOSE);
112  ASN1_TIME_print(b, tm);
113  ASN1_STRING_free(tm);
114  BIO_free(b);
115
116 Determine if one time is later or sooner than the current time:
117
118  int day, sec;
119
120  if (!ASN1_TIME_diff(&day, &sec, NULL, to))
121      /* Invalid time format */
122
123  if (day > 0 || sec > 0)
124      printf("Later\n");
125  else if (day < 0 || sec < 0)
126      printf("Sooner\n");
127  else
128      printf("Same\n");
129
130 =head1 RETURN VALUES
131
132 ASN1_TIME_set() and ASN1_TIME_adj() return a pointer to an ASN1_TIME structure
133 or NULL if an error occurred.
134
135 ASN1_TIME_set_string() and ASN1_TIME_set_string_X509() return 1 if the time
136 value is successfully set and 0 otherwise.
137
138 ASN1_TIME_check() returns 1 if the structure is syntactically correct and 0
139 otherwise.
140
141 ASN1_TIME_print() returns 1 if the time is successfully printed out and 0 if
142 an error occurred (I/O error or invalid time format).
143
144 ASN1_TIME_to_tm() returns 1 if the time is successfully parsed and 0 if an
145 error occured (invalid time format).
146
147 ASN1_TIME_diff() returns 1 for success and 0 for failure. It can fail if the
148 pass ASN1_TIME structure has invalid syntax for example.
149
150 =head1 HISTORY
151
152 The ASN1_TIME_to_tm() function was added in OpenSSL 1.1.1.
153 The ASN1_TIME_set_string_X509() function was added in OpenSSL 1.1.1.
154
155 =head1 COPYRIGHT
156
157 Copyright 2015-2017 The OpenSSL Project Authors. All Rights Reserved.
158
159 Licensed under the OpenSSL license (the "License").  You may not use
160 this file except in compliance with the License.  You can obtain a copy
161 in the file LICENSE in the source distribution or at
162 L<https://www.openssl.org/source/license.html>.
163
164 =cut