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