1da6c28aaSamw /* 2da6c28aaSamw * CDDL HEADER START 3da6c28aaSamw * 4da6c28aaSamw * The contents of this file are subject to the terms of the 5da6c28aaSamw * Common Development and Distribution License (the "License"). 6da6c28aaSamw * You may not use this file except in compliance with the License. 7da6c28aaSamw * 8da6c28aaSamw * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9da6c28aaSamw * or http://www.opensolaris.org/os/licensing. 10da6c28aaSamw * See the License for the specific language governing permissions 11da6c28aaSamw * and limitations under the License. 12da6c28aaSamw * 13da6c28aaSamw * When distributing Covered Code, include this CDDL HEADER in each 14da6c28aaSamw * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15da6c28aaSamw * If applicable, add the following below this CDDL HEADER, with the 16da6c28aaSamw * fields enclosed by brackets "[]" replaced with your own identifying 17da6c28aaSamw * information: Portions Copyright [yyyy] [name of copyright owner] 18da6c28aaSamw * 19da6c28aaSamw * CDDL HEADER END 20da6c28aaSamw */ 21da6c28aaSamw /* 22dc20a302Sas * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 23da6c28aaSamw * Use is subject to license terms. 24da6c28aaSamw */ 25da6c28aaSamw 26da6c28aaSamw /* 27da6c28aaSamw * Structures and type definitions for the SMB module. 28da6c28aaSamw */ 29da6c28aaSamw 30faa1795aSjb #ifndef _SMBSRV_SMB_KTYPES_H 31faa1795aSjb #define _SMBSRV_SMB_KTYPES_H 32da6c28aaSamw 33da6c28aaSamw #ifdef __cplusplus 34da6c28aaSamw extern "C" { 35da6c28aaSamw #endif 36da6c28aaSamw 37faa1795aSjb #include <sys/note.h> 38da6c28aaSamw #include <sys/systm.h> 39da6c28aaSamw #include <sys/param.h> 40da6c28aaSamw #include <sys/types.h> 41da6c28aaSamw #include <sys/synch.h> 42da6c28aaSamw #include <sys/taskq.h> 433db3f65cSamw #include <sys/socket.h> 44da6c28aaSamw #include <sys/acl.h> 45da6c28aaSamw #include <sys/sdt.h> 46c8ec8eeaSjose borrego #include <sys/stat.h> 47da6c28aaSamw #include <sys/vnode.h> 48da6c28aaSamw #include <sys/cred.h> 49*0f1702c5SYu Xiangning #include <netinet/in.h> 50*0f1702c5SYu Xiangning #include <sys/ksocket.h> 51faa1795aSjb #include <sys/fem.h> 52faa1795aSjb #include <sys/door.h> 53da6c28aaSamw #include <smbsrv/smb.h> 54da6c28aaSamw #include <smbsrv/smbinfo.h> 55da6c28aaSamw #include <smbsrv/mbuf.h> 566537f381Sas #include <smbsrv/smb_sid.h> 573db3f65cSamw #include <smbsrv/smb_xdr.h> 5821b7895dSjb #include <smbsrv/netbios.h> 59da6c28aaSamw #include <smbsrv/smb_vops.h> 60da6c28aaSamw 61faa1795aSjb struct smb_request; 62faa1795aSjb struct smb_server; 636537f381Sas struct smb_sd; 64da6c28aaSamw 65da6c28aaSamw int smb_noop(void *, size_t, int); 66da6c28aaSamw 67da6c28aaSamw #define SMB_AUDIT_STACK_DEPTH 16 68da6c28aaSamw #define SMB_AUDIT_BUF_MAX_REC 16 69da6c28aaSamw #define SMB_AUDIT_NODE 0x00000001 70da6c28aaSamw 71c8ec8eeaSjose borrego /* 72c8ec8eeaSjose borrego * Maximum number of records returned in SMBsearch, SMBfind 73c8ec8eeaSjose borrego * and SMBfindunique response. Value set to 10 for compatibility 74c8ec8eeaSjose borrego * with Windows. 75c8ec8eeaSjose borrego */ 76c8ec8eeaSjose borrego #define SMB_MAX_SEARCH 10 77c8ec8eeaSjose borrego 782c1b14e5Sjose borrego #define SMB_SEARCH_HIDDEN(sattr) ((sattr) & FILE_ATTRIBUTE_HIDDEN) 792c1b14e5Sjose borrego #define SMB_SEARCH_SYSTEM(sattr) ((sattr) & FILE_ATTRIBUTE_SYSTEM) 802c1b14e5Sjose borrego #define SMB_SEARCH_DIRECTORY(sattr) ((sattr) & FILE_ATTRIBUTE_DIRECTORY) 812c1b14e5Sjose borrego 822c1b14e5Sjose borrego 83da6c28aaSamw extern uint32_t smb_audit_flags; 84da6c28aaSamw 85da6c28aaSamw typedef struct { 86da6c28aaSamw uint32_t anr_refcnt; 87da6c28aaSamw int anr_depth; 88da6c28aaSamw pc_t anr_stack[SMB_AUDIT_STACK_DEPTH]; 89da6c28aaSamw } smb_audit_record_node_t; 90da6c28aaSamw 91da6c28aaSamw typedef struct { 92da6c28aaSamw int anb_index; 93da6c28aaSamw int anb_max_index; 94da6c28aaSamw smb_audit_record_node_t anb_records[SMB_AUDIT_BUF_MAX_REC]; 95da6c28aaSamw } smb_audit_buf_node_t; 96da6c28aaSamw 97da6c28aaSamw #define SMB_WORKER_PRIORITY 99 98da6c28aaSamw /* 99da6c28aaSamw * Thread State Machine 100da6c28aaSamw * -------------------- 101da6c28aaSamw * 102da6c28aaSamw * T5 T0 103da6c28aaSamw * smb_thread_destroy() <-------+ +------- smb_thread_init() 104da6c28aaSamw * | | 105da6c28aaSamw * | v 106da6c28aaSamw * +-----------------------------+ 107da6c28aaSamw * | SMB_THREAD_STATE_EXITED |<---+ 108da6c28aaSamw * +-----------------------------+ | 109da6c28aaSamw * | T1 | 110da6c28aaSamw * v | 111da6c28aaSamw * +-----------------------------+ | 112da6c28aaSamw * | SMB_THREAD_STATE_STARTING | | 113da6c28aaSamw * +-----------------------------+ | 114da6c28aaSamw * | T2 | T4 115da6c28aaSamw * v | 116da6c28aaSamw * +-----------------------------+ | 117da6c28aaSamw * | SMB_THREAD_STATE_RUNNING | | 118da6c28aaSamw * +-----------------------------+ | 119da6c28aaSamw * | T3 | 120da6c28aaSamw * v | 121da6c28aaSamw * +-----------------------------+ | 122da6c28aaSamw * | SMB_THREAD_STATE_EXITING |----+ 123da6c28aaSamw * +-----------------------------+ 124da6c28aaSamw * 125da6c28aaSamw * Transition T0 126da6c28aaSamw * 127da6c28aaSamw * This transition is executed in smb_thread_init(). 128da6c28aaSamw * 129da6c28aaSamw * Transition T1 130da6c28aaSamw * 131da6c28aaSamw * This transition is executed in smb_thread_start(). 132da6c28aaSamw * 133da6c28aaSamw * Transition T2 134da6c28aaSamw * 135da6c28aaSamw * This transition is executed by the thread itself when it starts running. 136da6c28aaSamw * 137da6c28aaSamw * Transition T3 138da6c28aaSamw * 139da6c28aaSamw * This transition is executed by the thread itself in 140da6c28aaSamw * smb_thread_entry_point() just before calling thread_exit(). 141da6c28aaSamw * 142da6c28aaSamw * 143da6c28aaSamw * Transition T4 144da6c28aaSamw * 145da6c28aaSamw * This transition is executed in smb_thread_stop(). 146da6c28aaSamw * 147da6c28aaSamw * Transition T5 148da6c28aaSamw * 149da6c28aaSamw * This transition is executed in smb_thread_destroy(). 150da6c28aaSamw * 151da6c28aaSamw * Comments 152da6c28aaSamw * -------- 153da6c28aaSamw * 154da6c28aaSamw * The field smb_thread_aw_t contains a function pointer that knows how to 155da6c28aaSamw * awake the thread. It is a temporary solution to work around the fact that 156da6c28aaSamw * kernel threads (not part of a userspace process) cannot be signaled. 157da6c28aaSamw */ 158da6c28aaSamw typedef enum smb_thread_state { 159da6c28aaSamw SMB_THREAD_STATE_STARTING = 0, 160da6c28aaSamw SMB_THREAD_STATE_RUNNING, 161da6c28aaSamw SMB_THREAD_STATE_EXITING, 162da6c28aaSamw SMB_THREAD_STATE_EXITED 163da6c28aaSamw } smb_thread_state_t; 164da6c28aaSamw 165da6c28aaSamw struct _smb_thread; 166da6c28aaSamw 167da6c28aaSamw typedef void (*smb_thread_ep_t)(struct _smb_thread *, void *ep_arg); 168da6c28aaSamw typedef void (*smb_thread_aw_t)(struct _smb_thread *, void *aw_arg); 169da6c28aaSamw 170da6c28aaSamw #define SMB_THREAD_MAGIC 0x534D4254 /* SMBT */ 171da6c28aaSamw 172da6c28aaSamw typedef struct _smb_thread { 173da6c28aaSamw uint32_t sth_magic; 174da6c28aaSamw char sth_name[16]; 175da6c28aaSamw smb_thread_state_t sth_state; 176da6c28aaSamw kthread_t *sth_th; 177da6c28aaSamw kt_did_t sth_did; 178da6c28aaSamw smb_thread_ep_t sth_ep; 179da6c28aaSamw void *sth_ep_arg; 180da6c28aaSamw smb_thread_aw_t sth_aw; 181da6c28aaSamw void *sth_aw_arg; 182da6c28aaSamw boolean_t sth_kill; 183da6c28aaSamw kmutex_t sth_mtx; 184da6c28aaSamw kcondvar_t sth_cv; 185da6c28aaSamw } smb_thread_t; 186da6c28aaSamw 187da6c28aaSamw /* 188da6c28aaSamw * Pool of IDs 189da6c28aaSamw * ----------- 190da6c28aaSamw * 191da6c28aaSamw * A pool of IDs is a pool of 16 bit numbers. It is implemented as a bitmap. 192da6c28aaSamw * A bit set to '1' indicates that that particular value has been allocated. 193da6c28aaSamw * The allocation process is done shifting a bit through the whole bitmap. 194da6c28aaSamw * The current position of that index bit is kept in the smb_idpool_t 195da6c28aaSamw * structure and represented by a byte index (0 to buffer size minus 1) and 196da6c28aaSamw * a bit index (0 to 7). 197da6c28aaSamw * 198da6c28aaSamw * The pools start with a size of 8 bytes or 64 IDs. Each time the pool runs 199da6c28aaSamw * out of IDs its current size is doubled until it reaches its maximum size 200da6c28aaSamw * (8192 bytes or 65536 IDs). The IDs 0 and 65535 are never given out which 201da6c28aaSamw * means that a pool can have a maximum number of 65534 IDs available. 202da6c28aaSamw */ 203da6c28aaSamw #define SMB_IDPOOL_MAGIC 0x4944504C /* IDPL */ 204da6c28aaSamw #define SMB_IDPOOL_MIN_SIZE 64 /* Number of IDs to begin with */ 205da6c28aaSamw #define SMB_IDPOOL_MAX_SIZE 64 * 1024 206da6c28aaSamw 207da6c28aaSamw typedef struct smb_idpool { 208da6c28aaSamw uint32_t id_magic; 209da6c28aaSamw kmutex_t id_mutex; 210da6c28aaSamw uint8_t *id_pool; 211da6c28aaSamw uint32_t id_size; 212da6c28aaSamw uint8_t id_bit; 213da6c28aaSamw uint8_t id_bit_idx; 214da6c28aaSamw uint32_t id_idx; 215da6c28aaSamw uint32_t id_idx_msk; 216da6c28aaSamw uint32_t id_free_counter; 217da6c28aaSamw uint32_t id_max_free_counter; 218da6c28aaSamw } smb_idpool_t; 219da6c28aaSamw 220da6c28aaSamw /* 22121b7895dSjb * Maximum size of a Transport Data Unit 22221b7895dSjb * 4 --> NBT/TCP Transport Header. 22321b7895dSjb * 32 --> SMB Header 22421b7895dSjb * 1 --> Word Count byte 22521b7895dSjb * 510 --> Maximum Number of bytes of the Word Table (2 * 255) 22621b7895dSjb * 2 --> Byte count of the data 22721b7895dSjb * 65535 --> Maximum size of the data 22821b7895dSjb * ----- 22921b7895dSjb * 66084 230da6c28aaSamw */ 23121b7895dSjb #define SMB_REQ_MAX_SIZE 66080 23221b7895dSjb #define SMB_XPRT_MAX_SIZE (SMB_REQ_MAX_SIZE + NETBIOS_HDR_SZ) 233da6c28aaSamw 23421b7895dSjb #define SMB_TXREQ_MAGIC 0X54524251 /* 'TREQ' */ 2355cdbe942Sjb typedef struct { 23621b7895dSjb uint32_t tr_magic; 23721b7895dSjb list_node_t tr_lnd; 23821b7895dSjb int tr_len; 23921b7895dSjb uint8_t tr_buf[SMB_XPRT_MAX_SIZE]; 24021b7895dSjb } smb_txreq_t; 2415cdbe942Sjb 2425cdbe942Sjb #define SMB_TXLST_MAGIC 0X544C5354 /* 'TLST' */ 2435cdbe942Sjb typedef struct { 2445cdbe942Sjb uint32_t tl_magic; 2455cdbe942Sjb kmutex_t tl_mutex; 2465cdbe942Sjb boolean_t tl_active; 2475cdbe942Sjb list_t tl_list; 2485cdbe942Sjb } smb_txlst_t; 2495cdbe942Sjb 250da6c28aaSamw /* 251faa1795aSjb * Maximum buffer size for NT is 37KB. If all clients are Windows 2000, this 252faa1795aSjb * can be changed to 64KB. 37KB must be used with a mix of NT/Windows 2000 253faa1795aSjb * clients because NT loses directory entries when values greater than 37KB are 254faa1795aSjb * used. 255faa1795aSjb * 256faa1795aSjb * Note: NBT_MAXBUF will be subtracted from the specified max buffer size to 257faa1795aSjb * account for the NBT header. 258da6c28aaSamw */ 259faa1795aSjb #define NBT_MAXBUF 8 260faa1795aSjb #define SMB_NT_MAXBUF (37 * 1024) 261da6c28aaSamw 262da6c28aaSamw #define OUTBUFSIZE (65 * 1024) 263da6c28aaSamw #define SMBHEADERSIZE 32 264da6c28aaSamw #define SMBND_HASH_MASK (0xFF) 265da6c28aaSamw #define MAX_IOVEC 512 266da6c28aaSamw #define MAX_READREF (8 * 1024) 267da6c28aaSamw 268da6c28aaSamw #define SMB_WORKER_MIN 4 269da6c28aaSamw #define SMB_WORKER_DEFAULT 64 270da6c28aaSamw #define SMB_WORKER_MAX 1024 271da6c28aaSamw 272da6c28aaSamw /* 273da6c28aaSamw * Fix align a pointer or offset appropriately so that fields will not 274da6c28aaSamw * cross word boundaries. 275da6c28aaSamw */ 276da6c28aaSamw #define PTRALIGN(x) \ 277da6c28aaSamw (((uintptr_t)(x) + (uintptr_t)(_POINTER_ALIGNMENT) - 1l) & \ 278da6c28aaSamw ~((uintptr_t)(_POINTER_ALIGNMENT) - 1l)) 279da6c28aaSamw 280da6c28aaSamw /* 281da6c28aaSamw * native os types are defined in win32/smbinfo.h 282da6c28aaSamw */ 283da6c28aaSamw 284da6c28aaSamw /* 285da6c28aaSamw * All 4 different time / date formats that will bee seen in SMB 286da6c28aaSamw */ 287da6c28aaSamw typedef struct { 288da6c28aaSamw uint16_t Day : 5; 289da6c28aaSamw uint16_t Month : 4; 290da6c28aaSamw uint16_t Year : 7; 291da6c28aaSamw } SMB_DATE; 292da6c28aaSamw 293da6c28aaSamw typedef struct { 294da6c28aaSamw uint16_t TwoSeconds : 5; 295da6c28aaSamw uint16_t Minutes : 6; 296da6c28aaSamw uint16_t Hours : 5; 297da6c28aaSamw } SMB_TIME; 298da6c28aaSamw 299da6c28aaSamw 300da6c28aaSamw typedef uint32_t UTIME; /* seconds since Jan 1 1970 */ 301da6c28aaSamw 302da6c28aaSamw typedef struct smb_malloc_list { 303da6c28aaSamw struct smb_malloc_list *forw; 304da6c28aaSamw struct smb_malloc_list *back; 305da6c28aaSamw } smb_malloc_list; 306da6c28aaSamw 307da6c28aaSamw typedef struct smb_llist { 308da6c28aaSamw krwlock_t ll_lock; 309da6c28aaSamw list_t ll_list; 310da6c28aaSamw uint32_t ll_count; 311da6c28aaSamw uint64_t ll_wrop; 312da6c28aaSamw } smb_llist_t; 313da6c28aaSamw 314da6c28aaSamw typedef struct smb_slist { 315da6c28aaSamw kmutex_t sl_mutex; 316da6c28aaSamw kcondvar_t sl_cv; 317da6c28aaSamw list_t sl_list; 318da6c28aaSamw uint32_t sl_count; 319da6c28aaSamw boolean_t sl_waiting; 320da6c28aaSamw } smb_slist_t; 321da6c28aaSamw 322faa1795aSjb typedef struct smb_session_list { 323faa1795aSjb krwlock_t se_lock; 324faa1795aSjb uint64_t se_wrop; 325faa1795aSjb struct { 326faa1795aSjb list_t lst; 327faa1795aSjb uint32_t count; 328faa1795aSjb } se_rdy; 329faa1795aSjb struct { 330faa1795aSjb list_t lst; 331faa1795aSjb uint32_t count; 332faa1795aSjb } se_act; 333faa1795aSjb } smb_session_list_t; 334faa1795aSjb 335da6c28aaSamw typedef struct { 336da6c28aaSamw kcondvar_t rwx_cv; 337da6c28aaSamw kmutex_t rwx_mutex; 338da6c28aaSamw krwlock_t rwx_lock; 339da6c28aaSamw boolean_t rwx_waiting; 340da6c28aaSamw } smb_rwx_t; 341da6c28aaSamw 342da6c28aaSamw /* NOTIFY CHANGE */ 343da6c28aaSamw 344da6c28aaSamw typedef struct smb_notify_change_req { 345da6c28aaSamw list_node_t nc_lnd; 346da6c28aaSamw struct smb_node *nc_node; 347da6c28aaSamw uint32_t nc_reply_type; 348da6c28aaSamw uint32_t nc_flags; 349da6c28aaSamw } smb_notify_change_req_t; 350da6c28aaSamw 351da6c28aaSamw /* 352da6c28aaSamw * SMB operates over a NetBIOS-over-TCP transport (NBT) or directly 353da6c28aaSamw * over TCP, which is also known as direct hosted NetBIOS-less SMB 354da6c28aaSamw * or SMB-over-TCP. 355da6c28aaSamw * 356da6c28aaSamw * NBT messages have a 4-byte header that defines the message type 357da6c28aaSamw * (8-bits), a 7-bit flags field and a 17-bit length. 358da6c28aaSamw * 359da6c28aaSamw * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 360da6c28aaSamw * | TYPE | FLAGS |E| LENGTH | 361da6c28aaSamw * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 362da6c28aaSamw * 363da6c28aaSamw * 8-bit type Defined in RFC 1002 364da6c28aaSamw * 7-bit flags Bits 0-6 reserved (must be 0) 365da6c28aaSamw * Bit 7: Length extension bit (E) 366da6c28aaSamw * 17-bit length Includes bit 7 of the flags byte 367da6c28aaSamw * 368da6c28aaSamw * 369da6c28aaSamw * SMB-over-TCP is defined to use a modified version of the NBT header 370da6c28aaSamw * containing an 8-bit message type and 24-bit message length. 371da6c28aaSamw * 372da6c28aaSamw * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 373da6c28aaSamw * | TYPE | LENGTH | 374da6c28aaSamw * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 375da6c28aaSamw * 376da6c28aaSamw * 8-bit type Must be 0 377da6c28aaSamw * 24-bit length 378da6c28aaSamw * 379da6c28aaSamw * The following structure is used to represent a generic, in-memory 380da6c28aaSamw * SMB transport header; it is not intended to map directly to either 381da6c28aaSamw * of the over-the-wire formats. 382da6c28aaSamw */ 383da6c28aaSamw typedef struct { 384da6c28aaSamw uint8_t xh_type; 385da6c28aaSamw uint32_t xh_length; 386da6c28aaSamw } smb_xprt_t; 387da6c28aaSamw 388faa1795aSjb int MBC_LENGTH(struct mbuf_chain *); 3893ad684d6Sjb int MBC_MAXBYTES(struct mbuf_chain *); 390faa1795aSjb void MBC_SETUP(struct mbuf_chain *, uint32_t); 391faa1795aSjb void MBC_INIT(struct mbuf_chain *, uint32_t); 392faa1795aSjb void MBC_FLUSH(struct mbuf_chain *); 393faa1795aSjb void MBC_ATTACH_MBUF(struct mbuf_chain *, struct mbuf *); 394faa1795aSjb void MBC_APPEND_MBUF(struct mbuf_chain *, struct mbuf *); 395da6c28aaSamw void MBC_ATTACH_BUF(struct mbuf_chain *MBC, unsigned char *BUF, int LEN); 396da6c28aaSamw int MBC_SHADOW_CHAIN(struct mbuf_chain *SUBMBC, struct mbuf_chain *MBC, 397da6c28aaSamw int OFF, int LEN); 398da6c28aaSamw 399da6c28aaSamw #define MBC_ROOM_FOR(b, n) (((b)->chain_offset + (n)) <= (b)->max_bytes) 400da6c28aaSamw 401da6c28aaSamw typedef struct smb_oplock { 402da6c28aaSamw struct smb_ofile *op_ofile; 403da6c28aaSamw uint32_t op_flags; 4048c10a865Sas uint32_t op_ipaddr; 4058c10a865Sas uint64_t op_kid; 406da6c28aaSamw } smb_oplock_t; 407da6c28aaSamw 408da6c28aaSamw #define OPLOCK_FLAG_BREAKING 1 409da6c28aaSamw 410da6c28aaSamw #define OPLOCK_RELEASE_LOCK_RELEASED 0 411da6c28aaSamw #define OPLOCK_RELEASE_FILE_CLOSED 1 412da6c28aaSamw 413da6c28aaSamw #define DOS_ATTR_VALID 0x80000000 414da6c28aaSamw 415da6c28aaSamw #define SMB_VFS_MAGIC 0x534D4256 /* 'SMBV' */ 416da6c28aaSamw 417da6c28aaSamw typedef struct smb_vfs { 418da6c28aaSamw uint32_t sv_magic; 419da6c28aaSamw list_node_t sv_lnd; 420da6c28aaSamw uint32_t sv_refcnt; 421da6c28aaSamw vfs_t *sv_vfsp; 422da6c28aaSamw vnode_t *sv_rootvp; 423da6c28aaSamw } smb_vfs_t; 424da6c28aaSamw 4252c1b14e5Sjose borrego typedef struct smb_unexport { 4262c1b14e5Sjose borrego list_node_t ux_lnd; 4272c1b14e5Sjose borrego char ux_sharename[MAXNAMELEN]; 4282c1b14e5Sjose borrego } smb_unexport_t; 4292c1b14e5Sjose borrego 430da6c28aaSamw #define SMB_NODE_MAGIC 0x4E4F4445 /* 'NODE' */ 431da6c28aaSamw 432da6c28aaSamw typedef enum { 433da6c28aaSamw SMB_NODE_STATE_AVAILABLE = 0, 434da6c28aaSamw SMB_NODE_STATE_DESTROYING 435da6c28aaSamw } smb_node_state_t; 436da6c28aaSamw 437da6c28aaSamw typedef struct smb_node { 438da6c28aaSamw uint32_t n_magic; 439da6c28aaSamw smb_rwx_t n_lock; 440dc20a302Sas krwlock_t n_share_lock; 441da6c28aaSamw list_node_t n_lnd; 442da6c28aaSamw smb_node_state_t n_state; 443da6c28aaSamw uint32_t n_refcnt; 444da6c28aaSamw uint32_t n_hashkey; 445faa1795aSjb struct smb_request *n_sr; 446faa1795aSjb kmem_cache_t *n_cache; 447da6c28aaSamw smb_llist_t *n_hash_bucket; 448da6c28aaSamw uint64_t n_orig_session_id; 449da6c28aaSamw uint32_t n_orig_uid; 450da6c28aaSamw smb_llist_t n_ofile_list; 451da6c28aaSamw smb_llist_t n_lock_list; 452c8ec8eeaSjose borrego struct smb_ofile *readonly_creator; 453da6c28aaSamw volatile int flags; /* FILE_NOTIFY_CHANGE_* */ 454da6c28aaSamw volatile int waiting_event; /* # of clients requesting FCN */ 455da6c28aaSamw smb_attr_t attr; 456da6c28aaSamw unsigned int what; 45755bf511dSas u_offset_t n_size; 458da6c28aaSamw smb_oplock_t n_oplock; 459da6c28aaSamw struct smb_node *dir_snode; /* Directory of node */ 460da6c28aaSamw struct smb_node *unnamed_stream_node; /* set in stream nodes */ 461da6c28aaSamw /* Credentials for delayed delete */ 462da6c28aaSamw cred_t *delete_on_close_cred; 463da6c28aaSamw char od_name[MAXNAMELEN]; 464da6c28aaSamw vnode_t *vp; 465da6c28aaSamw smb_audit_buf_node_t *n_audit_buf; 466da6c28aaSamw } smb_node_t; 467da6c28aaSamw 468da6c28aaSamw #define NODE_FLAGS_NOTIFY_CHANGE 0x10000fff 469da6c28aaSamw #define NODE_OPLOCKS_IN_FORCE 0x0000f000 470da6c28aaSamw #define NODE_OPLOCK_NONE 0x00000000 471da6c28aaSamw #define NODE_EXCLUSIVE_OPLOCK 0x00001000 472da6c28aaSamw #define NODE_BATCH_OPLOCK 0x00002000 473da6c28aaSamw #define NODE_LEVEL_II_OPLOCK 0x00003000 474da6c28aaSamw #define NODE_CAP_LEVEL_II 0x00010000 475da6c28aaSamw #define NODE_PROTOCOL_LOCK 0x00020000 476da6c28aaSamw #define NODE_FLAGS_WRITE_THROUGH 0x00100000 477da6c28aaSamw #define NODE_FLAGS_SYNCATIME 0x00200000 478da6c28aaSamw #define NODE_FLAGS_LOCKED 0x00400000 479da6c28aaSamw #define NODE_FLAGS_ATTR_VALID 0x00800000 480cbfb650aScp #define NODE_XATTR_DIR 0x01000000 481da6c28aaSamw #define NODE_FLAGS_CREATED 0x04000000 482da6c28aaSamw #define NODE_FLAGS_CHANGED 0x08000000 483da6c28aaSamw #define NODE_FLAGS_WATCH_TREE 0x10000000 484da6c28aaSamw #define NODE_FLAGS_SET_SIZE 0x20000000 485da6c28aaSamw #define NODE_FLAGS_DELETE_ON_CLOSE 0x40000000 486da6c28aaSamw #define NODE_FLAGS_EXECUTABLE 0x80000000 487da6c28aaSamw 488da6c28aaSamw #define OPLOCK_TYPE(n) ((n)->flags & NODE_OPLOCKS_IN_FORCE) 489da6c28aaSamw #define OPLOCKS_IN_FORCE(n) (OPLOCK_TYPE(n) != NODE_OPLOCK_NONE) 490da6c28aaSamw #define EXCLUSIVE_OPLOCK_IN_FORCE(n) \ 491da6c28aaSamw (OPLOCK_TYPE(n) == NODE_EXCLUSIVE_OPLOCK) 492da6c28aaSamw #define BATCH_OPLOCK_IN_FORCE(n) (OPLOCK_TYPE(n) == NODE_BATCH_OPLOCK) 493da6c28aaSamw #define LEVEL_II_OPLOCK_IN_FORCE(n) (OPLOCK_TYPE(n) == NODE_LEVEL_II_OPLOCK) 494da6c28aaSamw 495c8ec8eeaSjose borrego #define SMB_NODE_VFS(node) ((node)->vp->v_vfsp) 496c8ec8eeaSjose borrego #define SMB_NODE_FSID(node) ((node)->vp->v_vfsp->vfs_fsid) 497c8ec8eeaSjose borrego 498da6c28aaSamw /* 499da6c28aaSamw * Based on section 2.6.1.2 (Connection Management) of the June 13, 500da6c28aaSamw * 1996 CIFS spec, a server may terminate the transport connection 501da6c28aaSamw * due to inactivity. The client software is expected to be able to 502da6c28aaSamw * automatically reconnect to the server if this happens. Like much 503da6c28aaSamw * of the useful background information, this section appears to 504da6c28aaSamw * have been dropped from later revisions of the document. 505da6c28aaSamw * 506da6c28aaSamw * Each session has an activity timestamp that's updated whenever a 507da6c28aaSamw * request is dispatched. If the session is idle, i.e. receives no 508da6c28aaSamw * requests, for SMB_SESSION_INACTIVITY_TIMEOUT minutes it will be 509da6c28aaSamw * closed. 510da6c28aaSamw * 511da6c28aaSamw * Each session has an I/O semaphore to serialize communication with 512da6c28aaSamw * the client. For example, after receiving a raw-read request, the 513da6c28aaSamw * server is not allowed to send an oplock break to the client until 514da6c28aaSamw * after it has sent the raw-read data. 515da6c28aaSamw */ 516da6c28aaSamw #define SMB_SESSION_INACTIVITY_TIMEOUT (15 * 60) 517da6c28aaSamw 518da6c28aaSamw #define SMB_SESSION_OFILE_MAX (16 * 1024) 519da6c28aaSamw 520da6c28aaSamw /* 521da6c28aaSamw * When a connection is set up we need to remember both the client 522da6c28aaSamw * (peer) IP address and the local IP address used to establish the 523da6c28aaSamw * connection. When a client connects with a vc number of zero, we 524da6c28aaSamw * are supposed to abort any existing connections with that client 525da6c28aaSamw * (see notes in smb_negotiate.c and smb_session_setup_andx.c). For 526da6c28aaSamw * servers with multiple network interfaces or IP aliases, however, 527da6c28aaSamw * each interface has to be managed independently since the client 528da6c28aaSamw * is not aware of the server configuration. We have to allow the 529da6c28aaSamw * client to establish a connection on each interface with a vc 530da6c28aaSamw * number of zero without aborting the other connections. 531da6c28aaSamw * 532da6c28aaSamw * ipaddr: the client (peer) IP address for the session. 533da6c28aaSamw * local_ipaddr: the local IP address used to connect to the server. 534da6c28aaSamw */ 535da6c28aaSamw 536da6c28aaSamw #define SMB_MAC_KEYSZ 512 537da6c28aaSamw 538da6c28aaSamw struct smb_sign { 539da6c28aaSamw unsigned int seqnum; 540da6c28aaSamw unsigned int mackey_len; 541da6c28aaSamw unsigned int flags; 542da6c28aaSamw unsigned char mackey[SMB_MAC_KEYSZ]; 543da6c28aaSamw }; 544da6c28aaSamw 545da6c28aaSamw #define SMB_SIGNING_ENABLED 1 546da6c28aaSamw #define SMB_SIGNING_CHECK 2 547da6c28aaSamw 548da6c28aaSamw /* 549da6c28aaSamw * Session State Machine 550da6c28aaSamw * --------------------- 551da6c28aaSamw * 552da6c28aaSamw * +-----------------------------+ +------------------------------+ 553da6c28aaSamw * | SMB_SESSION_STATE_CONNECTED | | SMB_SESSION_STATE_TERMINATED | 554da6c28aaSamw * +-----------------------------+ +------------------------------+ 555da6c28aaSamw * T0| ^ 556da6c28aaSamw * +--------------------+ |T13 557da6c28aaSamw * v |T14 | 558da6c28aaSamw * +-------------------------------+ | +--------------------------------+ 559da6c28aaSamw * | SMB_SESSION_STATE_ESTABLISHED |---+--->| SMB_SESSION_STATE_DISCONNECTED | 560da6c28aaSamw * +-------------------------------+ +--------------------------------+ 561da6c28aaSamw * T1| ^ ^ ^ ^ 562da6c28aaSamw * +----------+ |T9 | | | 563da6c28aaSamw * v | | | | 564da6c28aaSamw * +------------------------------+ | | | 565da6c28aaSamw * | SMB_SESSION_STATE_NEGOTIATED | | | | 566da6c28aaSamw * +------------------------------+ | | | 567da6c28aaSamw * ^| ^| | ^ | | | 568da6c28aaSamw * +----------------+| || | | | | | 569da6c28aaSamw * |+----------------+ || T7| |T8 | | | 570da6c28aaSamw * || || | | | | | 571da6c28aaSamw * || +----------------+| | | | | | 572da6c28aaSamw * || |+----------------+ | | | | | 573da6c28aaSamw * || || v | | | | 574da6c28aaSamw * || || +-----------------------------------+ T10| | | 575da6c28aaSamw * || || | SMB_SESSION_STATE_OPLOCK_BREAKING |----+ | | 576da6c28aaSamw * || || +-----------------------------------+ | | 577da6c28aaSamw * || ||T5 | | 578da6c28aaSamw * || |+-->+-----------------------------------+ T11| | 579da6c28aaSamw * || |T6 | SMB_SESSION_STATE_READ_RAW_ACTIVE |------+ | 580da6c28aaSamw * || +----+-----------------------------------+ | 581da6c28aaSamw * ||T3 | 582da6c28aaSamw * |+------->+------------------------------------+ T12| 583da6c28aaSamw * |T4 | SMB_SESSION_STATE_WRITE_RAW_ACTIVE |-------+ 584da6c28aaSamw * +---------+------------------------------------+ 585da6c28aaSamw * 586da6c28aaSamw * Transition T0 587da6c28aaSamw * 588da6c28aaSamw * 589da6c28aaSamw * 590da6c28aaSamw * Transition T1 591da6c28aaSamw * 592da6c28aaSamw * 593da6c28aaSamw * 594da6c28aaSamw * Transition T2 595da6c28aaSamw * 596da6c28aaSamw * 597da6c28aaSamw * 598da6c28aaSamw * Transition T3 599da6c28aaSamw * 600da6c28aaSamw * 601da6c28aaSamw * 602da6c28aaSamw * Transition T4 603da6c28aaSamw * 604da6c28aaSamw * 605da6c28aaSamw * 606da6c28aaSamw * Transition T5 607da6c28aaSamw * 608da6c28aaSamw * 609da6c28aaSamw * 610da6c28aaSamw * Transition T6 611da6c28aaSamw * 612da6c28aaSamw * 613da6c28aaSamw * 614da6c28aaSamw * Transition T7 615da6c28aaSamw * 616da6c28aaSamw * 617da6c28aaSamw * 618da6c28aaSamw * Transition T8 619da6c28aaSamw * 620da6c28aaSamw * 621da6c28aaSamw * 622da6c28aaSamw * Transition T9 623da6c28aaSamw * 624da6c28aaSamw * 625da6c28aaSamw * 626da6c28aaSamw * Transition T10 627da6c28aaSamw * 628da6c28aaSamw * 629da6c28aaSamw * 630da6c28aaSamw * Transition T11 631da6c28aaSamw * 632da6c28aaSamw * 633da6c28aaSamw * 634da6c28aaSamw * Transition T12 635da6c28aaSamw * 636da6c28aaSamw * 637da6c28aaSamw * 638da6c28aaSamw * Transition T13 639da6c28aaSamw * 640da6c28aaSamw * 641da6c28aaSamw * 642da6c28aaSamw * Transition T14 643da6c28aaSamw * 644da6c28aaSamw * 645da6c28aaSamw * 646da6c28aaSamw */ 647da6c28aaSamw #define SMB_SESSION_MAGIC 0x53455353 /* 'SESS' */ 648da6c28aaSamw 649da6c28aaSamw typedef enum { 650faa1795aSjb SMB_SESSION_STATE_INITIALIZED = 0, 651faa1795aSjb SMB_SESSION_STATE_DISCONNECTED, 652da6c28aaSamw SMB_SESSION_STATE_CONNECTED, 653da6c28aaSamw SMB_SESSION_STATE_ESTABLISHED, 654da6c28aaSamw SMB_SESSION_STATE_NEGOTIATED, 655da6c28aaSamw SMB_SESSION_STATE_OPLOCK_BREAKING, 656da6c28aaSamw SMB_SESSION_STATE_WRITE_RAW_ACTIVE, 6576537f381Sas SMB_SESSION_STATE_TERMINATED, 6586537f381Sas SMB_SESSION_STATE_SENTINEL 659da6c28aaSamw } smb_session_state_t; 660da6c28aaSamw 661faa1795aSjb typedef struct smb_session { 662da6c28aaSamw uint32_t s_magic; 663da6c28aaSamw smb_rwx_t s_lock; 664da6c28aaSamw list_node_t s_lnd; 665da6c28aaSamw uint64_t s_kid; 666da6c28aaSamw smb_session_state_t s_state; 667da6c28aaSamw uint32_t s_flags; 668da6c28aaSamw int s_write_raw_status; 669faa1795aSjb kthread_t *s_thread; 670faa1795aSjb kt_did_t s_ktdid; 671faa1795aSjb smb_kmod_cfg_t s_cfg; 672faa1795aSjb kmem_cache_t *s_cache; 673faa1795aSjb kmem_cache_t *s_cache_request; 674faa1795aSjb struct smb_server *s_server; 675c8ec8eeaSjose borrego int32_t s_gmtoff; 676da6c28aaSamw uint32_t keep_alive; 677da6c28aaSamw uint64_t opentime; 678da6c28aaSamw uint16_t vcnumber; 679da6c28aaSamw uint16_t s_local_port; 680da6c28aaSamw uint32_t ipaddr; 681da6c28aaSamw uint32_t local_ipaddr; 682da6c28aaSamw char workstation[SMB_PI_MAX_HOST]; 683da6c28aaSamw int dialect; 684da6c28aaSamw int native_os; 685da6c28aaSamw uint32_t capabilities; 686da6c28aaSamw struct smb_sign signing; 687da6c28aaSamw 688*0f1702c5SYu Xiangning ksocket_t sock; 689da6c28aaSamw 690da6c28aaSamw smb_slist_t s_req_list; 691da6c28aaSamw smb_llist_t s_xa_list; 692da6c28aaSamw smb_llist_t s_user_list; 693da6c28aaSamw smb_idpool_t s_uid_pool; 6945cdbe942Sjb smb_txlst_t s_txlst; 695da6c28aaSamw 696da6c28aaSamw volatile uint32_t s_tree_cnt; 697da6c28aaSamw volatile uint32_t s_file_cnt; 698da6c28aaSamw volatile uint32_t s_dir_cnt; 699da6c28aaSamw 700da6c28aaSamw uint16_t secmode; 701da6c28aaSamw uint32_t sesskey; 702da6c28aaSamw uint32_t challenge_len; 703da6c28aaSamw unsigned char challenge_key[8]; 704da6c28aaSamw unsigned char MAC_key[44]; 705da6c28aaSamw int64_t activity_timestamp; 706da6c28aaSamw /* 707da6c28aaSamw * Maximum negotiated buffer size between SMB client and server 708da6c28aaSamw * in SMB_SESSION_SETUP_ANDX 709da6c28aaSamw */ 710da6c28aaSamw uint16_t smb_msg_size; 711da6c28aaSamw uchar_t *outpipe_data; 712da6c28aaSamw int outpipe_datalen; 713da6c28aaSamw int outpipe_cookie; 714faa1795aSjb } smb_session_t; 715da6c28aaSamw 716da6c28aaSamw #define SMB_USER_MAGIC 0x55534552 /* 'USER' */ 717da6c28aaSamw 718da6c28aaSamw #define SMB_USER_FLAG_GUEST SMB_ATF_GUEST 719da6c28aaSamw #define SMB_USER_FLAG_IPC SMB_ATF_ANON 720da6c28aaSamw #define SMB_USER_FLAG_ADMIN SMB_ATF_ADMIN 721da6c28aaSamw #define SMB_USER_FLAG_POWER_USER SMB_ATF_POWERUSER 722da6c28aaSamw #define SMB_USER_FLAG_BACKUP_OPERATOR SMB_ATF_BACKUPOP 723da6c28aaSamw 724da6c28aaSamw #define SMB_USER_PRIV_TAKE_OWNERSHIP 0x00000001 725da6c28aaSamw #define SMB_USER_PRIV_BACKUP 0x00000002 726da6c28aaSamw #define SMB_USER_PRIV_RESTORE 0x00000004 727da6c28aaSamw #define SMB_USER_PRIV_SECURITY 0x00000008 728da6c28aaSamw 729da6c28aaSamw 730da6c28aaSamw typedef enum { 731da6c28aaSamw SMB_USER_STATE_LOGGED_IN = 0, 732da6c28aaSamw SMB_USER_STATE_LOGGING_OFF, 7336537f381Sas SMB_USER_STATE_LOGGED_OFF, 7346537f381Sas SMB_USER_STATE_SENTINEL 735da6c28aaSamw } smb_user_state_t; 736da6c28aaSamw 737da6c28aaSamw typedef struct smb_user { 738da6c28aaSamw uint32_t u_magic; 739da6c28aaSamw list_node_t u_lnd; 740da6c28aaSamw kmutex_t u_mutex; 741da6c28aaSamw smb_user_state_t u_state; 742da6c28aaSamw 743faa1795aSjb struct smb_server *u_server; 744da6c28aaSamw smb_session_t *u_session; 745da6c28aaSamw uint16_t u_name_len; 746da6c28aaSamw char *u_name; 747da6c28aaSamw uint16_t u_domain_len; 748da6c28aaSamw char *u_domain; 749da6c28aaSamw time_t u_logon_time; 750da6c28aaSamw cred_t *u_cred; 751b89a8333Snatalie li - Sun Microsystems - Irvine United States cred_t *u_privcred; 752da6c28aaSamw 753da6c28aaSamw smb_llist_t u_tree_list; 754da6c28aaSamw smb_idpool_t u_tid_pool; 755da6c28aaSamw 756da6c28aaSamw uint32_t u_refcnt; 757da6c28aaSamw uint32_t u_flags; 758da6c28aaSamw uint32_t u_privileges; 759da6c28aaSamw uint16_t u_uid; 760da6c28aaSamw uint32_t u_audit_sid; 761da6c28aaSamw } smb_user_t; 762da6c28aaSamw 763c8ec8eeaSjose borrego #define SMB_TREE_MAGIC 0x54524545 /* 'TREE' */ 764c8ec8eeaSjose borrego 765c8ec8eeaSjose borrego #define SMB_TYPENAMELEN _ST_FSTYPSZ 766c8ec8eeaSjose borrego #define SMB_VOLNAMELEN 32 767c8ec8eeaSjose borrego 768c8ec8eeaSjose borrego #define SMB_TREE_READONLY 0x00000001 769c8ec8eeaSjose borrego #define SMB_TREE_SUPPORTS_ACLS 0x00000002 770c8ec8eeaSjose borrego #define SMB_TREE_STREAMS 0x00000004 771c8ec8eeaSjose borrego #define SMB_TREE_CASEINSENSITIVE 0x00000008 772c8ec8eeaSjose borrego #define SMB_TREE_NO_CASESENSITIVE 0x00000010 773c8ec8eeaSjose borrego #define SMB_TREE_NO_EXPORT 0x00000020 774c8ec8eeaSjose borrego #define SMB_TREE_NO_OPLOCKS 0x00000040 775c8ec8eeaSjose borrego #define SMB_TREE_NO_ATIME 0x00000080 776c8ec8eeaSjose borrego #define SMB_TREE_XVATTR 0x00000100 777c8ec8eeaSjose borrego #define SMB_TREE_DIRENTFLAGS 0x00000200 778c8ec8eeaSjose borrego #define SMB_TREE_ACLONCREATE 0x00000400 779c8ec8eeaSjose borrego #define SMB_TREE_ACEMASKONACCESS 0x00000800 780c8ec8eeaSjose borrego #define SMB_TREE_NFS_MOUNTED 0x00001000 7812c1b14e5Sjose borrego 782da6c28aaSamw typedef enum { 783da6c28aaSamw SMB_TREE_STATE_CONNECTED = 0, 784da6c28aaSamw SMB_TREE_STATE_DISCONNECTING, 7856537f381Sas SMB_TREE_STATE_DISCONNECTED, 7866537f381Sas SMB_TREE_STATE_SENTINEL 787da6c28aaSamw } smb_tree_state_t; 788da6c28aaSamw 789da6c28aaSamw typedef struct smb_tree { 790da6c28aaSamw uint32_t t_magic; 791da6c28aaSamw kmutex_t t_mutex; 792da6c28aaSamw list_node_t t_lnd; 793da6c28aaSamw smb_tree_state_t t_state; 794da6c28aaSamw 795faa1795aSjb struct smb_server *t_server; 796da6c28aaSamw smb_session_t *t_session; 797da6c28aaSamw smb_user_t *t_user; 798da6c28aaSamw smb_node_t *t_snode; 799da6c28aaSamw 800da6c28aaSamw smb_llist_t t_ofile_list; 801da6c28aaSamw smb_idpool_t t_fid_pool; 802da6c28aaSamw 803da6c28aaSamw smb_llist_t t_odir_list; 804da6c28aaSamw smb_idpool_t t_sid_pool; 805da6c28aaSamw 806da6c28aaSamw uint32_t t_refcnt; 807da6c28aaSamw uint32_t t_flags; 808da6c28aaSamw int32_t t_res_type; 809da6c28aaSamw uint16_t t_tid; 810da6c28aaSamw uint16_t t_umask; 811da6c28aaSamw char t_sharename[MAXNAMELEN]; 812da6c28aaSamw char t_resource[MAXPATHLEN]; 813c8ec8eeaSjose borrego char t_typename[SMB_TYPENAMELEN]; 814c8ec8eeaSjose borrego char t_volume[SMB_VOLNAMELEN]; 815da6c28aaSamw acl_type_t t_acltype; 816da6c28aaSamw } smb_tree_t; 817da6c28aaSamw 818c8ec8eeaSjose borrego #define SMB_TREE_VFS(tree) ((tree)->t_snode->vp->v_vfsp) 819c8ec8eeaSjose borrego #define SMB_TREE_FSID(tree) ((tree)->t_snode->vp->v_vfsp->vfs_fsid) 820c8ec8eeaSjose borrego 821c8ec8eeaSjose borrego #define SMB_TREE_IS_READONLY(sr) \ 822c8ec8eeaSjose borrego (((sr) && (sr)->tid_tree) ? \ 823c8ec8eeaSjose borrego smb_tree_has_feature((sr)->tid_tree, SMB_TREE_READONLY) : 0) 824c8ec8eeaSjose borrego 825c8ec8eeaSjose borrego #define SMB_TREE_IS_CASEINSENSITIVE(sr) \ 826c8ec8eeaSjose borrego (((sr) && (sr)->tid_tree) ? \ 827c8ec8eeaSjose borrego smb_tree_has_feature((sr)->tid_tree, SMB_TREE_CASEINSENSITIVE) : 0) 828da6c28aaSamw 829da6c28aaSamw /* 830c8ec8eeaSjose borrego * SMB_TREE_CONTAINS_NODE is used to check that a node is in the same 831c8ec8eeaSjose borrego * file system as the tree. 832da6c28aaSamw */ 833c8ec8eeaSjose borrego #define SMB_TREE_CONTAINS_NODE(sr, node) \ 834c8ec8eeaSjose borrego (((sr) && (sr)->tid_tree) ? \ 835c8ec8eeaSjose borrego (SMB_TREE_VFS((sr)->tid_tree) == SMB_NODE_VFS(node)) : 1) 836da6c28aaSamw 837da6c28aaSamw /* 838c8ec8eeaSjose borrego * SMB_NODE_IS_READONLY(node) 839c8ec8eeaSjose borrego * 840c8ec8eeaSjose borrego * This macro indicates whether the DOS readonly bit is set in the node's 841c8ec8eeaSjose borrego * attribute cache. The cache reflects what is on-disk. 842da6c28aaSamw */ 843da6c28aaSamw 844c8ec8eeaSjose borrego #define SMB_NODE_IS_READONLY(node) \ 845c8ec8eeaSjose borrego ((node) && (node)->attr.sa_dosattr & FILE_ATTRIBUTE_READONLY) 846da6c28aaSamw 847da6c28aaSamw /* 848c8ec8eeaSjose borrego * SMB_OFILE_IS_READONLY reflects whether an ofile is readonly or not. 849c8ec8eeaSjose borrego * The macro takes into account 850c8ec8eeaSjose borrego * - the tree readonly state 851c8ec8eeaSjose borrego * - the node readonly state 852c8ec8eeaSjose borrego * - whether the specified ofile is the readonly creator 853c8ec8eeaSjose borrego * The readonly creator has write permission until the ofile is closed. 854da6c28aaSamw */ 855da6c28aaSamw 856c8ec8eeaSjose borrego #define SMB_OFILE_IS_READONLY(of) \ 857c8ec8eeaSjose borrego (((of)->f_flags & SMB_OFLAGS_READONLY) || \ 858c8ec8eeaSjose borrego SMB_NODE_IS_READONLY((of)->f_node) || \ 859c8ec8eeaSjose borrego (((of)->f_node->readonly_creator) && \ 860c8ec8eeaSjose borrego ((of)->f_node->readonly_creator != (of)))) 861da6c28aaSamw 862c8ec8eeaSjose borrego /* 863c8ec8eeaSjose borrego * SMB_PATHFILE_IS_READONLY indicates whether or not a file is 864c8ec8eeaSjose borrego * readonly when the caller has a path rather than an ofile. Unlike 865c8ec8eeaSjose borrego * SMB_OFILE_IS_READONLY, the caller cannot be the readonly creator, 866c8ec8eeaSjose borrego * since that requires an ofile. 867c8ec8eeaSjose borrego */ 868da6c28aaSamw 869c8ec8eeaSjose borrego #define SMB_PATHFILE_IS_READONLY(sr, node) \ 870c8ec8eeaSjose borrego (SMB_TREE_IS_READONLY((sr)) || \ 871c8ec8eeaSjose borrego SMB_NODE_IS_READONLY((node)) || \ 872c8ec8eeaSjose borrego ((node)->readonly_creator)) 873da6c28aaSamw 874da6c28aaSamw #define PIPE_STATE_AUTH_VERIFY 0x00000001 875da6c28aaSamw 8763db3f65cSamw /* 8773db3f65cSamw * Data structure for SMB_FTYPE_MESG_PIPE ofiles, which is used 8783db3f65cSamw * at the interface between SMB and NDR RPC. 8793db3f65cSamw */ 8803db3f65cSamw typedef struct smb_opipe { 8813db3f65cSamw kmutex_t p_mutex; 8823db3f65cSamw kcondvar_t p_cv; 8833db3f65cSamw char *p_name; 8843db3f65cSamw uint32_t p_busy; 8853db3f65cSamw smb_opipe_hdr_t p_hdr; 8863db3f65cSamw smb_opipe_context_t p_context; 8873db3f65cSamw uint8_t *p_doorbuf; 8883db3f65cSamw uint8_t *p_data; 8893db3f65cSamw } smb_opipe_t; 8903db3f65cSamw 891da6c28aaSamw /* 892da6c28aaSamw * The of_ftype of an open file should contain the SMB_FTYPE value 893da6c28aaSamw * (cifs.h) returned when the file/pipe was opened. The following 894da6c28aaSamw * assumptions are currently made: 895da6c28aaSamw * 896da6c28aaSamw * File Type Node PipeInfo 897da6c28aaSamw * --------- -------- -------- 898da6c28aaSamw * SMB_FTYPE_DISK Valid Null 899da6c28aaSamw * SMB_FTYPE_BYTE_PIPE Undefined Undefined 900da6c28aaSamw * SMB_FTYPE_MESG_PIPE Null Valid 901da6c28aaSamw * SMB_FTYPE_PRINTER Undefined Undefined 902da6c28aaSamw * SMB_FTYPE_UNKNOWN Undefined Undefined 903da6c28aaSamw */ 904da6c28aaSamw 905da6c28aaSamw /* 906da6c28aaSamw * Some flags for ofile structure 907da6c28aaSamw * 908da6c28aaSamw * SMB_OFLAGS_SET_DELETE_ON_CLOSE 909da6c28aaSamw * Set this flag when the corresponding open operation whose 910da6c28aaSamw * DELETE_ON_CLOSE bit of the CreateOptions is set. If any 911da6c28aaSamw * open file instance has this bit set, the NODE_FLAGS_DELETE_ON_CLOSE 912da6c28aaSamw * will be set for the file node upon close. 913da6c28aaSamw */ 914da6c28aaSamw 915c8ec8eeaSjose borrego #define SMB_OFLAGS_READONLY 0x0001 916da6c28aaSamw #define SMB_OFLAGS_SET_DELETE_ON_CLOSE 0x0004 917da6c28aaSamw #define SMB_OFLAGS_LLF_POS_VALID 0x0008 918da6c28aaSamw 919da6c28aaSamw #define SMB_OFILE_MAGIC 0x4F464C45 /* 'OFLE' */ 920da6c28aaSamw 921da6c28aaSamw typedef enum { 922da6c28aaSamw SMB_OFILE_STATE_OPEN = 0, 923da6c28aaSamw SMB_OFILE_STATE_CLOSING, 9246537f381Sas SMB_OFILE_STATE_CLOSED, 9256537f381Sas SMB_OFILE_STATE_SENTINEL 926da6c28aaSamw } smb_ofile_state_t; 927da6c28aaSamw 928da6c28aaSamw typedef struct smb_ofile { 929da6c28aaSamw uint32_t f_magic; 930da6c28aaSamw kmutex_t f_mutex; 931da6c28aaSamw list_node_t f_lnd; 932da6c28aaSamw list_node_t f_nnd; 933da6c28aaSamw smb_ofile_state_t f_state; 934da6c28aaSamw 935faa1795aSjb struct smb_server *f_server; 936da6c28aaSamw smb_session_t *f_session; 937da6c28aaSamw smb_user_t *f_user; 938da6c28aaSamw smb_tree_t *f_tree; 939da6c28aaSamw smb_node_t *f_node; 9403db3f65cSamw smb_opipe_t *f_pipe; 941da6c28aaSamw 942dc20a302Sas uint32_t f_uniqid; 943da6c28aaSamw uint32_t f_refcnt; 944da6c28aaSamw uint64_t f_seek_pos; 945da6c28aaSamw uint32_t f_flags; 946da6c28aaSamw uint32_t f_granted_access; 947da6c28aaSamw uint32_t f_share_access; 948da6c28aaSamw uint32_t f_create_options; 949da6c28aaSamw uint16_t f_fid; 950da6c28aaSamw uint16_t f_opened_by_pid; 951da6c28aaSamw uint16_t f_ftype; 952da6c28aaSamw uint64_t f_llf_pos; 9538c10a865Sas int f_mode; 954da6c28aaSamw cred_t *f_cr; 9556537f381Sas pid_t f_pid; 956da6c28aaSamw } smb_ofile_t; 957da6c28aaSamw 958da6c28aaSamw /* odir flags bits */ 959da6c28aaSamw #define SMB_DIR_FLAG_OPEN 0x0001 960da6c28aaSamw #define SMB_DIR_FLAG_CLOSE 0x0002 961da6c28aaSamw #define SMB_DIR_CLOSED(dir) ((dir)->d_flags & SMB_DIR_FLAG_CLOSE) 962da6c28aaSamw 963da6c28aaSamw #define SMB_ODIR_MAGIC 0x4F444952 /* 'ODIR' */ 964da6c28aaSamw 965da6c28aaSamw typedef enum { 966da6c28aaSamw SMB_ODIR_STATE_OPEN = 0, 967da6c28aaSamw SMB_ODIR_STATE_CLOSING, 9686537f381Sas SMB_ODIR_STATE_CLOSED, 9696537f381Sas SMB_ODIR_STATE_SENTINEL 970da6c28aaSamw } smb_odir_state_t; 971da6c28aaSamw 972da6c28aaSamw typedef struct smb_odir { 973da6c28aaSamw uint32_t d_magic; 974da6c28aaSamw kmutex_t d_mutex; 975da6c28aaSamw list_node_t d_lnd; 976da6c28aaSamw smb_odir_state_t d_state; 977da6c28aaSamw 978da6c28aaSamw smb_session_t *d_session; 979da6c28aaSamw smb_user_t *d_user; 980da6c28aaSamw smb_tree_t *d_tree; 981da6c28aaSamw 982da6c28aaSamw uint32_t d_refcnt; 983da6c28aaSamw uint32_t d_cookie; 984c8ec8eeaSjose borrego uint32_t d_cookies[SMB_MAX_SEARCH]; 985da6c28aaSamw uint16_t d_sid; 986da6c28aaSamw uint16_t d_opened_by_pid; 987da6c28aaSamw uint16_t d_sattr; 988da6c28aaSamw char d_pattern[MAXNAMELEN]; 989da6c28aaSamw struct smb_node *d_dir_snode; 990da6c28aaSamw unsigned int d_wildcards; 991da6c28aaSamw } smb_odir_t; 992da6c28aaSamw 993da6c28aaSamw typedef struct smb_odir_context { 994c8ec8eeaSjose borrego uint32_t dc_cookie; 995c8ec8eeaSjose borrego uint16_t dc_dattr; 996c8ec8eeaSjose borrego char dc_name[MAXNAMELEN]; /* Real 'Xxxx.yyy.xx' */ 997c8ec8eeaSjose borrego char dc_name83[SMB_SHORTNAMELEN]; /* w/ dot 'XXXX .XX ' */ 998c8ec8eeaSjose borrego char dc_shortname[SMB_SHORTNAMELEN]; /* w/ dot 'XXXX.XX' */ 999c8ec8eeaSjose borrego smb_attr_t dc_attr; 1000da6c28aaSamw } smb_odir_context_t; 1001da6c28aaSamw 1002da6c28aaSamw #define SMB_LOCK_MAGIC 0x4C4F434B /* 'LOCK' */ 1003da6c28aaSamw 1004da6c28aaSamw typedef struct smb_lock { 1005da6c28aaSamw uint32_t l_magic; 1006da6c28aaSamw kmutex_t l_mutex; 1007da6c28aaSamw list_node_t l_lnd; 1008da6c28aaSamw kcondvar_t l_cv; 1009da6c28aaSamw 1010da6c28aaSamw list_node_t l_conflict_lnd; 1011da6c28aaSamw smb_slist_t l_conflict_list; 1012da6c28aaSamw 1013da6c28aaSamw smb_session_t *l_session; 1014da6c28aaSamw smb_ofile_t *l_file; 1015faa1795aSjb struct smb_request *l_sr; 1016da6c28aaSamw 1017da6c28aaSamw uint32_t l_flags; 1018da6c28aaSamw uint64_t l_session_kid; 1019da6c28aaSamw struct smb_lock *l_blocked_by; /* Debug info only */ 1020da6c28aaSamw 1021da6c28aaSamw uint16_t l_pid; 1022da6c28aaSamw uint16_t l_uid; 1023da6c28aaSamw uint32_t l_type; 1024da6c28aaSamw uint64_t l_start; 1025da6c28aaSamw uint64_t l_length; 1026da6c28aaSamw clock_t l_end_time; 1027da6c28aaSamw } smb_lock_t; 1028da6c28aaSamw 1029da6c28aaSamw #define SMB_LOCK_FLAG_INDEFINITE 0x0004 1030da6c28aaSamw #define SMB_LOCK_INDEFINITE_WAIT(lock) \ 1031da6c28aaSamw ((lock)->l_flags & SMB_LOCK_FLAG_INDEFINITE) 1032da6c28aaSamw 1033da6c28aaSamw #define SMB_LOCK_TYPE_READWRITE 101 1034da6c28aaSamw #define SMB_LOCK_TYPE_READONLY 102 1035da6c28aaSamw 1036faa1795aSjb typedef struct vardata_block { 1037faa1795aSjb uint8_t tag; 1038faa1795aSjb uint16_t len; 1039faa1795aSjb struct uio uio; 1040faa1795aSjb struct iovec iovec[MAX_IOVEC]; 1041faa1795aSjb } smb_vdb_t; 1042faa1795aSjb 1043faa1795aSjb #define SMB_RW_MAGIC 0x52445257 /* 'RDRW' */ 1044faa1795aSjb 1045faa1795aSjb typedef struct smb_rw_param { 1046faa1795aSjb uint32_t rw_magic; 1047faa1795aSjb smb_vdb_t rw_vdb; 1048faa1795aSjb uint64_t rw_offset; 1049faa1795aSjb uint32_t rw_last_write; 1050faa1795aSjb uint16_t rw_mode; 1051faa1795aSjb uint16_t rw_count; 1052faa1795aSjb uint16_t rw_mincnt; 1053faa1795aSjb uint16_t rw_dsoff; /* SMB data offset */ 1054faa1795aSjb uint8_t rw_andx; /* SMB secondary andx command */ 1055faa1795aSjb } smb_rw_param_t; 1056da6c28aaSamw 1057b89a8333Snatalie li - Sun Microsystems - Irvine United States /* 1058b89a8333Snatalie li - Sun Microsystems - Irvine United States * fs_query_info 1059b89a8333Snatalie li - Sun Microsystems - Irvine United States */ 1060b89a8333Snatalie li - Sun Microsystems - Irvine United States typedef struct smb_fqi { 1061b89a8333Snatalie li - Sun Microsystems - Irvine United States char *path; 1062b89a8333Snatalie li - Sun Microsystems - Irvine United States uint16_t srch_attr; 1063b89a8333Snatalie li - Sun Microsystems - Irvine United States smb_node_t *dir_snode; 1064b89a8333Snatalie li - Sun Microsystems - Irvine United States smb_attr_t dir_attr; 1065b89a8333Snatalie li - Sun Microsystems - Irvine United States char last_comp[MAXNAMELEN]; 1066b89a8333Snatalie li - Sun Microsystems - Irvine United States int last_comp_was_found; 1067b89a8333Snatalie li - Sun Microsystems - Irvine United States char last_comp_od[MAXNAMELEN]; 1068b89a8333Snatalie li - Sun Microsystems - Irvine United States smb_node_t *last_snode; 1069b89a8333Snatalie li - Sun Microsystems - Irvine United States smb_attr_t last_attr; 1070b89a8333Snatalie li - Sun Microsystems - Irvine United States } smb_fqi_t; 1071da6c28aaSamw 1072da6c28aaSamw #define SMB_NULL_FQI_NODES(fqi) \ 1073da6c28aaSamw (fqi).last_snode = NULL; \ 1074da6c28aaSamw (fqi).dir_snode = NULL; 1075da6c28aaSamw 1076da6c28aaSamw #define FQM_DIR_MUST_EXIST 1 1077da6c28aaSamw #define FQM_PATH_MUST_EXIST 2 1078da6c28aaSamw #define FQM_PATH_MUST_NOT_EXIST 3 1079da6c28aaSamw 1080da6c28aaSamw #define MYF_OPLOCK_MASK 0x000000F0 1081da6c28aaSamw #define MYF_OPLOCK_NONE 0x00000000 1082da6c28aaSamw #define MYF_EXCLUSIVE_OPLOCK 0x00000010 1083da6c28aaSamw #define MYF_BATCH_OPLOCK 0x00000020 1084da6c28aaSamw #define MYF_LEVEL_II_OPLOCK 0x00000030 1085da6c28aaSamw #define MYF_MUST_BE_DIRECTORY 0x00000100 1086da6c28aaSamw 1087da6c28aaSamw #define MYF_OPLOCK_TYPE(o) ((o) & MYF_OPLOCK_MASK) 1088da6c28aaSamw #define MYF_OPLOCKS_REQUEST(o) (MYF_OPLOCK_TYPE(o) != MYF_OPLOCK_NONE) 1089da6c28aaSamw #define MYF_IS_EXCLUSIVE_OPLOCK(o) (MYF_OPLOCK_TYPE(o) == MYF_EXCLUSIVE_OPLOCK) 1090da6c28aaSamw #define MYF_IS_BATCH_OPLOCK(o) (MYF_OPLOCK_TYPE(o) == MYF_BATCH_OPLOCK) 1091da6c28aaSamw #define MYF_IS_LEVEL_II_OPLOCK(o) (MYF_OPLOCK_TYPE(o) == MYF_LEVEL_II_OPLOCK) 1092da6c28aaSamw 1093da6c28aaSamw #define OPLOCK_MIN_TIMEOUT (5 * 1000) 1094da6c28aaSamw #define OPLOCK_STD_TIMEOUT (15 * 1000) 1095faa1795aSjb #define OPLOCK_RETRIES 2 1096da6c28aaSamw 10977b59d02dSjb typedef struct { 10987b59d02dSjb uint32_t severity; 10997b59d02dSjb uint32_t status; 11007b59d02dSjb uint16_t errcls; 11017b59d02dSjb uint16_t errcode; 11027b59d02dSjb } smb_error_t; 1103da6c28aaSamw 1104da6c28aaSamw /* 1105da6c28aaSamw * SMB Request State Machine 1106da6c28aaSamw * ------------------------- 1107da6c28aaSamw * 1108da6c28aaSamw * T4 +------+ T0 1109da6c28aaSamw * +--------------------------->| FREE |---------------------------+ 1110da6c28aaSamw * | +------+ | 1111da6c28aaSamw * +-----------+ | 1112da6c28aaSamw * | COMPLETED | | 1113da6c28aaSamw * +-----------+ 1114da6c28aaSamw * ^ | 1115da6c28aaSamw * | T15 +----------+ v 1116da6c28aaSamw * +------------+ T6 | | +--------------+ 1117da6c28aaSamw * | CLEANED_UP |<-----------------| CANCELED | | INITIALIZING | 1118da6c28aaSamw * +------------+ | | +--------------+ 1119da6c28aaSamw * | ^ +----------+ | 1120da6c28aaSamw * | | ^ ^ ^ ^ | 1121da6c28aaSamw * | | +-------------+ | | | | 1122da6c28aaSamw * | | T3 | | | | T13 | T1 1123da6c28aaSamw * | +-------------------------+ | | +----------------------+ | 1124da6c28aaSamw * +----------------------------+ | | | | | 1125da6c28aaSamw * T16 | | | | +-----------+ | | 1126da6c28aaSamw * | \/ | | T5 | | v 1127da6c28aaSamw * +-----------------+ | T12 +--------+ | T2 +-----------+ 1128da6c28aaSamw * | EVENT_OCCURRED |------------->| ACTIVE |<--------------------| SUBMITTED | 1129da6c28aaSamw * +-----------------+ | +--------+ | +-----------+ 1130da6c28aaSamw * ^ | | ^ | | 1131da6c28aaSamw * | | T8 | | | T7 | 1132da6c28aaSamw * | T10 T9 | +----------+ | +-------+ | T11 1133da6c28aaSamw * | | | +-------+ | | 1134da6c28aaSamw * | | | T14 | | | 1135da6c28aaSamw * | | v | v | 1136da6c28aaSamw * +----------------------+ +--------------+ 1137da6c28aaSamw * | WAITING_EVENT | | WAITING_LOCK | 1138da6c28aaSamw * +----------------------+ +--------------+ 1139da6c28aaSamw * 1140da6c28aaSamw * 1141da6c28aaSamw * 1142da6c28aaSamw * 1143da6c28aaSamw * 1144da6c28aaSamw * Transition T0 1145da6c28aaSamw * 1146da6c28aaSamw * This transition occurs when the request is allocated and is still under the 1147da6c28aaSamw * control of the session thread. 1148da6c28aaSamw * 1149da6c28aaSamw * Transition T1 1150da6c28aaSamw * 1151da6c28aaSamw * This transition occurs when the session thread dispatches a task to treat the 1152da6c28aaSamw * request. 1153da6c28aaSamw * 1154da6c28aaSamw * Transition T2 1155da6c28aaSamw * 1156da6c28aaSamw * 1157da6c28aaSamw * 1158da6c28aaSamw * Transition T3 1159da6c28aaSamw * 1160da6c28aaSamw * A request completes and smbsr_cleanup is called to release resources 1161da6c28aaSamw * associated with the request (but not the smb_request_t itself). This 1162da6c28aaSamw * includes references on smb_ofile_t, smb_node_t, and other structures. 1163da6c28aaSamw * CLEANED_UP state exists to detect if we attempt to cleanup a request 1164da6c28aaSamw * multiple times and to allow us to detect that we are accessing a 1165da6c28aaSamw * request that has already been cleaned up. 1166da6c28aaSamw * 1167da6c28aaSamw * Transition T4 1168da6c28aaSamw * 1169da6c28aaSamw * 1170da6c28aaSamw * 1171da6c28aaSamw * Transition T5 1172da6c28aaSamw * 1173da6c28aaSamw * 1174da6c28aaSamw * 1175da6c28aaSamw * Transition T6 1176da6c28aaSamw * 1177da6c28aaSamw * 1178da6c28aaSamw * 1179da6c28aaSamw * Transition T7 1180da6c28aaSamw * 1181da6c28aaSamw * 1182da6c28aaSamw * 1183da6c28aaSamw * Transition T8 1184da6c28aaSamw * 1185da6c28aaSamw * 1186da6c28aaSamw * 1187da6c28aaSamw * Transition T9 1188da6c28aaSamw * 1189da6c28aaSamw * 1190da6c28aaSamw * 1191da6c28aaSamw * Transition T10 1192da6c28aaSamw * 1193da6c28aaSamw * 1194da6c28aaSamw * 1195da6c28aaSamw * Transition T11 1196da6c28aaSamw * 1197da6c28aaSamw * 1198da6c28aaSamw * 1199da6c28aaSamw * Transition T12 1200da6c28aaSamw * 1201da6c28aaSamw * 1202da6c28aaSamw * 1203da6c28aaSamw * Transition T13 1204da6c28aaSamw * 1205da6c28aaSamw * 1206da6c28aaSamw * 1207da6c28aaSamw * Transition T14 1208da6c28aaSamw * 1209da6c28aaSamw * 1210da6c28aaSamw * 1211da6c28aaSamw * Transition T15 1212da6c28aaSamw * 1213da6c28aaSamw * Request processing is completed (control returns from smb_dispatch) 1214da6c28aaSamw * 1215da6c28aaSamw * Transition T16 1216da6c28aaSamw * 1217da6c28aaSamw * Multipart (andx) request was cleaned up with smbsr_cleanup but more "andx" 1218da6c28aaSamw * sections remain to be processed. 1219da6c28aaSamw * 1220da6c28aaSamw */ 1221da6c28aaSamw 1222da6c28aaSamw #define SMB_REQ_MAGIC 0x534D4252 /* 'SMBR' */ 1223da6c28aaSamw 1224da6c28aaSamw typedef enum smb_req_state { 1225da6c28aaSamw SMB_REQ_STATE_FREE = 0, 1226da6c28aaSamw SMB_REQ_STATE_INITIALIZING, 1227da6c28aaSamw SMB_REQ_STATE_SUBMITTED, 1228da6c28aaSamw SMB_REQ_STATE_ACTIVE, 1229da6c28aaSamw SMB_REQ_STATE_WAITING_EVENT, 1230da6c28aaSamw SMB_REQ_STATE_EVENT_OCCURRED, 1231da6c28aaSamw SMB_REQ_STATE_WAITING_LOCK, 1232da6c28aaSamw SMB_REQ_STATE_COMPLETED, 1233da6c28aaSamw SMB_REQ_STATE_CANCELED, 12346537f381Sas SMB_REQ_STATE_CLEANED_UP, 12356537f381Sas SMB_REQ_STATE_SENTINEL 1236da6c28aaSamw } smb_req_state_t; 1237da6c28aaSamw 1238faa1795aSjb typedef struct smb_request { 1239da6c28aaSamw uint32_t sr_magic; 1240da6c28aaSamw kmutex_t sr_mutex; 1241da6c28aaSamw list_node_t sr_session_lnd; 1242da6c28aaSamw smb_req_state_t sr_state; 1243da6c28aaSamw boolean_t sr_keep; 1244faa1795aSjb kmem_cache_t *sr_cache; 1245faa1795aSjb struct smb_server *sr_server; 12466537f381Sas pid_t *sr_pid; 1247c8ec8eeaSjose borrego int32_t sr_gmtoff; 1248faa1795aSjb smb_session_t *session; 1249faa1795aSjb smb_kmod_cfg_t *sr_cfg; 1250da6c28aaSamw smb_notify_change_req_t sr_ncr; 1251da6c28aaSamw 1252da6c28aaSamw /* Info from session service header */ 1253da6c28aaSamw uint32_t sr_req_length; /* Excluding NBT header */ 1254da6c28aaSamw 1255da6c28aaSamw /* Request buffer excluding NBT header */ 1256da6c28aaSamw void *sr_request_buf; 1257da6c28aaSamw 1258da6c28aaSamw /* Fields for raw writes */ 1259da6c28aaSamw uint32_t sr_raw_data_length; 1260da6c28aaSamw void *sr_raw_data_buf; 1261da6c28aaSamw 1262da6c28aaSamw smb_lock_t *sr_awaiting; 1263da6c28aaSamw struct mbuf_chain command; 1264da6c28aaSamw struct mbuf_chain reply; 1265da6c28aaSamw struct mbuf_chain raw_data; 1266da6c28aaSamw smb_malloc_list request_storage; 1267da6c28aaSamw struct smb_xa *r_xa; 1268da6c28aaSamw int andx_prev_wct; 1269da6c28aaSamw int cur_reply_offset; 1270da6c28aaSamw int orig_request_hdr; 1271da6c28aaSamw unsigned int reply_seqnum; /* reply sequence number */ 1272da6c28aaSamw unsigned char first_smb_com; /* command code */ 1273da6c28aaSamw unsigned char smb_com; /* command code */ 12747b59d02dSjb 12757b59d02dSjb uint8_t smb_rcls; /* error code class */ 12767b59d02dSjb uint8_t smb_reh; /* rsvd (AH DOS INT-24 ERR) */ 1277da6c28aaSamw uint16_t smb_err; /* error code */ 12787b59d02dSjb smb_error_t smb_error; 12797b59d02dSjb 1280da6c28aaSamw uint8_t smb_flg; /* flags */ 1281da6c28aaSamw uint16_t smb_flg2; /* flags */ 1282da6c28aaSamw uint16_t smb_pid_high; /* high part of pid */ 1283da6c28aaSamw unsigned char smb_sig[8]; /* signiture */ 1284da6c28aaSamw uint16_t smb_tid; /* tree id # */ 1285da6c28aaSamw uint16_t smb_pid; /* caller's process id # */ 1286da6c28aaSamw uint16_t smb_uid; /* user id # */ 1287da6c28aaSamw uint16_t smb_mid; /* mutiplex id # */ 1288da6c28aaSamw unsigned char smb_wct; /* count of parameter words */ 1289da6c28aaSamw uint16_t smb_bcc; /* data byte count */ 1290da6c28aaSamw 1291da6c28aaSamw /* Parameters */ 1292da6c28aaSamw struct mbuf_chain smb_vwv; /* variable width value */ 1293da6c28aaSamw 1294da6c28aaSamw /* Data */ 1295da6c28aaSamw struct mbuf_chain smb_data; 1296da6c28aaSamw 1297da6c28aaSamw uint16_t smb_fid; /* not in hdr, but common */ 1298da6c28aaSamw uint16_t smb_sid; /* not in hdr, but common */ 1299da6c28aaSamw 1300da6c28aaSamw unsigned char andx_com; 1301da6c28aaSamw uint16_t andx_off; 1302da6c28aaSamw 1303da6c28aaSamw struct smb_tree *tid_tree; 1304da6c28aaSamw struct smb_ofile *fid_ofile; 1305da6c28aaSamw struct smb_odir *sid_odir; 1306da6c28aaSamw smb_user_t *uid_user; 1307da6c28aaSamw 1308da6c28aaSamw union { 1309faa1795aSjb struct tcon { 1310da6c28aaSamw char *path; 1311da6c28aaSamw char *service; 1312da6c28aaSamw int pwdlen; 1313da6c28aaSamw char *password; 1314da6c28aaSamw uint16_t flags; 13158d7e4166Sjose borrego uint16_t optional_support; 1316da6c28aaSamw } tcon; 1317da6c28aaSamw 1318da6c28aaSamw struct open_param { 1319b89a8333Snatalie li - Sun Microsystems - Irvine United States smb_fqi_t fqi; 1320da6c28aaSamw uint16_t omode; 1321da6c28aaSamw uint16_t oflags; 1322da6c28aaSamw uint16_t ofun; 1323da6c28aaSamw uint32_t my_flags; 1324da6c28aaSamw uint32_t timeo; 1325da6c28aaSamw uint32_t dattr; 13268c10a865Sas timestruc_t crtime; 13272c1b14e5Sjose borrego timestruc_t mtime; 1328da6c28aaSamw uint64_t dsize; 1329da6c28aaSamw uint32_t desired_access; 1330da6c28aaSamw uint32_t share_access; 1331da6c28aaSamw uint32_t create_options; 1332da6c28aaSamw uint32_t create_disposition; 1333c8ec8eeaSjose borrego boolean_t created_readonly; 1334da6c28aaSamw uint32_t ftype, devstate; 1335da6c28aaSamw uint32_t action_taken; 1336da6c28aaSamw uint64_t fileid; 1337faa1795aSjb uint32_t rootdirfid; 1338da6c28aaSamw /* This is only set by NTTransactCreate */ 13396537f381Sas struct smb_sd *sd; 1340da6c28aaSamw } open; 1341da6c28aaSamw 1342faa1795aSjb struct dirop { 1343b89a8333Snatalie li - Sun Microsystems - Irvine United States smb_fqi_t fqi; 1344b89a8333Snatalie li - Sun Microsystems - Irvine United States smb_fqi_t dst_fqi; 1345da6c28aaSamw } dirop; 1346da6c28aaSamw 1347faa1795aSjb smb_rw_param_t *rw; 1348faa1795aSjb uint32_t timestamp; 1349da6c28aaSamw } arg; 1350da6c28aaSamw 1351da6c28aaSamw cred_t *user_cr; 1352faa1795aSjb } smb_request_t; 1353da6c28aaSamw 1354da6c28aaSamw #define SMB_READ_PROTOCOL(smb_nh_ptr) \ 1355da6c28aaSamw LE_IN32(((smb_nethdr_t *)(smb_nh_ptr))->sh_protocol) 1356da6c28aaSamw 1357da6c28aaSamw #define SMB_PROTOCOL_MAGIC_INVALID(rd_sr) \ 1358da6c28aaSamw (SMB_READ_PROTOCOL((rd_sr)->sr_request_buf) != SMB_PROTOCOL_MAGIC) 1359da6c28aaSamw 1360da6c28aaSamw #define SMB_READ_COMMAND(smb_nh_ptr) \ 1361da6c28aaSamw (((smb_nethdr_t *)(smb_nh_ptr))->sh_command) 1362da6c28aaSamw 1363da6c28aaSamw #define SMB_IS_WRITERAW(rd_sr) \ 1364da6c28aaSamw (SMB_READ_COMMAND((rd_sr)->sr_request_buf) == SMB_COM_WRITE_RAW) 1365da6c28aaSamw 1366da6c28aaSamw 1367da6c28aaSamw #define SR_FLG_OFFSET 9 1368da6c28aaSamw 1369da6c28aaSamw #define MAX_TRANS_NAME 64 1370da6c28aaSamw 1371da6c28aaSamw #define SMB_XA_FLAG_OPEN 0x0001 1372da6c28aaSamw #define SMB_XA_FLAG_CLOSE 0x0002 1373da6c28aaSamw #define SMB_XA_FLAG_COMPLETE 0x0004 1374da6c28aaSamw #define SMB_XA_CLOSED(xa) (!((xa)->xa_flags & SMB_XA_FLAG_OPEN)) 1375da6c28aaSamw 1376da6c28aaSamw #define SMB_XA_MAGIC 0x534D4258 /* 'SMBX' */ 1377da6c28aaSamw 1378da6c28aaSamw typedef struct smb_xa { 1379da6c28aaSamw uint32_t xa_magic; 1380da6c28aaSamw kmutex_t xa_mutex; 1381da6c28aaSamw list_node_t xa_lnd; 1382da6c28aaSamw 1383da6c28aaSamw uint32_t xa_refcnt; 1384da6c28aaSamw uint32_t xa_flags; 1385da6c28aaSamw 1386da6c28aaSamw struct smb_session *xa_session; 1387da6c28aaSamw 1388da6c28aaSamw unsigned char smb_com; /* which TRANS type */ 1389da6c28aaSamw unsigned char smb_flg; /* flags */ 1390da6c28aaSamw uint16_t smb_flg2; /* flags */ 1391da6c28aaSamw uint16_t smb_tid; /* tree id number */ 1392da6c28aaSamw uint16_t smb_pid; /* caller's process id number */ 1393da6c28aaSamw uint16_t smb_uid; /* user id number */ 1394da6c28aaSamw uint32_t smb_func; /* NT_TRANS function */ 1395da6c28aaSamw 1396da6c28aaSamw uint16_t xa_smb_mid; /* mutiplex id number */ 1397da6c28aaSamw uint16_t xa_smb_fid; /* TRANS2 secondary */ 1398da6c28aaSamw 1399da6c28aaSamw unsigned int reply_seqnum; /* reply sequence number */ 1400da6c28aaSamw 1401da6c28aaSamw uint32_t smb_tpscnt; /* total parameter bytes being sent */ 1402da6c28aaSamw uint32_t smb_tdscnt; /* total data bytes being sent */ 1403da6c28aaSamw uint32_t smb_mprcnt; /* max parameter bytes to return */ 1404da6c28aaSamw uint32_t smb_mdrcnt; /* max data bytes to return */ 1405da6c28aaSamw uint32_t smb_msrcnt; /* max setup words to return */ 1406da6c28aaSamw uint32_t smb_flags; /* additional information: */ 1407da6c28aaSamw /* bit 0 - if set, disconnect TID in smb_tid */ 1408da6c28aaSamw /* bit 1 - if set, transaction is one way */ 1409da6c28aaSamw /* (no final response) */ 1410da6c28aaSamw int32_t smb_timeout; /* number of milliseconds to await completion */ 1411da6c28aaSamw uint32_t smb_suwcnt; /* set up word count */ 1412da6c28aaSamw 1413da6c28aaSamw 1414da6c28aaSamw char *xa_smb_trans_name; 1415da6c28aaSamw 1416da6c28aaSamw int req_disp_param; 1417da6c28aaSamw int req_disp_data; 1418da6c28aaSamw 1419da6c28aaSamw struct mbuf_chain req_setup_mb; 1420da6c28aaSamw struct mbuf_chain req_param_mb; 1421da6c28aaSamw struct mbuf_chain req_data_mb; 1422da6c28aaSamw 1423da6c28aaSamw struct mbuf_chain rep_setup_mb; 1424da6c28aaSamw struct mbuf_chain rep_param_mb; 1425da6c28aaSamw struct mbuf_chain rep_data_mb; 1426da6c28aaSamw } smb_xa_t; 1427da6c28aaSamw 1428da6c28aaSamw 1429da6c28aaSamw #define SDDF_NO_FLAGS 0 1430da6c28aaSamw #define SDDF_SUPPRESS_TID 0x0001 1431da6c28aaSamw #define SDDF_SUPPRESS_UID 0x0002 1432da6c28aaSamw 14337b59d02dSjb /* 14347b59d02dSjb * SMB dispatch return codes. 14357b59d02dSjb */ 14367b59d02dSjb typedef enum { 1437faa1795aSjb SDRC_SUCCESS = 0, 1438faa1795aSjb SDRC_ERROR, 14397b59d02dSjb SDRC_DROP_VC, 14407b59d02dSjb SDRC_NO_REPLY, 144159229f98Sjose borrego SDRC_SR_KEPT, 1442faa1795aSjb SDRC_NOT_IMPLEMENTED 14437b59d02dSjb } smb_sdrc_t; 1444da6c28aaSamw 1445da6c28aaSamw #define VAR_BCC ((short)-1) 1446da6c28aaSamw 1447faa1795aSjb #define SMB_SERVER_MAGIC 0x53534552 /* 'SSER' */ 1448da6c28aaSamw 1449faa1795aSjb typedef struct { 1450faa1795aSjb kstat_named_t open_files; 1451faa1795aSjb kstat_named_t open_trees; 1452faa1795aSjb kstat_named_t open_users; 1453faa1795aSjb } smb_server_stats_t; 1454da6c28aaSamw 1455faa1795aSjb typedef struct { 1456faa1795aSjb kthread_t *ld_kth; 1457faa1795aSjb kt_did_t ld_ktdid; 1458*0f1702c5SYu Xiangning ksocket_t ld_so; 1459faa1795aSjb struct sockaddr_in ld_sin; 1460faa1795aSjb smb_session_list_t ld_session_list; 1461faa1795aSjb } smb_listener_daemon_t; 1462faa1795aSjb 1463faa1795aSjb typedef enum smb_server_state { 1464faa1795aSjb SMB_SERVER_STATE_CREATED = 0, 1465faa1795aSjb SMB_SERVER_STATE_CONFIGURED, 1466faa1795aSjb SMB_SERVER_STATE_RUNNING, 14676537f381Sas SMB_SERVER_STATE_DELETING, 14686537f381Sas SMB_SERVER_STATE_SENTINEL 1469faa1795aSjb } smb_server_state_t; 1470faa1795aSjb 1471faa1795aSjb typedef struct smb_server { 1472faa1795aSjb uint32_t sv_magic; 1473faa1795aSjb kcondvar_t sv_cv; 1474faa1795aSjb kmutex_t sv_mutex; 1475faa1795aSjb list_node_t sv_lnd; 1476faa1795aSjb smb_server_state_t sv_state; 1477faa1795aSjb uint32_t sv_refcnt; 14786537f381Sas pid_t sv_pid; 1479faa1795aSjb zoneid_t sv_zid; 1480faa1795aSjb smb_listener_daemon_t sv_nbt_daemon; 1481faa1795aSjb smb_listener_daemon_t sv_tcp_daemon; 1482faa1795aSjb krwlock_t sv_cfg_lock; 1483faa1795aSjb smb_kmod_cfg_t sv_cfg; 1484faa1795aSjb smb_session_t *sv_session; 1485da6c28aaSamw 1486faa1795aSjb kstat_t *sv_ksp; 1487faa1795aSjb kmutex_t sv_ksp_mutex; 1488faa1795aSjb char sv_ksp_name[KSTAT_STRLEN]; 1489faa1795aSjb smb_server_stats_t sv_ks_data; 1490da6c28aaSamw 1491faa1795aSjb door_handle_t sv_lmshrd; 1492da6c28aaSamw 1493c8ec8eeaSjose borrego int32_t si_gmtoff; 1494da6c28aaSamw 1495da6c28aaSamw smb_thread_t si_thread_timers; 14962c1b14e5Sjose borrego smb_thread_t si_thread_unexport; 1497da6c28aaSamw 1498faa1795aSjb taskq_t *sv_thread_pool; 1499da6c28aaSamw 15002c1b14e5Sjose borrego kmem_cache_t *si_cache_unexport; 1501da6c28aaSamw kmem_cache_t *si_cache_vfs; 1502da6c28aaSamw kmem_cache_t *si_cache_request; 1503da6c28aaSamw kmem_cache_t *si_cache_session; 1504da6c28aaSamw kmem_cache_t *si_cache_user; 1505da6c28aaSamw kmem_cache_t *si_cache_tree; 1506da6c28aaSamw kmem_cache_t *si_cache_ofile; 1507da6c28aaSamw kmem_cache_t *si_cache_odir; 1508da6c28aaSamw kmem_cache_t *si_cache_node; 1509da6c28aaSamw 1510faa1795aSjb volatile uint32_t sv_open_trees; 1511faa1795aSjb volatile uint32_t sv_open_files; 1512faa1795aSjb volatile uint32_t sv_open_users; 1513da6c28aaSamw 1514da6c28aaSamw smb_node_t *si_root_smb_node; 1515faa1795aSjb smb_llist_t sv_vfs_list; 15162c1b14e5Sjose borrego smb_slist_t sv_unexport_list; 1517faa1795aSjb } smb_server_t; 1518da6c28aaSamw 1519da6c28aaSamw #define SMB_INFO_NETBIOS_SESSION_SVC_RUNNING 0x0001 1520da6c28aaSamw #define SMB_INFO_NETBIOS_SESSION_SVC_FAILED 0x0002 1521da6c28aaSamw #define SMB_INFO_USER_LEVEL_SECURITY 0x40000000 1522da6c28aaSamw #define SMB_INFO_ENCRYPT_PASSWORDS 0x80000000 1523da6c28aaSamw 1524faa1795aSjb #define SMB_NEW_KID() atomic_inc_64_nv(&smb_kids) 1525faa1795aSjb #define SMB_UNIQ_FID() atomic_inc_32_nv(&smb_fids) 1526da6c28aaSamw 1527da6c28aaSamw /* 1528da6c28aaSamw * This is to be used by Trans2SetFileInfo 1529da6c28aaSamw * and Trans2SetPathInfo 1530da6c28aaSamw */ 1531da6c28aaSamw typedef struct smb_trans2_setinfo { 1532da6c28aaSamw uint16_t level; 1533da6c28aaSamw struct smb_xa *ts_xa; 1534da6c28aaSamw struct smb_node *node; 1535da6c28aaSamw char *path; 1536da6c28aaSamw char name[MAXNAMELEN]; 1537da6c28aaSamw } smb_trans2_setinfo_t; 1538da6c28aaSamw 1539da6c28aaSamw #define SMB_IS_STREAM(node) ((node)->unnamed_stream_node) 1540da6c28aaSamw 1541da6c28aaSamw #ifdef DEBUG 1542da6c28aaSamw extern uint_t smb_tsd_key; 1543da6c28aaSamw #endif 1544da6c28aaSamw 1545da6c28aaSamw typedef struct smb_tsd { 1546da6c28aaSamw void (*proc)(); 1547da6c28aaSamw void *arg; 1548da6c28aaSamw char name[100]; 1549da6c28aaSamw } smb_tsd_t; 1550da6c28aaSamw 1551da6c28aaSamw #define SMB_INVALID_AMASK -1 1552da6c28aaSamw #define SMB_INVALID_SHAREMODE -1 1553da6c28aaSamw #define SMB_INVALID_CRDISPOSITION -1 1554da6c28aaSamw 1555da6c28aaSamw typedef struct smb_dispatch_table { 1556faa1795aSjb smb_sdrc_t (*sdt_pre_op)(smb_request_t *); 1557faa1795aSjb smb_sdrc_t (*sdt_function)(smb_request_t *); 1558faa1795aSjb void (*sdt_post_op)(smb_request_t *); 1559da6c28aaSamw char sdt_dialect; 1560da6c28aaSamw unsigned char sdt_flags; 1561da6c28aaSamw krw_t sdt_slock_mode; 1562da6c28aaSamw kstat_named_t sdt_dispatch_stats; /* invocations */ 1563da6c28aaSamw } smb_dispatch_table_t; 1564da6c28aaSamw 156555bf511dSas /* 156655bf511dSas * Discretionary Access Control List (DACL) 156755bf511dSas * 156855bf511dSas * A Discretionary Access Control List (DACL), often abbreviated to 156955bf511dSas * ACL, is a list of access controls which either allow or deny access 157055bf511dSas * for users or groups to a resource. There is a list header followed 157155bf511dSas * by a list of access control entries (ACE). Each ACE specifies the 157255bf511dSas * access allowed or denied to a single user or group (identified by 157355bf511dSas * a SID). 157455bf511dSas * 157555bf511dSas * There is another access control list object called a System Access 157655bf511dSas * Control List (SACL), which is used to control auditing, but no 157755bf511dSas * support is provideed for SACLs at this time. 157855bf511dSas * 157955bf511dSas * ACL header format: 158055bf511dSas * 158155bf511dSas * 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 158255bf511dSas * 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 158355bf511dSas * +-------------------------------+---------------+---------------+ 158455bf511dSas * | AclSize | Sbz1 | AclRevision | 158555bf511dSas * +-------------------------------+---------------+---------------+ 158655bf511dSas * | Sbz2 | AceCount | 158755bf511dSas * +-------------------------------+-------------------------------+ 158855bf511dSas * 158955bf511dSas * AclRevision specifies the revision level of the ACL. This value should 159055bf511dSas * be ACL_REVISION, unless the ACL contains an object-specific ACE, in which 159155bf511dSas * case this value must be ACL_REVISION_DS. All ACEs in an ACL must be at the 159255bf511dSas * same revision level. 159355bf511dSas * 159455bf511dSas * ACE header format: 159555bf511dSas * 159655bf511dSas * 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 159755bf511dSas * 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 159855bf511dSas * +---------------+-------+-------+---------------+---------------+ 159955bf511dSas * | AceSize | AceFlags | AceType | 160055bf511dSas * +---------------+-------+-------+---------------+---------------+ 160155bf511dSas * 160255bf511dSas * Access mask format: 160355bf511dSas * 160455bf511dSas * 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 160555bf511dSas * 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 160655bf511dSas * +---------------+---------------+-------------------------------+ 160755bf511dSas * |G|G|G|G|Res'd|A| StandardRights| SpecificRights | 160855bf511dSas * |R|W|E|A| |S| | | 160955bf511dSas * +-+-------------+---------------+-------------------------------+ 161055bf511dSas * 161155bf511dSas * typedef struct ACCESS_MASK { 161255bf511dSas * WORD SpecificRights; 161355bf511dSas * BYTE StandardRights; 161455bf511dSas * BYTE AccessSystemAcl : 1; 161555bf511dSas * BYTE Reserved : 3; 161655bf511dSas * BYTE GenericAll : 1; 161755bf511dSas * BYTE GenericExecute : 1; 161855bf511dSas * BYTE GenericWrite : 1; 161955bf511dSas * BYTE GenericRead : 1; 162055bf511dSas * } ACCESS_MASK; 162155bf511dSas * 162255bf511dSas */ 162355bf511dSas 162455bf511dSas #define ACL_REVISION1 1 162555bf511dSas #define ACL_REVISION2 2 162655bf511dSas #define MIN_ACL_REVISION2 ACL_REVISION2 162755bf511dSas #define ACL_REVISION3 3 162855bf511dSas #define ACL_REVISION4 4 162955bf511dSas #define MAX_ACL_REVISION ACL_REVISION4 163055bf511dSas 163155bf511dSas /* 163255bf511dSas * Current ACE and ACL revision Levels 163355bf511dSas */ 163455bf511dSas #define ACE_REVISION 1 163555bf511dSas #define ACL_REVISION ACL_REVISION2 163655bf511dSas #define ACL_REVISION_DS ACL_REVISION4 163755bf511dSas 163855bf511dSas 163955bf511dSas #define ACCESS_ALLOWED_ACE_TYPE 0 164055bf511dSas #define ACCESS_DENIED_ACE_TYPE 1 164155bf511dSas #define SYSTEM_AUDIT_ACE_TYPE 2 164255bf511dSas #define SYSTEM_ALARM_ACE_TYPE 3 164355bf511dSas 164455bf511dSas /* 164555bf511dSas * se_flags 164655bf511dSas * ---------- 164755bf511dSas * Specifies a set of ACE type-specific control flags. This member can be a 164855bf511dSas * combination of the following values. 164955bf511dSas * 165055bf511dSas * CONTAINER_INHERIT_ACE: Child objects that are containers, such as 165155bf511dSas * directories, inherit the ACE as an effective ACE. The inherited 165255bf511dSas * ACE is inheritable unless the NO_PROPAGATE_INHERIT_ACE bit flag 165355bf511dSas * is also set. 165455bf511dSas * 165555bf511dSas * INHERIT_ONLY_ACE: Indicates an inherit-only ACE which does not control 165655bf511dSas * access to the object to which it is attached. 165755bf511dSas * If this flag is not set, 165855bf511dSas * the ACE is an effective ACE which controls access to the object 165955bf511dSas * to which it is attached. 166055bf511dSas * Both effective and inherit-only ACEs can be inherited 166155bf511dSas * depending on the state of the other inheritance flags. 166255bf511dSas * 166355bf511dSas * INHERITED_ACE: Windows 2000/XP: Indicates that the ACE was inherited. 166455bf511dSas * The system sets this bit when it propagates an 166555bf511dSas * inherited ACE to a child object. 166655bf511dSas * 166755bf511dSas * NO_PROPAGATE_INHERIT_ACE: If the ACE is inherited by a child object, the 166855bf511dSas * system clears the OBJECT_INHERIT_ACE and CONTAINER_INHERIT_ACE 166955bf511dSas * flags in the inherited ACE. 167055bf511dSas * This prevents the ACE from being inherited by 167155bf511dSas * subsequent generations of objects. 167255bf511dSas * 167355bf511dSas * OBJECT_INHERIT_ACE: Noncontainer child objects inherit the ACE as an 167455bf511dSas * effective ACE. For child objects that are containers, 167555bf511dSas * the ACE is inherited as an inherit-only ACE unless the 167655bf511dSas * NO_PROPAGATE_INHERIT_ACE bit flag is also set. 167755bf511dSas */ 167855bf511dSas #define OBJECT_INHERIT_ACE 0x01 167955bf511dSas #define CONTAINER_INHERIT_ACE 0x02 168055bf511dSas #define NO_PROPOGATE_INHERIT_ACE 0x04 168155bf511dSas #define INHERIT_ONLY_ACE 0x08 168255bf511dSas #define INHERITED_ACE 0x10 168355bf511dSas #define INHERIT_MASK_ACE 0x1F 168455bf511dSas 168555bf511dSas 168655bf511dSas /* 168755bf511dSas * These flags are only used in system audit or alarm ACEs to 168855bf511dSas * indicate when an audit message should be generated, i.e. 168955bf511dSas * on successful access or on unsuccessful access. 169055bf511dSas */ 169155bf511dSas #define SUCCESSFUL_ACCESS_ACE_FLAG 0x40 169255bf511dSas #define FAILED_ACCESS_ACE_FLAG 0x80 169355bf511dSas 169455bf511dSas /* 169555bf511dSas * se_bsize is the size, in bytes, of ACE as it appears on the wire. 169655bf511dSas * se_sln is used to sort the ACL when it's required. 169755bf511dSas */ 169855bf511dSas typedef struct smb_acehdr { 169955bf511dSas uint8_t se_type; 170055bf511dSas uint8_t se_flags; 170155bf511dSas uint16_t se_bsize; 170255bf511dSas } smb_acehdr_t; 170355bf511dSas 170455bf511dSas typedef struct smb_ace { 170555bf511dSas smb_acehdr_t se_hdr; 170655bf511dSas uint32_t se_mask; 170755bf511dSas list_node_t se_sln; 17086537f381Sas smb_sid_t *se_sid; 170955bf511dSas } smb_ace_t; 171055bf511dSas 171155bf511dSas /* 171255bf511dSas * sl_bsize is the size of ACL in bytes as it appears on the wire. 171355bf511dSas */ 171455bf511dSas typedef struct smb_acl { 171555bf511dSas uint8_t sl_revision; 171655bf511dSas uint16_t sl_bsize; 171755bf511dSas uint16_t sl_acecnt; 171855bf511dSas smb_ace_t *sl_aces; 171955bf511dSas list_t sl_sorted; 172055bf511dSas } smb_acl_t; 172155bf511dSas 172255bf511dSas /* 172355bf511dSas * ACE/ACL header size, in byte, as it appears on the wire 172455bf511dSas */ 172555bf511dSas #define SMB_ACE_HDRSIZE 4 172655bf511dSas #define SMB_ACL_HDRSIZE 8 172755bf511dSas 172855bf511dSas /* 172955bf511dSas * Security Descriptor (SD) 173055bf511dSas * 173155bf511dSas * Security descriptors provide protection for objects, for example 173255bf511dSas * files and directories. It identifies the owner and primary group 173355bf511dSas * (SIDs) and contains an access control list. When a user tries to 173455bf511dSas * access an object his SID is compared to the permissions in the 173555bf511dSas * DACL to determine if access should be allowed or denied. Note that 173655bf511dSas * this is a simplification because there are other factors, such as 173755bf511dSas * default behavior and privileges to be taken into account (see also 173855bf511dSas * access tokens). 173955bf511dSas * 174055bf511dSas * The boolean flags have the following meanings when set: 174155bf511dSas * 174255bf511dSas * SE_OWNER_DEFAULTED indicates that the SID pointed to by the Owner 174355bf511dSas * field was provided by a defaulting mechanism rather than explicitly 174455bf511dSas * provided by the original provider of the security descriptor. This 174555bf511dSas * may affect the treatment of the SID with respect to inheritance of 174655bf511dSas * an owner. 174755bf511dSas * 174855bf511dSas * SE_GROUP_DEFAULTED indicates that the SID in the Group field was 174955bf511dSas * provided by a defaulting mechanism rather than explicitly provided 175055bf511dSas * by the original provider of the security descriptor. This may 175155bf511dSas * affect the treatment of the SID with respect to inheritance of a 175255bf511dSas * primary group. 175355bf511dSas * 175455bf511dSas * SE_DACL_PRESENT indicates that the security descriptor contains a 175555bf511dSas * discretionary ACL. If this flag is set and the Dacl field of the 175655bf511dSas * SECURITY_DESCRIPTOR is null, then a null ACL is explicitly being 175755bf511dSas * specified. 175855bf511dSas * 175955bf511dSas * SE_DACL_DEFAULTED indicates that the ACL pointed to by the Dacl 176055bf511dSas * field was provided by a defaulting mechanism rather than explicitly 176155bf511dSas * provided by the original provider of the security descriptor. This 176255bf511dSas * may affect the treatment of the ACL with respect to inheritance of 176355bf511dSas * an ACL. This flag is ignored if the DaclPresent flag is not set. 176455bf511dSas * 176555bf511dSas * SE_SACL_PRESENT indicates that the security descriptor contains a 176655bf511dSas * system ACL pointed to by the Sacl field. If this flag is set and 176755bf511dSas * the Sacl field of the SECURITY_DESCRIPTOR is null, then an empty 176855bf511dSas * (but present) ACL is being specified. 176955bf511dSas * 177055bf511dSas * SE_SACL_DEFAULTED indicates that the ACL pointed to by the Sacl 177155bf511dSas * field was provided by a defaulting mechanism rather than explicitly 177255bf511dSas * provided by the original provider of the security descriptor. This 177355bf511dSas * may affect the treatment of the ACL with respect to inheritance of 177455bf511dSas * an ACL. This flag is ignored if the SaclPresent flag is not set. 177555bf511dSas * 177655bf511dSas * SE_DACL_PROTECTED Prevents ACEs set on the DACL of the parent container 177755bf511dSas * (and any objects above the parent container in the directory hierarchy) 177855bf511dSas * from being applied to the object's DACL. 177955bf511dSas * 178055bf511dSas * SE_SACL_PROTECTED Prevents ACEs set on the SACL of the parent container 178155bf511dSas * (and any objects above the parent container in the directory hierarchy) 178255bf511dSas * from being applied to the object's SACL. 178355bf511dSas * 178455bf511dSas * Note that the SE_DACL_PRESENT flag needs to be present to set 178555bf511dSas * SE_DACL_PROTECTED and SE_SACL_PRESENT needs to be present to set 178655bf511dSas * SE_SACL_PROTECTED. 178755bf511dSas * 178855bf511dSas * SE_SELF_RELATIVE indicates that the security descriptor is in self- 178955bf511dSas * relative form. In this form, all fields of the security descriptor 179055bf511dSas * are contiguous in memory and all pointer fields are expressed as 179155bf511dSas * offsets from the beginning of the security descriptor. 179255bf511dSas * 179355bf511dSas * 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1 179455bf511dSas * 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 179555bf511dSas * +---------------------------------------------------------------+ 179655bf511dSas * | Control |Reserved1 (SBZ)| Revision | 179755bf511dSas * +---------------------------------------------------------------+ 179855bf511dSas * | Owner | 179955bf511dSas * +---------------------------------------------------------------+ 180055bf511dSas * | Group | 180155bf511dSas * +---------------------------------------------------------------+ 180255bf511dSas * | Sacl | 180355bf511dSas * +---------------------------------------------------------------+ 180455bf511dSas * | Dacl | 180555bf511dSas * +---------------------------------------------------------------+ 180655bf511dSas * 180755bf511dSas */ 180855bf511dSas 180955bf511dSas #define SMB_OWNER_SECINFO 0x0001 181055bf511dSas #define SMB_GROUP_SECINFO 0x0002 181155bf511dSas #define SMB_DACL_SECINFO 0x0004 181255bf511dSas #define SMB_SACL_SECINFO 0x0008 181355bf511dSas #define SMB_ALL_SECINFO 0x000F 181455bf511dSas #define SMB_ACL_SECINFO (SMB_DACL_SECINFO | SMB_SACL_SECINFO) 181555bf511dSas 181655bf511dSas #define SECURITY_DESCRIPTOR_REVISION 1 181755bf511dSas 181855bf511dSas 181955bf511dSas #define SE_OWNER_DEFAULTED 0x0001 182055bf511dSas #define SE_GROUP_DEFAULTED 0x0002 182155bf511dSas #define SE_DACL_PRESENT 0x0004 182255bf511dSas #define SE_DACL_DEFAULTED 0x0008 182355bf511dSas #define SE_SACL_PRESENT 0x0010 182455bf511dSas #define SE_SACL_DEFAULTED 0x0020 182555bf511dSas #define SE_DACL_AUTO_INHERIT_REQ 0x0100 182655bf511dSas #define SE_SACL_AUTO_INHERIT_REQ 0x0200 182755bf511dSas #define SE_DACL_AUTO_INHERITED 0x0400 182855bf511dSas #define SE_SACL_AUTO_INHERITED 0x0800 182955bf511dSas #define SE_DACL_PROTECTED 0x1000 183055bf511dSas #define SE_SACL_PROTECTED 0x2000 183155bf511dSas #define SE_SELF_RELATIVE 0x8000 183255bf511dSas 183355bf511dSas #define SE_DACL_INHERITANCE_MASK 0x1500 183455bf511dSas #define SE_SACL_INHERITANCE_MASK 0x2A00 183555bf511dSas 183655bf511dSas /* 183755bf511dSas * Security descriptor structures: 183855bf511dSas * 183955bf511dSas * smb_sd_t SD in SMB pointer form 184055bf511dSas * smb_fssd_t SD in filesystem form 184155bf511dSas * 184255bf511dSas * Filesystems (e.g. ZFS/UFS) don't have something equivalent 184355bf511dSas * to SD. The items comprising a SMB SD are kept separately in 184455bf511dSas * filesystem. smb_fssd_t is introduced as a helper to provide 184555bf511dSas * the required abstraction for CIFS code. 184655bf511dSas */ 184755bf511dSas 18486537f381Sas typedef struct smb_sd { 184955bf511dSas uint8_t sd_revision; 185055bf511dSas uint16_t sd_control; 18516537f381Sas smb_sid_t *sd_owner; /* SID file owner */ 18526537f381Sas smb_sid_t *sd_group; /* SID group (for POSIX) */ 185355bf511dSas smb_acl_t *sd_sacl; /* ACL System (audits) */ 185455bf511dSas smb_acl_t *sd_dacl; /* ACL Discretionary (perm) */ 18556537f381Sas } smb_sd_t; 185655bf511dSas 185755bf511dSas /* 185855bf511dSas * SD header size as it appears on the wire 185955bf511dSas */ 186055bf511dSas #define SMB_SD_HDRSIZE 20 186155bf511dSas 186255bf511dSas /* 186355bf511dSas * values for smb_fssd.sd_flags 186455bf511dSas */ 186555bf511dSas #define SMB_FSSD_FLAGS_DIR 0x01 186655bf511dSas 186755bf511dSas typedef struct smb_fssd { 186855bf511dSas uint32_t sd_secinfo; 186955bf511dSas uint32_t sd_flags; 187055bf511dSas uid_t sd_uid; 187155bf511dSas gid_t sd_gid; 187255bf511dSas acl_t *sd_zdacl; 187355bf511dSas acl_t *sd_zsacl; 187455bf511dSas } smb_fssd_t; 187555bf511dSas 1876da6c28aaSamw #ifdef __cplusplus 1877da6c28aaSamw } 1878da6c28aaSamw #endif 1879da6c28aaSamw 1880faa1795aSjb #endif /* _SMBSRV_SMB_KTYPES_H */ 1881