source3/include/smb.h

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