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