source3/include/includes.h

   1 #ifndef _INCLUDES_H
   2 #define _INCLUDES_H
   3 /*
   4    Unix SMB/CIFS implementation.
   5    Machine customisation and include handling
   6    Copyright (C) Andrew Tridgell 1994-1998
   7    Copyright (C) 2002 by Martin Pool <mbp@samba.org>
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 /* work around broken krb5.h on sles9 */
  24 #ifdef SIZEOF_LONG
  25 #undef SIZEOF_LONG
  26 #endif
  27
  28 #include "../replace/replace.h"
  29
  30 /* make sure we have included the correct config.h */
  31 #ifndef NO_CONFIG_H /* for some tests */
  32 #ifndef CONFIG_H_IS_FROM_SAMBA
  33 #error "make sure you have removed all config.h files from standalone builds!"
  34 #error "the included config.h isn't from samba!"
  35 #endif
  36 #endif /* NO_CONFIG_H */
  37
  38 /* only do the C++ reserved word check when we compile
  39    to include --with-developer since too many systems
  40    still have comflicts with their header files (e.g. IRIX 6.4) */
  41
  42 #if !defined(__cplusplus) && defined(DEVELOPER)
  43 #define class #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
  44 #define private #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
  45 #define public #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
  46 #define protected #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
  47 #define template #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
  48 #define this #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
  49 #define new #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
  50 #define delete #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
  51 #define friend #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
  52 #endif
  53
  54 #include "local.h"
  55
  56 #ifdef AIX
  57 #define DEFAULT_PRINTING PRINT_AIX
  58 #define PRINTCAP_NAME "/etc/qconfig"
  59 #endif
  60
  61 #ifdef HPUX
  62 #define DEFAULT_PRINTING PRINT_HPUX
  63 #endif
  64
  65 #ifdef QNX
  66 #define DEFAULT_PRINTING PRINT_QNX
  67 #endif
  68
  69 #ifdef SUNOS4
  70 /* on SUNOS4 termios.h conflicts with sys/ioctl.h */
  71 #undef HAVE_TERMIOS_H
  72 #endif
  73
  74 #ifdef RELIANTUNIX
  75 /*
  76  * <unistd.h> has to be included before any other to get
  77  * large file support on Reliant UNIX. Yes, it's broken :-).
  78  */
  79 #ifdef HAVE_UNISTD_H
  80 #include <unistd.h>
  81 #endif
  82 #endif /* RELIANTUNIX */
  83
  84 #include "system/capability.h"
  85 #include "system/dir.h"
  86 #include "system/filesys.h"
  87 #include "system/glob.h"
  88 #include "system/iconv.h"
  89 #include "system/locale.h"
  90 #include "system/network.h"
  91 #include "system/passwd.h"
  92 #include "system/readline.h"
  93 #include "system/select.h"
  94 #include "system/shmem.h"
  95 #include "system/syslog.h"
  96 #include "system/terminal.h"
  97 #include "system/time.h"
  98 #include "system/wait.h"
  99
 100 #if defined(HAVE_RPC_RPC_H)
 101 /*
 102  * Check for AUTH_ERROR define conflict with rpc/rpc.h in prot.h.
 103  */
 104 #if defined(HAVE_SYS_SECURITY_H) && defined(HAVE_RPC_AUTH_ERROR_CONFLICT)
 105 #undef AUTH_ERROR
 106 #endif
 107 /*
 108  * HP-UX 11.X has TCP_NODELAY and TCP_MAXSEG defined in <netinet/tcp.h> which
 109  * was included above.  However <rpc/rpc.h> includes <sys/xti.h> which defines
 110  * them again without checking if they already exsist.  This generates
 111  * two "Redefinition of macro" warnings for every single .c file that is
 112  * compiled.
 113  */
 114 #if defined(HPUX) && defined(TCP_NODELAY)
 115 #undef TCP_NODELAY
 116 #endif
 117 #if defined(HPUX) && defined(TCP_MAXSEG)
 118 #undef TCP_MAXSEG
 119 #endif
 120 #include <rpc/rpc.h>
 121 #endif
 122
 123 #if defined(HAVE_YP_GET_DEFAULT_DOMAIN) && defined(HAVE_SETNETGRENT) && defined(HAVE_ENDNETGRENT) && defined(HAVE_GETNETGRENT)
 124 #define HAVE_NETGROUP 1
 125 #endif
 126
 127 #if defined (HAVE_NETGROUP)
 128 #if defined(HAVE_RPCSVC_YP_PROT_H)
 129 /*
 130  * HP-UX 11.X has TCP_NODELAY and TCP_MAXSEG defined in <netinet/tcp.h> which
 131  * was included above.  However <rpc/rpc.h> includes <sys/xti.h> which defines
 132  * them again without checking if they already exsist.  This generates
 133  * two "Redefinition of macro" warnings for every single .c file that is
 134  * compiled.
 135  */
 136 #if defined(HPUX) && defined(TCP_NODELAY)
 137 #undef TCP_NODELAY
 138 #endif
 139 #if defined(HPUX) && defined(TCP_MAXSEG)
 140 #undef TCP_MAXSEG
 141 #endif
 142 #include <rpcsvc/yp_prot.h>
 143 #endif
 144 #if defined(HAVE_RPCSVC_YPCLNT_H)
 145 #include <rpcsvc/ypclnt.h>
 146 #endif
 147 #endif /* HAVE_NETGROUP */
 148
 149 #if HAVE_KRB5_H
 150 #include <krb5.h>
 151 #else
 152 #undef HAVE_KRB5
 153 #endif
 154
 155 #if HAVE_LBER_H
 156 #include <lber.h>
 157 #if defined(HPUX) && !defined(_LBER_TYPES_H)
 158 /* Define ber_tag_t and ber_int_t for using
 159  * HP LDAP-UX Integration products' LDAP libraries.
 160 */
 161 #ifndef ber_tag_t
 162 typedef unsigned long ber_tag_t;
 163 typedef int ber_int_t;
 164 #endif
 165 #endif /* defined(HPUX) && !defined(_LBER_TYPES_H) */
 166 #ifndef LBER_USE_DER
 167 #define LBER_USE_DER 0x01
 168 #endif
 169 #endif
 170
 171 #if HAVE_LDAP_H
 172 #include <ldap.h>
 173 #ifndef LDAP_CONST
 174 #define LDAP_CONST const
 175 #endif
 176 #ifndef LDAP_OPT_SUCCESS
 177 #define LDAP_OPT_SUCCESS 0
 178 #endif
 179 /* Solaris 8 and maybe other LDAP implementations spell this "..._INPROGRESS": */
 180 #if defined(LDAP_SASL_BIND_INPROGRESS) && !defined(LDAP_SASL_BIND_IN_PROGRESS)
 181 #define LDAP_SASL_BIND_IN_PROGRESS LDAP_SASL_BIND_INPROGRESS
 182 #endif
 183 /* Solaris 8 defines SSL_LDAP_PORT, not LDAPS_PORT and it only does so if
 184    LDAP_SSL is defined - but SSL is not working. We just want the
 185    port number! Let's just define LDAPS_PORT correct. */
 186 #if !defined(LDAPS_PORT)
 187 #define LDAPS_PORT 636
 188 #endif
 189 #else
 190 #undef HAVE_LDAP
 191 #endif
 192
 193 #if HAVE_GSSAPI_GSSAPI_H
 194 #include <gssapi/gssapi.h>
 195 #elif HAVE_GSSAPI_GSSAPI_GENERIC_H
 196 #include <gssapi/gssapi_generic.h>
 197 #elif HAVE_GSSAPI_H
 198 #include <gssapi.h>
 199 #endif
 200
 201 #if HAVE_COM_ERR_H
 202 #include <com_err.h>
 203 #endif
 204
 205 #if HAVE_SYS_ATTRIBUTES_H
 206 #include <sys/attributes.h>
 207 #endif
 208
 209 #ifndef ENOATTR
 210 #define ENOATTR ENODATA
 211 #endif
 212
 213 /* mutually exclusive (SuSE 8.2) */
 214 #if HAVE_ATTR_XATTR_H
 215 #include <attr/xattr.h>
 216 #elif HAVE_SYS_XATTR_H
 217 #include <sys/xattr.h>
 218 #endif
 219
 220 #ifdef HAVE_SYS_EA_H
 221 #include <sys/ea.h>
 222 #endif
 223
 224 #ifdef HAVE_SYS_EXTATTR_H
 225 #include <sys/extattr.h>
 226 #endif
 227
 228 #ifdef HAVE_SYS_UIO_H
 229 #include <sys/uio.h>
 230 #endif
 231
 232 #if HAVE_LANGINFO_H
 233 #include <langinfo.h>
 234 #endif
 235
 236 #if HAVE_NETGROUP_H
 237 #include <netgroup.h>
 238 #endif
 239
 240 #if defined(HAVE_AIO_H) && defined(WITH_AIO)
 241 #include <aio.h>
 242 #endif
 243
 244 #ifdef WITH_MADVISE_PROTECTED
 245 #include <sys/mman.h>
 246 #endif
 247
 248 /* Special macros that are no-ops except when run under Valgrind on
 249  * x86.  They've moved a little bit from valgrind 1.0.4 to 1.9.4 */
 250 #if HAVE_VALGRIND_MEMCHECK_H
 251         /* memcheck.h includes valgrind.h */
 252 #include <valgrind/memcheck.h>
 253 #elif HAVE_VALGRIND_H
 254 #include <valgrind.h>
 255 #endif
 256
 257 /* If we have --enable-developer and the valgrind header is present,
 258  * then we're OK to use it.  Set a macro so this logic can be done only
 259  * once. */
 260 #if defined(DEVELOPER)
 261 #if (HAVE_VALGRIND_H || HAVE_VALGRIND_VALGRIND_H)
 262 #define VALGRIND
 263 #endif
 264 #endif
 265
 266
 267 /* we support ADS if we want it and have krb5 and ldap libs */
 268 #if defined(WITH_ADS) && defined(HAVE_KRB5) && defined(HAVE_LDAP)
 269 #define HAVE_ADS
 270 #endif
 271
 272 /*
 273  * Define additional missing types
 274  */
 275 #if defined(AIX)
 276 typedef sig_atomic_t SIG_ATOMIC_T;
 277 #else
 278 typedef sig_atomic_t volatile SIG_ATOMIC_T;
 279 #endif
 280
 281 #ifndef uchar
 282 #define uchar unsigned char
 283 #endif
 284
 285 /*
 286    Samba needs type definitions for int16, int32, uint16 and uint32.
 287
 288    Normally these are signed and unsigned 16 and 32 bit integers, but
 289    they actually only need to be at least 16 and 32 bits
 290    respectively. Thus if your word size is 8 bytes just defining them
 291    as signed and unsigned int will work.
 292 */
 293
 294 #ifndef uint8
 295 #define uint8 uint8_t
 296 #endif
 297
 298 #if !defined(int16) && !defined(HAVE_INT16_FROM_RPC_RPC_H)
 299 #  define int16 int16_t
 300    /* needed to work around compile issue on HP-UX 11.x */
 301 #  define _INT16        1
 302 #endif
 303
 304 /*
 305  * Note we duplicate the size tests in the unsigned
 306  * case as int16 may be a typedef from rpc/rpc.h
 307  */
 308
 309
 310 #if !defined(uint16) && !defined(HAVE_UINT16_FROM_RPC_RPC_H)
 311 #  define uint16 uint16_t
 312 #endif
 313
 314 #if !defined(int32) && !defined(HAVE_INT32_FROM_RPC_RPC_H)
 315 #  define int32 int32_t
 316 #  ifndef _INT32
 317      /* needed to work around compile issue on HP-UX 11.x */
 318 #    define _INT32      1
 319 #  endif
 320 #endif
 321
 322 /*
 323  * Note we duplicate the size tests in the unsigned
 324  * case as int32 may be a typedef from rpc/rpc.h
 325  */
 326
 327 #if !defined(uint32) && !defined(HAVE_UINT32_FROM_RPC_RPC_H)
 328 #  define uint32 uint32_t
 329 #endif
 330
 331 /*
 332  * check for 8 byte long long
 333  */
 334
 335 #if !defined(uint64)
 336 #  define uint64 uint64_t
 337 #endif
 338
 339 #if !defined(int64)
 340 #  define int64 int64_t
 341 #endif
 342
 343
 344 /*
 345  * Types for devices, inodes and offsets.
 346  */
 347
 348 #ifndef SMB_DEV_T
 349 #  if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_DEV64_T)
 350 #    define SMB_DEV_T dev64_t
 351 #  else
 352 #    define SMB_DEV_T dev_t
 353 #  endif
 354 #endif
 355
 356 #ifndef LARGE_SMB_DEV_T
 357 #  if (defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_DEV64_T)) || (defined(SIZEOF_DEV_T) && (SIZEOF_DEV_T == 8))
 358 #    define LARGE_SMB_DEV_T 1
 359 #  endif
 360 #endif
 361
 362 #ifdef LARGE_SMB_DEV_T
 363 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),(v)&0xFFFFFFFF), SIVAL((p),(ofs)+4,(v)>>32))
 364 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(((uint64_t)(IVAL((p),(ofs))))| (((uint64_t)(IVAL((p),(ofs)+4))) << 32)))
 365 #else
 366 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),v),SIVAL((p),(ofs)+4,0))
 367 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(IVAL((p),(ofs))))
 368 #endif
 369
 370 /*
 371  * Setup the correctly sized inode type.
 372  */
 373
 374 #ifndef SMB_INO_T
 375 #  if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_INO64_T)
 376 #    define SMB_INO_T ino64_t
 377 #  else
 378 #    define SMB_INO_T ino_t
 379 #  endif
 380 #endif
 381
 382 #ifndef LARGE_SMB_INO_T
 383 #  if (defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_INO64_T)) || (defined(SIZEOF_INO_T) && (SIZEOF_INO_T == 8))
 384 #    define LARGE_SMB_INO_T 1
 385 #  endif
 386 #endif
 387
 388 #ifdef LARGE_SMB_INO_T
 389 #define SINO_T_VAL(p, ofs, v) (SIVAL((p),(ofs),(v)&0xFFFFFFFF), SIVAL((p),(ofs)+4,(v)>>32))
 390 #define INO_T_VAL(p, ofs) ((SMB_INO_T)(((uint64_t)(IVAL(p,ofs)))| (((uint64_t)(IVAL(p,(ofs)+4))) << 32)))
 391 #else
 392 #define SINO_T_VAL(p, ofs, v) (SIVAL(p,ofs,v),SIVAL(p,(ofs)+4,0))
 393 #define INO_T_VAL(p, ofs) ((SMB_INO_T)(IVAL((p),(ofs))))
 394 #endif
 395
 396 #ifndef SMB_OFF_T
 397 #  if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_OFF64_T)
 398 #    define SMB_OFF_T off64_t
 399 #  else
 400 #    define SMB_OFF_T off_t
 401 #  endif
 402 #endif
 403
 404 #define SBIG_UINT(p, ofs, v) (SIVAL(p,ofs,(v)&0xFFFFFFFF), SIVAL(p,(ofs)+4,(v)>>32))
 405 #define BIG_UINT(p, ofs) ((((uint64_t) IVAL(p,(ofs)+4))<<32)|IVAL(p,ofs))
 406 #define IVAL2_TO_SMB_BIG_UINT(buf,off) ( (((uint64_t)(IVAL((buf),(off)))) & ((uint64_t)0xFFFFFFFF)) | \
 407                 (( ((uint64_t)(IVAL((buf),(off+4)))) & ((uint64_t)0xFFFFFFFF) ) << 32 ) )
 408
 409
 410 /* this should really be a 64 bit type if possible */
 411 typedef uint64_t br_off;
 412
 413 #define SMB_OFF_T_BITS (sizeof(SMB_OFF_T)*8)
 414
 415 /*
 416  * Set the define that tells us if we can do 64 bit
 417  * NT SMB calls.
 418  */
 419
 420 #ifndef LARGE_SMB_OFF_T
 421 #  if (defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_OFF64_T)) || (defined(SIZEOF_OFF_T) && (SIZEOF_OFF_T == 8))
 422 #    define LARGE_SMB_OFF_T 1
 423 #  endif
 424 #endif
 425
 426 #ifdef LARGE_SMB_OFF_T
 427 #define SOFF_T(p, ofs, v) (SIVAL(p,ofs,(v)&0xFFFFFFFF), SIVAL(p,(ofs)+4,(v)>>32))
 428 #define SOFF_T_R(p, ofs, v) (SIVAL(p,(ofs)+4,(v)&0xFFFFFFFF), SIVAL(p,ofs,(v)>>32))
 429 #define IVAL_TO_SMB_OFF_T(buf,off) ((SMB_OFF_T)(( ((uint64_t)(IVAL((buf),(off)))) & ((uint64_t)0xFFFFFFFF) )))
 430 #else
 431 #define SOFF_T(p, ofs, v) (SIVAL(p,ofs,v),SIVAL(p,(ofs)+4,0))
 432 #define SOFF_T_R(p, ofs, v) (SIVAL(p,(ofs)+4,v),SIVAL(p,ofs,0))
 433 #define IVAL_TO_SMB_OFF_T(buf,off) ((SMB_OFF_T)(( ((uint32)(IVAL((buf),(off)))) & 0xFFFFFFFF )))
 434 #endif
 435
 436 #ifndef HAVE_BLKSIZE_T
 437 /* This is mainly for HP/UX which defines st_blksize as long */
 438 typedef long blksize_t;
 439 #endif
 440
 441 #ifndef HAVE_BLKCNT_T
 442 /* This is mainly for HP/UX which doesn't have blkcnt_t */
 443 typedef long blkcnt_t;
 444 #endif
 445
 446 /*
 447  * Type for stat structure.
 448  */
 449
 450 struct stat_ex {
 451         dev_t           st_ex_dev;
 452         ino_t           st_ex_ino;
 453         mode_t          st_ex_mode;
 454         nlink_t         st_ex_nlink;
 455         uid_t           st_ex_uid;
 456         gid_t           st_ex_gid;
 457         dev_t           st_ex_rdev;
 458         off_t           st_ex_size;
 459         struct timespec st_ex_atime;
 460         struct timespec st_ex_mtime;
 461         struct timespec st_ex_ctime;
 462         struct timespec st_ex_btime; /* birthtime */
 463         blksize_t       st_ex_blksize;
 464         blkcnt_t        st_ex_blocks;
 465
 466         uint32_t        st_ex_flags;
 467         uint32_t        st_ex_mask;
 468
 469         /*
 470          * Add space for VFS internal extensions. The initial user of this
 471          * would be the onefs modules, passing the snapid from the stat calls
 472          * to the file_id_create call. Maybe we'll have to expand this later,
 473          * but the core of Samba should never look at this field.
 474          */
 475         uint64_t vfs_private;
 476 };
 477
 478 typedef struct stat_ex SMB_STRUCT_STAT;
 479
 480 /*
 481  * Type for dirent structure.
 482  */
 483
 484 #ifndef SMB_STRUCT_DIRENT
 485 #  if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_DIRENT64)
 486 #    define SMB_STRUCT_DIRENT struct dirent64
 487 #  else
 488 #    define SMB_STRUCT_DIRENT struct dirent
 489 #  endif
 490 #endif
 491
 492 /*
 493  * Type for DIR structure.
 494  */
 495
 496 #ifndef SMB_STRUCT_DIR
 497 #  if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_DIR64)
 498 #    define SMB_STRUCT_DIR DIR64
 499 #  else
 500 #    define SMB_STRUCT_DIR DIR
 501 #  endif
 502 #endif
 503
 504 /*
 505  * Defines for 64 bit fcntl locks.
 506  */
 507
 508 #ifndef SMB_STRUCT_FLOCK
 509 #  if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
 510 #    define SMB_STRUCT_FLOCK struct flock64
 511 #  else
 512 #    define SMB_STRUCT_FLOCK struct flock
 513 #  endif
 514 #endif
 515
 516 #ifndef SMB_F_SETLKW
 517 #  if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
 518 #    define SMB_F_SETLKW F_SETLKW64
 519 #  else
 520 #    define SMB_F_SETLKW F_SETLKW
 521 #  endif
 522 #endif
 523
 524 #ifndef SMB_F_SETLK
 525 #  if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
 526 #    define SMB_F_SETLK F_SETLK64
 527 #  else
 528 #    define SMB_F_SETLK F_SETLK
 529 #  endif
 530 #endif
 531
 532 #ifndef SMB_F_GETLK
 533 #  if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
 534 #    define SMB_F_GETLK F_GETLK64
 535 #  else
 536 #    define SMB_F_GETLK F_GETLK
 537 #  endif
 538 #endif
 539
 540 /*
 541  * Type for aiocb structure.
 542  */
 543
 544 #ifndef SMB_STRUCT_AIOCB
 545 #  if defined(WITH_AIO)
 546 #    if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_AIOCB64)
 547 #      define SMB_STRUCT_AIOCB struct aiocb64
 548 #    else
 549 #      define SMB_STRUCT_AIOCB struct aiocb
 550 #    endif
 551 #  else
 552 #    define SMB_STRUCT_AIOCB int /* AIO not being used but we still need the define.... */
 553 #  endif
 554 #endif
 555
 556 #ifndef HAVE_STRUCT_TIMESPEC
 557 struct timespec {
 558         time_t tv_sec;            /* Seconds.  */
 559         long tv_nsec;           /* Nanoseconds.  */
 560 };
 561 #endif
 562
 563 #ifdef HAVE_BROKEN_GETGROUPS
 564 #define GID_T int
 565 #else
 566 #define GID_T gid_t
 567 #endif
 568
 569 #ifndef NGROUPS_MAX
 570 #define NGROUPS_MAX 32 /* Guess... */
 571 #endif
 572
 573 /* Our own fstrings */
 574
 575 /*
 576                   --------------
 577                  /              \
 578                 /      REST      \
 579                /        IN        \
 580               /       PEACE        \
 581              /                      \
 582              | The infamous pstring |
 583              |                      |
 584              |                      |
 585              |      7 December      |
 586              |                      |
 587              |         2007         |
 588             *|     *  *  *          | *
 589    _________)/\\_//(\/(/\)/\//\/\///|_)_______
 590 */
 591
 592 #ifndef FSTRING_LEN
 593 #define FSTRING_LEN 256
 594 typedef char fstring[FSTRING_LEN];
 595 #endif
 596
 597 /* Samba 3 doesn't use iconv_convenience: */
 598 extern void *cmdline_lp_ctx;
 599 struct smb_iconv_convenience *lp_iconv_convenience(void *lp_ctx);
 600
 601 /* Lists, trees, caching, database... */
 602 #include "../lib/util/util.h"
 603 #include "../lib/util/xfile.h"
 604 #include "../lib/util/memory.h"
 605 #include "../lib/util/attr.h"
 606 #include "intl.h"
 607 #include "../lib/util/dlinklist.h"
 608 #include "tdb.h"
 609 #include "util_tdb.h"
 610
 611 #include "../talloc/talloc.h"
 612
 613 #include "event.h"
 614 #include "../lib/util/tevent_unix.h"
 615 #include "../lib/util/tevent_ntstatus.h"
 616 #include "../lib/tsocket/tsocket.h"
 617
 618 #include "../lib/util/data_blob.h"
 619 #include "../lib/util/time.h"
 620 #include "../lib/util/asn1.h"
 621
 622 #include "ads.h"
 623 #include "ads_dns.h"
 624 #include "interfaces.h"
 625 #include "trans2.h"
 626 #include "../libcli/util/error.h"
 627 #include "ntioctl.h"
 628 #include "../lib/util/charset/charset.h"
 629 #include "dynconfig.h"
 630 #include "util_getent.h"
 631 #include "debugparse.h"
 632 #include "privileges.h"
 633 #include "messages.h"
 634 #include "locking.h"
 635 #include "smb_perfcount.h"
 636 #include "smb_signing.h"
 637 #include "smb.h"
 638 #include "nameserv.h"
 639 #include "secrets.h"
 640 #include "../lib/util/byteorder.h"
 641 #include "privileges.h"
 642 #include "rpc_misc.h"
 643 #include "rpc_dce.h"
 644 #include "mapping.h"
 645 #include "passdb.h"
 646 #include "rpc_secdes.h"
 647 #include "../libgpo/gpo.h"
 648 #include "authdata.h"
 649 #include "msdfs.h"
 650 #include "rap.h"
 651 #include "../lib/crypto/md5.h"
 652 #include "../lib/crypto/md4.h"
 653 #include "../lib/crypto/arcfour.h"
 654 #include "../lib/crypto/crc32.h"
 655 #include "../lib/crypto/hmacmd5.h"
 656 #include "ntlmssp.h"
 657 #include "auth.h"
 658 #include "ntdomain.h"
 659 #include "reg_objects.h"
 660 #include "reg_db.h"
 661 #include "rpc_perfcount.h"
 662 #include "rpc_perfcount_defs.h"
 663 #include "librpc/gen_ndr/notify.h"
 664 #include "librpc/gen_ndr/xattr.h"
 665 #include "librpc/gen_ndr/messaging.h"
 666 #include "librpc/gen_ndr/ndr_nbt.h"
 667 #include "librpc/rpc/dcerpc.h"
 668 #include "nt_printing.h"
 669 #include "idmap.h"
 670 #include "client.h"
 671
 672 #include "session.h"
 673 #include "popt.h"
 674 #include "mangle.h"
 675 #include "module.h"
 676 #include "nsswitch/winbind_client.h"
 677 #include "spnego.h"
 678 #include "rpc_client.h"
 679 #include "dbwrap.h"
 680 #include "packet.h"
 681 #include "ctdbd_conn.h"
 682 #include "../lib/util/talloc_stack.h"
 683 #include "memcache.h"
 684 #include "async_smb.h"
 685 #include "../lib/async_req/async_sock.h"
 686 #include "services.h"
 687 #include "eventlog.h"
 688 #include "../lib/util/smb_threads.h"
 689 #include "../lib/util/smb_threads_internal.h"
 690 #include "tldap.h"
 691 #include "tldap_util.h"
 692
 693 #include "lib/smbconf/smbconf.h"
 694 #include "lib/smbconf/smbconf_init.h"
 695 #include "lib/smbconf/smbconf_reg.h"
 696 #include "lib/smbconf/smbconf_txt.h"
 697
 698 /* Defines for wisXXX functions. */
 699 #define UNI_UPPER    0x1
 700 #define UNI_LOWER    0x2
 701 #define UNI_DIGIT    0x4
 702 #define UNI_XDIGIT   0x8
 703 #define UNI_SPACE    0x10
 704
 705 #include "nsswitch/winbind_nss.h"
 706
 707 /* forward declaration from printing.h to get around
 708    header file dependencies */
 709
 710 struct printjob;
 711
 712 /* forward declarations from smbldap.c */
 713
 714 #include "smbldap.h"
 715
 716 /*
 717  * Reasons for cache flush.
 718  */
 719
 720 enum flush_reason_enum {
 721     SEEK_FLUSH,
 722     READ_FLUSH,
 723     WRITE_FLUSH,
 724     READRAW_FLUSH,
 725     OPLOCK_RELEASE_FLUSH,
 726     CLOSE_FLUSH,
 727     SYNC_FLUSH,
 728     SIZECHANGE_FLUSH,
 729     /* NUM_FLUSH_REASONS must remain the last value in the enumeration. */
 730     NUM_FLUSH_REASONS};
 731
 732 #include "nss_info.h"
 733 #include "modules/nfs4_acls.h"
 734 #include "nsswitch/libwbclient/wbclient.h"
 735
 736 /***** prototypes *****/
 737 #ifndef NO_PROTO_H
 738 #include "proto.h"
 739 #endif
 740 #include "libcli/security/secace.h"
 741 #include "libcli/security/secacl.h"
 742 #include "libcli/security/security_descriptor.h"
 743
 744 #if defined(HAVE_POSIX_ACLS)
 745 #include "modules/vfs_posixacl.h"
 746 #endif
 747
 748 #if defined(HAVE_TRU64_ACLS)
 749 #include "modules/vfs_tru64acl.h"
 750 #endif
 751
 752 #if defined(HAVE_SOLARIS_ACLS) || defined(HAVE_UNIXWARE_ACLS)
 753 #include "modules/vfs_solarisacl.h"
 754 #endif
 755
 756 #if defined(HAVE_HPUX_ACLS)
 757 #include "modules/vfs_hpuxacl.h"
 758 #endif
 759
 760 #if defined(HAVE_IRIX_ACLS)
 761 #include "modules/vfs_irixacl.h"
 762 #endif
 763
 764 #ifdef HAVE_LDAP
 765 #include "ads_protos.h"
 766 #endif
 767
 768 /* We need this after proto.h to reference GetTimeOfDay(). */
 769 #include "smbprofile.h"
 770
 771 /* String routines */
 772
 773 #include "srvstr.h"
 774 #include "safe_string.h"
 775
 776 /* prototypes from lib/util_transfer_file.c */
 777 #include "transfer_file.h"
 778
 779 #ifndef DEFAULT_PRINTING
 780 #ifdef HAVE_CUPS
 781 #define DEFAULT_PRINTING PRINT_CUPS
 782 #define PRINTCAP_NAME "cups"
 783 #elif defined(SYSV)
 784 #define DEFAULT_PRINTING PRINT_SYSV
 785 #define PRINTCAP_NAME "lpstat"
 786 #else
 787 #define DEFAULT_PRINTING PRINT_BSD
 788 #define PRINTCAP_NAME "/etc/printcap"
 789 #endif
 790 #endif
 791
 792 #ifndef PRINTCAP_NAME
 793 #define PRINTCAP_NAME "/etc/printcap"
 794 #endif
 795
 796 #ifndef SIGCLD
 797 #define SIGCLD SIGCHLD
 798 #endif
 799
 800 #ifndef SIGRTMIN
 801 #define SIGRTMIN NSIG
 802 #endif
 803
 804 #ifndef MAP_FILE
 805 #define MAP_FILE 0
 806 #endif
 807
 808 #if defined(HAVE_PUTPRPWNAM) && defined(AUTH_CLEARTEXT_SEG_CHARS)
 809 #define OSF1_ENH_SEC 1
 810 #endif
 811
 812 #ifndef ALLOW_CHANGE_PASSWORD
 813 #if (defined(HAVE_TERMIOS_H) && defined(HAVE_DUP2) && defined(HAVE_SETSID))
 814 #define ALLOW_CHANGE_PASSWORD 1
 815 #endif
 816 #endif
 817
 818 /* what is the longest significant password available on your system?
 819  Knowing this speeds up password searches a lot */
 820 #ifndef PASSWORD_LENGTH
 821 #define PASSWORD_LENGTH 8
 822 #endif
 823
 824 #ifndef HAVE_PIPE
 825 #define SYNC_DNS 1
 826 #endif
 827
 828 #if defined(HAVE_CRYPT16) && defined(HAVE_GETAUTHUID)
 829 #define ULTRIX_AUTH 1
 830 #endif
 831
 832 /* yuck, I'd like a better way of doing this */
 833 #define DIRP_SIZE (256 + 32)
 834
 835 /* default socket options. Dave Miller thinks we should default to TCP_NODELAY
 836    given the socket IO pattern that Samba uses */
 837 #ifdef TCP_NODELAY
 838 #define DEFAULT_SOCKET_OPTIONS "TCP_NODELAY"
 839 #else
 840 #define DEFAULT_SOCKET_OPTIONS ""
 841 #endif
 842
 843 /* dmalloc -- free heap debugger (dmalloc.org).  This should be near
 844  * the *bottom* of include files so as not to conflict. */
 845 #ifdef ENABLE_DMALLOC
 846 #  include <dmalloc.h>
 847 #endif
 848
 849
 850 #if HAVE_KERNEL_SHARE_MODES
 851 #ifndef LOCK_MAND
 852 #define LOCK_MAND       32      /* This is a mandatory flock */
 853 #define LOCK_READ       64      /* ... Which allows concurrent read operations */
 854 #define LOCK_WRITE      128     /* ... Which allows concurrent write operations */
 855 #define LOCK_RW         192     /* ... Which allows concurrent read & write ops */
 856 #endif
 857 #endif
 858
 859 extern int DEBUGLEVEL;
 860
 861 #define MAX_SEC_CTX_DEPTH 8    /* Maximum number of security contexts */
 862
 863
 864 #ifdef GLIBC_HACK_FCNTL64
 865 /* this is a gross hack. 64 bit locking is completely screwed up on
 866    i386 Linux in glibc 2.1.95 (which ships with RedHat 7.0). This hack
 867    "fixes" the problem with the current 2.4.0test kernels
 868 */
 869 #define fcntl fcntl64
 870 #undef F_SETLKW
 871 #undef F_SETLK
 872 #define F_SETLK 13
 873 #define F_SETLKW 14
 874 #endif
 875
 876
 877 /* needed for some systems without iconv. Doesn't really matter
 878    what error code we use */
 879 #ifndef EILSEQ
 880 #define EILSEQ EIO
 881 #endif
 882
 883 /* add varargs prototypes with printf checking */
 884 /*PRINTFLIKE2 */
 885 int fdprintf(int , const char *, ...) PRINTF_ATTRIBUTE(2,3);
 886 /*PRINTFLIKE1 */
 887 int d_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
 888 /*PRINTFLIKE2 */
 889 int d_fprintf(FILE *f, const char *, ...) PRINTF_ATTRIBUTE(2,3);
 890
 891 /* PRINTFLIKE2 */
 892 void sys_adminlog(int priority, const char *format_str, ...) PRINTF_ATTRIBUTE(2,3);
 893
 894 /* PRINTFLIKE2 */
 895 int fstr_sprintf(fstring s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 896
 897 int d_vfprintf(FILE *f, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 898
 899 int smb_xvasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 900
 901 int asprintf_strupper_m(char **strp, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 902 char *talloc_asprintf_strupper_m(TALLOC_CTX *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 903
 904 /*
 905  * Veritas File System.  Often in addition to native.
 906  * Quotas different.
 907  */
 908 #if defined(HAVE_SYS_FS_VX_QUOTA_H)
 909 #define VXFS_QUOTA
 910 #endif
 911
 912 #ifndef XATTR_CREATE
 913 #define XATTR_CREATE  0x1       /* set value, fail if attr already exists */
 914 #endif
 915
 916 #ifndef XATTR_REPLACE
 917 #define XATTR_REPLACE 0x2       /* set value, fail if attr does not exist */
 918 #endif
 919
 920 /*
 921  * This should be under the HAVE_KRB5 flag but since they're used
 922  * in lp_kerberos_method(), they ned to be always available
 923  */
 924 #define KERBEROS_VERIFY_SECRETS 0
 925 #define KERBEROS_VERIFY_SYSTEM_KEYTAB 1
 926 #define KERBEROS_VERIFY_DEDICATED_KEYTAB 2
 927 #define KERBEROS_VERIFY_SECRETS_AND_KEYTAB 3
 928
 929 /*
 930  * If you add any entries to the above, please modify the below expressions
 931  * so they remain accurate.
 932  */
 933 #define USE_KERBEROS_KEYTAB (KERBEROS_VERIFY_SECRETS != lp_kerberos_method())
 934 #define USE_SYSTEM_KEYTAB \
 935     ((KERBEROS_VERIFY_SECRETS_AND_KEYTAB == lp_kerberos_method()) || \
 936      (KERBEROS_VERIFY_SYSTEM_KEYTAB == lp_kerberos_method()))
 937
 938 #if defined(HAVE_KRB5)
 939 krb5_error_code smb_krb5_parse_name(krb5_context context,
 940                                 const char *name, /* in unix charset */
 941                                 krb5_principal *principal);
 942
 943 krb5_error_code smb_krb5_unparse_name(TALLOC_CTX *mem_ctx,
 944                                       krb5_context context,
 945                                       krb5_const_principal principal,
 946                                       char **unix_name);
 947
 948 #ifndef HAVE_KRB5_SET_REAL_TIME
 949 krb5_error_code krb5_set_real_time(krb5_context context, int32_t seconds, int32_t microseconds);
 950 #endif
 951
 952 krb5_error_code krb5_set_default_tgs_ktypes(krb5_context ctx, const krb5_enctype *enc);
 953
 954 #if defined(HAVE_KRB5_AUTH_CON_SETKEY) && !defined(HAVE_KRB5_AUTH_CON_SETUSERUSERKEY)
 955 krb5_error_code krb5_auth_con_setuseruserkey(krb5_context context, krb5_auth_context auth_context, krb5_keyblock *keyblock);
 956 #endif
 957
 958 #ifndef HAVE_KRB5_FREE_UNPARSED_NAME
 959 void krb5_free_unparsed_name(krb5_context ctx, char *val);
 960 #endif
 961
 962 /* Stub out initialize_krb5_error_table since it is not present in all
 963  * Kerberos implementations. If it's not present, it's not necessary to
 964  * call it.
 965  */
 966 #ifndef HAVE_INITIALIZE_KRB5_ERROR_TABLE
 967 #define initialize_krb5_error_table()
 968 #endif
 969
 970 /* Samba wrapper function for krb5 functionality. */
 971 bool setup_kaddr( krb5_address *pkaddr, struct sockaddr_storage *paddr);
 972 int create_kerberos_key_from_string(krb5_context context, krb5_principal host_princ, krb5_data *password, krb5_keyblock *key, krb5_enctype enctype, bool no_salt);
 973 bool get_auth_data_from_tkt(TALLOC_CTX *mem_ctx, DATA_BLOB *auth_data, krb5_ticket *tkt);
 974 krb5_const_principal get_principal_from_tkt(krb5_ticket *tkt);
 975 krb5_error_code smb_krb5_locate_kdc(krb5_context ctx, const krb5_data *realm, struct sockaddr **addr_pp, int *naddrs, int get_masters);
 976 #if defined(HAVE_KRB5_LOCATE_KDC)
 977 krb5_error_code krb5_locate_kdc(krb5_context ctx, const krb5_data *realm, struct sockaddr **addr_pp, int *naddrs, int get_masters);
 978 #endif
 979 krb5_error_code get_kerberos_allowed_etypes(krb5_context context, krb5_enctype **enctypes);
 980 bool get_krb5_smb_session_key(krb5_context context, krb5_auth_context auth_context, DATA_BLOB *session_key, bool remote);
 981 krb5_error_code smb_krb5_kt_free_entry(krb5_context context, krb5_keytab_entry *kt_entry);
 982 krb5_principal kerberos_fetch_salt_princ_for_host_princ(krb5_context context, krb5_principal host_princ, int enctype);
 983 void kerberos_set_creds_enctype(krb5_creds *pcreds, int enctype);
 984 bool kerberos_compatible_enctypes(krb5_context context, krb5_enctype enctype1, krb5_enctype enctype2);
 985 void kerberos_free_data_contents(krb5_context context, krb5_data *pdata);
 986 NTSTATUS decode_pac_data(TALLOC_CTX *mem_ctx,
 987                          DATA_BLOB *pac_data_blob,
 988                          krb5_context context,
 989                          krb5_keyblock *service_keyblock,
 990                          krb5_const_principal client_principal,
 991                          time_t tgs_authtime,
 992                          struct PAC_DATA **pac_data_out);
 993 void smb_krb5_checksum_from_pac_sig(krb5_checksum *cksum,
 994                                     struct PAC_SIGNATURE_DATA *sig);
 995 krb5_error_code smb_krb5_verify_checksum(krb5_context context,
 996                                          const krb5_keyblock *keyblock,
 997                                          krb5_keyusage usage,
 998                                          krb5_checksum *cksum,
 999                                          uint8 *data,
1000                                          size_t length);
1001 time_t get_authtime_from_tkt(krb5_ticket *tkt);
1002 void smb_krb5_free_ap_req(krb5_context context,
1003                           krb5_ap_req *ap_req);
1004 krb5_error_code smb_krb5_get_keyinfo_from_ap_req(krb5_context context,
1005                                                  const krb5_data *inbuf,
1006                                                  krb5_kvno *kvno,
1007                                                  krb5_enctype *enctype);
1008 krb5_error_code krb5_rd_req_return_keyblock_from_keytab(krb5_context context,
1009                                                         krb5_auth_context *auth_context,
1010                                                         const krb5_data *inbuf,
1011                                                         krb5_const_principal server,
1012                                                         krb5_keytab keytab,
1013                                                         krb5_flags *ap_req_options,
1014                                                         krb5_ticket **ticket,
1015                                                         krb5_keyblock **keyblock);
1016 krb5_error_code smb_krb5_parse_name_norealm(krb5_context context,
1017                                             const char *name,
1018                                             krb5_principal *principal);
1019 bool smb_krb5_principal_compare_any_realm(krb5_context context,
1020                                           krb5_const_principal princ1,
1021                                           krb5_const_principal princ2);
1022 int cli_krb5_get_ticket(const char *principal, time_t time_offset,
1023                         DATA_BLOB *ticket, DATA_BLOB *session_key_krb5, uint32 extra_ap_opts, const char *ccname, time_t *tgs_expire);
1024 krb5_error_code smb_krb5_renew_ticket(const char *ccache_string, const char *client_string, const char *service_string, time_t *expire_time);
1025 krb5_error_code kpasswd_err_to_krb5_err(krb5_error_code res_code);
1026 krb5_error_code smb_krb5_gen_netbios_krb5_address(smb_krb5_addresses **kerb_addr);
1027 krb5_error_code smb_krb5_free_addresses(krb5_context context, smb_krb5_addresses *addr);
1028 NTSTATUS krb5_to_nt_status(krb5_error_code kerberos_error);
1029 krb5_error_code nt_status_to_krb5(NTSTATUS nt_status);
1030 void smb_krb5_free_error(krb5_context context, krb5_error *krberror);
1031 krb5_error_code handle_krberror_packet(krb5_context context,
1032                                          krb5_data *packet);
1033
1034 void smb_krb5_get_init_creds_opt_free(krb5_context context,
1035                                     krb5_get_init_creds_opt *opt);
1036 krb5_error_code smb_krb5_get_init_creds_opt_alloc(krb5_context context,
1037                                     krb5_get_init_creds_opt **opt);
1038 krb5_error_code smb_krb5_mk_error(krb5_context context,
1039                                         krb5_error_code error_code,
1040                                         const krb5_principal server,
1041                                         krb5_data *reply);
1042 krb5_enctype smb_get_enctype_from_kt_entry(krb5_keytab_entry *kt_entry);
1043 krb5_error_code smb_krb5_enctype_to_string(krb5_context context,
1044                                             krb5_enctype enctype,
1045                                             char **etype_s);
1046 krb5_error_code smb_krb5_open_keytab(krb5_context context,
1047                                       const char *keytab_name,
1048                                       bool write_access,
1049                                       krb5_keytab *keytab);
1050 krb5_error_code smb_krb5_keytab_name(TALLOC_CTX *mem_ctx,
1051                                      krb5_context context,
1052                                      krb5_keytab keytab,
1053                                      const char **keytab_name);
1054 int smb_krb5_kt_add_entry_ext(krb5_context context,
1055                               krb5_keytab keytab,
1056                               krb5_kvno kvno,
1057                               const char *princ_s,
1058                               krb5_enctype *enctypes,
1059                               krb5_data password,
1060                               bool no_salt,
1061                               bool keep_old_entries);
1062
1063 #endif /* HAVE_KRB5 */
1064
1065
1066 #ifdef HAVE_LDAP
1067
1068 /* function declarations not included in proto.h */
1069 LDAP *ldap_open_with_timeout(const char *server, int port, unsigned int to);
1070
1071 #endif  /* HAVE_LDAP */
1072
1073 #if defined(HAVE_LINUX_READAHEAD) && ! defined(HAVE_READAHEAD_DECL)
1074 ssize_t readahead(int fd, off64_t offset, size_t count);
1075 #endif
1076
1077 #ifdef TRUE
1078 #undef TRUE
1079 #endif
1080 #define TRUE __ERROR__XX__DONT_USE_TRUE
1081
1082 #ifdef FALSE
1083 #undef FALSE
1084 #endif
1085 #define FALSE __ERROR__XX__DONT_USE_FALSE
1086
1087 /* If we have blacklisted mmap() try to avoid using it accidentally by
1088    undefining the HAVE_MMAP symbol. */
1089
1090 #ifdef MMAP_BLACKLIST
1091 #undef HAVE_MMAP
1092 #endif
1093
1094 #ifndef CONST_DISCARD
1095 #define CONST_DISCARD(type, ptr)      ((type) ((void *) (ptr)))
1096 #endif
1097
1098 void smb_panic( const char *why ) _NORETURN_;
1099 void dump_core(void) _NORETURN_;
1100 void exit_server(const char *const reason) _NORETURN_;
1101 void exit_server_cleanly(const char *const reason) _NORETURN_;
1102 void exit_server_fault(void) _NORETURN_;
1103
1104 #ifdef HAVE_LIBNSCD
1105 #include "libnscd.h"
1106 #endif
1107
1108 #if defined(HAVE_IPV6)
1109 void in6_addr_to_sockaddr_storage(struct sockaddr_storage *ss,
1110                                   struct in6_addr ip);
1111 #endif
1112
1113 #endif /* _INCLUDES_H */