crypto/o_time.c

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