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