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