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 #include "libcli/smb/smb_common.h"
  30 #include "libds/common/roles.h"
  31
  32 /* logged when starting the various Samba daemons */
  33 #define COPYRIGHT_STARTUP_MESSAGE       "Copyright Andrew Tridgell and the Samba Team 1992-2011"
  34
  35
  36 #if defined(LARGE_SMB_OFF_T)
  37 #define BUFFER_SIZE (128*1024)
  38 #else /* no large readwrite possible */
  39 #define BUFFER_SIZE (0xFFFF)
  40 #endif
  41
  42 #define SAFETY_MARGIN 1024
  43 #define LARGE_WRITEX_HDR_SIZE 65
  44
  45 #define NMB_PORT 137
  46 #define DGRAM_PORT 138
  47 #define SMB_PORT1 445
  48 #define SMB_PORT2 139
  49 #define SMB_PORTS "445 139"
  50
  51 #define Undefined (-1)
  52 #define False false
  53 #define True true
  54 #define Auto (2)
  55 #define Required (3)
  56
  57 #define SIZEOFWORD 2
  58
  59 #ifndef DEF_CREATE_MASK
  60 #define DEF_CREATE_MASK (0755)
  61 #endif
  62
  63 /* string manipulation flags - see clistr.c and srvstr.c */
  64 #define STR_TERMINATE 1
  65 #define STR_UPPER 2
  66 #define STR_ASCII 4
  67 #define STR_UNICODE 8
  68 #define STR_NOALIGN 16
  69 #define STR_TERMINATE_ASCII 128
  70
  71 /* how long to wait for secondary SMB packets (milli-seconds) */
  72 #define SMB_SECONDARY_WAIT (60*1000)
  73
  74 #define DIR_STRUCT_SIZE 43
  75
  76 /* deny modes */
  77 #define DENY_DOS 0
  78 #define DENY_ALL 1
  79 #define DENY_WRITE 2
  80 #define DENY_READ 3
  81 #define DENY_NONE 4
  82 #define DENY_FCB 7
  83
  84 /* open modes */
  85 #define DOS_OPEN_RDONLY 0
  86 #define DOS_OPEN_WRONLY 1
  87 #define DOS_OPEN_RDWR 2
  88 #define DOS_OPEN_EXEC 3
  89 #define DOS_OPEN_FCB 0xF
  90
  91 /* define shifts and masks for share and open modes. */
  92 #define OPENX_MODE_MASK 0xF
  93 #define DENY_MODE_SHIFT 4
  94 #define DENY_MODE_MASK 0x7
  95 #define GET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
  96 #define SET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
  97 #define GET_DENY_MODE(x) (((x)>>DENY_MODE_SHIFT) & DENY_MODE_MASK)
  98 #define SET_DENY_MODE(x) (((x) & DENY_MODE_MASK) <<DENY_MODE_SHIFT)
  99
 100 /* Sync on open file (not sure if used anymore... ?) */
 101 #define FILE_SYNC_OPENMODE (1<<14)
 102 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
 103
 104 /* open disposition values */
 105 #define OPENX_FILE_EXISTS_FAIL 0
 106 #define OPENX_FILE_EXISTS_OPEN 1
 107 #define OPENX_FILE_EXISTS_TRUNCATE 2
 108
 109 /* mask for open disposition. */
 110 #define OPENX_FILE_OPEN_MASK 0x3
 111
 112 #define GET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
 113 #define SET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
 114
 115 /* The above can be OR'ed with... */
 116 #define OPENX_FILE_CREATE_IF_NOT_EXIST 0x10
 117 #define OPENX_FILE_FAIL_IF_NOT_EXIST 0
 118
 119 typedef union unid_t {
 120         uid_t uid;
 121         gid_t gid;
 122 } unid_t;
 123
 124 /* pipe string names */
 125
 126 #ifndef MAXSUBAUTHS
 127 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
 128 #endif
 129
 130 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
 131
 132 #include "librpc/gen_ndr/security.h"
 133
 134 typedef struct write_cache {
 135         SMB_OFF_T file_size;
 136         SMB_OFF_T offset;
 137         size_t alloc_size;
 138         size_t data_size;
 139         char *data;
 140 } write_cache;
 141
 142 struct fd_handle {
 143         size_t ref_count;
 144         int fd;
 145         uint64_t position_information;
 146         SMB_OFF_T pos;
 147         uint32 private_options; /* NT Create options, but we only look at
 148                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
 149                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
 150                                  * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
 151                                  * for print files *only*, where
 152                                  * DELETE_ON_CLOSE is not stored in the share
 153                                  * mode database.
 154                                  */
 155         unsigned long gen_id;
 156 };
 157
 158 struct idle_event;
 159 struct share_mode_entry;
 160 struct uuid;
 161 struct named_mutex;
 162 struct wb_context;
 163 struct rpc_cli_smbd_conn;
 164 struct fncall_context;
 165
 166 struct vfs_fsp_data {
 167     struct vfs_fsp_data *next;
 168     struct vfs_handle_struct *owner;
 169     void (*destroy)(void *p_data);
 170     void *_dummy_;
 171     /* NOTE: This structure contains four pointers so that we can guarantee
 172      * that the end of the structure is always both 4-byte and 8-byte aligned.
 173      */
 174 };
 175
 176 /* the basic packet size, assuming no words or bytes */
 177 #define smb_size 39
 178
 179 struct notify_change {
 180         uint32_t action;
 181         const char *name;
 182 };
 183
 184 struct notify_mid_map;
 185 struct notify_entry;
 186 struct notify_event;
 187 struct notify_change_request;
 188 struct sys_notify_backend;
 189 struct sys_notify_context {
 190         struct event_context *ev;
 191         struct connection_struct *conn;
 192         void *private_data;     /* For use by the system backend */
 193 };
 194
 195 struct notify_change_buf {
 196         /*
 197          * If no requests are pending, changes are queued here. Simple array,
 198          * we only append.
 199          */
 200
 201         /*
 202          * num_changes == -1 means that we have got a catch-all change, when
 203          * asked we just return NT_STATUS_OK without specific changes.
 204          */
 205         int num_changes;
 206         struct notify_change *changes;
 207
 208         /*
 209          * If no changes are around requests are queued here. Using a linked
 210          * list, because we have to append at the end and delete from the top.
 211          */
 212         struct notify_change_request *requests;
 213 };
 214
 215 struct print_file_data {
 216         char *svcname;
 217         char *docname;
 218         char *filename;
 219         struct policy_handle handle;
 220         uint32_t jobid;
 221         uint16 rap_jobid;
 222 };
 223
 224 typedef struct files_struct {
 225         struct files_struct *next, *prev;
 226         int fnum;
 227         struct connection_struct *conn;
 228         struct fd_handle *fh;
 229         unsigned int num_smb_operations;
 230         struct file_id file_id;
 231         uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
 232         mode_t mode;
 233         uint16 file_pid;
 234         uint16 vuid;
 235         write_cache *wcp;
 236         struct timeval open_time;
 237         uint32 access_mask;             /* NTCreateX access bits (FILE_READ_DATA etc.) */
 238         uint32 share_access;            /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
 239
 240         bool update_write_time_triggered;
 241         struct timed_event *update_write_time_event;
 242         bool update_write_time_on_close;
 243         struct timespec close_write_time;
 244         bool write_time_forced;
 245
 246         int oplock_type;
 247         int sent_oplock_break;
 248         struct timed_event *oplock_timeout;
 249         struct lock_struct last_lock_failure;
 250         int current_lock_count; /* Count the number of outstanding locks and pending locks. */
 251
 252         struct share_mode_entry *pending_break_messages;
 253         int num_pending_break_messages;
 254
 255         bool can_lock;
 256         bool can_read;
 257         bool can_write;
 258         bool modified;
 259         bool is_directory;
 260         bool aio_write_behind;
 261         bool lockdb_clean;
 262         bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
 263         bool delete_on_close;
 264         bool posix_open;
 265         bool is_sparse;
 266         struct smb_filename *fsp_name;
 267         uint32_t name_hash;             /* Jenkins hash of full pathname. */
 268
 269         struct vfs_fsp_data *vfs_extension;
 270         struct fake_file_handle *fake_file_handle;
 271
 272         struct notify_change_buf *notify;
 273
 274         struct files_struct *base_fsp; /* placeholder for delete on close */
 275
 276         /*
 277          * Read-only cached brlock record, thrown away when the
 278          * brlock.tdb seqnum changes. This avoids fetching data from
 279          * the brlock.tdb on every read/write call.
 280          */
 281         int brlock_seqnum;
 282         struct byte_range_lock *brlock_rec;
 283
 284         struct dptr_struct *dptr;
 285
 286         /* if not NULL, means this is a print file */
 287         struct print_file_data *print_file;
 288
 289 } files_struct;
 290
 291 #include "ntquotas.h"
 292 #include "sysquotas.h"
 293
 294 struct vuid_cache_entry {
 295         struct auth_session_info *session_info;
 296         uint16_t vuid;
 297         bool read_only;
 298 };
 299
 300 struct vuid_cache {
 301         unsigned int next_entry;
 302         struct vuid_cache_entry array[VUID_CACHE_SIZE];
 303 };
 304
 305 typedef struct {
 306         char *name;
 307         bool is_wild;
 308 } name_compare_entry;
 309
 310 struct trans_state {
 311         struct trans_state *next, *prev;
 312         uint16 vuid;
 313         uint64_t mid;
 314
 315         uint32 max_param_return;
 316         uint32 max_data_return;
 317         uint32 max_setup_return;
 318
 319         uint8 cmd;              /* SMBtrans or SMBtrans2 */
 320
 321         char *name;             /* for trans requests */
 322         uint16 call;            /* for trans2 and nttrans requests */
 323
 324         bool close_on_completion;
 325         bool one_way;
 326
 327         unsigned int setup_count;
 328         uint16 *setup;
 329
 330         size_t received_data;
 331         size_t received_param;
 332
 333         size_t total_param;
 334         char *param;
 335
 336         size_t total_data;
 337         char *data;
 338 };
 339
 340 /*
 341  * Info about an alternate data stream
 342  */
 343
 344 struct stream_struct {
 345         SMB_OFF_T size;
 346         SMB_OFF_T alloc_size;
 347         char *name;
 348 };
 349
 350 /* Include VFS stuff */
 351
 352 #include "smb_acls.h"
 353 #include "vfs.h"
 354
 355 struct dfree_cached_info {
 356         time_t last_dfree_time;
 357         uint64_t dfree_ret;
 358         uint64_t bsize;
 359         uint64_t dfree;
 360         uint64_t dsize;
 361 };
 362
 363 struct dptr_struct;
 364
 365 struct share_params {
 366         int service;
 367 };
 368
 369 typedef struct connection_struct {
 370         struct connection_struct *next, *prev;
 371         struct smbd_server_connection *sconn; /* can be NULL */
 372         unsigned cnum; /* an index passed over the wire */
 373         struct share_params *params;
 374         bool force_user;
 375         struct vuid_cache vuid_cache;
 376         bool printer;
 377         bool ipc;
 378         bool read_only; /* Attributes for the current user of the share. */
 379         uint32_t share_access;
 380         /* Does this filesystem honor
 381            sub second timestamps on files
 382            and directories when setting time ? */
 383         enum timestamp_set_resolution ts_res;
 384         char *connectpath;
 385         char *origpath;
 386
 387         struct vfs_handle_struct *vfs_handles;          /* for the new plugins */
 388
 389         /*
 390          * This represents the user information on this connection. Depending
 391          * on the vuid using this tid, this might change per SMB request.
 392          */
 393         struct auth_session_info *session_info;
 394
 395         /*
 396          * If the "force group" parameter is set, this is the primary gid that
 397          * may be used in the users token, depending on the vuid using this tid.
 398          */
 399         gid_t force_group_gid;
 400
 401         uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
 402
 403         time_t lastused;
 404         time_t lastused_count;
 405         bool used;
 406         int num_files_open;
 407         unsigned int num_smb_operations; /* Count of smb operations on this tree. */
 408         int encrypt_level;
 409         bool encrypted_tid;
 410
 411         /* Semantics requested by the client or forced by the server config. */
 412         bool case_sensitive;
 413         bool case_preserve;
 414         bool short_case_preserve;
 415
 416         /* Semantics provided by the underlying filesystem. */
 417         int fs_capabilities;
 418         /* Device number of the directory of the share mount.
 419            Used to ensure unique FileIndex returns. */
 420         SMB_DEV_T base_share_dev;
 421
 422         name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
 423         name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
 424         name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
 425         name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
 426         struct dfree_cached_info *dfree_info;
 427         struct trans_state *pending_trans;
 428         struct notify_context *notify_ctx;
 429
 430         struct rpc_pipe_client *spoolss_pipe;
 431
 432 } connection_struct;
 433
 434 struct current_user {
 435         connection_struct *conn;
 436         uint16 vuid;
 437         struct security_unix_token ut;
 438         struct security_token *nt_user_token;
 439 };
 440
 441 struct smbd_smb2_request;
 442
 443 struct smb_request {
 444         uint8_t cmd;
 445         uint16 flags2;
 446         uint16 smbpid;
 447         uint64_t mid; /* For compatibility with SMB2. */
 448         uint32_t seqnum;
 449         uint16 vuid;
 450         uint16 tid;
 451         uint8  wct;
 452         uint16_t *vwv;
 453         uint16_t buflen;
 454         const uint8_t *buf;
 455         const uint8 *inbuf;
 456
 457         /*
 458          * Async handling in the main smb processing loop is directed by
 459          * outbuf: reply_xxx routines indicate sync behaviour by putting their
 460          * reply into "outbuf". If they leave it as NULL, they take of it
 461          * themselves, possibly later.
 462          *
 463          * If async handling is wanted, the reply_xxx routine must make sure
 464          * that it talloc_move()s the smb_req somewhere else.
 465          */
 466         uint8 *outbuf;
 467
 468         size_t unread_bytes;
 469         bool encrypted;
 470         connection_struct *conn;
 471         struct smbd_server_connection *sconn;
 472         struct smb_perfcount_data pcd;
 473
 474         /*
 475          * Chained request handling
 476          */
 477         struct files_struct *chain_fsp;
 478
 479         /*
 480          * Here we collect the outbufs from the chain handlers
 481          */
 482         uint8_t *chain_outbuf;
 483
 484         /*
 485          * state information for async smb handling
 486          */
 487         void *async_priv;
 488
 489         bool done;
 490
 491         /*
 492          * Back pointer to smb2 request.
 493          */
 494         struct smbd_smb2_request *smb2req;
 495 };
 496
 497 /* Defines for the sent_oplock_break field above. */
 498 #define NO_BREAK_SENT 0
 499 #define BREAK_TO_NONE_SENT 1
 500 #define LEVEL_II_BREAK_SENT 2
 501
 502 typedef struct {
 503         fstring smb_name; /* user name from the client */
 504         fstring unix_name; /* unix user name of a validated user */
 505         fstring domain; /* domain that the client specified */
 506 } userdom_struct;
 507
 508 /* used for network interfaces */
 509 struct interface {
 510         struct interface *next, *prev;
 511         char *name;
 512         int flags;
 513         struct sockaddr_storage ip;
 514         struct sockaddr_storage netmask;
 515         struct sockaddr_storage bcast;
 516 };
 517
 518 #define SHARE_MODE_FLAG_POSIX_OPEN      0x1
 519
 520 #include "librpc/gen_ndr/server_id.h"
 521
 522 /* oplock break message definition - linearization of share_mode_entry.
 523
 524 Offset  Data                    length.
 525 0       struct server_id pid    4
 526 4       uint16 op_mid           8
 527 12      uint16 op_type          2
 528 14      uint32 access_mask      4
 529 18      uint32 share_access     4
 530 22      uint32 private_options  4
 531 26      uint32 time sec         4
 532 30      uint32 time usec        4
 533 34      uint64 dev              8 bytes
 534 42      uint64 inode            8 bytes
 535 50      uint64 extid            8 bytes
 536 58      unsigned long file_id   4 bytes
 537 62      uint32 uid              4 bytes
 538 66      uint16 flags            2 bytes
 539 68      uint32 name_hash        4 bytes
 540 72
 541
 542 */
 543
 544 #define OP_BREAK_MSG_PID_OFFSET 0
 545 #define OP_BREAK_MSG_MID_OFFSET 4
 546 #define OP_BREAK_MSG_OP_TYPE_OFFSET 12
 547 #define OP_BREAK_MSG_ACCESS_MASK_OFFSET 14
 548 #define OP_BREAK_MSG_SHARE_ACCESS_OFFSET 18
 549 #define OP_BREAK_MSG_PRIV_OFFSET 22
 550 #define OP_BREAK_MSG_TIME_SEC_OFFSET 26
 551 #define OP_BREAK_MSG_TIME_USEC_OFFSET 30
 552 #define OP_BREAK_MSG_DEV_OFFSET 34
 553 #define OP_BREAK_MSG_INO_OFFSET 42
 554 #define OP_BREAK_MSG_EXTID_OFFSET 50
 555 #define OP_BREAK_MSG_FILE_ID_OFFSET 58
 556 #define OP_BREAK_MSG_UID_OFFSET 62
 557 #define OP_BREAK_MSG_FLAGS_OFFSET 66
 558 #define OP_BREAK_MSG_NAME_HASH_OFFSET 68
 559
 560 #define OP_BREAK_MSG_VNN_OFFSET 72
 561 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 76
 562
 563 #define NT_HASH_LEN 16
 564 #define LM_HASH_LEN 16
 565
 566 /* key and data in the connections database - used in smbstatus and smbd */
 567 struct connections_key {
 568         struct server_id pid;
 569         int cnum;
 570         fstring name;
 571 };
 572
 573 struct connections_data {
 574         int magic;
 575         struct server_id pid;
 576         int cnum;
 577         uid_t uid;
 578         gid_t gid;
 579         char servicename[FSTRING_LEN];
 580         char addr[24];
 581         char machine[FSTRING_LEN];
 582         time_t start;
 583
 584         /*
 585          * This field used to hold the msg_flags. For compatibility reasons,
 586          * keep the data structure in the tdb file the same.
 587          */
 588         uint32 unused_compatitibility_field;
 589 };
 590
 591 /* offsets into message for common items */
 592 #define smb_com         (NBT_HDR_SIZE+HDR_COM)
 593 #define smb_rcls        (NBT_HDR_SIZE+HDR_RCLS)
 594 #define smb_reh         (NBT_HDR_SIZE+HDR_REH)
 595 #define smb_err         (NBT_HDR_SIZE+HDR_ERR)
 596 #define smb_flg         (NBT_HDR_SIZE+HDR_FLG)
 597 #define smb_flg2        (NBT_HDR_SIZE+HDR_FLG2)
 598 #define smb_pidhigh     (NBT_HDR_SIZE+HDR_PIDHIGH)
 599 #define smb_ss_field    (NBT_HDR_SIZE+HDR_SS_FIELD)
 600 #define smb_tid         (NBT_HDR_SIZE+HDR_TID)
 601 #define smb_pid         (NBT_HDR_SIZE+HDR_PID)
 602 #define smb_uid         (NBT_HDR_SIZE+HDR_UID)
 603 #define smb_mid         (NBT_HDR_SIZE+HDR_MID)
 604 #define smb_wct         (NBT_HDR_SIZE+HDR_WCT)
 605 #define smb_vwv         (NBT_HDR_SIZE+HDR_VWV)
 606 #define smb_vwv0        (smb_vwv+( 0*2))
 607 #define smb_vwv1        (smb_vwv+( 1*2))
 608 #define smb_vwv2        (smb_vwv+( 2*2))
 609 #define smb_vwv3        (smb_vwv+( 3*2))
 610 #define smb_vwv4        (smb_vwv+( 4*2))
 611 #define smb_vwv5        (smb_vwv+( 5*2))
 612 #define smb_vwv6        (smb_vwv+( 6*2))
 613 #define smb_vwv7        (smb_vwv+( 7*2))
 614 #define smb_vwv8        (smb_vwv+( 8*2))
 615 #define smb_vwv9        (smb_vwv+( 9*2))
 616 #define smb_vwv10       (smb_vwv+(10*2))
 617 #define smb_vwv11       (smb_vwv+(11*2))
 618 #define smb_vwv12       (smb_vwv+(12*2))
 619 #define smb_vwv13       (smb_vwv+(13*2))
 620 #define smb_vwv14       (smb_vwv+(14*2))
 621 #define smb_vwv15       (smb_vwv+(15*2))
 622 #define smb_vwv16       (smb_vwv+(16*2))
 623 #define smb_vwv17       (smb_vwv+(17*2))
 624
 625 /* These are the trans subcommands */
 626 #define TRANSACT_SETNAMEDPIPEHANDLESTATE  0x01
 627 #define TRANSACT_DCERPCCMD                0x26
 628 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
 629
 630 /* These are the TRANS2 sub commands */
 631 #define TRANSACT2_OPEN                          0x00
 632 #define TRANSACT2_FINDFIRST                     0x01
 633 #define TRANSACT2_FINDNEXT                      0x02
 634 #define TRANSACT2_QFSINFO                       0x03
 635 #define TRANSACT2_SETFSINFO                     0x04
 636 #define TRANSACT2_QPATHINFO                     0x05
 637 #define TRANSACT2_SETPATHINFO                   0x06
 638 #define TRANSACT2_QFILEINFO                     0x07
 639 #define TRANSACT2_SETFILEINFO                   0x08
 640 #define TRANSACT2_FSCTL                         0x09
 641 #define TRANSACT2_IOCTL                         0x0A
 642 #define TRANSACT2_FINDNOTIFYFIRST               0x0B
 643 #define TRANSACT2_FINDNOTIFYNEXT                0x0C
 644 #define TRANSACT2_MKDIR                         0x0D
 645 #define TRANSACT2_SESSION_SETUP                 0x0E
 646 #define TRANSACT2_GET_DFS_REFERRAL              0x10
 647 #define TRANSACT2_REPORT_DFS_INCONSISTANCY      0x11
 648
 649 /* These are the NT transact sub commands. */
 650 #define NT_TRANSACT_CREATE                1
 651 #define NT_TRANSACT_IOCTL                 2
 652 #define NT_TRANSACT_SET_SECURITY_DESC     3
 653 #define NT_TRANSACT_NOTIFY_CHANGE         4
 654 #define NT_TRANSACT_RENAME                5
 655 #define NT_TRANSACT_QUERY_SECURITY_DESC   6
 656 #define NT_TRANSACT_GET_USER_QUOTA        7
 657 #define NT_TRANSACT_SET_USER_QUOTA        8
 658
 659 /* These are the NT transact_get_user_quota sub commands */
 660 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE   0x0000
 661 #define TRANSACT_GET_USER_QUOTA_LIST_START      0x0100
 662 #define TRANSACT_GET_USER_QUOTA_FOR_SID         0x0101
 663
 664 /* Relevant IOCTL codes */
 665 #define IOCTL_QUERY_JOB_INFO      0x530060
 666
 667 /* these are the trans2 sub fields for primary requests */
 668 #define smb_tpscnt smb_vwv0
 669 #define smb_tdscnt smb_vwv1
 670 #define smb_mprcnt smb_vwv2
 671 #define smb_mdrcnt smb_vwv3
 672 #define smb_msrcnt smb_vwv4
 673 #define smb_flags smb_vwv5
 674 #define smb_timeout smb_vwv6
 675 #define smb_pscnt smb_vwv9
 676 #define smb_psoff smb_vwv10
 677 #define smb_dscnt smb_vwv11
 678 #define smb_dsoff smb_vwv12
 679 #define smb_suwcnt smb_vwv13
 680 #define smb_setup smb_vwv14
 681 #define smb_setup0 smb_setup
 682 #define smb_setup1 (smb_setup+2)
 683 #define smb_setup2 (smb_setup+4)
 684
 685 /* these are for the secondary requests */
 686 #define smb_spscnt smb_vwv2
 687 #define smb_spsoff smb_vwv3
 688 #define smb_spsdisp smb_vwv4
 689 #define smb_sdscnt smb_vwv5
 690 #define smb_sdsoff smb_vwv6
 691 #define smb_sdsdisp smb_vwv7
 692 #define smb_sfid smb_vwv8
 693
 694 /* and these for responses */
 695 #define smb_tprcnt smb_vwv0
 696 #define smb_tdrcnt smb_vwv1
 697 #define smb_prcnt smb_vwv3
 698 #define smb_proff smb_vwv4
 699 #define smb_prdisp smb_vwv5
 700 #define smb_drcnt smb_vwv6
 701 #define smb_droff smb_vwv7
 702 #define smb_drdisp smb_vwv8
 703
 704 /* these are for the NT trans primary request. */
 705 #define smb_nt_MaxSetupCount smb_vwv0
 706 #define smb_nt_Flags (smb_vwv0 + 1)
 707 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
 708 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
 709 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
 710 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
 711 #define smb_nt_ParameterCount (smb_vwv0 + 19)
 712 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
 713 #define smb_nt_DataCount (smb_vwv0 + 27)
 714 #define smb_nt_DataOffset (smb_vwv0 + 31)
 715 #define smb_nt_SetupCount (smb_vwv0 + 35)
 716 #define smb_nt_Function (smb_vwv0 + 36)
 717 #define smb_nt_SetupStart (smb_vwv0 + 38)
 718
 719 /* these are for the NT trans secondary request. */
 720 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
 721 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
 722 #define smb_nts_ParameterCount (smb_vwv0 + 11)
 723 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
 724 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
 725 #define smb_nts_DataCount (smb_vwv0 + 23)
 726 #define smb_nts_DataOffset (smb_vwv0 + 27)
 727 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
 728
 729 /* these are for the NT trans reply. */
 730 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
 731 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
 732 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
 733 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
 734 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
 735 #define smb_ntr_DataCount (smb_vwv0 + 23)
 736 #define smb_ntr_DataOffset (smb_vwv0 + 27)
 737 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
 738
 739 /* these are for the NT create_and_X */
 740 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
 741 #define smb_ntcreate_Flags (smb_vwv0 + 7)
 742 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
 743 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
 744 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
 745 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
 746 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
 747 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
 748 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
 749 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
 750 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
 751
 752 /* this is used on a TConX. I'm not sure the name is very helpful though */
 753 #define SMB_SUPPORT_SEARCH_BITS        0x0001
 754 #define SMB_SHARE_IN_DFS               0x0002
 755
 756 /* Named pipe write mode flags. Used in writeX calls. */
 757 #define PIPE_RAW_MODE 0x4
 758 #define PIPE_START_MESSAGE 0x8
 759
 760 /* the desired access to use when opening a pipe */
 761 #define DESIRED_ACCESS_PIPE 0x2019f
 762
 763 /* Mapping of access rights to UNIX perms. */
 764 #define UNIX_ACCESS_RWX         FILE_GENERIC_ALL
 765 #define UNIX_ACCESS_R           FILE_GENERIC_READ
 766 #define UNIX_ACCESS_W           FILE_GENERIC_WRITE
 767 #define UNIX_ACCESS_X           FILE_GENERIC_EXECUTE
 768
 769 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
 770 #define UNIX_DIRECTORY_ACCESS_RWX               FILE_GENERIC_ALL
 771 #define UNIX_DIRECTORY_ACCESS_R                 FILE_GENERIC_READ
 772 #define UNIX_DIRECTORY_ACCESS_W                 (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
 773 #define UNIX_DIRECTORY_ACCESS_X                 FILE_GENERIC_EXECUTE
 774
 775 #if 0
 776 /*
 777  * This is the old mapping we used to use. To get W2KSP2 profiles
 778  * working we need to map to the canonical file perms.
 779  */
 780 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
 781 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
 782                         FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
 783 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
 784                         FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
 785                         FILE_APPEND_DATA|FILE_WRITE_DATA)
 786 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
 787                         FILE_EXECUTE|FILE_READ_ATTRIBUTES)
 788 #endif
 789
 790 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
 791
 792 /* Flags field. */
 793 #define REQUEST_OPLOCK 2
 794 #define REQUEST_BATCH_OPLOCK 4
 795 #define OPEN_DIRECTORY 8
 796 #define EXTENDED_RESPONSE_REQUIRED 0x10
 797
 798 /* ShareAccess field. */
 799 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
 800 #define FILE_SHARE_READ 1
 801 #define FILE_SHARE_WRITE 2
 802 #define FILE_SHARE_DELETE 4
 803
 804 /* Flags - combined with attributes. */
 805 #define FILE_FLAG_WRITE_THROUGH    0x80000000L
 806 #define FILE_FLAG_NO_BUFFERING     0x20000000L
 807 #define FILE_FLAG_RANDOM_ACCESS    0x10000000L
 808 #define FILE_FLAG_SEQUENTIAL_SCAN  0x08000000L
 809 #define FILE_FLAG_DELETE_ON_CLOSE  0x04000000L
 810 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
 811 #define FILE_FLAG_POSIX_SEMANTICS  0x01000000L
 812
 813 /* CreateDisposition field. */
 814 #define FILE_SUPERSEDE 0                /* File exists overwrite/supersede. File not exist create. */
 815 #define FILE_OPEN 1                     /* File exists open. File not exist fail. */
 816 #define FILE_CREATE 2                   /* File exists fail. File not exist create. */
 817 #define FILE_OPEN_IF 3                  /* File exists open. File not exist create. */
 818 #define FILE_OVERWRITE 4                /* File exists overwrite. File not exist fail. */
 819 #define FILE_OVERWRITE_IF 5             /* File exists overwrite. File not exist create. */
 820
 821 /* CreateOptions field. */
 822 #define FILE_DIRECTORY_FILE       0x0001
 823 #define FILE_WRITE_THROUGH        0x0002
 824 #define FILE_SEQUENTIAL_ONLY      0x0004
 825 #define FILE_NO_INTERMEDIATE_BUFFERING 0x0008
 826 #define FILE_SYNCHRONOUS_IO_ALERT      0x0010   /* may be ignored */
 827 #define FILE_SYNCHRONOUS_IO_NONALERT   0x0020   /* may be ignored */
 828 #define FILE_NON_DIRECTORY_FILE   0x0040
 829 #define FILE_CREATE_TREE_CONNECTION    0x0080   /* ignore, should be zero */
 830 #define FILE_COMPLETE_IF_OPLOCKED      0x0100   /* ignore, should be zero */
 831 #define FILE_NO_EA_KNOWLEDGE      0x0200
 832 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400 /* aka OPEN_FOR_RECOVERY: ignore, should be zero */
 833 #define FILE_RANDOM_ACCESS        0x0800
 834 #define FILE_DELETE_ON_CLOSE      0x1000
 835 #define FILE_OPEN_BY_FILE_ID      0x2000
 836 #define FILE_OPEN_FOR_BACKUP_INTENT    0x4000
 837 #define FILE_NO_COMPRESSION       0x8000
 838 #define FILE_RESERVER_OPFILTER    0x00100000    /* ignore, should be zero */
 839 #define FILE_OPEN_REPARSE_POINT   0x00200000
 840 #define FILE_OPEN_NO_RECALL       0x00400000
 841 #define FILE_OPEN_FOR_FREE_SPACE_QUERY 0x00800000 /* ignore should be zero */
 842
 843 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK      (0x008F0480)
 844
 845 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK    (0xFF100030)
 846
 847 /*
 848  * Private create options used by the ntcreatex processing code. From Samba4.
 849  * We reuse some ignored flags for private use. Passed in the private_flags
 850  * argument.
 851  */
 852 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS     0x0001
 853 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB     0x0002
 854
 855 /* Private options for streams support */
 856 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x0004
 857
 858 /* Private options for printer support */
 859 #define NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE 0x0008
 860
 861 /* Responses when opening a file. */
 862 #define FILE_WAS_SUPERSEDED 0
 863 #define FILE_WAS_OPENED 1
 864 #define FILE_WAS_CREATED 2
 865 #define FILE_WAS_OVERWRITTEN 3
 866
 867 /* Flag for NT transact rename call. */
 868 #define RENAME_REPLACE_IF_EXISTS 1
 869
 870 /* flags for SMBntrename call (from Samba4) */
 871 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
 872 #define RENAME_FLAG_HARD_LINK                0x103
 873 #define RENAME_FLAG_RENAME                   0x104
 874 #define RENAME_FLAG_COPY                     0x105
 875
 876 /* Filesystem Attributes. */
 877 #define FILE_CASE_SENSITIVE_SEARCH      0x00000001
 878 #define FILE_CASE_PRESERVED_NAMES       0x00000002
 879 #define FILE_UNICODE_ON_DISK            0x00000004
 880 /* According to cifs9f, this is 4, not 8 */
 881 /* Acconding to testing, this actually sets the security attribute! */
 882 #define FILE_PERSISTENT_ACLS            0x00000008
 883 #define FILE_FILE_COMPRESSION           0x00000010
 884 #define FILE_VOLUME_QUOTAS              0x00000020
 885 #define FILE_SUPPORTS_SPARSE_FILES      0x00000040
 886 #define FILE_SUPPORTS_REPARSE_POINTS    0x00000080
 887 #define FILE_SUPPORTS_REMOTE_STORAGE    0x00000100
 888 #define FS_LFN_APIS                     0x00004000
 889 #define FILE_VOLUME_IS_COMPRESSED       0x00008000
 890 #define FILE_SUPPORTS_OBJECT_IDS        0x00010000
 891 #define FILE_SUPPORTS_ENCRYPTION        0x00020000
 892 #define FILE_NAMED_STREAMS              0x00040000
 893 #define FILE_READ_ONLY_VOLUME           0x00080000
 894
 895 /* ChangeNotify flags. */
 896 #define FILE_NOTIFY_CHANGE_FILE_NAME   0x001
 897 #define FILE_NOTIFY_CHANGE_DIR_NAME    0x002
 898 #define FILE_NOTIFY_CHANGE_ATTRIBUTES  0x004
 899 #define FILE_NOTIFY_CHANGE_SIZE        0x008
 900 #define FILE_NOTIFY_CHANGE_LAST_WRITE  0x010
 901 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
 902 #define FILE_NOTIFY_CHANGE_CREATION    0x040
 903 #define FILE_NOTIFY_CHANGE_EA          0x080
 904 #define FILE_NOTIFY_CHANGE_SECURITY    0x100
 905 #define FILE_NOTIFY_CHANGE_STREAM_NAME  0x00000200
 906 #define FILE_NOTIFY_CHANGE_STREAM_SIZE  0x00000400
 907 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
 908
 909 #define FILE_NOTIFY_CHANGE_NAME \
 910         (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
 911
 912 /* change notify action results */
 913 #define NOTIFY_ACTION_ADDED 1
 914 #define NOTIFY_ACTION_REMOVED 2
 915 #define NOTIFY_ACTION_MODIFIED 3
 916 #define NOTIFY_ACTION_OLD_NAME 4
 917 #define NOTIFY_ACTION_NEW_NAME 5
 918 #define NOTIFY_ACTION_ADDED_STREAM 6
 919 #define NOTIFY_ACTION_REMOVED_STREAM 7
 920 #define NOTIFY_ACTION_MODIFIED_STREAM 8
 921
 922
 923 /* where to find the base of the SMB packet proper */
 924 #define smb_base(buf) (((const char *)(buf))+4)
 925
 926 /* we don't allow server strings to be longer than 48 characters as
 927    otherwise NT will not honour the announce packets */
 928 #define MAX_SERVER_STRING_LENGTH 48
 929
 930
 931 #define SMB_SUCCESS 0  /* The request was successful. */
 932
 933 #ifdef WITH_DFS
 934 void dfs_unlogin(void);
 935 extern int dcelogin_atmost_once;
 936 #endif
 937
 938 #ifdef NOSTRDUP
 939 char *strdup(char *s);
 940 #endif
 941
 942 #ifndef SELECT_CAST
 943 #define SELECT_CAST
 944 #endif
 945
 946 /* This was set by JHT in liaison with Jeremy Allison early 1997
 947  * History:
 948  * Version 4.0 - never made public
 949  * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
 950  *              - Reappeared in 1.9.16p11 with fixed smbd services
 951  * Version 4.20 - To indicate that nmbd and browsing now works better
 952  * Version 4.50 - Set at release of samba-2.2.0 by JHT
 953  *
 954  *  Note: In the presence of NT4.X do not set above 4.9
 955  *        Setting this above 4.9 can have undesired side-effects.
 956  *        This may change again in Samba-3.0 after further testing. JHT
 957  */
 958
 959 #define SAMBA_MAJOR_NBT_ANNOUNCE_VERSION 0x04
 960 #define SAMBA_MINOR_NBT_ANNOUNCE_VERSION 0x09
 961
 962 /* Browser Election Values */
 963 #define BROWSER_ELECTION_VERSION        0x010f
 964 #define BROWSER_CONSTANT        0xaa55
 965
 966 /* TCONX Flag (smb_vwv2). */
 967 #define TCONX_FLAG_EXTENDED_RESPONSE    0x8
 968
 969 /* File Status Flags. See:
 970
 971 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
 972 */
 973
 974 #define NO_EAS                  0x1
 975 #define NO_SUBSTREAMS           0x2
 976 #define NO_REPARSETAG           0x4
 977
 978 /* printing types */
 979 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
 980                      PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
 981                      PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
 982 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
 983 ,PRINT_TEST,PRINT_VLP
 984 #endif /* DEVELOPER */
 985 };
 986
 987 /* LDAP SSL options */
 988 enum ldap_ssl_types {LDAP_SSL_OFF, LDAP_SSL_START_TLS};
 989
 990 /* LDAP PASSWD SYNC methods */
 991 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
 992
 993 /*
 994  * This should be under the HAVE_KRB5 flag but since they're used
 995  * in lp_kerberos_method(), they ned to be always available
 996  * If you add any entries to KERBEROS_VERIFY defines, please modify USE.*KEYTAB macros
 997  * so they remain accurate.
 998  */
 999
1000 #define KERBEROS_VERIFY_SECRETS 0
1001 #define KERBEROS_VERIFY_SYSTEM_KEYTAB 1
1002 #define KERBEROS_VERIFY_DEDICATED_KEYTAB 2
1003 #define KERBEROS_VERIFY_SECRETS_AND_KEYTAB 3
1004
1005 /* Remote architectures we know about. */
1006 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1007                         RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
1008                         RA_SAMBA, RA_CIFSFS, RA_WINXP64, RA_OSX};
1009
1010 /* case handling */
1011 enum case_handling {CASE_LOWER,CASE_UPPER};
1012
1013 /* ACL compatibility */
1014 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
1015 /*
1016  * Global value meaing that the smb_uid field should be
1017  * ingored (in share level security and protocol level == CORE)
1018  */
1019
1020 #define UID_FIELD_INVALID 0
1021 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1022
1023 /*
1024  * Size of buffer to use when moving files across filesystems.
1025  */
1026 #define COPYBUF_SIZE (8*1024)
1027
1028 /*
1029  * Map the Core and Extended Oplock requesst bits down
1030  * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1031  */
1032
1033 /*
1034  * Core protocol.
1035  */
1036 #define CORE_OPLOCK_REQUEST(inbuf) \
1037     ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1038
1039 /*
1040  * Extended protocol.
1041  */
1042 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1043
1044 /*
1045  * Bits we test with.
1046  * Note these must fit into 16-bits.
1047  */
1048
1049 #define NO_OPLOCK                       OPLOCK_NONE
1050 #define EXCLUSIVE_OPLOCK                OPLOCK_EXCLUSIVE
1051 #define BATCH_OPLOCK                    OPLOCK_BATCH
1052 #define LEVEL_II_OPLOCK                 OPLOCK_LEVEL_II
1053
1054 /* The following are Samba-private. */
1055 #define INTERNAL_OPEN_ONLY              0x8
1056 #define FAKE_LEVEL_II_OPLOCK            0x10    /* Client requested no_oplock, but we have to
1057                                  * inform potential level2 holders on
1058                                  * write. */
1059 #define DEFERRED_OPEN_ENTRY             0x20
1060 /* #define UNUSED_SHARE_MODE_ENTRY      0x40 */   /* Not used anymore */
1061 #define FORCE_OPLOCK_BREAK_TO_NONE      0x80
1062
1063 /* None of the following should ever appear in fsp->oplock_request. */
1064 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1065
1066 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1067 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1068 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1069
1070 /* kernel_oplock_message definition.
1071
1072 struct kernel_oplock_message {
1073         uint64_t dev;
1074         uint64_t inode;
1075         unit64_t extid;
1076         unsigned long file_id;
1077 };
1078
1079 Offset  Data                  length.
1080 0     uint64_t dev            8 bytes
1081 8     uint64_t inode          8 bytes
1082 16    uint64_t extid          8 bytes
1083 24    unsigned long file_id   4 bytes
1084 28
1085
1086 */
1087 #define MSG_SMB_KERNEL_BREAK_SIZE 28
1088
1089 /* file_renamed_message definition.
1090
1091 struct file_renamed_message {
1092         uint64_t dev;
1093         uint64_t inode;
1094         char names[1]; A variable area containing sharepath and filename.
1095 };
1096
1097 Offset  Data                    length.
1098 0       uint64_t dev            8 bytes
1099 8       uint64_t inode          8 bytes
1100 16      unit64_t extid          8 bytes
1101 24      char [] name            zero terminated namelen bytes
1102 minimum length == 24.
1103
1104 */
1105
1106 #define MSG_FILE_RENAMED_MIN_SIZE 24
1107
1108 /*
1109  * On the wire return values for oplock types.
1110  */
1111
1112 #define CORE_OPLOCK_GRANTED (1<<5)
1113 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1114
1115 #define NO_OPLOCK_RETURN 0
1116 #define EXCLUSIVE_OPLOCK_RETURN 1
1117 #define BATCH_OPLOCK_RETURN 2
1118 #define LEVEL_II_OPLOCK_RETURN 3
1119
1120 /* Oplock levels */
1121 #define OPLOCKLEVEL_NONE 0
1122 #define OPLOCKLEVEL_II 1
1123
1124 /*
1125  * Capabilities abstracted for different systems.
1126  */
1127
1128 enum smbd_capability {
1129     KERNEL_OPLOCK_CAPABILITY,
1130     DMAPI_ACCESS_CAPABILITY,
1131     LEASE_CAPABILITY
1132 };
1133
1134 /*
1135  * Kernel oplocks capability flags.
1136  */
1137
1138 /* Level 2 oplocks are supported natively by kernel oplocks. */
1139 #define KOPLOCKS_LEVEL2_SUPPORTED               0x1
1140
1141 /* The kernel notifies deferred openers when they can retry the open. */
1142 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION     0x2
1143
1144 /* The kernel notifies smbds when an oplock break times out. */
1145 #define KOPLOCKS_TIMEOUT_NOTIFICATION           0x4
1146
1147 /* The kernel notifies smbds when an oplock is broken. */
1148 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION     0x8
1149
1150 struct kernel_oplocks_ops;
1151 struct kernel_oplocks {
1152         const struct kernel_oplocks_ops *ops;
1153         uint32_t flags;
1154         void *private_data;
1155 };
1156
1157 enum level2_contention_type {
1158         LEVEL2_CONTEND_ALLOC_SHRINK,
1159         LEVEL2_CONTEND_ALLOC_GROW,
1160         LEVEL2_CONTEND_SET_FILE_LEN,
1161         LEVEL2_CONTEND_FILL_SPARSE,
1162         LEVEL2_CONTEND_WRITE,
1163         LEVEL2_CONTEND_WINDOWS_BRL,
1164         LEVEL2_CONTEND_POSIX_BRL
1165 };
1166
1167 /* if a kernel does support oplocks then a structure of the following
1168    typee is used to describe how to interact with the kernel */
1169 struct kernel_oplocks_ops {
1170         bool (*set_oplock)(struct kernel_oplocks *ctx,
1171                            files_struct *fsp, int oplock_type);
1172         void (*release_oplock)(struct kernel_oplocks *ctx,
1173                                files_struct *fsp, int oplock_type);
1174         void (*contend_level2_oplocks_begin)(files_struct *fsp,
1175                                              enum level2_contention_type type);
1176         void (*contend_level2_oplocks_end)(files_struct *fsp,
1177                                            enum level2_contention_type type);
1178 };
1179
1180 #include "smb_macros.h"
1181
1182 #define MAX_NETBIOSNAME_LEN 16
1183 /* DOS character, NetBIOS namestring. Type used on the wire. */
1184 typedef char nstring[MAX_NETBIOSNAME_LEN];
1185 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1186 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1187
1188 /* A netbios name structure. */
1189 struct nmb_name {
1190         nstring      name;
1191         char         scope[64];
1192         unsigned int name_type;
1193 };
1194
1195 /* A netbios node status array element. */
1196 struct node_status {
1197         nstring name;
1198         unsigned char type;
1199         unsigned char flags;
1200 };
1201
1202 /* The extra info from a NetBIOS node status query */
1203 struct node_status_extra {
1204         unsigned char mac_addr[6];
1205         /* There really is more here ... */
1206 };
1207
1208 typedef struct user_struct {
1209         struct user_struct *next, *prev;
1210         uint16 vuid; /* Tag for this entry. */
1211
1212         char *session_keystr; /* used by utmp and pam session code.
1213                                  TDB key string */
1214         int homes_snum;
1215
1216         struct auth_session_info *session_info;
1217
1218         struct auth_ntlmssp_state *auth_ntlmssp_state;
1219 } user_struct;
1220
1221 /*
1222    Do you want session setups at user level security with a invalid
1223    password to be rejected or allowed in as guest? WinNT rejects them
1224    but it can be a pain as it means "net view" needs to use a password
1225
1226    You have 3 choices in the setting of map_to_guest:
1227
1228    "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1229    are rejected. This is the default.
1230
1231    "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1232    are rejected, unless the username does not exist, in which case it
1233    is treated as a guest login
1234
1235    "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1236    are treated as a guest login
1237
1238    Note that map_to_guest only has an effect in user or server
1239    level security.
1240 */
1241
1242 #define NEVER_MAP_TO_GUEST              0
1243 #define MAP_TO_GUEST_ON_BAD_USER        1
1244 #define MAP_TO_GUEST_ON_BAD_PASSWORD    2
1245 #define MAP_TO_GUEST_ON_BAD_UID         3
1246
1247 #define SAFE_NETBIOS_CHARS ". -_"
1248
1249 /* The maximum length of a trust account password.
1250    Used when we randomly create it, 15 char passwords
1251    exceed NT4's max password length */
1252
1253 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1254
1255 #define PORT_NONE       0
1256 #ifndef LDAP_PORT
1257 #define LDAP_PORT       389
1258 #endif
1259 #define LDAP_GC_PORT    3268
1260
1261 /* used by the IP comparison function */
1262 struct ip_service {
1263         struct sockaddr_storage ss;
1264         unsigned port;
1265 };
1266
1267 struct ea_struct {
1268         uint8 flags;
1269         char *name;
1270         DATA_BLOB value;
1271 };
1272
1273 struct ea_list {
1274         struct ea_list *next, *prev;
1275         struct ea_struct ea;
1276 };
1277
1278 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1279 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1280 /* EA to use for DOS attributes */
1281 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1282 /* Prefix for DosStreams in the vfs_streams_xattr module */
1283 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1284 /* Prefix for xattrs storing streams. */
1285 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
1286
1287 /* map readonly options */
1288 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1289
1290 /* usershare error codes. */
1291 enum usershare_err {
1292                 USERSHARE_OK=0,
1293                 USERSHARE_MALFORMED_FILE,
1294                 USERSHARE_BAD_VERSION,
1295                 USERSHARE_MALFORMED_PATH,
1296                 USERSHARE_MALFORMED_COMMENT_DEF,
1297                 USERSHARE_MALFORMED_ACL_DEF,
1298                 USERSHARE_ACL_ERR,
1299                 USERSHARE_PATH_NOT_ABSOLUTE,
1300                 USERSHARE_PATH_IS_DENIED,
1301                 USERSHARE_PATH_NOT_ALLOWED,
1302                 USERSHARE_PATH_NOT_DIRECTORY,
1303                 USERSHARE_POSIX_ERR,
1304                 USERSHARE_MALFORMED_SHARENAME_DEF,
1305                 USERSHARE_BAD_SHARENAME
1306 };
1307
1308 /* Different reasons for closing a file. */
1309 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1310
1311 /* Used in SMB_FS_OBJECTID_INFORMATION requests.  Must be exactly 48 bytes. */
1312 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1313 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1314 struct smb_extended_info {
1315         uint32 samba_magic;             /* Always SAMBA_EXTRA_INFO_MAGIC */
1316         uint32 samba_version;           /* Major/Minor/Release/Revision */
1317         uint32 samba_subversion;        /* Prerelease/RC/Vendor patch */
1318         NTTIME samba_gitcommitdate;
1319         char   samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
1320 };
1321
1322 /* time info */
1323 struct smb_file_time {
1324         struct timespec mtime;
1325         struct timespec atime;
1326         struct timespec ctime;
1327         struct timespec create_time;
1328 };
1329
1330 /*
1331  * unix_convert_flags
1332  */
1333 #define UCF_SAVE_LCOMP                  0x00000001
1334 #define UCF_ALWAYS_ALLOW_WCARD_LCOMP    0x00000002
1335 #define UCF_COND_ALLOW_WCARD_LCOMP      0x00000004
1336 #define UCF_POSIX_PATHNAMES             0x00000008
1337 #define UCF_UNIX_NAME_LOOKUP            0x00000010
1338
1339 /*
1340  * smb_filename
1341  */
1342 struct smb_filename {
1343         char *base_name;
1344         char *stream_name;
1345         char *original_lcomp;
1346         SMB_STRUCT_STAT st;
1347 };
1348
1349 /* Used to keep track of deferred opens. */
1350 struct deferred_open_record;
1351
1352 /* Used inside aio code. */
1353 struct aio_extra;
1354
1355 /*
1356  * Reasons for cache flush.
1357  */
1358
1359 enum flush_reason_enum {
1360     SEEK_FLUSH,
1361     READ_FLUSH,
1362     WRITE_FLUSH,
1363     READRAW_FLUSH,
1364     OPLOCK_RELEASE_FLUSH,
1365     CLOSE_FLUSH,
1366     SYNC_FLUSH,
1367     SIZECHANGE_FLUSH,
1368     /* NUM_FLUSH_REASONS must remain the last value in the enumeration. */
1369     NUM_FLUSH_REASONS};
1370
1371 #endif /* _SMB_H */