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