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