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