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