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