1 /* SPDX-License-Identifier: LGPL-2.1 */
2 #ifndef _COMMON_SMB2PDU_H
3 #define _COMMON_SMB2PDU_H
6 * Note that, due to trying to use names similar to the protocol specifications,
7 * there are many mixed case field names in the structures below. Although
8 * this does not match typical Linux kernel style, it is necessary to be
9 * able to match against the protocol specfication.
12 * Some commands have minimal (wct=0,bcc=0), or uninteresting, responses
13 * (ie no useful data other than the SMB error code itself) and are marked such.
14 * Knowing this helps avoid response buffer allocations and copy in some cases.
17 /* List of commands in host endian */
18 #define SMB2_NEGOTIATE_HE 0x0000
19 #define SMB2_SESSION_SETUP_HE 0x0001
20 #define SMB2_LOGOFF_HE 0x0002 /* trivial request/resp */
21 #define SMB2_TREE_CONNECT_HE 0x0003
22 #define SMB2_TREE_DISCONNECT_HE 0x0004 /* trivial req/resp */
23 #define SMB2_CREATE_HE 0x0005
24 #define SMB2_CLOSE_HE 0x0006
25 #define SMB2_FLUSH_HE 0x0007 /* trivial resp */
26 #define SMB2_READ_HE 0x0008
27 #define SMB2_WRITE_HE 0x0009
28 #define SMB2_LOCK_HE 0x000A
29 #define SMB2_IOCTL_HE 0x000B
30 #define SMB2_CANCEL_HE 0x000C
31 #define SMB2_ECHO_HE 0x000D
32 #define SMB2_QUERY_DIRECTORY_HE 0x000E
33 #define SMB2_CHANGE_NOTIFY_HE 0x000F
34 #define SMB2_QUERY_INFO_HE 0x0010
35 #define SMB2_SET_INFO_HE 0x0011
36 #define SMB2_OPLOCK_BREAK_HE 0x0012
38 /* The same list in little endian */
39 #define SMB2_NEGOTIATE cpu_to_le16(SMB2_NEGOTIATE_HE)
40 #define SMB2_SESSION_SETUP cpu_to_le16(SMB2_SESSION_SETUP_HE)
41 #define SMB2_LOGOFF cpu_to_le16(SMB2_LOGOFF_HE)
42 #define SMB2_TREE_CONNECT cpu_to_le16(SMB2_TREE_CONNECT_HE)
43 #define SMB2_TREE_DISCONNECT cpu_to_le16(SMB2_TREE_DISCONNECT_HE)
44 #define SMB2_CREATE cpu_to_le16(SMB2_CREATE_HE)
45 #define SMB2_CLOSE cpu_to_le16(SMB2_CLOSE_HE)
46 #define SMB2_FLUSH cpu_to_le16(SMB2_FLUSH_HE)
47 #define SMB2_READ cpu_to_le16(SMB2_READ_HE)
48 #define SMB2_WRITE cpu_to_le16(SMB2_WRITE_HE)
49 #define SMB2_LOCK cpu_to_le16(SMB2_LOCK_HE)
50 #define SMB2_IOCTL cpu_to_le16(SMB2_IOCTL_HE)
51 #define SMB2_CANCEL cpu_to_le16(SMB2_CANCEL_HE)
52 #define SMB2_ECHO cpu_to_le16(SMB2_ECHO_HE)
53 #define SMB2_QUERY_DIRECTORY cpu_to_le16(SMB2_QUERY_DIRECTORY_HE)
54 #define SMB2_CHANGE_NOTIFY cpu_to_le16(SMB2_CHANGE_NOTIFY_HE)
55 #define SMB2_QUERY_INFO cpu_to_le16(SMB2_QUERY_INFO_HE)
56 #define SMB2_SET_INFO cpu_to_le16(SMB2_SET_INFO_HE)
57 #define SMB2_OPLOCK_BREAK cpu_to_le16(SMB2_OPLOCK_BREAK_HE)
59 #define SMB2_INTERNAL_CMD cpu_to_le16(0xFFFF)
61 #define NUMBER_OF_SMB2_COMMANDS 0x0013
64 * Size of the session key (crypto key encrypted with the password
66 #define SMB2_NTLMV2_SESSKEY_SIZE 16
67 #define SMB2_SIGNATURE_SIZE 16
68 #define SMB2_HMACSHA256_SIZE 32
69 #define SMB2_CMACAES_SIZE 16
70 #define SMB3_GCM128_CRYPTKEY_SIZE 16
71 #define SMB3_GCM256_CRYPTKEY_SIZE 32
74 * Size of the smb3 encryption/decryption keys
75 * This size is big enough to store any cipher key types.
77 #define SMB3_ENC_DEC_KEY_SIZE 32
80 * Size of the smb3 signing key
82 #define SMB3_SIGN_KEY_SIZE 16
84 #define CIFS_CLIENT_CHALLENGE_SIZE 8
86 /* Maximum buffer size value we can send with 1 credit */
87 #define SMB2_MAX_BUFFER_SIZE 65536
90 * The default wsize is 1M for SMB2 (and for some CIFS cases).
91 * find_get_pages seems to return a maximum of 256
92 * pages in a single call. With PAGE_SIZE == 4k, this means we can
93 * fill a single wsize request with a single call.
95 #define SMB3_DEFAULT_IOSIZE (4 * 1024 * 1024)
98 * SMB2 Header Definition
100 * "MBZ" : Must be Zero
101 * "BB" : BugBug, Something to check/review/analyze later
102 * "PDU" : "Protocol Data Unit" (ie a network "frame")
106 #define __SMB2_HEADER_STRUCTURE_SIZE 64
107 #define SMB2_HEADER_STRUCTURE_SIZE \
108 cpu_to_le16(__SMB2_HEADER_STRUCTURE_SIZE)
110 #define SMB2_PROTO_NUMBER cpu_to_le32(0x424d53fe)
111 #define SMB2_TRANSFORM_PROTO_NUM cpu_to_le32(0x424d53fd)
112 #define SMB2_COMPRESSION_TRANSFORM_ID cpu_to_le32(0x424d53fc)
115 * SMB2 flag definitions
117 #define SMB2_FLAGS_SERVER_TO_REDIR cpu_to_le32(0x00000001)
118 #define SMB2_FLAGS_ASYNC_COMMAND cpu_to_le32(0x00000002)
119 #define SMB2_FLAGS_RELATED_OPERATIONS cpu_to_le32(0x00000004)
120 #define SMB2_FLAGS_SIGNED cpu_to_le32(0x00000008)
121 #define SMB2_FLAGS_PRIORITY_MASK cpu_to_le32(0x00000070) /* SMB3.1.1 */
122 #define SMB2_FLAGS_DFS_OPERATIONS cpu_to_le32(0x10000000)
123 #define SMB2_FLAGS_REPLAY_OPERATION cpu_to_le32(0x20000000) /* SMB3 & up */
126 * Definitions for SMB2 Protocol Data Units (network frames)
128 * See MS-SMB2.PDF specification for protocol details.
129 * The Naming convention is the lower case version of the SMB2
130 * command code name for the struct. Note that structures must be packed.
134 /* See MS-SMB2 section 2.2.1 */
136 __le32 ProtocolId; /* 0xFE 'S' 'M' 'B' */
137 __le16 StructureSize; /* 64 */
138 __le16 CreditCharge; /* MBZ */
139 __le32 Status; /* Error from server */
141 __le16 CreditRequest; /* CreditResponse */
158 __le16 StructureSize2; /* size of wct area (varies, request specific) */
161 #define SMB2_ERROR_STRUCTURE_SIZE2 9
162 #define SMB2_ERROR_STRUCTURE_SIZE2_LE cpu_to_le16(SMB2_ERROR_STRUCTURE_SIZE2)
164 struct smb2_err_rsp {
166 __le16 StructureSize;
167 __u8 ErrorContextCount;
169 __le32 ByteCount; /* even if zero, at least one byte follows */
170 __u8 ErrorData[1]; /* variable length */
173 #define SMB3_AES_CCM_NONCE 11
174 #define SMB3_AES_GCM_NONCE 12
176 /* Transform flags (for 3.0 dialect this flag indicates CCM */
177 #define TRANSFORM_FLAG_ENCRYPTED 0x0001
178 struct smb2_transform_hdr {
179 __le32 ProtocolId; /* 0xFD 'S' 'M' 'B' */
182 __le32 OriginalMessageSize;
184 __le16 Flags; /* EncryptionAlgorithm for 3.0, enc enabled for 3.1.1 */
189 /* See MS-SMB2 2.2.42 */
190 struct smb2_compression_transform_hdr_unchained {
191 __le32 ProtocolId; /* 0xFC 'S' 'M' 'B' */
192 __le32 OriginalCompressedSegmentSize;
193 __le16 CompressionAlgorithm;
195 __le16 Length; /* if chained it is length, else offset */
198 /* See MS-SMB2 2.2.42.1 */
199 #define SMB2_COMPRESSION_FLAG_NONE 0x0000
200 #define SMB2_COMPRESSION_FLAG_CHAINED 0x0001
202 struct compression_payload_header {
203 __le16 CompressionAlgorithm;
205 __le32 Length; /* length of compressed playload including field below if present */
206 /* __le32 OriginalPayloadSize; */ /* optional, present when LZNT1, LZ77, LZ77+Huffman */
209 /* See MS-SMB2 2.2.42.2 */
210 struct smb2_compression_transform_hdr_chained {
211 __le32 ProtocolId; /* 0xFC 'S' 'M' 'B' */
212 __le32 OriginalCompressedSegmentSize;
213 /* struct compression_payload_header[] */
216 /* See MS-SMB2 2.2.42.2.2 */
217 struct compression_pattern_payload_v1 {
224 /* See MS-SMB2 section 2.2.9.2 */
226 #define SMB2_RESERVED_TREE_CONNECT_CONTEXT_ID 0x0000
227 #define SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID cpu_to_le16(0x0001)
229 struct tree_connect_contexts {
236 /* Remoted identity tree connect context structures - see MS-SMB2 2.2.9.2.1 */
237 struct smb3_blob_data {
242 /* Valid values for Attr */
243 #define SE_GROUP_MANDATORY 0x00000001
244 #define SE_GROUP_ENABLED_BY_DEFAULT 0x00000002
245 #define SE_GROUP_ENABLED 0x00000004
246 #define SE_GROUP_OWNER 0x00000008
247 #define SE_GROUP_USE_FOR_DENY_ONLY 0x00000010
248 #define SE_GROUP_INTEGRITY 0x00000020
249 #define SE_GROUP_INTEGRITY_ENABLED 0x00000040
250 #define SE_GROUP_RESOURCE 0x20000000
251 #define SE_GROUP_LOGON_ID 0xC0000000
253 /* struct sid_attr_data is SidData array in BlobData format then le32 Attr */
255 struct sid_array_data {
257 /* SidAttrList - array of sid_attr_data structs */
260 struct luid_attr_data {
265 * struct privilege_data is the same as BLOB_DATA - see MS-SMB2 2.2.9.2.1.5
266 * but with size of LUID_ATTR_DATA struct and BlobData set to LUID_ATTR DATA
269 struct privilege_array_data {
270 __le16 PrivilegeCount;
271 /* array of privilege_data structs */
274 struct remoted_identity_tcon_context {
275 __le16 TicketType; /* must be 0x0001 */
276 __le16 TicketSize; /* total size of this struct */
277 __le16 User; /* offset to SID_ATTR_DATA struct with user info */
278 __le16 UserName; /* offset to null terminated Unicode username string */
279 __le16 Domain; /* offset to null terminated Unicode domain name */
280 __le16 Groups; /* offset to SID_ARRAY_DATA struct with group info */
281 __le16 RestrictedGroups; /* similar to above */
282 __le16 Privileges; /* offset to PRIVILEGE_ARRAY_DATA struct */
283 __le16 PrimaryGroup; /* offset to SID_ARRAY_DATA struct */
284 __le16 Owner; /* offset to BLOB_DATA struct */
285 __le16 DefaultDacl; /* offset to BLOB_DATA struct */
286 __le16 DeviceGroups; /* offset to SID_ARRAY_DATA struct */
287 __le16 UserClaims; /* offset to BLOB_DATA struct */
288 __le16 DeviceClaims; /* offset to BLOB_DATA struct */
289 __u8 TicketInfo[]; /* variable length buf - remoted identity data */
292 struct smb2_tree_connect_req_extension {
293 __le32 TreeConnectContextOffset;
294 __le16 TreeConnectContextCount;
296 __u8 PathName[]; /* variable sized array */
297 /* followed by array of TreeConnectContexts */
300 /* Flags/Reserved for SMB3.1.1 */
301 #define SMB2_TREE_CONNECT_FLAG_CLUSTER_RECONNECT cpu_to_le16(0x0001)
302 #define SMB2_TREE_CONNECT_FLAG_REDIRECT_TO_OWNER cpu_to_le16(0x0002)
303 #define SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT cpu_to_le16(0x0004)
305 struct smb2_tree_connect_req {
307 __le16 StructureSize; /* Must be 9 */
308 __le16 Flags; /* Flags in SMB3.1.1 */
311 __u8 Buffer[1]; /* variable length */
314 /* Possible ShareType values */
315 #define SMB2_SHARE_TYPE_DISK 0x01
316 #define SMB2_SHARE_TYPE_PIPE 0x02
317 #define SMB2_SHARE_TYPE_PRINT 0x03
320 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
321 * must be set (any of the remaining, SHI1005, flags may be set individually
324 #define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
325 #define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
326 #define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
327 #define SMB2_SHAREFLAG_NO_CACHING 0x00000030
328 #define SHI1005_FLAGS_DFS 0x00000001
329 #define SHI1005_FLAGS_DFS_ROOT 0x00000002
330 #define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS 0x00000100
331 #define SHI1005_FLAGS_FORCE_SHARED_DELETE 0x00000200
332 #define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING 0x00000400
333 #define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
334 #define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK 0x00001000
335 #define SHI1005_FLAGS_ENABLE_HASH_V1 0x00002000
336 #define SHI1005_FLAGS_ENABLE_HASH_V2 0x00004000
337 #define SHI1005_FLAGS_ENCRYPT_DATA 0x00008000
338 #define SMB2_SHAREFLAG_IDENTITY_REMOTING 0x00040000 /* 3.1.1 */
339 #define SMB2_SHAREFLAG_COMPRESS_DATA 0x00100000 /* 3.1.1 */
340 #define SHI1005_FLAGS_ALL 0x0014FF33
342 /* Possible share capabilities */
343 #define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
344 #define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
345 #define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
346 #define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
347 #define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
348 #define SMB2_SHARE_CAP_REDIRECT_TO_OWNER cpu_to_le32(0x00000100) /* 3.1.1 */
350 struct smb2_tree_connect_rsp {
352 __le16 StructureSize; /* Must be 16 */
353 __u8 ShareType; /* see below */
355 __le32 ShareFlags; /* see below */
356 __le32 Capabilities; /* see below */
357 __le32 MaximalAccess;
360 struct smb2_tree_disconnect_req {
362 __le16 StructureSize; /* Must be 4 */
366 struct smb2_tree_disconnect_rsp {
368 __le16 StructureSize; /* Must be 4 */
374 * SMB2_NEGOTIATE_PROTOCOL See MS-SMB2 section 2.2.3
376 /* SecurityMode flags */
377 #define SMB2_NEGOTIATE_SIGNING_ENABLED 0x0001
378 #define SMB2_NEGOTIATE_SIGNING_ENABLED_LE cpu_to_le16(0x0001)
379 #define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
380 #define SMB2_NEGOTIATE_SIGNING_REQUIRED_LE cpu_to_le16(0x0002)
381 #define SMB2_SEC_MODE_FLAGS_ALL 0x0003
383 /* Capabilities flags */
384 #define SMB2_GLOBAL_CAP_DFS 0x00000001
385 #define SMB2_GLOBAL_CAP_LEASING 0x00000002 /* Resp only New to SMB2.1 */
386 #define SMB2_GLOBAL_CAP_LARGE_MTU 0X00000004 /* Resp only New to SMB2.1 */
387 #define SMB2_GLOBAL_CAP_MULTI_CHANNEL 0x00000008 /* New to SMB3 */
388 #define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
389 #define SMB2_GLOBAL_CAP_DIRECTORY_LEASING 0x00000020 /* New to SMB3 */
390 #define SMB2_GLOBAL_CAP_ENCRYPTION 0x00000040 /* New to SMB3 */
392 #define SMB2_NT_FIND 0x00100000
393 #define SMB2_LARGE_FILES 0x00200000
395 #define SMB2_CLIENT_GUID_SIZE 16
396 #define SMB2_CREATE_GUID_SIZE 16
399 #define SMB10_PROT_ID 0x0000 /* local only, not sent on wire w/CIFS negprot */
400 #define SMB20_PROT_ID 0x0202
401 #define SMB21_PROT_ID 0x0210
402 #define SMB2X_PROT_ID 0x02FF
403 #define SMB30_PROT_ID 0x0300
404 #define SMB302_PROT_ID 0x0302
405 #define SMB311_PROT_ID 0x0311
406 #define BAD_PROT_ID 0xFFFF
408 #define SMB311_SALT_SIZE 32
409 /* Hash Algorithm Types */
410 #define SMB2_PREAUTH_INTEGRITY_SHA512 cpu_to_le16(0x0001)
411 #define SMB2_PREAUTH_HASH_SIZE 64
413 /* Negotiate Contexts - ContextTypes. See MS-SMB2 section 2.2.3.1 for details */
414 #define SMB2_PREAUTH_INTEGRITY_CAPABILITIES cpu_to_le16(1)
415 #define SMB2_ENCRYPTION_CAPABILITIES cpu_to_le16(2)
416 #define SMB2_COMPRESSION_CAPABILITIES cpu_to_le16(3)
417 #define SMB2_NETNAME_NEGOTIATE_CONTEXT_ID cpu_to_le16(5)
418 #define SMB2_TRANSPORT_CAPABILITIES cpu_to_le16(6)
419 #define SMB2_RDMA_TRANSFORM_CAPABILITIES cpu_to_le16(7)
420 #define SMB2_SIGNING_CAPABILITIES cpu_to_le16(8)
421 #define SMB2_POSIX_EXTENSIONS_AVAILABLE cpu_to_le16(0x100)
423 struct smb2_neg_context {
427 /* Followed by array of data. NOTE: some servers require padding to 8 byte boundary */
431 * SaltLength that the server send can be zero, so the only three required
432 * fields (all __le16) end up six bytes total, so the minimum context data len
433 * in the response is six bytes which accounts for
435 * HashAlgorithmCount, SaltLength, and 1 HashAlgorithm.
437 #define MIN_PREAUTH_CTXT_DATA_LEN 6
439 struct smb2_preauth_neg_context {
440 __le16 ContextType; /* 1 */
443 __le16 HashAlgorithmCount; /* 1 */
445 __le16 HashAlgorithms; /* HashAlgorithms[0] since only one defined */
446 __u8 Salt[SMB311_SALT_SIZE];
449 /* Encryption Algorithms Ciphers */
450 #define SMB2_ENCRYPTION_AES128_CCM cpu_to_le16(0x0001)
451 #define SMB2_ENCRYPTION_AES128_GCM cpu_to_le16(0x0002)
452 #define SMB2_ENCRYPTION_AES256_CCM cpu_to_le16(0x0003)
453 #define SMB2_ENCRYPTION_AES256_GCM cpu_to_le16(0x0004)
455 /* Min encrypt context data is one cipher so 2 bytes + 2 byte count field */
456 #define MIN_ENCRYPT_CTXT_DATA_LEN 4
457 struct smb2_encryption_neg_context {
458 __le16 ContextType; /* 2 */
461 /* CipherCount usally 2, but can be 3 when AES256-GCM enabled */
462 __le16 CipherCount; /* AES128-GCM and AES128-CCM by default */
466 /* See MS-SMB2 2.2.3.1.3 */
467 #define SMB3_COMPRESS_NONE cpu_to_le16(0x0000)
468 #define SMB3_COMPRESS_LZNT1 cpu_to_le16(0x0001)
469 #define SMB3_COMPRESS_LZ77 cpu_to_le16(0x0002)
470 #define SMB3_COMPRESS_LZ77_HUFF cpu_to_le16(0x0003)
471 /* Pattern scanning algorithm See MS-SMB2 3.1.4.4.1 */
472 #define SMB3_COMPRESS_PATTERN cpu_to_le16(0x0004) /* Pattern_V1 */
474 /* Compression Flags */
475 #define SMB2_COMPRESSION_CAPABILITIES_FLAG_NONE cpu_to_le32(0x00000000)
476 #define SMB2_COMPRESSION_CAPABILITIES_FLAG_CHAINED cpu_to_le32(0x00000001)
478 struct smb2_compression_capabilities_context {
479 __le16 ContextType; /* 3 */
482 __le16 CompressionAlgorithmCount;
485 __le16 CompressionAlgorithms[3];
486 __u16 Pad; /* Some servers require pad to DataLen multiple of 8 */
487 /* Check if pad needed */
491 * For smb2_netname_negotiate_context_id See MS-SMB2 2.2.3.1.4.
492 * Its struct simply contains NetName, an array of Unicode characters
494 struct smb2_netname_neg_context {
495 __le16 ContextType; /* 5 */
498 __le16 NetName[]; /* hostname of target converted to UCS-2 */
502 * For smb2_transport_capabilities context see MS-SMB2 2.2.3.1.5
507 #define SMB2_ACCEPT_TRANSPORT_LEVEL_SECURITY 0x00000001
509 struct smb2_transport_capabilities_context {
510 __le16 ContextType; /* 6 */
518 * For rdma transform capabilities context see MS-SMB2 2.2.3.1.6
522 /* RDMA Transform IDs */
523 #define SMB2_RDMA_TRANSFORM_NONE 0x0000
524 #define SMB2_RDMA_TRANSFORM_ENCRYPTION 0x0001
525 #define SMB2_RDMA_TRANSFORM_SIGNING 0x0002
527 struct smb2_rdma_transform_capabilities_context {
528 __le16 ContextType; /* 7 */
531 __le16 TransformCount;
534 __le16 RDMATransformIds[];
538 * For signing capabilities context see MS-SMB2 2.2.3.1.7
542 /* Signing algorithms */
543 #define SIGNING_ALG_HMAC_SHA256 0
544 #define SIGNING_ALG_HMAC_SHA256_LE cpu_to_le16(0)
545 #define SIGNING_ALG_AES_CMAC 1
546 #define SIGNING_ALG_AES_CMAC_LE cpu_to_le16(1)
547 #define SIGNING_ALG_AES_GMAC 2
548 #define SIGNING_ALG_AES_GMAC_LE cpu_to_le16(2)
550 struct smb2_signing_capabilities {
551 __le16 ContextType; /* 8 */
554 __le16 SigningAlgorithmCount;
555 __le16 SigningAlgorithms[];
556 /* Followed by padding to 8 byte boundary (required by some servers) */
559 #define POSIX_CTXT_DATA_LEN 16
560 struct smb2_posix_neg_context {
561 __le16 ContextType; /* 0x100 */
564 __u8 Name[16]; /* POSIX ctxt GUID 93AD25509CB411E7B42383DE968BCD7C */
567 struct smb2_negotiate_req {
569 __le16 StructureSize; /* Must be 36 */
572 __le16 Reserved; /* MBZ */
574 __u8 ClientGUID[SMB2_CLIENT_GUID_SIZE];
575 /* In SMB3.02 and earlier next three were MBZ le64 ClientStartTime */
576 __le32 NegotiateContextOffset; /* SMB3.1.1 only. MBZ earlier */
577 __le16 NegotiateContextCount; /* SMB3.1.1 only. MBZ earlier */
582 struct smb2_negotiate_rsp {
584 __le16 StructureSize; /* Must be 65 */
586 __le16 DialectRevision;
587 __le16 NegotiateContextCount; /* Prior to SMB3.1.1 was Reserved & MBZ */
590 __le32 MaxTransactSize;
593 __le64 SystemTime; /* MBZ */
594 __le64 ServerStartTime;
595 __le16 SecurityBufferOffset;
596 __le16 SecurityBufferLength;
597 __le32 NegotiateContextOffset; /* Pre:SMB3.1.1 was reserved/ignored */
598 __u8 Buffer[1]; /* variable length GSS security buffer */
603 * SMB2_SESSION_SETUP See MS-SMB2 section 2.2.5
606 #define SMB2_SESSION_REQ_FLAG_BINDING 0x01
607 #define SMB2_SESSION_REQ_FLAG_ENCRYPT_DATA 0x04
609 struct smb2_sess_setup_req {
611 __le16 StructureSize; /* Must be 25 */
616 __le16 SecurityBufferOffset;
617 __le16 SecurityBufferLength;
618 __le64 PreviousSessionId;
619 __u8 Buffer[1]; /* variable length GSS security buffer */
622 /* Currently defined SessionFlags */
623 #define SMB2_SESSION_FLAG_IS_GUEST 0x0001
624 #define SMB2_SESSION_FLAG_IS_GUEST_LE cpu_to_le16(0x0001)
625 #define SMB2_SESSION_FLAG_IS_NULL 0x0002
626 #define SMB2_SESSION_FLAG_IS_NULL_LE cpu_to_le16(0x0002)
627 #define SMB2_SESSION_FLAG_ENCRYPT_DATA 0x0004
628 #define SMB2_SESSION_FLAG_ENCRYPT_DATA_LE cpu_to_le16(0x0004)
630 struct smb2_sess_setup_rsp {
632 __le16 StructureSize; /* Must be 9 */
634 __le16 SecurityBufferOffset;
635 __le16 SecurityBufferLength;
636 __u8 Buffer[1]; /* variable length GSS security buffer */
641 * SMB2_LOGOFF See MS-SMB2 section 2.2.7
643 struct smb2_logoff_req {
645 __le16 StructureSize; /* Must be 4 */
649 struct smb2_logoff_rsp {
651 __le16 StructureSize; /* Must be 4 */
657 * SMB2_CLOSE See MS-SMB2 section 2.2.15
659 /* Currently defined values for close flags */
660 #define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
661 struct smb2_close_req {
663 __le16 StructureSize; /* Must be 24 */
666 __u64 PersistentFileId; /* opaque endianness */
667 __u64 VolatileFileId; /* opaque endianness */
671 * Maximum size of a SMB2_CLOSE response is 64 (smb2 header) + 60 (data)
673 #define MAX_SMB2_CLOSE_RESPONSE_SIZE 124
675 struct smb2_close_rsp {
677 __le16 StructureSize; /* 60 */
681 __le64 LastAccessTime;
682 __le64 LastWriteTime;
684 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
691 * SMB2_READ See MS-SMB2 section 2.2.19
693 /* For read request Flags field below, following flag is defined for SMB3.02 */
694 #define SMB2_READFLAG_READ_UNBUFFERED 0x01
695 #define SMB2_READFLAG_REQUEST_COMPRESSED 0x02 /* See MS-SMB2 2.2.19 */
697 /* Channel field for read and write: exactly one of following flags can be set*/
698 #define SMB2_CHANNEL_NONE cpu_to_le32(0x00000000)
699 #define SMB2_CHANNEL_RDMA_V1 cpu_to_le32(0x00000001)
700 #define SMB2_CHANNEL_RDMA_V1_INVALIDATE cpu_to_le32(0x00000002)
701 #define SMB2_CHANNEL_RDMA_TRANSFORM cpu_to_le32(0x00000003)
703 /* SMB2 read request without RFC1001 length at the beginning */
704 struct smb2_read_req {
706 __le16 StructureSize; /* Must be 49 */
707 __u8 Padding; /* offset from start of SMB2 header to place read */
708 __u8 Flags; /* MBZ unless SMB3.02 or later */
711 __u64 PersistentFileId;
712 __u64 VolatileFileId;
714 __le32 Channel; /* MBZ except for SMB3 or later */
715 __le32 RemainingBytes;
716 __le16 ReadChannelInfoOffset;
717 __le16 ReadChannelInfoLength;
722 #define SMB2_READFLAG_RESPONSE_NONE cpu_to_le32(0x00000000)
723 #define SMB2_READFLAG_RESPONSE_RDMA_TRANSFORM cpu_to_le32(0x00000001)
725 struct smb2_read_rsp {
727 __le16 StructureSize; /* Must be 17 */
731 __le32 DataRemaining;
738 * SMB2_WRITE See MS-SMB2 section 2.2.21
740 /* For write request Flags field below the following flags are defined: */
741 #define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
742 #define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
744 struct smb2_write_req {
746 __le16 StructureSize; /* Must be 49 */
747 __le16 DataOffset; /* offset from start of SMB2 header to write data */
750 __u64 PersistentFileId; /* opaque endianness */
751 __u64 VolatileFileId; /* opaque endianness */
752 __le32 Channel; /* MBZ unless SMB3.02 or later */
753 __le32 RemainingBytes;
754 __le16 WriteChannelInfoOffset;
755 __le16 WriteChannelInfoLength;
760 struct smb2_write_rsp {
762 __le16 StructureSize; /* Must be 17 */
766 __le32 DataRemaining;
773 * SMB2_FLUSH See MS-SMB2 section 2.2.17
775 struct smb2_flush_req {
777 __le16 StructureSize; /* Must be 24 */
780 __u64 PersistentFileId;
781 __u64 VolatileFileId;
784 struct smb2_flush_rsp {
786 __le16 StructureSize;
790 #define SMB2_LOCKFLAG_SHARED 0x0001
791 #define SMB2_LOCKFLAG_EXCLUSIVE 0x0002
792 #define SMB2_LOCKFLAG_UNLOCK 0x0004
793 #define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
794 #define SMB2_LOCKFLAG_MASK 0x0007
796 struct smb2_lock_element {
803 struct smb2_lock_req {
805 __le16 StructureSize; /* Must be 48 */
808 * The least significant four bits are the index, the other 28 bits are
809 * the lock sequence number (0 to 64). See MS-SMB2 2.2.26
811 __le32 LockSequenceNumber;
812 __u64 PersistentFileId;
813 __u64 VolatileFileId;
814 /* Followed by at least one */
815 struct smb2_lock_element locks[1];
818 struct smb2_lock_rsp {
820 __le16 StructureSize; /* Must be 4 */
824 struct smb2_echo_req {
826 __le16 StructureSize; /* Must be 4 */
830 struct smb2_echo_rsp {
832 __le16 StructureSize; /* Must be 4 */
837 * Valid FileInformation classes for query directory
839 * Note that these are a subset of the (file) QUERY_INFO levels defined
840 * later in this file (but since QUERY_DIRECTORY uses equivalent numbers
841 * we do not redefine them here)
843 * FileDirectoryInfomation 0x01
844 * FileFullDirectoryInformation 0x02
845 * FileIdFullDirectoryInformation 0x26
846 * FileBothDirectoryInformation 0x03
847 * FileIdBothDirectoryInformation 0x25
848 * FileNamesInformation 0x0C
849 * FileIdExtdDirectoryInformation 0x3C
852 /* search (query_directory) Flags field */
853 #define SMB2_RESTART_SCANS 0x01
854 #define SMB2_RETURN_SINGLE_ENTRY 0x02
855 #define SMB2_INDEX_SPECIFIED 0x04
856 #define SMB2_REOPEN 0x10
858 struct smb2_query_directory_req {
860 __le16 StructureSize; /* Must be 33 */
861 __u8 FileInformationClass;
864 __u64 PersistentFileId;
865 __u64 VolatileFileId;
866 __le16 FileNameOffset;
867 __le16 FileNameLength;
868 __le32 OutputBufferLength;
872 struct smb2_query_directory_rsp {
874 __le16 StructureSize; /* Must be 9 */
875 __le16 OutputBufferOffset;
876 __le32 OutputBufferLength;
881 * Maximum number of iovs we need for a set-info request.
882 * The largest one is rename/hardlink
883 * [0] : struct smb2_set_info_req + smb2_file_[rename|link]_info
885 * [2] : compound padding
887 #define SMB2_SET_INFO_IOV_SIZE 3
889 struct smb2_set_info_req {
891 __le16 StructureSize; /* Must be 33 */
897 __le32 AdditionalInformation;
898 __u64 PersistentFileId;
899 __u64 VolatileFileId;
903 struct smb2_set_info_rsp {
905 __le16 StructureSize; /* Must be 2 */
909 * SMB2_NOTIFY See MS-SMB2 section 2.2.35
912 #define SMB2_WATCH_TREE 0x0001
914 /* notify completion filter flags. See MS-FSCC 2.6 and MS-SMB2 2.2.35 */
915 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x00000001
916 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x00000002
917 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x00000004
918 #define FILE_NOTIFY_CHANGE_SIZE 0x00000008
919 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x00000010
920 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x00000020
921 #define FILE_NOTIFY_CHANGE_CREATION 0x00000040
922 #define FILE_NOTIFY_CHANGE_EA 0x00000080
923 #define FILE_NOTIFY_CHANGE_SECURITY 0x00000100
924 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
925 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
926 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
928 /* SMB2 Notify Action Flags */
929 #define FILE_ACTION_ADDED 0x00000001
930 #define FILE_ACTION_REMOVED 0x00000002
931 #define FILE_ACTION_MODIFIED 0x00000003
932 #define FILE_ACTION_RENAMED_OLD_NAME 0x00000004
933 #define FILE_ACTION_RENAMED_NEW_NAME 0x00000005
934 #define FILE_ACTION_ADDED_STREAM 0x00000006
935 #define FILE_ACTION_REMOVED_STREAM 0x00000007
936 #define FILE_ACTION_MODIFIED_STREAM 0x00000008
937 #define FILE_ACTION_REMOVED_BY_DELETE 0x00000009
939 struct smb2_change_notify_req {
941 __le16 StructureSize;
943 __le32 OutputBufferLength;
944 __u64 PersistentFileId; /* opaque endianness */
945 __u64 VolatileFileId; /* opaque endianness */
946 __le32 CompletionFilter;
950 struct smb2_change_notify_rsp {
952 __le16 StructureSize; /* Must be 9 */
953 __le16 OutputBufferOffset;
954 __le32 OutputBufferLength;
955 __u8 Buffer[1]; /* array of file notify structs */
960 * SMB2_CREATE See MS-SMB2 section 2.2.13
963 #define SMB2_OPLOCK_LEVEL_NONE 0x00
964 #define SMB2_OPLOCK_LEVEL_II 0x01
965 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE 0x08
966 #define SMB2_OPLOCK_LEVEL_BATCH 0x09
967 #define SMB2_OPLOCK_LEVEL_LEASE 0xFF
968 /* Non-spec internal type */
969 #define SMB2_OPLOCK_LEVEL_NOCHANGE 0x99
971 /* Impersonation Levels. See MS-WPO section 9.7 and MSDN-IMPERS */
972 #define IL_ANONYMOUS cpu_to_le32(0x00000000)
973 #define IL_IDENTIFICATION cpu_to_le32(0x00000001)
974 #define IL_IMPERSONATION cpu_to_le32(0x00000002)
975 #define IL_DELEGATE cpu_to_le32(0x00000003)
977 /* File Attrubutes */
978 #define FILE_ATTRIBUTE_READONLY 0x00000001
979 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
980 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
981 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
982 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
983 #define FILE_ATTRIBUTE_NORMAL 0x00000080
984 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
985 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
986 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
987 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
988 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
989 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
990 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
991 #define FILE_ATTRIBUTE_INTEGRITY_STREAM 0x00008000
992 #define FILE_ATTRIBUTE_NO_SCRUB_DATA 0x00020000
993 #define FILE_ATTRIBUTE__MASK 0x00007FB7
995 #define FILE_ATTRIBUTE_READONLY_LE cpu_to_le32(0x00000001)
996 #define FILE_ATTRIBUTE_HIDDEN_LE cpu_to_le32(0x00000002)
997 #define FILE_ATTRIBUTE_SYSTEM_LE cpu_to_le32(0x00000004)
998 #define FILE_ATTRIBUTE_DIRECTORY_LE cpu_to_le32(0x00000010)
999 #define FILE_ATTRIBUTE_ARCHIVE_LE cpu_to_le32(0x00000020)
1000 #define FILE_ATTRIBUTE_NORMAL_LE cpu_to_le32(0x00000080)
1001 #define FILE_ATTRIBUTE_TEMPORARY_LE cpu_to_le32(0x00000100)
1002 #define FILE_ATTRIBUTE_SPARSE_FILE_LE cpu_to_le32(0x00000200)
1003 #define FILE_ATTRIBUTE_REPARSE_POINT_LE cpu_to_le32(0x00000400)
1004 #define FILE_ATTRIBUTE_COMPRESSED_LE cpu_to_le32(0x00000800)
1005 #define FILE_ATTRIBUTE_OFFLINE_LE cpu_to_le32(0x00001000)
1006 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED_LE cpu_to_le32(0x00002000)
1007 #define FILE_ATTRIBUTE_ENCRYPTED_LE cpu_to_le32(0x00004000)
1008 #define FILE_ATTRIBUTE_INTEGRITY_STREAM_LE cpu_to_le32(0x00008000)
1009 #define FILE_ATTRIBUTE_NO_SCRUB_DATA_LE cpu_to_le32(0x00020000)
1010 #define FILE_ATTRIBUTE_MASK_LE cpu_to_le32(0x00007FB7)
1012 /* Desired Access Flags */
1013 #define FILE_READ_DATA_LE cpu_to_le32(0x00000001)
1014 #define FILE_LIST_DIRECTORY_LE cpu_to_le32(0x00000001)
1015 #define FILE_WRITE_DATA_LE cpu_to_le32(0x00000002)
1016 #define FILE_APPEND_DATA_LE cpu_to_le32(0x00000004)
1017 #define FILE_ADD_SUBDIRECTORY_LE cpu_to_le32(0x00000004)
1018 #define FILE_READ_EA_LE cpu_to_le32(0x00000008)
1019 #define FILE_WRITE_EA_LE cpu_to_le32(0x00000010)
1020 #define FILE_EXECUTE_LE cpu_to_le32(0x00000020)
1021 #define FILE_DELETE_CHILD_LE cpu_to_le32(0x00000040)
1022 #define FILE_READ_ATTRIBUTES_LE cpu_to_le32(0x00000080)
1023 #define FILE_WRITE_ATTRIBUTES_LE cpu_to_le32(0x00000100)
1024 #define FILE_DELETE_LE cpu_to_le32(0x00010000)
1025 #define FILE_READ_CONTROL_LE cpu_to_le32(0x00020000)
1026 #define FILE_WRITE_DAC_LE cpu_to_le32(0x00040000)
1027 #define FILE_WRITE_OWNER_LE cpu_to_le32(0x00080000)
1028 #define FILE_SYNCHRONIZE_LE cpu_to_le32(0x00100000)
1029 #define FILE_ACCESS_SYSTEM_SECURITY_LE cpu_to_le32(0x01000000)
1030 #define FILE_MAXIMAL_ACCESS_LE cpu_to_le32(0x02000000)
1031 #define FILE_GENERIC_ALL_LE cpu_to_le32(0x10000000)
1032 #define FILE_GENERIC_EXECUTE_LE cpu_to_le32(0x20000000)
1033 #define FILE_GENERIC_WRITE_LE cpu_to_le32(0x40000000)
1034 #define FILE_GENERIC_READ_LE cpu_to_le32(0x80000000)
1035 #define DESIRED_ACCESS_MASK cpu_to_le32(0xF21F01FF)
1038 #define FILE_READ_DESIRED_ACCESS_LE (FILE_READ_DATA_LE | \
1040 FILE_GENERIC_READ_LE)
1041 #define FILE_WRITE_DESIRE_ACCESS_LE (FILE_WRITE_DATA_LE | \
1042 FILE_APPEND_DATA_LE | \
1043 FILE_WRITE_EA_LE | \
1044 FILE_WRITE_ATTRIBUTES_LE | \
1045 FILE_GENERIC_WRITE_LE)
1047 /* ShareAccess Flags */
1048 #define FILE_SHARE_READ_LE cpu_to_le32(0x00000001)
1049 #define FILE_SHARE_WRITE_LE cpu_to_le32(0x00000002)
1050 #define FILE_SHARE_DELETE_LE cpu_to_le32(0x00000004)
1051 #define FILE_SHARE_ALL_LE cpu_to_le32(0x00000007)
1053 /* CreateDisposition Flags */
1054 #define FILE_SUPERSEDE_LE cpu_to_le32(0x00000000)
1055 #define FILE_OPEN_LE cpu_to_le32(0x00000001)
1056 #define FILE_CREATE_LE cpu_to_le32(0x00000002)
1057 #define FILE_OPEN_IF_LE cpu_to_le32(0x00000003)
1058 #define FILE_OVERWRITE_LE cpu_to_le32(0x00000004)
1059 #define FILE_OVERWRITE_IF_LE cpu_to_le32(0x00000005)
1060 #define FILE_CREATE_MASK_LE cpu_to_le32(0x00000007)
1062 #define FILE_READ_RIGHTS (FILE_READ_DATA | FILE_READ_EA \
1063 | FILE_READ_ATTRIBUTES)
1064 #define FILE_WRITE_RIGHTS (FILE_WRITE_DATA | FILE_APPEND_DATA \
1065 | FILE_WRITE_EA | FILE_WRITE_ATTRIBUTES)
1066 #define FILE_EXEC_RIGHTS (FILE_EXECUTE)
1068 /* CreateOptions Flags */
1069 #define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
1070 /* same as #define CREATE_NOT_FILE_LE cpu_to_le32(0x00000001) */
1071 #define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
1072 #define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
1073 #define FILE_NO_INTERMEDIATE_BUFFERING_LE cpu_to_le32(0x00000008)
1074 #define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
1075 #define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
1076 #define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
1077 #define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
1078 #define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000)
1079 #define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
1080 #define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
1081 #define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
1082 #define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
1083 #define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
1084 #define CREATE_OPTIONS_MASK_LE cpu_to_le32(0x00FFFFFF)
1086 #define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
1087 | FILE_READ_ATTRIBUTES_LE)
1088 #define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
1089 | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
1090 #define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
1092 /* Create Context Values */
1093 #define SMB2_CREATE_EA_BUFFER "ExtA" /* extended attributes */
1094 #define SMB2_CREATE_SD_BUFFER "SecD" /* security descriptor */
1095 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST "DHnQ"
1096 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT "DHnC"
1097 #define SMB2_CREATE_ALLOCATION_SIZE "AISi"
1098 #define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
1099 #define SMB2_CREATE_TIMEWARP_REQUEST "TWrp"
1100 #define SMB2_CREATE_QUERY_ON_DISK_ID "QFid"
1101 #define SMB2_CREATE_REQUEST_LEASE "RqLs"
1102 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST_V2 "DH2Q"
1103 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT_V2 "DH2C"
1104 #define SMB2_CREATE_TAG_POSIX "\x93\xAD\x25\x50\x9C\xB4\x11\xE7\xB4\x23\x83\xDE\x96\x8B\xCD\x7C"
1106 /* Flag (SMB3 open response) values */
1107 #define SMB2_CREATE_FLAG_REPARSEPOINT 0x01
1109 struct create_context {
1119 struct smb2_create_req {
1120 struct smb2_hdr hdr;
1121 __le16 StructureSize; /* Must be 57 */
1123 __u8 RequestedOplockLevel;
1124 __le32 ImpersonationLevel;
1125 __le64 SmbCreateFlags;
1127 __le32 DesiredAccess;
1128 __le32 FileAttributes;
1130 __le32 CreateDisposition;
1131 __le32 CreateOptions;
1134 __le32 CreateContextsOffset;
1135 __le32 CreateContextsLength;
1139 struct smb2_create_rsp {
1140 struct smb2_hdr hdr;
1141 __le16 StructureSize; /* Must be 89 */
1143 __u8 Flags; /* 0x01 if reparse point */
1144 __le32 CreateAction;
1145 __le64 CreationTime;
1146 __le64 LastAccessTime;
1147 __le64 LastWriteTime;
1149 __le64 AllocationSize;
1151 __le32 FileAttributes;
1153 __u64 PersistentFileId;
1154 __u64 VolatileFileId;
1155 __le32 CreateContextsOffset;
1156 __le32 CreateContextsLength;
1160 struct create_posix {
1161 struct create_context ccontext;
1167 #define SMB2_LEASE_NONE_LE cpu_to_le32(0x00)
1168 #define SMB2_LEASE_READ_CACHING_LE cpu_to_le32(0x01)
1169 #define SMB2_LEASE_HANDLE_CACHING_LE cpu_to_le32(0x02)
1170 #define SMB2_LEASE_WRITE_CACHING_LE cpu_to_le32(0x04)
1172 #define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS_LE cpu_to_le32(0x02)
1174 #define SMB2_LEASE_KEY_SIZE 16
1176 struct lease_context {
1177 __u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
1180 __le64 LeaseDuration;
1183 struct lease_context_v2 {
1184 __u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
1187 __le64 LeaseDuration;
1188 __u8 ParentLeaseKey[SMB2_LEASE_KEY_SIZE];
1193 struct create_lease {
1194 struct create_context ccontext;
1196 struct lease_context lcontext;
1199 struct create_lease_v2 {
1200 struct create_context ccontext;
1202 struct lease_context_v2 lcontext;
1206 /* See MS-SMB2 2.2.31 and 2.2.32 */
1207 struct smb2_ioctl_req {
1208 struct smb2_hdr hdr;
1209 __le16 StructureSize; /* Must be 57 */
1210 __le16 Reserved; /* offset from start of SMB2 header to write data */
1212 __u64 PersistentFileId;
1213 __u64 VolatileFileId;
1214 __le32 InputOffset; /* Reserved MBZ */
1216 __le32 MaxInputResponse;
1217 __le32 OutputOffset;
1219 __le32 MaxOutputResponse;
1225 struct smb2_ioctl_rsp {
1226 struct smb2_hdr hdr;
1227 __le16 StructureSize; /* Must be 49 */
1230 __u64 PersistentFileId;
1231 __u64 VolatileFileId;
1232 __le32 InputOffset; /* Reserved MBZ */
1234 __le32 OutputOffset;
1241 /* this goes in the ioctl buffer when doing FSCTL_SET_ZERO_DATA */
1242 struct file_zero_data_information {
1244 __le64 BeyondFinalZero;
1247 /* See MS-FSCC 2.3.7 */
1248 struct duplicate_extents_to_file {
1249 __u64 PersistentFileHandle; /* source file handle, opaque endianness */
1250 __u64 VolatileFileHandle;
1251 __le64 SourceFileOffset;
1252 __le64 TargetFileOffset;
1253 __le64 ByteCount; /* Bytes to be copied */
1256 /* See MS-FSCC 2.3.8 */
1257 #define DUPLICATE_EXTENTS_DATA_EX_SOURCE_ATOMIC 0x00000001
1258 struct duplicate_extents_to_file_ex {
1259 __u64 PersistentFileHandle; /* source file handle, opaque endianness */
1260 __u64 VolatileFileHandle;
1261 __le64 SourceFileOffset;
1262 __le64 TargetFileOffset;
1263 __le64 ByteCount; /* Bytes to be copied */
1269 /* See MS-FSCC 2.3.20 */
1270 struct fsctl_get_integrity_information_rsp {
1271 __le16 ChecksumAlgorithm;
1274 __le32 ChecksumChunkSizeInBytes;
1275 __le32 ClusterSizeInBytes;
1278 /* See MS-FSCC 2.3.55 */
1279 struct fsctl_query_file_regions_req {
1282 __le32 DesiredUsage;
1286 /* DesiredUsage flags see MS-FSCC 2.3.56.1 */
1287 #define FILE_USAGE_INVALID_RANGE 0x00000000
1288 #define FILE_USAGE_VALID_CACHED_DATA 0x00000001
1289 #define FILE_USAGE_NONCACHED_DATA 0x00000002
1291 struct file_region_info {
1294 __le32 DesiredUsage;
1298 /* See MS-FSCC 2.3.56 */
1299 struct fsctl_query_file_region_rsp {
1301 __le32 TotalRegionEntryCount;
1302 __le32 RegionEntryCount;
1304 struct file_region_info Regions[];
1307 /* See MS-FSCC 2.3.58 */
1308 struct fsctl_query_on_disk_vol_info_rsp {
1309 __le64 DirectoryCount;
1311 __le16 FsFormatMajVersion;
1312 __le16 FsFormatMinVersion;
1313 __u8 FsFormatName[24];
1315 __le64 LastUpdateTime;
1316 __u8 CopyrightInfo[68];
1317 __u8 AbstractInfo[68];
1318 __u8 FormatImplInfo[68];
1319 __u8 LastModifyImplInfo[68];
1322 /* See MS-FSCC 2.3.73 */
1323 struct fsctl_set_integrity_information_req {
1324 __le16 ChecksumAlgorithm;
1329 /* See MS-FSCC 2.3.75 */
1330 struct fsctl_set_integrity_info_ex_req {
1331 __u8 EnableIntegrity;
1339 /* Integrity ChecksumAlgorithm choices for above */
1340 #define CHECKSUM_TYPE_NONE 0x0000
1341 #define CHECKSUM_TYPE_CRC64 0x0002
1342 #define CHECKSUM_TYPE_UNCHANGED 0xFFFF /* set only */
1344 /* Integrity flags for above */
1345 #define FSCTL_INTEGRITY_FLAG_CHECKSUM_ENFORCEMENT_OFF 0x00000001
1347 /* Reparse structures - see MS-FSCC 2.1.2 */
1349 /* struct fsctl_reparse_info_req is empty, only response structs (see below) */
1350 struct reparse_data_buffer {
1352 __le16 ReparseDataLength;
1354 __u8 DataBuffer[]; /* Variable Length */
1357 struct reparse_guid_data_buffer {
1359 __le16 ReparseDataLength;
1361 __u8 ReparseGuid[16];
1362 __u8 DataBuffer[]; /* Variable Length */
1365 struct reparse_mount_point_data_buffer {
1367 __le16 ReparseDataLength;
1369 __le16 SubstituteNameOffset;
1370 __le16 SubstituteNameLength;
1371 __le16 PrintNameOffset;
1372 __le16 PrintNameLength;
1373 __u8 PathBuffer[]; /* Variable Length */
1376 #define SYMLINK_FLAG_RELATIVE 0x00000001
1378 struct reparse_symlink_data_buffer {
1380 __le16 ReparseDataLength;
1382 __le16 SubstituteNameOffset;
1383 __le16 SubstituteNameLength;
1384 __le16 PrintNameOffset;
1385 __le16 PrintNameLength;
1387 __u8 PathBuffer[]; /* Variable Length */
1390 /* See MS-FSCC 2.1.2.6 and cifspdu.h for struct reparse_posix_data */
1392 struct validate_negotiate_info_req {
1393 __le32 Capabilities;
1394 __u8 Guid[SMB2_CLIENT_GUID_SIZE];
1395 __le16 SecurityMode;
1396 __le16 DialectCount;
1397 __le16 Dialects[4]; /* BB expand this if autonegotiate > 4 dialects */
1400 struct validate_negotiate_info_rsp {
1401 __le32 Capabilities;
1402 __u8 Guid[SMB2_CLIENT_GUID_SIZE];
1403 __le16 SecurityMode;
1404 __le16 Dialect; /* Dialect in use for the connection */
1408 /* Possible InfoType values */
1409 #define SMB2_O_INFO_FILE 0x01
1410 #define SMB2_O_INFO_FILESYSTEM 0x02
1411 #define SMB2_O_INFO_SECURITY 0x03
1412 #define SMB2_O_INFO_QUOTA 0x04
1414 /* SMB2 Query Info see MS-SMB2 (2.2.37) or MS-DTYP */
1416 /* List of QUERY INFO levels (those also valid for QUERY_DIR are noted below */
1417 #define FILE_DIRECTORY_INFORMATION 1 /* also for QUERY_DIR */
1418 #define FILE_FULL_DIRECTORY_INFORMATION 2 /* also for QUERY_DIR */
1419 #define FILE_BOTH_DIRECTORY_INFORMATION 3 /* also for QUERY_DIR */
1420 #define FILE_BASIC_INFORMATION 4
1421 #define FILE_STANDARD_INFORMATION 5
1422 #define FILE_INTERNAL_INFORMATION 6
1423 #define FILE_EA_INFORMATION 7
1424 #define FILE_ACCESS_INFORMATION 8
1425 #define FILE_NAME_INFORMATION 9
1426 #define FILE_RENAME_INFORMATION 10
1427 #define FILE_LINK_INFORMATION 11
1428 #define FILE_NAMES_INFORMATION 12 /* also for QUERY_DIR */
1429 #define FILE_DISPOSITION_INFORMATION 13
1430 #define FILE_POSITION_INFORMATION 14
1431 #define FILE_FULL_EA_INFORMATION 15
1432 #define FILE_MODE_INFORMATION 16
1433 #define FILE_ALIGNMENT_INFORMATION 17
1434 #define FILE_ALL_INFORMATION 18
1435 #define FILE_ALLOCATION_INFORMATION 19
1436 #define FILE_END_OF_FILE_INFORMATION 20
1437 #define FILE_ALTERNATE_NAME_INFORMATION 21
1438 #define FILE_STREAM_INFORMATION 22
1439 #define FILE_PIPE_INFORMATION 23
1440 #define FILE_PIPE_LOCAL_INFORMATION 24
1441 #define FILE_PIPE_REMOTE_INFORMATION 25
1442 #define FILE_MAILSLOT_QUERY_INFORMATION 26
1443 #define FILE_MAILSLOT_SET_INFORMATION 27
1444 #define FILE_COMPRESSION_INFORMATION 28
1445 #define FILE_OBJECT_ID_INFORMATION 29
1446 /* Number 30 not defined in documents */
1447 #define FILE_MOVE_CLUSTER_INFORMATION 31
1448 #define FILE_QUOTA_INFORMATION 32
1449 #define FILE_REPARSE_POINT_INFORMATION 33
1450 #define FILE_NETWORK_OPEN_INFORMATION 34
1451 #define FILE_ATTRIBUTE_TAG_INFORMATION 35
1452 #define FILE_TRACKING_INFORMATION 36
1453 #define FILEID_BOTH_DIRECTORY_INFORMATION 37 /* also for QUERY_DIR */
1454 #define FILEID_FULL_DIRECTORY_INFORMATION 38 /* also for QUERY_DIR */
1455 #define FILE_VALID_DATA_LENGTH_INFORMATION 39
1456 #define FILE_SHORT_NAME_INFORMATION 40
1457 #define FILE_SFIO_RESERVE_INFORMATION 44
1458 #define FILE_SFIO_VOLUME_INFORMATION 45
1459 #define FILE_HARD_LINK_INFORMATION 46
1460 #define FILE_NORMALIZED_NAME_INFORMATION 48
1461 #define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
1462 #define FILE_STANDARD_LINK_INFORMATION 54
1463 #define FILE_ID_INFORMATION 59
1464 #define FILE_ID_EXTD_DIRECTORY_INFORMATION 60 /* also for QUERY_DIR */
1465 /* Used for Query Info and Find File POSIX Info for SMB3.1.1 and SMB1 */
1466 #define SMB_FIND_FILE_POSIX_INFO 0x064
1468 /* Security info type additionalinfo flags. */
1469 #define OWNER_SECINFO 0x00000001
1470 #define GROUP_SECINFO 0x00000002
1471 #define DACL_SECINFO 0x00000004
1472 #define SACL_SECINFO 0x00000008
1473 #define LABEL_SECINFO 0x00000010
1474 #define ATTRIBUTE_SECINFO 0x00000020
1475 #define SCOPE_SECINFO 0x00000040
1476 #define BACKUP_SECINFO 0x00010000
1477 #define UNPROTECTED_SACL_SECINFO 0x10000000
1478 #define UNPROTECTED_DACL_SECINFO 0x20000000
1479 #define PROTECTED_SACL_SECINFO 0x40000000
1480 #define PROTECTED_DACL_SECINFO 0x80000000
1482 /* Flags used for FileFullEAinfo */
1483 #define SL_RESTART_SCAN 0x00000001
1484 #define SL_RETURN_SINGLE_ENTRY 0x00000002
1485 #define SL_INDEX_SPECIFIED 0x00000004
1487 struct smb2_query_info_req {
1488 struct smb2_hdr hdr;
1489 __le16 StructureSize; /* Must be 41 */
1492 __le32 OutputBufferLength;
1493 __le16 InputBufferOffset;
1495 __le32 InputBufferLength;
1496 __le32 AdditionalInformation;
1498 __u64 PersistentFileId;
1499 __u64 VolatileFileId;
1503 struct smb2_query_info_rsp {
1504 struct smb2_hdr hdr;
1505 __le16 StructureSize; /* Must be 9 */
1506 __le16 OutputBufferOffset;
1507 __le32 OutputBufferLength;
1512 * PDU query infolevel structure definitions
1515 /* See MS-FSCC 2.3.52 */
1516 struct file_allocated_range_buffer {
1521 struct smb2_file_internal_info {
1523 } __packed; /* level 6 Query */
1525 struct smb2_file_rename_info { /* encoding of request for level 10 */
1526 __u8 ReplaceIfExists; /* 1 = replace existing target with new */
1527 /* 0 = fail if target already exists */
1529 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
1530 __le32 FileNameLength;
1531 char FileName[]; /* New name to be assigned */
1532 /* padding - overall struct size must be >= 24 so filename + pad >= 6 */
1533 } __packed; /* level 10 Set */
1535 struct smb2_file_link_info { /* encoding of request for level 11 */
1536 __u8 ReplaceIfExists; /* 1 = replace existing link with new */
1537 /* 0 = fail if link already exists */
1539 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
1540 __le32 FileNameLength;
1541 char FileName[]; /* Name to be assigned to new link */
1542 } __packed; /* level 11 Set */
1545 * This level 18, although with struct with same name is different from cifs
1546 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
1547 * CurrentByteOffset.
1549 struct smb2_file_all_info { /* data block encoding of response to level 18 */
1550 __le64 CreationTime; /* Beginning of FILE_BASIC_INFO equivalent */
1551 __le64 LastAccessTime;
1552 __le64 LastWriteTime;
1555 __u32 Pad1; /* End of FILE_BASIC_INFO_INFO equivalent */
1556 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
1557 __le64 EndOfFile; /* size ie offset to first free byte in file */
1558 __le32 NumberOfLinks; /* hard links */
1561 __u16 Pad2; /* End of FILE_STANDARD_INFO equivalent */
1565 __le64 CurrentByteOffset;
1567 __le32 AlignmentRequirement;
1568 __le32 FileNameLength;
1570 } __packed; /* level 18 Query */
1572 struct smb2_file_eof_info { /* encoding of request for level 10 */
1573 __le64 EndOfFile; /* new end of file value */
1574 } __packed; /* level 20 Set */
1576 /* Level 100 query info */
1577 struct smb311_posix_qinfo {
1578 __le64 CreationTime;
1579 __le64 LastAccessTime;
1580 __le64 LastWriteTime;
1583 __le64 AllocationSize;
1584 __le32 DosAttributes;
1588 /* beginning of POSIX Create Context Response */
1594 * var sized owner SID
1595 * var sized group SID
1596 * le32 filenamelength
1601 /* File System Information Classes */
1602 #define FS_VOLUME_INFORMATION 1 /* Query */
1603 #define FS_LABEL_INFORMATION 2 /* Set */
1604 #define FS_SIZE_INFORMATION 3 /* Query */
1605 #define FS_DEVICE_INFORMATION 4 /* Query */
1606 #define FS_ATTRIBUTE_INFORMATION 5 /* Query */
1607 #define FS_CONTROL_INFORMATION 6 /* Query, Set */
1608 #define FS_FULL_SIZE_INFORMATION 7 /* Query */
1609 #define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
1610 #define FS_DRIVER_PATH_INFORMATION 9 /* Query */
1611 #define FS_SECTOR_SIZE_INFORMATION 11 /* SMB3 or later. Query */
1612 #define FS_POSIX_INFORMATION 100 /* SMB3.1.1 POSIX. Query */
1614 struct smb2_fs_full_size_info {
1615 __le64 TotalAllocationUnits;
1616 __le64 CallerAvailableAllocationUnits;
1617 __le64 ActualAvailableAllocationUnits;
1618 __le32 SectorsPerAllocationUnit;
1619 __le32 BytesPerSector;
1622 #define SSINFO_FLAGS_ALIGNED_DEVICE 0x00000001
1623 #define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
1624 #define SSINFO_FLAGS_NO_SEEK_PENALTY 0x00000004
1625 #define SSINFO_FLAGS_TRIM_ENABLED 0x00000008
1627 /* sector size info struct */
1628 struct smb3_fs_ss_info {
1629 __le32 LogicalBytesPerSector;
1630 __le32 PhysicalBytesPerSectorForAtomicity;
1631 __le32 PhysicalBytesPerSectorForPerf;
1632 __le32 FSEffPhysicalBytesPerSectorForAtomicity;
1634 __le32 ByteOffsetForSectorAlignment;
1635 __le32 ByteOffsetForPartitionAlignment;
1638 /* File System Control Information */
1639 struct smb2_fs_control_info {
1640 __le64 FreeSpaceStartFiltering;
1641 __le64 FreeSpaceThreshold;
1642 __le64 FreeSpaceStopFiltering;
1643 __le64 DefaultQuotaThreshold;
1644 __le64 DefaultQuotaLimit;
1645 __le32 FileSystemControlFlags;
1649 /* volume info struct - see MS-FSCC 2.5.9 */
1650 #define MAX_VOL_LABEL_LEN 32
1651 struct smb3_fs_vol_info {
1652 __le64 VolumeCreationTime;
1653 __u32 VolumeSerialNumber;
1654 __le32 VolumeLabelLength; /* includes trailing null */
1655 __u8 SupportsObjects; /* True if eg like NTFS, supports objects */
1657 __u8 VolumeLabel[]; /* variable len */
1660 /* See MS-SMB2 2.2.23 through 2.2.25 */
1661 struct smb2_oplock_break {
1662 struct smb2_hdr hdr;
1663 __le16 StructureSize; /* Must be 24 */
1667 __u64 PersistentFid;
1671 #define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
1673 struct smb2_lease_break {
1674 struct smb2_hdr hdr;
1675 __le16 StructureSize; /* Must be 44 */
1679 __le32 CurrentLeaseState;
1680 __le32 NewLeaseState;
1682 __le32 AccessMaskHint;
1683 __le32 ShareMaskHint;
1686 struct smb2_lease_ack {
1687 struct smb2_hdr hdr;
1688 __le16 StructureSize; /* Must be 36 */
1693 __le64 LeaseDuration;
1696 #define OP_BREAK_STRUCT_SIZE_20 24
1697 #define OP_BREAK_STRUCT_SIZE_21 36
1698 #endif /* _COMMON_SMB2PDU_H */