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