1OPENSSL_USER_MACROS(7ossl)          OpenSSL         OPENSSL_USER_MACROS(7ossl)
2
3
4

NAME

6       openssl_user_macros, OPENSSL_API_COMPAT, OPENSSL_NO_DEPRECATED - User
7       defined macros
8

DESCRIPTION

10       User defined macros allow the programmer to control certain aspects of
11       what is exposed by the OpenSSL headers.
12
13       NOTE: to be effective, a user defined macro must be defined before
14       including any header file that depends on it, either in the compilation
15       command ("cc -DMACRO=value") or by defining the macro in source before
16       including any headers.
17
18       Other manual pages may refer to this page when declarations depend on
19       user defined macros.
20
21   The macros
22       OPENSSL_API_COMPAT
23           The value is a version number, given in one of the following two
24           forms:
25
26           "0xMNNFF000L"
27               This is the form supported for all versions up to 1.1.x, where
28               "M" represents the major number, "NN" represents the minor
29               number, and "FF" represents the fix number, as a hexadecimal
30               number.  For version 1.1.0, that's "0x10100000L".
31
32               Any version number may be given, but these numbers are the
33               current known major deprecation points, making them the most
34               meaningful:
35
36               "0x00908000L" (version 0.9.8)
37               "0x10000000L" (version 1.0.0)
38               "0x10100000L" (version 1.1.0)
39
40               For convenience, higher numbers are accepted as well, as long
41               as feasible.  For example, "0x60000000L" will work as expected.
42               However, it is recommended to start using the second form
43               instead:
44
45           "mmnnpp"
46               This form is a simple decimal number calculated with this
47               formula:
48
49               major * 10000 + minor * 100 + patch
50
51               where major, minor and patch are the desired major, minor and
52               patch components of the version number.  For example:
53
54               30000 corresponds to version 3.0.0
55               10002 corresponds to version 1.0.2
56               420101 corresponds to version 42.1.1
57
58           If OPENSSL_API_COMPAT is undefined, this default value is used in
59           its place: 30000
60
61       OPENSSL_NO_DEPRECATED
62           If this macro is defined, all deprecated public symbols in all
63           OpenSSL versions up to and including the version given by
64           OPENSSL_API_COMPAT (or the default value given above, when
65           OPENSSL_API_COMPAT isn't defined) will be hidden.
66

68       Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
69
70       Licensed under the Apache License 2.0 (the "License").  You may not use
71       this file except in compliance with the License.  You can obtain a copy
72       in the file LICENSE in the source distribution or at
73       <https://www.openssl.org/source/license.html>.
74
75
76
773.0.5                             2022-07-05        OPENSSL_USER_MACROS(7ossl)
Impressum