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         /* Is birthtime real, or was it calculated ? */
 464         bool            st_ex_calculated_birthtime;
 465         blksize_t       st_ex_blksize;
 466         blkcnt_t        st_ex_blocks;
 467
 468         uint32_t        st_ex_flags;
 469         uint32_t        st_ex_mask;
 470
 471         /*
 472          * Add space for VFS internal extensions. The initial user of this
 473          * would be the onefs modules, passing the snapid from the stat calls
 474          * to the file_id_create call. Maybe we'll have to expand this later,
 475          * but the core of Samba should never look at this field.
 476          */
 477         uint64_t vfs_private;
 478 };
 479
 480 typedef struct stat_ex SMB_STRUCT_STAT;
 481
 482 /*
 483  * Type for dirent structure.
 484  */
 485
 486 #ifndef SMB_STRUCT_DIRENT
 487 #  if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_DIRENT64)
 488 #    define SMB_STRUCT_DIRENT struct dirent64
 489 #  else
 490 #    define SMB_STRUCT_DIRENT struct dirent
 491 #  endif
 492 #endif
 493
 494 /*
 495  * Type for DIR structure.
 496  */
 497
 498 #ifndef SMB_STRUCT_DIR
 499 #  if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_DIR64)
 500 #    define SMB_STRUCT_DIR DIR64
 501 #  else
 502 #    define SMB_STRUCT_DIR DIR
 503 #  endif
 504 #endif
 505
 506 /*
 507  * Defines for 64 bit fcntl locks.
 508  */
 509
 510 #ifndef SMB_STRUCT_FLOCK
 511 #  if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
 512 #    define SMB_STRUCT_FLOCK struct flock64
 513 #  else
 514 #    define SMB_STRUCT_FLOCK struct flock
 515 #  endif
 516 #endif
 517
 518 #ifndef SMB_F_SETLKW
 519 #  if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
 520 #    define SMB_F_SETLKW F_SETLKW64
 521 #  else
 522 #    define SMB_F_SETLKW F_SETLKW
 523 #  endif
 524 #endif
 525
 526 #ifndef SMB_F_SETLK
 527 #  if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
 528 #    define SMB_F_SETLK F_SETLK64
 529 #  else
 530 #    define SMB_F_SETLK F_SETLK
 531 #  endif
 532 #endif
 533
 534 #ifndef SMB_F_GETLK
 535 #  if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
 536 #    define SMB_F_GETLK F_GETLK64
 537 #  else
 538 #    define SMB_F_GETLK F_GETLK
 539 #  endif
 540 #endif
 541
 542 /*
 543  * Type for aiocb structure.
 544  */
 545
 546 #ifndef SMB_STRUCT_AIOCB
 547 #  if defined(WITH_AIO)
 548 #    if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_AIOCB64)
 549 #      define SMB_STRUCT_AIOCB struct aiocb64
 550 #    else
 551 #      define SMB_STRUCT_AIOCB struct aiocb
 552 #    endif
 553 #  else
 554 #    define SMB_STRUCT_AIOCB int /* AIO not being used but we still need the define.... */
 555 #  endif
 556 #endif
 557
 558 #ifndef HAVE_STRUCT_TIMESPEC
 559 struct timespec {
 560         time_t tv_sec;            /* Seconds.  */
 561         long tv_nsec;           /* Nanoseconds.  */
 562 };
 563 #endif
 564
 565 #ifdef HAVE_BROKEN_GETGROUPS
 566 #define GID_T int
 567 #else
 568 #define GID_T gid_t
 569 #endif
 570
 571 #ifndef NGROUPS_MAX
 572 #define NGROUPS_MAX 32 /* Guess... */
 573 #endif
 574
 575 /* Our own fstrings */
 576
 577 /*
 578                   --------------
 579                  /              \
 580                 /      REST      \
 581                /        IN        \
 582               /       PEACE        \
 583              /                      \
 584              | The infamous pstring |
 585              |                      |
 586              |                      |
 587              |      7 December      |
 588              |                      |
 589              |         2007         |
 590             *|     *  *  *          | *
 591    _________)/\\_//(\/(/\)/\//\/\///|_)_______
 592 */
 593
 594 #ifndef FSTRING_LEN
 595 #define FSTRING_LEN 256
 596 typedef char fstring[FSTRING_LEN];
 597 #endif
 598
 599 /* Samba 3 doesn't use iconv_convenience: */
 600 extern void *cmdline_lp_ctx;
 601 struct smb_iconv_convenience *lp_iconv_convenience(void *lp_ctx);
 602
 603 /* Lists, trees, caching, database... */
 604 #include "../lib/util/util.h"
 605 #include "../lib/util/xfile.h"
 606 #include "../lib/util/memory.h"
 607 #include "../lib/util/attr.h"
 608 #include "intl.h"
 609 #include "../lib/util/dlinklist.h"
 610 #include "tdb.h"
 611 #include "util_tdb.h"
 612
 613 #include "../talloc/talloc.h"
 614
 615 #include "event.h"
 616 #include "../lib/util/tevent_unix.h"
 617 #include "../lib/util/tevent_ntstatus.h"
 618 #include "../lib/tsocket/tsocket.h"
 619
 620 #include "../lib/util/data_blob.h"
 621 #include "../lib/util/time.h"
 622 #include "../lib/util/asn1.h"
 623
 624 #include "ads.h"
 625 #include "ads_dns.h"
 626 #include "interfaces.h"
 627 #include "trans2.h"
 628 #include "../libcli/util/error.h"
 629 #include "ntioctl.h"
 630 #include "../lib/util/charset/charset.h"
 631 #include "dynconfig.h"
 632 #include "util_getent.h"
 633 #include "debugparse.h"
 634 #include "privileges.h"
 635 #include "messages.h"
 636 #include "locking.h"
 637 #include "smb_perfcount.h"
 638 #include "smb_signing.h"
 639 #include "smb.h"
 640 #include "nameserv.h"
 641 #include "secrets.h"
 642 #include "../lib/util/byteorder.h"
 643 #include "privileges.h"
 644 #include "rpc_misc.h"
 645 #include "rpc_dce.h"
 646 #include "mapping.h"
 647 #include "passdb.h"
 648 #include "rpc_secdes.h"
 649 #include "../libgpo/gpo.h"
 650 #include "authdata.h"
 651 #include "msdfs.h"
 652 #include "rap.h"
 653 #include "../lib/crypto/md5.h"
 654 #include "../lib/crypto/md4.h"
 655 #include "../lib/crypto/arcfour.h"
 656 #include "../lib/crypto/crc32.h"
 657 #include "../lib/crypto/hmacmd5.h"
 658 #include "ntlmssp.h"
 659 #include "auth.h"
 660 #include "ntdomain.h"
 661 #include "reg_objects.h"
 662 #include "reg_db.h"
 663 #include "rpc_perfcount.h"
 664 #include "rpc_perfcount_defs.h"
 665 #include "librpc/gen_ndr/notify.h"
 666 #include "librpc/gen_ndr/xattr.h"
 667 #include "librpc/gen_ndr/messaging.h"
 668 #include "librpc/gen_ndr/ndr_nbt.h"
 669 #include "librpc/rpc/dcerpc.h"
 670 #include "nt_printing.h"
 671 #include "idmap.h"
 672 #include "client.h"
 673
 674 #include "session.h"
 675 #include "popt.h"
 676 #include "mangle.h"
 677 #include "module.h"
 678 #include "nsswitch/winbind_client.h"
 679 #include "spnego.h"
 680 #include "rpc_client.h"
 681 #include "dbwrap.h"
 682 #include "packet.h"
 683 #include "ctdbd_conn.h"
 684 #include "../lib/util/talloc_stack.h"
 685 #include "memcache.h"
 686 #include "async_smb.h"
 687 #include "../lib/async_req/async_sock.h"
 688 #include "services.h"
 689 #include "eventlog.h"
 690 #include "../lib/util/smb_threads.h"
 691 #include "../lib/util/smb_threads_internal.h"
 692 #include "tldap.h"
 693 #include "tldap_util.h"
 694
 695 #include "lib/smbconf/smbconf.h"
 696 #include "lib/smbconf/smbconf_init.h"
 697 #include "lib/smbconf/smbconf_reg.h"
 698 #include "lib/smbconf/smbconf_txt.h"
 699
 700 /* Defines for wisXXX functions. */
 701 #define UNI_UPPER    0x1
 702 #define UNI_LOWER    0x2
 703 #define UNI_DIGIT    0x4
 704 #define UNI_XDIGIT   0x8
 705 #define UNI_SPACE    0x10
 706
 707 #include "nsswitch/winbind_nss.h"
 708
 709 /* forward declaration from printing.h to get around
 710    header file dependencies */
 711
 712 struct printjob;
 713
 714 /* forward declarations from smbldap.c */
 715
 716 #include "smbldap.h"
 717
 718 /*
 719  * Reasons for cache flush.
 720  */
 721
 722 enum flush_reason_enum {
 723     SEEK_FLUSH,
 724     READ_FLUSH,
 725     WRITE_FLUSH,
 726     READRAW_FLUSH,
 727     OPLOCK_RELEASE_FLUSH,
 728     CLOSE_FLUSH,
 729     SYNC_FLUSH,
 730     SIZECHANGE_FLUSH,
 731     /* NUM_FLUSH_REASONS must remain the last value in the enumeration. */
 732     NUM_FLUSH_REASONS};
 733
 734 #include "nss_info.h"
 735 #include "modules/nfs4_acls.h"
 736 #include "nsswitch/libwbclient/wbclient.h"
 737
 738 /***** prototypes *****/
 739 #ifndef NO_PROTO_H
 740 #include "proto.h"
 741 #endif
 742 #include "libcli/security/secace.h"
 743 #include "libcli/security/secacl.h"
 744 #include "libcli/security/security_descriptor.h"
 745
 746 #if defined(HAVE_POSIX_ACLS)
 747 #include "modules/vfs_posixacl.h"
 748 #endif
 749
 750 #if defined(HAVE_TRU64_ACLS)
 751 #include "modules/vfs_tru64acl.h"
 752 #endif
 753
 754 #if defined(HAVE_SOLARIS_ACLS) || defined(HAVE_UNIXWARE_ACLS)
 755 #include "modules/vfs_solarisacl.h"
 756 #endif
 757
 758 #if defined(HAVE_HPUX_ACLS)
 759 #include "modules/vfs_hpuxacl.h"
 760 #endif
 761
 762 #if defined(HAVE_IRIX_ACLS)
 763 #include "modules/vfs_irixacl.h"
 764 #endif
 765
 766 #ifdef HAVE_LDAP
 767 #include "ads_protos.h"
 768 #endif
 769
 770 /* We need this after proto.h to reference GetTimeOfDay(). */
 771 #include "smbprofile.h"
 772
 773 /* String routines */
 774
 775 #include "srvstr.h"
 776 #include "safe_string.h"
 777
 778 /* prototypes from lib/util_transfer_file.c */
 779 #include "transfer_file.h"
 780
 781 #ifndef DEFAULT_PRINTING
 782 #ifdef HAVE_CUPS
 783 #define DEFAULT_PRINTING PRINT_CUPS
 784 #define PRINTCAP_NAME "cups"
 785 #elif defined(SYSV)
 786 #define DEFAULT_PRINTING PRINT_SYSV
 787 #define PRINTCAP_NAME "lpstat"
 788 #else
 789 #define DEFAULT_PRINTING PRINT_BSD
 790 #define PRINTCAP_NAME "/etc/printcap"
 791 #endif
 792 #endif
 793
 794 #ifndef PRINTCAP_NAME
 795 #define PRINTCAP_NAME "/etc/printcap"
 796 #endif
 797
 798 #ifndef SIGCLD
 799 #define SIGCLD SIGCHLD
 800 #endif
 801
 802 #ifndef SIGRTMIN
 803 #define SIGRTMIN NSIG
 804 #endif
 805
 806 #ifndef MAP_FILE
 807 #define MAP_FILE 0
 808 #endif
 809
 810 #if defined(HAVE_PUTPRPWNAM) && defined(AUTH_CLEARTEXT_SEG_CHARS)
 811 #define OSF1_ENH_SEC 1
 812 #endif
 813
 814 #ifndef ALLOW_CHANGE_PASSWORD
 815 #if (defined(HAVE_TERMIOS_H) && defined(HAVE_DUP2) && defined(HAVE_SETSID))
 816 #define ALLOW_CHANGE_PASSWORD 1
 817 #endif
 818 #endif
 819
 820 /* what is the longest significant password available on your system?
 821  Knowing this speeds up password searches a lot */
 822 #ifndef PASSWORD_LENGTH
 823 #define PASSWORD_LENGTH 8
 824 #endif
 825
 826 #ifndef HAVE_PIPE
 827 #define SYNC_DNS 1
 828 #endif
 829
 830 #if defined(HAVE_CRYPT16) && defined(HAVE_GETAUTHUID)
 831 #define ULTRIX_AUTH 1
 832 #endif
 833
 834 /* yuck, I'd like a better way of doing this */
 835 #define DIRP_SIZE (256 + 32)
 836
 837 /* default socket options. Dave Miller thinks we should default to TCP_NODELAY
 838    given the socket IO pattern that Samba uses */
 839 #ifdef TCP_NODELAY
 840 #define DEFAULT_SOCKET_OPTIONS "TCP_NODELAY"
 841 #else
 842 #define DEFAULT_SOCKET_OPTIONS ""
 843 #endif
 844
 845 /* dmalloc -- free heap debugger (dmalloc.org).  This should be near
 846  * the *bottom* of include files so as not to conflict. */
 847 #ifdef ENABLE_DMALLOC
 848 #  include <dmalloc.h>
 849 #endif
 850
 851
 852 #if HAVE_KERNEL_SHARE_MODES
 853 #ifndef LOCK_MAND
 854 #define LOCK_MAND       32      /* This is a mandatory flock */
 855 #define LOCK_READ       64      /* ... Which allows concurrent read operations */
 856 #define LOCK_WRITE      128     /* ... Which allows concurrent write operations */
 857 #define LOCK_RW         192     /* ... Which allows concurrent read & write ops */
 858 #endif
 859 #endif
 860
 861 extern int DEBUGLEVEL;
 862
 863 #define MAX_SEC_CTX_DEPTH 8    /* Maximum number of security contexts */
 864
 865
 866 #ifdef GLIBC_HACK_FCNTL64
 867 /* this is a gross hack. 64 bit locking is completely screwed up on
 868    i386 Linux in glibc 2.1.95 (which ships with RedHat 7.0). This hack
 869    "fixes" the problem with the current 2.4.0test kernels
 870 */
 871 #define fcntl fcntl64
 872 #undef F_SETLKW
 873 #undef F_SETLK
 874 #define F_SETLK 13
 875 #define F_SETLKW 14
 876 #endif
 877
 878
 879 /* needed for some systems without iconv. Doesn't really matter
 880    what error code we use */
 881 #ifndef EILSEQ
 882 #define EILSEQ EIO
 883 #endif
 884
 885 /* add varargs prototypes with printf checking */
 886 /*PRINTFLIKE2 */
 887 int fdprintf(int , const char *, ...) PRINTF_ATTRIBUTE(2,3);
 888 /*PRINTFLIKE1 */
 889 int d_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
 890 /*PRINTFLIKE2 */
 891 int d_fprintf(FILE *f, const char *, ...) PRINTF_ATTRIBUTE(2,3);
 892
 893 /* PRINTFLIKE2 */
 894 void sys_adminlog(int priority, const char *format_str, ...) PRINTF_ATTRIBUTE(2,3);
 895
 896 /* PRINTFLIKE2 */
 897 int fstr_sprintf(fstring s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 898
 899 int d_vfprintf(FILE *f, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 900
 901 int smb_xvasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
 902
 903 int asprintf_strupper_m(char **strp, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 904 char *talloc_asprintf_strupper_m(TALLOC_CTX *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 905
 906 /*
 907  * Veritas File System.  Often in addition to native.
 908  * Quotas different.
 909  */
 910 #if defined(HAVE_SYS_FS_VX_QUOTA_H)
 911 #define VXFS_QUOTA
 912 #endif
 913
 914 #ifndef XATTR_CREATE
 915 #define XATTR_CREATE  0x1       /* set value, fail if attr already exists */
 916 #endif
 917
 918 #ifndef XATTR_REPLACE
 919 #define XATTR_REPLACE 0x2       /* set value, fail if attr does not exist */
 920 #endif
 921
 922 /*
 923  * This should be under the HAVE_KRB5 flag but since they're used
 924  * in lp_kerberos_method(), they ned to be always available
 925  */
 926 #define KERBEROS_VERIFY_SECRETS 0
 927 #define KERBEROS_VERIFY_SYSTEM_KEYTAB 1
 928 #define KERBEROS_VERIFY_DEDICATED_KEYTAB 2
 929 #define KERBEROS_VERIFY_SECRETS_AND_KEYTAB 3
 930
 931 /*
 932  * If you add any entries to the above, please modify the below expressions
 933  * so they remain accurate.
 934  */
 935 #define USE_KERBEROS_KEYTAB (KERBEROS_VERIFY_SECRETS != lp_kerberos_method())
 936 #define USE_SYSTEM_KEYTAB \
 937     ((KERBEROS_VERIFY_SECRETS_AND_KEYTAB == lp_kerberos_method()) || \
 938      (KERBEROS_VERIFY_SYSTEM_KEYTAB == lp_kerberos_method()))
 939
 940 #if defined(HAVE_KRB5)
 941 krb5_error_code smb_krb5_parse_name(krb5_context context,
 942                                 const char *name, /* in unix charset */
 943                                 krb5_principal *principal);
 944
 945 krb5_error_code smb_krb5_unparse_name(TALLOC_CTX *mem_ctx,
 946                                       krb5_context context,
 947                                       krb5_const_principal principal,
 948                                       char **unix_name);
 949
 950 #ifndef HAVE_KRB5_SET_REAL_TIME
 951 krb5_error_code krb5_set_real_time(krb5_context context, int32_t seconds, int32_t microseconds);
 952 #endif
 953
 954 krb5_error_code krb5_set_default_tgs_ktypes(krb5_context ctx, const krb5_enctype *enc);
 955
 956 #if defined(HAVE_KRB5_AUTH_CON_SETKEY) && !defined(HAVE_KRB5_AUTH_CON_SETUSERUSERKEY)
 957 krb5_error_code krb5_auth_con_setuseruserkey(krb5_context context, krb5_auth_context auth_context, krb5_keyblock *keyblock);
 958 #endif
 959
 960 #ifndef HAVE_KRB5_FREE_UNPARSED_NAME
 961 void krb5_free_unparsed_name(krb5_context ctx, char *val);
 962 #endif
 963
 964 /* Stub out initialize_krb5_error_table since it is not present in all
 965  * Kerberos implementations. If it's not present, it's not necessary to
 966  * call it.
 967  */
 968 #ifndef HAVE_INITIALIZE_KRB5_ERROR_TABLE
 969 #define initialize_krb5_error_table()
 970 #endif
 971
 972 /* Samba wrapper function for krb5 functionality. */
 973 bool setup_kaddr( krb5_address *pkaddr, struct sockaddr_storage *paddr);
 974 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);
 975 bool get_auth_data_from_tkt(TALLOC_CTX *mem_ctx, DATA_BLOB *auth_data, krb5_ticket *tkt);
 976 krb5_const_principal get_principal_from_tkt(krb5_ticket *tkt);
 977 krb5_error_code smb_krb5_locate_kdc(krb5_context ctx, const krb5_data *realm, struct sockaddr **addr_pp, int *naddrs, int get_masters);
 978 #if defined(HAVE_KRB5_LOCATE_KDC)
 979 krb5_error_code krb5_locate_kdc(krb5_context ctx, const krb5_data *realm, struct sockaddr **addr_pp, int *naddrs, int get_masters);
 980 #endif
 981 krb5_error_code get_kerberos_allowed_etypes(krb5_context context, krb5_enctype **enctypes);
 982 bool get_krb5_smb_session_key(krb5_context context, krb5_auth_context auth_context, DATA_BLOB *session_key, bool remote);
 983 krb5_error_code smb_krb5_kt_free_entry(krb5_context context, krb5_keytab_entry *kt_entry);
 984 krb5_principal kerberos_fetch_salt_princ_for_host_princ(krb5_context context, krb5_principal host_princ, int enctype);
 985 void kerberos_set_creds_enctype(krb5_creds *pcreds, int enctype);
 986 bool kerberos_compatible_enctypes(krb5_context context, krb5_enctype enctype1, krb5_enctype enctype2);
 987 void kerberos_free_data_contents(krb5_context context, krb5_data *pdata);
 988 NTSTATUS decode_pac_data(TALLOC_CTX *mem_ctx,
 989                          DATA_BLOB *pac_data_blob,
 990                          krb5_context context,
 991                          krb5_keyblock *service_keyblock,
 992                          krb5_const_principal client_principal,
 993                          time_t tgs_authtime,
 994                          struct PAC_DATA **pac_data_out);
 995 void smb_krb5_checksum_from_pac_sig(krb5_checksum *cksum,
 996                                     struct PAC_SIGNATURE_DATA *sig);
 997 krb5_error_code smb_krb5_verify_checksum(krb5_context context,
 998                                          const krb5_keyblock *keyblock,
 999                                          krb5_keyusage usage,
1000                                          krb5_checksum *cksum,
1001                                          uint8 *data,
1002                                          size_t length);
1003 time_t get_authtime_from_tkt(krb5_ticket *tkt);
1004 void smb_krb5_free_ap_req(krb5_context context,
1005                           krb5_ap_req *ap_req);
1006 krb5_error_code smb_krb5_get_keyinfo_from_ap_req(krb5_context context,
1007                                                  const krb5_data *inbuf,
1008                                                  krb5_kvno *kvno,
1009                                                  krb5_enctype *enctype);
1010 krb5_error_code krb5_rd_req_return_keyblock_from_keytab(krb5_context context,
1011                                                         krb5_auth_context *auth_context,
1012                                                         const krb5_data *inbuf,
1013                                                         krb5_const_principal server,
1014                                                         krb5_keytab keytab,
1015                                                         krb5_flags *ap_req_options,
1016                                                         krb5_ticket **ticket,
1017                                                         krb5_keyblock **keyblock);
1018 krb5_error_code smb_krb5_parse_name_norealm(krb5_context context,
1019                                             const char *name,
1020                                             krb5_principal *principal);
1021 bool smb_krb5_principal_compare_any_realm(krb5_context context,
1022                                           krb5_const_principal princ1,
1023                                           krb5_const_principal princ2);
1024 int cli_krb5_get_ticket(const char *principal, time_t time_offset,
1025                         DATA_BLOB *ticket, DATA_BLOB *session_key_krb5, uint32 extra_ap_opts, const char *ccname, time_t *tgs_expire);
1026 krb5_error_code smb_krb5_renew_ticket(const char *ccache_string, const char *client_string, const char *service_string, time_t *expire_time);
1027 krb5_error_code kpasswd_err_to_krb5_err(krb5_error_code res_code);
1028 krb5_error_code smb_krb5_gen_netbios_krb5_address(smb_krb5_addresses **kerb_addr);
1029 krb5_error_code smb_krb5_free_addresses(krb5_context context, smb_krb5_addresses *addr);
1030 NTSTATUS krb5_to_nt_status(krb5_error_code kerberos_error);
1031 krb5_error_code nt_status_to_krb5(NTSTATUS nt_status);
1032 void smb_krb5_free_error(krb5_context context, krb5_error *krberror);
1033 krb5_error_code handle_krberror_packet(krb5_context context,
1034                                          krb5_data *packet);
1035
1036 void smb_krb5_get_init_creds_opt_free(krb5_context context,
1037                                     krb5_get_init_creds_opt *opt);
1038 krb5_error_code smb_krb5_get_init_creds_opt_alloc(krb5_context context,
1039                                     krb5_get_init_creds_opt **opt);
1040 krb5_error_code smb_krb5_mk_error(krb5_context context,
1041                                         krb5_error_code error_code,
1042                                         const krb5_principal server,
1043                                         krb5_data *reply);
1044 krb5_enctype smb_get_enctype_from_kt_entry(krb5_keytab_entry *kt_entry);
1045 krb5_error_code smb_krb5_enctype_to_string(krb5_context context,
1046                                             krb5_enctype enctype,
1047                                             char **etype_s);
1048 krb5_error_code smb_krb5_open_keytab(krb5_context context,
1049                                       const char *keytab_name,
1050                                       bool write_access,
1051                                       krb5_keytab *keytab);
1052 krb5_error_code smb_krb5_keytab_name(TALLOC_CTX *mem_ctx,
1053                                      krb5_context context,
1054                                      krb5_keytab keytab,
1055                                      const char **keytab_name);
1056 int smb_krb5_kt_add_entry_ext(krb5_context context,
1057                               krb5_keytab keytab,
1058                               krb5_kvno kvno,
1059                               const char *princ_s,
1060                               krb5_enctype *enctypes,
1061                               krb5_data password,
1062                               bool no_salt,
1063                               bool keep_old_entries);
1064
1065 #endif /* HAVE_KRB5 */
1066
1067
1068 #ifdef HAVE_LDAP
1069
1070 /* function declarations not included in proto.h */
1071 LDAP *ldap_open_with_timeout(const char *server, int port, unsigned int to);
1072
1073 #endif  /* HAVE_LDAP */
1074
1075 #if defined(HAVE_LINUX_READAHEAD) && ! defined(HAVE_READAHEAD_DECL)
1076 ssize_t readahead(int fd, off64_t offset, size_t count);
1077 #endif
1078
1079 #ifdef TRUE
1080 #undef TRUE
1081 #endif
1082 #define TRUE __ERROR__XX__DONT_USE_TRUE
1083
1084 #ifdef FALSE
1085 #undef FALSE
1086 #endif
1087 #define FALSE __ERROR__XX__DONT_USE_FALSE
1088
1089 /* If we have blacklisted mmap() try to avoid using it accidentally by
1090    undefining the HAVE_MMAP symbol. */
1091
1092 #ifdef MMAP_BLACKLIST
1093 #undef HAVE_MMAP
1094 #endif
1095
1096 #ifndef CONST_DISCARD
1097 #define CONST_DISCARD(type, ptr)      ((type) ((void *) (ptr)))
1098 #endif
1099
1100 void smb_panic( const char *why ) _NORETURN_;
1101 void dump_core(void) _NORETURN_;
1102 void exit_server(const char *const reason) _NORETURN_;
1103 void exit_server_cleanly(const char *const reason) _NORETURN_;
1104 void exit_server_fault(void) _NORETURN_;
1105
1106 #ifdef HAVE_LIBNSCD
1107 #include "libnscd.h"
1108 #endif
1109
1110 #if defined(HAVE_IPV6)
1111 void in6_addr_to_sockaddr_storage(struct sockaddr_storage *ss,
1112                                   struct in6_addr ip);
1113 #endif
1114
1115 #endif /* _INCLUDES_H */