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