Fix typo in ASN1_TIME_set.pod
[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 The B<tm_sec>, B<tm_min>, B<tm_hour>, B<tm_mday>, B<tm_wday>, B<tm_yday>,
59 B<tm_mon> and B<tm_year> fields of B<tm> structure are set to proper values,
60 whereas all other fields are set to 0. If B<tm> is NULL this function performs
61 a format check on B<s> only. If B<s> is in Generalized format with fractional
62 seconds, e.g. YYYYMMDDHHMMSS.SSSZ, the fractional seconds will be lost while
63 converting B<s> to B<tm> structure.
64
65 ASN1_TIME_diff() sets B<*pday> and B<*psec> to the time difference between
66 B<from> and B<to>. If B<to> represents a time later than B<from> then
67 one or both (depending on the time difference) of B<*pday> and B<*psec>
68 will be positive. If B<to> represents a time earlier than B<from> then
69 one or both of B<*pday> and B<*psec> will be negative. If B<to> and B<from>
70 represent the same time then B<*pday> and B<*psec> will both be zero.
71 If both B<*pday> and B<*psec> are non-zero they will always have the same
72 sign. The value of B<*psec> will always be less than the number of seconds
73 in a day. If B<from> or B<to> is NULL the current time is used.
74
75 =head1 NOTES
76
77 The ASN1_TIME structure corresponds to the ASN.1 structure B<Time>
78 defined in RFC5280 et al. The time setting functions obey the rules outlined
79 in RFC5280: if the date can be represented by UTCTime it is used, else
80 GeneralizedTime is used.
81
82 The ASN1_TIME structure is represented as an ASN1_STRING internally and can
83 be freed up using ASN1_STRING_free().
84
85 The ASN1_TIME structure can represent years from 0000 to 9999 but no attempt
86 is made to correct ancient calendar changes (for example from Julian to
87 Gregorian calendars).
88
89 Some applications add offset times directly to a time_t value and pass the
90 results to ASN1_TIME_set() (or equivalent). This can cause problems as the
91 time_t value can overflow on some systems resulting in unexpected results.
92 New applications should use ASN1_TIME_adj() instead and pass the offset value
93 in the B<offset_sec> and B<offset_day> parameters instead of directly
94 manipulating a time_t value.
95
96 =head1 BUGS
97
98 ASN1_TIME_print() currently does not print out the time zone: it either prints
99 out "GMT" or nothing. But all certificates complying with RFC5280 et al use GMT
100 anyway.
101
102 =head1 EXAMPLES
103
104 Set a time structure to one hour after the current time and print it out:
105
106  #include <time.h>
107  #include <openssl/asn1.h>
108
109  ASN1_TIME *tm;
110  time_t t;
111  BIO *b;
112
113  t = time(NULL);
114  tm = ASN1_TIME_adj(NULL, t, 0, 60 * 60);
115  b = BIO_new_fp(stdout, BIO_NOCLOSE);
116  ASN1_TIME_print(b, tm);
117  ASN1_STRING_free(tm);
118  BIO_free(b);
119
120 Determine if one time is later or sooner than the current time:
121
122  int day, sec;
123
124  if (!ASN1_TIME_diff(&day, &sec, NULL, to))
125      /* Invalid time format */
126
127  if (day > 0 || sec > 0)
128      printf("Later\n");
129  else if (day < 0 || sec < 0)
130      printf("Sooner\n");
131  else
132      printf("Same\n");
133
134 =head1 RETURN VALUES
135
136 ASN1_TIME_set() and ASN1_TIME_adj() return a pointer to an ASN1_TIME structure
137 or NULL if an error occurred.
138
139 ASN1_TIME_set_string() and ASN1_TIME_set_string_X509() return 1 if the time
140 value is successfully set and 0 otherwise.
141
142 ASN1_TIME_check() returns 1 if the structure is syntactically correct and 0
143 otherwise.
144
145 ASN1_TIME_print() returns 1 if the time is successfully printed out and 0 if
146 an error occurred (I/O error or invalid time format).
147
148 ASN1_TIME_to_tm() returns 1 if the time is successfully parsed and 0 if an
149 error occured (invalid time format).
150
151 ASN1_TIME_diff() returns 1 for success and 0 for failure. It can fail if the
152 pass ASN1_TIME structure has invalid syntax for example.
153
154 =head1 HISTORY
155
156 The ASN1_TIME_to_tm() function was added in OpenSSL 1.1.1.
157 The ASN1_TIME_set_string_X509() function was added in OpenSSL 1.1.1.
158
159 =head1 COPYRIGHT
160
161 Copyright 2015-2017 The OpenSSL Project Authors. All Rights Reserved.
162
163 Licensed under the OpenSSL license (the "License").  You may not use
164 this file except in compliance with the License.  You can obtain a copy
165 in the file LICENSE in the source distribution or at
166 L<https://www.openssl.org/source/license.html>.
167
168 =cut