source3/include/smb.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB parameters and setup, plus a whole lot more.
   4
   5    Copyright (C) Andrew Tridgell              1992-2000
   6    Copyright (C) John H Terpstra              1996-2002
   7    Copyright (C) Luke Kenneth Casson Leighton 1996-2000
   8    Copyright (C) Paul Ashton                  1998-2000
   9    Copyright (C) Simo Sorce                   2001-2002
  10    Copyright (C) Martin Pool                  2002
  11
  12    This program is free software; you can redistribute it and/or modify
  13    it under the terms of the GNU General Public License as published by
  14    the Free Software Foundation; either version 3 of the License, or
  15    (at your option) any later version.
  16
  17    This program is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20    GNU General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public License
  23    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24 */
  25
  26 #ifndef _SMB_H
  27 #define _SMB_H
  28
  29 /* logged when starting the various Samba daemons */
  30 #define COPYRIGHT_STARTUP_MESSAGE       "Copyright Andrew Tridgell and the Samba Team 1992-2008"
  31
  32
  33 #if defined(LARGE_SMB_OFF_T)
  34 #define BUFFER_SIZE (128*1024)
  35 #else /* no large readwrite possible */
  36 #define BUFFER_SIZE (0xFFFF)
  37 #endif
  38
  39 #define SAFETY_MARGIN 1024
  40 #define LARGE_WRITEX_HDR_SIZE 65
  41
  42 #define NMB_PORT 137
  43 #define DGRAM_PORT 138
  44 #define SMB_PORT1 445
  45 #define SMB_PORT2 139
  46 #define SMB_PORTS "445 139"
  47
  48 #define Undefined (-1)
  49 #define False false
  50 #define True true
  51 #define Auto (2)
  52 #define Required (3)
  53
  54 #define SIZEOFWORD 2
  55
  56 #ifndef DEF_CREATE_MASK
  57 #define DEF_CREATE_MASK (0755)
  58 #endif
  59
  60 /* string manipulation flags - see clistr.c and srvstr.c */
  61 #define STR_TERMINATE 1
  62 #define STR_UPPER 2
  63 #define STR_ASCII 4
  64 #define STR_UNICODE 8
  65 #define STR_NOALIGN 16
  66 #define STR_TERMINATE_ASCII 128
  67
  68 /* how long to wait for secondary SMB packets (milli-seconds) */
  69 #define SMB_SECONDARY_WAIT (60*1000)
  70
  71 /* Debugging stuff */
  72 #include "debug.h"
  73
  74 /* this defines the error codes that receive_smb can put in smb_read_error */
  75 enum smb_read_errors {
  76         SMB_READ_OK = 0,
  77         SMB_READ_TIMEOUT,
  78         SMB_READ_EOF,
  79         SMB_READ_ERROR,
  80         SMB_WRITE_ERROR, /* This error code can go into the client smb_rw_error. */
  81         SMB_READ_BAD_SIG,
  82         SMB_NO_MEMORY,
  83         SMB_DO_NOT_DO_TDIS, /* cli_close_connection() check for this when smbfs wants to keep tree connected */
  84         SMB_READ_BAD_DECRYPT
  85 };
  86
  87 #define DIR_STRUCT_SIZE 43
  88
  89 /* these define the attribute byte as seen by DOS */
  90 #define aRONLY (1L<<0)          /* 0x01 */
  91 #define aHIDDEN (1L<<1)         /* 0x02 */
  92 #define aSYSTEM (1L<<2)         /* 0x04 */
  93 #define aVOLID (1L<<3)          /* 0x08 */
  94 #define aDIR (1L<<4)            /* 0x10 */
  95 #define aARCH (1L<<5)           /* 0x20 */
  96
  97 /* deny modes */
  98 #define DENY_DOS 0
  99 #define DENY_ALL 1
 100 #define DENY_WRITE 2
 101 #define DENY_READ 3
 102 #define DENY_NONE 4
 103 #define DENY_FCB 7
 104
 105 /* open modes */
 106 #define DOS_OPEN_RDONLY 0
 107 #define DOS_OPEN_WRONLY 1
 108 #define DOS_OPEN_RDWR 2
 109 #define DOS_OPEN_EXEC 3
 110 #define DOS_OPEN_FCB 0xF
 111
 112 /* define shifts and masks for share and open modes. */
 113 #define OPENX_MODE_MASK 0xF
 114 #define DENY_MODE_SHIFT 4
 115 #define DENY_MODE_MASK 0x7
 116 #define GET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
 117 #define SET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
 118 #define GET_DENY_MODE(x) (((x)>>DENY_MODE_SHIFT) & DENY_MODE_MASK)
 119 #define SET_DENY_MODE(x) (((x) & DENY_MODE_MASK) <<DENY_MODE_SHIFT)
 120
 121 /* Sync on open file (not sure if used anymore... ?) */
 122 #define FILE_SYNC_OPENMODE (1<<14)
 123 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
 124
 125 /* open disposition values */
 126 #define OPENX_FILE_EXISTS_FAIL 0
 127 #define OPENX_FILE_EXISTS_OPEN 1
 128 #define OPENX_FILE_EXISTS_TRUNCATE 2
 129
 130 /* mask for open disposition. */
 131 #define OPENX_FILE_OPEN_MASK 0x3
 132
 133 #define GET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
 134 #define SET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
 135
 136 /* The above can be OR'ed with... */
 137 #define OPENX_FILE_CREATE_IF_NOT_EXIST 0x10
 138 #define OPENX_FILE_FAIL_IF_NOT_EXIST 0
 139
 140 #include "doserr.h"
 141
 142 typedef union unid_t {
 143         uid_t uid;
 144         gid_t gid;
 145 } unid_t;
 146
 147 /*
 148  * SMB UCS2 (16-bit unicode) internal type.
 149  * smb_ucs2_t is *always* in little endian format.
 150  */
 151
 152 typedef uint16 smb_ucs2_t;
 153
 154 #ifdef WORDS_BIGENDIAN
 155 #define UCS2_SHIFT 8
 156 #else
 157 #define UCS2_SHIFT 0
 158 #endif
 159
 160 /* turn a 7 bit character into a ucs2 character */
 161 #define UCS2_CHAR(c) ((c) << UCS2_SHIFT)
 162
 163 /* return an ascii version of a ucs2 character */
 164 #define UCS2_TO_CHAR(c) (((c) >> UCS2_SHIFT) & 0xff)
 165
 166 /* Copy into a smb_ucs2_t from a possibly unaligned buffer. Return the copied smb_ucs2_t */
 167 #define COPY_UCS2_CHAR(dest,src) (((unsigned char *)(dest))[0] = ((unsigned char *)(src))[0],\
 168                                 ((unsigned char *)(dest))[1] = ((unsigned char *)(src))[1], (dest))
 169
 170 /* Large data type for manipulating uint32 unicode codepoints */
 171 typedef uint32 codepoint_t;
 172 #define INVALID_CODEPOINT ((codepoint_t)-1)
 173
 174 /* pipe string names */
 175 #define PIPE_LANMAN   "\\PIPE\\LANMAN"
 176 #define PIPE_SRVSVC   "\\PIPE\\srvsvc"
 177 #define PIPE_SAMR     "\\PIPE\\samr"
 178 #define PIPE_WINREG   "\\PIPE\\winreg"
 179 #define PIPE_WKSSVC   "\\PIPE\\wkssvc"
 180 #define PIPE_NETLOGON "\\PIPE\\NETLOGON"
 181 #define PIPE_NTLSA    "\\PIPE\\ntlsa"
 182 #define PIPE_NTSVCS   "\\PIPE\\ntsvcs"
 183 #define PIPE_LSASS    "\\PIPE\\lsass"
 184 #define PIPE_LSARPC   "\\PIPE\\lsarpc"
 185 #define PIPE_SPOOLSS  "\\PIPE\\spoolss"
 186 #define PIPE_NETDFS   "\\PIPE\\netdfs"
 187 #define PIPE_ECHO     "\\PIPE\\rpcecho"
 188 #define PIPE_SHUTDOWN "\\PIPE\\initshutdown"
 189 #define PIPE_EPM      "\\PIPE\\epmapper"
 190 #define PIPE_SVCCTL   "\\PIPE\\svcctl"
 191 #define PIPE_EVENTLOG "\\PIPE\\eventlog"
 192
 193 #define PIPE_NETLOGON_PLAIN "\\NETLOGON"
 194
 195 #define PI_LSARPC               0
 196 #define PI_DSSETUP              1
 197 #define PI_SAMR                 2
 198 #define PI_NETLOGON             3
 199 #define PI_SRVSVC               4
 200 #define PI_WKSSVC               5
 201 #define PI_WINREG               6
 202 #define PI_SPOOLSS              7
 203 #define PI_NETDFS               8
 204 #define PI_RPCECHO              9
 205 #define PI_INITSHUTDOWN         10
 206 #define PI_SVCCTL               11
 207 #define PI_EVENTLOG             12
 208 #define PI_NTSVCS               13
 209 #define PI_MAX_PIPES            14
 210
 211 /* 64 bit time (100usec) since ????? - cifs6.txt, section 3.5, page 30 */
 212 typedef uint64_t NTTIME;
 213
 214 #define MAX_HOURS_LEN 32
 215
 216 #ifndef MAXSUBAUTHS
 217 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
 218 #endif
 219
 220 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
 221
 222 #define LOOKUP_NAME_NONE                0x00000000
 223 #define LOOKUP_NAME_ISOLATED             0x00000001  /* Look up unqualified names */
 224 #define LOOKUP_NAME_REMOTE               0x00000002  /* Ask others */
 225 #define LOOKUP_NAME_GROUP                0x00000004  /* (unused) This is a NASTY hack for
 226                                                         valid users = @foo where foo also
 227                                                         exists in as user. */
 228 #define LOOKUP_NAME_EXPLICIT             0x00000008  /* Only include
 229                                                         explicitly mapped names and not
 230                                                         the Unix {User,Group} domain */
 231 #define LOOKUP_NAME_BUILTIN             0x00000010 /* builtin names */
 232 #define LOOKUP_NAME_WKN                 0x00000020 /* well known names */
 233 #define LOOKUP_NAME_DOMAIN              0x00000040 /* only lookup own domain */
 234 #define LOOKUP_NAME_LOCAL               (LOOKUP_NAME_ISOLATED\
 235                                         |LOOKUP_NAME_BUILTIN\
 236                                         |LOOKUP_NAME_WKN\
 237                                         |LOOKUP_NAME_DOMAIN)
 238 #define LOOKUP_NAME_ALL                 (LOOKUP_NAME_ISOLATED\
 239                                         |LOOKUP_NAME_REMOTE\
 240                                         |LOOKUP_NAME_BUILTIN\
 241                                         |LOOKUP_NAME_WKN\
 242                                         |LOOKUP_NAME_DOMAIN)
 243
 244 /**
 245  * @brief Security Identifier
 246  *
 247  * @sa http://msdn.microsoft.com/library/default.asp?url=/library/en-us/security/accctrl_38yn.asp
 248  **/
 249 typedef struct dom_sid {
 250         uint8  sid_rev_num;             /**< SID revision number */
 251         uint8  num_auths;               /**< Number of sub-authorities */
 252         uint8  id_auth[6];              /**< Identifier Authority */
 253         /*
 254          *  Pointer to sub-authorities.
 255          *
 256          * @note The values in these uint32's are in *native* byteorder, not
 257          * neccessarily little-endian...... JRA.
 258          */
 259         uint32 sub_auths[MAXSUBAUTHS];
 260 } DOM_SID;
 261
 262 enum id_mapping {
 263         ID_UNKNOWN = 0,
 264         ID_MAPPED,
 265         ID_UNMAPPED,
 266         ID_EXPIRED
 267 };
 268
 269 enum id_type {
 270         ID_TYPE_NOT_SPECIFIED = 0,
 271         ID_TYPE_UID,
 272         ID_TYPE_GID
 273 };
 274
 275 struct unixid {
 276         uint32_t id;
 277         enum id_type type;
 278 };
 279
 280 struct id_map {
 281         DOM_SID *sid;
 282         struct unixid xid;
 283         enum id_mapping status;
 284 };
 285
 286 /* used to hold an arbitrary blob of data */
 287 typedef struct data_blob {
 288         uint8 *data;
 289         size_t length;
 290         void (*free)(struct data_blob *data_blob);
 291 } DATA_BLOB;
 292
 293 extern const DATA_BLOB data_blob_null;
 294
 295 #include "librpc/gen_ndr/misc.h"
 296 #include "librpc/gen_ndr/security.h"
 297 #include "librpc/ndr/libndr.h"
 298 #include "librpc/gen_ndr/lsa.h"
 299 #include "librpc/gen_ndr/dfs.h"
 300 #include "librpc/gen_ndr/winreg.h"
 301 #include "librpc/gen_ndr/initshutdown.h"
 302 #include "librpc/gen_ndr/eventlog.h"
 303 #include "librpc/gen_ndr/srvsvc.h"
 304 #include "librpc/gen_ndr/wkssvc.h"
 305 #include "librpc/gen_ndr/echo.h"
 306 #include "librpc/gen_ndr/svcctl.h"
 307 #include "librpc/gen_ndr/netlogon.h"
 308 #include "librpc/gen_ndr/samr.h"
 309 #include "librpc/gen_ndr/dssetup.h"
 310 #include "librpc/gen_ndr/libnet_join.h"
 311 #include "librpc/gen_ndr/krb5pac.h"
 312 #include "librpc/gen_ndr/ntsvcs.h"
 313 #include "librpc/gen_ndr/nbt.h"
 314
 315 struct lsa_dom_info {
 316         bool valid;
 317         DOM_SID sid;
 318         const char *name;
 319         int num_idxs;
 320         int *idxs;
 321 };
 322
 323 struct lsa_name_info {
 324         uint32 rid;
 325         enum lsa_SidType type;
 326         const char *name;
 327         int dom_idx;
 328 };
 329
 330 /* Some well-known SIDs */
 331 extern const DOM_SID global_sid_World_Domain;
 332 extern const DOM_SID global_sid_World;
 333 extern const DOM_SID global_sid_Creator_Owner_Domain;
 334 extern const DOM_SID global_sid_NT_Authority;
 335 extern const DOM_SID global_sid_System;
 336 extern const DOM_SID global_sid_NULL;
 337 extern const DOM_SID global_sid_Authenticated_Users;
 338 extern const DOM_SID global_sid_Network;
 339 extern const DOM_SID global_sid_Creator_Owner;
 340 extern const DOM_SID global_sid_Creator_Group;
 341 extern const DOM_SID global_sid_Anonymous;
 342 extern const DOM_SID global_sid_Builtin;
 343 extern const DOM_SID global_sid_Builtin_Administrators;
 344 extern const DOM_SID global_sid_Builtin_Users;
 345 extern const DOM_SID global_sid_Builtin_Guests;
 346 extern const DOM_SID global_sid_Builtin_Power_Users;
 347 extern const DOM_SID global_sid_Builtin_Account_Operators;
 348 extern const DOM_SID global_sid_Builtin_Server_Operators;
 349 extern const DOM_SID global_sid_Builtin_Print_Operators;
 350 extern const DOM_SID global_sid_Builtin_Backup_Operators;
 351 extern const DOM_SID global_sid_Builtin_Replicator;
 352 extern const DOM_SID global_sid_Builtin_PreWin2kAccess;
 353 extern const DOM_SID global_sid_Unix_Users;
 354 extern const DOM_SID global_sid_Unix_Groups;
 355
 356 /*
 357  * The complete list of SIDS belonging to this user.
 358  * Created when a vuid is registered.
 359  * The definition of the user_sids array is as follows :
 360  *
 361  * token->user_sids[0] = primary user SID.
 362  * token->user_sids[1] = primary group SID.
 363  * token->user_sids[2..num_sids] = supplementary group SIDS.
 364  */
 365
 366 #define PRIMARY_USER_SID_INDEX 0
 367 #define PRIMARY_GROUP_SID_INDEX 1
 368
 369 typedef struct nt_user_token {
 370         size_t num_sids;
 371         DOM_SID *user_sids;
 372         SE_PRIV privileges;
 373 } NT_USER_TOKEN;
 374
 375 typedef struct _unix_token {
 376         uid_t uid;
 377         gid_t gid;
 378         int ngroups;
 379         gid_t *groups;
 380 } UNIX_USER_TOKEN;
 381
 382 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
 383 typedef struct time_info {
 384         uint32 time;
 385 } UTIME;
 386
 387 typedef struct write_cache {
 388         SMB_OFF_T file_size;
 389         SMB_OFF_T offset;
 390         size_t alloc_size;
 391         size_t data_size;
 392         char *data;
 393 } write_cache;
 394
 395 typedef struct {
 396         smb_ucs2_t *origname;
 397         smb_ucs2_t *filename;
 398         SMB_STRUCT_STAT *statinfo;
 399 } smb_filename;
 400
 401 #include "fake_file.h"
 402
 403 struct fd_handle {
 404         size_t ref_count;
 405         int fd;
 406         SMB_BIG_UINT position_information;
 407         SMB_OFF_T pos;
 408         uint32 private_options; /* NT Create options, but we only look at
 409                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
 410                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB (Except
 411                                  * for print files *only*, where
 412                                  * DELETE_ON_CLOSE is not stored in the share
 413                                  * mode database.
 414                                  */
 415         unsigned long gen_id;
 416 };
 417
 418 struct event_context;
 419 struct fd_event;
 420 struct timed_event;
 421 struct idle_event;
 422 struct share_mode_entry;
 423 struct uuid;
 424 struct named_mutex;
 425
 426 struct vfs_fsp_data {
 427     struct vfs_fsp_data *next;
 428     struct vfs_handle_struct *owner;
 429     /* NOTE: This structure contains two pointers so that we can guarantee
 430      * that the end of the structure is always both 4-byte and 8-byte aligned.
 431      */
 432 };
 433
 434 /* the basic packet size, assuming no words or bytes */
 435 #define smb_size 39
 436
 437 struct notify_change {
 438         uint32_t action;
 439         const char *name;
 440 };
 441
 442 struct notify_mid_map;
 443 struct notify_entry;
 444 struct notify_event;
 445 struct notify_change_request;
 446 struct sys_notify_backend;
 447 struct sys_notify_context {
 448         struct event_context *ev;
 449         struct connection_struct *conn;
 450         void *private_data;     /* For use by the system backend */
 451 };
 452
 453 struct notify_change_buf {
 454         /*
 455          * If no requests are pending, changes are queued here. Simple array,
 456          * we only append.
 457          */
 458
 459         /*
 460          * num_changes == -1 means that we have got a catch-all change, when
 461          * asked we just return NT_STATUS_OK without specific changes.
 462          */
 463         int num_changes;
 464         struct notify_change *changes;
 465
 466         /*
 467          * If no changes are around requests are queued here. Using a linked
 468          * list, because we have to append at the end and delete from the top.
 469          */
 470         struct notify_change_request *requests;
 471 };
 472
 473 typedef struct files_struct {
 474         struct files_struct *next, *prev;
 475         int fnum;
 476         struct connection_struct *conn;
 477         struct fd_handle *fh;
 478         unsigned int num_smb_operations;
 479         uint16 rap_print_jobid;
 480         struct file_id file_id;
 481         SMB_BIG_UINT initial_allocation_size; /* Faked up initial allocation on disk. */
 482         mode_t mode;
 483         uint16 file_pid;
 484         uint16 vuid;
 485         write_cache *wcp;
 486         struct timeval open_time;
 487         uint32 access_mask;             /* NTCreateX access bits (FILE_READ_DATA etc.) */
 488         uint32 share_access;            /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
 489
 490         bool update_write_time_triggered;
 491         struct timed_event *update_write_time_event;
 492         bool update_write_time_on_close;
 493         struct timespec close_write_time;
 494         bool write_time_forced;
 495
 496         int oplock_type;
 497         int sent_oplock_break;
 498         struct timed_event *oplock_timeout;
 499         struct lock_struct last_lock_failure;
 500         int current_lock_count; /* Count the number of outstanding locks and pending locks. */
 501
 502         struct share_mode_entry *pending_break_messages;
 503         int num_pending_break_messages;
 504
 505         bool can_lock;
 506         bool can_read;
 507         bool can_write;
 508         bool print_file;
 509         bool modified;
 510         bool is_directory;
 511         bool aio_write_behind;
 512         bool lockdb_clean;
 513         bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
 514         bool posix_open;
 515         char *fsp_name;
 516
 517         struct vfs_fsp_data *vfs_extension;
 518         FAKE_FILE_HANDLE *fake_file_handle;
 519
 520         struct notify_change_buf *notify;
 521
 522         struct files_struct *base_fsp; /* placeholder for delete on close */
 523 } files_struct;
 524
 525 #include "ntquotas.h"
 526 #include "sysquotas.h"
 527
 528 struct vuid_cache_entry {
 529         uint16 vuid;
 530         bool read_only;
 531         bool admin_user;
 532 };
 533
 534 struct vuid_cache {
 535         unsigned int entries;
 536         struct vuid_cache_entry array[VUID_CACHE_SIZE];
 537 };
 538
 539 typedef struct {
 540         char *name;
 541         bool is_wild;
 542 } name_compare_entry;
 543
 544 struct trans_state {
 545         struct trans_state *next, *prev;
 546         uint16 vuid;
 547         uint16 mid;
 548
 549         uint32 max_param_return;
 550         uint32 max_data_return;
 551         uint32 max_setup_return;
 552
 553         uint8 cmd;              /* SMBtrans or SMBtrans2 */
 554
 555         char *name;             /* for trans requests */
 556         uint16 call;            /* for trans2 and nttrans requests */
 557
 558         bool close_on_completion;
 559         bool one_way;
 560
 561         unsigned int setup_count;
 562         uint16 *setup;
 563
 564         size_t received_data;
 565         size_t received_param;
 566
 567         size_t total_param;
 568         char *param;
 569
 570         size_t total_data;
 571         char *data;
 572 };
 573
 574 /*
 575  * Info about an alternate data stream
 576  */
 577
 578 struct stream_struct {
 579         SMB_OFF_T size;
 580         SMB_OFF_T alloc_size;
 581         char *name;
 582 };
 583
 584 /* Include VFS stuff */
 585
 586 #include "smb_acls.h"
 587 #include "vfs.h"
 588
 589 struct dfree_cached_info {
 590         time_t last_dfree_time;
 591         SMB_BIG_UINT dfree_ret;
 592         SMB_BIG_UINT bsize;
 593         SMB_BIG_UINT dfree;
 594         SMB_BIG_UINT dsize;
 595 };
 596
 597 struct dptr_struct;
 598
 599 struct share_params {
 600         int service;
 601 };
 602
 603 struct share_iterator {
 604         int next_id;
 605 };
 606
 607 typedef struct connection_struct {
 608         struct connection_struct *next, *prev;
 609         unsigned cnum; /* an index passed over the wire */
 610         struct share_params *params;
 611         bool force_user;
 612         struct vuid_cache vuid_cache;
 613         struct dptr_struct *dirptr;
 614         bool printer;
 615         bool ipc;
 616         bool read_only; /* Attributes for the current user of the share. */
 617         bool admin_user; /* Attributes for the current user of the share. */
 618         char *dirpath;
 619         char *connectpath;
 620         char *origpath;
 621
 622         struct vfs_ops vfs;                   /* Filesystem operations */
 623         struct vfs_ops vfs_opaque;                      /* OPAQUE Filesystem operations */
 624         struct vfs_handle_struct *vfs_handles;          /* for the new plugins */
 625
 626         struct auth_serversupplied_info *server_info;
 627
 628         char *user; /* name of user who *opened* this connection */
 629         uid_t uid; /* uid of user who *opened* this connection */
 630         gid_t gid; /* gid of user who *opened* this connection */
 631         char client_address[INET6_ADDRSTRLEN]; /* String version of client IP address. */
 632
 633         uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
 634
 635         /* following groups stuff added by ih */
 636
 637         /* This groups info is valid for the user that *opened* the connection */
 638         size_t ngroups;
 639         gid_t *groups;
 640         NT_USER_TOKEN *nt_user_token;
 641
 642         time_t lastused;
 643         time_t lastused_count;
 644         bool used;
 645         int num_files_open;
 646         unsigned int num_smb_operations; /* Count of smb operations on this tree. */
 647         int encrypt_level;
 648         bool encrypted_tid;
 649
 650         /* Semantics requested by the client or forced by the server config. */
 651         bool case_sensitive;
 652         bool case_preserve;
 653         bool short_case_preserve;
 654
 655         /* Semantics provided by the underlying filesystem. */
 656         int fs_capabilities;
 657
 658         name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
 659         name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
 660         name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
 661         name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
 662         struct dfree_cached_info *dfree_info;
 663         struct trans_state *pending_trans;
 664         struct notify_context *notify_ctx;
 665 } connection_struct;
 666
 667 struct current_user {
 668         connection_struct *conn;
 669         uint16 vuid;
 670         UNIX_USER_TOKEN ut;
 671         NT_USER_TOKEN *nt_user_token;
 672 };
 673
 674 struct smb_request {
 675         uint16 flags2;
 676         uint16 smbpid;
 677         uint16 mid;
 678         uint16 vuid;
 679         uint16 tid;
 680         uint8  wct;
 681         const uint8 *inbuf;
 682         uint8 *outbuf;
 683         size_t unread_bytes;
 684         bool encrypted;
 685         connection_struct *conn;
 686 };
 687
 688 /* Defines for the sent_oplock_break field above. */
 689 #define NO_BREAK_SENT 0
 690 #define BREAK_TO_NONE_SENT 1
 691 #define LEVEL_II_BREAK_SENT 2
 692
 693 typedef struct {
 694         fstring smb_name; /* user name from the client */
 695         fstring unix_name; /* unix user name of a validated user */
 696         fstring full_name; /* to store full name (such as "Joe Bloggs") from gecos field of password file */
 697         fstring domain; /* domain that the client specified */
 698 } userdom_struct;
 699
 700 /* Extra fields above "LPQ_PRINTING" are used to map extra NT status codes. */
 701
 702 enum {LPQ_QUEUED=0,LPQ_PAUSED,LPQ_SPOOLING,LPQ_PRINTING,LPQ_ERROR,LPQ_DELETING,
 703       LPQ_OFFLINE,LPQ_PAPEROUT,LPQ_PRINTED,LPQ_DELETED,LPQ_BLOCKED,LPQ_USER_INTERVENTION};
 704
 705 typedef struct _print_queue_struct {
 706         int job;                /* normally the UNIX jobid -- see note in
 707                                    printing.c:traverse_fn_delete() */
 708         int size;
 709         int page_count;
 710         int status;
 711         int priority;
 712         time_t time;
 713         fstring fs_user;
 714         fstring fs_file;
 715 } print_queue_struct;
 716
 717 enum {LPSTAT_OK, LPSTAT_STOPPED, LPSTAT_ERROR};
 718
 719 typedef struct {
 720         fstring message;
 721         int qcount;
 722         int status;
 723 }  print_status_struct;
 724
 725 /* used for server information: client, nameserv and ipc */
 726 struct server_info_struct {
 727         fstring name;
 728         uint32 type;
 729         fstring comment;
 730         fstring domain; /* used ONLY in ipc.c NOT namework.c */
 731         bool server_added; /* used ONLY in ipc.c NOT namework.c */
 732 };
 733
 734 /* used for network interfaces */
 735 struct interface {
 736         struct interface *next, *prev;
 737         char *name;
 738         int flags;
 739         struct sockaddr_storage ip;
 740         struct sockaddr_storage netmask;
 741         struct sockaddr_storage bcast;
 742 };
 743
 744 /* Internal message queue for deferred opens. */
 745 struct pending_message_list {
 746         struct pending_message_list *next, *prev;
 747         struct timeval request_time; /* When was this first issued? */
 748         struct timeval end_time; /* When does this time out? */
 749         bool encrypted;
 750         DATA_BLOB buf;
 751         DATA_BLOB private_data;
 752 };
 753
 754 #define SHARE_MODE_FLAG_POSIX_OPEN      0x1
 755 #define SHARE_MODE_ALLOW_INITIAL_DELETE_ON_CLOSE      0x2
 756
 757 /* struct returned by get_share_modes */
 758 struct share_mode_entry {
 759         struct server_id pid;
 760         uint16 op_mid;
 761         uint16 op_type;
 762         uint32 access_mask;             /* NTCreateX access bits (FILE_READ_DATA etc.) */
 763         uint32 share_access;            /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
 764         uint32 private_options; /* NT Create options, but we only look at
 765                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
 766                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
 767                                  * smbstatus and swat */
 768         struct timeval time;
 769         struct file_id id;
 770         unsigned long share_file_id;
 771         uint32 uid;             /* uid of file opener. */
 772         uint16 flags;           /* See SHARE_MODE_XX above. */
 773 };
 774
 775 /* oplock break message definition - linearization of share_mode_entry.
 776
 777 Offset  Data                    length.
 778 0       struct server_id pid    4
 779 4       uint16 op_mid           2
 780 6       uint16 op_type          2
 781 8       uint32 access_mask      4
 782 12      uint32 share_access     4
 783 16      uint32 private_options  4
 784 20      uint32 time sec         4
 785 24      uint32 time usec        4
 786 28      SMB_DEV_T dev           8 bytes.
 787 36      SMB_INO_T inode         8 bytes
 788 44      unsigned long file_id   4 bytes
 789 48      uint32 uid              4 bytes
 790 52      uint16 flags            2 bytes
 791 54
 792
 793 */
 794 #ifdef CLUSTER_SUPPORT
 795 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 58
 796 #else
 797 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 54
 798 #endif
 799
 800 struct share_mode_lock {
 801         const char *servicepath; /* canonicalized. */
 802         const char *filename;
 803         struct file_id id;
 804         int num_share_modes;
 805         struct share_mode_entry *share_modes;
 806         UNIX_USER_TOKEN *delete_token;
 807         bool delete_on_close;
 808         struct timespec old_write_time;
 809         struct timespec changed_write_time;
 810         bool fresh;
 811         bool modified;
 812         struct db_record *record;
 813 };
 814
 815 /*
 816  * Internal structure of locking.tdb share mode db.
 817  * Used by locking.c and libsmbsharemodes.c
 818  */
 819
 820 struct locking_data {
 821         union {
 822                 struct {
 823                         int num_share_mode_entries;
 824                         bool delete_on_close;
 825                         struct timespec old_write_time;
 826                         struct timespec changed_write_time;
 827                         uint32 delete_token_size; /* Only valid if either of
 828                                                      the two previous fields
 829                                                      are True. */
 830                 } s;
 831                 struct share_mode_entry dummy; /* Needed for alignment. */
 832         } u;
 833         /* The following four entries are implicit
 834            struct share_mode_entry modes[num_share_mode_entries];
 835            char unix_token[delete_token_size] (divisible by 4).
 836            char share_name[];
 837            char file_name[];
 838         */
 839 };
 840
 841 /* Used to store pipe open records for NetFileEnum() */
 842
 843 struct pipe_open_rec {
 844         struct server_id pid;
 845         uid_t uid;
 846         int pnum;
 847         fstring name;
 848 };
 849
 850
 851 #define NT_HASH_LEN 16
 852 #define LM_HASH_LEN 16
 853
 854 /* Password history contants. */
 855 #define PW_HISTORY_SALT_LEN 16
 856 #define SALTED_MD5_HASH_LEN 16
 857 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
 858 #define MAX_PW_HISTORY_LEN 24
 859
 860 /*
 861  * Flags for account policy.
 862  */
 863 #define AP_MIN_PASSWORD_LEN             1
 864 #define AP_PASSWORD_HISTORY             2
 865 #define AP_USER_MUST_LOGON_TO_CHG_PASS  3
 866 #define AP_MAX_PASSWORD_AGE             4
 867 #define AP_MIN_PASSWORD_AGE             5
 868 #define AP_LOCK_ACCOUNT_DURATION        6
 869 #define AP_RESET_COUNT_TIME             7
 870 #define AP_BAD_ATTEMPT_LOCKOUT          8
 871 #define AP_TIME_TO_LOGOUT               9
 872 #define AP_REFUSE_MACHINE_PW_CHANGE     10
 873
 874 /*
 875  * Flags for local user manipulation.
 876  */
 877
 878 #define LOCAL_ADD_USER 0x1
 879 #define LOCAL_DELETE_USER 0x2
 880 #define LOCAL_DISABLE_USER 0x4
 881 #define LOCAL_ENABLE_USER 0x8
 882 #define LOCAL_TRUST_ACCOUNT 0x10
 883 #define LOCAL_SET_NO_PASSWORD 0x20
 884 #define LOCAL_SET_PASSWORD 0x40
 885 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
 886 #define LOCAL_INTERDOM_ACCOUNT 0x100
 887 #define LOCAL_AM_ROOT 0x200  /* Act as root */
 888
 889 /* key and data in the connections database - used in smbstatus and smbd */
 890 struct connections_key {
 891         struct server_id pid;
 892         int cnum;
 893         fstring name;
 894 };
 895
 896 struct connections_data {
 897         int magic;
 898         struct server_id pid;
 899         int cnum;
 900         uid_t uid;
 901         gid_t gid;
 902         char servicename[FSTRING_LEN];
 903         char addr[24];
 904         char machine[FSTRING_LEN];
 905         time_t start;
 906         uint32 bcast_msg_flags;
 907 };
 908
 909
 910 /* the following are used by loadparm for option lists */
 911 typedef enum {
 912         P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
 913         P_STRING,P_USTRING,P_ENUM,P_SEP
 914 } parm_type;
 915
 916 typedef enum {
 917         P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
 918 } parm_class;
 919
 920 struct enum_list {
 921         int value;
 922         const char *name;
 923 };
 924
 925 struct parm_struct {
 926         const char *label;
 927         parm_type type;
 928         parm_class p_class;
 929         void *ptr;
 930         bool (*special)(int snum, const char *, char **);
 931         const struct enum_list *enum_list;
 932         unsigned flags;
 933         union {
 934                 bool bvalue;
 935                 int ivalue;
 936                 char *svalue;
 937                 char cvalue;
 938                 char **lvalue;
 939         } def;
 940 };
 941
 942 /* The following flags are used in SWAT */
 943 #define FLAG_BASIC      0x0001 /* Display only in BASIC view */
 944 #define FLAG_SHARE      0x0002 /* file sharing options */
 945 #define FLAG_PRINT      0x0004 /* printing options */
 946 #define FLAG_GLOBAL     0x0008 /* local options that should be globally settable in SWAT */
 947 #define FLAG_WIZARD     0x0010 /* Parameters that the wizard will operate on */
 948 #define FLAG_ADVANCED   0x0020 /* Parameters that will be visible in advanced view */
 949 #define FLAG_DEVELOPER  0x0040 /* No longer used */
 950 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
 951 #define FLAG_HIDE       0x2000 /* options that should be hidden in SWAT */
 952 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
 953
 954 struct bitmap {
 955         uint32 *b;
 956         unsigned int n;
 957 };
 958
 959 /* offsets into message for common items */
 960 #define smb_com 8
 961 #define smb_rcls 9
 962 #define smb_reh 10
 963 #define smb_err 11
 964 #define smb_flg 13
 965 #define smb_flg2 14
 966 #define smb_pidhigh 16
 967 #define smb_ss_field 18
 968 #define smb_tid 28
 969 #define smb_pid 30
 970 #define smb_uid 32
 971 #define smb_mid 34
 972 #define smb_wct 36
 973 #define smb_vwv 37
 974 #define smb_vwv0 37
 975 #define smb_vwv1 39
 976 #define smb_vwv2 41
 977 #define smb_vwv3 43
 978 #define smb_vwv4 45
 979 #define smb_vwv5 47
 980 #define smb_vwv6 49
 981 #define smb_vwv7 51
 982 #define smb_vwv8 53
 983 #define smb_vwv9 55
 984 #define smb_vwv10 57
 985 #define smb_vwv11 59
 986 #define smb_vwv12 61
 987 #define smb_vwv13 63
 988 #define smb_vwv14 65
 989 #define smb_vwv15 67
 990 #define smb_vwv16 69
 991 #define smb_vwv17 71
 992
 993 /* flag defines. CIFS spec 3.1.1 */
 994 #define FLAG_SUPPORT_LOCKREAD       0x01
 995 #define FLAG_CLIENT_BUF_AVAIL       0x02
 996 #define FLAG_RESERVED               0x04
 997 #define FLAG_CASELESS_PATHNAMES     0x08
 998 #define FLAG_CANONICAL_PATHNAMES    0x10
 999 #define FLAG_REQUEST_OPLOCK         0x20
1000 #define FLAG_REQUEST_BATCH_OPLOCK   0x40
1001 #define FLAG_REPLY                  0x80
1002
1003 /* the complete */
1004 #define SMBmkdir      0x00   /* create directory */
1005 #define SMBrmdir      0x01   /* delete directory */
1006 #define SMBopen       0x02   /* open file */
1007 #define SMBcreate     0x03   /* create file */
1008 #define SMBclose      0x04   /* close file */
1009 #define SMBflush      0x05   /* flush file */
1010 #define SMBunlink     0x06   /* delete file */
1011 #define SMBmv         0x07   /* rename file */
1012 #define SMBgetatr     0x08   /* get file attributes */
1013 #define SMBsetatr     0x09   /* set file attributes */
1014 #define SMBread       0x0A   /* read from file */
1015 #define SMBwrite      0x0B   /* write to file */
1016 #define SMBlock       0x0C   /* lock byte range */
1017 #define SMBunlock     0x0D   /* unlock byte range */
1018 #define SMBctemp      0x0E   /* create temporary file */
1019 #define SMBmknew      0x0F   /* make new file */
1020 #define SMBcheckpath  0x10   /* check directory path */
1021 #define SMBexit       0x11   /* process exit */
1022 #define SMBlseek      0x12   /* seek */
1023 #define SMBtcon       0x70   /* tree connect */
1024 #define SMBtconX      0x75   /* tree connect and X*/
1025 #define SMBtdis       0x71   /* tree disconnect */
1026 #define SMBnegprot    0x72   /* negotiate protocol */
1027 #define SMBdskattr    0x80   /* get disk attributes */
1028 #define SMBsearch     0x81   /* search directory */
1029 #define SMBsplopen    0xC0   /* open print spool file */
1030 #define SMBsplwr      0xC1   /* write to print spool file */
1031 #define SMBsplclose   0xC2   /* close print spool file */
1032 #define SMBsplretq    0xC3   /* return print queue */
1033 #define SMBsends      0xD0   /* send single block message */
1034 #define SMBsendb      0xD1   /* send broadcast message */
1035 #define SMBfwdname    0xD2   /* forward user name */
1036 #define SMBcancelf    0xD3   /* cancel forward */
1037 #define SMBgetmac     0xD4   /* get machine name */
1038 #define SMBsendstrt   0xD5   /* send start of multi-block message */
1039 #define SMBsendend    0xD6   /* send end of multi-block message */
1040 #define SMBsendtxt    0xD7   /* send text of multi-block message */
1041
1042 /* Core+ protocol */
1043 #define SMBlockread       0x13   /* Lock a range and read */
1044 #define SMBwriteunlock 0x14 /* Unlock a range then write */
1045 #define SMBreadbraw   0x1a  /* read a block of data with no smb header */
1046 #define SMBwritebraw  0x1d  /* write a block of data with no smb header */
1047 #define SMBwritec     0x20  /* secondary write request */
1048 #define SMBwriteclose 0x2c  /* write a file then close it */
1049
1050 /* dos extended protocol */
1051 #define SMBreadBraw      0x1A   /* read block raw */
1052 #define SMBreadBmpx      0x1B   /* read block multiplexed */
1053 #define SMBreadBs        0x1C   /* read block (secondary response) */
1054 #define SMBwriteBraw     0x1D   /* write block raw */
1055 #define SMBwriteBmpx     0x1E   /* write block multiplexed */
1056 #define SMBwriteBs       0x1F   /* write block (secondary request) */
1057 #define SMBwriteC        0x20   /* write complete response */
1058 #define SMBsetattrE      0x22   /* set file attributes expanded */
1059 #define SMBgetattrE      0x23   /* get file attributes expanded */
1060 #define SMBlockingX      0x24   /* lock/unlock byte ranges and X */
1061 #define SMBtrans         0x25   /* transaction - name, bytes in/out */
1062 #define SMBtranss        0x26   /* transaction (secondary request/response) */
1063 #define SMBioctl         0x27   /* IOCTL */
1064 #define SMBioctls        0x28   /* IOCTL  (secondary request/response) */
1065 #define SMBcopy          0x29   /* copy */
1066 #define SMBmove          0x2A   /* move */
1067 #define SMBecho          0x2B   /* echo */
1068 #define SMBopenX         0x2D   /* open and X */
1069 #define SMBreadX         0x2E   /* read and X */
1070 #define SMBwriteX        0x2F   /* write and X */
1071 #define SMBsesssetupX    0x73   /* Session Set Up & X (including User Logon) */
1072 #define SMBffirst        0x82   /* find first */
1073 #define SMBfunique       0x83   /* find unique */
1074 #define SMBfclose        0x84   /* find close */
1075 #define SMBkeepalive     0x85   /* keepalive */
1076 #define SMBinvalid       0xFE   /* invalid command */
1077
1078 /* Extended 2.0 protocol */
1079 #define SMBtrans2        0x32   /* TRANS2 protocol set */
1080 #define SMBtranss2       0x33   /* TRANS2 protocol set, secondary command */
1081 #define SMBfindclose     0x34   /* Terminate a TRANSACT2_FINDFIRST */
1082 #define SMBfindnclose    0x35   /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
1083 #define SMBulogoffX      0x74   /* user logoff */
1084
1085 /* NT SMB extensions. */
1086 #define SMBnttrans       0xA0   /* NT transact */
1087 #define SMBnttranss      0xA1   /* NT transact secondary */
1088 #define SMBntcreateX     0xA2   /* NT create and X */
1089 #define SMBntcancel      0xA4   /* NT cancel */
1090 #define SMBntrename      0xA5   /* NT rename */
1091
1092 /* These are the trans subcommands */
1093 #define TRANSACT_SETNAMEDPIPEHANDLESTATE  0x01
1094 #define TRANSACT_DCERPCCMD                0x26
1095 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
1096
1097 /* These are the TRANS2 sub commands */
1098 #define TRANSACT2_OPEN                          0x00
1099 #define TRANSACT2_FINDFIRST                     0x01
1100 #define TRANSACT2_FINDNEXT                      0x02
1101 #define TRANSACT2_QFSINFO                       0x03
1102 #define TRANSACT2_SETFSINFO                     0x04
1103 #define TRANSACT2_QPATHINFO                     0x05
1104 #define TRANSACT2_SETPATHINFO                   0x06
1105 #define TRANSACT2_QFILEINFO                     0x07
1106 #define TRANSACT2_SETFILEINFO                   0x08
1107 #define TRANSACT2_FSCTL                         0x09
1108 #define TRANSACT2_IOCTL                         0x0A
1109 #define TRANSACT2_FINDNOTIFYFIRST               0x0B
1110 #define TRANSACT2_FINDNOTIFYNEXT                0x0C
1111 #define TRANSACT2_MKDIR                         0x0D
1112 #define TRANSACT2_SESSION_SETUP                 0x0E
1113 #define TRANSACT2_GET_DFS_REFERRAL              0x10
1114 #define TRANSACT2_REPORT_DFS_INCONSISTANCY      0x11
1115
1116 /* These are the NT transact sub commands. */
1117 #define NT_TRANSACT_CREATE                1
1118 #define NT_TRANSACT_IOCTL                 2
1119 #define NT_TRANSACT_SET_SECURITY_DESC     3
1120 #define NT_TRANSACT_NOTIFY_CHANGE         4
1121 #define NT_TRANSACT_RENAME                5
1122 #define NT_TRANSACT_QUERY_SECURITY_DESC   6
1123 #define NT_TRANSACT_GET_USER_QUOTA        7
1124 #define NT_TRANSACT_SET_USER_QUOTA        8
1125
1126 /* These are the NT transact_get_user_quota sub commands */
1127 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE   0x0000
1128 #define TRANSACT_GET_USER_QUOTA_LIST_START      0x0100
1129 #define TRANSACT_GET_USER_QUOTA_FOR_SID         0x0101
1130
1131 /* Relevant IOCTL codes */
1132 #define IOCTL_QUERY_JOB_INFO      0x530060
1133
1134 /* these are the trans2 sub fields for primary requests */
1135 #define smb_tpscnt smb_vwv0
1136 #define smb_tdscnt smb_vwv1
1137 #define smb_mprcnt smb_vwv2
1138 #define smb_mdrcnt smb_vwv3
1139 #define smb_msrcnt smb_vwv4
1140 #define smb_flags smb_vwv5
1141 #define smb_timeout smb_vwv6
1142 #define smb_pscnt smb_vwv9
1143 #define smb_psoff smb_vwv10
1144 #define smb_dscnt smb_vwv11
1145 #define smb_dsoff smb_vwv12
1146 #define smb_suwcnt smb_vwv13
1147 #define smb_setup smb_vwv14
1148 #define smb_setup0 smb_setup
1149 #define smb_setup1 (smb_setup+2)
1150 #define smb_setup2 (smb_setup+4)
1151
1152 /* these are for the secondary requests */
1153 #define smb_spscnt smb_vwv2
1154 #define smb_spsoff smb_vwv3
1155 #define smb_spsdisp smb_vwv4
1156 #define smb_sdscnt smb_vwv5
1157 #define smb_sdsoff smb_vwv6
1158 #define smb_sdsdisp smb_vwv7
1159 #define smb_sfid smb_vwv8
1160
1161 /* and these for responses */
1162 #define smb_tprcnt smb_vwv0
1163 #define smb_tdrcnt smb_vwv1
1164 #define smb_prcnt smb_vwv3
1165 #define smb_proff smb_vwv4
1166 #define smb_prdisp smb_vwv5
1167 #define smb_drcnt smb_vwv6
1168 #define smb_droff smb_vwv7
1169 #define smb_drdisp smb_vwv8
1170
1171 /* these are for the NT trans primary request. */
1172 #define smb_nt_MaxSetupCount smb_vwv0
1173 #define smb_nt_Flags (smb_vwv0 + 1)
1174 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1175 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1176 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1177 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1178 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1179 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1180 #define smb_nt_DataCount (smb_vwv0 + 27)
1181 #define smb_nt_DataOffset (smb_vwv0 + 31)
1182 #define smb_nt_SetupCount (smb_vwv0 + 35)
1183 #define smb_nt_Function (smb_vwv0 + 36)
1184 #define smb_nt_SetupStart (smb_vwv0 + 38)
1185
1186 /* these are for the NT trans secondary request. */
1187 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1188 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1189 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1190 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1191 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1192 #define smb_nts_DataCount (smb_vwv0 + 23)
1193 #define smb_nts_DataOffset (smb_vwv0 + 27)
1194 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1195
1196 /* these are for the NT trans reply. */
1197 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1198 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1199 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1200 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1201 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1202 #define smb_ntr_DataCount (smb_vwv0 + 23)
1203 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1204 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1205
1206 /* these are for the NT create_and_X */
1207 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1208 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1209 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1210 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1211 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1212 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1213 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1214 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1215 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1216 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1217 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1218
1219 /* this is used on a TConX. I'm not sure the name is very helpful though */
1220 #define SMB_SUPPORT_SEARCH_BITS        0x0001
1221 #define SMB_SHARE_IN_DFS               0x0002
1222
1223 /* Named pipe write mode flags. Used in writeX calls. */
1224 #define PIPE_RAW_MODE 0x4
1225 #define PIPE_START_MESSAGE 0x8
1226
1227 /* File Specific access rights */
1228 #define FILE_READ_DATA        0x00000001
1229 #define FILE_WRITE_DATA       0x00000002
1230 #define FILE_APPEND_DATA      0x00000004
1231 #define FILE_READ_EA          0x00000008 /* File and directory */
1232 #define FILE_WRITE_EA         0x00000010 /* File and directory */
1233 #define FILE_EXECUTE          0x00000020
1234 #define FILE_DELETE_CHILD     0x00000040
1235 #define FILE_READ_ATTRIBUTES  0x00000080
1236 #define FILE_WRITE_ATTRIBUTES 0x00000100
1237
1238 #define FILE_ALL_ACCESS       0x000001FF
1239
1240 /* Directory specific access rights */
1241 #define FILE_LIST_DIRECTORY   0x00000001
1242 #define FILE_ADD_FILE         0x00000002
1243 #define FILE_ADD_SUBDIRECTORY 0x00000004
1244 #define FILE_TRAVERSE         0x00000020
1245 #define FILE_DELETE_CHILD     0x00000040
1246
1247 /* the desired access to use when opening a pipe */
1248 #define DESIRED_ACCESS_PIPE 0x2019f
1249
1250 /* Generic access masks & rights. */
1251 #define DELETE_ACCESS        0x00010000 /* (1L<<16) */
1252 #define READ_CONTROL_ACCESS  0x00020000 /* (1L<<17) */
1253 #define WRITE_DAC_ACCESS     0x00040000 /* (1L<<18) */
1254 #define WRITE_OWNER_ACCESS   0x00080000 /* (1L<<19) */
1255 #define SYNCHRONIZE_ACCESS   0x00100000 /* (1L<<20) */
1256
1257 #define SYSTEM_SECURITY_ACCESS 0x01000000 /* (1L<<24) */
1258 #define MAXIMUM_ALLOWED_ACCESS 0x02000000 /* (1L<<25) */
1259 #define GENERIC_ALL_ACCESS     0x10000000 /* (1<<28) */
1260 #define GENERIC_EXECUTE_ACCESS 0x20000000 /* (1<<29) */
1261 #define GENERIC_WRITE_ACCESS   0x40000000 /* (1<<30) */
1262 #define GENERIC_READ_ACCESS    ((unsigned)0x80000000) /* (((unsigned)1)<<31) */
1263
1264 /* Mapping of generic access rights for files to specific rights. */
1265
1266 /* This maps to 0x1F01FF */
1267 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS| SYNCHRONIZE_ACCESS|FILE_ALL_ACCESS)
1268
1269 /* This maps to 0x120089 */
1270 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|FILE_READ_DATA|FILE_READ_ATTRIBUTES|\
1271                                                         FILE_READ_EA|SYNCHRONIZE_ACCESS)
1272
1273 /* This maps to 0x120116 */
1274 #define FILE_GENERIC_WRITE (STD_RIGHT_READ_CONTROL_ACCESS|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|\
1275                                                         FILE_WRITE_EA|FILE_APPEND_DATA|SYNCHRONIZE_ACCESS)
1276
1277 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|\
1278                                                                 FILE_EXECUTE|SYNCHRONIZE_ACCESS)
1279
1280 /* Share specific rights. */
1281 #define SHARE_ALL_ACCESS      FILE_GENERIC_ALL
1282 #define SHARE_READ_ONLY       (FILE_GENERIC_READ|FILE_EXECUTE)
1283
1284 /* Mapping of access rights to UNIX perms. */
1285 #define UNIX_ACCESS_RWX         FILE_GENERIC_ALL
1286 #define UNIX_ACCESS_R           FILE_GENERIC_READ
1287 #define UNIX_ACCESS_W           FILE_GENERIC_WRITE
1288 #define UNIX_ACCESS_X           FILE_GENERIC_EXECUTE
1289
1290 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1291 #define UNIX_DIRECTORY_ACCESS_RWX               FILE_GENERIC_ALL
1292 #define UNIX_DIRECTORY_ACCESS_R                 FILE_GENERIC_READ
1293 #define UNIX_DIRECTORY_ACCESS_W                 FILE_GENERIC_WRITE
1294 #define UNIX_DIRECTORY_ACCESS_X                 FILE_GENERIC_EXECUTE
1295
1296 #if 0
1297 /*
1298  * This is the old mapping we used to use. To get W2KSP2 profiles
1299  * working we need to map to the canonical file perms.
1300  */
1301 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1302 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1303                         FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1304 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1305                         FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1306                         FILE_APPEND_DATA|FILE_WRITE_DATA)
1307 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1308                         FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1309 #endif
1310
1311 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1312
1313 /* Flags field. */
1314 #define REQUEST_OPLOCK 2
1315 #define REQUEST_BATCH_OPLOCK 4
1316 #define OPEN_DIRECTORY 8
1317 #define EXTENDED_RESPONSE_REQUIRED 0x10
1318
1319 /* ShareAccess field. */
1320 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1321 #define FILE_SHARE_READ 1
1322 #define FILE_SHARE_WRITE 2
1323 #define FILE_SHARE_DELETE 4
1324
1325 /* FileAttributesField */
1326 #define FILE_ATTRIBUTE_READONLY         0x001L
1327 #define FILE_ATTRIBUTE_HIDDEN           0x002L
1328 #define FILE_ATTRIBUTE_SYSTEM           0x004L
1329 #define FILE_ATTRIBUTE_DIRECTORY        0x010L
1330 #define FILE_ATTRIBUTE_ARCHIVE          0x020L
1331 #define FILE_ATTRIBUTE_NORMAL           0x080L
1332 #define FILE_ATTRIBUTE_TEMPORARY        0x100L
1333 #define FILE_ATTRIBUTE_SPARSE           0x200L
1334 #define FILE_ATTRIBUTE_REPARSE_POINT    0x400L
1335 #define FILE_ATTRIBUTE_COMPRESSED       0x800L
1336 #define FILE_ATTRIBUTE_OFFLINE          0x1000L
1337 #define FILE_ATTRIBUTE_NONINDEXED       0x2000L
1338 #define FILE_ATTRIBUTE_ENCRYPTED        0x4000L
1339 #define SAMBA_ATTRIBUTES_MASK           0x7F
1340
1341 /* Flags - combined with attributes. */
1342 #define FILE_FLAG_WRITE_THROUGH    0x80000000L
1343 #define FILE_FLAG_NO_BUFFERING     0x20000000L
1344 #define FILE_FLAG_RANDOM_ACCESS    0x10000000L
1345 #define FILE_FLAG_SEQUENTIAL_SCAN  0x08000000L
1346 #define FILE_FLAG_DELETE_ON_CLOSE  0x04000000L
1347 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1348 #define FILE_FLAG_POSIX_SEMANTICS  0x01000000L
1349
1350 /* CreateDisposition field. */
1351 #define FILE_SUPERSEDE 0                /* File exists overwrite/supersede. File not exist create. */
1352 #define FILE_OPEN 1                     /* File exists open. File not exist fail. */
1353 #define FILE_CREATE 2                   /* File exists fail. File not exist create. */
1354 #define FILE_OPEN_IF 3                  /* File exists open. File not exist create. */
1355 #define FILE_OVERWRITE 4                /* File exists overwrite. File not exist fail. */
1356 #define FILE_OVERWRITE_IF 5             /* File exists overwrite. File not exist create. */
1357
1358 /* CreateOptions field. */
1359 #define FILE_DIRECTORY_FILE       0x0001
1360 #define FILE_WRITE_THROUGH        0x0002
1361 #define FILE_SEQUENTIAL_ONLY      0x0004
1362 #define FILE_NON_DIRECTORY_FILE   0x0040
1363 #define FILE_NO_EA_KNOWLEDGE      0x0200
1364 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400
1365 #define FILE_RANDOM_ACCESS        0x0800
1366 #define FILE_DELETE_ON_CLOSE      0x1000
1367 #define FILE_OPEN_BY_FILE_ID      0x2000
1368
1369 /* Private create options used by the ntcreatex processing code. From Samba4. */
1370 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS     0x01000000
1371 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB     0x02000000
1372
1373 /* Private options for streams support */
1374 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x04000000
1375
1376 /* Responses when opening a file. */
1377 #define FILE_WAS_SUPERSEDED 0
1378 #define FILE_WAS_OPENED 1
1379 #define FILE_WAS_CREATED 2
1380 #define FILE_WAS_OVERWRITTEN 3
1381
1382 /* File type flags */
1383 #define FILE_TYPE_DISK  0
1384 #define FILE_TYPE_BYTE_MODE_PIPE 1
1385 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1386 #define FILE_TYPE_PRINTER 3
1387 #define FILE_TYPE_COMM_DEVICE 4
1388 #define FILE_TYPE_UNKNOWN 0xFFFF
1389
1390 /* Flag for NT transact rename call. */
1391 #define RENAME_REPLACE_IF_EXISTS 1
1392
1393 /* flags for SMBntrename call (from Samba4) */
1394 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1395 #define RENAME_FLAG_HARD_LINK                0x103
1396 #define RENAME_FLAG_RENAME                   0x104
1397 #define RENAME_FLAG_COPY                     0x105
1398
1399 /* Filesystem Attributes. */
1400 #define FILE_CASE_SENSITIVE_SEARCH      0x00000001
1401 #define FILE_CASE_PRESERVED_NAMES       0x00000002
1402 #define FILE_UNICODE_ON_DISK            0x00000004
1403 /* According to cifs9f, this is 4, not 8 */
1404 /* Acconding to testing, this actually sets the security attribute! */
1405 #define FILE_PERSISTENT_ACLS            0x00000008
1406 #define FILE_FILE_COMPRESSION           0x00000010
1407 #define FILE_VOLUME_QUOTAS              0x00000020
1408 #define FILE_SUPPORTS_SPARSE_FILES      0x00000040
1409 #define FILE_SUPPORTS_REPARSE_POINTS    0x00000080
1410 #define FILE_SUPPORTS_REMOTE_STORAGE    0x00000100
1411 #define FS_LFN_APIS                     0x00004000
1412 #define FILE_VOLUME_IS_COMPRESSED       0x00008000
1413 #define FILE_SUPPORTS_OBJECT_IDS        0x00010000
1414 #define FILE_SUPPORTS_ENCRYPTION        0x00020000
1415 #define FILE_NAMED_STREAMS              0x00040000
1416 #define FILE_READ_ONLY_VOLUME           0x00080000
1417
1418 /* ChangeNotify flags. */
1419 #define FILE_NOTIFY_CHANGE_FILE_NAME   0x001
1420 #define FILE_NOTIFY_CHANGE_DIR_NAME    0x002
1421 #define FILE_NOTIFY_CHANGE_ATTRIBUTES  0x004
1422 #define FILE_NOTIFY_CHANGE_SIZE        0x008
1423 #define FILE_NOTIFY_CHANGE_LAST_WRITE  0x010
1424 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1425 #define FILE_NOTIFY_CHANGE_CREATION    0x040
1426 #define FILE_NOTIFY_CHANGE_EA          0x080
1427 #define FILE_NOTIFY_CHANGE_SECURITY    0x100
1428 #define FILE_NOTIFY_CHANGE_STREAM_NAME  0x00000200
1429 #define FILE_NOTIFY_CHANGE_STREAM_SIZE  0x00000400
1430 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1431
1432 #define FILE_NOTIFY_CHANGE_NAME \
1433         (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1434
1435 /* change notify action results */
1436 #define NOTIFY_ACTION_ADDED 1
1437 #define NOTIFY_ACTION_REMOVED 2
1438 #define NOTIFY_ACTION_MODIFIED 3
1439 #define NOTIFY_ACTION_OLD_NAME 4
1440 #define NOTIFY_ACTION_NEW_NAME 5
1441 #define NOTIFY_ACTION_ADDED_STREAM 6
1442 #define NOTIFY_ACTION_REMOVED_STREAM 7
1443 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1444
1445
1446 /* where to find the base of the SMB packet proper */
1447 #define smb_base(buf) (((char *)(buf))+4)
1448
1449 /* we don't allow server strings to be longer than 48 characters as
1450    otherwise NT will not honour the announce packets */
1451 #define MAX_SERVER_STRING_LENGTH 48
1452
1453
1454 #define SMB_SUCCESS 0  /* The request was successful. */
1455
1456 #ifdef WITH_DFS
1457 void dfs_unlogin(void);
1458 extern int dcelogin_atmost_once;
1459 #endif
1460
1461 #ifdef NOSTRDUP
1462 char *strdup(char *s);
1463 #endif
1464
1465 #ifndef SIGNAL_CAST
1466 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
1467 #endif
1468
1469 #ifndef SELECT_CAST
1470 #define SELECT_CAST
1471 #endif
1472
1473 /* This was set by JHT in liaison with Jeremy Allison early 1997
1474  * History:
1475  * Version 4.0 - never made public
1476  * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1477  *              - Reappeared in 1.9.16p11 with fixed smbd services
1478  * Version 4.20 - To indicate that nmbd and browsing now works better
1479  * Version 4.50 - Set at release of samba-2.2.0 by JHT
1480  *
1481  *  Note: In the presence of NT4.X do not set above 4.9
1482  *        Setting this above 4.9 can have undesired side-effects.
1483  *        This may change again in Samba-3.0 after further testing. JHT
1484  */
1485
1486 #define DEFAULT_MAJOR_VERSION 0x04
1487 #define DEFAULT_MINOR_VERSION 0x09
1488
1489 /* Browser Election Values */
1490 #define BROWSER_ELECTION_VERSION        0x010f
1491 #define BROWSER_CONSTANT        0xaa55
1492
1493 /* Sercurity mode bits. */
1494 #define NEGOTIATE_SECURITY_USER_LEVEL           0x01
1495 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE   0x02
1496 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED   0x04
1497 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED  0x08
1498
1499 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
1500
1501 #define FLAGS2_LONG_PATH_COMPONENTS    0x0001
1502 #define FLAGS2_EXTENDED_ATTRIBUTES     0x0002
1503 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
1504 #define FLAGS2_UNKNOWN_BIT4            0x0010
1505 #define FLAGS2_IS_LONG_NAME            0x0040
1506 #define FLAGS2_EXTENDED_SECURITY       0x0800
1507 #define FLAGS2_DFS_PATHNAMES           0x1000
1508 #define FLAGS2_READ_PERMIT_EXECUTE     0x2000
1509 #define FLAGS2_32_BIT_ERROR_CODES      0x4000
1510 #define FLAGS2_UNICODE_STRINGS         0x8000
1511
1512 #define FLAGS2_WIN2K_SIGNATURE         0xC852 /* Hack alert ! For now... JRA. */
1513
1514 /* TCONX Flag (smb_vwv2). */
1515 #define TCONX_FLAG_EXTENDED_RESPONSE    0x8
1516
1517 /* Capabilities.  see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1518
1519 #define CAP_RAW_MODE         0x0001
1520 #define CAP_MPX_MODE         0x0002
1521 #define CAP_UNICODE          0x0004
1522 #define CAP_LARGE_FILES      0x0008
1523 #define CAP_NT_SMBS          0x0010
1524 #define CAP_RPC_REMOTE_APIS  0x0020
1525 #define CAP_STATUS32         0x0040
1526 #define CAP_LEVEL_II_OPLOCKS 0x0080
1527 #define CAP_LOCK_AND_READ    0x0100
1528 #define CAP_NT_FIND          0x0200
1529 #define CAP_DFS              0x1000
1530 #define CAP_W2K_SMBS         0x2000
1531 #define CAP_LARGE_READX      0x4000
1532 #define CAP_LARGE_WRITEX     0x8000
1533 #define CAP_UNIX             0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1534 #define CAP_EXTENDED_SECURITY 0x80000000
1535
1536 /* protocol types. It assumes that higher protocols include lower protocols
1537    as subsets */
1538 enum protocol_types {PROTOCOL_NONE,PROTOCOL_CORE,PROTOCOL_COREPLUS,PROTOCOL_LANMAN1,PROTOCOL_LANMAN2,PROTOCOL_NT1};
1539
1540 /* security levels */
1541 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1542
1543 /* server roles */
1544 enum server_types {
1545         ROLE_STANDALONE,
1546         ROLE_DOMAIN_MEMBER,
1547         ROLE_DOMAIN_BDC,
1548         ROLE_DOMAIN_PDC
1549 };
1550
1551 /* printing types */
1552 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1553                      PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1554                      PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
1555 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1556 ,PRINT_TEST,PRINT_VLP
1557 #endif /* DEVELOPER */
1558 };
1559
1560 /* LDAP schema types */
1561 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1562
1563 /* LDAP SSL options */
1564 enum ldap_ssl_types {LDAP_SSL_ON, LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1565
1566 /* LDAP PASSWD SYNC methods */
1567 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1568
1569 /* Remote architectures we know about. */
1570 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1571                         RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
1572                         RA_SAMBA, RA_CIFSFS, RA_WINXP64};
1573
1574 /* case handling */
1575 enum case_handling {CASE_LOWER,CASE_UPPER};
1576
1577 /* ACL compatibility */
1578 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
1579 /*
1580  * Global value meaing that the smb_uid field should be
1581  * ingored (in share level security and protocol level == CORE)
1582  */
1583
1584 #define UID_FIELD_INVALID 0
1585 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1586
1587 /*
1588  * Size of buffer to use when moving files across filesystems.
1589  */
1590 #define COPYBUF_SIZE (8*1024)
1591
1592 /*
1593  * Used in chaining code.
1594  */
1595 extern int chain_size;
1596
1597 /*
1598  * Map the Core and Extended Oplock requesst bits down
1599  * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1600  */
1601
1602 /*
1603  * Core protocol.
1604  */
1605 #define CORE_OPLOCK_REQUEST(inbuf) \
1606     ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1607
1608 /*
1609  * Extended protocol.
1610  */
1611 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1612
1613 /* Lock types. */
1614 #define LOCKING_ANDX_SHARED_LOCK 0x1
1615 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1616 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1617 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1618 #define LOCKING_ANDX_LARGE_FILES 0x10
1619
1620 /*
1621  * Bits we test with.
1622  * Note these must fit into 16-bits.
1623  */
1624
1625 #define NO_OPLOCK                       0x0
1626 #define EXCLUSIVE_OPLOCK                0x1
1627 #define BATCH_OPLOCK                    0x2
1628 #define LEVEL_II_OPLOCK                 0x4
1629
1630 /* The following are Samba-private. */
1631 #define INTERNAL_OPEN_ONLY              0x8
1632 #define FAKE_LEVEL_II_OPLOCK            0x10    /* Client requested no_oplock, but we have to
1633                                  * inform potential level2 holders on
1634                                  * write. */
1635 #define DEFERRED_OPEN_ENTRY             0x20
1636 #define UNUSED_SHARE_MODE_ENTRY         0x40
1637 #define FORCE_OPLOCK_BREAK_TO_NONE      0x80
1638
1639 /* None of the following should ever appear in fsp->oplock_request. */
1640 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1641
1642 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1643 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1644 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1645
1646 struct inform_level2_message {
1647         SMB_DEV_T dev;
1648         SMB_INO_T inode;
1649         uint16 mid;
1650         unsigned long target_file_id;
1651         unsigned long source_file_id;
1652 };
1653
1654 /* kernel_oplock_message definition.
1655
1656 struct kernel_oplock_message {
1657         SMB_DEV_T dev;
1658         SMB_INO_T inode;
1659         unsigned long file_id;
1660 };
1661
1662 Offset  Data                  length.
1663 0     SMB_DEV_T dev           8 bytes.
1664 8     SMB_INO_T inode         8 bytes
1665 16    unsigned long file_id   4 bytes
1666 20
1667
1668 */
1669 #define MSG_SMB_KERNEL_BREAK_SIZE 20
1670
1671 /* file_renamed_message definition.
1672
1673 struct file_renamed_message {
1674         SMB_DEV_T dev;
1675         SMB_INO_T inode;
1676         char names[1]; A variable area containing sharepath and filename.
1677 };
1678
1679 Offset  Data                    length.
1680 0       SMB_DEV_T dev           8 bytes.
1681 8       SMB_INO_T inode         8 bytes
1682 16      char [] name            zero terminated namelen bytes
1683 minimum length == 18.
1684
1685 */
1686
1687 #define MSG_FILE_RENAMED_MIN_SIZE 16
1688
1689 /*
1690  * On the wire return values for oplock types.
1691  */
1692
1693 #define CORE_OPLOCK_GRANTED (1<<5)
1694 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1695
1696 #define NO_OPLOCK_RETURN 0
1697 #define EXCLUSIVE_OPLOCK_RETURN 1
1698 #define BATCH_OPLOCK_RETURN 2
1699 #define LEVEL_II_OPLOCK_RETURN 3
1700
1701 /* Oplock levels */
1702 #define OPLOCKLEVEL_NONE 0
1703 #define OPLOCKLEVEL_II 1
1704
1705 /*
1706  * Capabilities abstracted for different systems.
1707  */
1708
1709 enum smbd_capability {
1710     KERNEL_OPLOCK_CAPABILITY,
1711     DMAPI_ACCESS_CAPABILITY
1712 };
1713
1714 /* if a kernel does support oplocks then a structure of the following
1715    typee is used to describe how to interact with the kernel */
1716 struct kernel_oplocks {
1717         files_struct * (*receive_message)(fd_set *fds);
1718         bool (*set_oplock)(files_struct *fsp, int oplock_type);
1719         void (*release_oplock)(files_struct *fsp);
1720         bool (*msg_waiting)(fd_set *fds);
1721         int notification_fd;
1722 };
1723
1724 #include "smb_macros.h"
1725
1726 #define MAX_NETBIOSNAME_LEN 16
1727 /* DOS character, NetBIOS namestring. Type used on the wire. */
1728 typedef char nstring[MAX_NETBIOSNAME_LEN];
1729 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1730 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1731
1732 /* A netbios name structure. */
1733 struct nmb_name {
1734         nstring      name;
1735         char         scope[64];
1736         unsigned int name_type;
1737 };
1738
1739 /* A netbios node status array element. */
1740 typedef struct node_status_ {
1741         nstring name;
1742         unsigned char type;
1743         unsigned char flags;
1744 } NODE_STATUS_STRUCT;
1745
1746 /* The extra info from a NetBIOS node status query */
1747 struct node_status_extra {
1748         unsigned char mac_addr[6];
1749         /* There really is more here ... */
1750 };
1751
1752 struct pwd_info {
1753         bool null_pwd;
1754         bool cleartext;
1755
1756         fstring password;
1757 };
1758
1759 /* For split krb5 SPNEGO blobs. */
1760 struct pending_auth_data {
1761         struct pending_auth_data *prev, *next;
1762         uint16 vuid; /* Tag for this entry. */
1763         uint16 smbpid; /* Alternate tag for this entry. */
1764         size_t needed_len;
1765         DATA_BLOB partial_data;
1766 };
1767
1768 typedef struct user_struct {
1769         struct user_struct *next, *prev;
1770         uint16 vuid; /* Tag for this entry. */
1771
1772         char *session_keystr; /* used by utmp and pam session code.
1773                                  TDB key string */
1774         int homes_snum;
1775
1776         struct auth_serversupplied_info *server_info;
1777
1778         struct auth_ntlmssp_state *auth_ntlmssp_state;
1779 } user_struct;
1780
1781 struct unix_error_map {
1782         int unix_error;
1783         int dos_class;
1784         int dos_code;
1785         NTSTATUS nt_error;
1786 };
1787
1788 /*
1789  * Size of new password account encoding string.  This is enough space to
1790  * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1791  * Do not change unless you are adding new ACB bits!
1792  */
1793
1794 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1795
1796 /*
1797    Do you want session setups at user level security with a invalid
1798    password to be rejected or allowed in as guest? WinNT rejects them
1799    but it can be a pain as it means "net view" needs to use a password
1800
1801    You have 3 choices in the setting of map_to_guest:
1802
1803    "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1804    are rejected. This is the default.
1805
1806    "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1807    are rejected, unless the username does not exist, in which case it
1808    is treated as a guest login
1809
1810    "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1811    are treated as a guest login
1812
1813    Note that map_to_guest only has an effect in user or server
1814    level security.
1815 */
1816
1817 #define NEVER_MAP_TO_GUEST              0
1818 #define MAP_TO_GUEST_ON_BAD_USER        1
1819 #define MAP_TO_GUEST_ON_BAD_PASSWORD    2
1820 #define MAP_TO_GUEST_ON_BAD_UID         3
1821
1822 #define SAFE_NETBIOS_CHARS ". -_"
1823
1824 /* generic iconv conversion structure */
1825 typedef struct _smb_iconv_t {
1826         size_t (*direct)(void *cd, const char **inbuf, size_t *inbytesleft,
1827                          char **outbuf, size_t *outbytesleft);
1828         size_t (*pull)(void *cd, const char **inbuf, size_t *inbytesleft,
1829                        char **outbuf, size_t *outbytesleft);
1830         size_t (*push)(void *cd, const char **inbuf, size_t *inbytesleft,
1831                        char **outbuf, size_t *outbytesleft);
1832         void *cd_direct, *cd_pull, *cd_push;
1833         char *from_name, *to_name;
1834 } *smb_iconv_t;
1835
1836 /* The maximum length of a trust account password.
1837    Used when we randomly create it, 15 char passwords
1838    exceed NT4's max password length */
1839
1840 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1841
1842 #include "popt_common.h"
1843
1844 #define PORT_NONE       0
1845 #ifndef LDAP_PORT
1846 #define LDAP_PORT       389
1847 #endif
1848
1849 /* used by the IP comparison function */
1850 struct ip_service {
1851         struct sockaddr_storage ss;
1852         unsigned port;
1853 };
1854
1855 /* Special name type used to cause a _kerberos DNS lookup. */
1856 #define KDC_NAME_TYPE 0xDCDC
1857
1858 /* Used by the SMB signing functions. */
1859
1860 typedef struct smb_sign_info {
1861         void (*sign_outgoing_message)(char *outbuf, struct smb_sign_info *si);
1862         bool (*check_incoming_message)(const char *inbuf, struct smb_sign_info *si, bool must_be_ok);
1863         void (*free_signing_context)(struct smb_sign_info *si);
1864         void *signing_context;
1865
1866         bool negotiated_smb_signing;
1867         bool allow_smb_signing;
1868         bool doing_signing;
1869         bool mandatory_signing;
1870         bool seen_valid; /* Have I ever seen a validly signed packet? */
1871 } smb_sign_info;
1872
1873 struct ea_struct {
1874         uint8 flags;
1875         char *name;
1876         DATA_BLOB value;
1877 };
1878
1879 struct ea_list {
1880         struct ea_list *next, *prev;
1881         struct ea_struct ea;
1882 };
1883
1884 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1885 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1886 /* EA to use for DOS attributes */
1887 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1888 /* Prefix for DosStreams in the vfs_streams_xattr module */
1889 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1890
1891 #define UUID_SIZE 16
1892
1893 #define UUID_FLAT_SIZE 16
1894 typedef struct uuid_flat {
1895         uint8 info[UUID_FLAT_SIZE];
1896 } UUID_FLAT;
1897
1898 /* map readonly options */
1899 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1900
1901 /* usershare error codes. */
1902 enum usershare_err {
1903                 USERSHARE_OK=0,
1904                 USERSHARE_MALFORMED_FILE,
1905                 USERSHARE_BAD_VERSION,
1906                 USERSHARE_MALFORMED_PATH,
1907                 USERSHARE_MALFORMED_COMMENT_DEF,
1908                 USERSHARE_MALFORMED_ACL_DEF,
1909                 USERSHARE_ACL_ERR,
1910                 USERSHARE_PATH_NOT_ABSOLUTE,
1911                 USERSHARE_PATH_IS_DENIED,
1912                 USERSHARE_PATH_NOT_ALLOWED,
1913                 USERSHARE_PATH_NOT_DIRECTORY,
1914                 USERSHARE_POSIX_ERR
1915 };
1916
1917 /* Different reasons for closing a file. */
1918 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1919
1920 /* Used in SMB_FS_OBJECTID_INFORMATION requests.  Must be exactly 48 bytes. */
1921 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1922 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1923 struct smb_extended_info {
1924         uint32 samba_magic;             /* Always SAMBA_EXTRA_INFO_MAGIC */
1925         uint32 samba_version;           /* Major/Minor/Release/Revision */
1926         uint32 samba_subversion;        /* Prerelease/RC/Vendor patch */
1927         NTTIME samba_gitcommitdate;
1928         char   samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
1929 };
1930
1931 #endif /* _SMB_H */