Home | History | Annotate | Download | only in crypto
      1 /* crypto/o_time.c -*- mode:C; c-file-style: "eay" -*- */
      2 /* Written by Richard Levitte (richard (at) levitte.org) for the OpenSSL
      3  * project 2001.
      4  */
      5 /* Written by Dr Stephen N Henson (steve (at) openssl.org) for the OpenSSL
      6  * project 2008.
      7  */
      8 /* ====================================================================
      9  * Copyright (c) 2001 The OpenSSL Project.  All rights reserved.
     10  *
     11  * Redistribution and use in source and binary forms, with or without
     12  * modification, are permitted provided that the following conditions
     13  * are met:
     14  *
     15  * 1. Redistributions of source code must retain the above copyright
     16  *    notice, this list of conditions and the following disclaimer.
     17  *
     18  * 2. Redistributions in binary form must reproduce the above copyright
     19  *    notice, this list of conditions and the following disclaimer in
     20  *    the documentation and/or other materials provided with the
     21  *    distribution.
     22  *
     23  * 3. All advertising materials mentioning features or use of this
     24  *    software must display the following acknowledgment:
     25  *    "This product includes software developed by the OpenSSL Project
     26  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
     27  *
     28  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
     29  *    endorse or promote products derived from this software without
     30  *    prior written permission. For written permission, please contact
     31  *    licensing (at) OpenSSL.org.
     32  *
     33  * 5. Products derived from this software may not be called "OpenSSL"
     34  *    nor may "OpenSSL" appear in their names without prior written
     35  *    permission of the OpenSSL Project.
     36  *
     37  * 6. Redistributions of any form whatsoever must retain the following
     38  *    acknowledgment:
     39  *    "This product includes software developed by the OpenSSL Project
     40  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
     41  *
     42  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
     43  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     44  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     45  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
     46  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     47  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     48  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     49  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     50  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     51  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     52  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
     53  * OF THE POSSIBILITY OF SUCH DAMAGE.
     54  * ====================================================================
     55  *
     56  * This product includes cryptographic software written by Eric Young
     57  * (eay (at) cryptsoft.com).  This product includes software written by Tim
     58  * Hudson (tjh (at) cryptsoft.com).
     59  *
     60  */
     61 
     62 #include <openssl/e_os2.h>
     63 #include <string.h>
     64 #include "o_time.h"
     65 
     66 #ifdef OPENSSL_SYS_VMS
     67 # include <libdtdef.h>
     68 # include <lib$routines.h>
     69 # include <lnmdef.h>
     70 # include <starlet.h>
     71 # include <descrip.h>
     72 # include <stdlib.h>
     73 #endif
     74 
     75 struct tm *OPENSSL_gmtime(const time_t *timer, struct tm *result)
     76 	{
     77 	struct tm *ts = NULL;
     78 
     79 #if defined(OPENSSL_THREADS) && !defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_SYS_OS2) && (!defined(OPENSSL_SYS_VMS) || defined(gmtime_r)) && !defined(OPENSSL_SYS_MACOSX) && !defined(OPENSSL_SYS_SUNOS)
     80 	/* should return &data, but doesn't on some systems,
     81 	   so we don't even look at the return value */
     82 	gmtime_r(timer,result);
     83 	ts = result;
     84 #elif !defined(OPENSSL_SYS_VMS)
     85 	ts = gmtime(timer);
     86 	if (ts == NULL)
     87 		return NULL;
     88 
     89 	memcpy(result, ts, sizeof(struct tm));
     90 	ts = result;
     91 #endif
     92 #ifdef OPENSSL_SYS_VMS
     93 	if (ts == NULL)
     94 		{
     95 		static $DESCRIPTOR(tabnam,"LNM$DCL_LOGICAL");
     96 		static $DESCRIPTOR(lognam,"SYS$TIMEZONE_DIFFERENTIAL");
     97 		char logvalue[256];
     98 		unsigned int reslen = 0;
     99 		struct {
    100 			short buflen;
    101 			short code;
    102 			void *bufaddr;
    103 			unsigned int *reslen;
    104 		} itemlist[] = {
    105 			{ 0, LNM$_STRING, 0, 0 },
    106 			{ 0, 0, 0, 0 },
    107 		};
    108 		int status;
    109 		time_t t;
    110 
    111 		/* Get the value for SYS$TIMEZONE_DIFFERENTIAL */
    112 		itemlist[0].buflen = sizeof(logvalue);
    113 		itemlist[0].bufaddr = logvalue;
    114 		itemlist[0].reslen = &reslen;
    115 		status = sys$trnlnm(0, &tabnam, &lognam, 0, itemlist);
    116 		if (!(status & 1))
    117 			return NULL;
    118 		logvalue[reslen] = '\0';
    119 
    120 		t = *timer;
    121 
    122 /* The following is extracted from the DEC C header time.h */
    123 /*
    124 **  Beginning in OpenVMS Version 7.0 mktime, time, ctime, strftime
    125 **  have two implementations.  One implementation is provided
    126 **  for compatibility and deals with time in terms of local time,
    127 **  the other __utc_* deals with time in terms of UTC.
    128 */
    129 /* We use the same conditions as in said time.h to check if we should
    130    assume that t contains local time (and should therefore be adjusted)
    131    or UTC (and should therefore be left untouched). */
    132 #if __CRTL_VER < 70000000 || defined _VMS_V6_SOURCE
    133 		/* Get the numerical value of the equivalence string */
    134 		status = atoi(logvalue);
    135 
    136 		/* and use it to move time to GMT */
    137 		t -= status;
    138 #endif
    139 
    140 		/* then convert the result to the time structure */
    141 
    142 		/* Since there was no gmtime_r() to do this stuff for us,
    143 		   we have to do it the hard way. */
    144 		{
    145 		/* The VMS epoch is the astronomical Smithsonian date,
    146 		   if I remember correctly, which is November 17, 1858.
    147 		   Furthermore, time is measure in thenths of microseconds
    148 		   and stored in quadwords (64 bit integers).  unix_epoch
    149 		   below is January 1st 1970 expressed as a VMS time.  The
    150 		   following code was used to get this number:
    151 
    152 		   #include <stdio.h>
    153 		   #include <stdlib.h>
    154 		   #include <lib$routines.h>
    155 		   #include <starlet.h>
    156 
    157 		   main()
    158 		   {
    159 		     unsigned long systime[2];
    160 		     unsigned short epoch_values[7] =
    161 		       { 1970, 1, 1, 0, 0, 0, 0 };
    162 
    163 		     lib$cvt_vectim(epoch_values, systime);
    164 
    165 		     printf("%u %u", systime[0], systime[1]);
    166 		   }
    167 		*/
    168 		unsigned long unix_epoch[2] = { 1273708544, 8164711 };
    169 		unsigned long deltatime[2];
    170 		unsigned long systime[2];
    171 		struct vms_vectime
    172 			{
    173 			short year, month, day, hour, minute, second,
    174 				centi_second;
    175 			} time_values;
    176 		long operation;
    177 
    178 		/* Turn the number of seconds since January 1st 1970 to
    179 		   an internal delta time.
    180 		   Note that lib$cvt_to_internal_time() will assume
    181 		   that t is signed, and will therefore break on 32-bit
    182 		   systems some time in 2038.
    183 		*/
    184 		operation = LIB$K_DELTA_SECONDS;
    185 		status = lib$cvt_to_internal_time(&operation,
    186 			&t, deltatime);
    187 
    188 		/* Add the delta time with the Unix epoch and we have
    189 		   the current UTC time in internal format */
    190 		status = lib$add_times(unix_epoch, deltatime, systime);
    191 
    192 		/* Turn the internal time into a time vector */
    193 		status = sys$numtim(&time_values, systime);
    194 
    195 		/* Fill in the struct tm with the result */
    196 		result->tm_sec = time_values.second;
    197 		result->tm_min = time_values.minute;
    198 		result->tm_hour = time_values.hour;
    199 		result->tm_mday = time_values.day;
    200 		result->tm_mon = time_values.month - 1;
    201 		result->tm_year = time_values.year - 1900;
    202 
    203 		operation = LIB$K_DAY_OF_WEEK;
    204 		status = lib$cvt_from_internal_time(&operation,
    205 			&result->tm_wday, systime);
    206 		result->tm_wday %= 7;
    207 
    208 		operation = LIB$K_DAY_OF_YEAR;
    209 		status = lib$cvt_from_internal_time(&operation,
    210 			&result->tm_yday, systime);
    211 		result->tm_yday--;
    212 
    213 		result->tm_isdst = 0; /* There's no way to know... */
    214 
    215 		ts = result;
    216 		}
    217 		}
    218 #endif
    219 	return ts;
    220 	}
    221 
    222 /* Take a tm structure and add an offset to it. This avoids any OS issues
    223  * with restricted date types and overflows which cause the year 2038
    224  * problem.
    225  */
    226 
    227 #define SECS_PER_DAY (24 * 60 * 60)
    228 
    229 static long date_to_julian(int y, int m, int d);
    230 static void julian_to_date(long jd, int *y, int *m, int *d);
    231 
    232 int OPENSSL_gmtime_adj(struct tm *tm, int off_day, long offset_sec)
    233 	{
    234 	int offset_hms, offset_day;
    235 	long time_jd;
    236 	int time_year, time_month, time_day;
    237 	/* split offset into days and day seconds */
    238 	offset_day = offset_sec / SECS_PER_DAY;
    239 	/* Avoid sign issues with % operator */
    240 	offset_hms  = offset_sec - (offset_day * SECS_PER_DAY);
    241 	offset_day += off_day;
    242 	/* Add current time seconds to offset */
    243 	offset_hms += tm->tm_hour * 3600 + tm->tm_min * 60 + tm->tm_sec;
    244 	/* Adjust day seconds if overflow */
    245 	if (offset_hms >= SECS_PER_DAY)
    246 		{
    247 		offset_day++;
    248 		offset_hms -= SECS_PER_DAY;
    249 		}
    250 	else if (offset_hms < 0)
    251 		{
    252 		offset_day--;
    253 		offset_hms += SECS_PER_DAY;
    254 		}
    255 
    256 	/* Convert date of time structure into a Julian day number.
    257 	 */
    258 
    259 	time_year = tm->tm_year + 1900;
    260 	time_month = tm->tm_mon + 1;
    261 	time_day = tm->tm_mday;
    262 
    263 	time_jd = date_to_julian(time_year, time_month, time_day);
    264 
    265 	/* Work out Julian day of new date */
    266 	time_jd += offset_day;
    267 
    268 	if (time_jd < 0)
    269 		return 0;
    270 
    271 	/* Convert Julian day back to date */
    272 
    273 	julian_to_date(time_jd, &time_year, &time_month, &time_day);
    274 
    275 	if (time_year < 1900 || time_year > 9999)
    276 		return 0;
    277 
    278 	/* Update tm structure */
    279 
    280 	tm->tm_year = time_year - 1900;
    281 	tm->tm_mon = time_month - 1;
    282 	tm->tm_mday = time_day;
    283 
    284 	tm->tm_hour = offset_hms / 3600;
    285 	tm->tm_min = (offset_hms / 60) % 60;
    286 	tm->tm_sec = offset_hms % 60;
    287 
    288 	return 1;
    289 
    290 }
    291 
    292 /* Convert date to and from julian day
    293  * Uses Fliegel & Van Flandern algorithm
    294  */
    295 static long date_to_julian(int y, int m, int d)
    296 {
    297 	return (1461 * (y + 4800 + (m - 14) / 12)) / 4 +
    298 		(367 * (m - 2 - 12 * ((m - 14) / 12))) / 12 -
    299 		(3 * ((y + 4900 + (m - 14) / 12) / 100)) / 4 +
    300 		d - 32075;
    301 }
    302 
    303 static void julian_to_date(long jd, int *y, int *m, int *d)
    304 	{
    305 	long  L = jd + 68569;
    306 	long  n = (4 * L) / 146097;
    307 	long  i, j;
    308 
    309 	L = L - (146097 * n + 3) / 4;
    310 	i = (4000 * (L + 1)) / 1461001;
    311 	L = L - (1461 * i) / 4 + 31;
    312 	j = (80 * L) / 2447;
    313 	*d = L - (2447 * j) / 80;
    314 	L = j / 11;
    315 	*m = j + 2 - (12 * L);
    316 	*y = 100 * (n - 49) + i + L;
    317 	}
    318 
    319 #ifdef OPENSSL_TIME_TEST
    320 
    321 #include <stdio.h>
    322 
    323 /* Time checking test code. Check times are identical for a wide range of
    324  * offsets. This should be run on a machine with 64 bit time_t or it will
    325  * trigger the very errors the routines fix.
    326  */
    327 
    328 int main(int argc, char **argv)
    329 	{
    330 	long offset;
    331 	for (offset = 0; offset < 1000000; offset++)
    332 		{
    333 		check_time(offset);
    334 		check_time(-offset);
    335 		check_time(offset * 1000);
    336 		check_time(-offset * 1000);
    337 		}
    338 	}
    339 
    340 int check_time(long offset)
    341 	{
    342 	struct tm tm1, tm2;
    343 	time_t t1, t2;
    344 	time(&t1);
    345 	t2 = t1 + offset;
    346 	OPENSSL_gmtime(&t2, &tm2);
    347 	OPENSSL_gmtime(&t1, &tm1);
    348 	OPENSSL_gmtime_adj(&tm1, 0, offset);
    349 	if ((tm1.tm_year == tm2.tm_year) &&
    350 	    (tm1.tm_mon == tm2.tm_mon) &&
    351 	    (tm1.tm_mday == tm2.tm_mday) &&
    352 	    (tm1.tm_hour == tm2.tm_hour) &&
    353 	    (tm1.tm_min == tm2.tm_min) &&
    354 	    (tm1.tm_sec == tm2.tm_sec))
    355 		return 1;
    356 	fprintf(stderr, "TIME ERROR!!\n");
    357 	fprintf(stderr, "Time1: %d/%d/%d, %d:%02d:%02d\n",
    358 			tm2.tm_mday, tm2.tm_mon + 1, tm2.tm_year + 1900,
    359 			tm2.tm_hour, tm2.tm_min, tm2.tm_sec);
    360 	fprintf(stderr, "Time2: %d/%d/%d, %d:%02d:%02d\n",
    361 			tm1.tm_mday, tm1.tm_mon + 1, tm1.tm_year + 1900,
    362 			tm1.tm_hour, tm1.tm_min, tm1.tm_sec);
    363 	return 0;
    364 	}
    365 
    366 #endif
    367