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