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