Replumbing: New public API to load or add providers
[openssl.git] / include / openssl / opensslconf.h.in
index 2603247df2c9ce491683794cd1644622a8f592c1..ca680bc3883e4dd90b8a994b619f58f2423a8f02 100644 (file)
@@ -1,21 +1,26 @@
 /*
  * {- join("\n * ", @autowarntext) -}
  *
- * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
+ * Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
  *
- * Licensed under the OpenSSL license (the "License").  You may not use
+ * 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
  */
 
-#ifdef  __cplusplus
+#include <openssl/opensslv.h>
+
+#ifndef HEADER_OPENSSLCONF_H
+# define HEADER_OPENSSLCONF_H
+
+# ifdef  __cplusplus
 extern "C" {
-#endif
+# endif
 
-#ifdef OPENSSL_ALGORITHM_DEFINES
-# error OPENSSL_ALGORITHM_DEFINES no longer supported
-#endif
+# ifdef OPENSSL_ALGORITHM_DEFINES
+#  error OPENSSL_ALGORITHM_DEFINES no longer supported
+# endif
 
 /*
  * OpenSSL was configured with the following options:
@@ -23,34 +28,20 @@ extern "C" {
 
 {- if (@{$config{openssl_sys_defines}}) {
       foreach (@{$config{openssl_sys_defines}}) {
-       $OUT .= "#ifndef $_\n";
-       $OUT .= "# define $_ 1\n";
-       $OUT .= "#endif\n";
+       $OUT .= "# ifndef $_\n";
+       $OUT .= "#  define $_ 1\n";
+       $OUT .= "# endif\n";
       }
     }
     foreach (@{$config{openssl_api_defines}}) {
         (my $macro, my $value) = $_ =~ /^(.*?)=(.*?)$/;
-        $OUT .= "#define OPENSSL_MIN_API $value\n";
-    }
-    if (@{$config{openssl_algorithm_defines}}) {
-      foreach (@{$config{openssl_algorithm_defines}}) {
-       $OUT .= "#ifndef $_\n";
-       $OUT .= "# define $_\n";
-       $OUT .= "#endif\n";
-      }
-    }
-    if (@{$config{openssl_thread_defines}}) {
-      foreach (@{$config{openssl_thread_defines}}) {
-       $OUT .= "#ifndef $_\n";
-       $OUT .= "# define $_\n";
-       $OUT .= "#endif\n";
-      }
+        $OUT .= "# define $macro $value\n";
     }
-    if (@{$config{openssl_other_defines}}) {
-      foreach (@{$config{openssl_other_defines}}) {
-       $OUT .= "#ifndef $_\n";
-       $OUT .= "# define $_\n";
-       $OUT .= "#endif\n";
+    if (@{$config{openssl_feature_defines}}) {
+      foreach (@{$config{openssl_feature_defines}}) {
+       $OUT .= "# ifndef $_\n";
+       $OUT .= "#  define $_\n";
+       $OUT .= "# endif\n";
       }
     }
     "";
@@ -60,88 +51,139 @@ extern "C" {
  * Sometimes OPENSSSL_NO_xxx ends up with an empty file and some compilers
  * don't like that.  This will hopefully silence them.
  */
-#define NON_EMPTY_TRANSLATION_UNIT static void *dummy = &dummy;
+# define NON_EMPTY_TRANSLATION_UNIT static void *dummy = &dummy;
 
 /*
  * Applications should use -DOPENSSL_API_COMPAT=<version> to suppress the
- * declarations of functions deprecated in or before <version>. Otherwise, they
- * still won't see them if the library has been built to disable deprecated
- * functions.
+ * declarations of functions deprecated in or before <version>.  If this is
+ * undefined, the value of the macro OPENSSL_API_MIN above is the default.
+ *
+ * For any version number up until version 1.1.x, <version> is expected to be
+ * the calculated version number 0xMNNFFPPSL.  For version numbers 3.0.0 and
+ * on, <version> is expected to be only the major version number (i.e. 3 for
+ * version 3.0.0).
+ */
+# ifndef DECLARE_DEPRECATED
+#  define DECLARE_DEPRECATED(f)   f;
+#  ifdef __GNUC__
+#   if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ > 0)
+#    undef DECLARE_DEPRECATED
+#    define DECLARE_DEPRECATED(f)    f __attribute__ ((deprecated));
+#   endif
+#  endif
+# endif
+
+/*
+ * We convert the OPENSSL_API_COMPAT value to an API level.  The API level
+ * is the major version number for 3.0.0 and on.  For earlier versions, it
+ * uses this scheme, which is close enough for our purposes:
+ *
+ *      0.x.y   0       (0.9.8 was the last release in this series)
+ *      1.0.x   1       (1.0.2 was the last release in this series)
+ *      1.1.x   2       (1.1.1 was the last release in this series)
+ */
+
+/* In case someone defined both */
+# if defined(OPENSSL_API_COMPAT) && defined(OPENSSL_API_LEVEL)
+#  error "Disallowed to defined both OPENSSL_API_COMPAT and OPENSSL_API_LEVEL"
+# endif
+
+# ifndef OPENSSL_API_COMPAT
+#  define OPENSSL_API_LEVEL OPENSSL_MIN_API
+# else
+#  if (OPENSSL_API_COMPAT < 0x1000L) /* Major version numbers up to 16777215 */
+#   define OPENSSL_API_LEVEL OPENSSL_API_COMPAT
+#  elif (OPENSSL_API_COMPAT & 0xF0000000L) == 0x00000000L
+#   define OPENSSL_API_LEVEL 0
+#  elif (OPENSSL_API_COMPAT & 0xFFF00000L) == 0x10000000L
+#   define OPENSSL_API_LEVEL 1
+#  elif (OPENSSL_API_COMPAT & 0xFFF00000L) == 0x10100000L
+#   define OPENSSL_API_LEVEL 2
+#  else
+/ * Major number 3 to 15 */
+#   define OPENSSL_API_LEVEL ((OPENSSL_API_COMPAT >> 28) & 0xF)
+#  endif
+# endif
+
+/*
+ * Do not deprecate things to be deprecated in version 4.0 before the
+ * OpenSSL version number matches.
  */
-#if defined(OPENSSL_NO_DEPRECATED)
-# define DECLARE_DEPRECATED(f)
-#elif __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ > 0)
-# define DECLARE_DEPRECATED(f)    f __attribute__ ((deprecated));
-#else
-# define DECLARE_DEPRECATED(f)   f;
-#endif
-
-#ifndef OPENSSL_FILE
-# ifdef OPENSSL_NO_FILENAMES
-#  define OPENSSL_FILE ""
-#  define OPENSSL_LINE 0
+# if OPENSSL_VERSION_MAJOR < 4
+#  define DEPRECATEDIN_4(f)       f;
+#  define OPENSSL_API_4 0
+# elif OPENSSL_API_LEVEL < 4
+#  define DEPRECATEDIN_4(f)       DECLARE_DEPRECATED(f)
+#  define OPENSSL_API_4 0
+# else
+#  define DEPRECATEDIN_4(f)
+#  define OPENSSL_API_4 1
+# endif
+
+# if OPENSSL_API_LEVEL < 3
+#  define DEPRECATEDIN_3(f)       DECLARE_DEPRECATED(f)
+#  define OPENSSL_API_3 0
 # else
-#  define OPENSSL_FILE __FILE__
-#  define OPENSSL_LINE __LINE__
+#  define DEPRECATEDIN_3(f)
+#  define OPENSSL_API_3 1
+# endif
+
+# if OPENSSL_API_LEVEL < 2
+#  define DEPRECATEDIN_1_1_0(f)   DECLARE_DEPRECATED(f)
+#  define OPENSSL_API_1_1_0 0
+# else
+#  define DEPRECATEDIN_1_1_0(f)
+#  define OPENSSL_API_1_1_0 1
+# endif
+
+# if OPENSSL_API_LEVEL < 1
+#  define DEPRECATEDIN_1_0_0(f)   DECLARE_DEPRECATED(f)
+#  define OPENSSL_API_1_0_0 0
+# else
+#  define DEPRECATEDIN_1_0_0(f)
+#  define OPENSSL_API_1_0_0 1
+# endif
+
+# if OPENSSL_API_LEVEL < 0
+#  define DEPRECATEDIN_0_9_8(f)   DECLARE_DEPRECATED(f)
+#  define OPENSSL_API_0_9_8 0
+# else
+#  define DEPRECATEDIN_0_9_8(f)
+#  define OPENSSL_API_0_9_8 1
+# endif
+
+# ifndef OPENSSL_FILE
+#  ifdef OPENSSL_NO_FILENAMES
+#   define OPENSSL_FILE ""
+#   define OPENSSL_LINE 0
+#  else
+#   define OPENSSL_FILE __FILE__
+#   define OPENSSL_LINE __LINE__
+#  endif
 # endif
-#endif
-
-#ifndef OPENSSL_MIN_API
-# define OPENSSL_MIN_API 0
-#endif
-
-#if !defined(OPENSSL_API_COMPAT) || OPENSSL_API_COMPAT < OPENSSL_MIN_API
-# undef OPENSSL_API_COMPAT
-# define OPENSSL_API_COMPAT OPENSSL_MIN_API
-#endif
-
-#if OPENSSL_API_COMPAT < 0x10200000L
-# define DEPRECATEDIN_1_2_0(f)   DECLARE_DEPRECATED(f)
-#else
-# define DEPRECATEDIN_1_2_0(f)
-#endif
-
-#if OPENSSL_API_COMPAT < 0x10100000L
-# define DEPRECATEDIN_1_1_0(f)   DECLARE_DEPRECATED(f)
-#else
-# define DEPRECATEDIN_1_1_0(f)
-#endif
-
-#if OPENSSL_API_COMPAT < 0x10000000L
-# define DEPRECATEDIN_1_0_0(f)   DECLARE_DEPRECATED(f)
-#else
-# define DEPRECATEDIN_1_0_0(f)
-#endif
-
-#if OPENSSL_API_COMPAT < 0x00908000L
-# define DEPRECATEDIN_0_9_8(f)   DECLARE_DEPRECATED(f)
-#else
-# define DEPRECATEDIN_0_9_8(f)
-#endif
-
-{- $target{cpuid_obj} ne "mem_clr.o" ? "#define OPENSSL_CPUID_OBJ" : "" -}
 
 /* Generate 80386 code? */
-{- $config{processor} eq "386" ? "#define" : "#undef" -} I386_ONLY
+{- $config{processor} eq "386" ? "# define" : "# undef" -} I386_ONLY
 
-#undef OPENSSL_UNISTD
-#define OPENSSL_UNISTD {- $target{unistd} -}
+# undef OPENSSL_UNISTD
+# define OPENSSL_UNISTD {- $target{unistd} -}
 
-{- $config{export_var_as_fn} ? "#define" : "#undef" -} OPENSSL_EXPORT_VAR_AS_FUNCTION
+{- $config{export_var_as_fn} ? "# define" : "# undef" -} OPENSSL_EXPORT_VAR_AS_FUNCTION
 
 /*
  * The following are cipher-specific, but are part of the public API.
  */
-#if !defined(OPENSSL_SYS_UEFI)
-{- $config{bn_ll} ? "# define" : "# undef" -} BN_LLONG
+# if !defined(OPENSSL_SYS_UEFI)
+{- $config{bn_ll} ? "#  define" : "#  undef" -} BN_LLONG
 /* Only one for the following should be defined */
-{- $config{b64l} ? "# define" : "# undef" -} SIXTY_FOUR_BIT_LONG
-{- $config{b64}  ? "# define" : "# undef" -} SIXTY_FOUR_BIT
-{- $config{b32}  ? "# define" : "# undef" -} THIRTY_TWO_BIT
-#endif
+{- $config{b64l} ? "#  define" : "#  undef" -} SIXTY_FOUR_BIT_LONG
+{- $config{b64}  ? "#  define" : "#  undef" -} SIXTY_FOUR_BIT
+{- $config{b32}  ? "#  define" : "#  undef" -} THIRTY_TWO_BIT
+# endif
 
-#define RC4_INT {- $config{rc4_int} -}
+# define RC4_INT {- $config{rc4_int} -}
 
-#ifdef  __cplusplus
+# ifdef  __cplusplus
 }
-#endif
+# endif
+#endif                          /* HEADER_OPENSSLCONF_H */