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