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