source3/include/smb.h

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