xref: /illumos-gate/usr/src/uts/common/smbsrv/smb.h (revision 94047d49)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Copyright 2018 Nexenta Systems, Inc.  All rights reserved.
25  */
26 
27 #ifndef _SMBSRV_SMB_H
28 #define	_SMBSRV_SMB_H
29 
30 
31 /*
32  * SMB definitions and interfaces, mostly defined in the SMB and CIFS specs.
33  */
34 #include <sys/types.h>
35 #include <smbsrv/string.h>
36 #include <smbsrv/msgbuf.h>
37 
38 #include <smb/ntstatus.h>
39 #include <smb/nterror.h>
40 #include <smb/lmerr.h>
41 #include <smb/doserror.h>
42 #include <smb/ntaccess.h>
43 
44 /*
45  * Macintosh Extensions for CIFS
46  */
47 #include <smbsrv/mac_cifs.h>
48 
49 /*
50  * NT Installable File System (IFS) interface.
51  */
52 #include <smbsrv/ntifs.h>
53 
54 #ifdef __cplusplus
55 extern "C" {
56 #endif
57 
58 /*
59  * The msgbuf format and length of an SMB header.
60  */
61 #define	SMB_HEADER_DOS_FMT	"Mbbbwbww10.wwww"
62 #define	SMB_HEADER_NT_FMT	"Mblbww#c2.wwww"
63 #define	SMB_HEADER_LEN		32
64 #define	SMB_SIG_SIZE		8	/* SMB signature size */
65 
66 #define	SMB_HEADER_ED_FMT	"Mbbbwbww8c2.wwww"
67 #define	SMB_HEADER_ED_LEN	(4+1+1+1+2+1+2+12+2+2+2+2)
68 #define	SMB_TRANSHDR_ED_FMT	"wwwwb.wl2.wwwwb."
69 #define	SMB_TRANSHDR_ED_LEN	(2+2+2+2+1+1+2+4+2+2+2+2+2+1+1)
70 #define	SMB_TRANSSHDR_ED_FMT	"wwwwwwwww"
71 #define	SMB_TRANSSHDR_ED_LEN	(2+2+2+2+2+2+2+2)
72 #define	SMB_TRANS2SHDR_ED_FMT	"wwwwwwwww"
73 #define	SMB_TRANS2SHDR_ED_LEN	(2+2+2+2+2+2+2+2+2)
74 /* There is something wrong with this. Should be 38 bytes. It is 37 bytes */
75 #define	SMB_NT_TRANSHDR_ED_FMT	"b2.llllllllbw"
76 #define	SMB_NT_TRANSHDR_ED_LEN	(1+2+4+4+4+4+4+4+4+4+1+2)
77 
78 /*
79  * CIFS definition for the SMB header (CIFS Section 3.2). Note that the
80  * pid_high field is not documented in the 1997 CIFS specificaction. This
81  * is a decoded or memory-based definition, which may be padded to align
82  * its elements on word boundaries. See smb_hdrbuf_t for the network
83  * ready structure.
84  */
85 typedef struct smb_hdr {
86 	uint8_t protocol[4];
87 	uint8_t command;
88 
89 	union {
90 		struct {
91 			uint8_t error_class;
92 			uint8_t reserved;
93 			uint16_t error;
94 		} dos_error;
95 		uint32_t ntstatus;
96 	} status;
97 
98 	uint8_t flags;
99 	uint16_t flags2;
100 	uint16_t pid_high;
101 
102 	union {
103 		uint16_t pad[5];
104 		struct {
105 			uint16_t reserved;
106 			uint8_t security_sig[SMB_SIG_SIZE];
107 		} extra;
108 	} extra;
109 
110 	uint16_t tid;
111 	uint16_t pid;
112 	uint16_t uid;
113 	uint16_t mid;
114 } smb_hdr_t;
115 
116 /*
117  * Encoded or packed SMB header in network ready format.
118  */
119 typedef struct smb_hdrbuf {
120 	uint8_t hdr[SMB_HEADER_LEN];
121 } smb_hdrbuf_t;
122 
123 /*
124  * Protocol magic value as a 32-bit.  This will be 0xff 0x53 0x4d 0x42 on
125  * the wire.
126  */
127 
128 #define	SMB_PROTOCOL_MAGIC	0x424d53ff
129 #define	SMB2_PROTOCOL_MAGIC	0x424d53fe
130 
131 /*
132  * Time and date encoding (CIFS Section 3.6). The date is encoded such
133  * that the year has a range of 0-119, which represents 1980-2099. The
134  * month range is 1-12, and the day range is 1-31.
135  */
136 typedef struct smb_date {
137 	uint16_t day   : 5;
138 	uint16_t month : 4;
139 	uint16_t year  : 7;
140 } smb_date_t;
141 
142 /*
143  * The hours range is 0-23, the minutes range is 0-59 and the two_sec
144  * range is 0-29.
145  */
146 typedef struct smb_time {
147 	uint16_t two_sec : 5;
148 	uint16_t minutes : 6;
149 	uint16_t hours    : 5;
150 } smb_time_t;
151 
152 /*
153  * This is a 64-bit signed absolute time representing 100ns increments.
154  * A positive value represents the absolute time since 1601AD. A
155  * negative value represents a context specific relative time.
156  */
157 typedef struct smb_time2 {
158 	uint32_t low_time;
159 	int32_t high_time;
160 } smb_time2_t;
161 
162 /*
163  * The number of seconds since Jan 1, 1970, 00:00:00.0.
164  */
165 typedef uint32_t smb_utime_t;
166 
167 #define	SMB_LM_NEGOTIATE_WORDCNT		13
168 #define	SMB_NT_NEGOTIATE_WORDCNT		17
169 
170 #define	SMB_NAME83_EXTLEN			3
171 #define	SMB_NAME83_BASELEN			8
172 #define	SMB_NAME83_LEN				12
173 
174 /* Share types */
175 #ifndef _SHARE_TYPES_DEFINED_
176 #define	_SHARE_TYPES_DEFINED_
177 #define	STYPE_DISKTREE			0x00000000
178 #define	STYPE_PRINTQ			0x00000001
179 #define	STYPE_DEVICE			0x00000002
180 #define	STYPE_IPC			0x00000003
181 #define	STYPE_MASK			0x0000000F
182 #define	STYPE_DFS			0x00000064
183 #define	STYPE_HIDDEN			0x80000000
184 #define	STYPE_SPECIAL			0x80000000
185 #endif /* _SHARE_TYPES_DEFINED_ */
186 
187 #define	STYPE_ISDSK(S)	(((S) & STYPE_MASK) == STYPE_DISKTREE)
188 #define	STYPE_ISPRN(S)	(((S) & STYPE_MASK) == STYPE_PRINTQ)
189 #define	STYPE_ISDEV(S)	(((S) & STYPE_MASK) == STYPE_DEVICE)
190 #define	STYPE_ISIPC(S)	(((S) & STYPE_MASK) == STYPE_IPC)
191 
192 /*
193  * NtCreateAndX and NtTransactCreate creation flags: defined in CIFS
194  * section 4.2.2
195  *
196  * Creation Flag Name         Value  Description
197  * ========================== ====== ==================================
198  * NT_CREATE_REQUEST_OPLOCK   0x02   Level I oplock requested
199  * NT_CREATE_REQUEST_OPBATCH  0x04   Batch oplock requested
200  * NT_CREATE_OPEN_TARGET_DIR  0x08   Target for open is a directory
201  */
202 #define	NT_CREATE_FLAG_REQUEST_OPLOCK		0x02
203 #define	NT_CREATE_FLAG_REQUEST_OPBATCH		0x04
204 #define	NT_CREATE_FLAG_OPEN_TARGET_DIR		0x08
205 #define	NT_CREATE_FLAG_EXTENDED_RESPONSE	0x10
206 
207 /*
208  * The option flags valid in the SMB nt_create_andx call are a subset of
209  * those defined in ntifs.h (ditto SMB nt_transact_create)
210  */
211 #define	SMB_NTCREATE_VALID_OPTIONS (FILE_VALID_OPTION_FLAGS & ~( \
212 	FILE_SYNCHRONOUS_IO_ALERT | FILE_SYNCHRONOUS_IO_NONALERT |\
213 	FILE_RESERVE_OPFILTER))
214 
215 /*
216  * Oplocks levels as expressed in the SMB procotol, i.e.
217  * in nt_create_andx and nt_transact_create responses.
218  * The FS-level oplock interface flags are in ntifs.h
219  * (See OPLOCK_LEVEL_...)
220  */
221 #define	SMB_OPLOCK_NONE		0
222 #define	SMB_OPLOCK_EXCLUSIVE	1
223 #define	SMB_OPLOCK_BATCH	2
224 #define	SMB_OPLOCK_LEVEL_II	3
225 
226 /*
227  * Define the filter flags for NtNotifyChangeDirectoryFile
228  */
229 #define	FILE_NOTIFY_CHANGE_FILE_NAME	0x00000001
230 #define	FILE_NOTIFY_CHANGE_DIR_NAME	0x00000002
231 #define	FILE_NOTIFY_CHANGE_NAME		0x00000003
232 #define	FILE_NOTIFY_CHANGE_ATTRIBUTES	0x00000004
233 #define	FILE_NOTIFY_CHANGE_SIZE		0x00000008
234 #define	FILE_NOTIFY_CHANGE_LAST_WRITE	0x00000010
235 #define	FILE_NOTIFY_CHANGE_LAST_ACCESS	0x00000020
236 #define	FILE_NOTIFY_CHANGE_CREATION	0x00000040
237 #define	FILE_NOTIFY_CHANGE_EA		0x00000080
238 #define	FILE_NOTIFY_CHANGE_SECURITY	0x00000100
239 #define	FILE_NOTIFY_CHANGE_STREAM_NAME	0x00000200
240 #define	FILE_NOTIFY_CHANGE_STREAM_SIZE	0x00000400
241 #define	FILE_NOTIFY_CHANGE_STREAM_WRITE	0x00000800
242 #define	FILE_NOTIFY_VALID_MASK		0x00000fff
243 
244 
245 /*
246  * Define the file action type codes for NtNotifyChangeDirectoryFile
247  */
248 #define	FILE_ACTION_ADDED		0x00000001
249 #define	FILE_ACTION_REMOVED		0x00000002
250 #define	FILE_ACTION_MODIFIED		0x00000003
251 #define	FILE_ACTION_RENAMED_OLD_NAME	0x00000004
252 #define	FILE_ACTION_RENAMED_NEW_NAME	0x00000005
253 #define	FILE_ACTION_ADDED_STREAM	0x00000006
254 #define	FILE_ACTION_REMOVED_STREAM	0x00000007
255 #define	FILE_ACTION_MODIFIED_STREAM	0x00000008
256 /* See also: FILE_ACTION_SUBDIR_CHANGED etc. */
257 
258 /* Lock type flags */
259 #define	LOCKING_ANDX_NORMAL_LOCK	0x00
260 #define	LOCKING_ANDX_SHARED_LOCK	0x01
261 #define	LOCKING_ANDX_OPLOCK_RELEASE	0x02
262 #define	LOCKING_ANDX_CHANGE_LOCK_TYPE	0x04
263 #define	LOCKING_ANDX_CANCEL_LOCK	0x08
264 #define	LOCKING_ANDX_LARGE_FILES	0x10
265 
266 #define	SMB_COM_CREATE_DIRECTORY	0x00
267 #define	SMB_COM_DELETE_DIRECTORY	0x01
268 #define	SMB_COM_OPEN			0x02
269 #define	SMB_COM_CREATE			0x03
270 #define	SMB_COM_CLOSE			0x04
271 #define	SMB_COM_FLUSH			0x05
272 #define	SMB_COM_DELETE			0x06
273 #define	SMB_COM_RENAME			0x07
274 #define	SMB_COM_QUERY_INFORMATION	0x08
275 #define	SMB_COM_SET_INFORMATION		0x09
276 #define	SMB_COM_READ			0x0A
277 #define	SMB_COM_WRITE			0x0B
278 #define	SMB_COM_LOCK_BYTE_RANGE		0x0C
279 #define	SMB_COM_UNLOCK_BYTE_RANGE	0x0D
280 #define	SMB_COM_CREATE_TEMPORARY	0x0E
281 #define	SMB_COM_CREATE_NEW		0x0F
282 #define	SMB_COM_CHECK_DIRECTORY		0x10
283 #define	SMB_COM_PROCESS_EXIT		0x11
284 #define	SMB_COM_SEEK			0x12
285 #define	SMB_COM_LOCK_AND_READ		0x13
286 #define	SMB_COM_WRITE_AND_UNLOCK	0x14
287 
288 #define	SMB_COM_READ_RAW		0x1A
289 #define	SMB_COM_READ_MPX		0x1B
290 #define	SMB_COM_READ_MPX_SECONDARY	0x1C
291 #define	SMB_COM_WRITE_RAW		0x1D
292 #define	SMB_COM_WRITE_MPX		0x1E
293 #define	SMB_COM_WRITE_MPX_SECONDARY	0x1F
294 #define	SMB_COM_WRITE_COMPLETE		0x20
295 
296 #define	SMB_COM_SET_INFORMATION2	0x22
297 #define	SMB_COM_QUERY_INFORMATION2	0x23
298 #define	SMB_COM_LOCKING_ANDX		0x24
299 #define	SMB_COM_TRANSACTION		0x25
300 #define	SMB_COM_TRANSACTION_SECONDARY	0x26
301 #define	SMB_COM_IOCTL			0x27
302 #define	SMB_COM_IOCTL_SECONDARY		0x28
303 #define	SMB_COM_COPY			0x29
304 #define	SMB_COM_MOVE			0x2A
305 #define	SMB_COM_ECHO			0x2B
306 #define	SMB_COM_WRITE_AND_CLOSE		0x2C
307 #define	SMB_COM_OPEN_ANDX		0x2D
308 #define	SMB_COM_READ_ANDX		0x2E
309 #define	SMB_COM_WRITE_ANDX		0x2F
310 
311 #define	SMB_COM_CLOSE_AND_TREE_DISC	0x31
312 #define	SMB_COM_TRANSACTION2		0x32
313 #define	SMB_COM_TRANSACTION2_SECONDARY	0x33
314 #define	SMB_COM_FIND_CLOSE2		0x34
315 #define	SMB_COM_FIND_NOTIFY_CLOSE	0x35
316 
317 #define	SMB_COM_TREE_CONNECT		0x70
318 #define	SMB_COM_TREE_DISCONNECT		0x71
319 #define	SMB_COM_NEGOTIATE		0x72
320 #define	SMB_COM_SESSION_SETUP_ANDX	0x73
321 #define	SMB_COM_LOGOFF_ANDX		0x74
322 #define	SMB_COM_TREE_CONNECT_ANDX	0x75
323 
324 #define	SMB_COM_QUERY_INFORMATION_DISK	0x80
325 #define	SMB_COM_SEARCH			0x81
326 #define	SMB_COM_FIND			0x82
327 #define	SMB_COM_FIND_UNIQUE		0x83
328 #define	SMB_COM_FIND_CLOSE		0x84
329 
330 #define	SMB_COM_NT_TRANSACT		0xA0
331 #define	SMB_COM_NT_TRANSACT_SECONDARY	0xA1
332 #define	SMB_COM_NT_CREATE_ANDX		0xA2
333 #define	SMB_COM_NT_CANCEL		0xA4
334 
335 #define	SMB_COM_OPEN_PRINT_FILE		0xC0
336 #define	SMB_COM_WRITE_PRINT_FILE	0xC1
337 #define	SMB_COM_CLOSE_PRINT_FILE	0xC2
338 #define	SMB_COM_GET_PRINT_QUEUE		0xC3
339 
340 #define	SMB_COM_NUM			0x100
341 
342 /*
343  * Flags field of the SMB header. The names in parenthesis represent
344  * alternative names for the flags.
345  *
346  * SMB_FLAGS_LOCK_AND_READ_OK     If the server supports LockAndRead and
347  * (SMB_FLAGS_LOCKS_SUBDIALECT)   WriteAndUnlock, it sets this bit in the
348  *                                Negotiate response.
349  *
350  * SMB_FLAGS_SEND_NO_ACK          When on, the client guarantees that there
351  * (SMB_FLAGS_RCV_BUF_POSTED)     is a receive buffer posted such that a
352  *                                "Send-No-Ack" can be used by the server
353  *                                to respond to the client's request.
354  *
355  * SMB_FLAGS_CASE_INSENSITIVE     This is part of the Flags field of every
356  *                                SMB header. If this bit is set, then all
357  *                                pathnames in the SMB should be treated as
358  *                                case-insensitive. Otherwise pathnames are
359  *                                case-sensitive.
360  *
361  * SMB_FLAGS_CANONICALIZED_PATHS  When on in SessionSetupX, this indicates
362  *                                that all paths sent to the server are
363  *                                already in OS/2 canonicalized format.
364  *
365  * OS/2 canonical format means that file/directory names are in upper case,
366  * are valid characters, . and .. have been removed and single backslashes
367  * are used as separators.
368  *
369  * SMB_FLAGS_OPLOCK               When set in an open file request SMBs
370  *                                (Open, Create, OpenX, etc.) this bit
371  *                                indicates a request for an oplock on the
372  *                                file. When set in the response, this bit
373  *                                indicates that the oplock was granted.
374  *
375  * SMB_FLAGS_OPLOCK_NOTIFY_ANY    When on, this bit indicates that the server
376  *                                should notify the client on any request
377  *                                that could cause the file to be changed.
378  *                                If not set, the server only notifies the
379  *                                client on other open requests on the file.
380  *                                This bit is only relevant when
381  *                                SMB_FLAGS_OPLOCK is set.
382  *
383  * SMB_FLAGS_SERVER_TO_REDIR      This bit indicates that the SMB is being
384  * (SMB_FLAGS_REPLY)              sent from server to (client) redirector.
385  */
386 #define	SMB_FLAGS_LOCK_AND_READ_OK	0x01
387 #define	SMB_FLAGS_SEND_NO_ACK		0x02
388 #define	SMB_FLAGS_RESERVED		0x04
389 #define	SMB_FLAGS_CASE_INSENSITIVE	0x08
390 #define	SMB_FLAGS_CANONICALIZED_PATHS	0x10
391 #define	SMB_FLAGS_OPLOCK		0x20
392 #define	SMB_FLAGS_OPLOCK_NOTIFY_ANY	0x40
393 #define	SMB_FLAGS_REPLY			0x80
394 
395 
396 /*
397  * Flags2 field of the SMB header.
398  *
399  * SMB_FLAGS2_READ_IF_EXECUTE is also known as SMB_FLAGS2_PAGING_IO
400  */
401 #define	SMB_FLAGS2_KNOWS_LONG_NAMES		0x0001
402 #define	SMB_FLAGS2_KNOWS_EAS			0x0002
403 #define	SMB_FLAGS2_SMB_SECURITY_SIGNATURE	0x0004
404 #define	SMB_FLAGS2_IS_LONG_NAME			0x0040
405 #define	SMB_FLAGS2_REPARSE_PATH			0x0400
406 #define	SMB_FLAGS2_EXT_SEC			0x0800
407 #define	SMB_FLAGS2_DFS				0x1000
408 #define	SMB_FLAGS2_READ_IF_EXECUTE		0x2000
409 #define	SMB_FLAGS2_NT_STATUS			0x4000
410 #define	SMB_FLAGS2_UNICODE			0x8000
411 
412 #define	DIALECT_UNKNOWN		 0
413 #define	PC_NETWORK_PROGRAM_1_0	 1  /* The original MSNET SMB protocol */
414 #define	PCLAN1_0		 2  /* Some versions of the original MSNET */
415 #define	MICROSOFT_NETWORKS_1_03	 3  /* This is used for the MS-NET 1.03 */
416 #define	MICROSOFT_NETWORKS_3_0	 4  /* This is the  DOS LANMAN 1.0 specific */
417 #define	LANMAN1_0		 5  /* This is the first version of the full */
418 #define	LM1_2X002		 6  /* This is the first version of the full */
419 #define	DOS_LM1_2X002		 7  /* This is the dos equivalent of the */
420 #define	DOS_LANMAN2_1		 8  /* DOS LANMAN2.1 */
421 #define	LANMAN2_1		 9  /* OS/2 LANMAN2.1 */
422 #define	Windows_for_Workgroups_3_1a 10 /* Windows for Workgroups Version 1.0 */
423 #define	NT_LM_0_12		11  /* The SMB protocol designed for NT */
424 #define	DIALECT_SMB2002		12  /* SMB 2.002 (switch to SMB2) */
425 #define	DIALECT_SMB2XXX		13  /* SMB 2.??? (switch to SMB2) */
426 
427 /*
428  * SMB_TREE_CONNECT_ANDX  request flags
429  *
430  * The tree specified by TID in the SMB header
431  * should be disconnected - disconnect errors
432  * should be ignored.
433  */
434 #define	SMB_TCONX_DISCONECT_TID		0x0001
435 /*
436  * Client request for signing key protection.
437  */
438 #define	SMB_TCONX_EXTENDED_SIGNATURES	0x0004
439 /*
440  * Client request for extended information.
441  */
442 #define	SMB_TCONX_EXTENDED_RESPONSE	0x0008
443 
444 /*
445  * SMB_TREE_CONNECT_ANDX OptionalSupport flags
446  *
447  * SMB_SUPPORT_SEARCH_BITS    The server supports SearchAttributes.
448  * SMB_SHARE_IS_IN_DFS        The share is managed by DFS.
449  * SMB_CSC_MASK               Offline-caching mask - see CSC values.
450  * SMB_UNIQUE_FILE_NAME       The server uses long names and does not support
451  *                            short names.  This indicates to clients that
452  *                            they may perform directory name-space caching.
453  * SMB_EXTENDED_SIGNATURES    The server will use signing key protection.
454  *
455  * SMB_CSC_CACHE_MANUAL_REINT Clients are allowed to cache files for offline
456  *                            use as requested by users but automatic
457  *                            file-by-file reintegration is not allowed.
458  * SMB_CSC_CACHE_AUTO_REINT   Clients are allowed to automatically cache
459  *                            files for offline use and file-by-file
460  *                            reintegration is allowed.
461  * SMB_CSC_CACHE_VDO          Clients are allowed to automatically cache files
462  *                            for offline use, file-by-file reintegration is
463  *                            allowed and clients are permitted to work from
464  *                            their local cache even while offline.
465  * SMB_CSC_CACHE_NONE         Client-side caching is disabled for this share.
466  *
467  * SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM
468  *			      The server will filter directory entries based
469  *			      on the access permissions of the client.
470  */
471 #define	SMB_SUPPORT_SEARCH_BITS		0x0001
472 #define	SMB_SHARE_IS_IN_DFS		0x0002
473 #define	SMB_CSC_MASK			0x000C
474 #define	SMB_UNIQUE_FILE_NAME		0x0010
475 #define	SMB_EXTENDED_SIGNATURES		0x0020
476 
477 #define	SMB_CSC_CACHE_MANUAL_REINT	0x0000
478 #define	SMB_CSC_CACHE_AUTO_REINT	0x0004
479 #define	SMB_CSC_CACHE_VDO		0x0008
480 #define	SMB_CSC_CACHE_NONE		0x000C
481 
482 #define	SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM	0x0800
483 #define	SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING		0x0400
484 
485 /*
486  * The subcommand codes, placed in SETUP[0], for named pipe operations are:
487  * SubCommand Code	Value Description
488  * ===================	===== =========================================
489  */
490 
491 #define	CallNamedPipe	0x54	/* open/write/read/close pipe */
492 #define	WaitNamedPipe	0x53	/* wait for pipe to be nonbusy */
493 #define	PeekNmPipe	0x23	/* read but don't remove data */
494 #define	QNmPHandState	0x21	/* query pipe handle modes */
495 #define	SetNmPHandState	0x01	/* set pipe handle modes */
496 #define	QNmPipeInfo	0x22	/* query pipe attributes */
497 #define	TransactNmPipe	0x26	/* write/read operation on pipe */
498 #define	RawReadNmPipe	0x11	/* read pipe in "raw" (non message mode) */
499 #define	RawWriteNmPipe	0x31	/* write pipe "raw" (non message mode) */
500 
501 
502 
503 /*
504  * Setup[0] Transaction2       Value  Description
505  * Subcommand Code
506  * ==========================  =====  =============================
507  */
508 
509 #define	TRANS2_OPEN2		0x00	/* Create file, extended attributes */
510 #define	TRANS2_FIND_FIRST2	0x01	/* Begin search for files */
511 #define	TRANS2_FIND_NEXT2	0x02	/* Resume search for files */
512 #define	TRANS2_QUERY_FS_INFORMATION 0x03 /* Get file system information */
513 #define	TRANS2_SET_FS_INFORMATION	0x04	/* Set file system info. */
514 #define	TRANS2_QUERY_PATH_INFORMATION 0x05 /* Get info, named file or dir */
515 #define	TRANS2_SET_PATH_INFORMATION 0x06 /* Set info, named file or dir */
516 #define	TRANS2_QUERY_FILE_INFORMATION 0x07 /* Get info, handle */
517 #define	TRANS2_SET_FILE_INFORMATION 0x08 /* Set info, handle */
518 #define	TRANS2_FSCTL		0x09	/* Not implemented by NT server */
519 #define	TRANS2_IOCTL2		0x0A	/* Not implemented by NT server */
520 #define	TRANS2_FIND_NOTIFY_FIRST 0x0B	/* Not implemented by NT server */
521 #define	TRANS2_FIND_NOTIFY_NEXT 0x0C	/* Not implemented by NT server */
522 #define	TRANS2_CREATE_DIRECTORY 0x0D	/* Create dir, extended attributes */
523 #define	TRANS2_SESSION_SETUP	0x0E	/* Session setup, extended security */
524 #define	TRANS2_GET_DFS_REFERRAL	0x10	/* Get a Dfs referral */
525 #define	TRANS2_REPORT_DFS_INCONSISTENCY 0x11 /* Report a Dfs inconsistency */
526 
527 /*
528  * Access Mode Encoding (CIFS/1.0 1996 Section 3.8).
529  *
530  * The desired access mode passed in SmbOpen and SmbOpenAndX has the following
531  * mapping:
532  *
533  *    1111 11
534  *    5432 1098 7654 3210
535  *    rWrC rLLL rSSS rAAA
536  *
537  * where:
538  *
539  *    W - Write through mode.  No read ahead or write behind allowed on
540  *        this file or device.  When protocol is returned, data is expected
541  *        to be on the disk or device.
542  *
543  *    S - Sharing mode:
544  *        0 - Compatibility mode (as in core open)
545  *        1 - Deny read/write/execute (exclusive)
546  *        2 - Deny write
547  *        3 - Deny read/execute
548  *        4 - Deny none
549  *
550  *    A - Access mode
551  *        0 - Open for reading
552  *        1 - Open for writing
553  *        2 - Open for reading and writing
554  *        3 - Open for execute
555  *
556  *    rSSSrAAA = 11111111 (hex FF) indicates FCB open (as in core protocol)
557  *
558  *    C - Cache mode
559  *        0 - Normal file
560  *        1 - Do not cache this file
561  *
562  *    L - Locality of reference
563  *        0 - Locality of reference is unknown
564  *        1 - Mainly sequential access
565  *        2 - Mainly random access
566  *        3 - Random access with some locality
567  *        4 to 7 - Currently undefined
568  */
569 
570 
571 #define	SMB_DA_SHARE_MASK		0x70
572 #define	SMB_DA_ACCESS_MASK		0x07
573 #define	SMB_DA_FCB_MASK			(UCHAR)0xFF
574 
575 #define	SMB_DA_ACCESS_READ		0x00
576 #define	SMB_DA_ACCESS_WRITE		0x01
577 #define	SMB_DA_ACCESS_READ_WRITE	0x02
578 #define	SMB_DA_ACCESS_EXECUTE		0x03
579 
580 #define	SMB_DA_SHARE_COMPATIBILITY	0x00
581 #define	SMB_DA_SHARE_EXCLUSIVE		0x10
582 #define	SMB_DA_SHARE_DENY_WRITE		0x20
583 #define	SMB_DA_SHARE_DENY_READ		0x30
584 #define	SMB_DA_SHARE_DENY_NONE		0x40
585 
586 #define	SMB_DA_FCB			(UCHAR)0xFF
587 
588 #define	SMB_CACHE_NORMAL		0x0000
589 #define	SMB_DO_NOT_CACHE		0x1000
590 
591 #define	SMB_LR_UNKNOWN			0x0000
592 #define	SMB_LR_SEQUENTIAL		0x0100
593 #define	SMB_LR_RANDOM			0x0200
594 #define	SMB_LR_RANDOM_WITH_LOCALITY	0x0300
595 #define	SMB_LR_MASK			0x0F00
596 
597 #define	SMB_DA_WRITE_THROUGH		0x4000
598 
599 /*
600  * Macros used for share reservation rule checking
601  */
602 
603 #define	SMB_DENY_READ(share_access) ((share_access & FILE_SHARE_READ) == 0)
604 
605 #define	SMB_DENY_WRITE(share_access) ((share_access & FILE_SHARE_WRITE) == 0)
606 
607 #define	SMB_DENY_DELETE(share_access) ((share_access & FILE_SHARE_DELETE) == 0)
608 
609 #define	SMB_DENY_RW(share_access) \
610 	((share_access & (FILE_SHARE_READ | FILE_SHARE_WRITE)) == 0)
611 
612 #define	SMB_DENY_ALL(share_access) (share_access == 0)
613 
614 #define	SMB_DENY_NONE(share_access) (share_access == FILE_SHARE_ALL)
615 
616 /*
617  * The SMB open function determines what action should be taken depending
618  * on the existence or lack thereof of files used in the operation.  It
619  * has the following mapping:
620  *
621  *    1111 1
622  *    5432 1098 7654 3210
623  *    rrrr rrrr rrrC rrOO
624  *
625  * where:
626  *
627  *    O - Open (action to be taken if the target file exists)
628  *        0 - Fail
629  *        1 - Open or Append file
630  *        2 - Truncate file
631  *
632  *    C - Create (action to be taken if the target file does not exist)
633  *        0 - Fail
634  *        1 - Create file
635  */
636 
637 #define	SMB_OFUN_OPEN_MASK		0x3
638 #define	SMB_OFUN_CREATE_MASK		0x10
639 
640 #define	SMB_OFUN_OPEN_FAIL		0
641 #define	SMB_OFUN_OPEN_APPEND		1
642 #define	SMB_OFUN_OPEN_OPEN		1
643 #define	SMB_OFUN_OPEN_TRUNCATE		2
644 
645 #define	SMB_OFUN_CREATE_FAIL		0x00
646 #define	SMB_OFUN_CREATE_CREATE		0x10
647 
648 /*
649  * The Action field of OpenAndX has the following format:
650  *
651  *    1111 11
652  *    5432 1098 7654 3210
653  *    Lrrr rrrr rrrr rrOO
654  *
655  * where:
656  *
657  *    L - Opportunistic lock.  1 if lock granted, else 0.
658  *
659  *    O - Open action:
660  *        1 - The file existed and was opened
661  *        2 - The file did not exist but was created
662  *        3 - The file existed and was truncated
663  */
664 
665 #define	SMB_OACT_OPENED			0x01
666 #define	SMB_OACT_CREATED		0x02
667 #define	SMB_OACT_TRUNCATED		0x03
668 #define	SMB_OACT_OPLOCK			0x8000
669 
670 #define	SMB_FTYPE_DISK			0
671 #define	SMB_FTYPE_BYTE_PIPE		1
672 #define	SMB_FTYPE_MESG_PIPE		2
673 #define	SMB_FTYPE_PRINTER		3
674 #define	SMB_FTYPE_UNKNOWN		0xFFFF
675 
676 #define	SMB_DEVST_BLOCKING		0x8000
677 #define	SMB_DEVST_ENDPOINT		0x4000
678 #define	SMB_DEVST_TYPE_MASK		0x0C00
679 #define	SMB_DEVST_TYPE_BYTE_PIPE	0x0000
680 #define	SMB_DEVST_TYPE_MESG_PIPE	0x0400
681 #define	SMB_DEVST_RMODE_MASK		0x0300
682 #define	SMB_DEVST_RMODE_BYTES		0x0000
683 #define	SMB_DEVST_RMODE_MESGS		0x0100
684 #define	SMB_DEVST_ICOUNT_MASK		0x00FF		/* not used */
685 
686 #define	SMB_FTYPE_IS_DISK(F)		((F) == SMB_FTYPE_DISK)
687 #define	SMB_FTYPE_IS_PIPE(F) \
688 	(((F) == SMB_FTYPE_BYTE_PIPE) || ((F) == SMB_FTYPE_MESG_PIPE))
689 #define	SMB_FTYPE_IS_PRINTER(F)		((F) == SMB_FTYPE_PRINTER)
690 
691 /*
692  * TRANS2_FIND
693  */
694 #define	SMB_FIND_FILE_DIRECTORY_INFO		0x101
695 #define	SMB_FIND_FILE_FULL_DIRECTORY_INFO	0x102
696 #define	SMB_FIND_FILE_NAMES_INFO		0x103
697 #define	SMB_FIND_FILE_BOTH_DIRECTORY_INFO	0x104
698 #define	SMB_FIND_FILE_ID_FULL_DIRECTORY_INFO	0x105
699 #define	SMB_FIND_FILE_ID_BOTH_DIRECTORY_INFO	0x106
700 #define	SMB_MAC_FIND_BOTH_HFS_INFO		MAC_FIND_BOTH_HFS_INFO
701 
702 
703 /*
704  * Flags for TRANS2_FIND_FIRST2 and TRANS2_FIND_NEXT2 (NTDDK).
705  *
706  * If SMB_FIND_RETURN_RESUME_KEYS was set in the request parameters,
707  * each entry is preceded by a four-byte resume key.
708  */
709 #define	SMB_FIND_CLOSE_AFTER_REQUEST	0x01
710 #define	SMB_FIND_CLOSE_AT_EOS		0x02
711 #define	SMB_FIND_RETURN_RESUME_KEYS	0x04
712 #define	SMB_FIND_CONTINUE_FROM_LAST	0x08
713 #define	SMB_FIND_WITH_BACKUP_INTENT	0x10
714 
715 
716 /*
717  * TRANS2_QUERY_FS_INFORMATION
718  *
719  * SMB_QUERY_FS_QUOTA_INFO, SMB_QUERY_FS_CONTROL_INFO are not used in Windows
720  * NT, and are not used in any post NT Windows operating systems. If a server
721  * receives these information levels from a client, it should handle them as
722  * invalid information levels.
723  */
724 #define	SMB_INFO_ALLOCATION		1
725 #define	SMB_INFO_VOLUME			2
726 #define	SMB_QUERY_FS_LABEL_INFO		0x101
727 #define	SMB_QUERY_FS_VOLUME_INFO	0x102
728 #define	SMB_QUERY_FS_SIZE_INFO		0x103
729 #define	SMB_QUERY_FS_DEVICE_INFO	0x104
730 #define	SMB_QUERY_FS_ATTRIBUTE_INFO	0x105
731 #define	SMB_QUERY_FS_QUOTA_INFO		0x106
732 #define	SMB_QUERY_FS_CONTROL_INFO	0x107
733 
734 #define	SMB_MAC_QUERY_FS_INFO		MAC_QUERY_FS_INFO
735 
736 /*
737  * Internal use only.
738  * Define information levels to represent the following requests:
739  *    smb_query_information
740  *    smb_query_information2
741  *    smb_set_information
742  *    smb_set_information2
743  */
744 #define	SMB_QUERY_INFORMATION	0x3001
745 #define	SMB_QUERY_INFORMATION2	0x3002
746 #define	SMB_SET_INFORMATION	0x3001
747 #define	SMB_SET_INFORMATION2	0x3002
748 
749 /* TRANS2_QUERY_{PATH,FILE}_INFORMATION */
750 #define	SMB_INFO_STANDARD		 1	/* query, set */
751 #define	SMB_INFO_QUERY_EA_SIZE		 2	/* query */
752 #define	SMB_INFO_SET_EAS		 2	/* set */
753 #define	SMB_INFO_QUERY_EAS_FROM_LIST	 3	/* query */
754 #define	SMB_INFO_QUERY_ALL_EAS		 4	/* query */
755 #define	SMB_INFO_QUERY_FULL_NAME	 5	/* unused */
756 #define	SMB_INFO_IS_NAME_VALID		 6	/* query */
757 
758 #define	SMB_QUERY_FILE_BASIC_INFO	 0x101
759 #define	SMB_QUERY_FILE_STANDARD_INFO	 0x102
760 #define	SMB_QUERY_FILE_EA_INFO		 0x103
761 #define	SMB_QUERY_FILE_NAME_INFO	 0x104
762 #define	SMB_QUERY_FILE_ALLOCATION_INFO	 0x105	/* unused */
763 #define	SMB_QUERY_FILE_END_OF_FILE_INFO	 0x106	/* unused */
764 #define	SMB_QUERY_FILE_ALL_INFO		 0x107
765 #define	SMB_QUERY_FILE_ALT_NAME_INFO	 0x108
766 #define	SMB_QUERY_FILE_STREAM_INFO	 0x109
767 #define	SMB_QUERY_FILE_COMPRESSION_INFO	 0x10B
768 
769 #define	SMB_MAC_SET_FINDER_INFO		MAC_SET_FINDER_INFO
770 #define	SMB_MAC_DT_ADD_APPL		MAC_DT_ADD_APPL
771 #define	SMB_MAC_DT_REMOVE_APPL		MAC_DT_REMOVE_APPL
772 #define	SMB_MAC_DT_GET_APPL		MAC_DT_GET_APPL
773 #define	SMB_MAC_DT_GET_ICON		MAC_DT_GET_ICON
774 #define	SMB_MAC_DT_GET_ICON_INFO	MAC_DT_GET_ICON_INFO
775 #define	SMB_MAC_DT_ADD_ICON		MAC_DT_ADD_ICON
776 
777 #define	SMB_SET_FILE_BASIC_INFO		0x101
778 #define	SMB_SET_FILE_DISPOSITION_INFO	0x102
779 #define	SMB_SET_FILE_ALLOCATION_INFO	0x103
780 #define	SMB_SET_FILE_END_OF_FILE_INFO	0x104
781 
782 
783 /* NT passthrough levels - see ntifs.h FILE_INFORMATION_CLASS */
784 #define	SMB_FILE_BASIC_INFORMATION		1004
785 #define	SMB_FILE_STANDARD_INFORMATION		1005
786 #define	SMB_FILE_INTERNAL_INFORMATION		1006
787 #define	SMB_FILE_EA_INFORMATION			1007
788 #define	SMB_FILE_ACCESS_INFORMATION		1008
789 #define	SMB_FILE_NAME_INFORMATION		1009
790 #define	SMB_FILE_RENAME_INFORMATION		1010
791 #define	SMB_FILE_LINK_INFORMATION		1011
792 #define	SMB_FILE_DISPOSITION_INFORMATION	1013
793 #define	SMB_FILE_ALL_INFORMATION		1018
794 #define	SMB_FILE_ALLOCATION_INFORMATION		1019
795 #define	SMB_FILE_END_OF_FILE_INFORMATION	1020
796 #define	SMB_FILE_ALT_NAME_INFORMATION		1021
797 #define	SMB_FILE_STREAM_INFORMATION		1022
798 #define	SMB_FILE_COMPRESSION_INFORMATION	1028
799 #define	SMB_FILE_NETWORK_OPEN_INFORMATION	1034
800 #define	SMB_FILE_ATTR_TAG_INFORMATION		1035
801 
802 /* NT passthrough levels - see ntifs.h FILE_FS_INFORMATION_CLASS */
803 #define	SMB_FILE_FS_VOLUME_INFORMATION		1001
804 #define	SMB_FILE_FS_LABEL_INFORMATION		1002
805 #define	SMB_FILE_FS_SIZE_INFORMATION		1003
806 #define	SMB_FILE_FS_DEVICE_INFORMATION		1004
807 #define	SMB_FILE_FS_ATTRIBUTE_INFORMATION	1005
808 #define	SMB_FILE_FS_CONTROL_INFORMATION		1006
809 #define	SMB_FILE_FS_FULLSIZE_INFORMATION	1007
810 #define	SMB_FILE_FS_OBJECTID_INFORMATION	1008
811 #define	SMB_FILE_FS_DRIVERPATH_INFORMATION	1009
812 
813 /*
814  * The following bits may be set in the SecurityMode field of the
815  * SMB_COM_NEGOTIATE response.
816  *
817  * Note: Same as the NTDDK definitions.
818  */
819 #define	NEGOTIATE_USER_SECURITY				0x01
820 #define	NEGOTIATE_ENCRYPT_PASSWORDS			0x02
821 #define	NEGOTIATE_SECURITY_SIGNATURES_ENABLED		0x04
822 #define	NEGOTIATE_SECURITY_SIGNATURES_REQUIRED		0x08
823 
824 
825 /*
826  * Negotiated Capabilities (CIFS/1.0 section 4.1.1)
827  *
828  * Capabilities allow the server to tell the client what it supports.
829  * Undefined bits MUST be set to zero by servers, and MUST be ignored
830  * by clients. The bit definitions are:
831  *
832  * Capability Name	 Encoding   Meaning
833  * ====================	 ========   ==================================
834  * CAP_RAW_MODE		 0x0001	    The server supports SMB_COM_READ_RAW and
835  *				    SMB_COM_WRITE_RAW (obsolescent)
836  * CAP_MPX_MODE		 0x0002	    The server supports SMB_COM_READ_MPX and
837  *				    SMB_COM_WRITE_MPX (obsolescent)
838  * CAP_UNICODE		 0x0004	    The server supports Unicode strings
839  * CAP_LARGE_FILES	 0x0008	    The server supports large files with 64
840  *				    bit offsets
841  * CAP_NT_SMBS		 0x0010	    The server supports the SMBs particular
842  *				    to the NT LM 0.12 dialect.
843  *				    Implies CAP_NT_FIND.
844  * CAP_RPC_REMOTE_APIS	 0x0020	    The server supports remote admin API
845  *				    requests via DCE RPC
846  * CAP_STATUS32		 0x0040	    The server can respond with 32 bit
847  *				    status codes in Status.Status
848  * CAP_LEVEL_II_OPLOCKS	 0x0080	    The server supports level 2 oplocks
849  * CAP_LOCK_AND_READ	 0x0100	    The server supports the
850  *				    SMB_COM_LOCK_AND_READ SMB
851  * CAP_NT_FIND		 0x0200
852  * CAP_BULK_TRANSFER	 0x0400
853  * CAP_COMPRESSED_BULK	 0x0800
854  * CAP_DFS		 0x1000	    The server is DFS aware
855  * CAP_INFOLEVEL_PASSTHRU 0x2000    The server supports passthru information
856  *				    level processing capability.
857  * CAP_LARGE_READX	 0x4000	    The server supports large
858  *				    SMB_COM_READ_ANDX
859  * CAP_LARGE_WRITEX	 0x8000	    The server supports large
860  *				    SMB_COM_WRITE_ANDX
861  * CAP_RESERVED		 0x02000000 Reserved for future use.
862  * CAP_EXTENDED_SECURITY 0x80000000 The server supports extended security
863  *				    exchanges.
864  *
865  * Extended security exchanges provides a means of supporting arbitrary
866  * authentication protocols within CIFS. Security blobs are opaque to the
867  * CIFS protocol; they are messages in some authentication protocol that
868  * has been agreed upon by client and server by some out of band mechanism,
869  * for which CIFS merely functions as a transport. When
870  * CAP_EXTENDED_SECURITY is negotiated, the server includes a first
871  * security blob in its response; subsequent security blobs are exchanged
872  * in SMB_COM_SESSION_SETUP_ANDX requests and responses until the
873  * authentication protocol terminates.
874  */
875 #define	CAP_RAW_MODE			0x0001
876 #define	CAP_MPX_MODE			0x0002
877 #define	CAP_UNICODE			0x0004
878 #define	CAP_LARGE_FILES			0x0008
879 #define	CAP_NT_SMBS			0x0010
880 #define	CAP_RPC_REMOTE_APIS		0x0020
881 #define	CAP_STATUS32			0x0040
882 #define	CAP_LEVEL_II_OPLOCKS		0x0080
883 #define	CAP_LOCK_AND_READ		0x0100
884 #define	CAP_NT_FIND			0x0200
885 #define	CAP_BULK_TRANSFER		0x0400
886 #define	CAP_COMPRESSED_BULK		0x0800
887 #define	CAP_DFS				0x1000
888 #define	CAP_INFOLEVEL_PASSTHRU		0x2000
889 #define	CAP_LARGE_READX			0x4000
890 #define	CAP_LARGE_WRITEX		0x8000
891 #define	CAP_RESERVED			0x02000000
892 #define	CAP_EXTENDED_SECURITY		0x80000000
893 
894 
895 /*
896  * Different device types according to NT
897  */
898 #define	FILE_DEVICE_BEEP		0x00000001
899 #define	FILE_DEVICE_CD_ROM		0x00000002
900 #define	FILE_DEVICE_CD_ROM_FILE_SYSTEM	0x00000003
901 #define	FILE_DEVICE_CONTROLLER		0x00000004
902 #define	FILE_DEVICE_DATALINK		0x00000005
903 #define	FILE_DEVICE_DFS			0x00000006
904 #define	FILE_DEVICE_DISK		0x00000007
905 #define	FILE_DEVICE_DISK_FILE_SYSTEM	0x00000008
906 #define	FILE_DEVICE_FILE_SYSTEM		0x00000009
907 #define	FILE_DEVICE_INPORT_PORT		0x0000000a
908 #define	FILE_DEVICE_KEYBOARD		0x0000000b
909 #define	FILE_DEVICE_MAILSLOT		0x0000000c
910 #define	FILE_DEVICE_MIDI_IN		0x0000000d
911 #define	FILE_DEVICE_MIDI_OUT		0x0000000e
912 #define	FILE_DEVICE_MOUSE		0x0000000f
913 #define	FILE_DEVICE_MULTI_UNC_PROVIDER	0x00000010
914 #define	FILE_DEVICE_NAMED_PIPE		0x00000011
915 #define	FILE_DEVICE_NETWORK		0x00000012
916 #define	FILE_DEVICE_NETWORK_BROWSER	0x00000013
917 #define	FILE_DEVICE_NETWORK_FILE_SYSTEM 0x00000014
918 #define	FILE_DEVICE_NULL		0x00000015
919 #define	FILE_DEVICE_PARALLEL_PORT	0x00000016
920 #define	FILE_DEVICE_PHYSICAL_NETCARD	0x00000017
921 #define	FILE_DEVICE_PRINTER		0x00000018
922 #define	FILE_DEVICE_SCANNER		0x00000019
923 #define	FILE_DEVICE_SERIAL_MOUSE_PORT	0x0000001a
924 #define	FILE_DEVICE_SERIAL_PORT		0x0000001b
925 #define	FILE_DEVICE_SCREEN		0x0000001c
926 #define	FILE_DEVICE_SOUND		0x0000001d
927 #define	FILE_DEVICE_STREAMS		0x0000001e
928 #define	FILE_DEVICE_TAPE		0x0000001f
929 #define	FILE_DEVICE_TAPE_FILE_SYSTEM	0x00000020
930 #define	FILE_DEVICE_TRANSPORT		0x00000021
931 #define	FILE_DEVICE_UNKNOWN		0x00000022
932 #define	FILE_DEVICE_VIDEO		0x00000023
933 #define	FILE_DEVICE_VIRTUAL_DISK	0x00000024
934 #define	FILE_DEVICE_WAVE_IN		0x00000025
935 #define	FILE_DEVICE_WAVE_OUT		0x00000026
936 #define	FILE_DEVICE_8042_PORT		0x00000027
937 #define	FILE_DEVICE_NETWORK_REDIRECTOR	0x00000028
938 #define	FILE_DEVICE_BATTERY		0x00000029
939 #define	FILE_DEVICE_BUS_EXTENDER	0x0000002a
940 #define	FILE_DEVICE_MODEM		0x0000002b
941 #define	FILE_DEVICE_VDM			0x0000002c
942 
943 /*
944  * Some of these device types are not currently accessible over the network
945  * and may never be accessible over the network. Some may change to be
946  *
947  * accessible over the network. The values for device types that may never
948  * be accessible over the network may be redefined to be just reserved at
949  * some date in the future.
950  *
951  * Characteristics is the sum of any of the following:
952  */
953 
954 #define	FILE_REMOVABLE_MEDIA		0x00000001
955 #define	FILE_READ_ONLY_DEVICE		0x00000002
956 #define	FILE_FLOPPY_DISKETTE		0x00000004
957 #define	FILE_WRITE_ONE_MEDIA		0x00000008
958 #define	FILE_REMOTE_DEVICE		0x00000010
959 #define	FILE_DEVICE_IS_MOUNTED		0x00000020
960 #define	FILE_VIRTUAL_VOLUME		0x00000040
961 
962 /*
963  * File System Control Flags for smb_com_trans2_query|set_fs_information
964  * level SMB_FILE_FS_CONTROL_INFORMATION
965  */
966 #define	FILE_VC_QUOTA_TRACK		0x00000001
967 #define	FILE_VC_QUOTA_ENFORCE		0x00000002
968 #define	FILE_VC_CONTENT_INDEX_DISABLED	0x00000008
969 #define	FILE_VC_LOG_QUOTA_THRESHOLD	0x00000010
970 #define	FILE_VC_LOG_QUOTA_LIMIT		0x00000020
971 #define	FILE_VC_LOG_VOLUME_THRESHOLD	0x00000040
972 #define	FILE_VC_LOG_VOLUME_LIMIT	0x00000080
973 #define	FILE_VC_QUOTAS_INCOMPLETE	0x00000100
974 #define	FILE_VC_QUOTAS_REBUILDING	0x00000200
975 
976 /*
977  * CREATE_ANDX ShareAccess Flags
978  */
979 
980 #define	FILE_SHARE_NONE			0x00000000
981 #define	FILE_SHARE_READ			0x00000001
982 #define	FILE_SHARE_WRITE		0x00000002
983 #define	FILE_SHARE_DELETE		0x00000004
984 #define	FILE_SHARE_ALL			0x00000007
985 #define	FILE_SHARE_VALID_FLAGS		0x00000007
986 
987 
988 /*
989  * CREATE_ANDX CreateDisposition flags
990  *
991  * FILE_SUPERSEDE     If the file already exists it should be superseded
992  *		      by the specified file. If the file does not already
993  *		      exist then it should be created.
994  *
995  * FILE_CREATE	      If the file already exists the operation should fail.
996  *		      If the file does not already exist then it should be
997  *		      created. (aka CREATE_NEW)
998  *
999  * FILE_OPEN	      If the file already exists then it should be opened.
1000  *		      If the file does not already exist then the operation
1001  *		      should fail. (aka OPEN_EXISTING)
1002  *
1003  * FILE_OPEN_IF	      If the file already exists then it should be opened.
1004  *		      If the file does not already exist then it should be
1005  *		      created. (aka OPEN_ALWAYS)
1006  *
1007  * FILE_OVERWRITE     If the file already exists, it should be opened and
1008  *		      overwritten. If the file does not already exist then
1009  *		      the operation should fail. (aka TRUNCATE_EXISTING)
1010  *
1011  * FILE_OVERWRITE_IF  If the file already exists, it should be opened and
1012  *		      overwritten. If the file does not already exist then
1013  *		      it should be created. (aka CREATE_ALWAYS)
1014  */
1015 #define	FILE_SUPERSEDE			0x00000000
1016 #define	FILE_OPEN			0x00000001
1017 #define	FILE_CREATE			0x00000002
1018 #define	FILE_OPEN_IF			0x00000003
1019 #define	FILE_OVERWRITE			0x00000004
1020 #define	FILE_OVERWRITE_IF		0x00000005
1021 #define	FILE_MAXIMUM_DISPOSITION	0x00000005
1022 
1023 /*
1024  * CREATE_ANDX Impersonation levels
1025  */
1026 
1027 #define	SECURITY_ANONYMOUS	0x00000001
1028 #define	SECURITY_IDENTIFICATION	0x00000002
1029 #define	SECURITY_IMPERSONATION	0x00000003
1030 #define	SECURITY_DELEGATION	0x00000004
1031 
1032 /*
1033  * CREATE_ANDX SecurityFlags
1034  */
1035 
1036 #define	SECURITY_CONTEXT_TRACKING	0x00000001
1037 #define	SECURITY_EFFECTIVE_ONLY		0x00000002
1038 
1039 /*
1040  * Server types
1041  */
1042 #define	SV_WORKSTATION		0x00000001	/* All workstations */
1043 #define	SV_SERVER		0x00000002	/* All servers */
1044 #define	SV_SQLSERVER		0x00000004	/* running with SQL server */
1045 #define	SV_DOMAIN_CTRL		0x00000008	/* Primary domain controller */
1046 #define	SV_DOMAIN_BAKCTRL	0x00000010	/* Backup domain controller */
1047 #define	SV_TIME_SOURCE		0x00000020	/* running timesource service */
1048 #define	SV_AFP			0x00000040	/* Apple File Protocol */
1049 #define	SV_NOVELL		0x00000080	/* Novell servers */
1050 #define	SV_DOMAIN_MEMBER	0x00000100	/* Domain Member */
1051 #define	SV_PRINTQ_SERVER	0x00000200	/* Server sharing print queue */
1052 #define	SV_DIALIN_SERVER	0x00000400	/* Server running dialin */
1053 #define	SV_XENIX_SERVER		0x00000800	/* Xenix server */
1054 #define	SV_NT			0x00001000	/* NT server */
1055 #define	SV_WFW			0x00002000	/* Server running Windows for */
1056 #define	SV_SERVER_NT		0x00008000	/* Windows NT non DC server */
1057 #define	SV_POTENTIAL_BROWSER	0x00010000	/* can run browser service */
1058 #define	SV_BACKUP_BROWSER	0x00020000	/* Backup browser server */
1059 #define	SV_MASTER_BROWSER	0x00040000	/* Master browser server */
1060 #define	SV_DOMAIN_MASTER	0x00080000	/* Domain Master Browser */
1061 #define	SV_OSF			0x00100000	/* OSF operating system */
1062 #define	SV_VMS			0x00200000	/* VMS operating system */
1063 #define	SV_WINDOWS_95_PLUS	0x00400000	/* Windows 95 or better */
1064 
1065 #define	SV_LOCAL_LIST_ONLY	0x40000000	/* Enumerate only "local" */
1066 #define	SV_TYPE_DOMAIN_ENUM	0x80000000	/*  Enumerate Domains */
1067 
1068 #define	MY_SERVER_TYPE	(SV_SERVER | SV_NT | SV_SERVER_NT)
1069 
1070 
1071 #define	PRQ_ACTIVE	0	/* Active */
1072 #define	PRQ_PAUSE	1	/* Paused */
1073 #define	PRQ_ERROR	2	/* Error Occurred */
1074 #define	PRQ_PENDING	3	/* Deletion pending */
1075 
1076 #define	PRJ_QS_QUEUED	0	/* Active */
1077 #define	PRJ_QS_PAUSED	1	/* Paused */
1078 #define	PRJ_QS_SPOOLING	2	/* Paused */
1079 #define	PRJ_QS_PRINTING	3	/* Paused */
1080 
1081 
1082 #define	SHARE_ACCESS_READ	0x01	/* read & execute from resource	*/
1083 #define	SHARE_ACCESS_WRITE	0x02	/* write data to resource	*/
1084 #define	SHARE_ACCESS_CREATE	0x04	/* create an instance of	*/
1085 #define	SHARE_ACCESS_EXEC	0x08	/* execute from resource	*/
1086 #define	SHARE_ACCESS_DELETE	0x10	/* Permission to delete the resource */
1087 #define	SHARE_ACCESS_ATTRIB	0x20	/* Permission to modify the resource */
1088 #define	SHARE_ACCESS_PERM	0x40	/* Permission to change permissions */
1089 #define	SHARE_ACCESS_ALL	0x7F	/* All of the above permissions	*/
1090 
1091 
1092 /*
1093  * SMB_COM_NT_TRANSACTION sub-command codes (CIFS/1.0 section 5.3)
1094  *
1095  * SubCommand Code		   Value Description
1096  * =============================== ===== =================================
1097  * NT_TRANSACT_CREATE		   1	 File open/create
1098  * NT_TRANSACT_IOCTL		   2	 Device IOCTL
1099  * NT_TRANSACT_SET_SECURITY_DESC   3	 Set security descriptor
1100  * NT_TRANSACT_NOTIFY_CHANGE	   4	 Start directory watch
1101  * NT_TRANSACT_RENAME		   5	 Reserved (handle-based rename)
1102  * NT_TRANSACT_QUERY_SECURITY_DESC 6	 Retrieve security descriptor
1103  * NT_TRANSACT_QUERY_QUOTA	   7	 Retrieve quota information
1104  * NT_TRANSACT_SET_QUOTA	   8	 Set quota information
1105  */
1106 #define	NT_TRANSACT_MIN_FUNCTION	1
1107 
1108 #define	NT_TRANSACT_CREATE		1
1109 #define	NT_TRANSACT_IOCTL		2
1110 #define	NT_TRANSACT_SET_SECURITY_DESC	3
1111 #define	NT_TRANSACT_NOTIFY_CHANGE	4
1112 #define	NT_TRANSACT_RENAME		5
1113 #define	NT_TRANSACT_QUERY_SECURITY_DESC 6
1114 #define	NT_TRANSACT_QUERY_QUOTA		7
1115 #define	NT_TRANSACT_SET_QUOTA		8
1116 
1117 #define	NT_TRANSACT_MAX_FUNCTION	8
1118 
1119 
1120 /*
1121  * Pipe states
1122  */
1123 #define	SMB_PIPE_READMODE_BYTE		0x0000
1124 #define	SMB_PIPE_READMODE_MESSAGE	0x0100
1125 #define	SMB_PIPE_TYPE_BYTE		0x0000
1126 #define	SMB_PIPE_TYPE_MESSAGE		0x0400
1127 #define	SMB_PIPE_END_CLIENT		0x0000
1128 #define	SMB_PIPE_END_SERVER		0x4000
1129 #define	SMB_PIPE_WAIT			0x0000
1130 #define	SMB_PIPE_NOWAIT			0x8000
1131 #define	SMB_PIPE_UNLIMITED_INSTANCES	0x00FF
1132 
1133 /*
1134  * smb_com_seek request
1135  */
1136 #define	SMB_SEEK_SET	0 /* set file offset to specified offset */
1137 #define	SMB_SEEK_CUR	1 /* set file offset to current plus specified offset */
1138 #define	SMB_SEEK_END	2 /* set file offset to EOF plus specified offset */
1139 
1140 /*
1141  * API Numbers for Transact based RAP (Remote Administration Protocol) calls
1142  */
1143 #define	API_WshareEnum			0
1144 #define	API_WshareGetInfo		1
1145 #define	API_WshareSetInfo		2
1146 #define	API_WshareAdd			3
1147 #define	API_WshareDel			4
1148 #define	API_NetShareCheck		5
1149 #define	API_WsessionEnum		6
1150 #define	API_WsessionGetInfo		7
1151 #define	API_WsessionDel			8
1152 #define	API_WconnectionEnum		9
1153 #define	API_WfileEnum			10
1154 #define	API_WfileGetInfo		11
1155 #define	API_WfileClose			12
1156 #define	API_WserverGetInfo		13
1157 #define	API_WserverSetInfo		14
1158 #define	API_WserverDiskEnum		15
1159 #define	API_WserverAdminCommand		16
1160 #define	API_NetAuditOpen		17
1161 #define	API_WauditClear			18
1162 #define	API_NetErrorLogOpen		19
1163 #define	API_WerrorLogClear		20
1164 #define	API_NetCharDevEnum		21
1165 #define	API_NetCharDevGetInfo		22
1166 #define	API_WCharDevControl		23
1167 #define	API_NetCharDevQEnum		24
1168 #define	API_NetCharDevQGetInfo		25
1169 #define	API_WCharDevQSetInfo		26
1170 #define	API_WCharDevQPurge		27
1171 #define	API_WCharDevQPurgeSelf		28
1172 #define	API_WMessageNameEnum		29
1173 #define	API_WMessageNameGetInfo		30
1174 #define	API_WMessageNameAdd		31
1175 #define	API_WMessageNameDel		32
1176 #define	API_WMessageNameFwd		33
1177 #define	API_WMessageNameUnFwd		34
1178 #define	API_WMessageBufferSend		35
1179 #define	API_WMessageFileSend		36
1180 #define	API_WMessageLogFileSet		37
1181 #define	API_WMessageLogFileGet		38
1182 #define	API_WServiceEnum		39
1183 #define	API_WServiceInstall		40
1184 #define	API_WServiceControl		41
1185 #define	API_WAccessEnum			42
1186 #define	API_WAccessGetInfo		43
1187 #define	API_WAccessSetInfo		44
1188 #define	API_WAccessAdd			45
1189 #define	API_WAccessDel			46
1190 #define	API_WGroupEnum			47
1191 #define	API_WGroupAdd			48
1192 #define	API_WGroupDel			49
1193 #define	API_WGroupAddUser		50
1194 #define	API_WGroupDelUser		51
1195 #define	API_WGroupGetUsers		52
1196 #define	API_WUserEnum			53
1197 #define	API_WUserAdd			54
1198 #define	API_WUserDel			55
1199 #define	API_WUserGetInfo		56
1200 #define	API_WUserSetInfo		57
1201 #define	API_WUserPasswordSet		58
1202 #define	API_WUserGetGroups		59
1203 #define	API_DeadTableEntry		60
1204 #define	API_WWkstaSetUID		62
1205 #define	API_WWkstaGetInfo		63
1206 #define	API_WWkstaSetInfo		64
1207 #define	API_WUseEnum			65
1208 #define	API_WUseAdd			66
1209 #define	API_WUseDel			67
1210 #define	API_WUseGetInfo			68
1211 #define	API_WPrintQEnum			69
1212 #define	API_WPrintQGetInfo		70
1213 #define	API_WPrintQSetInfo		71
1214 #define	API_WPrintQAdd			72
1215 #define	API_WPrintQDel			73
1216 #define	API_WPrintQPause		74
1217 #define	API_WPrintQContinue		75
1218 #define	API_WPrintJobEnum		76
1219 #define	API_WPrintJobGetInfo		77
1220 #define	API_WPrintJobSetInfo_OLD	78
1221 #define	API_WPrintJobDel		81
1222 #define	API_WPrintJobPause		82
1223 #define	API_WPrintJobContinue		83
1224 #define	API_WPrintDestEnum		84
1225 #define	API_WPrintDestGetInfo		85
1226 #define	API_WPrintDestControl		86
1227 #define	API_WProfileSave		87
1228 #define	API_WProfileLoad		88
1229 #define	API_WStatisticsGet		89
1230 #define	API_WStatisticsClear		90
1231 #define	API_NetRemoteTOD		91
1232 #define	API_WNetBiosEnum		92
1233 #define	API_WNetBiosGetInfo		93
1234 #define	API_NetServerEnum		94
1235 #define	API_I_NetServerEnum		95
1236 #define	API_WServiceGetInfo		96
1237 #define	API_WPrintQPurge		103
1238 #define	API_NetServerEnum2		104
1239 #define	API_WAccessGetUserPerms		105
1240 #define	API_WGroupGetInfo		106
1241 #define	API_WGroupSetInfo		107
1242 #define	API_WGroupSetUsers		108
1243 #define	API_WUserSetGroups		109
1244 #define	API_WUserModalsGet		110
1245 #define	API_WUserModalsSet		111
1246 #define	API_WFileEnum2			112
1247 #define	API_WUserAdd2			113
1248 #define	API_WUserSetInfo2		114
1249 #define	API_WUserPasswordSet2		115
1250 #define	API_I_NetServerEnum2		116
1251 #define	API_WConfigGet2			117
1252 #define	API_WConfigGetAll2		118
1253 #define	API_WGetDCName			119
1254 #define	API_NetHandleGetInfo		120
1255 #define	API_NetHandleSetInfo		121
1256 #define	API_WStatisticsGet2		122
1257 #define	API_WBuildGetInfo		123
1258 #define	API_WFileGetInfo2		124
1259 #define	API_WFileClose2			125
1260 #define	API_WNetServerReqChallenge	126
1261 #define	API_WNetServerAuthenticate	127
1262 #define	API_WNetServerPasswordSet	128
1263 #define	API_WNetAccountDeltas		129
1264 #define	API_WNetAccountSync		130
1265 #define	API_WUserEnum2			131
1266 #define	API_WWkstaUserLogon		132
1267 #define	API_WWkstaUserLogoff		133
1268 #define	API_WLogonEnum			134
1269 #define	API_WErrorLogRead		135
1270 #define	API_WI_NetPathType		136
1271 #define	API_WI_NetPathCanonicalize	137
1272 #define	API_WI_NetPathCompare		138
1273 #define	API_WI_NetNameValidate		139
1274 #define	API_WI_NetNameCanonicalize	140
1275 #define	API_WI_NetNameCompare		141
1276 #define	API_WAuditRead			142
1277 #define	API_WPrintDestAdd		143
1278 #define	API_WPrintDestSetInfo		144
1279 #define	API_WPrintDestDel		145
1280 #define	API_WUserValidate2		146
1281 #define	API_WPrintJobSetInfo		147
1282 #define	API_TI_NetServerDiskEnum	148
1283 #define	API_TI_NetServerDiskGetInfo	149
1284 #define	API_TI_FTVerifyMirror		150
1285 #define	API_TI_FTAbortVerify		151
1286 #define	API_TI_FTGetInfo		152
1287 #define	API_TI_FTSetInfo		153
1288 #define	API_TI_FTLockDisk		154
1289 #define	API_TI_FTFixError		155
1290 #define	API_TI_FTAbortFix		156
1291 #define	API_TI_FTDiagnoseError		157
1292 #define	API_TI_FTGetDriveStats		158
1293 #define	API_TI_FTErrorGetInfo		160
1294 #define	API_NetAccessCheck		163
1295 #define	API_NetAlertRaise		164
1296 #define	API_NetAlertStart		165
1297 #define	API_NetAlertStop		166
1298 #define	API_NetAuditWrite		167
1299 #define	API_NetIRemoteAPI		168
1300 #define	API_NetServiceStatus		169
1301 #define	API_I_NetServerRegister		170
1302 #define	API_I_NetServerDeregister	171
1303 #define	API_I_NetSessionEntryMake	172
1304 #define	API_I_NetSessionEntryClear	173
1305 #define	API_I_NetSessionEntryGetInfo	174
1306 #define	API_I_NetSessionEntrySetInfo	175
1307 #define	API_I_NetConnectionEntryMake	176
1308 #define	API_I_NetConnectionEntryClear	177
1309 #define	API_I_NetConnectionEntrySetInfo	178
1310 #define	API_I_NetConnectionEntryGetInfo	179
1311 #define	API_I_NetFileEntryMake		180
1312 #define	API_I_NetFileEntryClear		181
1313 #define	API_I_NetFileEntrySetInfo	182
1314 #define	API_I_NetFileEntryGetInfo	183
1315 #define	API_AltSrvMessageBufferSend	184
1316 #define	API_AltSrvMessageFileSend	185
1317 #define	API_wI_NetRplWkstaEnum		186
1318 #define	API_wI_NetRplWkstaGetInfo	187
1319 #define	API_wI_NetRplWkstaSetInfo	188
1320 #define	API_wI_NetRplWkstaAdd		189
1321 #define	API_wI_NetRplWkstaDel		190
1322 #define	API_wI_NetRplProfileEnum	191
1323 #define	API_wI_NetRplProfileGetInfo	192
1324 #define	API_wI_NetRplProfileSetInfo	193
1325 #define	API_wI_NetRplProfileAdd		194
1326 #define	API_wI_NetRplProfileDel		195
1327 #define	API_wI_NetRplProfileClone	196
1328 #define	API_wI_NetRplBaseProfileEnum	197
1329 #define	API_WIServerSetInfo		201
1330 #define	API_WPrintDriverEnum		205
1331 #define	API_WPrintQProcessorEnum	206
1332 #define	API_WPrintPortEnum		207
1333 #define	API_WNetWriteUpdateLog		208
1334 #define	API_WNetAccountUpdate		209
1335 #define	API_WNetAccountConfirmUpdate	210
1336 #define	API_WConfigSet			211
1337 #define	API_WAccountsReplicate		212
1338 #define	API_SamOEMChgPasswordUser2_P	214
1339 #define	API_NetServerEnum3		215
1340 #define	API_WprintDriverGetInfo		250
1341 #define	API_WprintDriverSetInfo		251
1342 #define	API_WaliasAdd			252
1343 #define	API_WaliasDel			253
1344 #define	API_WaliasGetInfo		254
1345 #define	API_WaliasSetInfo		255
1346 #define	API_WaliasEnum			256
1347 #define	API_WuserGetLogonAsn		257
1348 #define	API_WuserSetLogonAsn		258
1349 #define	API_WuserGetAppSel		259
1350 #define	API_WuserSetAppSel		260
1351 #define	API_WappAdd			261
1352 #define	API_WappDel			262
1353 #define	API_WappGetInfo			263
1354 #define	API_WappSetInfo			264
1355 #define	API_WappEnum			265
1356 #define	API_WUserDCDBInit		266
1357 #define	API_WDASDAdd			267
1358 #define	API_WDASDDel			268
1359 #define	API_WDASDGetInfo		269
1360 #define	API_WDASDSetInfo		270
1361 #define	API_WDASDEnum			271
1362 #define	API_WDASDCheck			272
1363 #define	API_WDASDCtl			273
1364 #define	API_WuserRemoteLogonCheck	274
1365 #define	API_WUserPasswordSet3		275
1366 #define	API_WCreateRIPLMachine		276
1367 #define	API_WDeleteRIPLMachine		277
1368 #define	API_WGetRIPLMachineInfo		278
1369 #define	API_WSetRIPLMachineInfo		279
1370 #define	API_WEnumRIPLMachine		280
1371 #define	API_WI_ShareAdd			281
1372 #define	API_WI_AliasEnum		282
1373 #define	API_WaccessApply		283
1374 #define	API_WPrt16Query			284
1375 #define	API_WPrt16Set			285
1376 #define	API_WUserDel100			286
1377 #define	API_WUserRemoteLogonCheck2	287
1378 #define	API_WRemoteTODSet		294
1379 #define	API_WprintJobMoveAll		295
1380 #define	API_W16AppParmAdd		296
1381 #define	API_W16AppParmDel		297
1382 #define	API_W16AppParmGet		298
1383 #define	API_W16AppParmSet		299
1384 #define	API_W16RIPLMachineCreate	300
1385 #define	API_W16RIPLMachineGetInfo	301
1386 #define	API_W16RIPLMachineSetInfo	302
1387 #define	API_W16RIPLMachineEnum		303
1388 #define	API_W16RIPLMachineListParmEnum	304
1389 #define	API_W16RIPLMachClassGetInfo	305
1390 #define	API_W16RIPLMachClassEnum	306
1391 #define	API_W16RIPLMachClassCreate	307
1392 #define	API_W16RIPLMachClassSetInfo	308
1393 #define	API_W16RIPLMachClassDelete	309
1394 #define	API_W16RIPLMachClassLPEnum	310
1395 #define	API_W16RIPLMachineDelete	311
1396 #define	API_W16WSLevelGetInfo		312
1397 #define	API_WserverNameAdd		313
1398 #define	API_WserverNameDel		314
1399 #define	API_WserverNameEnum		315
1400 #define	API_I_WDASDEnum			316
1401 #define	API_I_WDASDEnumTerminate	317
1402 #define	API_I_WDASDSetInfo2		318
1403 #define	MAX_RAP_API			318
1404 
1405 #ifdef __cplusplus
1406 }
1407 #endif
1408 
1409 #endif /* _SMBSRV_SMB_H */
1410