source3/include/smb.h

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