Add public API for gettables and settables for keymanagement, signatures and key...
[openssl.git] / e_os.h
1 /*
2  * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #ifndef OSSL_E_OS_H
11 # define OSSL_E_OS_H
12
13 # include <limits.h>
14 # include <openssl/opensslconf.h>
15
16 # include <openssl/e_os2.h>
17 # include <openssl/crypto.h>
18 # include "internal/nelem.h"
19
20 /*
21  * <openssl/e_os2.h> contains what we can justify to make visible to the
22  * outside; this file e_os.h is not part of the exported interface.
23  */
24
25 # if defined(OPENSSL_SYS_VXWORKS) || defined(OPENSSL_SYS_UEFI)
26 #  define NO_CHMOD
27 #  define NO_SYSLOG
28 # endif
29
30 # define get_last_sys_error()    errno
31 # define clear_sys_error()       errno=0
32 # define set_sys_error(e)        errno=(e)
33
34 /********************************************************************
35  The Microsoft section
36  ********************************************************************/
37 # if defined(OPENSSL_SYS_WIN32) && !defined(WIN32)
38 #  define WIN32
39 # endif
40 # if defined(OPENSSL_SYS_WINDOWS) && !defined(WINDOWS)
41 #  define WINDOWS
42 # endif
43 # if defined(OPENSSL_SYS_MSDOS) && !defined(MSDOS)
44 #  define MSDOS
45 # endif
46
47 # ifdef WIN32
48 #  undef get_last_sys_error
49 #  undef clear_sys_error
50 #  undef set_sys_error
51 #  define get_last_sys_error()    GetLastError()
52 #  define clear_sys_error()       SetLastError(0)
53 #  define set_sys_error(e)        SetLastError(e)
54 #  if !defined(WINNT)
55 #   define WIN_CONSOLE_BUG
56 #  endif
57 # else
58 # endif
59
60 # if (defined(WINDOWS) || defined(MSDOS))
61
62 #  ifdef __DJGPP__
63 #   include <unistd.h>
64 #   include <sys/stat.h>
65 #   define _setmode setmode
66 #   define _O_TEXT O_TEXT
67 #   define _O_BINARY O_BINARY
68 #   undef DEVRANDOM_EGD  /*  Neither MS-DOS nor FreeDOS provide 'egd' sockets.  */
69 #   undef DEVRANDOM
70 #   define DEVRANDOM "/dev/urandom\x24"
71 #  endif                        /* __DJGPP__ */
72
73 #  ifndef S_IFDIR
74 #   define S_IFDIR     _S_IFDIR
75 #  endif
76
77 #  ifndef S_IFMT
78 #   define S_IFMT      _S_IFMT
79 #  endif
80
81 #  if !defined(WINNT) && !defined(__DJGPP__)
82 #   define NO_SYSLOG
83 #  endif
84
85 #  ifdef WINDOWS
86 #   if !defined(_WIN32_WCE) && !defined(_WIN32_WINNT)
87        /*
88         * Defining _WIN32_WINNT here in e_os.h implies certain "discipline."
89         * Most notably we ought to check for availability of each specific
90         * routine that was introduced after denoted _WIN32_WINNT with
91         * GetProcAddress(). Normally newer functions are masked with higher
92         * _WIN32_WINNT in SDK headers. So that if you wish to use them in
93         * some module, you'd need to override _WIN32_WINNT definition in
94         * the target module in order to "reach for" prototypes, but replace
95         * calls to new functions with indirect calls. Alternatively it
96         * might be possible to achieve the goal by /DELAYLOAD-ing .DLLs
97         * and check for current OS version instead.
98         */
99 #    define _WIN32_WINNT 0x0501
100 #   endif
101 #   if defined(_WIN32_WINNT) || defined(_WIN32_WCE)
102        /*
103         * Just like defining _WIN32_WINNT including winsock2.h implies
104         * certain "discipline" for maintaining [broad] binary compatibility.
105         * As long as structures are invariant among Winsock versions,
106         * it's sufficient to check for specific Winsock2 API availability
107         * at run-time [DSO_global_lookup is recommended]...
108         */
109 #    include <winsock2.h>
110 #    include <ws2tcpip.h>
111        /* yes, they have to be #included prior to <windows.h> */
112 #   endif
113 #   include <windows.h>
114 #   include <stdio.h>
115 #   include <stddef.h>
116 #   include <errno.h>
117 #   if defined(_WIN32_WCE) && !defined(EACCES)
118 #    define EACCES   13
119 #   endif
120 #   include <string.h>
121 #   ifdef _WIN64
122 #    define strlen(s) _strlen31(s)
123 /* cut strings to 2GB */
124 static __inline unsigned int _strlen31(const char *str)
125 {
126     unsigned int len = 0;
127     while (*str && len < 0x80000000U)
128         str++, len++;
129     return len & 0x7FFFFFFF;
130 }
131 #   endif
132 #   include <malloc.h>
133 #   if defined(_MSC_VER) && !defined(_WIN32_WCE) && !defined(_DLL) && defined(stdin)
134 #    if _MSC_VER>=1300 && _MSC_VER<1600
135 #     undef stdin
136 #     undef stdout
137 #     undef stderr
138 FILE *__iob_func();
139 #     define stdin  (&__iob_func()[0])
140 #     define stdout (&__iob_func()[1])
141 #     define stderr (&__iob_func()[2])
142 #    elif _MSC_VER<1300 && defined(I_CAN_LIVE_WITH_LNK4049)
143 #     undef stdin
144 #     undef stdout
145 #     undef stderr
146          /*
147           * pre-1300 has __p__iob(), but it's available only in msvcrt.lib,
148           * or in other words with /MD. Declaring implicit import, i.e. with
149           * _imp_ prefix, works correctly with all compiler options, but
150           * without /MD results in LINK warning LNK4049: 'locally defined
151           * symbol "__iob" imported'.
152           */
153 extern FILE *_imp___iob;
154 #     define stdin  (&_imp___iob[0])
155 #     define stdout (&_imp___iob[1])
156 #     define stderr (&_imp___iob[2])
157 #    endif
158 #   endif
159 #  endif
160 #  include <io.h>
161 #  include <fcntl.h>
162
163 #  ifdef OPENSSL_SYS_WINCE
164 #   define OPENSSL_NO_POSIX_IO
165 #  endif
166
167 #  define EXIT(n) exit(n)
168 #  define LIST_SEPARATOR_CHAR ';'
169 #  ifndef W_OK
170 #   define W_OK        2
171 #  endif
172 #  ifndef R_OK
173 #   define R_OK        4
174 #  endif
175 #  ifdef OPENSSL_SYS_WINCE
176 #   define DEFAULT_HOME  ""
177 #  else
178 #   define DEFAULT_HOME  "C:"
179 #  endif
180
181 /* Avoid Visual Studio 13 GetVersion deprecated problems */
182 #  if defined(_MSC_VER) && _MSC_VER>=1800
183 #   define check_winnt() (1)
184 #   define check_win_minplat(x) (1)
185 #  else
186 #   define check_winnt() (GetVersion() < 0x80000000)
187 #   define check_win_minplat(x) (LOBYTE(LOWORD(GetVersion())) >= (x))
188 #  endif
189
190 # else                          /* The non-microsoft world */
191
192 #  if defined(OPENSSL_SYS_VXWORKS)
193 #   include <time.h>
194 #  else
195 #   include <sys/time.h>
196 #  endif
197
198 #  ifdef OPENSSL_SYS_VMS
199 #   define VMS 1
200   /*
201    * some programs don't include stdlib, so exit() and others give implicit
202    * function warnings
203    */
204 #   include <stdlib.h>
205 #   if defined(__DECC)
206 #    include <unistd.h>
207 #   else
208 #    include <unixlib.h>
209 #   endif
210 #   define LIST_SEPARATOR_CHAR ','
211   /* We don't have any well-defined random devices on VMS, yet... */
212 #   undef DEVRANDOM
213   /*-
214      We need to do this since VMS has the following coding on status codes:
215
216      Bits 0-2: status type: 0 = warning, 1 = success, 2 = error, 3 = info ...
217                The important thing to know is that odd numbers are considered
218                good, while even ones are considered errors.
219      Bits 3-15: actual status number
220      Bits 16-27: facility number.  0 is considered "unknown"
221      Bits 28-31: control bits.  If bit 28 is set, the shell won't try to
222                  output the message (which, for random codes, just looks ugly)
223
224      So, what we do here is to change 0 to 1 to get the default success status,
225      and everything else is shifted up to fit into the status number field, and
226      the status is tagged as an error, which is what is wanted here.
227
228      Finally, we add the VMS C facility code 0x35a000, because there are some
229      programs, such as Perl, that will reinterpret the code back to something
230      POSIX.  'man perlvms' explains it further.
231
232      NOTE: the perlvms manual wants to turn all codes 2 to 255 into success
233      codes (status type = 1).  I couldn't disagree more.  Fortunately, the
234      status type doesn't seem to bother Perl.
235      -- Richard Levitte
236   */
237 #   define EXIT(n)  exit((n) ? (((n) << 3) | 2 | 0x10000000 | 0x35a000) : 1)
238
239 #   define DEFAULT_HOME "SYS$LOGIN:"
240
241 #  else
242      /* !defined VMS */
243 #   include <unistd.h>
244 #   include <sys/types.h>
245 #   ifdef OPENSSL_SYS_WIN32_CYGWIN
246 #    include <io.h>
247 #    include <fcntl.h>
248 #   endif
249
250 #   define LIST_SEPARATOR_CHAR ':'
251 #   define EXIT(n)             exit(n)
252 #  endif
253
254 # endif
255
256 /***********************************************/
257
258 # if defined(OPENSSL_SYS_WINDOWS)
259 #  define strcasecmp _stricmp
260 #  define strncasecmp _strnicmp
261 #  if (_MSC_VER >= 1310) && !defined(_WIN32_WCE)
262 #   define open _open
263 #   define fdopen _fdopen
264 #   define close _close
265 #   ifndef strdup
266 #    define strdup _strdup
267 #   endif
268 #   define unlink _unlink
269 #   define fileno _fileno
270 #  endif
271 # else
272 #  include <strings.h>
273 # endif
274
275 /* vxworks */
276 # if defined(OPENSSL_SYS_VXWORKS)
277 #  include <ioLib.h>
278 #  include <tickLib.h>
279 #  include <sysLib.h>
280 #  include <vxWorks.h>
281 #  include <sockLib.h>
282 #  include <taskLib.h>
283
284 #  define TTY_STRUCT int
285 #  define sleep(a) taskDelay((a) * sysClkRateGet())
286
287 /*
288  * NOTE: these are implemented by helpers in database app! if the database is
289  * not linked, we need to implement them elsewhere
290  */
291 struct hostent *gethostbyname(const char *name);
292 struct hostent *gethostbyaddr(const char *addr, int length, int type);
293 struct servent *getservbyname(const char *name, const char *proto);
294
295 # endif
296 /* end vxworks */
297
298 # ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
299 #  define CRYPTO_memcmp memcmp
300 # endif
301
302 # ifndef OPENSSL_NO_SECURE_MEMORY
303    /* unistd.h defines _POSIX_VERSION */
304 #  if defined(OPENSSL_SYS_UNIX) \
305       && ( (defined(_POSIX_VERSION) && _POSIX_VERSION >= 200112L)      \
306            || defined(__sun) || defined(__hpux) || defined(__sgi)      \
307            || defined(__osf__) )
308       /* secure memory is implemented */
309 #   else
310 #     define OPENSSL_NO_SECURE_MEMORY
311 #   endif
312 # endif
313
314 #endif