defines.h revision 128456
1/*
2 * Copyright (c) 1999-2003 Damien Miller.  All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 */
24
25#ifndef _DEFINES_H
26#define _DEFINES_H
27
28/* $Id: defines.h,v 1.115 2004/04/14 07:24:30 dtucker Exp $ */
29
30
31/* Constants */
32
33#ifndef SHUT_RDWR
34enum
35{
36  SHUT_RD = 0,		/* No more receptions.  */
37  SHUT_WR,			/* No more transmissions.  */
38  SHUT_RDWR			/* No more receptions or transmissions.  */
39};
40# define SHUT_RD   SHUT_RD
41# define SHUT_WR   SHUT_WR
42# define SHUT_RDWR SHUT_RDWR
43#endif
44
45#ifndef IPTOS_LOWDELAY
46# define IPTOS_LOWDELAY          0x10
47# define IPTOS_THROUGHPUT        0x08
48# define IPTOS_RELIABILITY       0x04
49# define IPTOS_LOWCOST           0x02
50# define IPTOS_MINCOST           IPTOS_LOWCOST
51#endif /* IPTOS_LOWDELAY */
52
53#ifndef MAXPATHLEN
54# ifdef PATH_MAX
55#  define MAXPATHLEN PATH_MAX
56# else /* PATH_MAX */
57#  define MAXPATHLEN 64 /* Should be safe */
58# endif /* PATH_MAX */
59#endif /* MAXPATHLEN */
60
61#ifndef STDIN_FILENO
62# define STDIN_FILENO    0
63#endif
64#ifndef STDOUT_FILENO
65# define STDOUT_FILENO   1
66#endif
67#ifndef STDERR_FILENO
68# define STDERR_FILENO   2
69#endif
70
71#ifndef NGROUPS_MAX	/* Disable groupaccess if NGROUP_MAX is not set */
72#ifdef NGROUPS
73#define NGROUPS_MAX NGROUPS
74#else
75#define NGROUPS_MAX 0
76#endif
77#endif
78
79#ifndef O_NONBLOCK	/* Non Blocking Open */
80# define O_NONBLOCK      00004
81#endif
82
83#ifndef S_ISDIR
84# define S_ISDIR(mode)	(((mode) & (_S_IFMT)) == (_S_IFDIR))
85#endif /* S_ISDIR */
86
87#ifndef S_ISREG
88# define S_ISREG(mode)	(((mode) & (_S_IFMT)) == (_S_IFREG))
89#endif /* S_ISREG */
90
91#ifndef S_ISLNK
92# define S_ISLNK(mode)	(((mode) & S_IFMT) == S_IFLNK)
93#endif /* S_ISLNK */
94
95#ifndef S_IXUSR
96# define S_IXUSR			0000100	/* execute/search permission, */
97# define S_IXGRP			0000010	/* execute/search permission, */
98# define S_IXOTH			0000001	/* execute/search permission, */
99# define _S_IWUSR			0000200	/* write permission, */
100# define S_IWUSR			_S_IWUSR	/* write permission, owner */
101# define S_IWGRP			0000020	/* write permission, group */
102# define S_IWOTH			0000002	/* write permission, other */
103# define S_IRUSR			0000400	/* read permission, owner */
104# define S_IRGRP			0000040	/* read permission, group */
105# define S_IROTH			0000004	/* read permission, other */
106# define S_IRWXU			0000700	/* read, write, execute */
107# define S_IRWXG			0000070	/* read, write, execute */
108# define S_IRWXO			0000007	/* read, write, execute */
109#endif /* S_IXUSR */
110
111#if !defined(MAP_ANON) && defined(MAP_ANONYMOUS)
112#define MAP_ANON MAP_ANONYMOUS
113#endif
114
115#ifndef MAP_FAILED
116# define MAP_FAILED ((void *)-1)
117#endif
118
119/* *-*-nto-qnx doesn't define this constant in the system headers */
120#ifdef MISSING_NFDBITS
121# define	NFDBITS (8 * sizeof(unsigned long))
122#endif
123
124/*
125SCO Open Server 3 has INADDR_LOOPBACK defined in rpc/rpc.h but
126including rpc/rpc.h breaks Solaris 6
127*/
128#ifndef INADDR_LOOPBACK
129#define INADDR_LOOPBACK ((u_long)0x7f000001)
130#endif
131
132#ifndef __unused
133#define __unused
134#endif
135
136/* Types */
137
138/* If sys/types.h does not supply intXX_t, supply them ourselves */
139/* (or die trying) */
140
141
142#ifndef HAVE_U_INT
143typedef unsigned int u_int;
144#endif
145
146#ifndef HAVE_INTXX_T
147# if (SIZEOF_CHAR == 1)
148typedef char int8_t;
149# else
150#  error "8 bit int type not found."
151# endif
152# if (SIZEOF_SHORT_INT == 2)
153typedef short int int16_t;
154# else
155#  ifdef _UNICOS
156#   if (SIZEOF_SHORT_INT == 4)
157typedef short int16_t;
158#   else
159typedef long  int16_t;
160#   endif
161#  else
162#   error "16 bit int type not found."
163#  endif /* _UNICOS */
164# endif
165# if (SIZEOF_INT == 4)
166typedef int int32_t;
167# else
168#  ifdef _UNICOS
169typedef long  int32_t;
170#  else
171#   error "32 bit int type not found."
172#  endif /* _UNICOS */
173# endif
174#endif
175
176/* If sys/types.h does not supply u_intXX_t, supply them ourselves */
177#ifndef HAVE_U_INTXX_T
178# ifdef HAVE_UINTXX_T
179typedef uint8_t u_int8_t;
180typedef uint16_t u_int16_t;
181typedef uint32_t u_int32_t;
182# define HAVE_U_INTXX_T 1
183# else
184#  if (SIZEOF_CHAR == 1)
185typedef unsigned char u_int8_t;
186#  else
187#   error "8 bit int type not found."
188#  endif
189#  if (SIZEOF_SHORT_INT == 2)
190typedef unsigned short int u_int16_t;
191#  else
192#   ifdef _UNICOS
193#    if (SIZEOF_SHORT_INT == 4)
194typedef unsigned short u_int16_t;
195#    else
196typedef unsigned long  u_int16_t;
197#    endif
198#   else
199#    error "16 bit int type not found."
200#   endif
201#  endif
202#  if (SIZEOF_INT == 4)
203typedef unsigned int u_int32_t;
204#  else
205#   ifdef _UNICOS
206typedef unsigned long  u_int32_t;
207#   else
208#    error "32 bit int type not found."
209#   endif
210#  endif
211# endif
212#define __BIT_TYPES_DEFINED__
213#endif
214
215/* 64-bit types */
216#ifndef HAVE_INT64_T
217# if (SIZEOF_LONG_INT == 8)
218typedef long int int64_t;
219# else
220#  if (SIZEOF_LONG_LONG_INT == 8)
221typedef long long int int64_t;
222#  endif
223# endif
224#endif
225#ifndef HAVE_U_INT64_T
226# if (SIZEOF_LONG_INT == 8)
227typedef unsigned long int u_int64_t;
228# else
229#  if (SIZEOF_LONG_LONG_INT == 8)
230typedef unsigned long long int u_int64_t;
231#  endif
232# endif
233#endif
234
235#ifndef HAVE_U_CHAR
236typedef unsigned char u_char;
237# define HAVE_U_CHAR
238#endif /* HAVE_U_CHAR */
239
240#ifndef SIZE_T_MAX
241#define SIZE_T_MAX ULONG_MAX
242#endif /* SIZE_T_MAX */
243
244#ifndef HAVE_SIZE_T
245typedef unsigned int size_t;
246# define HAVE_SIZE_T
247# define SIZE_T_MAX UINT_MAX
248#endif /* HAVE_SIZE_T */
249
250#ifndef HAVE_SSIZE_T
251typedef int ssize_t;
252# define HAVE_SSIZE_T
253#endif /* HAVE_SSIZE_T */
254
255#ifndef HAVE_CLOCK_T
256typedef long clock_t;
257# define HAVE_CLOCK_T
258#endif /* HAVE_CLOCK_T */
259
260#ifndef HAVE_SA_FAMILY_T
261typedef int sa_family_t;
262# define HAVE_SA_FAMILY_T
263#endif /* HAVE_SA_FAMILY_T */
264
265#ifndef HAVE_PID_T
266typedef int pid_t;
267# define HAVE_PID_T
268#endif /* HAVE_PID_T */
269
270#ifndef HAVE_SIG_ATOMIC_T
271typedef int sig_atomic_t;
272# define HAVE_SIG_ATOMIC_T
273#endif /* HAVE_SIG_ATOMIC_T */
274
275#ifndef HAVE_MODE_T
276typedef int mode_t;
277# define HAVE_MODE_T
278#endif /* HAVE_MODE_T */
279
280#if !defined(HAVE_SS_FAMILY_IN_SS) && defined(HAVE___SS_FAMILY_IN_SS)
281# define ss_family __ss_family
282#endif /* !defined(HAVE_SS_FAMILY_IN_SS) && defined(HAVE_SA_FAMILY_IN_SS) */
283
284#ifndef HAVE_SYS_UN_H
285struct	sockaddr_un {
286	short	sun_family;		/* AF_UNIX */
287	char	sun_path[108];		/* path name (gag) */
288};
289#endif /* HAVE_SYS_UN_H */
290
291#if defined(BROKEN_SYS_TERMIO_H) && !defined(_STRUCT_WINSIZE)
292#define _STRUCT_WINSIZE
293struct winsize {
294      unsigned short ws_row;          /* rows, in characters */
295      unsigned short ws_col;          /* columns, in character */
296      unsigned short ws_xpixel;       /* horizontal size, pixels */
297      unsigned short ws_ypixel;       /* vertical size, pixels */
298};
299#endif
300
301/* *-*-nto-qnx does not define this type in the system headers */
302#ifdef MISSING_FD_MASK
303 typedef unsigned long int	fd_mask;
304#endif
305
306/* Paths */
307
308#ifndef _PATH_BSHELL
309# define _PATH_BSHELL "/bin/sh"
310#endif
311#ifndef _PATH_CSHELL
312# define _PATH_CSHELL "/bin/csh"
313#endif
314#ifndef _PATH_SHELLS
315# define _PATH_SHELLS "/etc/shells"
316#endif
317
318#ifdef USER_PATH
319# ifdef _PATH_STDPATH
320#  undef _PATH_STDPATH
321# endif
322# define _PATH_STDPATH USER_PATH
323#endif
324
325#ifndef _PATH_STDPATH
326# define _PATH_STDPATH "/usr/bin:/bin:/usr/sbin:/sbin"
327#endif
328
329#ifndef SUPERUSER_PATH
330# define SUPERUSER_PATH	_PATH_STDPATH
331#endif
332
333#ifndef _PATH_DEVNULL
334# define _PATH_DEVNULL "/dev/null"
335#endif
336
337#ifndef MAIL_DIRECTORY
338# define MAIL_DIRECTORY "/var/spool/mail"
339#endif
340
341#ifndef MAILDIR
342# define MAILDIR MAIL_DIRECTORY
343#endif
344
345#if !defined(_PATH_MAILDIR) && defined(MAILDIR)
346# define _PATH_MAILDIR MAILDIR
347#endif /* !defined(_PATH_MAILDIR) && defined(MAILDIR) */
348
349#ifndef _PATH_NOLOGIN
350# define _PATH_NOLOGIN "/etc/nologin"
351#endif
352
353/* Define this to be the path of the xauth program. */
354#ifdef XAUTH_PATH
355#define _PATH_XAUTH XAUTH_PATH
356#endif /* XAUTH_PATH */
357
358/* derived from XF4/xc/lib/dps/Xlibnet.h */
359#ifndef X_UNIX_PATH
360#  ifdef __hpux
361#    define X_UNIX_PATH "/var/spool/sockets/X11/%u"
362#  else
363#    define X_UNIX_PATH "/tmp/.X11-unix/X%u"
364#  endif
365#endif /* X_UNIX_PATH */
366#define _PATH_UNIX_X X_UNIX_PATH
367
368#ifndef _PATH_TTY
369# define _PATH_TTY "/dev/tty"
370#endif
371
372/* Macros */
373
374#if defined(HAVE_LOGIN_GETCAPBOOL) && defined(HAVE_LOGIN_CAP_H)
375# define HAVE_LOGIN_CAP
376#endif
377
378#ifndef MAX
379# define MAX(a,b) (((a)>(b))?(a):(b))
380# define MIN(a,b) (((a)<(b))?(a):(b))
381#endif
382
383#ifndef roundup
384# define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))
385#endif
386
387#ifndef timersub
388#define timersub(a, b, result)					\
389   do {								\
390      (result)->tv_sec = (a)->tv_sec - (b)->tv_sec;		\
391      (result)->tv_usec = (a)->tv_usec - (b)->tv_usec;		\
392      if ((result)->tv_usec < 0) {				\
393	 --(result)->tv_sec;					\
394	 (result)->tv_usec += 1000000;				\
395      }								\
396   } while (0)
397#endif
398
399#ifndef TIMEVAL_TO_TIMESPEC
400#define	TIMEVAL_TO_TIMESPEC(tv, ts) {					\
401	(ts)->tv_sec = (tv)->tv_sec;					\
402	(ts)->tv_nsec = (tv)->tv_usec * 1000;				\
403}
404#endif
405
406#ifndef TIMESPEC_TO_TIMEVAL
407#define	TIMESPEC_TO_TIMEVAL(tv, ts) {					\
408	(tv)->tv_sec = (ts)->tv_sec;					\
409	(tv)->tv_usec = (ts)->tv_nsec / 1000;				\
410}
411#endif
412
413#ifndef __P
414# define __P(x) x
415#endif
416
417#if !defined(IN6_IS_ADDR_V4MAPPED)
418# define IN6_IS_ADDR_V4MAPPED(a) \
419	((((u_int32_t *) (a))[0] == 0) && (((u_int32_t *) (a))[1] == 0) && \
420	 (((u_int32_t *) (a))[2] == htonl (0xffff)))
421#endif /* !defined(IN6_IS_ADDR_V4MAPPED) */
422
423#if !defined(__GNUC__) || (__GNUC__ < 2)
424# define __attribute__(x)
425#endif /* !defined(__GNUC__) || (__GNUC__ < 2) */
426
427/* *-*-nto-qnx doesn't define this macro in the system headers */
428#ifdef MISSING_HOWMANY
429# define howmany(x,y)	(((x)+((y)-1))/(y))
430#endif
431
432#ifndef OSSH_ALIGNBYTES
433#define OSSH_ALIGNBYTES	(sizeof(int) - 1)
434#endif
435#ifndef __CMSG_ALIGN
436#define	__CMSG_ALIGN(p) (((u_int)(p) + OSSH_ALIGNBYTES) &~ OSSH_ALIGNBYTES)
437#endif
438
439/* Length of the contents of a control message of length len */
440#ifndef CMSG_LEN
441#define	CMSG_LEN(len)	(__CMSG_ALIGN(sizeof(struct cmsghdr)) + (len))
442#endif
443
444/* Length of the space taken up by a padded control message of length len */
445#ifndef CMSG_SPACE
446#define	CMSG_SPACE(len)	(__CMSG_ALIGN(sizeof(struct cmsghdr)) + __CMSG_ALIGN(len))
447#endif
448
449/* given pointer to struct cmsghdr, return pointer to data */
450#ifndef CMSG_DATA
451#define CMSG_DATA(cmsg) ((u_char *)(cmsg) + __CMSG_ALIGN(sizeof(struct cmsghdr)))
452#endif /* CMSG_DATA */
453
454/*
455 * RFC 2292 requires to check msg_controllen, in case that the kernel returns
456 * an empty list for some reasons.
457 */
458#ifndef CMSG_FIRSTHDR
459#define CMSG_FIRSTHDR(mhdr) \
460	((mhdr)->msg_controllen >= sizeof(struct cmsghdr) ? \
461	 (struct cmsghdr *)(mhdr)->msg_control : \
462	 (struct cmsghdr *)NULL)
463#endif /* CMSG_FIRSTHDR */
464
465
466/* Function replacement / compatibility hacks */
467
468#if !defined(HAVE_GETADDRINFO) && (defined(HAVE_OGETADDRINFO) || defined(HAVE_NGETADDRINFO))
469# define HAVE_GETADDRINFO
470#endif
471
472#ifndef HAVE_GETOPT_OPTRESET
473# undef getopt
474# undef opterr
475# undef optind
476# undef optopt
477# undef optreset
478# undef optarg
479# define getopt(ac, av, o)  BSDgetopt(ac, av, o)
480# define opterr             BSDopterr
481# define optind             BSDoptind
482# define optopt             BSDoptopt
483# define optreset           BSDoptreset
484# define optarg             BSDoptarg
485#endif
486
487/* In older versions of libpam, pam_strerror takes a single argument */
488#ifdef HAVE_OLD_PAM
489# define PAM_STRERROR(a,b) pam_strerror((b))
490#else
491# define PAM_STRERROR(a,b) pam_strerror((a),(b))
492#endif
493
494#ifdef PAM_SUN_CODEBASE
495# define PAM_MSG_MEMBER(msg, n, member) ((*(msg))[(n)].member)
496#else
497# define PAM_MSG_MEMBER(msg, n, member) ((msg)[(n)]->member)
498#endif
499
500#if defined(BROKEN_GETADDRINFO) && defined(HAVE_GETADDRINFO)
501# undef HAVE_GETADDRINFO
502#endif
503#if defined(BROKEN_GETADDRINFO) && defined(HAVE_FREEADDRINFO)
504# undef HAVE_FREEADDRINFO
505#endif
506#if defined(BROKEN_GETADDRINFO) && defined(HAVE_GAI_STRERROR)
507# undef HAVE_GAI_STRERROR
508#endif
509
510#if defined(BROKEN_UPDWTMPX) && defined(HAVE_UPDWTMPX)
511# undef HAVE_UPDWTMPX
512#endif
513
514#if !defined(HAVE_MEMMOVE) && defined(HAVE_BCOPY)
515# define memmove(s1, s2, n) bcopy((s2), (s1), (n))
516#endif /* !defined(HAVE_MEMMOVE) && defined(HAVE_BCOPY) */
517
518#if defined(HAVE_VHANGUP) && !defined(HAVE_DEV_PTMX)
519#  define USE_VHANGUP
520#endif /* defined(HAVE_VHANGUP) && !defined(HAVE_DEV_PTMX) */
521
522#ifndef GETPGRP_VOID
523# define getpgrp() getpgrp(0)
524#endif
525
526/* OPENSSL_free() is Free() in versions before OpenSSL 0.9.6 */
527#if !defined(OPENSSL_VERSION_NUMBER) || (OPENSSL_VERSION_NUMBER < 0x0090600f)
528# define OPENSSL_free(x) Free(x)
529#endif
530
531#if !defined(HAVE___func__) && defined(HAVE___FUNCTION__)
532#  define __func__ __FUNCTION__
533#elif !defined(HAVE___func__)
534#  define __func__ ""
535#endif
536
537#if defined(KRB5) && !defined(HEIMDAL)
538#  define krb5_get_err_text(context,code) error_message(code)
539#endif
540
541#if defined(SKEYCHALLENGE_4ARG)
542# define _compat_skeychallenge(a,b,c,d) skeychallenge(a,b,c,d)
543#else
544# define _compat_skeychallenge(a,b,c,d) skeychallenge(a,b,c)
545#endif
546
547/* Maximum number of file descriptors available */
548#ifdef HAVE_SYSCONF
549# define SSH_SYSFDMAX sysconf(_SC_OPEN_MAX)
550#else
551# define SSH_SYSFDMAX 10000
552#endif
553
554
555/*
556 * Define this to use pipes instead of socketpairs for communicating with the
557 * client program.  Socketpairs do not seem to work on all systems.
558 *
559 * configure.ac sets this for a few OS's which are known to have problems
560 * but you may need to set it yourself
561 */
562/* #define USE_PIPES 1 */
563
564/**
565 ** login recorder definitions
566 **/
567
568/* FIXME: put default paths back in */
569#ifndef UTMP_FILE
570#  ifdef _PATH_UTMP
571#    define UTMP_FILE _PATH_UTMP
572#  else
573#    ifdef CONF_UTMP_FILE
574#      define UTMP_FILE CONF_UTMP_FILE
575#    endif
576#  endif
577#endif
578#ifndef WTMP_FILE
579#  ifdef _PATH_WTMP
580#    define WTMP_FILE _PATH_WTMP
581#  else
582#    ifdef CONF_WTMP_FILE
583#      define WTMP_FILE CONF_WTMP_FILE
584#    endif
585#  endif
586#endif
587/* pick up the user's location for lastlog if given */
588#ifndef LASTLOG_FILE
589#  ifdef _PATH_LASTLOG
590#    define LASTLOG_FILE _PATH_LASTLOG
591#  else
592#    ifdef CONF_LASTLOG_FILE
593#      define LASTLOG_FILE CONF_LASTLOG_FILE
594#    endif
595#  endif
596#endif
597
598#if defined(HAVE_SHADOW_H) && !defined(DISABLE_SHADOW)
599# define USE_SHADOW
600#endif
601
602/* The login() library function in libutil is first choice */
603#if defined(HAVE_LOGIN) && !defined(DISABLE_LOGIN)
604#  define USE_LOGIN
605
606#else
607/* Simply select your favourite login types. */
608/* Can't do if-else because some systems use several... <sigh> */
609#  if defined(UTMPX_FILE) && !defined(DISABLE_UTMPX)
610#    define USE_UTMPX
611#  endif
612#  if defined(UTMP_FILE) && !defined(DISABLE_UTMP)
613#    define USE_UTMP
614#  endif
615#  if defined(WTMPX_FILE) && !defined(DISABLE_WTMPX)
616#    define USE_WTMPX
617#  endif
618#  if defined(WTMP_FILE) && !defined(DISABLE_WTMP)
619#    define USE_WTMP
620#  endif
621
622#endif
623
624#ifndef UT_LINESIZE
625# define UT_LINESIZE 8
626#endif
627
628/* I hope that the presence of LASTLOG_FILE is enough to detect this */
629#if defined(LASTLOG_FILE) && !defined(DISABLE_LASTLOG)
630#  define USE_LASTLOG
631#endif
632
633#ifdef HAVE_OSF_SIA
634# ifdef USE_SHADOW
635#  undef USE_SHADOW
636# endif
637# define CUSTOM_SYS_AUTH_PASSWD 1
638#endif
639
640/** end of login recorder definitions */
641
642#endif /* _DEFINES_H */
643