4 * Copyright (c) International Business Machines Corp., 2009, 2013
6 * Author(s): Steve French (sfrench@us.ibm.com)
7 * Pavel Shilovsky (pshilovsky@samba.org) 2012
9 * This library is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as published
11 * by the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
17 * the GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this library; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
31 * Note that, due to trying to use names similar to the protocol specifications,
32 * there are many mixed case field names in the structures below. Although
33 * this does not match typical Linux kernel style, it is necessary to be
34 * be able to match against the protocol specfication.
37 * Some commands have minimal (wct=0,bcc=0), or uninteresting, responses
38 * (ie no useful data other than the SMB error code itself) and are marked such.
39 * Knowing this helps avoid response buffer allocations and copy in some cases.
42 /* List of commands in host endian */
43 #define SMB2_NEGOTIATE_HE 0x0000
44 #define SMB2_SESSION_SETUP_HE 0x0001
45 #define SMB2_LOGOFF_HE 0x0002 /* trivial request/resp */
46 #define SMB2_TREE_CONNECT_HE 0x0003
47 #define SMB2_TREE_DISCONNECT_HE 0x0004 /* trivial req/resp */
48 #define SMB2_CREATE_HE 0x0005
49 #define SMB2_CLOSE_HE 0x0006
50 #define SMB2_FLUSH_HE 0x0007 /* trivial resp */
51 #define SMB2_READ_HE 0x0008
52 #define SMB2_WRITE_HE 0x0009
53 #define SMB2_LOCK_HE 0x000A
54 #define SMB2_IOCTL_HE 0x000B
55 #define SMB2_CANCEL_HE 0x000C
56 #define SMB2_ECHO_HE 0x000D
57 #define SMB2_QUERY_DIRECTORY_HE 0x000E
58 #define SMB2_CHANGE_NOTIFY_HE 0x000F
59 #define SMB2_QUERY_INFO_HE 0x0010
60 #define SMB2_SET_INFO_HE 0x0011
61 #define SMB2_OPLOCK_BREAK_HE 0x0012
63 /* The same list in little endian */
64 #define SMB2_NEGOTIATE cpu_to_le16(SMB2_NEGOTIATE_HE)
65 #define SMB2_SESSION_SETUP cpu_to_le16(SMB2_SESSION_SETUP_HE)
66 #define SMB2_LOGOFF cpu_to_le16(SMB2_LOGOFF_HE)
67 #define SMB2_TREE_CONNECT cpu_to_le16(SMB2_TREE_CONNECT_HE)
68 #define SMB2_TREE_DISCONNECT cpu_to_le16(SMB2_TREE_DISCONNECT_HE)
69 #define SMB2_CREATE cpu_to_le16(SMB2_CREATE_HE)
70 #define SMB2_CLOSE cpu_to_le16(SMB2_CLOSE_HE)
71 #define SMB2_FLUSH cpu_to_le16(SMB2_FLUSH_HE)
72 #define SMB2_READ cpu_to_le16(SMB2_READ_HE)
73 #define SMB2_WRITE cpu_to_le16(SMB2_WRITE_HE)
74 #define SMB2_LOCK cpu_to_le16(SMB2_LOCK_HE)
75 #define SMB2_IOCTL cpu_to_le16(SMB2_IOCTL_HE)
76 #define SMB2_CANCEL cpu_to_le16(SMB2_CANCEL_HE)
77 #define SMB2_ECHO cpu_to_le16(SMB2_ECHO_HE)
78 #define SMB2_QUERY_DIRECTORY cpu_to_le16(SMB2_QUERY_DIRECTORY_HE)
79 #define SMB2_CHANGE_NOTIFY cpu_to_le16(SMB2_CHANGE_NOTIFY_HE)
80 #define SMB2_QUERY_INFO cpu_to_le16(SMB2_QUERY_INFO_HE)
81 #define SMB2_SET_INFO cpu_to_le16(SMB2_SET_INFO_HE)
82 #define SMB2_OPLOCK_BREAK cpu_to_le16(SMB2_OPLOCK_BREAK_HE)
84 #define SMB2_INTERNAL_CMD cpu_to_le16(0xFFFF)
86 #define NUMBER_OF_SMB2_COMMANDS 0x0013
88 /* 52 transform hdr + 64 hdr + 88 create rsp */
89 #define SMB2_TRANSFORM_HEADER_SIZE 52
90 #define MAX_SMB2_HDR_SIZE 204
92 #define SMB2_PROTO_NUMBER cpu_to_le32(0x424d53fe)
93 #define SMB2_TRANSFORM_PROTO_NUM cpu_to_le32(0x424d53fd)
94 #define SMB2_COMPRESSION_TRANSFORM_ID cpu_to_le32(0x424d53fc)
97 * SMB2 Header Definition
99 * "MBZ" : Must be Zero
100 * "BB" : BugBug, Something to check/review/analyze later
101 * "PDU" : "Protocol Data Unit" (ie a network "frame")
105 #define SMB2_HEADER_STRUCTURE_SIZE cpu_to_le16(64)
107 struct smb2_sync_hdr
{
108 __le32 ProtocolId
; /* 0xFE 'S' 'M' 'B' */
109 __le16 StructureSize
; /* 64 */
110 __le16 CreditCharge
; /* MBZ */
111 __le32 Status
; /* Error from server */
113 __le16 CreditRequest
; /* CreditResponse */
118 __u32 TreeId
; /* opaque - so do not make little endian */
119 __u64 SessionId
; /* opaque - so do not make little endian */
123 /* The total header size for SMB2 read and write */
124 #define SMB2_READWRITE_PDU_HEADER_SIZE (48 + sizeof(struct smb2_sync_hdr))
126 struct smb2_sync_pdu
{
127 struct smb2_sync_hdr sync_hdr
;
128 __le16 StructureSize2
; /* size of wct area (varies, request specific) */
131 #define SMB3_AES128CCM_NONCE 11
132 #define SMB3_AES128GCM_NONCE 12
134 /* Transform flags (for 3.0 dialect this flag indicates CCM */
135 #define TRANSFORM_FLAG_ENCRYPTED 0x0001
136 struct smb2_transform_hdr
{
137 __le32 ProtocolId
; /* 0xFD 'S' 'M' 'B' */
140 __le32 OriginalMessageSize
;
142 __le16 Flags
; /* EncryptionAlgorithm for 3.0, enc enabled for 3.1.1 */
146 /* See MS-SMB2 2.2.42.1 */
147 struct compression_playload_header
{
153 /* See MS-SMB2 2.2.42.2 */
154 struct compression_pattern_payload_v1
{
162 * SMB2 flag definitions
164 #define SMB2_FLAGS_SERVER_TO_REDIR cpu_to_le32(0x00000001)
165 #define SMB2_FLAGS_ASYNC_COMMAND cpu_to_le32(0x00000002)
166 #define SMB2_FLAGS_RELATED_OPERATIONS cpu_to_le32(0x00000004)
167 #define SMB2_FLAGS_SIGNED cpu_to_le32(0x00000008)
168 #define SMB2_FLAGS_PRIORITY_MASK cpu_to_le32(0x00000070) /* SMB3.1.1 */
169 #define SMB2_FLAGS_DFS_OPERATIONS cpu_to_le32(0x10000000)
170 #define SMB2_FLAGS_REPLAY_OPERATION cpu_to_le32(0x20000000) /* SMB3 & up */
173 * Definitions for SMB2 Protocol Data Units (network frames)
175 * See MS-SMB2.PDF specification for protocol details.
176 * The Naming convention is the lower case version of the SMB2
177 * command code name for the struct. Note that structures must be packed.
181 #define COMPOUND_FID 0xFFFFFFFFFFFFFFFFULL
183 #define SMB2_ERROR_STRUCTURE_SIZE2 cpu_to_le16(9)
185 struct smb2_err_rsp
{
186 struct smb2_sync_hdr sync_hdr
;
187 __le16 StructureSize
;
188 __le16 Reserved
; /* MBZ */
189 __le32 ByteCount
; /* even if zero, at least one byte follows */
190 __u8 ErrorData
[1]; /* variable length */
193 #define SYMLINK_ERROR_TAG 0x4c4d5953
195 struct smb2_symlink_err_rsp
{
196 __le32 SymLinkLength
;
197 __le32 SymLinkErrorTag
;
199 __le16 ReparseDataLength
;
200 __le16 UnparsedPathLength
;
201 __le16 SubstituteNameOffset
;
202 __le16 SubstituteNameLength
;
203 __le16 PrintNameOffset
;
204 __le16 PrintNameLength
;
209 /* SMB 3.1.1 and later dialects. See MS-SMB2 section 2.2.2.1 */
210 struct smb2_error_context_rsp
{
211 __le32 ErrorDataLength
;
213 __u8 ErrorContextData
; /* ErrorDataLength long array */
217 #define SMB2_ERROR_ID_DEFAULT 0x00000000
218 #define SMB2_ERROR_ID_SHARE_REDIRECT cpu_to_le32(0x72645253) /* "rdRS" */
220 /* Defines for Type field below (see MS-SMB2 2.2.2.2.2.1) */
221 #define MOVE_DST_IPADDR_V4 cpu_to_le32(0x00000001)
222 #define MOVE_DST_IPADDR_V6 cpu_to_le32(0x00000002)
224 struct move_dst_ipaddr
{
227 __u8 address
[16]; /* IPv4 followed by 12 bytes rsvd or IPv6 address */
230 struct share_redirect_error_context_rsp
{
231 __le32 StructureSize
;
232 __le32 NotificationType
;
233 __le32 ResourceNameOffset
;
234 __le32 ResourceNameLength
;
238 struct move_dst_ipaddr IpAddrMoveList
[];
239 /* __u8 ResourceName[] */ /* Name of share as counted Unicode string */
242 #define SMB2_CLIENT_GUID_SIZE 16
244 struct smb2_negotiate_req
{
245 struct smb2_sync_hdr sync_hdr
;
246 __le16 StructureSize
; /* Must be 36 */
249 __le16 Reserved
; /* MBZ */
251 __u8 ClientGUID
[SMB2_CLIENT_GUID_SIZE
];
252 /* In SMB3.02 and earlier next three were MBZ le64 ClientStartTime */
253 __le32 NegotiateContextOffset
; /* SMB3.1.1 only. MBZ earlier */
254 __le16 NegotiateContextCount
; /* SMB3.1.1 only. MBZ earlier */
256 __le16 Dialects
[1]; /* One dialect (vers=) at a time for now */
260 #define SMB10_PROT_ID 0x0000 /* local only, not sent on wire w/CIFS negprot */
261 #define SMB20_PROT_ID 0x0202
262 #define SMB21_PROT_ID 0x0210
263 #define SMB30_PROT_ID 0x0300
264 #define SMB302_PROT_ID 0x0302
265 #define SMB311_PROT_ID 0x0311
266 #define BAD_PROT_ID 0xFFFF
268 /* SecurityMode flags */
269 #define SMB2_NEGOTIATE_SIGNING_ENABLED 0x0001
270 #define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
271 #define SMB2_SEC_MODE_FLAGS_ALL 0x0003
273 /* Capabilities flags */
274 #define SMB2_GLOBAL_CAP_DFS 0x00000001
275 #define SMB2_GLOBAL_CAP_LEASING 0x00000002 /* Resp only New to SMB2.1 */
276 #define SMB2_GLOBAL_CAP_LARGE_MTU 0X00000004 /* Resp only New to SMB2.1 */
277 #define SMB2_GLOBAL_CAP_MULTI_CHANNEL 0x00000008 /* New to SMB3 */
278 #define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
279 #define SMB2_GLOBAL_CAP_DIRECTORY_LEASING 0x00000020 /* New to SMB3 */
280 #define SMB2_GLOBAL_CAP_ENCRYPTION 0x00000040 /* New to SMB3 */
282 #define SMB2_NT_FIND 0x00100000
283 #define SMB2_LARGE_FILES 0x00200000
286 /* Negotiate Contexts - ContextTypes. See MS-SMB2 section 2.2.3.1 for details */
287 #define SMB2_PREAUTH_INTEGRITY_CAPABILITIES cpu_to_le16(1)
288 #define SMB2_ENCRYPTION_CAPABILITIES cpu_to_le16(2)
289 #define SMB2_COMPRESSION_CAPABILITIES cpu_to_le16(3)
290 #define SMB2_NETNAME_NEGOTIATE_CONTEXT_ID cpu_to_le16(5)
291 #define SMB2_POSIX_EXTENSIONS_AVAILABLE cpu_to_le16(0x100)
293 struct smb2_neg_context
{
297 /* Followed by array of data */
300 #define SMB311_SALT_SIZE 32
301 /* Hash Algorithm Types */
302 #define SMB2_PREAUTH_INTEGRITY_SHA512 cpu_to_le16(0x0001)
303 #define SMB2_PREAUTH_HASH_SIZE 64
305 #define MIN_PREAUTH_CTXT_DATA_LEN (SMB311_SALT_SIZE + 6)
306 struct smb2_preauth_neg_context
{
307 __le16 ContextType
; /* 1 */
310 __le16 HashAlgorithmCount
; /* 1 */
312 __le16 HashAlgorithms
; /* HashAlgorithms[0] since only one defined */
313 __u8 Salt
[SMB311_SALT_SIZE
];
316 /* Encryption Algorithms Ciphers */
317 #define SMB2_ENCRYPTION_AES128_CCM cpu_to_le16(0x0001)
318 #define SMB2_ENCRYPTION_AES128_GCM cpu_to_le16(0x0002)
320 /* Min encrypt context data is one cipher so 2 bytes + 2 byte count field */
321 #define MIN_ENCRYPT_CTXT_DATA_LEN 4
322 struct smb2_encryption_neg_context
{
323 __le16 ContextType
; /* 2 */
326 __le16 CipherCount
; /* AES-128-GCM and AES-128-CCM */
330 /* See MS-SMB2 2.2.3.1.3 */
331 #define SMB3_COMPRESS_NONE cpu_to_le16(0x0000)
332 #define SMB3_COMPRESS_LZNT1 cpu_to_le16(0x0001)
333 #define SMB3_COMPRESS_LZ77 cpu_to_le16(0x0002)
334 #define SMB3_COMPRESS_LZ77_HUFF cpu_to_le16(0x0003)
335 /* Pattern scanning algorithm See MS-SMB2 3.1.4.4.1 */
336 #define SMB3_COMPRESS_PATTERN cpu_to_le16(0x0004)
338 /* Compression Flags */
339 #define SMB2_COMPRESSION_CAPABILITIES_FLAG_NONE cpu_to_le32(0x00000000)
340 #define SMB2_COMPRESSION_CAPABILITIES_FLAG_CHAINED cpu_to_le32(0x00000001)
342 struct smb2_compression_capabilities_context
{
343 __le16 ContextType
; /* 3 */
346 __le16 CompressionAlgorithmCount
;
349 __le16 CompressionAlgorithms
[3];
353 * For smb2_netname_negotiate_context_id See MS-SMB2 2.2.3.1.4.
354 * Its struct simply contains NetName, an array of Unicode characters
356 struct smb2_netname_neg_context
{
357 __le16 ContextType
; /* 0x100 */
360 __le16 NetName
[]; /* hostname of target converted to UCS-2 */
363 #define POSIX_CTXT_DATA_LEN 16
364 struct smb2_posix_neg_context
{
365 __le16 ContextType
; /* 0x100 */
368 __u8 Name
[16]; /* POSIX ctxt GUID 93AD25509CB411E7B42383DE968BCD7C */
371 struct smb2_negotiate_rsp
{
372 struct smb2_sync_hdr sync_hdr
;
373 __le16 StructureSize
; /* Must be 65 */
375 __le16 DialectRevision
;
376 __le16 NegotiateContextCount
; /* Prior to SMB3.1.1 was Reserved & MBZ */
379 __le32 MaxTransactSize
;
382 __le64 SystemTime
; /* MBZ */
383 __le64 ServerStartTime
;
384 __le16 SecurityBufferOffset
;
385 __le16 SecurityBufferLength
;
386 __le32 NegotiateContextOffset
; /* Pre:SMB3.1.1 was reserved/ignored */
387 __u8 Buffer
[1]; /* variable length GSS security buffer */
391 #define SMB2_SESSION_REQ_FLAG_BINDING 0x01
392 #define SMB2_SESSION_REQ_FLAG_ENCRYPT_DATA 0x04
394 struct smb2_sess_setup_req
{
395 struct smb2_sync_hdr sync_hdr
;
396 __le16 StructureSize
; /* Must be 25 */
401 __le16 SecurityBufferOffset
;
402 __le16 SecurityBufferLength
;
403 __u64 PreviousSessionId
;
404 __u8 Buffer
[1]; /* variable length GSS security buffer */
407 /* Currently defined SessionFlags */
408 #define SMB2_SESSION_FLAG_IS_GUEST 0x0001
409 #define SMB2_SESSION_FLAG_IS_NULL 0x0002
410 #define SMB2_SESSION_FLAG_ENCRYPT_DATA 0x0004
411 struct smb2_sess_setup_rsp
{
412 struct smb2_sync_hdr sync_hdr
;
413 __le16 StructureSize
; /* Must be 9 */
415 __le16 SecurityBufferOffset
;
416 __le16 SecurityBufferLength
;
417 __u8 Buffer
[1]; /* variable length GSS security buffer */
420 struct smb2_logoff_req
{
421 struct smb2_sync_hdr sync_hdr
;
422 __le16 StructureSize
; /* Must be 4 */
426 struct smb2_logoff_rsp
{
427 struct smb2_sync_hdr sync_hdr
;
428 __le16 StructureSize
; /* Must be 4 */
432 /* Flags/Reserved for SMB3.1.1 */
433 #define SMB2_TREE_CONNECT_FLAG_CLUSTER_RECONNECT cpu_to_le16(0x0001)
434 #define SMB2_TREE_CONNECT_FLAG_REDIRECT_TO_OWNER cpu_to_le16(0x0002)
435 #define SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT cpu_to_le16(0x0004)
437 struct smb2_tree_connect_req
{
438 struct smb2_sync_hdr sync_hdr
;
439 __le16 StructureSize
; /* Must be 9 */
440 __le16 Flags
; /* Reserved MBZ for dialects prior to SMB3.1.1 */
443 __u8 Buffer
[1]; /* variable length */
446 /* See MS-SMB2 section 2.2.9.2 */
448 #define SMB2_RESERVED_TREE_CONNECT_CONTEXT_ID 0x0000
449 #define SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID cpu_to_le16(0x0001)
451 struct tree_connect_contexts
{
458 /* Remoted identity tree connect context structures - see MS-SMB2 2.2.9.2.1 */
459 struct smb3_blob_data
{
464 /* Valid values for Attr */
465 #define SE_GROUP_MANDATORY 0x00000001
466 #define SE_GROUP_ENABLED_BY_DEFAULT 0x00000002
467 #define SE_GROUP_ENABLED 0x00000004
468 #define SE_GROUP_OWNER 0x00000008
469 #define SE_GROUP_USE_FOR_DENY_ONLY 0x00000010
470 #define SE_GROUP_INTEGRITY 0x00000020
471 #define SE_GROUP_INTEGRITY_ENABLED 0x00000040
472 #define SE_GROUP_RESOURCE 0x20000000
473 #define SE_GROUP_LOGON_ID 0xC0000000
475 /* struct sid_attr_data is SidData array in BlobData format then le32 Attr */
477 struct sid_array_data
{
479 /* SidAttrList - array of sid_attr_data structs */
482 struct luid_attr_data
{
487 * struct privilege_data is the same as BLOB_DATA - see MS-SMB2 2.2.9.2.1.5
488 * but with size of LUID_ATTR_DATA struct and BlobData set to LUID_ATTR DATA
491 struct privilege_array_data
{
492 __le16 PrivilegeCount
;
493 /* array of privilege_data structs */
496 struct remoted_identity_tcon_context
{
497 __le16 TicketType
; /* must be 0x0001 */
498 __le16 TicketSize
; /* total size of this struct */
499 __le16 User
; /* offset to SID_ATTR_DATA struct with user info */
500 __le16 UserName
; /* offset to null terminated Unicode username string */
501 __le16 Domain
; /* offset to null terminated Unicode domain name */
502 __le16 Groups
; /* offset to SID_ARRAY_DATA struct with group info */
503 __le16 RestrictedGroups
; /* similar to above */
504 __le16 Privileges
; /* offset to PRIVILEGE_ARRAY_DATA struct */
505 __le16 PrimaryGroup
; /* offset to SID_ARRAY_DATA struct */
506 __le16 Owner
; /* offset to BLOB_DATA struct */
507 __le16 DefaultDacl
; /* offset to BLOB_DATA struct */
508 __le16 DeviceGroups
; /* offset to SID_ARRAY_DATA struct */
509 __le16 UserClaims
; /* offset to BLOB_DATA struct */
510 __le16 DeviceClaims
; /* offset to BLOB_DATA struct */
511 __u8 TicketInfo
[]; /* variable length buf - remoted identity data */
514 struct smb2_tree_connect_req_extension
{
515 __le32 TreeConnectContextOffset
;
516 __le16 TreeConnectContextCount
;
518 __u8 PathName
[]; /* variable sized array */
519 /* followed by array of TreeConnectContexts */
522 struct smb2_tree_connect_rsp
{
523 struct smb2_sync_hdr sync_hdr
;
524 __le16 StructureSize
; /* Must be 16 */
525 __u8 ShareType
; /* see below */
527 __le32 ShareFlags
; /* see below */
528 __le32 Capabilities
; /* see below */
529 __le32 MaximalAccess
;
532 /* Possible ShareType values */
533 #define SMB2_SHARE_TYPE_DISK 0x01
534 #define SMB2_SHARE_TYPE_PIPE 0x02
535 #define SMB2_SHARE_TYPE_PRINT 0x03
538 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
539 * must be set (any of the remaining, SHI1005, flags may be set individually
542 #define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
543 #define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
544 #define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
545 #define SMB2_SHAREFLAG_NO_CACHING 0x00000030
546 #define SHI1005_FLAGS_DFS 0x00000001
547 #define SHI1005_FLAGS_DFS_ROOT 0x00000002
548 #define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS 0x00000100
549 #define SHI1005_FLAGS_FORCE_SHARED_DELETE 0x00000200
550 #define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING 0x00000400
551 #define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
552 #define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK 0x00001000
553 #define SHI1005_FLAGS_ENABLE_HASH_V1 0x00002000
554 #define SHI1005_FLAGS_ENABLE_HASH_V2 0x00004000
555 #define SHI1005_FLAGS_ENCRYPT_DATA 0x00008000
556 #define SMB2_SHAREFLAG_IDENTITY_REMOTING 0x00040000 /* 3.1.1 */
557 #define SHI1005_FLAGS_ALL 0x0004FF33
559 /* Possible share capabilities */
560 #define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
561 #define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
562 #define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
563 #define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
564 #define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
565 #define SMB2_SHARE_CAP_REDIRECT_TO_OWNER cpu_to_le32(0x00000100) /* 3.1.1 */
567 struct smb2_tree_disconnect_req
{
568 struct smb2_sync_hdr sync_hdr
;
569 __le16 StructureSize
; /* Must be 4 */
573 struct smb2_tree_disconnect_rsp
{
574 struct smb2_sync_hdr sync_hdr
;
575 __le16 StructureSize
; /* Must be 4 */
579 /* File Attrubutes */
580 #define FILE_ATTRIBUTE_READONLY 0x00000001
581 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
582 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
583 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
584 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
585 #define FILE_ATTRIBUTE_NORMAL 0x00000080
586 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
587 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
588 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
589 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
590 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
591 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
592 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
593 #define FILE_ATTRIBUTE_INTEGRITY_STREAM 0x00008000
594 #define FILE_ATTRIBUTE_NO_SCRUB_DATA 0x00020000
597 #define SMB2_OPLOCK_LEVEL_NONE 0x00
598 #define SMB2_OPLOCK_LEVEL_II 0x01
599 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE 0x08
600 #define SMB2_OPLOCK_LEVEL_BATCH 0x09
601 #define SMB2_OPLOCK_LEVEL_LEASE 0xFF
602 /* Non-spec internal type */
603 #define SMB2_OPLOCK_LEVEL_NOCHANGE 0x99
605 /* Desired Access Flags */
606 #define FILE_READ_DATA_LE cpu_to_le32(0x00000001)
607 #define FILE_WRITE_DATA_LE cpu_to_le32(0x00000002)
608 #define FILE_APPEND_DATA_LE cpu_to_le32(0x00000004)
609 #define FILE_READ_EA_LE cpu_to_le32(0x00000008)
610 #define FILE_WRITE_EA_LE cpu_to_le32(0x00000010)
611 #define FILE_EXECUTE_LE cpu_to_le32(0x00000020)
612 #define FILE_READ_ATTRIBUTES_LE cpu_to_le32(0x00000080)
613 #define FILE_WRITE_ATTRIBUTES_LE cpu_to_le32(0x00000100)
614 #define FILE_DELETE_LE cpu_to_le32(0x00010000)
615 #define FILE_READ_CONTROL_LE cpu_to_le32(0x00020000)
616 #define FILE_WRITE_DAC_LE cpu_to_le32(0x00040000)
617 #define FILE_WRITE_OWNER_LE cpu_to_le32(0x00080000)
618 #define FILE_SYNCHRONIZE_LE cpu_to_le32(0x00100000)
619 #define FILE_ACCESS_SYSTEM_SECURITY_LE cpu_to_le32(0x01000000)
620 #define FILE_MAXIMAL_ACCESS_LE cpu_to_le32(0x02000000)
621 #define FILE_GENERIC_ALL_LE cpu_to_le32(0x10000000)
622 #define FILE_GENERIC_EXECUTE_LE cpu_to_le32(0x20000000)
623 #define FILE_GENERIC_WRITE_LE cpu_to_le32(0x40000000)
624 #define FILE_GENERIC_READ_LE cpu_to_le32(0x80000000)
626 /* ShareAccess Flags */
627 #define FILE_SHARE_READ_LE cpu_to_le32(0x00000001)
628 #define FILE_SHARE_WRITE_LE cpu_to_le32(0x00000002)
629 #define FILE_SHARE_DELETE_LE cpu_to_le32(0x00000004)
630 #define FILE_SHARE_ALL_LE cpu_to_le32(0x00000007)
632 /* CreateDisposition Flags */
633 #define FILE_SUPERSEDE_LE cpu_to_le32(0x00000000)
634 #define FILE_OPEN_LE cpu_to_le32(0x00000001)
635 #define FILE_CREATE_LE cpu_to_le32(0x00000002)
636 #define FILE_OPEN_IF_LE cpu_to_le32(0x00000003)
637 #define FILE_OVERWRITE_LE cpu_to_le32(0x00000004)
638 #define FILE_OVERWRITE_IF_LE cpu_to_le32(0x00000005)
640 /* CreateOptions Flags */
641 #define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
642 /* same as #define CREATE_NOT_FILE_LE cpu_to_le32(0x00000001) */
643 #define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
644 #define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
645 #define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
646 #define FILE_SYNCHRONOUS_IO_ALERT_LE cpu_to_le32(0x00000010)
647 #define FILE_SYNCHRONOUS_IO_NON_ALERT_LE cpu_to_le32(0x00000020)
648 #define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
649 #define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
650 #define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
651 #define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
652 #define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000)
653 #define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
654 #define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
655 #define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
656 #define FILE_RESERVE_OPFILTER_LE cpu_to_le32(0x00100000)
657 #define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
658 #define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
659 #define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
661 #define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
662 | FILE_READ_ATTRIBUTES_LE)
663 #define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
664 | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
665 #define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
667 /* Impersonation Levels. See MS-WPO section 9.7 and MSDN-IMPERS */
668 #define IL_ANONYMOUS cpu_to_le32(0x00000000)
669 #define IL_IDENTIFICATION cpu_to_le32(0x00000001)
670 #define IL_IMPERSONATION cpu_to_le32(0x00000002)
671 #define IL_DELEGATE cpu_to_le32(0x00000003)
673 /* Create Context Values */
674 #define SMB2_CREATE_EA_BUFFER "ExtA" /* extended attributes */
675 #define SMB2_CREATE_SD_BUFFER "SecD" /* security descriptor */
676 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST "DHnQ"
677 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT "DHnC"
678 #define SMB2_CREATE_ALLOCATION_SIZE "AISi"
679 #define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
680 #define SMB2_CREATE_TIMEWARP_REQUEST "TWrp"
681 #define SMB2_CREATE_QUERY_ON_DISK_ID "QFid"
682 #define SMB2_CREATE_REQUEST_LEASE "RqLs"
683 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST_V2 "DH2Q"
684 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT_V2 "DH2C"
685 #define SMB2_CREATE_APP_INSTANCE_ID 0x45BCA66AEFA7F74A9008FA462E144D74
686 #define SMB2_CREATE_APP_INSTANCE_VERSION 0xB982D0B73B56074FA07B524A8116A010
687 #define SVHDX_OPEN_DEVICE_CONTEX 0x9CCBCF9E04C1E643980E158DA1F6EC83
688 #define SMB2_CREATE_TAG_POSIX 0x93AD25509CB411E7B42383DE968BCD7C
690 /* Flag (SMB3 open response) values */
691 #define SMB2_CREATE_FLAG_REPARSEPOINT 0x01
694 * Maximum number of iovs we need for an open/create request.
695 * [0] : struct smb2_create_req
697 * [2] : lease context
698 * [3] : durable context
699 * [4] : posix context
700 * [5] : time warp context
701 * [6] : query id context
702 * [7] : compound padding
704 #define SMB2_CREATE_IOV_SIZE 8
706 struct smb2_create_req
{
707 struct smb2_sync_hdr sync_hdr
;
708 __le16 StructureSize
; /* Must be 57 */
710 __u8 RequestedOplockLevel
;
711 __le32 ImpersonationLevel
;
712 __le64 SmbCreateFlags
;
714 __le32 DesiredAccess
;
715 __le32 FileAttributes
;
717 __le32 CreateDisposition
;
718 __le32 CreateOptions
;
721 __le32 CreateContextsOffset
;
722 __le32 CreateContextsLength
;
727 * Maximum size of a SMB2_CREATE response is 64 (smb2 header) +
728 * 88 (fixed part of create response) + 520 (path) + 208 (contexts) +
729 * 2 bytes of padding.
731 #define MAX_SMB2_CREATE_RESPONSE_SIZE 880
733 struct smb2_create_rsp
{
734 struct smb2_sync_hdr sync_hdr
;
735 __le16 StructureSize
; /* Must be 89 */
737 __u8 Flag
; /* 0x01 if reparse point */
740 __le64 LastAccessTime
;
741 __le64 LastWriteTime
;
743 __le64 AllocationSize
;
745 __le32 FileAttributes
;
747 __u64 PersistentFileId
; /* opaque endianness */
748 __u64 VolatileFileId
; /* opaque endianness */
749 __le32 CreateContextsOffset
;
750 __le32 CreateContextsLength
;
754 struct create_context
{
764 #define SMB2_LEASE_READ_CACHING_HE 0x01
765 #define SMB2_LEASE_HANDLE_CACHING_HE 0x02
766 #define SMB2_LEASE_WRITE_CACHING_HE 0x04
768 #define SMB2_LEASE_NONE cpu_to_le32(0x00)
769 #define SMB2_LEASE_READ_CACHING cpu_to_le32(0x01)
770 #define SMB2_LEASE_HANDLE_CACHING cpu_to_le32(0x02)
771 #define SMB2_LEASE_WRITE_CACHING cpu_to_le32(0x04)
773 #define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS cpu_to_le32(0x00000002)
774 #define SMB2_LEASE_FLAG_PARENT_LEASE_KEY_SET cpu_to_le32(0x00000004)
776 #define SMB2_LEASE_KEY_SIZE 16
778 struct lease_context
{
779 u8 LeaseKey
[SMB2_LEASE_KEY_SIZE
];
782 __le64 LeaseDuration
;
785 struct lease_context_v2
{
786 u8 LeaseKey
[SMB2_LEASE_KEY_SIZE
];
789 __le64 LeaseDuration
;
790 __le64 ParentLeaseKeyLow
;
791 __le64 ParentLeaseKeyHigh
;
796 struct create_lease
{
797 struct create_context ccontext
;
799 struct lease_context lcontext
;
802 struct create_lease_v2
{
803 struct create_context ccontext
;
805 struct lease_context_v2 lcontext
;
809 struct create_durable
{
810 struct create_context ccontext
;
815 __u64 PersistentFileId
;
816 __u64 VolatileFileId
;
821 struct create_posix
{
822 struct create_context ccontext
;
828 /* See MS-SMB2 2.2.13.2.11 */
830 #define SMB2_DHANDLE_FLAG_PERSISTENT 0x00000002
831 struct durable_context_v2
{
838 struct create_durable_v2
{
839 struct create_context ccontext
;
841 struct durable_context_v2 dcontext
;
844 /* See MS-SMB2 2.2.13.2.12 */
845 struct durable_reconnect_context_v2
{
847 __u64 PersistentFileId
;
848 __u64 VolatileFileId
;
851 __le32 Flags
; /* see above DHANDLE_FLAG_PERSISTENT */
854 /* See MS-SMB2 2.2.14.2.9 */
855 struct create_on_disk_id
{
856 struct create_context ccontext
;
863 /* See MS-SMB2 2.2.14.2.12 */
864 struct durable_reconnect_context_v2_rsp
{
866 __le32 Flags
; /* see above DHANDLE_FLAG_PERSISTENT */
869 struct create_durable_handle_reconnect_v2
{
870 struct create_context ccontext
;
872 struct durable_reconnect_context_v2 dcontext
;
876 /* See MS-SMB2 2.2.13.2.5 */
877 struct crt_twarp_ctxt
{
878 struct create_context ccontext
;
884 /* See MS-SMB2 2.2.13.2.9 */
885 struct crt_query_id_ctxt
{
886 struct create_context ccontext
;
891 struct create_context ccontext
;
895 /* Followed by at least 4 ACEs */
899 #define COPY_CHUNK_RES_KEY_SIZE 24
900 struct resume_key_req
{
901 char ResumeKey
[COPY_CHUNK_RES_KEY_SIZE
];
902 __le32 ContextLength
; /* MBZ */
903 char Context
[]; /* ignored, Windows sets to 4 bytes of zero */
906 /* this goes in the ioctl buffer when doing a copychunk request */
907 struct copychunk_ioctl
{
908 char SourceKey
[COPY_CHUNK_RES_KEY_SIZE
];
909 __le32 ChunkCount
; /* we are only sending 1 */
911 /* array will only be one chunk long for us */
914 __le32 Length
; /* how many bytes to copy */
918 /* this goes in the ioctl buffer when doing FSCTL_SET_ZERO_DATA */
919 struct file_zero_data_information
{
921 __le64 BeyondFinalZero
;
924 struct copychunk_ioctl_rsp
{
925 __le32 ChunksWritten
;
926 __le32 ChunkBytesWritten
;
927 __le32 TotalBytesWritten
;
930 struct fsctl_set_integrity_information_req
{
931 __le16 ChecksumAlgorithm
;
936 struct fsctl_get_integrity_information_rsp
{
937 __le16 ChecksumAlgorithm
;
940 __le32 ChecksumChunkSizeInBytes
;
941 __le32 ClusterSizeInBytes
;
944 struct file_allocated_range_buffer
{
949 /* Integrity ChecksumAlgorithm choices for above */
950 #define CHECKSUM_TYPE_NONE 0x0000
951 #define CHECKSUM_TYPE_CRC64 0x0002
952 #define CHECKSUM_TYPE_UNCHANGED 0xFFFF /* set only */
954 /* Integrity flags for above */
955 #define FSCTL_INTEGRITY_FLAG_CHECKSUM_ENFORCEMENT_OFF 0x00000001
957 /* Reparse structures - see MS-FSCC 2.1.2 */
959 /* struct fsctl_reparse_info_req is empty, only response structs (see below) */
961 struct reparse_data_buffer
{
963 __le16 ReparseDataLength
;
965 __u8 DataBuffer
[]; /* Variable Length */
968 struct reparse_guid_data_buffer
{
970 __le16 ReparseDataLength
;
972 __u8 ReparseGuid
[16];
973 __u8 DataBuffer
[]; /* Variable Length */
976 struct reparse_mount_point_data_buffer
{
978 __le16 ReparseDataLength
;
980 __le16 SubstituteNameOffset
;
981 __le16 SubstituteNameLength
;
982 __le16 PrintNameOffset
;
983 __le16 PrintNameLength
;
984 __u8 PathBuffer
[]; /* Variable Length */
987 #define SYMLINK_FLAG_RELATIVE 0x00000001
989 struct reparse_symlink_data_buffer
{
991 __le16 ReparseDataLength
;
993 __le16 SubstituteNameOffset
;
994 __le16 SubstituteNameLength
;
995 __le16 PrintNameOffset
;
996 __le16 PrintNameLength
;
998 __u8 PathBuffer
[]; /* Variable Length */
1001 /* See MS-FSCC 2.1.2.6 and cifspdu.h for struct reparse_posix_data */
1004 /* See MS-DFSC 2.2.2 */
1005 struct fsctl_get_dfs_referral_req
{
1006 __le16 MaxReferralLevel
;
1007 __u8 RequestFileName
[];
1010 /* DFS response is struct get_dfs_refer_rsp */
1012 /* See MS-SMB2 2.2.31.3 */
1013 struct network_resiliency_req
{
1017 /* There is no buffer for the response ie no struct network_resiliency_rsp */
1020 struct validate_negotiate_info_req
{
1021 __le32 Capabilities
;
1022 __u8 Guid
[SMB2_CLIENT_GUID_SIZE
];
1023 __le16 SecurityMode
;
1024 __le16 DialectCount
;
1025 __le16 Dialects
[4]; /* BB expand this if autonegotiate > 4 dialects */
1028 struct validate_negotiate_info_rsp
{
1029 __le32 Capabilities
;
1030 __u8 Guid
[SMB2_CLIENT_GUID_SIZE
];
1031 __le16 SecurityMode
;
1032 __le16 Dialect
; /* Dialect in use for the connection */
1035 #define RSS_CAPABLE cpu_to_le32(0x00000001)
1036 #define RDMA_CAPABLE cpu_to_le32(0x00000002)
1038 #define INTERNETWORK cpu_to_le16(0x0002)
1039 #define INTERNETWORKV6 cpu_to_le16(0x0017)
1041 struct network_interface_info_ioctl_rsp
{
1042 __le32 Next
; /* next interface. zero if this is last one */
1044 __le32 Capability
; /* RSS or RDMA Capable */
1051 struct iface_info_ipv4
{
1057 struct iface_info_ipv6
{
1060 __u8 IPv6Address
[16];
1064 #define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
1066 struct compress_ioctl
{
1067 __le16 CompressionState
; /* See cifspdu.h for possible flag values */
1070 struct duplicate_extents_to_file
{
1071 __u64 PersistentFileHandle
; /* source file handle, opaque endianness */
1072 __u64 VolatileFileHandle
;
1073 __le64 SourceFileOffset
;
1074 __le64 TargetFileOffset
;
1075 __le64 ByteCount
; /* Bytes to be copied */
1079 * Maximum number of iovs we need for an ioctl request.
1080 * [0] : struct smb2_ioctl_req
1083 #define SMB2_IOCTL_IOV_SIZE 2
1085 struct smb2_ioctl_req
{
1086 struct smb2_sync_hdr sync_hdr
;
1087 __le16 StructureSize
; /* Must be 57 */
1090 __u64 PersistentFileId
; /* opaque endianness */
1091 __u64 VolatileFileId
; /* opaque endianness */
1094 __le32 MaxInputResponse
;
1095 __le32 OutputOffset
;
1097 __le32 MaxOutputResponse
;
1103 struct smb2_ioctl_rsp
{
1104 struct smb2_sync_hdr sync_hdr
;
1105 __le16 StructureSize
; /* Must be 57 */
1108 __u64 PersistentFileId
; /* opaque endianness */
1109 __u64 VolatileFileId
; /* opaque endianness */
1112 __le32 OutputOffset
;
1116 /* char * buffer[] */
1119 /* Currently defined values for close flags */
1120 #define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
1121 struct smb2_close_req
{
1122 struct smb2_sync_hdr sync_hdr
;
1123 __le16 StructureSize
; /* Must be 24 */
1126 __u64 PersistentFileId
; /* opaque endianness */
1127 __u64 VolatileFileId
; /* opaque endianness */
1131 * Maximum size of a SMB2_CLOSE response is 64 (smb2 header) + 60 (data)
1133 #define MAX_SMB2_CLOSE_RESPONSE_SIZE 124
1135 struct smb2_close_rsp
{
1136 struct smb2_sync_hdr sync_hdr
;
1137 __le16 StructureSize
; /* 60 */
1140 __le64 CreationTime
;
1141 __le64 LastAccessTime
;
1142 __le64 LastWriteTime
;
1144 __le64 AllocationSize
; /* Beginning of FILE_STANDARD_INFO equivalent */
1149 struct smb2_flush_req
{
1150 struct smb2_sync_hdr sync_hdr
;
1151 __le16 StructureSize
; /* Must be 24 */
1154 __u64 PersistentFileId
; /* opaque endianness */
1155 __u64 VolatileFileId
; /* opaque endianness */
1158 struct smb2_flush_rsp
{
1159 struct smb2_sync_hdr sync_hdr
;
1160 __le16 StructureSize
;
1164 /* For read request Flags field below, following flag is defined for SMB3.02 */
1165 #define SMB2_READFLAG_READ_UNBUFFERED 0x01
1166 #define SMB2_READFLAG_REQUEST_COMPRESSED 0x02 /* See MS-SMB2 2.2.19 */
1168 /* Channel field for read and write: exactly one of following flags can be set*/
1169 #define SMB2_CHANNEL_NONE cpu_to_le32(0x00000000)
1170 #define SMB2_CHANNEL_RDMA_V1 cpu_to_le32(0x00000001) /* SMB3 or later */
1171 #define SMB2_CHANNEL_RDMA_V1_INVALIDATE cpu_to_le32(0x00000002) /* >= SMB3.02 */
1173 /* SMB2 read request without RFC1001 length at the beginning */
1174 struct smb2_read_plain_req
{
1175 struct smb2_sync_hdr sync_hdr
;
1176 __le16 StructureSize
; /* Must be 49 */
1177 __u8 Padding
; /* offset from start of SMB2 header to place read */
1178 __u8 Flags
; /* MBZ unless SMB3.02 or later */
1181 __u64 PersistentFileId
; /* opaque endianness */
1182 __u64 VolatileFileId
; /* opaque endianness */
1183 __le32 MinimumCount
;
1184 __le32 Channel
; /* MBZ except for SMB3 or later */
1185 __le32 RemainingBytes
;
1186 __le16 ReadChannelInfoOffset
;
1187 __le16 ReadChannelInfoLength
;
1191 struct smb2_read_rsp
{
1192 struct smb2_sync_hdr sync_hdr
;
1193 __le16 StructureSize
; /* Must be 17 */
1197 __le32 DataRemaining
;
1202 /* For write request Flags field below the following flags are defined: */
1203 #define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
1204 #define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
1206 struct smb2_write_req
{
1207 struct smb2_sync_hdr sync_hdr
;
1208 __le16 StructureSize
; /* Must be 49 */
1209 __le16 DataOffset
; /* offset from start of SMB2 header to write data */
1212 __u64 PersistentFileId
; /* opaque endianness */
1213 __u64 VolatileFileId
; /* opaque endianness */
1214 __le32 Channel
; /* MBZ unless SMB3.02 or later */
1215 __le32 RemainingBytes
;
1216 __le16 WriteChannelInfoOffset
;
1217 __le16 WriteChannelInfoLength
;
1222 struct smb2_write_rsp
{
1223 struct smb2_sync_hdr sync_hdr
;
1224 __le16 StructureSize
; /* Must be 17 */
1228 __le32 DataRemaining
;
1234 #define SMB2_WATCH_TREE 0x0001
1236 /* notify completion filter flags. See MS-FSCC 2.6 and MS-SMB2 2.2.35 */
1237 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x00000001
1238 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x00000002
1239 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x00000004
1240 #define FILE_NOTIFY_CHANGE_SIZE 0x00000008
1241 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x00000010
1242 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x00000020
1243 #define FILE_NOTIFY_CHANGE_CREATION 0x00000040
1244 #define FILE_NOTIFY_CHANGE_EA 0x00000080
1245 #define FILE_NOTIFY_CHANGE_SECURITY 0x00000100
1246 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1247 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1248 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1250 struct smb2_change_notify_req
{
1251 struct smb2_sync_hdr sync_hdr
;
1252 __le16 StructureSize
;
1254 __le32 OutputBufferLength
;
1255 __u64 PersistentFileId
; /* opaque endianness */
1256 __u64 VolatileFileId
; /* opaque endianness */
1257 __le32 CompletionFilter
;
1261 struct smb2_change_notify_rsp
{
1262 struct smb2_sync_hdr sync_hdr
;
1263 __le16 StructureSize
; /* Must be 9 */
1264 __le16 OutputBufferOffset
;
1265 __le32 OutputBufferLength
;
1266 __u8 Buffer
[1]; /* array of file notify structs */
1269 #define SMB2_LOCKFLAG_SHARED_LOCK 0x0001
1270 #define SMB2_LOCKFLAG_EXCLUSIVE_LOCK 0x0002
1271 #define SMB2_LOCKFLAG_UNLOCK 0x0004
1272 #define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
1274 struct smb2_lock_element
{
1281 struct smb2_lock_req
{
1282 struct smb2_sync_hdr sync_hdr
;
1283 __le16 StructureSize
; /* Must be 48 */
1286 __u64 PersistentFileId
; /* opaque endianness */
1287 __u64 VolatileFileId
; /* opaque endianness */
1288 /* Followed by at least one */
1289 struct smb2_lock_element locks
[1];
1292 struct smb2_lock_rsp
{
1293 struct smb2_sync_hdr sync_hdr
;
1294 __le16 StructureSize
; /* Must be 4 */
1298 struct smb2_echo_req
{
1299 struct smb2_sync_hdr sync_hdr
;
1300 __le16 StructureSize
; /* Must be 4 */
1304 struct smb2_echo_rsp
{
1305 struct smb2_sync_hdr sync_hdr
;
1306 __le16 StructureSize
; /* Must be 4 */
1310 /* search (query_directory) Flags field */
1311 #define SMB2_RESTART_SCANS 0x01
1312 #define SMB2_RETURN_SINGLE_ENTRY 0x02
1313 #define SMB2_INDEX_SPECIFIED 0x04
1314 #define SMB2_REOPEN 0x10
1316 #define SMB2_QUERY_DIRECTORY_IOV_SIZE 2
1318 struct smb2_query_directory_req
{
1319 struct smb2_sync_hdr sync_hdr
;
1320 __le16 StructureSize
; /* Must be 33 */
1321 __u8 FileInformationClass
;
1324 __u64 PersistentFileId
; /* opaque endianness */
1325 __u64 VolatileFileId
; /* opaque endianness */
1326 __le16 FileNameOffset
;
1327 __le16 FileNameLength
;
1328 __le32 OutputBufferLength
;
1332 struct smb2_query_directory_rsp
{
1333 struct smb2_sync_hdr sync_hdr
;
1334 __le16 StructureSize
; /* Must be 9 */
1335 __le16 OutputBufferOffset
;
1336 __le32 OutputBufferLength
;
1340 /* Possible InfoType values */
1341 #define SMB2_O_INFO_FILE 0x01
1342 #define SMB2_O_INFO_FILESYSTEM 0x02
1343 #define SMB2_O_INFO_SECURITY 0x03
1344 #define SMB2_O_INFO_QUOTA 0x04
1346 /* Security info type additionalinfo flags. See MS-SMB2 (2.2.37) or MS-DTYP */
1347 #define OWNER_SECINFO 0x00000001
1348 #define GROUP_SECINFO 0x00000002
1349 #define DACL_SECINFO 0x00000004
1350 #define SACL_SECINFO 0x00000008
1351 #define LABEL_SECINFO 0x00000010
1352 #define ATTRIBUTE_SECINFO 0x00000020
1353 #define SCOPE_SECINFO 0x00000040
1354 #define BACKUP_SECINFO 0x00010000
1355 #define UNPROTECTED_SACL_SECINFO 0x10000000
1356 #define UNPROTECTED_DACL_SECINFO 0x20000000
1357 #define PROTECTED_SACL_SECINFO 0x40000000
1358 #define PROTECTED_DACL_SECINFO 0x80000000
1360 /* Flags used for FileFullEAinfo */
1361 #define SL_RESTART_SCAN 0x00000001
1362 #define SL_RETURN_SINGLE_ENTRY 0x00000002
1363 #define SL_INDEX_SPECIFIED 0x00000004
1365 struct smb2_query_info_req
{
1366 struct smb2_sync_hdr sync_hdr
;
1367 __le16 StructureSize
; /* Must be 41 */
1370 __le32 OutputBufferLength
;
1371 __le16 InputBufferOffset
;
1373 __le32 InputBufferLength
;
1374 __le32 AdditionalInformation
;
1376 __u64 PersistentFileId
; /* opaque endianness */
1377 __u64 VolatileFileId
; /* opaque endianness */
1381 struct smb2_query_info_rsp
{
1382 struct smb2_sync_hdr sync_hdr
;
1383 __le16 StructureSize
; /* Must be 9 */
1384 __le16 OutputBufferOffset
;
1385 __le32 OutputBufferLength
;
1390 * Maximum number of iovs we need for a set-info request.
1391 * The largest one is rename/hardlink
1392 * [0] : struct smb2_set_info_req + smb2_file_[rename|link]_info
1394 * [2] : compound padding
1396 #define SMB2_SET_INFO_IOV_SIZE 3
1398 struct smb2_set_info_req
{
1399 struct smb2_sync_hdr sync_hdr
;
1400 __le16 StructureSize
; /* Must be 33 */
1403 __le32 BufferLength
;
1404 __le16 BufferOffset
;
1406 __le32 AdditionalInformation
;
1407 __u64 PersistentFileId
; /* opaque endianness */
1408 __u64 VolatileFileId
; /* opaque endianness */
1412 struct smb2_set_info_rsp
{
1413 struct smb2_sync_hdr sync_hdr
;
1414 __le16 StructureSize
; /* Must be 2 */
1417 struct smb2_oplock_break
{
1418 struct smb2_sync_hdr sync_hdr
;
1419 __le16 StructureSize
; /* Must be 24 */
1423 __u64 PersistentFid
;
1427 #define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
1429 struct smb2_lease_break
{
1430 struct smb2_sync_hdr sync_hdr
;
1431 __le16 StructureSize
; /* Must be 44 */
1435 __le32 CurrentLeaseState
;
1436 __le32 NewLeaseState
;
1438 __le32 AccessMaskHint
;
1439 __le32 ShareMaskHint
;
1442 struct smb2_lease_ack
{
1443 struct smb2_sync_hdr sync_hdr
;
1444 __le16 StructureSize
; /* Must be 36 */
1449 __le64 LeaseDuration
;
1453 * PDU infolevel structure definitions
1454 * BB consider moving to a different header
1457 /* File System Information Classes */
1458 #define FS_VOLUME_INFORMATION 1 /* Query */
1459 #define FS_LABEL_INFORMATION 2 /* Local only */
1460 #define FS_SIZE_INFORMATION 3 /* Query */
1461 #define FS_DEVICE_INFORMATION 4 /* Query */
1462 #define FS_ATTRIBUTE_INFORMATION 5 /* Query */
1463 #define FS_CONTROL_INFORMATION 6 /* Query, Set */
1464 #define FS_FULL_SIZE_INFORMATION 7 /* Query */
1465 #define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
1466 #define FS_DRIVER_PATH_INFORMATION 9 /* Local only */
1467 #define FS_VOLUME_FLAGS_INFORMATION 10 /* Local only */
1468 #define FS_SECTOR_SIZE_INFORMATION 11 /* SMB3 or later. Query */
1469 #define FS_POSIX_INFORMATION 100 /* SMB3.1.1 POSIX. Query */
1471 struct smb2_fs_full_size_info
{
1472 __le64 TotalAllocationUnits
;
1473 __le64 CallerAvailableAllocationUnits
;
1474 __le64 ActualAvailableAllocationUnits
;
1475 __le32 SectorsPerAllocationUnit
;
1476 __le32 BytesPerSector
;
1479 #define SSINFO_FLAGS_ALIGNED_DEVICE 0x00000001
1480 #define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
1481 #define SSINFO_FLAGS_NO_SEEK_PENALTY 0x00000004
1482 #define SSINFO_FLAGS_TRIM_ENABLED 0x00000008
1484 /* sector size info struct */
1485 struct smb3_fs_ss_info
{
1486 __le32 LogicalBytesPerSector
;
1487 __le32 PhysicalBytesPerSectorForAtomicity
;
1488 __le32 PhysicalBytesPerSectorForPerf
;
1489 __le32 FileSystemEffectivePhysicalBytesPerSectorForAtomicity
;
1491 __le32 ByteOffsetForSectorAlignment
;
1492 __le32 ByteOffsetForPartitionAlignment
;
1495 /* volume info struct - see MS-FSCC 2.5.9 */
1496 #define MAX_VOL_LABEL_LEN 32
1497 struct smb3_fs_vol_info
{
1498 __le64 VolumeCreationTime
;
1499 __u32 VolumeSerialNumber
;
1500 __le32 VolumeLabelLength
; /* includes trailing null */
1501 __u8 SupportsObjects
; /* True if eg like NTFS, supports objects */
1503 __u8 VolumeLabel
[]; /* variable len */
1506 /* partial list of QUERY INFO levels */
1507 #define FILE_DIRECTORY_INFORMATION 1
1508 #define FILE_FULL_DIRECTORY_INFORMATION 2
1509 #define FILE_BOTH_DIRECTORY_INFORMATION 3
1510 #define FILE_BASIC_INFORMATION 4
1511 #define FILE_STANDARD_INFORMATION 5
1512 #define FILE_INTERNAL_INFORMATION 6
1513 #define FILE_EA_INFORMATION 7
1514 #define FILE_ACCESS_INFORMATION 8
1515 #define FILE_NAME_INFORMATION 9
1516 #define FILE_RENAME_INFORMATION 10
1517 #define FILE_LINK_INFORMATION 11
1518 #define FILE_NAMES_INFORMATION 12
1519 #define FILE_DISPOSITION_INFORMATION 13
1520 #define FILE_POSITION_INFORMATION 14
1521 #define FILE_FULL_EA_INFORMATION 15
1522 #define FILE_MODE_INFORMATION 16
1523 #define FILE_ALIGNMENT_INFORMATION 17
1524 #define FILE_ALL_INFORMATION 18
1525 #define FILE_ALLOCATION_INFORMATION 19
1526 #define FILE_END_OF_FILE_INFORMATION 20
1527 #define FILE_ALTERNATE_NAME_INFORMATION 21
1528 #define FILE_STREAM_INFORMATION 22
1529 #define FILE_PIPE_INFORMATION 23
1530 #define FILE_PIPE_LOCAL_INFORMATION 24
1531 #define FILE_PIPE_REMOTE_INFORMATION 25
1532 #define FILE_MAILSLOT_QUERY_INFORMATION 26
1533 #define FILE_MAILSLOT_SET_INFORMATION 27
1534 #define FILE_COMPRESSION_INFORMATION 28
1535 #define FILE_OBJECT_ID_INFORMATION 29
1536 /* Number 30 not defined in documents */
1537 #define FILE_MOVE_CLUSTER_INFORMATION 31
1538 #define FILE_QUOTA_INFORMATION 32
1539 #define FILE_REPARSE_POINT_INFORMATION 33
1540 #define FILE_NETWORK_OPEN_INFORMATION 34
1541 #define FILE_ATTRIBUTE_TAG_INFORMATION 35
1542 #define FILE_TRACKING_INFORMATION 36
1543 #define FILEID_BOTH_DIRECTORY_INFORMATION 37
1544 #define FILEID_FULL_DIRECTORY_INFORMATION 38
1545 #define FILE_VALID_DATA_LENGTH_INFORMATION 39
1546 #define FILE_SHORT_NAME_INFORMATION 40
1547 #define FILE_SFIO_RESERVE_INFORMATION 44
1548 #define FILE_SFIO_VOLUME_INFORMATION 45
1549 #define FILE_HARD_LINK_INFORMATION 46
1550 #define FILE_NORMALIZED_NAME_INFORMATION 48
1551 #define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
1552 #define FILE_STANDARD_LINK_INFORMATION 54
1553 #define FILE_ID_INFORMATION 59
1555 struct smb2_file_internal_info
{
1557 } __packed
; /* level 6 Query */
1559 struct smb2_file_rename_info
{ /* encoding of request for level 10 */
1560 __u8 ReplaceIfExists
; /* 1 = replace existing target with new */
1561 /* 0 = fail if target already exists */
1563 __u64 RootDirectory
; /* MBZ for network operations (why says spec?) */
1564 __le32 FileNameLength
;
1565 char FileName
[]; /* New name to be assigned */
1566 } __packed
; /* level 10 Set */
1568 struct smb2_file_link_info
{ /* encoding of request for level 11 */
1569 __u8 ReplaceIfExists
; /* 1 = replace existing link with new */
1570 /* 0 = fail if link already exists */
1572 __u64 RootDirectory
; /* MBZ for network operations (why says spec?) */
1573 __le32 FileNameLength
;
1574 char FileName
[]; /* Name to be assigned to new link */
1575 } __packed
; /* level 11 Set */
1577 struct smb2_file_full_ea_info
{ /* encoding of response for level 15 */
1578 __le32 next_entry_offset
;
1580 __u8 ea_name_length
;
1581 __le16 ea_value_length
;
1582 char ea_data
[]; /* \0 terminated name plus value */
1583 } __packed
; /* level 15 Set */
1586 * This level 18, although with struct with same name is different from cifs
1587 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
1588 * CurrentByteOffset.
1590 struct smb2_file_all_info
{ /* data block encoding of response to level 18 */
1591 __le64 CreationTime
; /* Beginning of FILE_BASIC_INFO equivalent */
1592 __le64 LastAccessTime
;
1593 __le64 LastWriteTime
;
1596 __u32 Pad1
; /* End of FILE_BASIC_INFO_INFO equivalent */
1597 __le64 AllocationSize
; /* Beginning of FILE_STANDARD_INFO equivalent */
1598 __le64 EndOfFile
; /* size ie offset to first free byte in file */
1599 __le32 NumberOfLinks
; /* hard links */
1602 __u16 Pad2
; /* End of FILE_STANDARD_INFO equivalent */
1606 __le64 CurrentByteOffset
;
1608 __le32 AlignmentRequirement
;
1609 __le32 FileNameLength
;
1611 } __packed
; /* level 18 Query */
1613 struct smb2_file_eof_info
{ /* encoding of request for level 10 */
1614 __le64 EndOfFile
; /* new end of file value */
1615 } __packed
; /* level 20 Set */
1617 struct smb2_file_network_open_info
{
1618 __le64 CreationTime
;
1619 __le64 LastAccessTime
;
1620 __le64 LastWriteTime
;
1622 __le64 AllocationSize
;
1626 } __packed
; /* level 34 Query also similar returned in close rsp and open rsp */
1628 /* See MS-FSCC 2.4.43 */
1629 struct smb2_file_id_information
{
1630 __le64 VolumeSerialNumber
;
1631 __u64 PersistentFileId
; /* opaque endianness */
1632 __u64 VolatileFileId
; /* opaque endianness */
1633 } __packed
; /* level 59 */
1635 extern char smb2_padding
[7];
1637 /* equivalent of the contents of SMB3.1.1 POSIX open context response */
1638 struct create_posix_rsp
{
1642 struct cifs_sid owner
; /* var-sized on the wire */
1643 struct cifs_sid group
; /* var-sized on the wire */
1647 * SMB2-only POSIX info level
1649 * See posix_info_sid_size(), posix_info_extra_size() and
1650 * posix_info_parse() to help with the handling of this struct.
1652 struct smb2_posix_info
{
1653 __le32 NextEntryOffset
;
1655 __le64 CreationTime
;
1656 __le64 LastAccessTime
;
1657 __le64 LastWriteTime
;
1660 __le64 AllocationSize
;
1661 __le32 DosAttributes
;
1665 /* beginning of POSIX Create Context Response */
1670 * var sized owner SID
1671 * var sized group SID
1672 * le32 filenamelength
1678 * Parsed version of the above struct. Allows direct access to the
1679 * variable length fields
1681 struct smb2_posix_info_parsed
{
1682 const struct smb2_posix_info
*base
;
1684 struct cifs_sid owner
;
1685 struct cifs_sid group
;
1690 #endif /* _SMB2PDU_H */