Make {RSA,DSA,DH}_new_method obtain and release an ENGINE
[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)
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 #else
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)       read((s),(b),(n))
169 #define writesocket(s,b,n)      write((s),(b),(n))
170 #endif
171
172 #ifdef WIN16
173 #  define OPENSSL_NO_FP_API
174 #  define MS_CALLBACK   _far _loadds
175 #  define MS_FAR        _far
176 #else
177 #  define MS_CALLBACK
178 #  define MS_FAR
179 #endif
180
181 #ifdef OPENSSL_NO_STDIO
182 #  define OPENSSL_NO_FP_API
183 #endif
184
185 #if (defined(WINDOWS) || defined(MSDOS))
186
187 #  ifndef S_IFDIR
188 #    define S_IFDIR     _S_IFDIR
189 #  endif
190
191 #  ifndef S_IFMT
192 #    define S_IFMT      _S_IFMT
193 #  endif
194
195 #  if !defined(WINNT)
196 #    define NO_SYSLOG
197 #  endif
198 #  define NO_DIRENT
199
200 #  ifdef WINDOWS
201 #    include <windows.h>
202 #    include <stddef.h>
203 #    include <errno.h>
204 #    include <string.h>
205 #    include <malloc.h>
206 #  endif
207 #  include <io.h>
208 #  include <fcntl.h>
209
210 #  define ssize_t long
211
212 #  if defined (__BORLANDC__)
213 #    define _setmode setmode
214 #    define _O_TEXT O_TEXT
215 #    define _O_BINARY O_BINARY
216 #    define _int64 __int64
217 #    define _kbhit kbhit
218 #  endif
219
220 #  if defined(WIN16) && !defined(MONOLITH) && defined(SSLEAY) && defined(_WINEXITNOPERSIST)
221 #    define EXIT(n) { if (n == 0) _wsetexit(_WINEXITNOPERSIST); return(n); }
222 #  else
223 #    define EXIT(n)             return(n);
224 #  endif
225 #  define LIST_SEPARATOR_CHAR ';'
226 #  ifndef X_OK
227 #    define X_OK        0
228 #  endif
229 #  ifndef W_OK
230 #    define W_OK        2
231 #  endif
232 #  ifndef R_OK
233 #    define R_OK        4
234 #  endif
235 #  define OPENSSL_CONF  "openssl.cnf"
236 #  define SSLEAY_CONF   OPENSSL_CONF
237 #  define NUL_DEV       "nul"
238 #  define RFILE         ".rnd"
239 #  define DEFAULT_HOME  "C:"
240
241 #else /* The non-microsoft world world */
242
243 #  ifdef OPENSSL_SYS_VMS
244 #    define VMS 1
245   /* some programs don't include stdlib, so exit() and others give implicit 
246      function warnings */
247 #    include <stdlib.h>
248 #    if defined(__DECC)
249 #      include <unistd.h>
250 #    else
251 #      include <unixlib.h>
252 #    endif
253 #    define OPENSSL_CONF        "openssl.cnf"
254 #    define SSLEAY_CONF         OPENSSL_CONF
255 #    define RFILE               ".rnd"
256 #    define LIST_SEPARATOR_CHAR ','
257 #    define NUL_DEV             "NLA0:"
258   /* We don't have any well-defined random devices on VMS, yet... */
259 #    undef DEVRANDOM
260   /* We need to do this since VMS has the following coding on status codes:
261
262      Bits 0-2: status type: 0 = warning, 1 = success, 2 = error, 3 = info ...
263                The important thing to know is that odd numbers are considered
264                good, while even ones are considered errors.
265      Bits 3-15: actual status number
266      Bits 16-27: facility number.  0 is considered "unknown"
267      Bits 28-31: control bits.  If bit 28 is set, the shell won't try to
268                  output the message (which, for random codes, just looks ugly)
269
270      So, what we do here is to change 0 to 1 to get the default success status,
271      and everything else is shifted up to fit into the status number field, and
272      the status is tagged as an error, which I believe is what is wanted here.
273      -- Richard Levitte
274   */
275 #    if !defined(MONOLITH) || defined(OPENSSL_C)
276 #      define EXIT(n)           do { int __VMS_EXIT = n; \
277                                      if (__VMS_EXIT == 0) \
278                                        __VMS_EXIT = 1; \
279                                      else \
280                                        __VMS_EXIT = (n << 3) | 2; \
281                                      __VMS_EXIT |= 0x10000000; \
282                                      exit(__VMS_EXIT); \
283                                      return(__VMS_EXIT); } while(0)
284 #    else
285 #      define EXIT(n)           return(n)
286 #    endif
287 #    define NO_SYS_PARAM_H
288 #  else
289      /* !defined VMS */
290 #    ifdef OPENSSL_SYS_MPE
291 #      define NO_SYS_PARAM_H
292 #    endif
293 #    ifdef OPENSSL_UNISTD
294 #      include OPENSSL_UNISTD
295 #    else
296 #      include <unistd.h>
297 #    endif
298 #    ifndef NO_SYS_TYPES_H
299 #      include <sys/types.h>
300 #    endif
301 #    if defined(NeXT) || defined(OPENSSL_SYS_NEWS4)
302 #      define pid_t int /* pid_t is missing on NEXTSTEP/OPENSTEP
303                          * (unless when compiling with -D_POSIX_SOURCE,
304                          * which doesn't work for us) */
305 #      define ssize_t int /* ditto */
306 #    endif
307 #    ifdef OPENSSL_SYS_NEWS4 /* setvbuf is missing on mips-sony-bsd */
308 #      define setvbuf(a, b, c, d) setbuffer((a), (b), (d))
309        typedef unsigned long clock_t;
310 #    endif
311
312 #    define OPENSSL_CONF        "openssl.cnf"
313 #    define SSLEAY_CONF         OPENSSL_CONF
314 #    define RFILE               ".rnd"
315 #    define LIST_SEPARATOR_CHAR ':'
316 #    define NUL_DEV             "/dev/null"
317 #    ifndef MONOLITH
318 #      define EXIT(n)           exit(n); return(n)
319 #    else
320 #      define EXIT(n)           return(n)
321 #    endif
322 #  endif
323
324 #  define SSLeay_getpid()       getpid()
325
326 #endif
327
328
329 /*************/
330
331 #ifdef USE_SOCKETS
332 #  if defined(WINDOWS) || defined(MSDOS)
333       /* windows world */
334
335 #    ifdef OPENSSL_NO_SOCK
336 #      define SSLeay_Write(a,b,c)       (-1)
337 #      define SSLeay_Read(a,b,c)        (-1)
338 #      define SHUTDOWN(fd)              close(fd)
339 #      define SHUTDOWN2(fd)             close(fd)
340 #    else
341 #      include <winsock.h>
342 extern HINSTANCE _hInstance;
343 #      define SSLeay_Write(a,b,c)       send((a),(b),(c),0)
344 #      define SSLeay_Read(a,b,c)        recv((a),(b),(c),0)
345 #      define SHUTDOWN(fd)              { shutdown((fd),0); closesocket(fd); }
346 #      define SHUTDOWN2(fd)             { shutdown((fd),2); closesocket(fd); }
347 #    endif
348
349 #  elif defined(MAC_OS_pre_X)
350
351 #    include "MacSocket.h"
352 #    define SSLeay_Write(a,b,c)         MacSocket_send((a),(b),(c))
353 #    define SSLeay_Read(a,b,c)          MacSocket_recv((a),(b),(c),true)
354 #    define SHUTDOWN(fd)                MacSocket_close(fd)
355 #    define SHUTDOWN2(fd)               MacSocket_close(fd)
356
357 #  else
358
359 #    ifndef NO_SYS_PARAM_H
360 #      include <sys/param.h>
361 #    endif
362 #    ifdef OPENSSL_SYS_VXWORKS
363 #      include <time.h> 
364 #    elif !defined(OPENSSL_SYS_MPE)
365 #      include <sys/time.h> /* Needed under linux for FD_XXX */
366 #    endif
367
368 #    include <netdb.h>
369 #    if defined(OPENSSL_SYS_VMS_NODECC)
370 #      include <socket.h>
371 #      include <in.h>
372 #      include <inet.h>
373 #    else
374 #      include <sys/socket.h>
375 #      ifdef FILIO_H
376 #        include <sys/filio.h> /* Added for FIONBIO under unixware */
377 #      endif
378 #      include <netinet/in.h>
379 #      include <arpa/inet.h>
380 #    endif
381
382 #    if defined(NeXT) || defined(_NEXT_SOURCE)
383 #      include <sys/fcntl.h>
384 #      include <sys/types.h>
385 #    endif
386
387 #    ifdef OPENSSL_SYS_AIX
388 #      include <sys/select.h>
389 #    endif
390
391 #    ifdef __QNX__
392 #      include <sys/select.h>
393 #    endif
394
395 #    if defined(sun)
396 #      include <sys/filio.h>
397 #    else
398 #      ifndef VMS
399 #        include <sys/ioctl.h>
400 #      else
401          /* ioctl is only in VMS > 7.0 and when socketshr is not used */
402 #        if !defined(TCPIP_TYPE_SOCKETSHR) && defined(__VMS_VER) && (__VMS_VER > 70000000)
403 #          include <sys/ioctl.h>
404 #        endif
405 #      endif
406 #    endif
407
408 #    ifdef VMS
409 #      include <unixio.h>
410 #      if defined(TCPIP_TYPE_SOCKETSHR)
411 #        include <socketshr.h>
412 #      endif
413 #    endif
414
415 #    define SSLeay_Read(a,b,c)     read((a),(b),(c))
416 #    define SSLeay_Write(a,b,c)    write((a),(b),(c))
417 #    define SHUTDOWN(fd)    { shutdown((fd),0); closesocket((fd)); }
418 #    define SHUTDOWN2(fd)   { shutdown((fd),2); closesocket((fd)); }
419 #    define INVALID_SOCKET      (-1)
420 #  endif
421 #endif
422
423 #if defined(__ultrix)
424 #  ifndef ssize_t
425 #    define ssize_t int 
426 #  endif
427 #endif
428
429 #if defined(sun) && !defined(__svr4__) && !defined(__SVR4)
430   /* include headers first, so our defines don't break it */
431 #include <stdlib.h>
432 #include <string.h>
433   /* bcopy can handle overlapping moves according to SunOS 4.1.4 manpage */
434 # define memmove(s1,s2,n) bcopy((s2),(s1),(n))
435 # define strtoul(s,e,b) ((unsigned long int)strtol((s),(e),(b)))
436 extern char *sys_errlist[]; extern int sys_nerr;
437 # define strerror(errnum) \
438         (((errnum)<0 || (errnum)>=sys_nerr) ? NULL : sys_errlist[errnum])
439 #endif
440
441 /***********************************************/
442
443 /* do we need to do this for getenv.
444  * Just define getenv for use under windows */
445
446 #ifdef WIN16
447 /* How to do this needs to be thought out a bit more.... */
448 /*char *GETENV(char *);
449 #define Getenv  GETENV*/
450 #define Getenv  getenv
451 #else
452 #define Getenv getenv
453 #endif
454
455 #define DG_GCC_BUG      /* gcc < 2.6.3 on DGUX */
456
457 #ifdef sgi
458 #define IRIX_CC_BUG     /* all version of IRIX I've tested (4.* 5.*) */
459 #endif
460 #ifdef OPENSSL_SYS_SNI
461 #define IRIX_CC_BUG     /* CDS++ up to V2.0Bsomething suffered from the same bug.*/
462 #endif
463
464 #if defined(OPENSSL_SYS_OS2) && defined(__EMX__)
465 # include <io.h>
466 # include <fcntl.h>
467 # define NO_SYSLOG
468 # define strcasecmp stricmp
469 #endif
470
471 #ifdef  __cplusplus
472 }
473 #endif
474
475 #endif
476