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