Security fixes brought forward from 0.9.7.
[openssl.git] / e_os.h
1 /* e_os.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #ifndef HEADER_E_OS_H
60 #define HEADER_E_OS_H
61
62 #include <openssl/opensslconf.h>
63
64 #include <openssl/e_os2.h>
65 /* <openssl/e_os2.h> contains what we can justify to make visible
66  * to the outside; this file e_os.h is not part of the exported
67  * interface. */
68
69 #ifdef  __cplusplus
70 extern "C" {
71 #endif
72
73 /* Used to checking reference counts, most while doing perl5 stuff :-) */
74 #ifdef REF_PRINT
75 #undef REF_PRINT
76 #define REF_PRINT(a,b)  fprintf(stderr,"%08X:%4d:%s\n",(int)b,b->references,a)
77 #endif
78
79 #ifndef DEVRANDOM
80 /* set this to a comma-separated list of 'random' device files to try out.
81  * My default, we will try to read at least one of these files */
82 #define DEVRANDOM "/dev/urandom","/dev/random","/dev/srandom"
83 #endif
84 #ifndef DEVRANDOM_EGD
85 /* set this to a comma-seperated list of 'egd' sockets to try out. These
86  * sockets will be tried in the order listed in case accessing the device files
87  * listed in DEVRANDOM did not return enough entropy. */
88 #define DEVRANDOM_EGD "/var/run/egd-pool","/dev/egd-pool","/etc/egd-pool","/etc/entropy"
89 #endif
90
91 #if defined(OPENSSL_SYS_VXWORKS)
92 #  define NO_SYS_PARAM_H
93 #  define NO_CHMOD
94 #  define NO_SYSLOG
95 #endif
96   
97 #if defined(OPENSSL_SYS_MACINTOSH_CLASSIC)
98 # if macintosh==1
99 #  ifndef MAC_OS_GUSI_SOURCE
100 #    define MAC_OS_pre_X
101 #    define NO_SYS_TYPES_H
102      typedef long ssize_t;
103 #  endif
104 #  define NO_SYS_PARAM_H
105 #  define NO_CHMOD
106 #  define NO_SYSLOG
107 #  undef  DEVRANDOM
108 #  define GETPID_IS_MEANINGLESS
109 # endif
110 #endif
111
112 /********************************************************************
113  The Microsoft section
114  ********************************************************************/
115 /* The following is used becaue of the small stack in some
116  * Microsoft operating systems */
117 #if defined(OPENSSL_SYS_MSDOS) && !defined(OPENSSL_SYSNAME_WIN32)
118 #  define MS_STATIC     static
119 #else
120 #  define MS_STATIC
121 #endif
122
123 #if defined(OPENSSL_SYS_WIN32) && !defined(WIN32)
124 #  define WIN32
125 #endif
126 #if defined(OPENSSL_SYS_WIN16) && !defined(WIN16)
127 #  define WIN16
128 #endif
129 #if defined(OPENSSL_SYS_WINDOWS) && !defined(WINDOWS)
130 #  define WINDOWS
131 #endif
132 #if defined(OPENSSL_SYS_MSDOS) && !defined(MSDOS)
133 #  define MSDOS
134 #endif
135
136 #if defined(MSDOS) && !defined(GETPID_IS_MEANINGLESS)
137 #  define GETPID_IS_MEANINGLESS
138 #endif
139
140 #ifdef WIN32
141 #define get_last_sys_error()    GetLastError()
142 #define clear_sys_error()       SetLastError(0)
143 #if !defined(WINNT)
144 #define WIN_CONSOLE_BUG
145 #endif
146 #else
147 #define get_last_sys_error()    errno
148 #define clear_sys_error()       errno=0
149 #endif
150
151 #if defined(WINDOWS)
152 #define get_last_socket_error() WSAGetLastError()
153 #define clear_socket_error()    WSASetLastError(0)
154 #define readsocket(s,b,n)       recv((s),(b),(n),0)
155 #define writesocket(s,b,n)      send((s),(b),(n),0)
156 #define EADDRINUSE              WSAEADDRINUSE
157 #elif defined(MAC_OS_pre_X)
158 #define get_last_socket_error() errno
159 #define clear_socket_error()    errno=0
160 #define closesocket(s)          MacSocket_close(s)
161 #define readsocket(s,b,n)       MacSocket_recv((s),(b),(n),true)
162 #define writesocket(s,b,n)      MacSocket_send((s),(b),(n))
163 #elif defined(OPENSSL_SYS_VMS)
164 #define get_last_socket_error() errno
165 #define clear_socket_error()    errno=0
166 #define ioctlsocket(a,b,c)      ioctl(a,b,c)
167 #define closesocket(s)          close(s)
168 #define readsocket(s,b,n)       recv((s),(b),(n),0)
169 #define writesocket(s,b,n)      send((s),(b),(n),0)
170 #else
171 #define get_last_socket_error() errno
172 #define clear_socket_error()    errno=0
173 #define ioctlsocket(a,b,c)      ioctl(a,b,c)
174 #define closesocket(s)          close(s)
175 #define readsocket(s,b,n)       read((s),(b),(n))
176 #define writesocket(s,b,n)      write((s),(b),(n))
177 #endif
178
179 #ifdef WIN16
180 #  define OPENSSL_NO_FP_API
181 #  define MS_CALLBACK   _far _loadds
182 #  define MS_FAR        _far
183 #else
184 #  define MS_CALLBACK
185 #  define MS_FAR
186 #endif
187
188 #ifdef OPENSSL_NO_STDIO
189 #  define OPENSSL_NO_FP_API
190 #endif
191
192 #if (defined(WINDOWS) || defined(MSDOS))
193
194 #  ifdef __DJGPP__
195 #    include <unistd.h>
196 #    include <sys/stat.h>
197 #    define _setmode setmode
198 #    define _O_TEXT O_TEXT
199 #    define _O_BINARY O_BINARY
200 #  endif /* __DJGPP__ */
201
202 #  ifndef S_IFDIR
203 #    define S_IFDIR     _S_IFDIR
204 #  endif
205
206 #  ifndef S_IFMT
207 #    define S_IFMT      _S_IFMT
208 #  endif
209
210 #  if !defined(WINNT)
211 #    define NO_SYSLOG
212 #  endif
213 #  define NO_DIRENT
214
215 #  ifdef WINDOWS
216 #    include <windows.h>
217 #    include <stddef.h>
218 #    include <errno.h>
219 #    include <string.h>
220 #    include <malloc.h>
221 #  endif
222 #  include <io.h>
223 #  include <fcntl.h>
224
225 #  define ssize_t long
226
227 #  if defined (__BORLANDC__)
228 #    define _setmode setmode
229 #    define _O_TEXT O_TEXT
230 #    define _O_BINARY O_BINARY
231 #    define _int64 __int64
232 #    define _kbhit kbhit
233 #  endif
234
235 #  if defined(WIN16) && !defined(MONOLITH) && defined(SSLEAY) && defined(_WINEXITNOPERSIST)
236 #    define EXIT(n) { if (n == 0) _wsetexit(_WINEXITNOPERSIST); return(n); }
237 #  else
238 #    define EXIT(n)             return(n);
239 #  endif
240 #  define LIST_SEPARATOR_CHAR ';'
241 #  ifndef X_OK
242 #    define X_OK        0
243 #  endif
244 #  ifndef W_OK
245 #    define W_OK        2
246 #  endif
247 #  ifndef R_OK
248 #    define R_OK        4
249 #  endif
250 #  define OPENSSL_CONF  "openssl.cnf"
251 #  define SSLEAY_CONF   OPENSSL_CONF
252 #  define NUL_DEV       "nul"
253 #  define RFILE         ".rnd"
254 #  define DEFAULT_HOME  "C:"
255
256 #else /* The non-microsoft world world */
257
258 #  ifdef OPENSSL_SYS_VMS
259 #    define VMS 1
260   /* some programs don't include stdlib, so exit() and others give implicit 
261      function warnings */
262 #    include <stdlib.h>
263 #    if defined(__DECC)
264 #      include <unistd.h>
265 #    else
266 #      include <unixlib.h>
267 #    endif
268 #    define OPENSSL_CONF        "openssl.cnf"
269 #    define SSLEAY_CONF         OPENSSL_CONF
270 #    define RFILE               ".rnd"
271 #    define LIST_SEPARATOR_CHAR ','
272 #    define NUL_DEV             "NLA0:"
273   /* We don't have any well-defined random devices on VMS, yet... */
274 #    undef DEVRANDOM
275   /* We need to do this since VMS has the following coding on status codes:
276
277      Bits 0-2: status type: 0 = warning, 1 = success, 2 = error, 3 = info ...
278                The important thing to know is that odd numbers are considered
279                good, while even ones are considered errors.
280      Bits 3-15: actual status number
281      Bits 16-27: facility number.  0 is considered "unknown"
282      Bits 28-31: control bits.  If bit 28 is set, the shell won't try to
283                  output the message (which, for random codes, just looks ugly)
284
285      So, what we do here is to change 0 to 1 to get the default success status,
286      and everything else is shifted up to fit into the status number field, and
287      the status is tagged as an error, which I believe is what is wanted here.
288      -- Richard Levitte
289   */
290 #    if !defined(MONOLITH) || defined(OPENSSL_C)
291 #      define EXIT(n)           do { int __VMS_EXIT = n; \
292                                      if (__VMS_EXIT == 0) \
293                                        __VMS_EXIT = 1; \
294                                      else \
295                                        __VMS_EXIT = (n << 3) | 2; \
296                                      __VMS_EXIT |= 0x10000000; \
297                                      exit(__VMS_EXIT); \
298                                      return(__VMS_EXIT); } while(0)
299 #    else
300 #      define EXIT(n)           return(n)
301 #    endif
302 #    define NO_SYS_PARAM_H
303 #  else
304      /* !defined VMS */
305 #    ifdef OPENSSL_SYS_MPE
306 #      define NO_SYS_PARAM_H
307 #    endif
308 #    ifdef OPENSSL_UNISTD
309 #      include OPENSSL_UNISTD
310 #    else
311 #      include <unistd.h>
312 #    endif
313 #    ifndef NO_SYS_TYPES_H
314 #      include <sys/types.h>
315 #    endif
316 #    if defined(NeXT) || defined(OPENSSL_SYS_NEWS4)
317 #      define pid_t int /* pid_t is missing on NEXTSTEP/OPENSTEP
318                          * (unless when compiling with -D_POSIX_SOURCE,
319                          * which doesn't work for us) */
320 #      define ssize_t int /* ditto */
321 #    endif
322 #    ifdef OPENSSL_SYS_NEWS4 /* setvbuf is missing on mips-sony-bsd */
323 #      define setvbuf(a, b, c, d) setbuffer((a), (b), (d))
324        typedef unsigned long clock_t;
325 #    endif
326
327 #    define OPENSSL_CONF        "openssl.cnf"
328 #    define SSLEAY_CONF         OPENSSL_CONF
329 #    define RFILE               ".rnd"
330 #    define LIST_SEPARATOR_CHAR ':'
331 #    define NUL_DEV             "/dev/null"
332 #    ifndef MONOLITH
333 #      define EXIT(n)           exit(n); return(n)
334 #    else
335 #      define EXIT(n)           return(n)
336 #    endif
337 #  endif
338
339 #  define SSLeay_getpid()       getpid()
340
341 #endif
342
343
344 /*************/
345
346 #ifdef USE_SOCKETS
347 #  if (defined(WINDOWS) || defined(MSDOS)) && !defined(__DJGPP__)
348       /* windows world */
349
350 #    ifdef OPENSSL_NO_SOCK
351 #      define SSLeay_Write(a,b,c)       (-1)
352 #      define SSLeay_Read(a,b,c)        (-1)
353 #      define SHUTDOWN(fd)              close(fd)
354 #      define SHUTDOWN2(fd)             close(fd)
355 #    else
356 #      include <winsock.h>
357 extern HINSTANCE _hInstance;
358 #      define SSLeay_Write(a,b,c)       send((a),(b),(c),0)
359 #      define SSLeay_Read(a,b,c)        recv((a),(b),(c),0)
360 #      define SHUTDOWN(fd)              { shutdown((fd),0); closesocket(fd); }
361 #      define SHUTDOWN2(fd)             { shutdown((fd),2); closesocket(fd); }
362 #    endif
363
364 #  elif defined(MAC_OS_pre_X)
365
366 #    include "MacSocket.h"
367 #    define SSLeay_Write(a,b,c)         MacSocket_send((a),(b),(c))
368 #    define SSLeay_Read(a,b,c)          MacSocket_recv((a),(b),(c),true)
369 #    define SHUTDOWN(fd)                MacSocket_close(fd)
370 #    define SHUTDOWN2(fd)               MacSocket_close(fd)
371
372 #  else
373
374 #    ifndef NO_SYS_PARAM_H
375 #      include <sys/param.h>
376 #    endif
377 #    ifdef OPENSSL_SYS_VXWORKS
378 #      include <time.h> 
379 #    elif !defined(OPENSSL_SYS_MPE)
380 #      include <sys/time.h> /* Needed under linux for FD_XXX */
381 #    endif
382
383 #    include <netdb.h>
384 #    if defined(OPENSSL_SYS_VMS_NODECC)
385 #      include <socket.h>
386 #      include <in.h>
387 #      include <inet.h>
388 #    else
389 #      include <sys/socket.h>
390 #      ifdef FILIO_H
391 #        include <sys/filio.h> /* Added for FIONBIO under unixware */
392 #      endif
393 #      include <netinet/in.h>
394 #      include <arpa/inet.h>
395 #    endif
396
397 #    if defined(NeXT) || defined(_NEXT_SOURCE)
398 #      include <sys/fcntl.h>
399 #      include <sys/types.h>
400 #    endif
401
402 #    ifdef OPENSSL_SYS_AIX
403 #      include <sys/select.h>
404 #    endif
405
406 #    ifdef __QNX__
407 #      include <sys/select.h>
408 #    endif
409
410 #    if defined(sun)
411 #      include <sys/filio.h>
412 #    else
413 #      ifndef VMS
414 #        include <sys/ioctl.h>
415 #      else
416          /* ioctl is only in VMS > 7.0 and when socketshr is not used */
417 #        if !defined(TCPIP_TYPE_SOCKETSHR) && defined(__VMS_VER) && (__VMS_VER > 70000000)
418 #          include <sys/ioctl.h>
419 #        endif
420 #      endif
421 #    endif
422
423 #    ifdef VMS
424 #      include <unixio.h>
425 #      if defined(TCPIP_TYPE_SOCKETSHR)
426 #        include <socketshr.h>
427 #      endif
428 #    endif
429
430 #    define SSLeay_Read(a,b,c)     read((a),(b),(c))
431 #    define SSLeay_Write(a,b,c)    write((a),(b),(c))
432 #    define SHUTDOWN(fd)    { shutdown((fd),0); closesocket((fd)); }
433 #    define SHUTDOWN2(fd)   { shutdown((fd),2); closesocket((fd)); }
434 #    ifndef INVALID_SOCKET
435 #    define INVALID_SOCKET      (-1)
436 #    endif /* INVALID_SOCKET */
437 #  endif
438 #endif
439
440 #if defined(__ultrix)
441 #  ifndef ssize_t
442 #    define ssize_t int 
443 #  endif
444 #endif
445
446 #if defined(sun) && !defined(__svr4__) && !defined(__SVR4)
447   /* include headers first, so our defines don't break it */
448 #include <stdlib.h>
449 #include <string.h>
450   /* bcopy can handle overlapping moves according to SunOS 4.1.4 manpage */
451 # define memmove(s1,s2,n) bcopy((s2),(s1),(n))
452 # define strtoul(s,e,b) ((unsigned long int)strtol((s),(e),(b)))
453 extern char *sys_errlist[]; extern int sys_nerr;
454 # define strerror(errnum) \
455         (((errnum)<0 || (errnum)>=sys_nerr) ? NULL : sys_errlist[errnum])
456 #endif
457
458 /***********************************************/
459
460 /* do we need to do this for getenv.
461  * Just define getenv for use under windows */
462
463 #ifdef WIN16
464 /* How to do this needs to be thought out a bit more.... */
465 /*char *GETENV(char *);
466 #define Getenv  GETENV*/
467 #define Getenv  getenv
468 #else
469 #define Getenv getenv
470 #endif
471
472 #define DG_GCC_BUG      /* gcc < 2.6.3 on DGUX */
473
474 #ifdef sgi
475 #define IRIX_CC_BUG     /* all version of IRIX I've tested (4.* 5.*) */
476 #endif
477 #ifdef OPENSSL_SYS_SNI
478 #define IRIX_CC_BUG     /* CDS++ up to V2.0Bsomething suffered from the same bug.*/
479 #endif
480
481 #if defined(OPENSSL_SYS_OS2) && defined(__EMX__)
482 # include <io.h>
483 # include <fcntl.h>
484 # define NO_SYSLOG
485 # define strcasecmp stricmp
486 #endif
487
488 /* vxworks */
489 #if defined(OPENSSL_SYS_VXWORKS)
490 #include <ioLib.h>
491 #include <tickLib.h>
492 #include <sysLib.h>
493
494 #define TTY_STRUCT int
495
496 #define sleep(a) taskDelay((a) * sysClkRateGet())
497 #if defined(ioctlsocket)
498 #undef ioctlsocket
499 #endif
500 #define ioctlsocket(a,b,c) ioctl((a),(b),*(c))
501
502 #include <vxWorks.h>
503 #include <sockLib.h>
504 #include <taskLib.h>
505
506 #define getpid taskIdSelf
507
508 /* NOTE: these are implemented by helpers in database app!
509  * if the database is not linked, we need to implement them
510  * elswhere */
511 struct hostent *gethostbyname(const char *name);
512 struct hostent *gethostbyaddr(const char *addr, int length, int type);
513 struct servent *getservbyname(const char *name, const char *proto);
514
515 #endif
516 /* end vxworks */
517
518 #ifdef  __cplusplus
519 }
520 #endif
521
522 #endif
523