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