diff options
| author | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2020-12-18 21:47:20 +0100 |
|---|---|---|
| committer | Dr. David von Oheimb <dev@ddvo.net> | 2021-01-20 15:55:58 +0100 |
| commit | b09aa550d3d9af269f9551a5a95a3d8408d9098d (patch) | |
| tree | 7cfcb3e10b4ee022e7dae8d0bb4242180cfc3bd3 /doc/man3/ASN1_TIME_set.pod | |
| parent | 9495cfbc22393aee87aa877e9e2e726c2cc441f1 (diff) | |
ASN1_TIME_print() etc.: Improve doc and add comment on handling invalid time input
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/13714)
Diffstat (limited to 'doc/man3/ASN1_TIME_set.pod')
| -rw-r--r-- | doc/man3/ASN1_TIME_set.pod | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/man3/ASN1_TIME_set.pod b/doc/man3/ASN1_TIME_set.pod index b3163ad539..60898e4e0a 100644 --- a/doc/man3/ASN1_TIME_set.pod +++ b/doc/man3/ASN1_TIME_set.pod @@ -102,9 +102,9 @@ functions check the syntax of the time structure I<s>. The ASN1_TIME_print(), ASN1_UTCTIME_print() and ASN1_GENERALIZEDTIME_print() functions print the time structure I<s> to BIO I<b> in human readable format. It will be of the format MMM DD HH:MM:SS YYYY [GMT], for example -"Feb 3 00:55:52 2015 GMT" it does not include a newline. If the time -structure has invalid format it prints out "Bad time value" and returns -an error. The output for generalized time may include a fractional part +"Feb 3 00:55:52 2015 GMT", which does not include a newline. +If the time structure has invalid format it prints out "Bad time value" and +returns an error. The output for generalized time may include a fractional part following the second. ASN1_TIME_to_tm() converts the time I<s> to the standard I<tm> structure. @@ -181,6 +181,9 @@ ASN1_TIME_print(), ASN1_UTCTIME_print() and ASN1_GENERALIZEDTIME_print() do not print out the timezone: it either prints out "GMT" or nothing. But all certificates complying with RFC5280 et al use GMT anyway. +ASN1_TIME_print(), ASN1_UTCTIME_print() and ASN1_GENERALIZEDTIME_print() +do not distinguish if they fail because of an I/O error or invalid time format. + Use the ASN1_TIME_normalize() function to normalize the time value before printing to get GMT results. @@ -199,9 +202,9 @@ ASN1_TIME_normalize() returns 1 on success, and 0 on error. ASN1_TIME_check(), ASN1_UTCTIME_check and ASN1_GENERALIZEDTIME_check() return 1 if the structure is syntactically correct and 0 otherwise. -ASN1_TIME_print(), ASN1_UTCTIME_print() and ASN1_GENERALIZEDTIME_print() return -1 if the time is successfully printed out and 0 if an error occurred (I/O error -or invalid time format). +ASN1_TIME_print(), ASN1_UTCTIME_print() and ASN1_GENERALIZEDTIME_print() +return 1 if the time is successfully printed out and +0 if an I/O error occurred an error occurred (I/O error or invalid time format). ASN1_TIME_to_tm() returns 1 if the time is successfully parsed and 0 if an error occurred (invalid time format). |