source3/include/smb.h

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