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