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
  31 /* logged when starting the various Samba daemons */
  32 #define COPYRIGHT_STARTUP_MESSAGE       "Copyright Andrew Tridgell and the Samba Team 1992-2011"
  33
  34
  35 #if defined(LARGE_SMB_OFF_T)
  36 #define BUFFER_SIZE (128*1024)
  37 #else /* no large readwrite possible */
  38 #define BUFFER_SIZE (0xFFFF)
  39 #endif
  40
  41 #define SAFETY_MARGIN 1024
  42 #define LARGE_WRITEX_HDR_SIZE 65
  43
  44 #define NMB_PORT 137
  45 #define DGRAM_PORT 138
  46 #define SMB_PORT1 445
  47 #define SMB_PORT2 139
  48 #define SMB_PORTS "445 139"
  49
  50 #define Undefined (-1)
  51 #define False false
  52 #define True true
  53 #define Auto (2)
  54 #define Required (3)
  55
  56 #define SIZEOFWORD 2
  57
  58 #ifndef DEF_CREATE_MASK
  59 #define DEF_CREATE_MASK (0755)
  60 #endif
  61
  62 /* string manipulation flags - see clistr.c and srvstr.c */
  63 #define STR_TERMINATE 1
  64 #define STR_UPPER 2
  65 #define STR_ASCII 4
  66 #define STR_UNICODE 8
  67 #define STR_NOALIGN 16
  68 #define STR_TERMINATE_ASCII 128
  69
  70 /* how long to wait for secondary SMB packets (milli-seconds) */
  71 #define SMB_SECONDARY_WAIT (60*1000)
  72
  73 /* Debugging stuff */
  74 #include "lib/util/debug.h"
  75 #include "lib/util/debug_s3.h"
  76
  77 /* this defines the error codes that receive_smb can put in smb_read_error */
  78 enum smb_read_errors {
  79         SMB_READ_OK = 0,
  80         SMB_READ_TIMEOUT,
  81         SMB_READ_EOF,
  82         SMB_READ_ERROR,
  83         SMB_WRITE_ERROR, /* This error code can go into the client smb_rw_error. */
  84         SMB_READ_BAD_SIG,
  85         SMB_NO_MEMORY,
  86         SMB_DO_NOT_DO_TDIS, /* cli_close_connection() check for this when smbfs wants to keep tree connected */
  87         SMB_READ_BAD_DECRYPT
  88 };
  89
  90 #define DIR_STRUCT_SIZE 43
  91
  92 /* these define the attribute byte as seen by DOS */
  93 #define aRONLY (1L<<0)          /* 0x01 */
  94 #define aHIDDEN (1L<<1)         /* 0x02 */
  95 #define aSYSTEM (1L<<2)         /* 0x04 */
  96 #define aVOLID (1L<<3)          /* 0x08 */
  97 #define aDIR (1L<<4)            /* 0x10 */
  98 #define aARCH (1L<<5)           /* 0x20 */
  99
 100 /* deny modes */
 101 #define DENY_DOS 0
 102 #define DENY_ALL 1
 103 #define DENY_WRITE 2
 104 #define DENY_READ 3
 105 #define DENY_NONE 4
 106 #define DENY_FCB 7
 107
 108 /* open modes */
 109 #define DOS_OPEN_RDONLY 0
 110 #define DOS_OPEN_WRONLY 1
 111 #define DOS_OPEN_RDWR 2
 112 #define DOS_OPEN_EXEC 3
 113 #define DOS_OPEN_FCB 0xF
 114
 115 /* define shifts and masks for share and open modes. */
 116 #define OPENX_MODE_MASK 0xF
 117 #define DENY_MODE_SHIFT 4
 118 #define DENY_MODE_MASK 0x7
 119 #define GET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
 120 #define SET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
 121 #define GET_DENY_MODE(x) (((x)>>DENY_MODE_SHIFT) & DENY_MODE_MASK)
 122 #define SET_DENY_MODE(x) (((x) & DENY_MODE_MASK) <<DENY_MODE_SHIFT)
 123
 124 /* Sync on open file (not sure if used anymore... ?) */
 125 #define FILE_SYNC_OPENMODE (1<<14)
 126 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
 127
 128 /* open disposition values */
 129 #define OPENX_FILE_EXISTS_FAIL 0
 130 #define OPENX_FILE_EXISTS_OPEN 1
 131 #define OPENX_FILE_EXISTS_TRUNCATE 2
 132
 133 /* mask for open disposition. */
 134 #define OPENX_FILE_OPEN_MASK 0x3
 135
 136 #define GET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
 137 #define SET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
 138
 139 /* The above can be OR'ed with... */
 140 #define OPENX_FILE_CREATE_IF_NOT_EXIST 0x10
 141 #define OPENX_FILE_FAIL_IF_NOT_EXIST 0
 142
 143 typedef union unid_t {
 144         uid_t uid;
 145         gid_t gid;
 146 } unid_t;
 147
 148 /* pipe string names */
 149
 150 #ifndef MAXSUBAUTHS
 151 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
 152 #endif
 153
 154 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
 155
 156 #define LOOKUP_NAME_NONE                0x00000000
 157 #define LOOKUP_NAME_ISOLATED             0x00000001  /* Look up unqualified names */
 158 #define LOOKUP_NAME_REMOTE               0x00000002  /* Ask others */
 159 #define LOOKUP_NAME_GROUP                0x00000004  /* (unused) This is a NASTY hack for
 160                                                         valid users = @foo where foo also
 161                                                         exists in as user. */
 162 #define LOOKUP_NAME_NO_NSS               0x00000008  /* no NSS calls to avoid
 163                                                         winbind recursions */
 164 #define LOOKUP_NAME_BUILTIN             0x00000010 /* builtin names */
 165 #define LOOKUP_NAME_WKN                 0x00000020 /* well known names */
 166 #define LOOKUP_NAME_DOMAIN              0x00000040 /* only lookup own domain */
 167 #define LOOKUP_NAME_LOCAL               (LOOKUP_NAME_ISOLATED\
 168                                         |LOOKUP_NAME_BUILTIN\
 169                                         |LOOKUP_NAME_WKN\
 170                                         |LOOKUP_NAME_DOMAIN)
 171 #define LOOKUP_NAME_ALL                 (LOOKUP_NAME_ISOLATED\
 172                                         |LOOKUP_NAME_REMOTE\
 173                                         |LOOKUP_NAME_BUILTIN\
 174                                         |LOOKUP_NAME_WKN\
 175                                         |LOOKUP_NAME_DOMAIN)
 176
 177 #include "librpc/gen_ndr/dcerpc.h"
 178 #include "librpc/gen_ndr/security.h"
 179
 180 /*
 181  * The complete list of SIDS belonging to this user.
 182  * Created when a vuid is registered.
 183  * The definition of the user_sids array is as follows :
 184  *
 185  * token->user_sids[0] = primary user SID.
 186  * token->user_sids[1] = primary group SID.
 187  * token->user_sids[2..num_sids] = supplementary group SIDS.
 188  */
 189
 190 #define PRIMARY_USER_SID_INDEX 0
 191 #define PRIMARY_GROUP_SID_INDEX 1
 192
 193 typedef struct write_cache {
 194         SMB_OFF_T file_size;
 195         SMB_OFF_T offset;
 196         size_t alloc_size;
 197         size_t data_size;
 198         char *data;
 199 } write_cache;
 200
 201 struct fd_handle {
 202         size_t ref_count;
 203         int fd;
 204         uint64_t position_information;
 205         SMB_OFF_T pos;
 206         uint32 private_options; /* NT Create options, but we only look at
 207                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
 208                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB and
 209                                  * NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE
 210                                  * for print files *only*, where
 211                                  * DELETE_ON_CLOSE is not stored in the share
 212                                  * mode database.
 213                                  */
 214         unsigned long gen_id;
 215 };
 216
 217 struct idle_event;
 218 struct share_mode_entry;
 219 struct uuid;
 220 struct named_mutex;
 221 struct wb_context;
 222 struct rpc_cli_smbd_conn;
 223 struct fncall_context;
 224
 225 struct vfs_fsp_data {
 226     struct vfs_fsp_data *next;
 227     struct vfs_handle_struct *owner;
 228     void (*destroy)(void *p_data);
 229     void *_dummy_;
 230     /* NOTE: This structure contains four pointers so that we can guarantee
 231      * that the end of the structure is always both 4-byte and 8-byte aligned.
 232      */
 233 };
 234
 235 /* the basic packet size, assuming no words or bytes */
 236 #define smb_size 39
 237
 238 struct notify_change {
 239         uint32_t action;
 240         const char *name;
 241 };
 242
 243 struct notify_mid_map;
 244 struct notify_entry;
 245 struct notify_event;
 246 struct notify_change_request;
 247 struct sys_notify_backend;
 248 struct sys_notify_context {
 249         struct event_context *ev;
 250         struct connection_struct *conn;
 251         void *private_data;     /* For use by the system backend */
 252 };
 253
 254 struct notify_change_buf {
 255         /*
 256          * If no requests are pending, changes are queued here. Simple array,
 257          * we only append.
 258          */
 259
 260         /*
 261          * num_changes == -1 means that we have got a catch-all change, when
 262          * asked we just return NT_STATUS_OK without specific changes.
 263          */
 264         int num_changes;
 265         struct notify_change *changes;
 266
 267         /*
 268          * If no changes are around requests are queued here. Using a linked
 269          * list, because we have to append at the end and delete from the top.
 270          */
 271         struct notify_change_request *requests;
 272 };
 273
 274 struct print_file_data {
 275         char *svcname;
 276         char *docname;
 277         char *filename;
 278         struct policy_handle handle;
 279         uint32_t jobid;
 280         uint16 rap_jobid;
 281 };
 282
 283 typedef struct files_struct {
 284         struct files_struct *next, *prev;
 285         int fnum;
 286         struct connection_struct *conn;
 287         struct fd_handle *fh;
 288         unsigned int num_smb_operations;
 289         struct file_id file_id;
 290         uint64_t initial_allocation_size; /* Faked up initial allocation on disk. */
 291         mode_t mode;
 292         uint16 file_pid;
 293         uint16 vuid;
 294         write_cache *wcp;
 295         struct timeval open_time;
 296         uint32 access_mask;             /* NTCreateX access bits (FILE_READ_DATA etc.) */
 297         uint32 share_access;            /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
 298
 299         bool update_write_time_triggered;
 300         struct timed_event *update_write_time_event;
 301         bool update_write_time_on_close;
 302         struct timespec close_write_time;
 303         bool write_time_forced;
 304
 305         int oplock_type;
 306         int sent_oplock_break;
 307         struct timed_event *oplock_timeout;
 308         struct lock_struct last_lock_failure;
 309         int current_lock_count; /* Count the number of outstanding locks and pending locks. */
 310
 311         struct share_mode_entry *pending_break_messages;
 312         int num_pending_break_messages;
 313
 314         bool can_lock;
 315         bool can_read;
 316         bool can_write;
 317         bool modified;
 318         bool is_directory;
 319         bool aio_write_behind;
 320         bool lockdb_clean;
 321         bool initial_delete_on_close; /* Only set at NTCreateX if file was created. */
 322         bool delete_on_close;
 323         bool posix_open;
 324         bool is_sparse;
 325         struct smb_filename *fsp_name;
 326         uint32_t name_hash;             /* Jenkins hash of full pathname. */
 327
 328         struct vfs_fsp_data *vfs_extension;
 329         struct fake_file_handle *fake_file_handle;
 330
 331         struct notify_change_buf *notify;
 332
 333         struct files_struct *base_fsp; /* placeholder for delete on close */
 334
 335         /*
 336          * Read-only cached brlock record, thrown away when the
 337          * brlock.tdb seqnum changes. This avoids fetching data from
 338          * the brlock.tdb on every read/write call.
 339          */
 340         int brlock_seqnum;
 341         struct byte_range_lock *brlock_rec;
 342
 343         struct dptr_struct *dptr;
 344
 345         /* if not NULL, means this is a print file */
 346         struct print_file_data *print_file;
 347
 348 } files_struct;
 349
 350 #include "ntquotas.h"
 351 #include "sysquotas.h"
 352
 353 struct client_address {
 354         char addr[INET6_ADDRSTRLEN];
 355         const char *name;
 356 };
 357
 358 struct vuid_cache_entry {
 359         struct auth_serversupplied_info *session_info;
 360         uint16_t vuid;
 361         bool read_only;
 362 };
 363
 364 struct vuid_cache {
 365         unsigned int next_entry;
 366         struct vuid_cache_entry array[VUID_CACHE_SIZE];
 367 };
 368
 369 typedef struct {
 370         char *name;
 371         bool is_wild;
 372 } name_compare_entry;
 373
 374 struct trans_state {
 375         struct trans_state *next, *prev;
 376         uint16 vuid;
 377         uint64_t mid;
 378
 379         uint32 max_param_return;
 380         uint32 max_data_return;
 381         uint32 max_setup_return;
 382
 383         uint8 cmd;              /* SMBtrans or SMBtrans2 */
 384
 385         char *name;             /* for trans requests */
 386         uint16 call;            /* for trans2 and nttrans requests */
 387
 388         bool close_on_completion;
 389         bool one_way;
 390
 391         unsigned int setup_count;
 392         uint16 *setup;
 393
 394         size_t received_data;
 395         size_t received_param;
 396
 397         size_t total_param;
 398         char *param;
 399
 400         size_t total_data;
 401         char *data;
 402 };
 403
 404 /*
 405  * Info about an alternate data stream
 406  */
 407
 408 struct stream_struct {
 409         SMB_OFF_T size;
 410         SMB_OFF_T alloc_size;
 411         char *name;
 412 };
 413
 414 /* Include VFS stuff */
 415
 416 #include "smb_acls.h"
 417 #include "vfs.h"
 418
 419 struct dfree_cached_info {
 420         time_t last_dfree_time;
 421         uint64_t dfree_ret;
 422         uint64_t bsize;
 423         uint64_t dfree;
 424         uint64_t dsize;
 425 };
 426
 427 struct dptr_struct;
 428
 429 struct share_params {
 430         int service;
 431 };
 432
 433 struct share_iterator {
 434         int next_id;
 435 };
 436
 437 typedef struct connection_struct {
 438         struct connection_struct *next, *prev;
 439         struct smbd_server_connection *sconn; /* can be NULL */
 440         unsigned cnum; /* an index passed over the wire */
 441         struct share_params *params;
 442         bool force_user;
 443         struct vuid_cache vuid_cache;
 444         bool printer;
 445         bool ipc;
 446         bool read_only; /* Attributes for the current user of the share. */
 447         /* Does this filesystem honor
 448            sub second timestamps on files
 449            and directories when setting time ? */
 450         enum timestamp_set_resolution ts_res;
 451         char *connectpath;
 452         char *origpath;
 453
 454         struct vfs_handle_struct *vfs_handles;          /* for the new plugins */
 455
 456         /*
 457          * This represents the user information on this connection. Depending
 458          * on the vuid using this tid, this might change per SMB request.
 459          */
 460         struct auth_serversupplied_info *session_info;
 461
 462         /*
 463          * If the "force group" parameter is set, this is the primary gid that
 464          * may be used in the users token, depending on the vuid using this tid.
 465          */
 466         gid_t force_group_gid;
 467
 468         uint16 vuid; /* vuid of user who *opened* this connection, or UID_FIELD_INVALID */
 469
 470         time_t lastused;
 471         time_t lastused_count;
 472         bool used;
 473         int num_files_open;
 474         unsigned int num_smb_operations; /* Count of smb operations on this tree. */
 475         int encrypt_level;
 476         bool encrypted_tid;
 477
 478         /* Semantics requested by the client or forced by the server config. */
 479         bool case_sensitive;
 480         bool case_preserve;
 481         bool short_case_preserve;
 482
 483         /* Semantics provided by the underlying filesystem. */
 484         int fs_capabilities;
 485         /* Device number of the directory of the share mount.
 486            Used to ensure unique FileIndex returns. */
 487         SMB_DEV_T base_share_dev;
 488
 489         name_compare_entry *hide_list; /* Per-share list of files to return as hidden. */
 490         name_compare_entry *veto_list; /* Per-share list of files to veto (never show). */
 491         name_compare_entry *veto_oplock_list; /* Per-share list of files to refuse oplocks on. */
 492         name_compare_entry *aio_write_behind_list; /* Per-share list of files to use aio write behind on. */
 493         struct dfree_cached_info *dfree_info;
 494         struct trans_state *pending_trans;
 495         struct notify_context *notify_ctx;
 496
 497         struct rpc_pipe_client *spoolss_pipe;
 498
 499 } connection_struct;
 500
 501 struct current_user {
 502         connection_struct *conn;
 503         uint16 vuid;
 504         struct security_unix_token ut;
 505         struct security_token *nt_user_token;
 506 };
 507
 508 struct smbd_smb2_request;
 509
 510 struct smb_request {
 511         uint8_t cmd;
 512         uint16 flags2;
 513         uint16 smbpid;
 514         uint64_t mid; /* For compatibility with SMB2. */
 515         uint32_t seqnum;
 516         uint16 vuid;
 517         uint16 tid;
 518         uint8  wct;
 519         uint16_t *vwv;
 520         uint16_t buflen;
 521         const uint8_t *buf;
 522         const uint8 *inbuf;
 523
 524         /*
 525          * Async handling in the main smb processing loop is directed by
 526          * outbuf: reply_xxx routines indicate sync behaviour by putting their
 527          * reply into "outbuf". If they leave it as NULL, they take of it
 528          * themselves, possibly later.
 529          *
 530          * If async handling is wanted, the reply_xxx routine must make sure
 531          * that it talloc_move()s the smb_req somewhere else.
 532          */
 533         uint8 *outbuf;
 534
 535         size_t unread_bytes;
 536         bool encrypted;
 537         connection_struct *conn;
 538         struct smbd_server_connection *sconn;
 539         struct smb_perfcount_data pcd;
 540
 541         /*
 542          * Chained request handling
 543          */
 544         struct files_struct *chain_fsp;
 545
 546         /*
 547          * Here we collect the outbufs from the chain handlers
 548          */
 549         uint8_t *chain_outbuf;
 550
 551         /*
 552          * state information for async smb handling
 553          */
 554         void *async_priv;
 555
 556         bool done;
 557
 558         /*
 559          * Back pointer to smb2 request.
 560          */
 561         struct smbd_smb2_request *smb2req;
 562 };
 563
 564 /* Defines for the sent_oplock_break field above. */
 565 #define NO_BREAK_SENT 0
 566 #define BREAK_TO_NONE_SENT 1
 567 #define LEVEL_II_BREAK_SENT 2
 568
 569 typedef struct {
 570         fstring smb_name; /* user name from the client */
 571         fstring unix_name; /* unix user name of a validated user */
 572         fstring domain; /* domain that the client specified */
 573 } userdom_struct;
 574
 575 /* used for server information: client, nameserv and ipc */
 576 struct server_info_struct {
 577         fstring name;
 578         uint32 type;
 579         fstring comment;
 580         fstring domain; /* used ONLY in ipc.c NOT namework.c */
 581         bool server_added; /* used ONLY in ipc.c NOT namework.c */
 582 };
 583
 584 /* used for network interfaces */
 585 struct interface {
 586         struct interface *next, *prev;
 587         char *name;
 588         int flags;
 589         struct sockaddr_storage ip;
 590         struct sockaddr_storage netmask;
 591         struct sockaddr_storage bcast;
 592 };
 593
 594 /* Internal message queue for deferred opens. */
 595 struct pending_message_list {
 596         struct pending_message_list *next, *prev;
 597         struct timeval request_time; /* When was this first issued? */
 598         struct timed_event *te;
 599         struct smb_perfcount_data pcd;
 600         uint32_t seqnum;
 601         bool encrypted;
 602         bool processed;
 603         DATA_BLOB buf;
 604         DATA_BLOB private_data;
 605 };
 606
 607 #define SHARE_MODE_FLAG_POSIX_OPEN      0x1
 608
 609 #include "librpc/gen_ndr/server_id.h"
 610
 611 /* struct returned by get_share_modes */
 612 struct share_mode_entry {
 613         struct server_id pid;
 614         uint64_t op_mid;        /* For compatibility with SMB2 opens. */
 615         uint16 op_type;
 616         uint32 access_mask;             /* NTCreateX access bits (FILE_READ_DATA etc.) */
 617         uint32 share_access;            /* NTCreateX share constants (FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE). */
 618         uint32 private_options; /* NT Create options, but we only look at
 619                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_DOS and
 620                                  * NTCREATEX_OPTIONS_PRIVATE_DENY_FCB for
 621                                  * smbstatus and swat */
 622         struct timeval time;
 623         struct file_id id;
 624         unsigned long share_file_id;
 625         uint32 uid;             /* uid of file opener. */
 626         uint16 flags;           /* See SHARE_MODE_XX above. */
 627         uint32_t name_hash;             /* Jenkins hash of full pathname. */
 628 };
 629
 630 /* oplock break message definition - linearization of share_mode_entry.
 631
 632 Offset  Data                    length.
 633 0       struct server_id pid    4
 634 4       uint16 op_mid           8
 635 12      uint16 op_type          2
 636 14      uint32 access_mask      4
 637 18      uint32 share_access     4
 638 22      uint32 private_options  4
 639 26      uint32 time sec         4
 640 30      uint32 time usec        4
 641 34      uint64 dev              8 bytes
 642 42      uint64 inode            8 bytes
 643 50      uint64 extid            8 bytes
 644 58      unsigned long file_id   4 bytes
 645 62      uint32 uid              4 bytes
 646 66      uint16 flags            2 bytes
 647 68      uint32 name_hash        4 bytes
 648 72
 649
 650 */
 651
 652 #define OP_BREAK_MSG_PID_OFFSET 0
 653 #define OP_BREAK_MSG_MID_OFFSET 4
 654 #define OP_BREAK_MSG_OP_TYPE_OFFSET 12
 655 #define OP_BREAK_MSG_ACCESS_MASK_OFFSET 14
 656 #define OP_BREAK_MSG_SHARE_ACCESS_OFFSET 18
 657 #define OP_BREAK_MSG_PRIV_OFFSET 22
 658 #define OP_BREAK_MSG_TIME_SEC_OFFSET 26
 659 #define OP_BREAK_MSG_TIME_USEC_OFFSET 30
 660 #define OP_BREAK_MSG_DEV_OFFSET 34
 661 #define OP_BREAK_MSG_INO_OFFSET 42
 662 #define OP_BREAK_MSG_EXTID_OFFSET 50
 663 #define OP_BREAK_MSG_FILE_ID_OFFSET 58
 664 #define OP_BREAK_MSG_UID_OFFSET 62
 665 #define OP_BREAK_MSG_FLAGS_OFFSET 66
 666 #define OP_BREAK_MSG_NAME_HASH_OFFSET 68
 667
 668 #define OP_BREAK_MSG_VNN_OFFSET 72
 669 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 76
 670
 671 struct delete_token_list {
 672         struct delete_token_list *next, *prev;
 673         uint32_t name_hash;
 674         struct security_unix_token *delete_token;
 675 };
 676
 677 struct share_mode_lock {
 678         const char *servicepath; /* canonicalized. */
 679         const char *base_name;
 680         const char *stream_name;
 681         struct file_id id;
 682         int num_share_modes;
 683         struct share_mode_entry *share_modes;
 684         struct delete_token_list *delete_tokens;
 685         struct timespec old_write_time;
 686         struct timespec changed_write_time;
 687         bool fresh;
 688         bool modified;
 689         struct db_record *record;
 690 };
 691
 692 /*
 693  * Internal structure of locking.tdb share mode db.
 694  * Used by locking.c and libsmbsharemodes.c
 695  */
 696
 697 struct locking_data {
 698         union {
 699                 struct {
 700                         int num_share_mode_entries;
 701                         struct timespec old_write_time;
 702                         struct timespec changed_write_time;
 703                         uint32 num_delete_token_entries;
 704                 } s;
 705                 struct share_mode_entry dummy; /* Needed for alignment. */
 706         } u;
 707         /* The following four entries are implicit
 708
 709            (1) struct share_mode_entry modes[num_share_mode_entries];
 710
 711            (2) A num_delete_token_entries of structs {
 712                 uint32_t len_delete_token;
 713                 char unix_token[len_delete_token] (divisible by 4).
 714            };
 715
 716            (3) char share_name[];
 717            (4) char file_name[];
 718         */
 719 };
 720
 721 /* Used to store pipe open records for NetFileEnum() */
 722
 723 struct pipe_open_rec {
 724         struct server_id pid;
 725         uid_t uid;
 726         int pnum;
 727         fstring name;
 728 };
 729
 730
 731 #define NT_HASH_LEN 16
 732 #define LM_HASH_LEN 16
 733
 734 /* Password history contants. */
 735 #define PW_HISTORY_SALT_LEN 16
 736 #define SALTED_MD5_HASH_LEN 16
 737 #define PW_HISTORY_ENTRY_LEN (PW_HISTORY_SALT_LEN+SALTED_MD5_HASH_LEN)
 738 #define MAX_PW_HISTORY_LEN 24
 739
 740 /*
 741  * Flags for local user manipulation.
 742  */
 743
 744 #define LOCAL_ADD_USER 0x1
 745 #define LOCAL_DELETE_USER 0x2
 746 #define LOCAL_DISABLE_USER 0x4
 747 #define LOCAL_ENABLE_USER 0x8
 748 #define LOCAL_TRUST_ACCOUNT 0x10
 749 #define LOCAL_SET_NO_PASSWORD 0x20
 750 #define LOCAL_SET_PASSWORD 0x40
 751 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
 752 #define LOCAL_INTERDOM_ACCOUNT 0x100
 753 #define LOCAL_AM_ROOT 0x200  /* Act as root */
 754
 755 /* key and data in the connections database - used in smbstatus and smbd */
 756 struct connections_key {
 757         struct server_id pid;
 758         int cnum;
 759         fstring name;
 760 };
 761
 762 struct connections_data {
 763         int magic;
 764         struct server_id pid;
 765         int cnum;
 766         uid_t uid;
 767         gid_t gid;
 768         char servicename[FSTRING_LEN];
 769         char addr[24];
 770         char machine[FSTRING_LEN];
 771         time_t start;
 772
 773         /*
 774          * This field used to hold the msg_flags. For compatibility reasons,
 775          * keep the data structure in the tdb file the same.
 776          */
 777         uint32 unused_compatitibility_field;
 778 };
 779
 780
 781 /* the following are used by loadparm for option lists */
 782 typedef enum {
 783         P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
 784         P_STRING,P_USTRING,P_ENUM,P_SEP
 785 } parm_type;
 786
 787 typedef enum {
 788         P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
 789 } parm_class;
 790
 791 struct enum_list {
 792         int value;
 793         const char *name;
 794 };
 795
 796 struct parm_struct {
 797         const char *label;
 798         parm_type type;
 799         parm_class p_class;
 800         void *ptr;
 801         bool (*special)(int snum, const char *, char **);
 802         const struct enum_list *enum_list;
 803         unsigned flags;
 804         union {
 805                 bool bvalue;
 806                 int ivalue;
 807                 char *svalue;
 808                 char cvalue;
 809                 char **lvalue;
 810         } def;
 811 };
 812
 813 /* The following flags are used in SWAT */
 814 #define FLAG_BASIC      0x0001 /* Display only in BASIC view */
 815 #define FLAG_SHARE      0x0002 /* file sharing options */
 816 #define FLAG_PRINT      0x0004 /* printing options */
 817 #define FLAG_GLOBAL     0x0008 /* local options that should be globally settable in SWAT */
 818 #define FLAG_WIZARD     0x0010 /* Parameters that the wizard will operate on */
 819 #define FLAG_ADVANCED   0x0020 /* Parameters that will be visible in advanced view */
 820 #define FLAG_DEVELOPER  0x0040 /* No longer used */
 821 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
 822 #define FLAG_HIDE       0x2000 /* options that should be hidden in SWAT */
 823 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
 824 #define FLAG_META       0x8000 /* A meta directive - not a real parameter */
 825 #define FLAG_CMDLINE    0x10000 /* option has been overridden */
 826
 827 struct bitmap {
 828         uint32 *b;
 829         unsigned int n;
 830 };
 831
 832 /* offsets into message for common items */
 833 #define smb_com 8
 834 #define smb_rcls 9
 835 #define smb_reh 10
 836 #define smb_err 11
 837 #define smb_flg 13
 838 #define smb_flg2 14
 839 #define smb_pidhigh 16
 840 #define smb_ss_field 18
 841 #define smb_tid 28
 842 #define smb_pid 30
 843 #define smb_uid 32
 844 #define smb_mid 34
 845 #define smb_wct 36
 846 #define smb_vwv 37
 847 #define smb_vwv0 37
 848 #define smb_vwv1 39
 849 #define smb_vwv2 41
 850 #define smb_vwv3 43
 851 #define smb_vwv4 45
 852 #define smb_vwv5 47
 853 #define smb_vwv6 49
 854 #define smb_vwv7 51
 855 #define smb_vwv8 53
 856 #define smb_vwv9 55
 857 #define smb_vwv10 57
 858 #define smb_vwv11 59
 859 #define smb_vwv12 61
 860 #define smb_vwv13 63
 861 #define smb_vwv14 65
 862 #define smb_vwv15 67
 863 #define smb_vwv16 69
 864 #define smb_vwv17 71
 865
 866 /* flag defines. CIFS spec 3.1.1 */
 867 #define FLAG_SUPPORT_LOCKREAD       0x01
 868 #define FLAG_CLIENT_BUF_AVAIL       0x02
 869 #define FLAG_RESERVED               0x04
 870 #define FLAG_CASELESS_PATHNAMES     0x08
 871 #define FLAG_CANONICAL_PATHNAMES    0x10
 872 #define FLAG_REQUEST_OPLOCK         0x20
 873 #define FLAG_REQUEST_BATCH_OPLOCK   0x40
 874 #define FLAG_REPLY                  0x80
 875
 876 /* the complete */
 877 #define SMBmkdir      0x00   /* create directory */
 878 #define SMBrmdir      0x01   /* delete directory */
 879 #define SMBopen       0x02   /* open file */
 880 #define SMBcreate     0x03   /* create file */
 881 #define SMBclose      0x04   /* close file */
 882 #define SMBflush      0x05   /* flush file */
 883 #define SMBunlink     0x06   /* delete file */
 884 #define SMBmv         0x07   /* rename file */
 885 #define SMBgetatr     0x08   /* get file attributes */
 886 #define SMBsetatr     0x09   /* set file attributes */
 887 #define SMBread       0x0A   /* read from file */
 888 #define SMBwrite      0x0B   /* write to file */
 889 #define SMBlock       0x0C   /* lock byte range */
 890 #define SMBunlock     0x0D   /* unlock byte range */
 891 #define SMBctemp      0x0E   /* create temporary file */
 892 #define SMBmknew      0x0F   /* make new file */
 893 #define SMBcheckpath  0x10   /* check directory path */
 894 #define SMBexit       0x11   /* process exit */
 895 #define SMBlseek      0x12   /* seek */
 896 #define SMBtcon       0x70   /* tree connect */
 897 #define SMBtconX      0x75   /* tree connect and X*/
 898 #define SMBtdis       0x71   /* tree disconnect */
 899 #define SMBnegprot    0x72   /* negotiate protocol */
 900 #define SMBdskattr    0x80   /* get disk attributes */
 901 #define SMBsearch     0x81   /* search directory */
 902 #define SMBsplopen    0xC0   /* open print spool file */
 903 #define SMBsplwr      0xC1   /* write to print spool file */
 904 #define SMBsplclose   0xC2   /* close print spool file */
 905 #define SMBsplretq    0xC3   /* return print queue */
 906 #define SMBsends      0xD0   /* send single block message */
 907 #define SMBsendb      0xD1   /* send broadcast message */
 908 #define SMBfwdname    0xD2   /* forward user name */
 909 #define SMBcancelf    0xD3   /* cancel forward */
 910 #define SMBgetmac     0xD4   /* get machine name */
 911 #define SMBsendstrt   0xD5   /* send start of multi-block message */
 912 #define SMBsendend    0xD6   /* send end of multi-block message */
 913 #define SMBsendtxt    0xD7   /* send text of multi-block message */
 914
 915 /* Core+ protocol */
 916 #define SMBlockread       0x13   /* Lock a range and read */
 917 #define SMBwriteunlock 0x14 /* Unlock a range then write */
 918 #define SMBreadbraw   0x1a  /* read a block of data with no smb header */
 919 #define SMBwritebraw  0x1d  /* write a block of data with no smb header */
 920 #define SMBwritec     0x20  /* secondary write request */
 921 #define SMBwriteclose 0x2c  /* write a file then close it */
 922
 923 /* dos extended protocol */
 924 #define SMBreadBraw      0x1A   /* read block raw */
 925 #define SMBreadBmpx      0x1B   /* read block multiplexed */
 926 #define SMBreadBs        0x1C   /* read block (secondary response) */
 927 #define SMBwriteBraw     0x1D   /* write block raw */
 928 #define SMBwriteBmpx     0x1E   /* write block multiplexed */
 929 #define SMBwriteBs       0x1F   /* write block (secondary request) */
 930 #define SMBwriteC        0x20   /* write complete response */
 931 #define SMBsetattrE      0x22   /* set file attributes expanded */
 932 #define SMBgetattrE      0x23   /* get file attributes expanded */
 933 #define SMBlockingX      0x24   /* lock/unlock byte ranges and X */
 934 #define SMBtrans         0x25   /* transaction - name, bytes in/out */
 935 #define SMBtranss        0x26   /* transaction (secondary request/response) */
 936 #define SMBioctl         0x27   /* IOCTL */
 937 #define SMBioctls        0x28   /* IOCTL  (secondary request/response) */
 938 #define SMBcopy          0x29   /* copy */
 939 #define SMBmove          0x2A   /* move */
 940 #define SMBecho          0x2B   /* echo */
 941 #define SMBopenX         0x2D   /* open and X */
 942 #define SMBreadX         0x2E   /* read and X */
 943 #define SMBwriteX        0x2F   /* write and X */
 944 #define SMBsesssetupX    0x73   /* Session Set Up & X (including User Logon) */
 945 #define SMBffirst        0x82   /* find first */
 946 #define SMBfunique       0x83   /* find unique */
 947 #define SMBfclose        0x84   /* find close */
 948 #define SMBkeepalive     0x85   /* keepalive */
 949 #define SMBinvalid       0xFE   /* invalid command */
 950
 951 /* Extended 2.0 protocol */
 952 #define SMBtrans2        0x32   /* TRANS2 protocol set */
 953 #define SMBtranss2       0x33   /* TRANS2 protocol set, secondary command */
 954 #define SMBfindclose     0x34   /* Terminate a TRANSACT2_FINDFIRST */
 955 #define SMBfindnclose    0x35   /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
 956 #define SMBulogoffX      0x74   /* user logoff */
 957
 958 /* NT SMB extensions. */
 959 #define SMBnttrans       0xA0   /* NT transact */
 960 #define SMBnttranss      0xA1   /* NT transact secondary */
 961 #define SMBntcreateX     0xA2   /* NT create and X */
 962 #define SMBntcancel      0xA4   /* NT cancel */
 963 #define SMBntrename      0xA5   /* NT rename */
 964
 965 /* These are the trans subcommands */
 966 #define TRANSACT_SETNAMEDPIPEHANDLESTATE  0x01
 967 #define TRANSACT_DCERPCCMD                0x26
 968 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
 969
 970 /* These are the TRANS2 sub commands */
 971 #define TRANSACT2_OPEN                          0x00
 972 #define TRANSACT2_FINDFIRST                     0x01
 973 #define TRANSACT2_FINDNEXT                      0x02
 974 #define TRANSACT2_QFSINFO                       0x03
 975 #define TRANSACT2_SETFSINFO                     0x04
 976 #define TRANSACT2_QPATHINFO                     0x05
 977 #define TRANSACT2_SETPATHINFO                   0x06
 978 #define TRANSACT2_QFILEINFO                     0x07
 979 #define TRANSACT2_SETFILEINFO                   0x08
 980 #define TRANSACT2_FSCTL                         0x09
 981 #define TRANSACT2_IOCTL                         0x0A
 982 #define TRANSACT2_FINDNOTIFYFIRST               0x0B
 983 #define TRANSACT2_FINDNOTIFYNEXT                0x0C
 984 #define TRANSACT2_MKDIR                         0x0D
 985 #define TRANSACT2_SESSION_SETUP                 0x0E
 986 #define TRANSACT2_GET_DFS_REFERRAL              0x10
 987 #define TRANSACT2_REPORT_DFS_INCONSISTANCY      0x11
 988
 989 /* These are the NT transact sub commands. */
 990 #define NT_TRANSACT_CREATE                1
 991 #define NT_TRANSACT_IOCTL                 2
 992 #define NT_TRANSACT_SET_SECURITY_DESC     3
 993 #define NT_TRANSACT_NOTIFY_CHANGE         4
 994 #define NT_TRANSACT_RENAME                5
 995 #define NT_TRANSACT_QUERY_SECURITY_DESC   6
 996 #define NT_TRANSACT_GET_USER_QUOTA        7
 997 #define NT_TRANSACT_SET_USER_QUOTA        8
 998
 999 /* These are the NT transact_get_user_quota sub commands */
1000 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE   0x0000
1001 #define TRANSACT_GET_USER_QUOTA_LIST_START      0x0100
1002 #define TRANSACT_GET_USER_QUOTA_FOR_SID         0x0101
1003
1004 /* Relevant IOCTL codes */
1005 #define IOCTL_QUERY_JOB_INFO      0x530060
1006
1007 /* these are the trans2 sub fields for primary requests */
1008 #define smb_tpscnt smb_vwv0
1009 #define smb_tdscnt smb_vwv1
1010 #define smb_mprcnt smb_vwv2
1011 #define smb_mdrcnt smb_vwv3
1012 #define smb_msrcnt smb_vwv4
1013 #define smb_flags smb_vwv5
1014 #define smb_timeout smb_vwv6
1015 #define smb_pscnt smb_vwv9
1016 #define smb_psoff smb_vwv10
1017 #define smb_dscnt smb_vwv11
1018 #define smb_dsoff smb_vwv12
1019 #define smb_suwcnt smb_vwv13
1020 #define smb_setup smb_vwv14
1021 #define smb_setup0 smb_setup
1022 #define smb_setup1 (smb_setup+2)
1023 #define smb_setup2 (smb_setup+4)
1024
1025 /* these are for the secondary requests */
1026 #define smb_spscnt smb_vwv2
1027 #define smb_spsoff smb_vwv3
1028 #define smb_spsdisp smb_vwv4
1029 #define smb_sdscnt smb_vwv5
1030 #define smb_sdsoff smb_vwv6
1031 #define smb_sdsdisp smb_vwv7
1032 #define smb_sfid smb_vwv8
1033
1034 /* and these for responses */
1035 #define smb_tprcnt smb_vwv0
1036 #define smb_tdrcnt smb_vwv1
1037 #define smb_prcnt smb_vwv3
1038 #define smb_proff smb_vwv4
1039 #define smb_prdisp smb_vwv5
1040 #define smb_drcnt smb_vwv6
1041 #define smb_droff smb_vwv7
1042 #define smb_drdisp smb_vwv8
1043
1044 /* these are for the NT trans primary request. */
1045 #define smb_nt_MaxSetupCount smb_vwv0
1046 #define smb_nt_Flags (smb_vwv0 + 1)
1047 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
1048 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
1049 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
1050 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
1051 #define smb_nt_ParameterCount (smb_vwv0 + 19)
1052 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
1053 #define smb_nt_DataCount (smb_vwv0 + 27)
1054 #define smb_nt_DataOffset (smb_vwv0 + 31)
1055 #define smb_nt_SetupCount (smb_vwv0 + 35)
1056 #define smb_nt_Function (smb_vwv0 + 36)
1057 #define smb_nt_SetupStart (smb_vwv0 + 38)
1058
1059 /* these are for the NT trans secondary request. */
1060 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
1061 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
1062 #define smb_nts_ParameterCount (smb_vwv0 + 11)
1063 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
1064 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
1065 #define smb_nts_DataCount (smb_vwv0 + 23)
1066 #define smb_nts_DataOffset (smb_vwv0 + 27)
1067 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
1068
1069 /* these are for the NT trans reply. */
1070 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
1071 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
1072 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
1073 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
1074 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
1075 #define smb_ntr_DataCount (smb_vwv0 + 23)
1076 #define smb_ntr_DataOffset (smb_vwv0 + 27)
1077 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
1078
1079 /* these are for the NT create_and_X */
1080 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
1081 #define smb_ntcreate_Flags (smb_vwv0 + 7)
1082 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
1083 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
1084 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
1085 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
1086 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
1087 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
1088 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
1089 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
1090 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
1091
1092 /* this is used on a TConX. I'm not sure the name is very helpful though */
1093 #define SMB_SUPPORT_SEARCH_BITS        0x0001
1094 #define SMB_SHARE_IN_DFS               0x0002
1095
1096 /* Named pipe write mode flags. Used in writeX calls. */
1097 #define PIPE_RAW_MODE 0x4
1098 #define PIPE_START_MESSAGE 0x8
1099
1100 /* the desired access to use when opening a pipe */
1101 #define DESIRED_ACCESS_PIPE 0x2019f
1102
1103 /* Mapping of access rights to UNIX perms. */
1104 #define UNIX_ACCESS_RWX         FILE_GENERIC_ALL
1105 #define UNIX_ACCESS_R           FILE_GENERIC_READ
1106 #define UNIX_ACCESS_W           FILE_GENERIC_WRITE
1107 #define UNIX_ACCESS_X           FILE_GENERIC_EXECUTE
1108
1109 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
1110 #define UNIX_DIRECTORY_ACCESS_RWX               FILE_GENERIC_ALL
1111 #define UNIX_DIRECTORY_ACCESS_R                 FILE_GENERIC_READ
1112 #define UNIX_DIRECTORY_ACCESS_W                 (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
1113 #define UNIX_DIRECTORY_ACCESS_X                 FILE_GENERIC_EXECUTE
1114
1115 #if 0
1116 /*
1117  * This is the old mapping we used to use. To get W2KSP2 profiles
1118  * working we need to map to the canonical file perms.
1119  */
1120 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
1121 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1122                         FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
1123 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1124                         FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
1125                         FILE_APPEND_DATA|FILE_WRITE_DATA)
1126 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
1127                         FILE_EXECUTE|FILE_READ_ATTRIBUTES)
1128 #endif
1129
1130 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
1131
1132 /* Flags field. */
1133 #define REQUEST_OPLOCK 2
1134 #define REQUEST_BATCH_OPLOCK 4
1135 #define OPEN_DIRECTORY 8
1136 #define EXTENDED_RESPONSE_REQUIRED 0x10
1137
1138 /* ShareAccess field. */
1139 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
1140 #define FILE_SHARE_READ 1
1141 #define FILE_SHARE_WRITE 2
1142 #define FILE_SHARE_DELETE 4
1143
1144 /* FileAttributesField */
1145 #define FILE_ATTRIBUTE_READONLY         0x001L
1146 #define FILE_ATTRIBUTE_HIDDEN           0x002L
1147 #define FILE_ATTRIBUTE_SYSTEM           0x004L
1148 #define FILE_ATTRIBUTE_DIRECTORY        0x010L
1149 #define FILE_ATTRIBUTE_ARCHIVE          0x020L
1150 #define FILE_ATTRIBUTE_NORMAL           0x080L
1151 #define FILE_ATTRIBUTE_TEMPORARY        0x100L
1152 #define FILE_ATTRIBUTE_SPARSE           0x200L
1153 #define FILE_ATTRIBUTE_REPARSE_POINT    0x400L
1154 #define FILE_ATTRIBUTE_COMPRESSED       0x800L
1155 #define FILE_ATTRIBUTE_OFFLINE          0x1000L
1156 #define FILE_ATTRIBUTE_NONINDEXED       0x2000L
1157 #define FILE_ATTRIBUTE_ENCRYPTED        0x4000L
1158 #define SAMBA_ATTRIBUTES_MASK           (FILE_ATTRIBUTE_READONLY|\
1159                                         FILE_ATTRIBUTE_HIDDEN|\
1160                                         FILE_ATTRIBUTE_SYSTEM|\
1161                                         FILE_ATTRIBUTE_DIRECTORY|\
1162                                         FILE_ATTRIBUTE_ARCHIVE)
1163
1164 /* Flags - combined with attributes. */
1165 #define FILE_FLAG_WRITE_THROUGH    0x80000000L
1166 #define FILE_FLAG_NO_BUFFERING     0x20000000L
1167 #define FILE_FLAG_RANDOM_ACCESS    0x10000000L
1168 #define FILE_FLAG_SEQUENTIAL_SCAN  0x08000000L
1169 #define FILE_FLAG_DELETE_ON_CLOSE  0x04000000L
1170 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
1171 #define FILE_FLAG_POSIX_SEMANTICS  0x01000000L
1172
1173 /* CreateDisposition field. */
1174 #define FILE_SUPERSEDE 0                /* File exists overwrite/supersede. File not exist create. */
1175 #define FILE_OPEN 1                     /* File exists open. File not exist fail. */
1176 #define FILE_CREATE 2                   /* File exists fail. File not exist create. */
1177 #define FILE_OPEN_IF 3                  /* File exists open. File not exist create. */
1178 #define FILE_OVERWRITE 4                /* File exists overwrite. File not exist fail. */
1179 #define FILE_OVERWRITE_IF 5             /* File exists overwrite. File not exist create. */
1180
1181 /* CreateOptions field. */
1182 #define FILE_DIRECTORY_FILE       0x0001
1183 #define FILE_WRITE_THROUGH        0x0002
1184 #define FILE_SEQUENTIAL_ONLY      0x0004
1185 #define FILE_NO_INTERMEDIATE_BUFFERING 0x0008
1186 #define FILE_SYNCHRONOUS_IO_ALERT      0x0010   /* may be ignored */
1187 #define FILE_SYNCHRONOUS_IO_NONALERT   0x0020   /* may be ignored */
1188 #define FILE_NON_DIRECTORY_FILE   0x0040
1189 #define FILE_CREATE_TREE_CONNECTION    0x0080   /* ignore, should be zero */
1190 #define FILE_COMPLETE_IF_OPLOCKED      0x0100   /* ignore, should be zero */
1191 #define FILE_NO_EA_KNOWLEDGE      0x0200
1192 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400 /* aka OPEN_FOR_RECOVERY: ignore, should be zero */
1193 #define FILE_RANDOM_ACCESS        0x0800
1194 #define FILE_DELETE_ON_CLOSE      0x1000
1195 #define FILE_OPEN_BY_FILE_ID      0x2000
1196 #define FILE_OPEN_FOR_BACKUP_INTENT    0x4000
1197 #define FILE_NO_COMPRESSION       0x8000
1198 #define FILE_RESERVER_OPFILTER    0x00100000    /* ignore, should be zero */
1199 #define FILE_OPEN_REPARSE_POINT   0x00200000
1200 #define FILE_OPEN_NO_RECALL       0x00400000
1201 #define FILE_OPEN_FOR_FREE_SPACE_QUERY 0x00800000 /* ignore should be zero */
1202
1203 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK      (0x008F0480)
1204
1205 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK    (0xFF100030)
1206
1207 /*
1208  * Private create options used by the ntcreatex processing code. From Samba4.
1209  * We reuse some ignored flags for private use. Passed in the private_flags
1210  * argument.
1211  */
1212 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS     0x0001
1213 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB     0x0002
1214
1215 /* Private options for streams support */
1216 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x0004
1217
1218 /* Private options for printer support */
1219 #define NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE 0x0008
1220
1221 /* Responses when opening a file. */
1222 #define FILE_WAS_SUPERSEDED 0
1223 #define FILE_WAS_OPENED 1
1224 #define FILE_WAS_CREATED 2
1225 #define FILE_WAS_OVERWRITTEN 3
1226
1227 /* File type flags */
1228 #define FILE_TYPE_DISK  0
1229 #define FILE_TYPE_BYTE_MODE_PIPE 1
1230 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
1231 #define FILE_TYPE_PRINTER 3
1232 #define FILE_TYPE_COMM_DEVICE 4
1233 #define FILE_TYPE_UNKNOWN 0xFFFF
1234
1235 /* Flag for NT transact rename call. */
1236 #define RENAME_REPLACE_IF_EXISTS 1
1237
1238 /* flags for SMBntrename call (from Samba4) */
1239 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
1240 #define RENAME_FLAG_HARD_LINK                0x103
1241 #define RENAME_FLAG_RENAME                   0x104
1242 #define RENAME_FLAG_COPY                     0x105
1243
1244 /* Filesystem Attributes. */
1245 #define FILE_CASE_SENSITIVE_SEARCH      0x00000001
1246 #define FILE_CASE_PRESERVED_NAMES       0x00000002
1247 #define FILE_UNICODE_ON_DISK            0x00000004
1248 /* According to cifs9f, this is 4, not 8 */
1249 /* Acconding to testing, this actually sets the security attribute! */
1250 #define FILE_PERSISTENT_ACLS            0x00000008
1251 #define FILE_FILE_COMPRESSION           0x00000010
1252 #define FILE_VOLUME_QUOTAS              0x00000020
1253 #define FILE_SUPPORTS_SPARSE_FILES      0x00000040
1254 #define FILE_SUPPORTS_REPARSE_POINTS    0x00000080
1255 #define FILE_SUPPORTS_REMOTE_STORAGE    0x00000100
1256 #define FS_LFN_APIS                     0x00004000
1257 #define FILE_VOLUME_IS_COMPRESSED       0x00008000
1258 #define FILE_SUPPORTS_OBJECT_IDS        0x00010000
1259 #define FILE_SUPPORTS_ENCRYPTION        0x00020000
1260 #define FILE_NAMED_STREAMS              0x00040000
1261 #define FILE_READ_ONLY_VOLUME           0x00080000
1262
1263 /* ChangeNotify flags. */
1264 #define FILE_NOTIFY_CHANGE_FILE_NAME   0x001
1265 #define FILE_NOTIFY_CHANGE_DIR_NAME    0x002
1266 #define FILE_NOTIFY_CHANGE_ATTRIBUTES  0x004
1267 #define FILE_NOTIFY_CHANGE_SIZE        0x008
1268 #define FILE_NOTIFY_CHANGE_LAST_WRITE  0x010
1269 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
1270 #define FILE_NOTIFY_CHANGE_CREATION    0x040
1271 #define FILE_NOTIFY_CHANGE_EA          0x080
1272 #define FILE_NOTIFY_CHANGE_SECURITY    0x100
1273 #define FILE_NOTIFY_CHANGE_STREAM_NAME  0x00000200
1274 #define FILE_NOTIFY_CHANGE_STREAM_SIZE  0x00000400
1275 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1276
1277 #define FILE_NOTIFY_CHANGE_NAME \
1278         (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
1279
1280 /* change notify action results */
1281 #define NOTIFY_ACTION_ADDED 1
1282 #define NOTIFY_ACTION_REMOVED 2
1283 #define NOTIFY_ACTION_MODIFIED 3
1284 #define NOTIFY_ACTION_OLD_NAME 4
1285 #define NOTIFY_ACTION_NEW_NAME 5
1286 #define NOTIFY_ACTION_ADDED_STREAM 6
1287 #define NOTIFY_ACTION_REMOVED_STREAM 7
1288 #define NOTIFY_ACTION_MODIFIED_STREAM 8
1289
1290
1291 /* where to find the base of the SMB packet proper */
1292 #define smb_base(buf) (((char *)(buf))+4)
1293
1294 /* we don't allow server strings to be longer than 48 characters as
1295    otherwise NT will not honour the announce packets */
1296 #define MAX_SERVER_STRING_LENGTH 48
1297
1298
1299 #define SMB_SUCCESS 0  /* The request was successful. */
1300
1301 #ifdef WITH_DFS
1302 void dfs_unlogin(void);
1303 extern int dcelogin_atmost_once;
1304 #endif
1305
1306 #ifdef NOSTRDUP
1307 char *strdup(char *s);
1308 #endif
1309
1310 #ifndef SELECT_CAST
1311 #define SELECT_CAST
1312 #endif
1313
1314 /* This was set by JHT in liaison with Jeremy Allison early 1997
1315  * History:
1316  * Version 4.0 - never made public
1317  * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
1318  *              - Reappeared in 1.9.16p11 with fixed smbd services
1319  * Version 4.20 - To indicate that nmbd and browsing now works better
1320  * Version 4.50 - Set at release of samba-2.2.0 by JHT
1321  *
1322  *  Note: In the presence of NT4.X do not set above 4.9
1323  *        Setting this above 4.9 can have undesired side-effects.
1324  *        This may change again in Samba-3.0 after further testing. JHT
1325  */
1326
1327 #define DEFAULT_MAJOR_VERSION 0x04
1328 #define DEFAULT_MINOR_VERSION 0x09
1329
1330 /* Browser Election Values */
1331 #define BROWSER_ELECTION_VERSION        0x010f
1332 #define BROWSER_CONSTANT        0xaa55
1333
1334 /* Sercurity mode bits. */
1335 #define NEGOTIATE_SECURITY_USER_LEVEL           0x01
1336 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE   0x02
1337 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED   0x04
1338 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED  0x08
1339
1340 /* TCONX Flag (smb_vwv2). */
1341 #define TCONX_FLAG_EXTENDED_RESPONSE    0x8
1342
1343 /* File Status Flags. See:
1344
1345 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
1346 */
1347
1348 #define NO_EAS                  0x1
1349 #define NO_SUBSTREAMS           0x2
1350 #define NO_REPARSETAG           0x4
1351
1352 /* Capabilities.  see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
1353
1354 #define CAP_RAW_MODE         0x0001
1355 #define CAP_MPX_MODE         0x0002
1356 #define CAP_UNICODE          0x0004
1357 #define CAP_LARGE_FILES      0x0008
1358 #define CAP_NT_SMBS          0x0010
1359 #define CAP_RPC_REMOTE_APIS  0x0020
1360 #define CAP_STATUS32         0x0040
1361 #define CAP_LEVEL_II_OPLOCKS 0x0080
1362 #define CAP_LOCK_AND_READ    0x0100
1363 #define CAP_NT_FIND          0x0200
1364 #define CAP_DFS              0x1000
1365 #define CAP_W2K_SMBS         0x2000
1366 #define CAP_LARGE_READX      0x4000
1367 #define CAP_LARGE_WRITEX     0x8000
1368 #define CAP_UNIX             0x800000 /* Capabilities for UNIX extensions. Created by HP. */
1369 #define CAP_EXTENDED_SECURITY 0x80000000
1370
1371 /* protocol types. It assumes that higher protocols include lower protocols
1372    as subsets */
1373 enum protocol_types {
1374         PROTOCOL_NONE,
1375         PROTOCOL_CORE,
1376         PROTOCOL_COREPLUS,
1377         PROTOCOL_LANMAN1,
1378         PROTOCOL_LANMAN2,
1379         PROTOCOL_NT1,
1380         PROTOCOL_SMB2
1381 };
1382
1383 /* security levels */
1384 enum security_types {SEC_SHARE,SEC_USER,SEC_SERVER,SEC_DOMAIN,SEC_ADS};
1385
1386 /* server roles */
1387 enum server_types {
1388         ROLE_STANDALONE,
1389         ROLE_DOMAIN_MEMBER,
1390         ROLE_DOMAIN_BDC,
1391         ROLE_DOMAIN_PDC
1392 };
1393
1394 /* printing types */
1395 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
1396                      PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
1397                      PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
1398 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
1399 ,PRINT_TEST,PRINT_VLP
1400 #endif /* DEVELOPER */
1401 };
1402
1403 /* LDAP schema types */
1404 enum schema_types {SCHEMA_COMPAT, SCHEMA_AD, SCHEMA_SAMBA};
1405
1406 /* LDAP SSL options */
1407 enum ldap_ssl_types {LDAP_SSL_OFF, LDAP_SSL_START_TLS};
1408
1409 /* LDAP PASSWD SYNC methods */
1410 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
1411
1412 /*
1413  * This should be under the HAVE_KRB5 flag but since they're used
1414  * in lp_kerberos_method(), they ned to be always available
1415  * If you add any entries to KERBEROS_VERIFY defines, please modify USE.*KEYTAB macros
1416  * so they remain accurate.
1417  */
1418
1419 #define KERBEROS_VERIFY_SECRETS 0
1420 #define KERBEROS_VERIFY_SYSTEM_KEYTAB 1
1421 #define KERBEROS_VERIFY_DEDICATED_KEYTAB 2
1422 #define KERBEROS_VERIFY_SECRETS_AND_KEYTAB 3
1423
1424 /* Remote architectures we know about. */
1425 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
1426                         RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
1427                         RA_SAMBA, RA_CIFSFS, RA_WINXP64, RA_OSX};
1428
1429 /* case handling */
1430 enum case_handling {CASE_LOWER,CASE_UPPER};
1431
1432 /* ACL compatibility */
1433 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
1434 /*
1435  * Global value meaing that the smb_uid field should be
1436  * ingored (in share level security and protocol level == CORE)
1437  */
1438
1439 #define UID_FIELD_INVALID 0
1440 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
1441
1442 /*
1443  * Size of buffer to use when moving files across filesystems.
1444  */
1445 #define COPYBUF_SIZE (8*1024)
1446
1447 /*
1448  * Map the Core and Extended Oplock requesst bits down
1449  * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
1450  */
1451
1452 /*
1453  * Core protocol.
1454  */
1455 #define CORE_OPLOCK_REQUEST(inbuf) \
1456     ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
1457
1458 /*
1459  * Extended protocol.
1460  */
1461 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
1462
1463 /* Lock types. */
1464 #define LOCKING_ANDX_SHARED_LOCK 0x1
1465 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
1466 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
1467 #define LOCKING_ANDX_CANCEL_LOCK 0x8
1468 #define LOCKING_ANDX_LARGE_FILES 0x10
1469
1470 /*
1471  * Bits we test with.
1472  * Note these must fit into 16-bits.
1473  */
1474
1475 #define NO_OPLOCK                       0x0
1476 #define EXCLUSIVE_OPLOCK                0x1
1477 #define BATCH_OPLOCK                    0x2
1478 #define LEVEL_II_OPLOCK                 0x4
1479
1480 /* The following are Samba-private. */
1481 #define INTERNAL_OPEN_ONLY              0x8
1482 #define FAKE_LEVEL_II_OPLOCK            0x10    /* Client requested no_oplock, but we have to
1483                                  * inform potential level2 holders on
1484                                  * write. */
1485 #define DEFERRED_OPEN_ENTRY             0x20
1486 #define UNUSED_SHARE_MODE_ENTRY         0x40
1487 #define FORCE_OPLOCK_BREAK_TO_NONE      0x80
1488
1489 /* None of the following should ever appear in fsp->oplock_request. */
1490 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|UNUSED_SHARE_MODE_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
1491
1492 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
1493 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
1494 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
1495
1496 /* kernel_oplock_message definition.
1497
1498 struct kernel_oplock_message {
1499         uint64_t dev;
1500         uint64_t inode;
1501         unit64_t extid;
1502         unsigned long file_id;
1503 };
1504
1505 Offset  Data                  length.
1506 0     uint64_t dev            8 bytes
1507 8     uint64_t inode          8 bytes
1508 16    uint64_t extid          8 bytes
1509 24    unsigned long file_id   4 bytes
1510 28
1511
1512 */
1513 #define MSG_SMB_KERNEL_BREAK_SIZE 28
1514
1515 /* file_renamed_message definition.
1516
1517 struct file_renamed_message {
1518         uint64_t dev;
1519         uint64_t inode;
1520         char names[1]; A variable area containing sharepath and filename.
1521 };
1522
1523 Offset  Data                    length.
1524 0       uint64_t dev            8 bytes
1525 8       uint64_t inode          8 bytes
1526 16      unit64_t extid          8 bytes
1527 24      char [] name            zero terminated namelen bytes
1528 minimum length == 24.
1529
1530 */
1531
1532 #define MSG_FILE_RENAMED_MIN_SIZE 24
1533
1534 /*
1535  * On the wire return values for oplock types.
1536  */
1537
1538 #define CORE_OPLOCK_GRANTED (1<<5)
1539 #define EXTENDED_OPLOCK_GRANTED (1<<15)
1540
1541 #define NO_OPLOCK_RETURN 0
1542 #define EXCLUSIVE_OPLOCK_RETURN 1
1543 #define BATCH_OPLOCK_RETURN 2
1544 #define LEVEL_II_OPLOCK_RETURN 3
1545
1546 /* Oplock levels */
1547 #define OPLOCKLEVEL_NONE 0
1548 #define OPLOCKLEVEL_II 1
1549
1550 /*
1551  * Capabilities abstracted for different systems.
1552  */
1553
1554 enum smbd_capability {
1555     KERNEL_OPLOCK_CAPABILITY,
1556     DMAPI_ACCESS_CAPABILITY,
1557     LEASE_CAPABILITY
1558 };
1559
1560 /*
1561  * Kernel oplocks capability flags.
1562  */
1563
1564 /* Level 2 oplocks are supported natively by kernel oplocks. */
1565 #define KOPLOCKS_LEVEL2_SUPPORTED               0x1
1566
1567 /* The kernel notifies deferred openers when they can retry the open. */
1568 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION     0x2
1569
1570 /* The kernel notifies smbds when an oplock break times out. */
1571 #define KOPLOCKS_TIMEOUT_NOTIFICATION           0x4
1572
1573 /* The kernel notifies smbds when an oplock is broken. */
1574 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION     0x8
1575
1576 struct kernel_oplocks_ops;
1577 struct kernel_oplocks {
1578         const struct kernel_oplocks_ops *ops;
1579         uint32_t flags;
1580         void *private_data;
1581 };
1582
1583 enum level2_contention_type {
1584         LEVEL2_CONTEND_ALLOC_SHRINK,
1585         LEVEL2_CONTEND_ALLOC_GROW,
1586         LEVEL2_CONTEND_SET_FILE_LEN,
1587         LEVEL2_CONTEND_FILL_SPARSE,
1588         LEVEL2_CONTEND_WRITE,
1589         LEVEL2_CONTEND_WINDOWS_BRL,
1590         LEVEL2_CONTEND_POSIX_BRL
1591 };
1592
1593 /* if a kernel does support oplocks then a structure of the following
1594    typee is used to describe how to interact with the kernel */
1595 struct kernel_oplocks_ops {
1596         bool (*set_oplock)(struct kernel_oplocks *ctx,
1597                            files_struct *fsp, int oplock_type);
1598         void (*release_oplock)(struct kernel_oplocks *ctx,
1599                                files_struct *fsp, int oplock_type);
1600         void (*contend_level2_oplocks_begin)(files_struct *fsp,
1601                                              enum level2_contention_type type);
1602         void (*contend_level2_oplocks_end)(files_struct *fsp,
1603                                            enum level2_contention_type type);
1604 };
1605
1606 #include "smb_macros.h"
1607
1608 #define MAX_NETBIOSNAME_LEN 16
1609 /* DOS character, NetBIOS namestring. Type used on the wire. */
1610 typedef char nstring[MAX_NETBIOSNAME_LEN];
1611 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
1612 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
1613
1614 /* A netbios name structure. */
1615 struct nmb_name {
1616         nstring      name;
1617         char         scope[64];
1618         unsigned int name_type;
1619 };
1620
1621 /* A netbios node status array element. */
1622 struct node_status {
1623         nstring name;
1624         unsigned char type;
1625         unsigned char flags;
1626 };
1627
1628 /* The extra info from a NetBIOS node status query */
1629 struct node_status_extra {
1630         unsigned char mac_addr[6];
1631         /* There really is more here ... */
1632 };
1633
1634 typedef struct user_struct {
1635         struct user_struct *next, *prev;
1636         uint16 vuid; /* Tag for this entry. */
1637
1638         char *session_keystr; /* used by utmp and pam session code.
1639                                  TDB key string */
1640         int homes_snum;
1641
1642         struct auth_serversupplied_info *session_info;
1643
1644         struct auth_ntlmssp_state *auth_ntlmssp_state;
1645 } user_struct;
1646
1647 struct unix_error_map {
1648         int unix_error;
1649         int dos_class;
1650         int dos_code;
1651         NTSTATUS nt_error;
1652 };
1653
1654 /*
1655  * Size of new password account encoding string.  This is enough space to
1656  * hold 11 ACB characters, plus the surrounding [] and a terminating null.
1657  * Do not change unless you are adding new ACB bits!
1658  */
1659
1660 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
1661
1662 /*
1663    Do you want session setups at user level security with a invalid
1664    password to be rejected or allowed in as guest? WinNT rejects them
1665    but it can be a pain as it means "net view" needs to use a password
1666
1667    You have 3 choices in the setting of map_to_guest:
1668
1669    "NEVER_MAP_TO_GUEST" means session setups with an invalid password
1670    are rejected. This is the default.
1671
1672    "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
1673    are rejected, unless the username does not exist, in which case it
1674    is treated as a guest login
1675
1676    "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
1677    are treated as a guest login
1678
1679    Note that map_to_guest only has an effect in user or server
1680    level security.
1681 */
1682
1683 #define NEVER_MAP_TO_GUEST              0
1684 #define MAP_TO_GUEST_ON_BAD_USER        1
1685 #define MAP_TO_GUEST_ON_BAD_PASSWORD    2
1686 #define MAP_TO_GUEST_ON_BAD_UID         3
1687
1688 #define SAFE_NETBIOS_CHARS ". -_"
1689
1690 /* The maximum length of a trust account password.
1691    Used when we randomly create it, 15 char passwords
1692    exceed NT4's max password length */
1693
1694 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1695
1696 #define PORT_NONE       0
1697 #ifndef LDAP_PORT
1698 #define LDAP_PORT       389
1699 #endif
1700 #define LDAP_GC_PORT    3268
1701
1702 /* used by the IP comparison function */
1703 struct ip_service {
1704         struct sockaddr_storage ss;
1705         unsigned port;
1706 };
1707
1708 struct ea_struct {
1709         uint8 flags;
1710         char *name;
1711         DATA_BLOB value;
1712 };
1713
1714 struct ea_list {
1715         struct ea_list *next, *prev;
1716         struct ea_struct ea;
1717 };
1718
1719 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
1720 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
1721 /* EA to use for DOS attributes */
1722 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
1723 /* Prefix for DosStreams in the vfs_streams_xattr module */
1724 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
1725 /* Prefix for xattrs storing streams. */
1726 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
1727
1728 /* map readonly options */
1729 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1730
1731 /* usershare error codes. */
1732 enum usershare_err {
1733                 USERSHARE_OK=0,
1734                 USERSHARE_MALFORMED_FILE,
1735                 USERSHARE_BAD_VERSION,
1736                 USERSHARE_MALFORMED_PATH,
1737                 USERSHARE_MALFORMED_COMMENT_DEF,
1738                 USERSHARE_MALFORMED_ACL_DEF,
1739                 USERSHARE_ACL_ERR,
1740                 USERSHARE_PATH_NOT_ABSOLUTE,
1741                 USERSHARE_PATH_IS_DENIED,
1742                 USERSHARE_PATH_NOT_ALLOWED,
1743                 USERSHARE_PATH_NOT_DIRECTORY,
1744                 USERSHARE_POSIX_ERR,
1745                 USERSHARE_MALFORMED_SHARENAME_DEF,
1746                 USERSHARE_BAD_SHARENAME
1747 };
1748
1749 /* Different reasons for closing a file. */
1750 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1751
1752 /* Used in SMB_FS_OBJECTID_INFORMATION requests.  Must be exactly 48 bytes. */
1753 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1754 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1755 struct smb_extended_info {
1756         uint32 samba_magic;             /* Always SAMBA_EXTRA_INFO_MAGIC */
1757         uint32 samba_version;           /* Major/Minor/Release/Revision */
1758         uint32 samba_subversion;        /* Prerelease/RC/Vendor patch */
1759         NTTIME samba_gitcommitdate;
1760         char   samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
1761 };
1762
1763 /* time info */
1764 struct smb_file_time {
1765         struct timespec mtime;
1766         struct timespec atime;
1767         struct timespec ctime;
1768         struct timespec create_time;
1769 };
1770
1771 /*
1772  * unix_convert_flags
1773  */
1774 #define UCF_SAVE_LCOMP                  0x00000001
1775 #define UCF_ALWAYS_ALLOW_WCARD_LCOMP    0x00000002
1776 #define UCF_COND_ALLOW_WCARD_LCOMP      0x00000004
1777 #define UCF_POSIX_PATHNAMES             0x00000008
1778
1779 /*
1780  * smb_filename
1781  */
1782 struct smb_filename {
1783         char *base_name;
1784         char *stream_name;
1785         char *original_lcomp;
1786         SMB_STRUCT_STAT st;
1787 };
1788
1789 /* struct for maintaining the child processes that get spawned from smbd */
1790 struct child_pid {
1791         struct child_pid *prev, *next;
1792         pid_t pid;
1793 };
1794
1795 /* Used to keep track of deferred opens. */
1796 struct deferred_open_record;
1797
1798 /* Client-side offline caching policy types */
1799 #define CSC_POLICY_MANUAL 0
1800 #define CSC_POLICY_DOCUMENTS 1
1801 #define CSC_POLICY_PROGRAMS 2
1802 #define CSC_POLICY_DISABLE 3
1803
1804 /* Used inside aio code. */
1805 struct aio_extra;
1806
1807 #endif /* _SMB_H */