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
37 #define SMB2_SERVER_TO_CLIENT_NOTIFICATION 0x0013
39 /* The same list in little endian */
40 #define SMB2_NEGOTIATE cpu_to_le16(SMB2_NEGOTIATE_HE)
41 #define SMB2_SESSION_SETUP cpu_to_le16(SMB2_SESSION_SETUP_HE)
42 #define SMB2_LOGOFF cpu_to_le16(SMB2_LOGOFF_HE)
43 #define SMB2_TREE_CONNECT cpu_to_le16(SMB2_TREE_CONNECT_HE)
44 #define SMB2_TREE_DISCONNECT cpu_to_le16(SMB2_TREE_DISCONNECT_HE)
45 #define SMB2_CREATE cpu_to_le16(SMB2_CREATE_HE)
46 #define SMB2_CLOSE cpu_to_le16(SMB2_CLOSE_HE)
47 #define SMB2_FLUSH cpu_to_le16(SMB2_FLUSH_HE)
48 #define SMB2_READ cpu_to_le16(SMB2_READ_HE)
49 #define SMB2_WRITE cpu_to_le16(SMB2_WRITE_HE)
50 #define SMB2_LOCK cpu_to_le16(SMB2_LOCK_HE)
51 #define SMB2_IOCTL cpu_to_le16(SMB2_IOCTL_HE)
52 #define SMB2_CANCEL cpu_to_le16(SMB2_CANCEL_HE)
53 #define SMB2_ECHO cpu_to_le16(SMB2_ECHO_HE)
54 #define SMB2_QUERY_DIRECTORY cpu_to_le16(SMB2_QUERY_DIRECTORY_HE)
55 #define SMB2_CHANGE_NOTIFY cpu_to_le16(SMB2_CHANGE_NOTIFY_HE)
56 #define SMB2_QUERY_INFO cpu_to_le16(SMB2_QUERY_INFO_HE)
57 #define SMB2_SET_INFO cpu_to_le16(SMB2_SET_INFO_HE)
58 #define SMB2_OPLOCK_BREAK cpu_to_le16(SMB2_OPLOCK_BREAK_HE)
60 #define SMB2_INTERNAL_CMD cpu_to_le16(0xFFFF)
62 #define NUMBER_OF_SMB2_COMMANDS 0x0013
65 * Size of the session key (crypto key encrypted with the password
67 #define SMB2_NTLMV2_SESSKEY_SIZE 16
68 #define SMB2_SIGNATURE_SIZE 16
69 #define SMB2_HMACSHA256_SIZE 32
70 #define SMB2_CMACAES_SIZE 16
71 #define SMB3_GCM128_CRYPTKEY_SIZE 16
72 #define SMB3_GCM256_CRYPTKEY_SIZE 32
75 * Size of the smb3 encryption/decryption keys
76 * This size is big enough to store any cipher key types.
78 #define SMB3_ENC_DEC_KEY_SIZE 32
81 * Size of the smb3 signing key
83 #define SMB3_SIGN_KEY_SIZE 16
85 #define CIFS_CLIENT_CHALLENGE_SIZE 8
87 /* Maximum buffer size value we can send with 1 credit */
88 #define SMB2_MAX_BUFFER_SIZE 65536
91 * The default wsize is 1M for SMB2 (and for some CIFS cases).
92 * find_get_pages seems to return a maximum of 256
93 * pages in a single call. With PAGE_SIZE == 4k, this means we can
94 * fill a single wsize request with a single call.
96 #define SMB3_DEFAULT_IOSIZE (4 * 1024 * 1024)
99 * SMB2 Header Definition
101 * "MBZ" : Must be Zero
102 * "BB" : BugBug, Something to check/review/analyze later
103 * "PDU" : "Protocol Data Unit" (ie a network "frame")
107 #define __SMB2_HEADER_STRUCTURE_SIZE 64
108 #define SMB2_HEADER_STRUCTURE_SIZE \
109 cpu_to_le16(__SMB2_HEADER_STRUCTURE_SIZE)
111 #define SMB2_PROTO_NUMBER cpu_to_le32(0x424d53fe)
112 #define SMB2_TRANSFORM_PROTO_NUM cpu_to_le32(0x424d53fd)
113 #define SMB2_COMPRESSION_TRANSFORM_ID cpu_to_le32(0x424d53fc)
116 * SMB2 flag definitions
118 #define SMB2_FLAGS_SERVER_TO_REDIR cpu_to_le32(0x00000001)
119 #define SMB2_FLAGS_ASYNC_COMMAND cpu_to_le32(0x00000002)
120 #define SMB2_FLAGS_RELATED_OPERATIONS cpu_to_le32(0x00000004)
121 #define SMB2_FLAGS_SIGNED cpu_to_le32(0x00000008)
122 #define SMB2_FLAGS_PRIORITY_MASK cpu_to_le32(0x00000070) /* SMB3.1.1 */
123 #define SMB2_FLAGS_DFS_OPERATIONS cpu_to_le32(0x10000000)
124 #define SMB2_FLAGS_REPLAY_OPERATION cpu_to_le32(0x20000000) /* SMB3 & up */
127 * Definitions for SMB2 Protocol Data Units (network frames)
129 * See MS-SMB2.PDF specification for protocol details.
130 * The Naming convention is the lower case version of the SMB2
131 * command code name for the struct. Note that structures must be packed.
135 /* See MS-SMB2 section 2.2.1 */
137 __le32 ProtocolId
; /* 0xFE 'S' 'M' 'B' */
138 __le16 StructureSize
; /* 64 */
139 __le16 CreditCharge
; /* MBZ */
140 __le32 Status
; /* Error from server */
142 __le16 CreditRequest
; /* CreditResponse */
157 struct smb3_hdr_req
{
158 __le32 ProtocolId
; /* 0xFE 'S' 'M' 'B' */
159 __le16 StructureSize
; /* 64 */
160 __le16 CreditCharge
; /* MBZ */
161 __le16 ChannelSequence
; /* See MS-SMB2 3.2.4.1 and 3.2.7.1 */
164 __le16 CreditRequest
; /* CreditResponse */
181 __le16 StructureSize2
; /* size of wct area (varies, request specific) */
184 #define SMB2_ERROR_STRUCTURE_SIZE2 9
185 #define SMB2_ERROR_STRUCTURE_SIZE2_LE cpu_to_le16(SMB2_ERROR_STRUCTURE_SIZE2)
187 struct smb2_err_rsp
{
189 __le16 StructureSize
;
190 __u8 ErrorContextCount
;
192 __le32 ByteCount
; /* even if zero, at least one byte follows */
193 __u8 ErrorData
[]; /* variable length */
196 #define SMB3_AES_CCM_NONCE 11
197 #define SMB3_AES_GCM_NONCE 12
199 /* Transform flags (for 3.0 dialect this flag indicates CCM */
200 #define TRANSFORM_FLAG_ENCRYPTED 0x0001
201 struct smb2_transform_hdr
{
202 __le32 ProtocolId
; /* 0xFD 'S' 'M' 'B' */
205 __le32 OriginalMessageSize
;
207 __le16 Flags
; /* EncryptionAlgorithm for 3.0, enc enabled for 3.1.1 */
212 /* See MS-SMB2 2.2.42 */
213 struct smb2_compression_transform_hdr_unchained
{
214 __le32 ProtocolId
; /* 0xFC 'S' 'M' 'B' */
215 __le32 OriginalCompressedSegmentSize
;
216 __le16 CompressionAlgorithm
;
218 __le16 Length
; /* if chained it is length, else offset */
221 /* See MS-SMB2 2.2.42.1 */
222 #define SMB2_COMPRESSION_FLAG_NONE 0x0000
223 #define SMB2_COMPRESSION_FLAG_CHAINED 0x0001
225 struct compression_payload_header
{
226 __le16 CompressionAlgorithm
;
228 __le32 Length
; /* length of compressed playload including field below if present */
229 /* __le32 OriginalPayloadSize; */ /* optional, present when LZNT1, LZ77, LZ77+Huffman */
232 /* See MS-SMB2 2.2.42.2 */
233 struct smb2_compression_transform_hdr_chained
{
234 __le32 ProtocolId
; /* 0xFC 'S' 'M' 'B' */
235 __le32 OriginalCompressedSegmentSize
;
236 /* struct compression_payload_header[] */
239 /* See MS-SMB2 2.2.42.2.2 */
240 struct compression_pattern_payload_v1
{
247 /* See MS-SMB2 section 2.2.9.2 */
249 #define SMB2_RESERVED_TREE_CONNECT_CONTEXT_ID 0x0000
250 #define SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID cpu_to_le16(0x0001)
252 struct tree_connect_contexts
{
259 /* Remoted identity tree connect context structures - see MS-SMB2 2.2.9.2.1 */
260 struct smb3_blob_data
{
265 /* Valid values for Attr */
266 #define SE_GROUP_MANDATORY 0x00000001
267 #define SE_GROUP_ENABLED_BY_DEFAULT 0x00000002
268 #define SE_GROUP_ENABLED 0x00000004
269 #define SE_GROUP_OWNER 0x00000008
270 #define SE_GROUP_USE_FOR_DENY_ONLY 0x00000010
271 #define SE_GROUP_INTEGRITY 0x00000020
272 #define SE_GROUP_INTEGRITY_ENABLED 0x00000040
273 #define SE_GROUP_RESOURCE 0x20000000
274 #define SE_GROUP_LOGON_ID 0xC0000000
276 /* struct sid_attr_data is SidData array in BlobData format then le32 Attr */
278 struct sid_array_data
{
280 /* SidAttrList - array of sid_attr_data structs */
283 struct luid_attr_data
{
288 * struct privilege_data is the same as BLOB_DATA - see MS-SMB2 2.2.9.2.1.5
289 * but with size of LUID_ATTR_DATA struct and BlobData set to LUID_ATTR DATA
292 struct privilege_array_data
{
293 __le16 PrivilegeCount
;
294 /* array of privilege_data structs */
297 struct remoted_identity_tcon_context
{
298 __le16 TicketType
; /* must be 0x0001 */
299 __le16 TicketSize
; /* total size of this struct */
300 __le16 User
; /* offset to SID_ATTR_DATA struct with user info */
301 __le16 UserName
; /* offset to null terminated Unicode username string */
302 __le16 Domain
; /* offset to null terminated Unicode domain name */
303 __le16 Groups
; /* offset to SID_ARRAY_DATA struct with group info */
304 __le16 RestrictedGroups
; /* similar to above */
305 __le16 Privileges
; /* offset to PRIVILEGE_ARRAY_DATA struct */
306 __le16 PrimaryGroup
; /* offset to SID_ARRAY_DATA struct */
307 __le16 Owner
; /* offset to BLOB_DATA struct */
308 __le16 DefaultDacl
; /* offset to BLOB_DATA struct */
309 __le16 DeviceGroups
; /* offset to SID_ARRAY_DATA struct */
310 __le16 UserClaims
; /* offset to BLOB_DATA struct */
311 __le16 DeviceClaims
; /* offset to BLOB_DATA struct */
312 __u8 TicketInfo
[]; /* variable length buf - remoted identity data */
315 struct smb2_tree_connect_req_extension
{
316 __le32 TreeConnectContextOffset
;
317 __le16 TreeConnectContextCount
;
319 __u8 PathName
[]; /* variable sized array */
320 /* followed by array of TreeConnectContexts */
323 /* Flags/Reserved for SMB3.1.1 */
324 #define SMB2_TREE_CONNECT_FLAG_CLUSTER_RECONNECT cpu_to_le16(0x0001)
325 #define SMB2_TREE_CONNECT_FLAG_REDIRECT_TO_OWNER cpu_to_le16(0x0002)
326 #define SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT cpu_to_le16(0x0004)
328 struct smb2_tree_connect_req
{
330 __le16 StructureSize
; /* Must be 9 */
331 __le16 Flags
; /* Flags in SMB3.1.1 */
334 __u8 Buffer
[]; /* variable length */
337 /* Possible ShareType values */
338 #define SMB2_SHARE_TYPE_DISK 0x01
339 #define SMB2_SHARE_TYPE_PIPE 0x02
340 #define SMB2_SHARE_TYPE_PRINT 0x03
343 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
344 * must be set (any of the remaining, SHI1005, flags may be set individually
347 #define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
348 #define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
349 #define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
350 #define SMB2_SHAREFLAG_NO_CACHING 0x00000030
351 #define SHI1005_FLAGS_DFS 0x00000001
352 #define SHI1005_FLAGS_DFS_ROOT 0x00000002
353 #define SMB2_SHAREFLAG_RESTRICT_EXCLUSIVE_OPENS 0x00000100
354 #define SMB2_SHAREFLAG_FORCE_SHARED_DELETE 0x00000200
355 #define SMB2_SHAREFLAG_ALLOW_NAMESPACE_CACHING 0x00000400
356 #define SMB2_SHAREFLAG_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
357 #define SMB2_SHAREFLAG_FORCE_LEVELII_OPLOCK 0x00001000
358 #define SMB2_SHAREFLAG_ENABLE_HASH_V1 0x00002000
359 #define SMB2_SHAREFLAG_ENABLE_HASH_V2 0x00004000
360 #define SHI1005_FLAGS_ENCRYPT_DATA 0x00008000
361 #define SMB2_SHAREFLAG_IDENTITY_REMOTING 0x00040000 /* 3.1.1 */
362 #define SMB2_SHAREFLAG_COMPRESS_DATA 0x00100000 /* 3.1.1 */
363 #define SMB2_SHAREFLAG_ISOLATED_TRANSPORT 0x00200000
364 #define SHI1005_FLAGS_ALL 0x0034FF33
366 /* Possible share capabilities */
367 #define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
368 #define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
369 #define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
370 #define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
371 #define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
372 #define SMB2_SHARE_CAP_REDIRECT_TO_OWNER cpu_to_le32(0x00000100) /* 3.1.1 */
374 struct smb2_tree_connect_rsp
{
376 __le16 StructureSize
; /* Must be 16 */
377 __u8 ShareType
; /* see below */
379 __le32 ShareFlags
; /* see below */
380 __le32 Capabilities
; /* see below */
381 __le32 MaximalAccess
;
384 struct smb2_tree_disconnect_req
{
386 __le16 StructureSize
; /* Must be 4 */
390 struct smb2_tree_disconnect_rsp
{
392 __le16 StructureSize
; /* Must be 4 */
398 * SMB2_NEGOTIATE_PROTOCOL See MS-SMB2 section 2.2.3
400 /* SecurityMode flags */
401 #define SMB2_NEGOTIATE_SIGNING_ENABLED 0x0001
402 #define SMB2_NEGOTIATE_SIGNING_ENABLED_LE cpu_to_le16(0x0001)
403 #define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
404 #define SMB2_NEGOTIATE_SIGNING_REQUIRED_LE cpu_to_le16(0x0002)
405 #define SMB2_SEC_MODE_FLAGS_ALL 0x0003
407 /* Capabilities flags */
408 #define SMB2_GLOBAL_CAP_DFS 0x00000001
409 #define SMB2_GLOBAL_CAP_LEASING 0x00000002 /* Resp only New to SMB2.1 */
410 #define SMB2_GLOBAL_CAP_LARGE_MTU 0x00000004 /* Resp only New to SMB2.1 */
411 #define SMB2_GLOBAL_CAP_MULTI_CHANNEL 0x00000008 /* New to SMB3 */
412 #define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
413 #define SMB2_GLOBAL_CAP_DIRECTORY_LEASING 0x00000020 /* New to SMB3 */
414 #define SMB2_GLOBAL_CAP_ENCRYPTION 0x00000040 /* New to SMB3 */
415 #define SMB2_GLOBAL_CAP_NOTIFICATIONS 0x00000080 /* New to SMB3.1.1 */
417 #define SMB2_NT_FIND 0x00100000
418 #define SMB2_LARGE_FILES 0x00200000
420 #define SMB2_CLIENT_GUID_SIZE 16
421 #define SMB2_CREATE_GUID_SIZE 16
424 #define SMB10_PROT_ID 0x0000 /* local only, not sent on wire w/CIFS negprot */
425 #define SMB20_PROT_ID 0x0202
426 #define SMB21_PROT_ID 0x0210
427 #define SMB2X_PROT_ID 0x02FF
428 #define SMB30_PROT_ID 0x0300
429 #define SMB302_PROT_ID 0x0302
430 #define SMB311_PROT_ID 0x0311
431 #define BAD_PROT_ID 0xFFFF
433 #define SMB311_SALT_SIZE 32
434 /* Hash Algorithm Types */
435 #define SMB2_PREAUTH_INTEGRITY_SHA512 cpu_to_le16(0x0001)
436 #define SMB2_PREAUTH_HASH_SIZE 64
438 /* Negotiate Contexts - ContextTypes. See MS-SMB2 section 2.2.3.1 for details */
439 #define SMB2_PREAUTH_INTEGRITY_CAPABILITIES cpu_to_le16(1)
440 #define SMB2_ENCRYPTION_CAPABILITIES cpu_to_le16(2)
441 #define SMB2_COMPRESSION_CAPABILITIES cpu_to_le16(3)
442 #define SMB2_NETNAME_NEGOTIATE_CONTEXT_ID cpu_to_le16(5)
443 #define SMB2_TRANSPORT_CAPABILITIES cpu_to_le16(6)
444 #define SMB2_RDMA_TRANSFORM_CAPABILITIES cpu_to_le16(7)
445 #define SMB2_SIGNING_CAPABILITIES cpu_to_le16(8)
446 #define SMB2_POSIX_EXTENSIONS_AVAILABLE cpu_to_le16(0x100)
448 struct smb2_neg_context
{
452 /* Followed by array of data. NOTE: some servers require padding to 8 byte boundary */
456 * SaltLength that the server send can be zero, so the only three required
457 * fields (all __le16) end up six bytes total, so the minimum context data len
458 * in the response is six bytes which accounts for
460 * HashAlgorithmCount, SaltLength, and 1 HashAlgorithm.
462 #define MIN_PREAUTH_CTXT_DATA_LEN 6
464 struct smb2_preauth_neg_context
{
465 __le16 ContextType
; /* 1 */
468 __le16 HashAlgorithmCount
; /* 1 */
470 __le16 HashAlgorithms
; /* HashAlgorithms[0] since only one defined */
471 __u8 Salt
[SMB311_SALT_SIZE
];
474 /* Encryption Algorithms Ciphers */
475 #define SMB2_ENCRYPTION_AES128_CCM cpu_to_le16(0x0001)
476 #define SMB2_ENCRYPTION_AES128_GCM cpu_to_le16(0x0002)
477 #define SMB2_ENCRYPTION_AES256_CCM cpu_to_le16(0x0003)
478 #define SMB2_ENCRYPTION_AES256_GCM cpu_to_le16(0x0004)
480 /* Min encrypt context data is one cipher so 2 bytes + 2 byte count field */
481 #define MIN_ENCRYPT_CTXT_DATA_LEN 4
482 struct smb2_encryption_neg_context
{
483 __le16 ContextType
; /* 2 */
486 /* CipherCount usally 2, but can be 3 when AES256-GCM enabled */
487 __le16 CipherCount
; /* AES128-GCM and AES128-CCM by default */
491 /* See MS-SMB2 2.2.3.1.3 */
492 #define SMB3_COMPRESS_NONE cpu_to_le16(0x0000)
493 #define SMB3_COMPRESS_LZNT1 cpu_to_le16(0x0001)
494 #define SMB3_COMPRESS_LZ77 cpu_to_le16(0x0002)
495 #define SMB3_COMPRESS_LZ77_HUFF cpu_to_le16(0x0003)
496 /* Pattern scanning algorithm See MS-SMB2 3.1.4.4.1 */
497 #define SMB3_COMPRESS_PATTERN cpu_to_le16(0x0004) /* Pattern_V1 */
499 /* Compression Flags */
500 #define SMB2_COMPRESSION_CAPABILITIES_FLAG_NONE cpu_to_le32(0x00000000)
501 #define SMB2_COMPRESSION_CAPABILITIES_FLAG_CHAINED cpu_to_le32(0x00000001)
503 struct smb2_compression_capabilities_context
{
504 __le16 ContextType
; /* 3 */
507 __le16 CompressionAlgorithmCount
;
510 __le16 CompressionAlgorithms
[3];
511 __u16 Pad
; /* Some servers require pad to DataLen multiple of 8 */
512 /* Check if pad needed */
516 * For smb2_netname_negotiate_context_id See MS-SMB2 2.2.3.1.4.
517 * Its struct simply contains NetName, an array of Unicode characters
519 struct smb2_netname_neg_context
{
520 __le16 ContextType
; /* 5 */
523 __le16 NetName
[]; /* hostname of target converted to UCS-2 */
527 * For smb2_transport_capabilities context see MS-SMB2 2.2.3.1.5
532 #define SMB2_ACCEPT_TRANSPORT_LEVEL_SECURITY 0x00000001
534 struct smb2_transport_capabilities_context
{
535 __le16 ContextType
; /* 6 */
543 * For rdma transform capabilities context see MS-SMB2 2.2.3.1.6
547 /* RDMA Transform IDs */
548 #define SMB2_RDMA_TRANSFORM_NONE 0x0000
549 #define SMB2_RDMA_TRANSFORM_ENCRYPTION 0x0001
550 #define SMB2_RDMA_TRANSFORM_SIGNING 0x0002
552 struct smb2_rdma_transform_capabilities_context
{
553 __le16 ContextType
; /* 7 */
556 __le16 TransformCount
;
559 __le16 RDMATransformIds
[];
563 * For signing capabilities context see MS-SMB2 2.2.3.1.7
567 /* Signing algorithms */
568 #define SIGNING_ALG_HMAC_SHA256 0
569 #define SIGNING_ALG_HMAC_SHA256_LE cpu_to_le16(0)
570 #define SIGNING_ALG_AES_CMAC 1
571 #define SIGNING_ALG_AES_CMAC_LE cpu_to_le16(1)
572 #define SIGNING_ALG_AES_GMAC 2
573 #define SIGNING_ALG_AES_GMAC_LE cpu_to_le16(2)
575 struct smb2_signing_capabilities
{
576 __le16 ContextType
; /* 8 */
579 __le16 SigningAlgorithmCount
;
580 __le16 SigningAlgorithms
[];
581 /* Followed by padding to 8 byte boundary (required by some servers) */
584 #define POSIX_CTXT_DATA_LEN 16
585 struct smb2_posix_neg_context
{
586 __le16 ContextType
; /* 0x100 */
589 __u8 Name
[16]; /* POSIX ctxt GUID 93AD25509CB411E7B42383DE968BCD7C */
592 struct smb2_negotiate_req
{
594 __le16 StructureSize
; /* Must be 36 */
597 __le16 Reserved
; /* MBZ */
599 __u8 ClientGUID
[SMB2_CLIENT_GUID_SIZE
];
600 /* In SMB3.02 and earlier next three were MBZ le64 ClientStartTime */
601 __le32 NegotiateContextOffset
; /* SMB3.1.1 only. MBZ earlier */
602 __le16 NegotiateContextCount
; /* SMB3.1.1 only. MBZ earlier */
607 struct smb2_negotiate_rsp
{
609 __le16 StructureSize
; /* Must be 65 */
611 __le16 DialectRevision
;
612 __le16 NegotiateContextCount
; /* Prior to SMB3.1.1 was Reserved & MBZ */
615 __le32 MaxTransactSize
;
618 __le64 SystemTime
; /* MBZ */
619 __le64 ServerStartTime
;
620 __le16 SecurityBufferOffset
;
621 __le16 SecurityBufferLength
;
622 __le32 NegotiateContextOffset
; /* Pre:SMB3.1.1 was reserved/ignored */
623 __u8 Buffer
[]; /* variable length GSS security buffer */
628 * SMB2_SESSION_SETUP See MS-SMB2 section 2.2.5
631 #define SMB2_SESSION_REQ_FLAG_BINDING 0x01
632 #define SMB2_SESSION_REQ_FLAG_ENCRYPT_DATA 0x04
634 struct smb2_sess_setup_req
{
636 __le16 StructureSize
; /* Must be 25 */
641 __le16 SecurityBufferOffset
;
642 __le16 SecurityBufferLength
;
643 __le64 PreviousSessionId
;
644 __u8 Buffer
[]; /* variable length GSS security buffer */
647 /* Currently defined SessionFlags */
648 #define SMB2_SESSION_FLAG_IS_GUEST 0x0001
649 #define SMB2_SESSION_FLAG_IS_GUEST_LE cpu_to_le16(0x0001)
650 #define SMB2_SESSION_FLAG_IS_NULL 0x0002
651 #define SMB2_SESSION_FLAG_IS_NULL_LE cpu_to_le16(0x0002)
652 #define SMB2_SESSION_FLAG_ENCRYPT_DATA 0x0004
653 #define SMB2_SESSION_FLAG_ENCRYPT_DATA_LE cpu_to_le16(0x0004)
655 struct smb2_sess_setup_rsp
{
657 __le16 StructureSize
; /* Must be 9 */
659 __le16 SecurityBufferOffset
;
660 __le16 SecurityBufferLength
;
661 __u8 Buffer
[]; /* variable length GSS security buffer */
666 * SMB2_LOGOFF See MS-SMB2 section 2.2.7
668 struct smb2_logoff_req
{
670 __le16 StructureSize
; /* Must be 4 */
674 struct smb2_logoff_rsp
{
676 __le16 StructureSize
; /* Must be 4 */
682 * SMB2_CLOSE See MS-SMB2 section 2.2.15
684 /* Currently defined values for close flags */
685 #define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
686 struct smb2_close_req
{
688 __le16 StructureSize
; /* Must be 24 */
691 __u64 PersistentFileId
; /* opaque endianness */
692 __u64 VolatileFileId
; /* opaque endianness */
696 * Maximum size of a SMB2_CLOSE response is 64 (smb2 header) + 60 (data)
698 #define MAX_SMB2_CLOSE_RESPONSE_SIZE 124
700 struct smb2_close_rsp
{
702 __le16 StructureSize
; /* 60 */
706 __le64 LastAccessTime
;
707 __le64 LastWriteTime
;
709 __le64 AllocationSize
; /* Beginning of FILE_STANDARD_INFO equivalent */
716 * SMB2_READ See MS-SMB2 section 2.2.19
718 /* For read request Flags field below, following flag is defined for SMB3.02 */
719 #define SMB2_READFLAG_READ_UNBUFFERED 0x01
720 #define SMB2_READFLAG_REQUEST_COMPRESSED 0x02 /* See MS-SMB2 2.2.19 */
722 /* Channel field for read and write: exactly one of following flags can be set*/
723 #define SMB2_CHANNEL_NONE cpu_to_le32(0x00000000)
724 #define SMB2_CHANNEL_RDMA_V1 cpu_to_le32(0x00000001)
725 #define SMB2_CHANNEL_RDMA_V1_INVALIDATE cpu_to_le32(0x00000002)
726 #define SMB2_CHANNEL_RDMA_TRANSFORM cpu_to_le32(0x00000003)
728 /* SMB2 read request without RFC1001 length at the beginning */
729 struct smb2_read_req
{
731 __le16 StructureSize
; /* Must be 49 */
732 __u8 Padding
; /* offset from start of SMB2 header to place read */
733 __u8 Flags
; /* MBZ unless SMB3.02 or later */
736 __u64 PersistentFileId
;
737 __u64 VolatileFileId
;
739 __le32 Channel
; /* MBZ except for SMB3 or later */
740 __le32 RemainingBytes
;
741 __le16 ReadChannelInfoOffset
;
742 __le16 ReadChannelInfoLength
;
747 #define SMB2_READFLAG_RESPONSE_NONE cpu_to_le32(0x00000000)
748 #define SMB2_READFLAG_RESPONSE_RDMA_TRANSFORM cpu_to_le32(0x00000001)
750 struct smb2_read_rsp
{
752 __le16 StructureSize
; /* Must be 17 */
756 __le32 DataRemaining
;
763 * SMB2_WRITE See MS-SMB2 section 2.2.21
765 /* For write request Flags field below the following flags are defined: */
766 #define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
767 #define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
769 struct smb2_write_req
{
771 __le16 StructureSize
; /* Must be 49 */
772 __le16 DataOffset
; /* offset from start of SMB2 header to write data */
775 __u64 PersistentFileId
; /* opaque endianness */
776 __u64 VolatileFileId
; /* opaque endianness */
777 __le32 Channel
; /* MBZ unless SMB3.02 or later */
778 __le32 RemainingBytes
;
779 __le16 WriteChannelInfoOffset
;
780 __le16 WriteChannelInfoLength
;
785 struct smb2_write_rsp
{
787 __le16 StructureSize
; /* Must be 17 */
791 __le32 DataRemaining
;
798 * SMB2_FLUSH See MS-SMB2 section 2.2.17
800 struct smb2_flush_req
{
802 __le16 StructureSize
; /* Must be 24 */
805 __u64 PersistentFileId
;
806 __u64 VolatileFileId
;
809 struct smb2_flush_rsp
{
811 __le16 StructureSize
;
815 #define SMB2_LOCKFLAG_SHARED 0x0001
816 #define SMB2_LOCKFLAG_EXCLUSIVE 0x0002
817 #define SMB2_LOCKFLAG_UNLOCK 0x0004
818 #define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
819 #define SMB2_LOCKFLAG_MASK 0x0007
821 struct smb2_lock_element
{
828 struct smb2_lock_req
{
830 __le16 StructureSize
; /* Must be 48 */
833 * The least significant four bits are the index, the other 28 bits are
834 * the lock sequence number (0 to 64). See MS-SMB2 2.2.26
836 __le32 LockSequenceNumber
;
837 __u64 PersistentFileId
;
838 __u64 VolatileFileId
;
839 /* Followed by at least one */
841 struct smb2_lock_element lock
;
842 DECLARE_FLEX_ARRAY(struct smb2_lock_element
, locks
);
846 struct smb2_lock_rsp
{
848 __le16 StructureSize
; /* Must be 4 */
852 struct smb2_echo_req
{
854 __le16 StructureSize
; /* Must be 4 */
858 struct smb2_echo_rsp
{
860 __le16 StructureSize
; /* Must be 4 */
865 * Valid FileInformation classes for query directory
867 * Note that these are a subset of the (file) QUERY_INFO levels defined
868 * later in this file (but since QUERY_DIRECTORY uses equivalent numbers
869 * we do not redefine them here)
871 * FileDirectoryInfomation 0x01
872 * FileFullDirectoryInformation 0x02
873 * FileIdFullDirectoryInformation 0x26
874 * FileBothDirectoryInformation 0x03
875 * FileIdBothDirectoryInformation 0x25
876 * FileNamesInformation 0x0C
877 * FileIdExtdDirectoryInformation 0x3C
880 /* search (query_directory) Flags field */
881 #define SMB2_RESTART_SCANS 0x01
882 #define SMB2_RETURN_SINGLE_ENTRY 0x02
883 #define SMB2_INDEX_SPECIFIED 0x04
884 #define SMB2_REOPEN 0x10
886 struct smb2_query_directory_req
{
888 __le16 StructureSize
; /* Must be 33 */
889 __u8 FileInformationClass
;
892 __u64 PersistentFileId
;
893 __u64 VolatileFileId
;
894 __le16 FileNameOffset
;
895 __le16 FileNameLength
;
896 __le32 OutputBufferLength
;
900 struct smb2_query_directory_rsp
{
902 __le16 StructureSize
; /* Must be 9 */
903 __le16 OutputBufferOffset
;
904 __le32 OutputBufferLength
;
909 * Maximum number of iovs we need for a set-info request.
910 * The largest one is rename/hardlink
911 * [0] : struct smb2_set_info_req + smb2_file_[rename|link]_info
913 * [2] : compound padding
915 #define SMB2_SET_INFO_IOV_SIZE 3
917 struct smb2_set_info_req
{
919 __le16 StructureSize
; /* Must be 33 */
925 __le32 AdditionalInformation
;
926 __u64 PersistentFileId
;
927 __u64 VolatileFileId
;
931 struct smb2_set_info_rsp
{
933 __le16 StructureSize
; /* Must be 2 */
937 * SMB2_NOTIFY See MS-SMB2 section 2.2.35
940 #define SMB2_WATCH_TREE 0x0001
942 /* notify completion filter flags. See MS-FSCC 2.6 and MS-SMB2 2.2.35 */
943 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x00000001
944 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x00000002
945 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x00000004
946 #define FILE_NOTIFY_CHANGE_SIZE 0x00000008
947 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x00000010
948 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x00000020
949 #define FILE_NOTIFY_CHANGE_CREATION 0x00000040
950 #define FILE_NOTIFY_CHANGE_EA 0x00000080
951 #define FILE_NOTIFY_CHANGE_SECURITY 0x00000100
952 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
953 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
954 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
956 /* SMB2 Notify Action Flags */
957 #define FILE_ACTION_ADDED 0x00000001
958 #define FILE_ACTION_REMOVED 0x00000002
959 #define FILE_ACTION_MODIFIED 0x00000003
960 #define FILE_ACTION_RENAMED_OLD_NAME 0x00000004
961 #define FILE_ACTION_RENAMED_NEW_NAME 0x00000005
962 #define FILE_ACTION_ADDED_STREAM 0x00000006
963 #define FILE_ACTION_REMOVED_STREAM 0x00000007
964 #define FILE_ACTION_MODIFIED_STREAM 0x00000008
965 #define FILE_ACTION_REMOVED_BY_DELETE 0x00000009
967 struct smb2_change_notify_req
{
969 __le16 StructureSize
;
971 __le32 OutputBufferLength
;
972 __u64 PersistentFileId
; /* opaque endianness */
973 __u64 VolatileFileId
; /* opaque endianness */
974 __le32 CompletionFilter
;
978 struct smb2_change_notify_rsp
{
980 __le16 StructureSize
; /* Must be 9 */
981 __le16 OutputBufferOffset
;
982 __le32 OutputBufferLength
;
983 __u8 Buffer
[]; /* array of file notify structs */
987 * SMB2_SERVER_TO_CLIENT_NOTIFICATION: See MS-SMB2 section 2.2.44
990 #define SMB2_NOTIFY_SESSION_CLOSED 0x0000
992 struct smb2_server_client_notification
{
994 __le16 StructureSize
;
995 __u16 Reserved
; /* MBZ */
996 __le32 NotificationType
;
997 __u8 NotificationBuffer
[4]; /* MBZ */
1001 * SMB2_CREATE See MS-SMB2 section 2.2.13
1004 #define SMB2_OPLOCK_LEVEL_NONE 0x00
1005 #define SMB2_OPLOCK_LEVEL_II 0x01
1006 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE 0x08
1007 #define SMB2_OPLOCK_LEVEL_BATCH 0x09
1008 #define SMB2_OPLOCK_LEVEL_LEASE 0xFF
1009 /* Non-spec internal type */
1010 #define SMB2_OPLOCK_LEVEL_NOCHANGE 0x99
1012 /* Impersonation Levels. See MS-WPO section 9.7 and MSDN-IMPERS */
1013 #define IL_ANONYMOUS cpu_to_le32(0x00000000)
1014 #define IL_IDENTIFICATION cpu_to_le32(0x00000001)
1015 #define IL_IMPERSONATION cpu_to_le32(0x00000002)
1016 #define IL_DELEGATE cpu_to_le32(0x00000003)
1018 /* File Attrubutes */
1019 #define FILE_ATTRIBUTE_READONLY 0x00000001
1020 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
1021 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
1022 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
1023 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
1024 #define FILE_ATTRIBUTE_NORMAL 0x00000080
1025 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
1026 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
1027 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
1028 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
1029 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
1030 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
1031 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
1032 #define FILE_ATTRIBUTE_INTEGRITY_STREAM 0x00008000
1033 #define FILE_ATTRIBUTE_NO_SCRUB_DATA 0x00020000
1034 #define FILE_ATTRIBUTE__MASK 0x00007FB7
1036 #define FILE_ATTRIBUTE_READONLY_LE cpu_to_le32(0x00000001)
1037 #define FILE_ATTRIBUTE_HIDDEN_LE cpu_to_le32(0x00000002)
1038 #define FILE_ATTRIBUTE_SYSTEM_LE cpu_to_le32(0x00000004)
1039 #define FILE_ATTRIBUTE_DIRECTORY_LE cpu_to_le32(0x00000010)
1040 #define FILE_ATTRIBUTE_ARCHIVE_LE cpu_to_le32(0x00000020)
1041 #define FILE_ATTRIBUTE_NORMAL_LE cpu_to_le32(0x00000080)
1042 #define FILE_ATTRIBUTE_TEMPORARY_LE cpu_to_le32(0x00000100)
1043 #define FILE_ATTRIBUTE_SPARSE_FILE_LE cpu_to_le32(0x00000200)
1044 #define FILE_ATTRIBUTE_REPARSE_POINT_LE cpu_to_le32(0x00000400)
1045 #define FILE_ATTRIBUTE_COMPRESSED_LE cpu_to_le32(0x00000800)
1046 #define FILE_ATTRIBUTE_OFFLINE_LE cpu_to_le32(0x00001000)
1047 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED_LE cpu_to_le32(0x00002000)
1048 #define FILE_ATTRIBUTE_ENCRYPTED_LE cpu_to_le32(0x00004000)
1049 #define FILE_ATTRIBUTE_INTEGRITY_STREAM_LE cpu_to_le32(0x00008000)
1050 #define FILE_ATTRIBUTE_NO_SCRUB_DATA_LE cpu_to_le32(0x00020000)
1051 #define FILE_ATTRIBUTE_MASK_LE cpu_to_le32(0x00007FB7)
1053 /* Desired Access Flags */
1054 #define FILE_READ_DATA_LE cpu_to_le32(0x00000001)
1055 #define FILE_LIST_DIRECTORY_LE cpu_to_le32(0x00000001)
1056 #define FILE_WRITE_DATA_LE cpu_to_le32(0x00000002)
1057 #define FILE_APPEND_DATA_LE cpu_to_le32(0x00000004)
1058 #define FILE_ADD_SUBDIRECTORY_LE cpu_to_le32(0x00000004)
1059 #define FILE_READ_EA_LE cpu_to_le32(0x00000008)
1060 #define FILE_WRITE_EA_LE cpu_to_le32(0x00000010)
1061 #define FILE_EXECUTE_LE cpu_to_le32(0x00000020)
1062 #define FILE_DELETE_CHILD_LE cpu_to_le32(0x00000040)
1063 #define FILE_READ_ATTRIBUTES_LE cpu_to_le32(0x00000080)
1064 #define FILE_WRITE_ATTRIBUTES_LE cpu_to_le32(0x00000100)
1065 #define FILE_DELETE_LE cpu_to_le32(0x00010000)
1066 #define FILE_READ_CONTROL_LE cpu_to_le32(0x00020000)
1067 #define FILE_WRITE_DAC_LE cpu_to_le32(0x00040000)
1068 #define FILE_WRITE_OWNER_LE cpu_to_le32(0x00080000)
1069 #define FILE_SYNCHRONIZE_LE cpu_to_le32(0x00100000)
1070 #define FILE_ACCESS_SYSTEM_SECURITY_LE cpu_to_le32(0x01000000)
1071 #define FILE_MAXIMAL_ACCESS_LE cpu_to_le32(0x02000000)
1072 #define FILE_GENERIC_ALL_LE cpu_to_le32(0x10000000)
1073 #define FILE_GENERIC_EXECUTE_LE cpu_to_le32(0x20000000)
1074 #define FILE_GENERIC_WRITE_LE cpu_to_le32(0x40000000)
1075 #define FILE_GENERIC_READ_LE cpu_to_le32(0x80000000)
1076 #define DESIRED_ACCESS_MASK cpu_to_le32(0xF21F01FF)
1079 #define FILE_READ_DESIRED_ACCESS_LE (FILE_READ_DATA_LE | \
1081 FILE_GENERIC_READ_LE)
1082 #define FILE_WRITE_DESIRE_ACCESS_LE (FILE_WRITE_DATA_LE | \
1083 FILE_APPEND_DATA_LE | \
1084 FILE_WRITE_EA_LE | \
1085 FILE_WRITE_ATTRIBUTES_LE | \
1086 FILE_GENERIC_WRITE_LE)
1088 /* ShareAccess Flags */
1089 #define FILE_SHARE_READ_LE cpu_to_le32(0x00000001)
1090 #define FILE_SHARE_WRITE_LE cpu_to_le32(0x00000002)
1091 #define FILE_SHARE_DELETE_LE cpu_to_le32(0x00000004)
1092 #define FILE_SHARE_ALL_LE cpu_to_le32(0x00000007)
1094 /* CreateDisposition Flags */
1095 #define FILE_SUPERSEDE_LE cpu_to_le32(0x00000000)
1096 #define FILE_OPEN_LE cpu_to_le32(0x00000001)
1097 #define FILE_CREATE_LE cpu_to_le32(0x00000002)
1098 #define FILE_OPEN_IF_LE cpu_to_le32(0x00000003)
1099 #define FILE_OVERWRITE_LE cpu_to_le32(0x00000004)
1100 #define FILE_OVERWRITE_IF_LE cpu_to_le32(0x00000005)
1101 #define FILE_CREATE_MASK_LE cpu_to_le32(0x00000007)
1103 #define FILE_READ_RIGHTS (FILE_READ_DATA | FILE_READ_EA \
1104 | FILE_READ_ATTRIBUTES)
1105 #define FILE_WRITE_RIGHTS (FILE_WRITE_DATA | FILE_APPEND_DATA \
1106 | FILE_WRITE_EA | FILE_WRITE_ATTRIBUTES)
1107 #define FILE_EXEC_RIGHTS (FILE_EXECUTE)
1109 /* CreateOptions Flags */
1110 #define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
1111 /* same as #define CREATE_NOT_FILE_LE cpu_to_le32(0x00000001) */
1112 #define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
1113 #define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
1114 #define FILE_NO_INTERMEDIATE_BUFFERING_LE cpu_to_le32(0x00000008)
1115 /* FILE_SYNCHRONOUS_IO_ALERT_LE cpu_to_le32(0x00000010) should be zero, ignored */
1116 /* FILE_SYNCHRONOUS_IO_NONALERT cpu_to_le32(0x00000020) should be zero, ignored */
1117 #define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
1118 #define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
1119 #define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
1120 /* FILE_OPEN_REMOTE_INSTANCE cpu_to_le32(0x00000400) should be zero, ignored */
1121 #define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
1122 #define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000) /* MBZ */
1123 #define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
1124 #define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
1125 #define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
1126 /* FILE_OPEN_REQUIRING_OPLOCK cpu_to_le32(0x00010000) should be zero, ignored */
1127 /* FILE_DISALLOW_EXCLUSIVE cpu_to_le32(0x00020000) should be zero, ignored */
1128 /* FILE_RESERVE_OPFILTER cpu_to_le32(0x00100000) MBZ */
1129 #define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
1130 #define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
1131 /* #define FILE_OPEN_FOR_FREE_SPACE_QUERY cpu_to_le32(0x00800000) should be zero, ignored */
1132 #define CREATE_OPTIONS_MASK_LE cpu_to_le32(0x00FFFFFF)
1134 #define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
1135 | FILE_READ_ATTRIBUTES_LE)
1136 #define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
1137 | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
1138 #define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
1140 /* Create Context Values */
1141 #define SMB2_CREATE_EA_BUFFER "ExtA" /* extended attributes */
1142 #define SMB2_CREATE_SD_BUFFER "SecD" /* security descriptor */
1143 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST "DHnQ"
1144 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT "DHnC"
1145 #define SMB2_CREATE_ALLOCATION_SIZE "AISi"
1146 #define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
1147 #define SMB2_CREATE_TIMEWARP_REQUEST "TWrp"
1148 #define SMB2_CREATE_QUERY_ON_DISK_ID "QFid"
1149 #define SMB2_CREATE_REQUEST_LEASE "RqLs"
1150 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST_V2 "DH2Q"
1151 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT_V2 "DH2C"
1152 #define SMB2_CREATE_TAG_POSIX "\x93\xAD\x25\x50\x9C\xB4\x11\xE7\xB4\x23\x83\xDE\x96\x8B\xCD\x7C"
1153 #define SMB2_CREATE_APP_INSTANCE_ID "\x45\xBC\xA6\x6A\xEF\xA7\xF7\x4A\x90\x08\xFA\x46\x2E\x14\x4D\x74"
1154 #define SMB2_CREATE_APP_INSTANCE_VERSION "\xB9\x82\xD0\xB7\x3B\x56\x07\x4F\xA0\x7B\x52\x4A\x81\x16\xA0\x10"
1155 #define SVHDX_OPEN_DEVICE_CONTEXT "\x9C\xCB\xCF\x9E\x04\xC1\xE6\x43\x98\x0E\x15\x8D\xA1\xF6\xEC\x83"
1156 #define SMB2_CREATE_TAG_AAPL "AAPL"
1158 /* Flag (SMB3 open response) values */
1159 #define SMB2_CREATE_FLAG_REPARSEPOINT 0x01
1161 struct create_context
{
1171 struct smb2_create_req
{
1172 struct smb2_hdr hdr
;
1173 __le16 StructureSize
; /* Must be 57 */
1175 __u8 RequestedOplockLevel
;
1176 __le32 ImpersonationLevel
;
1177 __le64 SmbCreateFlags
;
1179 __le32 DesiredAccess
;
1180 __le32 FileAttributes
;
1182 __le32 CreateDisposition
;
1183 __le32 CreateOptions
;
1186 __le32 CreateContextsOffset
;
1187 __le32 CreateContextsLength
;
1191 struct smb2_create_rsp
{
1192 struct smb2_hdr hdr
;
1193 __le16 StructureSize
; /* Must be 89 */
1195 __u8 Flags
; /* 0x01 if reparse point */
1196 __le32 CreateAction
;
1197 __le64 CreationTime
;
1198 __le64 LastAccessTime
;
1199 __le64 LastWriteTime
;
1201 __le64 AllocationSize
;
1203 __le32 FileAttributes
;
1205 __u64 PersistentFileId
;
1206 __u64 VolatileFileId
;
1207 __le32 CreateContextsOffset
;
1208 __le32 CreateContextsLength
;
1212 struct create_posix
{
1213 struct create_context ccontext
;
1219 /* See MS-SMB2 2.2.13.2.3 and MS-SMB2 2.2.13.2.4 */
1220 struct create_durable
{
1221 struct create_context ccontext
;
1226 __u64 PersistentFileId
;
1227 __u64 VolatileFileId
;
1232 /* See MS-SMB2 2.2.13.2.5 */
1233 struct create_mxac_req
{
1234 struct create_context ccontext
;
1239 /* See MS-SMB2 2.2.14.2.5 */
1240 struct create_mxac_rsp
{
1241 struct create_context ccontext
;
1244 __le32 MaximalAccess
;
1247 #define SMB2_LEASE_NONE_LE cpu_to_le32(0x00)
1248 #define SMB2_LEASE_READ_CACHING_LE cpu_to_le32(0x01)
1249 #define SMB2_LEASE_HANDLE_CACHING_LE cpu_to_le32(0x02)
1250 #define SMB2_LEASE_WRITE_CACHING_LE cpu_to_le32(0x04)
1252 #define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS_LE cpu_to_le32(0x02)
1254 #define SMB2_LEASE_KEY_SIZE 16
1256 /* See MS-SMB2 2.2.13.2.8 */
1257 struct lease_context
{
1258 __u8 LeaseKey
[SMB2_LEASE_KEY_SIZE
];
1261 __le64 LeaseDuration
;
1264 /* See MS-SMB2 2.2.13.2.10 */
1265 struct lease_context_v2
{
1266 __u8 LeaseKey
[SMB2_LEASE_KEY_SIZE
];
1269 __le64 LeaseDuration
;
1270 __u8 ParentLeaseKey
[SMB2_LEASE_KEY_SIZE
];
1275 struct create_lease
{
1276 struct create_context ccontext
;
1278 struct lease_context lcontext
;
1281 struct create_lease_v2
{
1282 struct create_context ccontext
;
1284 struct lease_context_v2 lcontext
;
1288 /* See MS-SMB2 2.2.14.2.9 */
1289 struct create_disk_id_rsp
{
1290 struct create_context ccontext
;
1297 /* See MS-SMB2 2.2.13.2.13 */
1298 struct create_app_inst_id
{
1299 struct create_context ccontext
;
1301 __le32 StructureSize
; /* Must be 20 */
1303 __u8 AppInstanceId
[16];
1306 /* See MS-SMB2 2.2.13.2.15 */
1307 struct create_app_inst_id_vers
{
1308 struct create_context ccontext
;
1310 __le32 StructureSize
; /* Must be 24 */
1313 __le64 AppInstanceVersionHigh
;
1314 __le64 AppInstanceVersionLow
;
1317 /* See MS-SMB2 2.2.31 and 2.2.32 */
1318 struct smb2_ioctl_req
{
1319 struct smb2_hdr hdr
;
1320 __le16 StructureSize
; /* Must be 57 */
1321 __le16 Reserved
; /* offset from start of SMB2 header to write data */
1323 __u64 PersistentFileId
;
1324 __u64 VolatileFileId
;
1325 __le32 InputOffset
; /* Reserved MBZ */
1327 __le32 MaxInputResponse
;
1328 __le32 OutputOffset
;
1330 __le32 MaxOutputResponse
;
1336 struct smb2_ioctl_rsp
{
1337 struct smb2_hdr hdr
;
1338 __le16 StructureSize
; /* Must be 49 */
1341 __u64 PersistentFileId
;
1342 __u64 VolatileFileId
;
1343 __le32 InputOffset
; /* Reserved MBZ */
1345 __le32 OutputOffset
;
1352 /* this goes in the ioctl buffer when doing FSCTL_SET_ZERO_DATA */
1353 struct file_zero_data_information
{
1355 __le64 BeyondFinalZero
;
1358 /* See MS-FSCC 2.3.7 */
1359 struct duplicate_extents_to_file
{
1360 __u64 PersistentFileHandle
; /* source file handle, opaque endianness */
1361 __u64 VolatileFileHandle
;
1362 __le64 SourceFileOffset
;
1363 __le64 TargetFileOffset
;
1364 __le64 ByteCount
; /* Bytes to be copied */
1367 /* See MS-FSCC 2.3.8 */
1368 #define DUPLICATE_EXTENTS_DATA_EX_SOURCE_ATOMIC 0x00000001
1369 struct duplicate_extents_to_file_ex
{
1370 __u64 PersistentFileHandle
; /* source file handle, opaque endianness */
1371 __u64 VolatileFileHandle
;
1372 __le64 SourceFileOffset
;
1373 __le64 TargetFileOffset
;
1374 __le64 ByteCount
; /* Bytes to be copied */
1380 /* See MS-FSCC 2.3.20 */
1381 struct fsctl_get_integrity_information_rsp
{
1382 __le16 ChecksumAlgorithm
;
1385 __le32 ChecksumChunkSizeInBytes
;
1386 __le32 ClusterSizeInBytes
;
1389 /* See MS-FSCC 2.3.55 */
1390 struct fsctl_query_file_regions_req
{
1393 __le32 DesiredUsage
;
1397 /* DesiredUsage flags see MS-FSCC 2.3.56.1 */
1398 #define FILE_USAGE_INVALID_RANGE 0x00000000
1399 #define FILE_USAGE_VALID_CACHED_DATA 0x00000001
1400 #define FILE_USAGE_NONCACHED_DATA 0x00000002
1402 struct file_region_info
{
1405 __le32 DesiredUsage
;
1409 /* See MS-FSCC 2.3.56 */
1410 struct fsctl_query_file_region_rsp
{
1412 __le32 TotalRegionEntryCount
;
1413 __le32 RegionEntryCount
;
1415 struct file_region_info Regions
[];
1418 /* See MS-FSCC 2.3.58 */
1419 struct fsctl_query_on_disk_vol_info_rsp
{
1420 __le64 DirectoryCount
;
1422 __le16 FsFormatMajVersion
;
1423 __le16 FsFormatMinVersion
;
1424 __u8 FsFormatName
[24];
1426 __le64 LastUpdateTime
;
1427 __u8 CopyrightInfo
[68];
1428 __u8 AbstractInfo
[68];
1429 __u8 FormatImplInfo
[68];
1430 __u8 LastModifyImplInfo
[68];
1433 /* See MS-FSCC 2.3.73 */
1434 struct fsctl_set_integrity_information_req
{
1435 __le16 ChecksumAlgorithm
;
1440 /* See MS-FSCC 2.3.75 */
1441 struct fsctl_set_integrity_info_ex_req
{
1442 __u8 EnableIntegrity
;
1450 /* Integrity ChecksumAlgorithm choices for above */
1451 #define CHECKSUM_TYPE_NONE 0x0000
1452 #define CHECKSUM_TYPE_CRC64 0x0002
1453 #define CHECKSUM_TYPE_UNCHANGED 0xFFFF /* set only */
1455 /* Integrity flags for above */
1456 #define FSCTL_INTEGRITY_FLAG_CHECKSUM_ENFORCEMENT_OFF 0x00000001
1458 /* Reparse structures - see MS-FSCC 2.1.2 */
1460 /* struct fsctl_reparse_info_req is empty, only response structs (see below) */
1461 struct reparse_data_buffer
{
1463 __le16 ReparseDataLength
;
1465 __u8 DataBuffer
[]; /* Variable Length */
1468 struct reparse_guid_data_buffer
{
1470 __le16 ReparseDataLength
;
1472 __u8 ReparseGuid
[16];
1473 __u8 DataBuffer
[]; /* Variable Length */
1476 struct reparse_mount_point_data_buffer
{
1478 __le16 ReparseDataLength
;
1480 __le16 SubstituteNameOffset
;
1481 __le16 SubstituteNameLength
;
1482 __le16 PrintNameOffset
;
1483 __le16 PrintNameLength
;
1484 __u8 PathBuffer
[]; /* Variable Length */
1487 #define SYMLINK_FLAG_RELATIVE 0x00000001
1489 struct reparse_symlink_data_buffer
{
1491 __le16 ReparseDataLength
;
1493 __le16 SubstituteNameOffset
;
1494 __le16 SubstituteNameLength
;
1495 __le16 PrintNameOffset
;
1496 __le16 PrintNameLength
;
1498 __u8 PathBuffer
[]; /* Variable Length */
1501 /* See MS-FSCC 2.1.2.6 and cifspdu.h for struct reparse_posix_data */
1503 struct validate_negotiate_info_req
{
1504 __le32 Capabilities
;
1505 __u8 Guid
[SMB2_CLIENT_GUID_SIZE
];
1506 __le16 SecurityMode
;
1507 __le16 DialectCount
;
1508 __le16 Dialects
[4]; /* BB expand this if autonegotiate > 4 dialects */
1511 struct validate_negotiate_info_rsp
{
1512 __le32 Capabilities
;
1513 __u8 Guid
[SMB2_CLIENT_GUID_SIZE
];
1514 __le16 SecurityMode
;
1515 __le16 Dialect
; /* Dialect in use for the connection */
1519 /* Possible InfoType values */
1520 #define SMB2_O_INFO_FILE 0x01
1521 #define SMB2_O_INFO_FILESYSTEM 0x02
1522 #define SMB2_O_INFO_SECURITY 0x03
1523 #define SMB2_O_INFO_QUOTA 0x04
1525 /* SMB2 Query Info see MS-SMB2 (2.2.37) or MS-DTYP */
1527 /* List of QUERY INFO levels (those also valid for QUERY_DIR are noted below */
1528 #define FILE_DIRECTORY_INFORMATION 1 /* also for QUERY_DIR */
1529 #define FILE_FULL_DIRECTORY_INFORMATION 2 /* also for QUERY_DIR */
1530 #define FILE_BOTH_DIRECTORY_INFORMATION 3 /* also for QUERY_DIR */
1531 #define FILE_BASIC_INFORMATION 4
1532 #define FILE_STANDARD_INFORMATION 5
1533 #define FILE_INTERNAL_INFORMATION 6
1534 #define FILE_EA_INFORMATION 7
1535 #define FILE_ACCESS_INFORMATION 8
1536 #define FILE_NAME_INFORMATION 9
1537 #define FILE_RENAME_INFORMATION 10
1538 #define FILE_LINK_INFORMATION 11
1539 #define FILE_NAMES_INFORMATION 12 /* also for QUERY_DIR */
1540 #define FILE_DISPOSITION_INFORMATION 13
1541 #define FILE_POSITION_INFORMATION 14
1542 #define FILE_FULL_EA_INFORMATION 15
1543 #define FILE_MODE_INFORMATION 16
1544 #define FILE_ALIGNMENT_INFORMATION 17
1545 #define FILE_ALL_INFORMATION 18
1546 #define FILE_ALLOCATION_INFORMATION 19
1547 #define FILE_END_OF_FILE_INFORMATION 20
1548 #define FILE_ALTERNATE_NAME_INFORMATION 21
1549 #define FILE_STREAM_INFORMATION 22
1550 #define FILE_PIPE_INFORMATION 23
1551 #define FILE_PIPE_LOCAL_INFORMATION 24
1552 #define FILE_PIPE_REMOTE_INFORMATION 25
1553 #define FILE_MAILSLOT_QUERY_INFORMATION 26
1554 #define FILE_MAILSLOT_SET_INFORMATION 27
1555 #define FILE_COMPRESSION_INFORMATION 28
1556 #define FILE_OBJECT_ID_INFORMATION 29
1557 /* Number 30 not defined in documents */
1558 #define FILE_MOVE_CLUSTER_INFORMATION 31
1559 #define FILE_QUOTA_INFORMATION 32
1560 #define FILE_REPARSE_POINT_INFORMATION 33
1561 #define FILE_NETWORK_OPEN_INFORMATION 34
1562 #define FILE_ATTRIBUTE_TAG_INFORMATION 35
1563 #define FILE_TRACKING_INFORMATION 36
1564 #define FILEID_BOTH_DIRECTORY_INFORMATION 37 /* also for QUERY_DIR */
1565 #define FILEID_FULL_DIRECTORY_INFORMATION 38 /* also for QUERY_DIR */
1566 #define FILE_VALID_DATA_LENGTH_INFORMATION 39
1567 #define FILE_SHORT_NAME_INFORMATION 40
1568 #define FILE_SFIO_RESERVE_INFORMATION 44
1569 #define FILE_SFIO_VOLUME_INFORMATION 45
1570 #define FILE_HARD_LINK_INFORMATION 46
1571 #define FILE_NORMALIZED_NAME_INFORMATION 48
1572 #define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
1573 #define FILE_STANDARD_LINK_INFORMATION 54
1574 #define FILE_ID_INFORMATION 59
1575 #define FILE_ID_EXTD_DIRECTORY_INFORMATION 60 /* also for QUERY_DIR */
1576 /* Used for Query Info and Find File POSIX Info for SMB3.1.1 and SMB1 */
1577 #define SMB_FIND_FILE_POSIX_INFO 0x064
1579 /* Security info type additionalinfo flags. */
1580 #define OWNER_SECINFO 0x00000001
1581 #define GROUP_SECINFO 0x00000002
1582 #define DACL_SECINFO 0x00000004
1583 #define SACL_SECINFO 0x00000008
1584 #define LABEL_SECINFO 0x00000010
1585 #define ATTRIBUTE_SECINFO 0x00000020
1586 #define SCOPE_SECINFO 0x00000040
1587 #define BACKUP_SECINFO 0x00010000
1588 #define UNPROTECTED_SACL_SECINFO 0x10000000
1589 #define UNPROTECTED_DACL_SECINFO 0x20000000
1590 #define PROTECTED_SACL_SECINFO 0x40000000
1591 #define PROTECTED_DACL_SECINFO 0x80000000
1593 /* Flags used for FileFullEAinfo */
1594 #define SL_RESTART_SCAN 0x00000001
1595 #define SL_RETURN_SINGLE_ENTRY 0x00000002
1596 #define SL_INDEX_SPECIFIED 0x00000004
1598 struct smb2_query_info_req
{
1599 struct smb2_hdr hdr
;
1600 __le16 StructureSize
; /* Must be 41 */
1603 __le32 OutputBufferLength
;
1604 __le16 InputBufferOffset
;
1606 __le32 InputBufferLength
;
1607 __le32 AdditionalInformation
;
1609 __u64 PersistentFileId
;
1610 __u64 VolatileFileId
;
1614 struct smb2_query_info_rsp
{
1615 struct smb2_hdr hdr
;
1616 __le16 StructureSize
; /* Must be 9 */
1617 __le16 OutputBufferOffset
;
1618 __le32 OutputBufferLength
;
1623 * PDU query infolevel structure definitions
1626 /* See MS-FSCC 2.3.52 */
1627 struct file_allocated_range_buffer
{
1632 struct smb2_file_internal_info
{
1634 } __packed
; /* level 6 Query */
1636 struct smb2_file_rename_info
{ /* encoding of request for level 10 */
1637 __u8 ReplaceIfExists
; /* 1 = replace existing target with new */
1638 /* 0 = fail if target already exists */
1640 __u64 RootDirectory
; /* MBZ for network operations (why says spec?) */
1641 __le32 FileNameLength
;
1642 char FileName
[]; /* New name to be assigned */
1643 /* padding - overall struct size must be >= 24 so filename + pad >= 6 */
1644 } __packed
; /* level 10 Set */
1646 struct smb2_file_link_info
{ /* encoding of request for level 11 */
1647 __u8 ReplaceIfExists
; /* 1 = replace existing link with new */
1648 /* 0 = fail if link already exists */
1650 __u64 RootDirectory
; /* MBZ for network operations (why says spec?) */
1651 __le32 FileNameLength
;
1652 char FileName
[]; /* Name to be assigned to new link */
1653 } __packed
; /* level 11 Set */
1656 * This level 18, although with struct with same name is different from cifs
1657 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
1658 * CurrentByteOffset.
1660 struct smb2_file_all_info
{ /* data block encoding of response to level 18 */
1661 __le64 CreationTime
; /* Beginning of FILE_BASIC_INFO equivalent */
1662 __le64 LastAccessTime
;
1663 __le64 LastWriteTime
;
1666 __u32 Pad1
; /* End of FILE_BASIC_INFO_INFO equivalent */
1667 __le64 AllocationSize
; /* Beginning of FILE_STANDARD_INFO equivalent */
1668 __le64 EndOfFile
; /* size ie offset to first free byte in file */
1669 __le32 NumberOfLinks
; /* hard links */
1672 __u16 Pad2
; /* End of FILE_STANDARD_INFO equivalent */
1676 __le64 CurrentByteOffset
;
1678 __le32 AlignmentRequirement
;
1679 __le32 FileNameLength
;
1681 char __pad
; /* Legacy structure padding */
1682 DECLARE_FLEX_ARRAY(char, FileName
);
1684 } __packed
; /* level 18 Query */
1686 struct smb2_file_eof_info
{ /* encoding of request for level 10 */
1687 __le64 EndOfFile
; /* new end of file value */
1688 } __packed
; /* level 20 Set */
1690 /* Level 100 query info */
1691 struct smb311_posix_qinfo
{
1692 __le64 CreationTime
;
1693 __le64 LastAccessTime
;
1694 __le64 LastWriteTime
;
1697 __le64 AllocationSize
;
1698 __le32 DosAttributes
;
1702 /* beginning of POSIX Create Context Response */
1708 * var sized owner SID
1709 * var sized group SID
1710 * le32 filenamelength
1715 /* File System Information Classes */
1716 #define FS_VOLUME_INFORMATION 1 /* Query */
1717 #define FS_LABEL_INFORMATION 2 /* Set */
1718 #define FS_SIZE_INFORMATION 3 /* Query */
1719 #define FS_DEVICE_INFORMATION 4 /* Query */
1720 #define FS_ATTRIBUTE_INFORMATION 5 /* Query */
1721 #define FS_CONTROL_INFORMATION 6 /* Query, Set */
1722 #define FS_FULL_SIZE_INFORMATION 7 /* Query */
1723 #define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
1724 #define FS_DRIVER_PATH_INFORMATION 9 /* Query */
1725 #define FS_SECTOR_SIZE_INFORMATION 11 /* SMB3 or later. Query */
1726 #define FS_POSIX_INFORMATION 100 /* SMB3.1.1 POSIX. Query */
1728 struct smb2_fs_full_size_info
{
1729 __le64 TotalAllocationUnits
;
1730 __le64 CallerAvailableAllocationUnits
;
1731 __le64 ActualAvailableAllocationUnits
;
1732 __le32 SectorsPerAllocationUnit
;
1733 __le32 BytesPerSector
;
1736 #define SSINFO_FLAGS_ALIGNED_DEVICE 0x00000001
1737 #define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
1738 #define SSINFO_FLAGS_NO_SEEK_PENALTY 0x00000004
1739 #define SSINFO_FLAGS_TRIM_ENABLED 0x00000008
1741 /* sector size info struct */
1742 struct smb3_fs_ss_info
{
1743 __le32 LogicalBytesPerSector
;
1744 __le32 PhysicalBytesPerSectorForAtomicity
;
1745 __le32 PhysicalBytesPerSectorForPerf
;
1746 __le32 FSEffPhysicalBytesPerSectorForAtomicity
;
1748 __le32 ByteOffsetForSectorAlignment
;
1749 __le32 ByteOffsetForPartitionAlignment
;
1752 /* File System Control Information */
1753 struct smb2_fs_control_info
{
1754 __le64 FreeSpaceStartFiltering
;
1755 __le64 FreeSpaceThreshold
;
1756 __le64 FreeSpaceStopFiltering
;
1757 __le64 DefaultQuotaThreshold
;
1758 __le64 DefaultQuotaLimit
;
1759 __le32 FileSystemControlFlags
;
1763 /* volume info struct - see MS-FSCC 2.5.9 */
1764 #define MAX_VOL_LABEL_LEN 32
1765 struct smb3_fs_vol_info
{
1766 __le64 VolumeCreationTime
;
1767 __u32 VolumeSerialNumber
;
1768 __le32 VolumeLabelLength
; /* includes trailing null */
1769 __u8 SupportsObjects
; /* True if eg like NTFS, supports objects */
1771 __u8 VolumeLabel
[]; /* variable len */
1774 /* See MS-SMB2 2.2.23 through 2.2.25 */
1775 struct smb2_oplock_break
{
1776 struct smb2_hdr hdr
;
1777 __le16 StructureSize
; /* Must be 24 */
1781 __u64 PersistentFid
;
1785 #define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
1787 struct smb2_lease_break
{
1788 struct smb2_hdr hdr
;
1789 __le16 StructureSize
; /* Must be 44 */
1793 __le32 CurrentLeaseState
;
1794 __le32 NewLeaseState
;
1796 __le32 AccessMaskHint
;
1797 __le32 ShareMaskHint
;
1800 struct smb2_lease_ack
{
1801 struct smb2_hdr hdr
;
1802 __le16 StructureSize
; /* Must be 36 */
1807 __le64 LeaseDuration
;
1810 #define OP_BREAK_STRUCT_SIZE_20 24
1811 #define OP_BREAK_STRUCT_SIZE_21 36
1812 #endif /* _COMMON_SMB2PDU_H */