ASN1_TIME_SET(3ossl)
okay bestie, welcome to the ASN1_TIME_SET(3ossl) manual page โ the OpenSSL ASN.1 Time situation, part 1 of 2 ๐ซถโจ this is a whole cast of functions and they are all kind of iconic in their own way ๐
๐ธ NAME ๐ธ
This page is the home base for all the ASN.1 Time functions: ASN1_TIME_set, ASN1_UTCTIME_set, ASN1_GENERALIZEDTIME_set, ASN1_TIME_adj, ASN1_UTCTIME_adj, ASN1_GENERALIZEDTIME_adj, ASN1_TIME_check, ASN1_UTCTIME_check, ASN1_GENERALIZEDTIME_check, ASN1_TIME_set_string, ASN1_UTCTIME_set_string, ASN1_GENERALIZEDTIME_set_string, ASN1_TIME_set_string_X509, ASN1_TIME_normalize, ASN1_TIME_to_tm, ASN1_TIME_print, ASN1_TIME_print_ex, ASN1_UTCTIME_print, ASN1_GENERALIZEDTIME_print, ASN1_TIME_diff, ASN1_TIME_cmp_time_t, ASN1_UTCTIME_cmp_time_t, ASN1_TIME_compare, ASN1_TIME_to_generalizedtime, ASN1_TIME_dup, ASN1_UTCTIME_dup, and ASN1_GENERALIZEDTIME_dup โ aka the ASN.1 Time functions, no cap ๐
โจ SYNOPSIS โจ
hereโs the whole squad in signature form, copy-paste exact because yes:
ASN1_TIME *ASN1_TIME_set(ASN1_TIME *s, time_t t);
ASN1_UTCTIME *ASN1_UTCTIME_set(ASN1_UTCTIME *s, time_t t);
ASN1_GENERALIZEDTIME *ASN1_GENERALIZEDTIME_set(ASN1_GENERALIZEDTIME *s,
time_t t);
ASN1_TIME *ASN1_TIME_adj(ASN1_TIME *s, time_t t, int offset_day,
long offset_sec);
ASN1_UTCTIME *ASN1_UTCTIME_adj(ASN1_UTCTIME *s, time_t t,
int offset_day, long offset_sec);
ASN1_GENERALIZEDTIME *ASN1_GENERALIZEDTIME_adj(ASN1_GENERALIZEDTIME *s,
time_t t, int offset_day,
long offset_sec);
int ASN1_TIME_set_string(ASN1_TIME *s, const char *str);
int ASN1_TIME_set_string_X509(ASN1_TIME *s, const char *str);
int ASN1_UTCTIME_set_string(ASN1_UTCTIME *s, const char *str);
int ASN1_GENERALIZEDTIME_set_string(ASN1_GENERALIZEDTIME *s,
const char *str);
int ASN1_TIME_normalize(ASN1_TIME *s);
int ASN1_TIME_check(const ASN1_TIME *t);
int ASN1_UTCTIME_check(const ASN1_UTCTIME *t);
int ASN1_GENERALIZEDTIME_check(const ASN1_GENERALIZEDTIME *t);
int ASN1_TIME_print(BIO *b, const ASN1_TIME *s);
int ASN1_TIME_print_ex(BIO *bp, const ASN1_TIME *tm, unsigned long flags);
int ASN1_UTCTIME_print(BIO *b, const ASN1_UTCTIME *s);
int ASN1_GENERALIZEDTIME_print(BIO *b, const ASN1_GENERALIZEDTIME *s);
int ASN1_TIME_to_tm(const ASN1_TIME *s, struct tm *tm);
int ASN1_TIME_diff(int *pday, int *psec, const ASN1_TIME *from,
const ASN1_TIME *to);
int ASN1_TIME_cmp_time_t(const ASN1_TIME *s, time_t t);
int ASN1_UTCTIME_cmp_time_t(const ASN1_UTCTIME *s, time_t t);
int ASN1_TIME_compare(const ASN1_TIME *a, const ASN1_TIME *b);
ASN1_GENERALIZEDTIME *ASN1_TIME_to_generalizedtime(ASN1_TIME *t,
ASN1_GENERALIZEDTIME **out);
ASN1_TIME *ASN1_TIME_dup(const ASN1_TIME *t);
ASN1_UTCTIME *ASN1_UTCTIME_dup(const ASN1_UTCTIME *t);
ASN1_GENERALIZEDTIME *ASN1_GENERALIZEDTIME_dup(const ASN1_GENERALIZEDTIME *t);
๐ DESCRIPTION ๐
okay so hereโs the vibe check on every little group of functions, bestie ๐
ASN1_TIME_set(),ASN1_UTCTIME_set(),ASN1_GENERALIZEDTIME_set()โ these set the structuresto the time represented by thetime_tvaluet. IfsisNULL, a new time structure is allocated and returned. slay โจASN1_TIME_adj(),ASN1_UTCTIME_adj(),ASN1_GENERALIZEDTIME_adj()โ these set the time structuresto the time represented by the timeoffset_dayandoffset_secafter thetime_tvaluet. The values ofoffset_dayoroffset_seccan be negative to set a time beforet. Theoffset_secvalue can also exceed the number of seconds in a day. IfsisNULL, a new structure is allocated and returned ๐ASN1_TIME_set_string(),ASN1_UTCTIME_set_string(),ASN1_GENERALIZEDTIME_set_string()โ these set the time structuresto the time represented by stringstr, which must be in appropriate ASN.1 time format (for exampleYYMMDDHHMMSSZorYYYYMMDDHHMMSSZ). IfsisNULL, this function performs a format check onstronly. The stringstris copied intos๐ASN1_TIME_set_string_X509()โ setsASN1_TIMEstructuresto the time represented by stringstr, which must be in appropriate time format that RFC 5280 requires. That means it only allowsYYMMDDHHMMSSZandYYYYMMDDHHMMSSZ(leap second is rejected); all other ASN.1 time format are not allowed. IfsisNULL, this function performs a format check onstronly ๐ฆASN1_TIME_normalize()โ converts anASN1_GENERALIZEDTIMEorASN1_UTCTIMEinto a time value that can be used in a certificate. It should be used after theASN1_TIME_set_string()functions and beforeASN1_TIME_print()functions to get consistent (i.e. GMT) results ๐ธASN1_TIME_check(),ASN1_UTCTIME_check(),ASN1_GENERALIZEDTIME_check()โ these check the syntax of the time structures๐งASN1_TIME_print(),ASN1_UTCTIME_print(),ASN1_GENERALIZEDTIME_print()โ these print the time structuresto BIObin human readable format. It will be of the formatMMM DD HH:MM:SS[.s*] YYYY GMT, for example"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_print_ex()โ providesflagsto specify the output format of the datetime. This can be eitherASN1_DTFLGS_RFC822orASN1_DTFLGS_ISO8601โญASN1_TIME_to_tm()โ converts the timesto the standardtmstructure. IfsisNULL, then the current time is converted. The output time is GMT. Thetm_sec,tm_min,tm_hour,tm_mday,tm_wday,tm_yday,tm_monandtm_yearfields of thetmstructure are set to proper values, whereas all other fields are set to0. IftmisNULL, this function performs a format check onsonly. Ifsis in Generalized format with fractional seconds, e.g.YYYYMMDDHHMMSS.SSSZ, the fractional seconds will be lost while convertingstotmstructure ๐ญASN1_TIME_diff()โ sets*pdayand*psecto the time difference betweenfromandto. Iftorepresents a time later thanfrom, then one or both (depending on the time difference) of*pdayand*psecwill be positive. Iftorepresents a time earlier thanfrom, then one or both of*pdayand*psecwill be negative. Iftoandfromrepresent the same time, then*pdayand*psecwill both be zero. If both*pdayand*psecare nonzero they will always have the same sign. The value of*psecwill always be less than the number of seconds in a day. IffromortoisNULL, the current time is used ๐ฅASN1_TIME_cmp_time_t()andASN1_UTCTIME_cmp_time_t()โ these compare the two times represented by the time structuresand thetime_tt๐ซASN1_TIME_compare()โ compares the two times represented by the time structuresaandb๐ซถASN1_TIME_to_generalizedtime()โ converts anASN1_TIMEto anASN1_GENERALIZEDTIME, regardless of year. If eitheroutor*outareNULL, then a new object is allocated and must be freed after use ๐ASN1_TIME_dup(),ASN1_UTCTIME_dup(),ASN1_GENERALIZEDTIME_dup()โ these duplicate the time structuretand return the duplicated result correspondingly ๐
๐ฆ NOTES ๐ฆ
- The
ASN1_TIMEstructure corresponds to the ASN.1 structure Time defined inRFC5280et al. The time setting functions obey the rules outlined inRFC5280: if the date can be represented by UTCTime it is used, else GeneralizedTime is used โจ - The
ASN1_TIME,ASN1_UTCTIMEandASN1_GENERALIZEDTIMEstructures are represented as anASN1_STRINGinternally and can be freed up usingASN1_STRING_free()๐ - The
ASN1_TIMEstructure can represent years from0000to9999but no attempt is made to correct ancient calendar changes (for example from Julian to Gregorian calendars) ๐ธ ASN1_UTCTIMEis limited to a year range of1950through2049๐- Some applications add offset times directly to a
time_tvalue and pass the results toASN1_TIME_set()(or equivalent). This can cause problems as thetime_tvalue can overflow on some systems resulting in unexpected results. New applications should useASN1_TIME_adj()instead and pass the offset value in theoffset_secandoffset_dayparameters instead of directly manipulating atime_tvalue โ ๏ธ ASN1_TIME_adj()may change the type fromASN1_GENERALIZEDTIMEtoASN1_UTCTIME, or vice versa, based on the resulting year.ASN1_GENERALIZEDTIME_adj()andASN1_UTCTIME_adj()will not modify the type of the return structure ๐- It is recommended that functions starting with
ASN1_TIMEbe used instead of those starting withASN1_UTCTIMEorASN1_GENERALIZEDTIME. The functions starting withASN1_UTCTIMEandASN1_GENERALIZEDTIMEact only on that specific time format. The functions starting withASN1_TIMEwill operate on either format ๐ - Users familiar with RFC822 should note that when specifying the flag
ASN1_DTFLGS_RFC822the year will be formatted as documented above, i.e., using 4 digits, not 2 as specified in RFC822 ๐ง
๐ BUGS ๐
ASN1_TIME_print(),ASN1_UTCTIME_print()andASN1_GENERALIZEDTIME_print()do not print out the timezone: it either prints out"GMT"or nothing. But all certificates complying withRFC5280et al use GMT anyway ๐ASN1_TIME_print(),ASN1_TIME_print_ex(),ASN1_UTCTIME_print()andASN1_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 ๐ซถ
๐ RETURN VALUES ๐
ASN1_TIME_set(),ASN1_UTCTIME_set(),ASN1_GENERALIZEDTIME_set(),ASN1_TIME_adj(),ASN1_UTCTIME_adj()andASN1_GENERALIZEDTIME_set()return a pointer to a time structure orNULLif an error occurred โจASN1_TIME_set_string(),ASN1_UTCTIME_set_string(),ASN1_GENERALIZEDTIME_set_string()andASN1_TIME_set_string_X509()return1if the time value is successfully set and0otherwise ๐ASN1_TIME_normalize()returns1on success, and0on error ๐ASN1_TIME_check(),ASN1_UTCTIME_checkandASN1_GENERALIZEDTIME_check()return1if the structure is syntactically correct and0otherwise ๐ธASN1_TIME_print(),ASN1_UTCTIME_print()andASN1_GENERALIZEDTIME_print()return1if the time is successfully printed out and0if an I/O error occurred an error occurred (I/O error or invalid time format) ๐ญASN1_TIME_to_tm()returns1if the time is successfully parsed and0if an error occurred (invalid time format) ๐ฆASN1_TIME_diff()returns1for success and0for failure. It can fail if the passed-in time structure has invalid syntax, for example ๐ฅASN1_TIME_cmp_time_t()andASN1_UTCTIME_cmp_time_t()return-1ifsis beforet,0ifsequalst, or1ifsis aftert.-2is returned on error ๐ASN1_TIME_compare()returns-1ifais beforeb,0ifaequalsb, or1ifais afterb.-2is returned on error ๐ซASN1_TIME_to_generalizedtime()returns a pointer to the appropriate time structure on success orNULLif an error occurred ๐ASN1_TIME_dup(),ASN1_UTCTIME_dup()andASN1_GENERALIZEDTIME_dup()return a pointer to a time structure orNULLif an error occurred ๐
โจ EXAMPLES โจ
Okay bestie, real talk โ this is where it gets fun. Here's how you actually use these things ๐
Set a time to one hour from now and print it out
Lowkey the cleanest little demo ever. Set a time structure to one hour after the current time and print it out:
#include <time.h>
#include <openssl/asn1.h>
ASN1_TIME *tm;
time_t t;
BIO *b;
t = time(NULL);
tm = ASN1_TIME_adj(NULL, t, 0, 60 * 60);
b = BIO_new_fp(stdout, BIO_NOCLOSE);
ASN1_TIME_print(b, tm);
ASN1_STRING_free(tm);
BIO_free(b);
Notice that 60 * 60? That's sixty minutes times sixty seconds, aka one hour, and yes we're doing math in public ๐งฎโจ Calling ASN1_TIME_adj() with NULL as the first arg means it allocates a shiny new ASN1_TIME for you, and then you gotta ASN1_STRING_free() it when you're done because we do not leave memory leaks lying around ๐
Is this time later or sooner than now?
Determine if one time is later or sooner than the current time:
int day, sec;
if (!ASN1_TIME_diff(&day, &sec, NULL, to))
/* Invalid time format */
if (day > 0 || sec > 0)
printf("Later\n");
else if (day < 0 || sec < 0)
printf("Sooner\n");
else
printf("Same\n");
Passing NULL as the from argument means "compare against right now", and the diff gets poured into day and sec ๐ซถ Also note the vibe check in that if (!ASN1_TIME_diff(...)) โ if it returns false you're dealing with an invalid time format, so handle that before you go printing "Later" like a liar ๐ญ
๐ HISTORY ๐
Not me giving you the lore drop ๐ The ASN1_TIME_to_tm() function was added in OpenSSL 1.1.1.
The ASN1_TIME_set_string_X509() function was added in OpenSSL 1.1.1.
The ASN1_TIME_normalize() function was added in OpenSSL 1.1.1.
The ASN1_TIME_cmp_time_t() function was added in OpenSSL 1.1.1.
The ASN1_TIME_compare() function was added in OpenSSL 1.1.1.
Bestie that's five functions all dropping in 1.1.1 โ that release really said "I'll do it myself" and ate ๐๐ฅ
๐ COPYRIGHT ๐
Copyright 2015-2025 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.
Fr fr, read the License before you go copying this around โ "not in compliance" is not the flex you think it is ๐
Okay that's the whole page, you made it to the end, I'm so proud of you ๐โจ This gem is from OpenSSL 3.5.6, dated 2026-04-07, and it's filed under ASN1_TIME_SET(3ossl) โ go forth and handle your timestamps responsibly, mwah ๐๐ธ
๐ฆ where this page comes from
- freebsd 15.1: base 15.1
- ๐ girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms