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