openssh/defines.h

   1 #ifndef _DEFINES_H
   2 #define _DEFINES_H
   3
   4 /* $Id$ */
   5
   6 /* Necessary headers */
   7
   8 #include <sys/types.h> /* For [u]intxx_t */
   9 #include <sys/socket.h> /* For SHUT_XXXX */
  10 #include <sys/param.h> /* For MAXPATHLEN and roundup() */
  11 #include <netinet/in_systm.h> /* For typedefs */
  12 #include <netinet/in.h> /* For IPv6 macros */
  13 #include <netinet/ip.h> /* For IPTOS macros */
  14 #ifdef HAVE_SYS_UN_H
  15 # include <sys/un.h> /* For sockaddr_un */
  16 #endif
  17 #ifdef HAVE_SYS_BITYPES_H
  18 # include <sys/bitypes.h> /* For u_intXX_t */
  19 #endif
  20 #ifdef HAVE_PATHS_H
  21 # include <paths.h> /* For _PATH_XXX */
  22 #endif
  23 #ifdef HAVE_LIMITS_H
  24 # include <limits.h> /* For PATH_MAX */
  25 #endif
  26 #ifdef HAVE_SYS_TIME_H
  27 # include <sys/time.h> /* For timersub */
  28 #endif
  29 #ifdef HAVE_MAILLOCK_H
  30 # include <maillock.h> /* For _PATH_MAILDIR */
  31 #endif
  32 #ifdef HAVE_SYS_CDEFS_H
  33 # include <sys/cdefs.h> /* For __P() */
  34 #endif
  35 #ifdef HAVE_SYS_SYSMACROS_H
  36 # include <sys/sysmacros.h> /* For MIN, MAX, etc */
  37 #endif
  38 #ifdef HAVE_SYS_STAT_H
  39 # include <sys/stat.h> /* For S_* constants and macros */
  40 #endif
  41 #ifdef HAVE_NEXT
  42 #  include <libc.h>
  43 #endif
  44
  45 #include <unistd.h> /* For STDIN_FILENO, etc */
  46 #include <termios.h> /* Struct winsize */
  47 #include <fcntl.h> /* For O_NONBLOCK */
  48 #include <openssl/opensslv.h> /* For OPENSSL_VERSION_NUMBER */
  49
  50 /* *-*-nto-qnx needs these headers for strcasecmp and LASTLOG_FILE respectively */
  51 #ifdef HAVE_STRINGS_H
  52 # include <strings.h>
  53 #endif
  54 #ifdef HAVE_LOGIN_H
  55 # include <login.h>
  56 #endif
  57
  58
  59 /* Constants */
  60
  61 #ifndef SHUT_RDWR
  62 enum
  63 {
  64   SHUT_RD = 0,          /* No more receptions.  */
  65   SHUT_WR,                      /* No more transmissions.  */
  66   SHUT_RDWR                     /* No more receptions or transmissions.  */
  67 };
  68 # define SHUT_RD   SHUT_RD
  69 # define SHUT_WR   SHUT_WR
  70 # define SHUT_RDWR SHUT_RDWR
  71 #endif
  72
  73 #ifndef IPTOS_LOWDELAY
  74 # define IPTOS_LOWDELAY          0x10
  75 # define IPTOS_THROUGHPUT        0x08
  76 # define IPTOS_RELIABILITY       0x04
  77 # define IPTOS_LOWCOST           0x02
  78 # define IPTOS_MINCOST           IPTOS_LOWCOST
  79 #endif /* IPTOS_LOWDELAY */
  80
  81 #ifndef MAXPATHLEN
  82 # ifdef PATH_MAX
  83 #  define MAXPATHLEN PATH_MAX
  84 # else /* PATH_MAX */
  85 #  define MAXPATHLEN 64 /* Should be safe */
  86 # endif /* PATH_MAX */
  87 #endif /* MAXPATHLEN */
  88
  89 #ifndef STDIN_FILENO
  90 # define STDIN_FILENO    0
  91 #endif
  92 #ifndef STDOUT_FILENO
  93 # define STDOUT_FILENO   1
  94 #endif
  95 #ifndef STDERR_FILENO
  96 # define STDERR_FILENO   2
  97 #endif
  98
  99 #ifndef NGROUPS_MAX     /* Disable groupaccess if NGROUP_MAX is not set */
 100 #ifdef NGROUPS
 101 #define NGROUPS_MAX NGROUPS
 102 #else
 103 #define NGROUPS_MAX 0
 104 #endif
 105 #endif
 106
 107 #ifndef O_NONBLOCK      /* Non Blocking Open */
 108 # define O_NONBLOCK      00004
 109 #endif
 110
 111 #ifndef S_ISDIR
 112 # define S_ISDIR(mode)  (((mode) & (_S_IFMT)) == (_S_IFDIR))
 113 #endif /* S_ISDIR */
 114
 115 #ifndef S_ISREG
 116 # define S_ISREG(mode)  (((mode) & (_S_IFMT)) == (_S_IFREG))
 117 #endif /* S_ISREG */
 118
 119 #ifndef S_ISLNK
 120 # define S_ISLNK(mode)  (((mode) & S_IFMT) == S_IFLNK)
 121 #endif /* S_ISLNK */
 122
 123 #ifndef S_IXUSR
 124 # define S_IXUSR                        0000100 /* execute/search permission, */
 125 # define S_IXGRP                        0000010 /* execute/search permission, */
 126 # define S_IXOTH                        0000001 /* execute/search permission, */
 127 # define _S_IWUSR                       0000200 /* write permission, */
 128 # define S_IWUSR                        _S_IWUSR        /* write permission, owner */
 129 # define S_IWGRP                        0000020 /* write permission, group */
 130 # define S_IWOTH                        0000002 /* write permission, other */
 131 # define S_IRUSR                        0000400 /* read permission, owner */
 132 # define S_IRGRP                        0000040 /* read permission, group */
 133 # define S_IROTH                        0000004 /* read permission, other */
 134 # define S_IRWXU                        0000700 /* read, write, execute */
 135 # define S_IRWXG                        0000070 /* read, write, execute */
 136 # define S_IRWXO                        0000007 /* read, write, execute */
 137 #endif /* S_IXUSR */
 138
 139 /* *-*-nto-qnx doesn't define this constant in the system headers */
 140 #ifdef MISSING_NFDBITS
 141 # define        NFDBITS (8 * sizeof(unsigned long))
 142 #endif
 143
 144 /*
 145 SCO Open Server 3 has INADDR_LOOPBACK defined in rpc/rpc.h but
 146 including rpc/rpc.h breaks Solaris 6
 147 */
 148 #ifndef INADDR_LOOPBACK
 149 #define INADDR_LOOPBACK ((ulong)0x7f000001)
 150 #endif
 151
 152 /* Types */
 153
 154 /* If sys/types.h does not supply intXX_t, supply them ourselves */
 155 /* (or die trying) */
 156
 157
 158 #ifndef HAVE_U_INT
 159 typedef unsigned int u_int;
 160 #endif
 161
 162 #ifndef HAVE_INTXX_T
 163 # if (SIZEOF_CHAR == 1)
 164 typedef char int8_t;
 165 # else
 166 #  error "8 bit int type not found."
 167 # endif
 168 # if (SIZEOF_SHORT_INT == 2)
 169 typedef short int int16_t;
 170 # else
 171 #  ifdef _CRAY
 172 #   if (SIZEOF_SHORT_INT == 4)
 173 typedef short int16_t;
 174 #   else
 175 typedef long  int16_t;
 176 #   endif
 177 #  else
 178 #   error "16 bit int type not found."
 179 #  endif /* _CRAY */
 180 # endif
 181 # if (SIZEOF_INT == 4)
 182 typedef int int32_t;
 183 # else
 184 #  ifdef _CRAY
 185 typedef long  int32_t;
 186 #  else
 187 #   error "32 bit int type not found."
 188 #  endif /* _CRAY */
 189 # endif
 190 #endif
 191
 192 /* If sys/types.h does not supply u_intXX_t, supply them ourselves */
 193 #ifndef HAVE_U_INTXX_T
 194 # ifdef HAVE_UINTXX_T
 195 typedef uint8_t u_int8_t;
 196 typedef uint16_t u_int16_t;
 197 typedef uint32_t u_int32_t;
 198 # define HAVE_U_INTXX_T 1
 199 # else
 200 #  if (SIZEOF_CHAR == 1)
 201 typedef unsigned char u_int8_t;
 202 #  else
 203 #   error "8 bit int type not found."
 204 #  endif
 205 #  if (SIZEOF_SHORT_INT == 2)
 206 typedef unsigned short int u_int16_t;
 207 #  else
 208 #   ifdef _CRAY
 209 #    if (SIZEOF_SHORT_INT == 4)
 210 typedef unsigned short u_int16_t;
 211 #    else
 212 typedef unsigned long  u_int16_t;
 213 #    endif
 214 #   else
 215 #    error "16 bit int type not found."
 216 #   endif
 217 #  endif
 218 #  if (SIZEOF_INT == 4)
 219 typedef unsigned int u_int32_t;
 220 #  else
 221 #   ifdef _CRAY
 222 typedef unsigned long  u_int32_t;
 223 #   else
 224 #    error "32 bit int type not found."
 225 #   endif
 226 #  endif
 227 # endif
 228 #define __BIT_TYPES_DEFINED__
 229 #endif
 230
 231 /* 64-bit types */
 232 #ifndef HAVE_INT64_T
 233 # if (SIZEOF_LONG_INT == 8)
 234 typedef long int int64_t;
 235 #   define HAVE_INT64_T 1
 236 # else
 237 #  if (SIZEOF_LONG_LONG_INT == 8)
 238 typedef long long int int64_t;
 239 #   define HAVE_INT64_T 1
 240 #  endif
 241 # endif
 242 #endif
 243 #ifndef HAVE_U_INT64_T
 244 # if (SIZEOF_LONG_INT == 8)
 245 typedef unsigned long int u_int64_t;
 246 #   define HAVE_U_INT64_T 1
 247 # else
 248 #  if (SIZEOF_LONG_LONG_INT == 8)
 249 typedef unsigned long long int u_int64_t;
 250 #   define HAVE_U_INT64_T 1
 251 #  endif
 252 # endif
 253 #endif
 254 #if !defined(HAVE_LONG_LONG_INT) && (SIZEOF_LONG_LONG_INT == 8)
 255 # define HAVE_LONG_LONG_INT 1
 256 #endif
 257
 258 #ifndef HAVE_U_CHAR
 259 typedef unsigned char u_char;
 260 # define HAVE_U_CHAR
 261 #endif /* HAVE_U_CHAR */
 262
 263 #ifndef HAVE_SIZE_T
 264 typedef unsigned int size_t;
 265 # define HAVE_SIZE_T
 266 #endif /* HAVE_SIZE_T */
 267
 268 #ifndef HAVE_SSIZE_T
 269 typedef int ssize_t;
 270 # define HAVE_SSIZE_T
 271 #endif /* HAVE_SSIZE_T */
 272
 273 #ifndef HAVE_CLOCK_T
 274 typedef long clock_t;
 275 # define HAVE_CLOCK_T
 276 #endif /* HAVE_CLOCK_T */
 277
 278 #ifndef HAVE_SA_FAMILY_T
 279 typedef int sa_family_t;
 280 # define HAVE_SA_FAMILY_T
 281 #endif /* HAVE_SA_FAMILY_T */
 282
 283 #ifndef HAVE_PID_T
 284 typedef int pid_t;
 285 # define HAVE_PID_T
 286 #endif /* HAVE_PID_T */
 287
 288 #ifndef HAVE_SIG_ATOMIC_T
 289 typedef int sig_atomic_t;
 290 # define HAVE_SIG_ATOMIC_T
 291 #endif /* HAVE_SIG_ATOMIC_T */
 292
 293 #ifndef HAVE_MODE_T
 294 typedef int mode_t;
 295 # define HAVE_MODE_T
 296 #endif /* HAVE_MODE_T */
 297
 298 #if !defined(HAVE_SS_FAMILY_IN_SS) && defined(HAVE___SS_FAMILY_IN_SS)
 299 # define ss_family __ss_family
 300 #endif /* !defined(HAVE_SS_FAMILY_IN_SS) && defined(HAVE_SA_FAMILY_IN_SS) */
 301
 302 #ifndef HAVE_SYS_UN_H
 303 struct  sockaddr_un {
 304         short   sun_family;             /* AF_UNIX */
 305         char    sun_path[108];          /* path name (gag) */
 306 };
 307 #endif /* HAVE_SYS_UN_H */
 308
 309 #if defined(BROKEN_SYS_TERMIO_H) && !defined(_STRUCT_WINSIZE)
 310 #define _STRUCT_WINSIZE
 311 struct winsize {
 312       unsigned short ws_row;          /* rows, in characters */
 313       unsigned short ws_col;          /* columns, in character */
 314       unsigned short ws_xpixel;       /* horizontal size, pixels */
 315       unsigned short ws_ypixel;       /* vertical size, pixels */
 316 };
 317 #endif
 318
 319 /* *-*-nto-qnx does not define this type in the system headers */
 320 #ifdef MISSING_FD_MASK
 321  typedef unsigned long int      fd_mask;
 322 #endif
 323
 324 /* Paths */
 325
 326 #ifndef _PATH_BSHELL
 327 # define _PATH_BSHELL "/bin/sh"
 328 #endif
 329 #ifndef _PATH_CSHELL
 330 # define _PATH_CSHELL "/bin/csh"
 331 #endif
 332 #ifndef _PATH_SHELLS
 333 # define _PATH_SHELLS "/etc/shells"
 334 #endif
 335
 336 #ifdef USER_PATH
 337 # ifdef _PATH_STDPATH
 338 #  undef _PATH_STDPATH
 339 # endif
 340 # define _PATH_STDPATH USER_PATH
 341 #endif
 342
 343 #ifndef _PATH_STDPATH
 344 # define _PATH_STDPATH "/usr/bin:/bin:/usr/sbin:/sbin"
 345 #endif
 346
 347 #ifndef _PATH_DEVNULL
 348 # define _PATH_DEVNULL "/dev/null"
 349 #endif
 350
 351 #ifndef MAIL_DIRECTORY
 352 # define MAIL_DIRECTORY "/var/spool/mail"
 353 #endif
 354
 355 #ifndef MAILDIR
 356 # define MAILDIR MAIL_DIRECTORY
 357 #endif
 358
 359 #if !defined(_PATH_MAILDIR) && defined(MAILDIR)
 360 # define _PATH_MAILDIR MAILDIR
 361 #endif /* !defined(_PATH_MAILDIR) && defined(MAILDIR) */
 362
 363 #ifndef _PATH_RSH
 364 # ifdef RSH_PATH
 365 #  define _PATH_RSH RSH_PATH
 366 # else /* RSH_PATH */
 367 #  define _PATH_RSH "/usr/bin/rsh"
 368 # endif /* RSH_PATH */
 369 #endif /* _PATH_RSH */
 370
 371 #ifndef _PATH_NOLOGIN
 372 # define _PATH_NOLOGIN "/etc/nologin"
 373 #endif
 374
 375 /* Define this to be the path of the xauth program. */
 376 #ifdef XAUTH_PATH
 377 #define _PATH_XAUTH XAUTH_PATH
 378 #endif /* XAUTH_PATH */
 379
 380 /* derived from XF4/xc/lib/dps/Xlibnet.h */
 381 #ifndef X_UNIX_PATH
 382 #  ifdef __hpux
 383 #    define X_UNIX_PATH "/var/spool/sockets/X11/%u"
 384 #  else
 385 #    define X_UNIX_PATH "/tmp/.X11-unix/X%u"
 386 #  endif
 387 #endif /* X_UNIX_PATH */
 388 #define _PATH_UNIX_X X_UNIX_PATH
 389
 390 #ifndef _PATH_TTY
 391 # define _PATH_TTY "/dev/tty"
 392 #endif
 393
 394 /* Macros */
 395
 396 #if defined(HAVE_LOGIN_GETCAPBOOL) && defined(HAVE_LOGIN_CAP_H)
 397 # define HAVE_LOGIN_CAP
 398 #endif
 399
 400 #ifndef MAX
 401 # define MAX(a,b) (((a)>(b))?(a):(b))
 402 # define MIN(a,b) (((a)<(b))?(a):(b))
 403 #endif
 404
 405 #ifndef roundup
 406 # define roundup(x, y)   ((((x)+((y)-1))/(y))*(y))
 407 #endif
 408
 409 #ifndef timersub
 410 #define timersub(a, b, result)                                  \
 411    do {                                                         \
 412       (result)->tv_sec = (a)->tv_sec - (b)->tv_sec;             \
 413       (result)->tv_usec = (a)->tv_usec - (b)->tv_usec;          \
 414       if ((result)->tv_usec < 0) {                              \
 415          --(result)->tv_sec;                                    \
 416          (result)->tv_usec += 1000000;                          \
 417       }                                                         \
 418    } while (0)
 419 #endif
 420
 421 #ifndef __P
 422 # define __P(x) x
 423 #endif
 424
 425 #if !defined(IN6_IS_ADDR_V4MAPPED)
 426 # define IN6_IS_ADDR_V4MAPPED(a) \
 427         ((((u_int32_t *) (a))[0] == 0) && (((u_int32_t *) (a))[1] == 0) && \
 428          (((u_int32_t *) (a))[2] == htonl (0xffff)))
 429 #endif /* !defined(IN6_IS_ADDR_V4MAPPED) */
 430
 431 #if !defined(__GNUC__) || (__GNUC__ < 2)
 432 # define __attribute__(x)
 433 #endif /* !defined(__GNUC__) || (__GNUC__ < 2) */
 434
 435 /* *-*-nto-qnx doesn't define this macro in the system headers */
 436 #ifdef MISSING_HOWMANY
 437 # define howmany(x,y)   (((x)+((y)-1))/(y))
 438 #endif
 439
 440 /* Function replacement / compatibility hacks */
 441
 442 /* In older versions of libpam, pam_strerror takes a single argument */
 443 #ifdef HAVE_OLD_PAM
 444 # define PAM_STRERROR(a,b) pam_strerror((b))
 445 #else
 446 # define PAM_STRERROR(a,b) pam_strerror((a),(b))
 447 #endif
 448
 449 #ifdef PAM_SUN_CODEBASE
 450 # define PAM_MSG_MEMBER(msg, n, member) ((*(msg))[(n)].member)
 451 #else
 452 # define PAM_MSG_MEMBER(msg, n, member) ((msg)[(n)]->member)
 453 #endif
 454
 455 #if defined(BROKEN_GETADDRINFO) && defined(HAVE_GETADDRINFO)
 456 # undef HAVE_GETADDRINFO
 457 #endif
 458 #if defined(BROKEN_GETADDRINFO) && defined(HAVE_FREEADDRINFO)
 459 # undef HAVE_FREEADDRINFO
 460 #endif
 461 #if defined(BROKEN_GETADDRINFO) && defined(HAVE_GAI_STRERROR)
 462 # undef HAVE_GAI_STRERROR
 463 #endif
 464
 465 #if !defined(HAVE_MEMMOVE) && defined(HAVE_BCOPY)
 466 # define memmove(s1, s2, n) bcopy((s2), (s1), (n))
 467 #endif /* !defined(HAVE_MEMMOVE) && defined(HAVE_BCOPY) */
 468
 469 #if !defined(HAVE_ATEXIT) && defined(HAVE_ON_EXIT)
 470 # define atexit(a) on_exit(a, NULL)
 471 #else
 472 # if defined(HAVE_XATEXIT)
 473 #  define atexit(a) xatexit(a)
 474 # endif /* defined(HAVE_XATEXIT) */
 475 #endif /* !defined(HAVE_ATEXIT) && defined(HAVE_ON_EXIT) */
 476
 477 #if defined(HAVE_VHANGUP) && !defined(HAVE_DEV_PTMX)
 478 #  define USE_VHANGUP
 479 #endif /* defined(HAVE_VHANGUP) && !defined(HAVE_DEV_PTMX) */
 480
 481 #ifndef GETPGRP_VOID
 482 # define getpgrp() getpgrp(0)
 483 #endif
 484
 485 /* OPENSSL_free() is Free() in versions before OpenSSL 0.9.6 */
 486 #if !defined(OPENSSL_VERSION_NUMBER) || (OPENSSL_VERSION_NUMBER < 0x0090600f)
 487 # define OPENSSL_free(x) Free(x)
 488 #endif
 489
 490 /*
 491  * Define this to use pipes instead of socketpairs for communicating with the
 492  * client program.  Socketpairs do not seem to work on all systems.
 493  *
 494  * configure.ac sets this for a few OS's which are known to have problems
 495  * but you may need to set it yourself
 496  */
 497 /* #define USE_PIPES 1 */
 498
 499 /**
 500  ** login recorder definitions
 501  **/
 502
 503 /* preprocess */
 504
 505 #ifdef HAVE_UTMP_H
 506 #  ifdef HAVE_TIME_IN_UTMP
 507 #    include <time.h>
 508 #  endif
 509 #  include <utmp.h>
 510 #endif
 511 #ifdef HAVE_UTMPX_H
 512 #  ifdef HAVE_TV_IN_UTMPX
 513 #    include <sys/time.h>
 514 #  endif
 515 #  include <utmpx.h>
 516 #endif
 517 #ifdef HAVE_LASTLOG_H
 518 #  include <lastlog.h>
 519 #endif
 520 #ifdef HAVE_PATHS_H
 521 #  include <paths.h>
 522 #endif
 523
 524 /* FIXME: put default paths back in */
 525 #ifndef UTMP_FILE
 526 #  ifdef _PATH_UTMP
 527 #    define UTMP_FILE _PATH_UTMP
 528 #  else
 529 #    ifdef CONF_UTMP_FILE
 530 #      define UTMP_FILE CONF_UTMP_FILE
 531 #    endif
 532 #  endif
 533 #endif
 534 #ifndef WTMP_FILE
 535 #  ifdef _PATH_WTMP
 536 #    define WTMP_FILE _PATH_WTMP
 537 #  else
 538 #    ifdef CONF_WTMP_FILE
 539 #      define WTMP_FILE CONF_WTMP_FILE
 540 #    endif
 541 #  endif
 542 #endif
 543 /* pick up the user's location for lastlog if given */
 544 #ifndef LASTLOG_FILE
 545 #  ifdef _PATH_LASTLOG
 546 #    define LASTLOG_FILE _PATH_LASTLOG
 547 #  else
 548 #    ifdef CONF_LASTLOG_FILE
 549 #      define LASTLOG_FILE CONF_LASTLOG_FILE
 550 #    endif
 551 #  endif
 552 #endif
 553
 554
 555 /* The login() library function in libutil is first choice */
 556 #if defined(HAVE_LOGIN) && !defined(DISABLE_LOGIN)
 557 #  define USE_LOGIN
 558
 559 #else
 560 /* Simply select your favourite login types. */
 561 /* Can't do if-else because some systems use several... <sigh> */
 562 #  if defined(UTMPX_FILE) && !defined(DISABLE_UTMPX)
 563 #    define USE_UTMPX
 564 #  endif
 565 #  if defined(UTMP_FILE) && !defined(DISABLE_UTMP)
 566 #    define USE_UTMP
 567 #  endif
 568 #  if defined(WTMPX_FILE) && !defined(DISABLE_WTMPX)
 569 #    define USE_WTMPX
 570 #  endif
 571 #  if defined(WTMP_FILE) && !defined(DISABLE_WTMP)
 572 #    define USE_WTMP
 573 #  endif
 574
 575 #endif
 576
 577 /* I hope that the presence of LASTLOG_FILE is enough to detect this */
 578 #if defined(LASTLOG_FILE) && !defined(DISABLE_LASTLOG)
 579 #  define USE_LASTLOG
 580 #endif
 581
 582 /* which type of time to use? (api.c) */
 583 #ifdef HAVE_SYS_TIME_H
 584 #  define USE_TIMEVAL
 585 #endif
 586
 587 /** end of login recorder definitions */
 588
 589 #endif /* _DEFINES_H */