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