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