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