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