Security-59306.61.1.tar.gz

[apple/security.git] / OSX / libsecurity_cdsa_utils / lib / cuTimeStr.h

diff --git a/OSX/libsecurity_cdsa_utils/lib/cuTimeStr.h b/OSX/libsecurity_cdsa_utils/lib/cuTimeStr.h
index 0eefc56eb1ca7fc4dd0a89d7f4de868825cf5399..77cef334f0ecb72e1ca33f4cf1e38b3e9823b7d6 100644 (file)
--- a/OSX/libsecurity_cdsa_utils/lib/cuTimeStr.h
+++ b/OSX/libsecurity_cdsa_utils/lib/cuTimeStr.h
@@ -1,25 +1,25 @@
 /*
- * Copyright (c) 2002,2011,2014 Apple Inc. All Rights Reserved.
- * 
+ * Copyright (c) 2002,2011,2014-2019 Apple Inc. All Rights Reserved.
+ *
  * The contents of this file constitute Original Code as defined in and are
  * subject to the Apple Public Source License Version 1.2 (the 'License').
- * You may not use this file except in compliance with the License. 
+ * You may not use this file except in compliance with the License.
  * Please obtain a copy of the License at http://www.apple.com/publicsource
  * and read it before using this file.
- * 
+ *
  * This Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
- * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
- * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
- * Please see the License for the specific language governing rights 
+ * Please see the License for the specific language governing rights
  * and limitations under the License.
  */
- 
+
 /*
  * cuTimeStr.h = Time string utilities.
  */
- 
+
 #ifndef        _TIME_STR_H_
 #define _TIME_STR_H_
 
@@ -38,7 +38,7 @@ extern "C" {
 /*
  * Given a string containing either a UTC-style or "generalized time"
  * time string, convert to a struct tm (in GMT/UTC). Returns nonzero on
- * error. 
+ * error.
  */
 int cuTimeStringToTm(
        const char                      *str,
@@ -46,23 +46,45 @@ int cuTimeStringToTm(
        struct tm                       *tmp);
 
 typedef enum {
-       TIME_UTC,
-       TIME_CSSM,
-       TIME_GEN
+       CU_TIME_UTC = 0,
+       CU_TIME_LEGACY = 1, /* do not use; see note below */
+       CU_TIME_GEN = 2,
+       CU_TIME_CSSM = 3
 } timeSpec;
 
+/* TIME_UTC was formerly defined in this header with a value of 0. However,
+ * a newer version of <time.h> may define it with a value of 1. Clients which
+ * specify the TIME_UTC constant for a timeSpec parameter will get a value
+ * of 0 under the old header, and a value of 1 under the newer header.
+ * The latter conflicts with the old definition of TIME_CSSM. To resolve this,
+ * we now treat 1 as a legacy value which maps to CU_TIME_UTC if TIME_UTC=1,
+ * otherwise to CU_TIME_CSSM.
+ *
+ * Important: any code which specifies the legacy TIME_CSSM constant must be
+ * recompiled against this header to ensure the correct timeSpec value is used.
+ */
+#ifndef TIME_UTC
+#define TIME_UTC CU_TIME_UTC /* time.h has not defined TIME_UTC */
+#endif
+#ifndef TIME_GEN
+#define TIME_GEN CU_TIME_GEN
+#endif
+#ifndef TIME_CSSM
+#define TIME_CSSM CU_TIME_CSSM
+#endif
+
 /*
  * Return an APP_MALLOCd time string, specified format and time relative
  * to 'now' in seconds.
  */
 char *cuTimeAtNowPlus(
-       int                             secFromNow, 
+       int                             secFromNow,
        timeSpec                        spec);
 
 /*
  * Convert a CSSM_X509_TIME, which can be in any of three forms (UTC,
  * generalized, or CSSM_TIMESTRING) into a CSSM_TIMESTRING. Caller
- * must free() the result. Returns NULL if x509time is badly formed. 
+ * must free() the result. Returns NULL if x509time is badly formed.
  */
 char *cuX509TimeToCssmTimestring(
        const CSSM_X509_TIME    *x509Time,