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