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