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