4 * Copyright (c) International Business Machines Corp., 2009, 2013
6 * Author(s): Steve French (sfrench@us.ibm.com)
7 * Pavel Shilovsky (pshilovsky@samba.org) 2012
9 * This library is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as published
11 * by the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
17 * the GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this library; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
31 * Note that, due to trying to use names similar to the protocol specifications,
32 * there are many mixed case field names in the structures below. Although
33 * this does not match typical Linux kernel style, it is necessary to be
34 * able to match against the protocol specfication.
37 * Some commands have minimal (wct=0,bcc=0), or uninteresting, responses
38 * (ie no useful data other than the SMB error code itself) and are marked such.
39 * Knowing this helps avoid response buffer allocations and copy in some cases.
42 /* List of commands in host endian */
43 #define SMB2_NEGOTIATE_HE 0x0000
44 #define SMB2_SESSION_SETUP_HE 0x0001
45 #define SMB2_LOGOFF_HE 0x0002 /* trivial request/resp */
46 #define SMB2_TREE_CONNECT_HE 0x0003
47 #define SMB2_TREE_DISCONNECT_HE 0x0004 /* trivial req/resp */
48 #define SMB2_CREATE_HE 0x0005
49 #define SMB2_CLOSE_HE 0x0006
50 #define SMB2_FLUSH_HE 0x0007 /* trivial resp */
51 #define SMB2_READ_HE 0x0008
52 #define SMB2_WRITE_HE 0x0009
53 #define SMB2_LOCK_HE 0x000A
54 #define SMB2_IOCTL_HE 0x000B
55 #define SMB2_CANCEL_HE 0x000C
56 #define SMB2_ECHO_HE 0x000D
57 #define SMB2_QUERY_DIRECTORY_HE 0x000E
58 #define SMB2_CHANGE_NOTIFY_HE 0x000F
59 #define SMB2_QUERY_INFO_HE 0x0010
60 #define SMB2_SET_INFO_HE 0x0011
61 #define SMB2_OPLOCK_BREAK_HE 0x0012
63 /* The same list in little endian */
64 #define SMB2_NEGOTIATE cpu_to_le16(SMB2_NEGOTIATE_HE)
65 #define SMB2_SESSION_SETUP cpu_to_le16(SMB2_SESSION_SETUP_HE)
66 #define SMB2_LOGOFF cpu_to_le16(SMB2_LOGOFF_HE)
67 #define SMB2_TREE_CONNECT cpu_to_le16(SMB2_TREE_CONNECT_HE)
68 #define SMB2_TREE_DISCONNECT cpu_to_le16(SMB2_TREE_DISCONNECT_HE)
69 #define SMB2_CREATE cpu_to_le16(SMB2_CREATE_HE)
70 #define SMB2_CLOSE cpu_to_le16(SMB2_CLOSE_HE)
71 #define SMB2_FLUSH cpu_to_le16(SMB2_FLUSH_HE)
72 #define SMB2_READ cpu_to_le16(SMB2_READ_HE)
73 #define SMB2_WRITE cpu_to_le16(SMB2_WRITE_HE)
74 #define SMB2_LOCK cpu_to_le16(SMB2_LOCK_HE)
75 #define SMB2_IOCTL cpu_to_le16(SMB2_IOCTL_HE)
76 #define SMB2_CANCEL cpu_to_le16(SMB2_CANCEL_HE)
77 #define SMB2_ECHO cpu_to_le16(SMB2_ECHO_HE)
78 #define SMB2_QUERY_DIRECTORY cpu_to_le16(SMB2_QUERY_DIRECTORY_HE)
79 #define SMB2_CHANGE_NOTIFY cpu_to_le16(SMB2_CHANGE_NOTIFY_HE)
80 #define SMB2_QUERY_INFO cpu_to_le16(SMB2_QUERY_INFO_HE)
81 #define SMB2_SET_INFO cpu_to_le16(SMB2_SET_INFO_HE)
82 #define SMB2_OPLOCK_BREAK cpu_to_le16(SMB2_OPLOCK_BREAK_HE)
84 #define SMB2_INTERNAL_CMD cpu_to_le16(0xFFFF)
86 #define NUMBER_OF_SMB2_COMMANDS 0x0013
88 /* 52 transform hdr + 64 hdr + 88 create rsp */
89 #define SMB2_TRANSFORM_HEADER_SIZE 52
90 #define MAX_SMB2_HDR_SIZE 204
92 #define SMB2_PROTO_NUMBER cpu_to_le32(0x424d53fe)
93 #define SMB2_TRANSFORM_PROTO_NUM cpu_to_le32(0x424d53fd)
94 #define SMB2_COMPRESSION_TRANSFORM_ID cpu_to_le32(0x424d53fc)
97 * SMB2 Header Definition
99 * "MBZ" : Must be Zero
100 * "BB" : BugBug, Something to check/review/analyze later
101 * "PDU" : "Protocol Data Unit" (ie a network "frame")
105 #define SMB2_HEADER_STRUCTURE_SIZE cpu_to_le16(64)
107 struct smb2_sync_hdr {
108 __le32 ProtocolId; /* 0xFE 'S' 'M' 'B' */
109 __le16 StructureSize; /* 64 */
110 __le16 CreditCharge; /* MBZ */
111 __le32 Status; /* Error from server */
113 __le16 CreditRequest; /* CreditResponse */
118 __u32 TreeId; /* opaque - so do not make little endian */
119 __u64 SessionId; /* opaque - so do not make little endian */
123 /* The total header size for SMB2 read and write */
124 #define SMB2_READWRITE_PDU_HEADER_SIZE (48 + sizeof(struct smb2_sync_hdr))
126 struct smb2_sync_pdu {
127 struct smb2_sync_hdr sync_hdr;
128 __le16 StructureSize2; /* size of wct area (varies, request specific) */
131 #define SMB3_AES128CCM_NONCE 11
132 #define SMB3_AES128GCM_NONCE 12
134 /* Transform flags (for 3.0 dialect this flag indicates CCM */
135 #define TRANSFORM_FLAG_ENCRYPTED 0x0001
136 struct smb2_transform_hdr {
137 __le32 ProtocolId; /* 0xFD 'S' 'M' 'B' */
140 __le32 OriginalMessageSize;
142 __le16 Flags; /* EncryptionAlgorithm for 3.0, enc enabled for 3.1.1 */
146 /* See MS-SMB2 2.2.42 */
147 struct smb2_compression_transform_hdr {
148 __le32 ProtocolId; /* 0xFC 'S' 'M' 'B' */
149 __le32 OriginalCompressedSegmentSize;
150 __le16 CompressionAlgorithm;
152 __le16 Length; /* if chained it is length, else offset */
155 /* See MS-SMB2 2.2.42.1 */
156 struct compression_payload_header {
162 /* See MS-SMB2 2.2.42.2 */
163 struct compression_pattern_payload_v1 {
171 * SMB2 flag definitions
173 #define SMB2_FLAGS_SERVER_TO_REDIR cpu_to_le32(0x00000001)
174 #define SMB2_FLAGS_ASYNC_COMMAND cpu_to_le32(0x00000002)
175 #define SMB2_FLAGS_RELATED_OPERATIONS cpu_to_le32(0x00000004)
176 #define SMB2_FLAGS_SIGNED cpu_to_le32(0x00000008)
177 #define SMB2_FLAGS_PRIORITY_MASK cpu_to_le32(0x00000070) /* SMB3.1.1 */
178 #define SMB2_FLAGS_DFS_OPERATIONS cpu_to_le32(0x10000000)
179 #define SMB2_FLAGS_REPLAY_OPERATION cpu_to_le32(0x20000000) /* SMB3 & up */
182 * Definitions for SMB2 Protocol Data Units (network frames)
184 * See MS-SMB2.PDF specification for protocol details.
185 * The Naming convention is the lower case version of the SMB2
186 * command code name for the struct. Note that structures must be packed.
190 #define COMPOUND_FID 0xFFFFFFFFFFFFFFFFULL
192 #define SMB2_ERROR_STRUCTURE_SIZE2 cpu_to_le16(9)
194 struct smb2_err_rsp {
195 struct smb2_sync_hdr sync_hdr;
196 __le16 StructureSize;
197 __le16 Reserved; /* MBZ */
198 __le32 ByteCount; /* even if zero, at least one byte follows */
199 __u8 ErrorData[1]; /* variable length */
202 #define SYMLINK_ERROR_TAG 0x4c4d5953
204 struct smb2_symlink_err_rsp {
205 __le32 SymLinkLength;
206 __le32 SymLinkErrorTag;
208 __le16 ReparseDataLength;
209 __le16 UnparsedPathLength;
210 __le16 SubstituteNameOffset;
211 __le16 SubstituteNameLength;
212 __le16 PrintNameOffset;
213 __le16 PrintNameLength;
218 /* SMB 3.1.1 and later dialects. See MS-SMB2 section 2.2.2.1 */
219 struct smb2_error_context_rsp {
220 __le32 ErrorDataLength;
222 __u8 ErrorContextData; /* ErrorDataLength long array */
226 #define SMB2_ERROR_ID_DEFAULT 0x00000000
227 #define SMB2_ERROR_ID_SHARE_REDIRECT cpu_to_le32(0x72645253) /* "rdRS" */
229 /* Defines for Type field below (see MS-SMB2 2.2.2.2.2.1) */
230 #define MOVE_DST_IPADDR_V4 cpu_to_le32(0x00000001)
231 #define MOVE_DST_IPADDR_V6 cpu_to_le32(0x00000002)
233 struct move_dst_ipaddr {
236 __u8 address[16]; /* IPv4 followed by 12 bytes rsvd or IPv6 address */
239 struct share_redirect_error_context_rsp {
240 __le32 StructureSize;
241 __le32 NotificationType;
242 __le32 ResourceNameOffset;
243 __le32 ResourceNameLength;
247 struct move_dst_ipaddr IpAddrMoveList[];
248 /* __u8 ResourceName[] */ /* Name of share as counted Unicode string */
251 #define SMB2_CLIENT_GUID_SIZE 16
253 struct smb2_negotiate_req {
254 struct smb2_sync_hdr sync_hdr;
255 __le16 StructureSize; /* Must be 36 */
258 __le16 Reserved; /* MBZ */
260 __u8 ClientGUID[SMB2_CLIENT_GUID_SIZE];
261 /* In SMB3.02 and earlier next three were MBZ le64 ClientStartTime */
262 __le32 NegotiateContextOffset; /* SMB3.1.1 only. MBZ earlier */
263 __le16 NegotiateContextCount; /* SMB3.1.1 only. MBZ earlier */
265 __le16 Dialects[1]; /* One dialect (vers=) at a time for now */
269 #define SMB10_PROT_ID 0x0000 /* local only, not sent on wire w/CIFS negprot */
270 #define SMB20_PROT_ID 0x0202
271 #define SMB21_PROT_ID 0x0210
272 #define SMB30_PROT_ID 0x0300
273 #define SMB302_PROT_ID 0x0302
274 #define SMB311_PROT_ID 0x0311
275 #define BAD_PROT_ID 0xFFFF
277 /* SecurityMode flags */
278 #define SMB2_NEGOTIATE_SIGNING_ENABLED 0x0001
279 #define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
280 #define SMB2_SEC_MODE_FLAGS_ALL 0x0003
282 /* Capabilities flags */
283 #define SMB2_GLOBAL_CAP_DFS 0x00000001
284 #define SMB2_GLOBAL_CAP_LEASING 0x00000002 /* Resp only New to SMB2.1 */
285 #define SMB2_GLOBAL_CAP_LARGE_MTU 0X00000004 /* Resp only New to SMB2.1 */
286 #define SMB2_GLOBAL_CAP_MULTI_CHANNEL 0x00000008 /* New to SMB3 */
287 #define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
288 #define SMB2_GLOBAL_CAP_DIRECTORY_LEASING 0x00000020 /* New to SMB3 */
289 #define SMB2_GLOBAL_CAP_ENCRYPTION 0x00000040 /* New to SMB3 */
291 #define SMB2_NT_FIND 0x00100000
292 #define SMB2_LARGE_FILES 0x00200000
295 /* Negotiate Contexts - ContextTypes. See MS-SMB2 section 2.2.3.1 for details */
296 #define SMB2_PREAUTH_INTEGRITY_CAPABILITIES cpu_to_le16(1)
297 #define SMB2_ENCRYPTION_CAPABILITIES cpu_to_le16(2)
298 #define SMB2_COMPRESSION_CAPABILITIES cpu_to_le16(3)
299 #define SMB2_NETNAME_NEGOTIATE_CONTEXT_ID cpu_to_le16(5)
300 #define SMB2_POSIX_EXTENSIONS_AVAILABLE cpu_to_le16(0x100)
302 struct smb2_neg_context {
306 /* Followed by array of data */
309 #define SMB311_SALT_SIZE 32
310 /* Hash Algorithm Types */
311 #define SMB2_PREAUTH_INTEGRITY_SHA512 cpu_to_le16(0x0001)
312 #define SMB2_PREAUTH_HASH_SIZE 64
314 #define MIN_PREAUTH_CTXT_DATA_LEN (SMB311_SALT_SIZE + 6)
315 struct smb2_preauth_neg_context {
316 __le16 ContextType; /* 1 */
319 __le16 HashAlgorithmCount; /* 1 */
321 __le16 HashAlgorithms; /* HashAlgorithms[0] since only one defined */
322 __u8 Salt[SMB311_SALT_SIZE];
325 /* Encryption Algorithms Ciphers */
326 #define SMB2_ENCRYPTION_AES128_CCM cpu_to_le16(0x0001)
327 #define SMB2_ENCRYPTION_AES128_GCM cpu_to_le16(0x0002)
328 #define SMB2_ENCRYPTION_AES256_CCM cpu_to_le16(0x0003)
329 #define SMB2_ENCRYPTION_AES256_GCM cpu_to_le16(0x0004)
331 /* Min encrypt context data is one cipher so 2 bytes + 2 byte count field */
332 #define MIN_ENCRYPT_CTXT_DATA_LEN 4
333 struct smb2_encryption_neg_context {
334 __le16 ContextType; /* 2 */
337 __le16 CipherCount; /* AES-128-GCM and AES-128-CCM */
341 /* See MS-SMB2 2.2.3.1.3 */
342 #define SMB3_COMPRESS_NONE cpu_to_le16(0x0000)
343 #define SMB3_COMPRESS_LZNT1 cpu_to_le16(0x0001)
344 #define SMB3_COMPRESS_LZ77 cpu_to_le16(0x0002)
345 #define SMB3_COMPRESS_LZ77_HUFF cpu_to_le16(0x0003)
346 /* Pattern scanning algorithm See MS-SMB2 3.1.4.4.1 */
347 #define SMB3_COMPRESS_PATTERN cpu_to_le16(0x0004) /* Pattern_V1 */
349 /* Compression Flags */
350 #define SMB2_COMPRESSION_CAPABILITIES_FLAG_NONE cpu_to_le32(0x00000000)
351 #define SMB2_COMPRESSION_CAPABILITIES_FLAG_CHAINED cpu_to_le32(0x00000001)
353 struct smb2_compression_capabilities_context {
354 __le16 ContextType; /* 3 */
357 __le16 CompressionAlgorithmCount;
360 __le16 CompressionAlgorithms[3];
364 * For smb2_netname_negotiate_context_id See MS-SMB2 2.2.3.1.4.
365 * Its struct simply contains NetName, an array of Unicode characters
367 struct smb2_netname_neg_context {
368 __le16 ContextType; /* 0x100 */
371 __le16 NetName[]; /* hostname of target converted to UCS-2 */
374 #define POSIX_CTXT_DATA_LEN 16
375 struct smb2_posix_neg_context {
376 __le16 ContextType; /* 0x100 */
379 __u8 Name[16]; /* POSIX ctxt GUID 93AD25509CB411E7B42383DE968BCD7C */
382 struct smb2_negotiate_rsp {
383 struct smb2_sync_hdr sync_hdr;
384 __le16 StructureSize; /* Must be 65 */
386 __le16 DialectRevision;
387 __le16 NegotiateContextCount; /* Prior to SMB3.1.1 was Reserved & MBZ */
390 __le32 MaxTransactSize;
393 __le64 SystemTime; /* MBZ */
394 __le64 ServerStartTime;
395 __le16 SecurityBufferOffset;
396 __le16 SecurityBufferLength;
397 __le32 NegotiateContextOffset; /* Pre:SMB3.1.1 was reserved/ignored */
398 __u8 Buffer[1]; /* variable length GSS security buffer */
402 #define SMB2_SESSION_REQ_FLAG_BINDING 0x01
403 #define SMB2_SESSION_REQ_FLAG_ENCRYPT_DATA 0x04
405 struct smb2_sess_setup_req {
406 struct smb2_sync_hdr sync_hdr;
407 __le16 StructureSize; /* Must be 25 */
412 __le16 SecurityBufferOffset;
413 __le16 SecurityBufferLength;
414 __u64 PreviousSessionId;
415 __u8 Buffer[1]; /* variable length GSS security buffer */
418 /* Currently defined SessionFlags */
419 #define SMB2_SESSION_FLAG_IS_GUEST 0x0001
420 #define SMB2_SESSION_FLAG_IS_NULL 0x0002
421 #define SMB2_SESSION_FLAG_ENCRYPT_DATA 0x0004
422 struct smb2_sess_setup_rsp {
423 struct smb2_sync_hdr sync_hdr;
424 __le16 StructureSize; /* Must be 9 */
426 __le16 SecurityBufferOffset;
427 __le16 SecurityBufferLength;
428 __u8 Buffer[1]; /* variable length GSS security buffer */
431 struct smb2_logoff_req {
432 struct smb2_sync_hdr sync_hdr;
433 __le16 StructureSize; /* Must be 4 */
437 struct smb2_logoff_rsp {
438 struct smb2_sync_hdr sync_hdr;
439 __le16 StructureSize; /* Must be 4 */
443 /* Flags/Reserved for SMB3.1.1 */
444 #define SMB2_TREE_CONNECT_FLAG_CLUSTER_RECONNECT cpu_to_le16(0x0001)
445 #define SMB2_TREE_CONNECT_FLAG_REDIRECT_TO_OWNER cpu_to_le16(0x0002)
446 #define SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT cpu_to_le16(0x0004)
448 struct smb2_tree_connect_req {
449 struct smb2_sync_hdr sync_hdr;
450 __le16 StructureSize; /* Must be 9 */
451 __le16 Flags; /* Reserved MBZ for dialects prior to SMB3.1.1 */
454 __u8 Buffer[1]; /* variable length */
457 /* See MS-SMB2 section 2.2.9.2 */
459 #define SMB2_RESERVED_TREE_CONNECT_CONTEXT_ID 0x0000
460 #define SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID cpu_to_le16(0x0001)
462 struct tree_connect_contexts {
469 /* Remoted identity tree connect context structures - see MS-SMB2 2.2.9.2.1 */
470 struct smb3_blob_data {
475 /* Valid values for Attr */
476 #define SE_GROUP_MANDATORY 0x00000001
477 #define SE_GROUP_ENABLED_BY_DEFAULT 0x00000002
478 #define SE_GROUP_ENABLED 0x00000004
479 #define SE_GROUP_OWNER 0x00000008
480 #define SE_GROUP_USE_FOR_DENY_ONLY 0x00000010
481 #define SE_GROUP_INTEGRITY 0x00000020
482 #define SE_GROUP_INTEGRITY_ENABLED 0x00000040
483 #define SE_GROUP_RESOURCE 0x20000000
484 #define SE_GROUP_LOGON_ID 0xC0000000
486 /* struct sid_attr_data is SidData array in BlobData format then le32 Attr */
488 struct sid_array_data {
490 /* SidAttrList - array of sid_attr_data structs */
493 struct luid_attr_data {
498 * struct privilege_data is the same as BLOB_DATA - see MS-SMB2 2.2.9.2.1.5
499 * but with size of LUID_ATTR_DATA struct and BlobData set to LUID_ATTR DATA
502 struct privilege_array_data {
503 __le16 PrivilegeCount;
504 /* array of privilege_data structs */
507 struct remoted_identity_tcon_context {
508 __le16 TicketType; /* must be 0x0001 */
509 __le16 TicketSize; /* total size of this struct */
510 __le16 User; /* offset to SID_ATTR_DATA struct with user info */
511 __le16 UserName; /* offset to null terminated Unicode username string */
512 __le16 Domain; /* offset to null terminated Unicode domain name */
513 __le16 Groups; /* offset to SID_ARRAY_DATA struct with group info */
514 __le16 RestrictedGroups; /* similar to above */
515 __le16 Privileges; /* offset to PRIVILEGE_ARRAY_DATA struct */
516 __le16 PrimaryGroup; /* offset to SID_ARRAY_DATA struct */
517 __le16 Owner; /* offset to BLOB_DATA struct */
518 __le16 DefaultDacl; /* offset to BLOB_DATA struct */
519 __le16 DeviceGroups; /* offset to SID_ARRAY_DATA struct */
520 __le16 UserClaims; /* offset to BLOB_DATA struct */
521 __le16 DeviceClaims; /* offset to BLOB_DATA struct */
522 __u8 TicketInfo[]; /* variable length buf - remoted identity data */
525 struct smb2_tree_connect_req_extension {
526 __le32 TreeConnectContextOffset;
527 __le16 TreeConnectContextCount;
529 __u8 PathName[]; /* variable sized array */
530 /* followed by array of TreeConnectContexts */
533 struct smb2_tree_connect_rsp {
534 struct smb2_sync_hdr sync_hdr;
535 __le16 StructureSize; /* Must be 16 */
536 __u8 ShareType; /* see below */
538 __le32 ShareFlags; /* see below */
539 __le32 Capabilities; /* see below */
540 __le32 MaximalAccess;
543 /* Possible ShareType values */
544 #define SMB2_SHARE_TYPE_DISK 0x01
545 #define SMB2_SHARE_TYPE_PIPE 0x02
546 #define SMB2_SHARE_TYPE_PRINT 0x03
549 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
550 * must be set (any of the remaining, SHI1005, flags may be set individually
553 #define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
554 #define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
555 #define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
556 #define SMB2_SHAREFLAG_NO_CACHING 0x00000030
557 #define SHI1005_FLAGS_DFS 0x00000001
558 #define SHI1005_FLAGS_DFS_ROOT 0x00000002
559 #define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS 0x00000100
560 #define SHI1005_FLAGS_FORCE_SHARED_DELETE 0x00000200
561 #define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING 0x00000400
562 #define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
563 #define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK 0x00001000
564 #define SHI1005_FLAGS_ENABLE_HASH_V1 0x00002000
565 #define SHI1005_FLAGS_ENABLE_HASH_V2 0x00004000
566 #define SHI1005_FLAGS_ENCRYPT_DATA 0x00008000
567 #define SMB2_SHAREFLAG_IDENTITY_REMOTING 0x00040000 /* 3.1.1 */
568 #define SHI1005_FLAGS_ALL 0x0004FF33
570 /* Possible share capabilities */
571 #define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
572 #define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
573 #define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
574 #define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
575 #define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
576 #define SMB2_SHARE_CAP_REDIRECT_TO_OWNER cpu_to_le32(0x00000100) /* 3.1.1 */
578 struct smb2_tree_disconnect_req {
579 struct smb2_sync_hdr sync_hdr;
580 __le16 StructureSize; /* Must be 4 */
584 struct smb2_tree_disconnect_rsp {
585 struct smb2_sync_hdr sync_hdr;
586 __le16 StructureSize; /* Must be 4 */
590 /* File Attrubutes */
591 #define FILE_ATTRIBUTE_READONLY 0x00000001
592 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
593 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
594 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
595 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
596 #define FILE_ATTRIBUTE_NORMAL 0x00000080
597 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
598 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
599 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
600 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
601 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
602 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
603 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
604 #define FILE_ATTRIBUTE_INTEGRITY_STREAM 0x00008000
605 #define FILE_ATTRIBUTE_NO_SCRUB_DATA 0x00020000
608 #define SMB2_OPLOCK_LEVEL_NONE 0x00
609 #define SMB2_OPLOCK_LEVEL_II 0x01
610 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE 0x08
611 #define SMB2_OPLOCK_LEVEL_BATCH 0x09
612 #define SMB2_OPLOCK_LEVEL_LEASE 0xFF
613 /* Non-spec internal type */
614 #define SMB2_OPLOCK_LEVEL_NOCHANGE 0x99
616 /* Desired Access Flags */
617 #define FILE_READ_DATA_LE cpu_to_le32(0x00000001)
618 #define FILE_WRITE_DATA_LE cpu_to_le32(0x00000002)
619 #define FILE_APPEND_DATA_LE cpu_to_le32(0x00000004)
620 #define FILE_READ_EA_LE cpu_to_le32(0x00000008)
621 #define FILE_WRITE_EA_LE cpu_to_le32(0x00000010)
622 #define FILE_EXECUTE_LE cpu_to_le32(0x00000020)
623 #define FILE_READ_ATTRIBUTES_LE cpu_to_le32(0x00000080)
624 #define FILE_WRITE_ATTRIBUTES_LE cpu_to_le32(0x00000100)
625 #define FILE_DELETE_LE cpu_to_le32(0x00010000)
626 #define FILE_READ_CONTROL_LE cpu_to_le32(0x00020000)
627 #define FILE_WRITE_DAC_LE cpu_to_le32(0x00040000)
628 #define FILE_WRITE_OWNER_LE cpu_to_le32(0x00080000)
629 #define FILE_SYNCHRONIZE_LE cpu_to_le32(0x00100000)
630 #define FILE_ACCESS_SYSTEM_SECURITY_LE cpu_to_le32(0x01000000)
631 #define FILE_MAXIMAL_ACCESS_LE cpu_to_le32(0x02000000)
632 #define FILE_GENERIC_ALL_LE cpu_to_le32(0x10000000)
633 #define FILE_GENERIC_EXECUTE_LE cpu_to_le32(0x20000000)
634 #define FILE_GENERIC_WRITE_LE cpu_to_le32(0x40000000)
635 #define FILE_GENERIC_READ_LE cpu_to_le32(0x80000000)
637 /* ShareAccess Flags */
638 #define FILE_SHARE_READ_LE cpu_to_le32(0x00000001)
639 #define FILE_SHARE_WRITE_LE cpu_to_le32(0x00000002)
640 #define FILE_SHARE_DELETE_LE cpu_to_le32(0x00000004)
641 #define FILE_SHARE_ALL_LE cpu_to_le32(0x00000007)
643 /* CreateDisposition Flags */
644 #define FILE_SUPERSEDE_LE cpu_to_le32(0x00000000)
645 #define FILE_OPEN_LE cpu_to_le32(0x00000001)
646 #define FILE_CREATE_LE cpu_to_le32(0x00000002)
647 #define FILE_OPEN_IF_LE cpu_to_le32(0x00000003)
648 #define FILE_OVERWRITE_LE cpu_to_le32(0x00000004)
649 #define FILE_OVERWRITE_IF_LE cpu_to_le32(0x00000005)
651 /* CreateOptions Flags */
652 #define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
653 /* same as #define CREATE_NOT_FILE_LE cpu_to_le32(0x00000001) */
654 #define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
655 #define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
656 #define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
657 #define FILE_SYNCHRONOUS_IO_ALERT_LE cpu_to_le32(0x00000010)
658 #define FILE_SYNCHRONOUS_IO_NON_ALERT_LE cpu_to_le32(0x00000020)
659 #define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
660 #define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
661 #define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
662 #define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
663 #define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000)
664 #define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
665 #define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
666 #define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
667 #define FILE_RESERVE_OPFILTER_LE cpu_to_le32(0x00100000)
668 #define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
669 #define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
670 #define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
672 #define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
673 | FILE_READ_ATTRIBUTES_LE)
674 #define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
675 | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
676 #define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
678 /* Impersonation Levels. See MS-WPO section 9.7 and MSDN-IMPERS */
679 #define IL_ANONYMOUS cpu_to_le32(0x00000000)
680 #define IL_IDENTIFICATION cpu_to_le32(0x00000001)
681 #define IL_IMPERSONATION cpu_to_le32(0x00000002)
682 #define IL_DELEGATE cpu_to_le32(0x00000003)
684 /* Create Context Values */
685 #define SMB2_CREATE_EA_BUFFER "ExtA" /* extended attributes */
686 #define SMB2_CREATE_SD_BUFFER "SecD" /* security descriptor */
687 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST "DHnQ"
688 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT "DHnC"
689 #define SMB2_CREATE_ALLOCATION_SIZE "AISi"
690 #define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
691 #define SMB2_CREATE_TIMEWARP_REQUEST "TWrp"
692 #define SMB2_CREATE_QUERY_ON_DISK_ID "QFid"
693 #define SMB2_CREATE_REQUEST_LEASE "RqLs"
694 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST_V2 "DH2Q"
695 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT_V2 "DH2C"
696 #define SMB2_CREATE_APP_INSTANCE_ID 0x45BCA66AEFA7F74A9008FA462E144D74
697 #define SMB2_CREATE_APP_INSTANCE_VERSION 0xB982D0B73B56074FA07B524A8116A010
698 #define SVHDX_OPEN_DEVICE_CONTEX 0x9CCBCF9E04C1E643980E158DA1F6EC83
699 #define SMB2_CREATE_TAG_POSIX 0x93AD25509CB411E7B42383DE968BCD7C
701 /* Flag (SMB3 open response) values */
702 #define SMB2_CREATE_FLAG_REPARSEPOINT 0x01
705 * Maximum number of iovs we need for an open/create request.
706 * [0] : struct smb2_create_req
708 * [2] : lease context
709 * [3] : durable context
710 * [4] : posix context
711 * [5] : time warp context
712 * [6] : query id context
713 * [7] : compound padding
715 #define SMB2_CREATE_IOV_SIZE 8
717 struct smb2_create_req {
718 struct smb2_sync_hdr sync_hdr;
719 __le16 StructureSize; /* Must be 57 */
721 __u8 RequestedOplockLevel;
722 __le32 ImpersonationLevel;
723 __le64 SmbCreateFlags;
725 __le32 DesiredAccess;
726 __le32 FileAttributes;
728 __le32 CreateDisposition;
729 __le32 CreateOptions;
732 __le32 CreateContextsOffset;
733 __le32 CreateContextsLength;
738 * Maximum size of a SMB2_CREATE response is 64 (smb2 header) +
739 * 88 (fixed part of create response) + 520 (path) + 208 (contexts) +
740 * 2 bytes of padding.
742 #define MAX_SMB2_CREATE_RESPONSE_SIZE 880
744 struct smb2_create_rsp {
745 struct smb2_sync_hdr sync_hdr;
746 __le16 StructureSize; /* Must be 89 */
748 __u8 Flag; /* 0x01 if reparse point */
751 __le64 LastAccessTime;
752 __le64 LastWriteTime;
754 __le64 AllocationSize;
756 __le32 FileAttributes;
758 __u64 PersistentFileId; /* opaque endianness */
759 __u64 VolatileFileId; /* opaque endianness */
760 __le32 CreateContextsOffset;
761 __le32 CreateContextsLength;
765 struct create_context {
775 #define SMB2_LEASE_READ_CACHING_HE 0x01
776 #define SMB2_LEASE_HANDLE_CACHING_HE 0x02
777 #define SMB2_LEASE_WRITE_CACHING_HE 0x04
779 #define SMB2_LEASE_NONE cpu_to_le32(0x00)
780 #define SMB2_LEASE_READ_CACHING cpu_to_le32(0x01)
781 #define SMB2_LEASE_HANDLE_CACHING cpu_to_le32(0x02)
782 #define SMB2_LEASE_WRITE_CACHING cpu_to_le32(0x04)
784 #define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS cpu_to_le32(0x00000002)
785 #define SMB2_LEASE_FLAG_PARENT_LEASE_KEY_SET cpu_to_le32(0x00000004)
787 #define SMB2_LEASE_KEY_SIZE 16
789 struct lease_context {
790 u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
793 __le64 LeaseDuration;
796 struct lease_context_v2 {
797 u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
800 __le64 LeaseDuration;
801 __le64 ParentLeaseKeyLow;
802 __le64 ParentLeaseKeyHigh;
807 struct create_lease {
808 struct create_context ccontext;
810 struct lease_context lcontext;
813 struct create_lease_v2 {
814 struct create_context ccontext;
816 struct lease_context_v2 lcontext;
820 struct create_durable {
821 struct create_context ccontext;
826 __u64 PersistentFileId;
827 __u64 VolatileFileId;
832 struct create_posix {
833 struct create_context ccontext;
839 /* See MS-SMB2 2.2.13.2.11 */
841 #define SMB2_DHANDLE_FLAG_PERSISTENT 0x00000002
842 struct durable_context_v2 {
849 struct create_durable_v2 {
850 struct create_context ccontext;
852 struct durable_context_v2 dcontext;
855 /* See MS-SMB2 2.2.13.2.12 */
856 struct durable_reconnect_context_v2 {
858 __u64 PersistentFileId;
859 __u64 VolatileFileId;
862 __le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
865 /* See MS-SMB2 2.2.14.2.9 */
866 struct create_on_disk_id {
867 struct create_context ccontext;
874 /* See MS-SMB2 2.2.14.2.12 */
875 struct durable_reconnect_context_v2_rsp {
877 __le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
880 struct create_durable_handle_reconnect_v2 {
881 struct create_context ccontext;
883 struct durable_reconnect_context_v2 dcontext;
887 /* See MS-SMB2 2.2.13.2.5 */
888 struct crt_twarp_ctxt {
889 struct create_context ccontext;
895 /* See MS-SMB2 2.2.13.2.9 */
896 struct crt_query_id_ctxt {
897 struct create_context ccontext;
902 struct create_context ccontext;
906 /* Followed by at least 4 ACEs */
910 #define COPY_CHUNK_RES_KEY_SIZE 24
911 struct resume_key_req {
912 char ResumeKey[COPY_CHUNK_RES_KEY_SIZE];
913 __le32 ContextLength; /* MBZ */
914 char Context[]; /* ignored, Windows sets to 4 bytes of zero */
917 /* this goes in the ioctl buffer when doing a copychunk request */
918 struct copychunk_ioctl {
919 char SourceKey[COPY_CHUNK_RES_KEY_SIZE];
920 __le32 ChunkCount; /* we are only sending 1 */
922 /* array will only be one chunk long for us */
925 __le32 Length; /* how many bytes to copy */
929 /* this goes in the ioctl buffer when doing FSCTL_SET_ZERO_DATA */
930 struct file_zero_data_information {
932 __le64 BeyondFinalZero;
935 struct copychunk_ioctl_rsp {
936 __le32 ChunksWritten;
937 __le32 ChunkBytesWritten;
938 __le32 TotalBytesWritten;
941 struct fsctl_set_integrity_information_req {
942 __le16 ChecksumAlgorithm;
947 struct fsctl_get_integrity_information_rsp {
948 __le16 ChecksumAlgorithm;
951 __le32 ChecksumChunkSizeInBytes;
952 __le32 ClusterSizeInBytes;
955 struct file_allocated_range_buffer {
960 /* Integrity ChecksumAlgorithm choices for above */
961 #define CHECKSUM_TYPE_NONE 0x0000
962 #define CHECKSUM_TYPE_CRC64 0x0002
963 #define CHECKSUM_TYPE_UNCHANGED 0xFFFF /* set only */
965 /* Integrity flags for above */
966 #define FSCTL_INTEGRITY_FLAG_CHECKSUM_ENFORCEMENT_OFF 0x00000001
968 /* Reparse structures - see MS-FSCC 2.1.2 */
970 /* struct fsctl_reparse_info_req is empty, only response structs (see below) */
972 struct reparse_data_buffer {
974 __le16 ReparseDataLength;
976 __u8 DataBuffer[]; /* Variable Length */
979 struct reparse_guid_data_buffer {
981 __le16 ReparseDataLength;
983 __u8 ReparseGuid[16];
984 __u8 DataBuffer[]; /* Variable Length */
987 struct reparse_mount_point_data_buffer {
989 __le16 ReparseDataLength;
991 __le16 SubstituteNameOffset;
992 __le16 SubstituteNameLength;
993 __le16 PrintNameOffset;
994 __le16 PrintNameLength;
995 __u8 PathBuffer[]; /* Variable Length */
998 #define SYMLINK_FLAG_RELATIVE 0x00000001
1000 struct reparse_symlink_data_buffer {
1002 __le16 ReparseDataLength;
1004 __le16 SubstituteNameOffset;
1005 __le16 SubstituteNameLength;
1006 __le16 PrintNameOffset;
1007 __le16 PrintNameLength;
1009 __u8 PathBuffer[]; /* Variable Length */
1012 /* See MS-FSCC 2.1.2.6 and cifspdu.h for struct reparse_posix_data */
1015 /* See MS-DFSC 2.2.2 */
1016 struct fsctl_get_dfs_referral_req {
1017 __le16 MaxReferralLevel;
1018 __u8 RequestFileName[];
1021 /* DFS response is struct get_dfs_refer_rsp */
1023 /* See MS-SMB2 2.2.31.3 */
1024 struct network_resiliency_req {
1028 /* There is no buffer for the response ie no struct network_resiliency_rsp */
1031 struct validate_negotiate_info_req {
1032 __le32 Capabilities;
1033 __u8 Guid[SMB2_CLIENT_GUID_SIZE];
1034 __le16 SecurityMode;
1035 __le16 DialectCount;
1036 __le16 Dialects[4]; /* BB expand this if autonegotiate > 4 dialects */
1039 struct validate_negotiate_info_rsp {
1040 __le32 Capabilities;
1041 __u8 Guid[SMB2_CLIENT_GUID_SIZE];
1042 __le16 SecurityMode;
1043 __le16 Dialect; /* Dialect in use for the connection */
1046 #define RSS_CAPABLE cpu_to_le32(0x00000001)
1047 #define RDMA_CAPABLE cpu_to_le32(0x00000002)
1049 #define INTERNETWORK cpu_to_le16(0x0002)
1050 #define INTERNETWORKV6 cpu_to_le16(0x0017)
1052 struct network_interface_info_ioctl_rsp {
1053 __le32 Next; /* next interface. zero if this is last one */
1055 __le32 Capability; /* RSS or RDMA Capable */
1062 struct iface_info_ipv4 {
1068 struct iface_info_ipv6 {
1071 __u8 IPv6Address[16];
1075 #define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
1077 struct compress_ioctl {
1078 __le16 CompressionState; /* See cifspdu.h for possible flag values */
1081 struct duplicate_extents_to_file {
1082 __u64 PersistentFileHandle; /* source file handle, opaque endianness */
1083 __u64 VolatileFileHandle;
1084 __le64 SourceFileOffset;
1085 __le64 TargetFileOffset;
1086 __le64 ByteCount; /* Bytes to be copied */
1090 * Maximum number of iovs we need for an ioctl request.
1091 * [0] : struct smb2_ioctl_req
1094 #define SMB2_IOCTL_IOV_SIZE 2
1096 struct smb2_ioctl_req {
1097 struct smb2_sync_hdr sync_hdr;
1098 __le16 StructureSize; /* Must be 57 */
1101 __u64 PersistentFileId; /* opaque endianness */
1102 __u64 VolatileFileId; /* opaque endianness */
1105 __le32 MaxInputResponse;
1106 __le32 OutputOffset;
1108 __le32 MaxOutputResponse;
1114 struct smb2_ioctl_rsp {
1115 struct smb2_sync_hdr sync_hdr;
1116 __le16 StructureSize; /* Must be 57 */
1119 __u64 PersistentFileId; /* opaque endianness */
1120 __u64 VolatileFileId; /* opaque endianness */
1123 __le32 OutputOffset;
1127 /* char * buffer[] */
1130 /* Currently defined values for close flags */
1131 #define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
1132 struct smb2_close_req {
1133 struct smb2_sync_hdr sync_hdr;
1134 __le16 StructureSize; /* Must be 24 */
1137 __u64 PersistentFileId; /* opaque endianness */
1138 __u64 VolatileFileId; /* opaque endianness */
1142 * Maximum size of a SMB2_CLOSE response is 64 (smb2 header) + 60 (data)
1144 #define MAX_SMB2_CLOSE_RESPONSE_SIZE 124
1146 struct smb2_close_rsp {
1147 struct smb2_sync_hdr sync_hdr;
1148 __le16 StructureSize; /* 60 */
1151 __le64 CreationTime;
1152 __le64 LastAccessTime;
1153 __le64 LastWriteTime;
1155 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
1160 struct smb2_flush_req {
1161 struct smb2_sync_hdr sync_hdr;
1162 __le16 StructureSize; /* Must be 24 */
1165 __u64 PersistentFileId; /* opaque endianness */
1166 __u64 VolatileFileId; /* opaque endianness */
1169 struct smb2_flush_rsp {
1170 struct smb2_sync_hdr sync_hdr;
1171 __le16 StructureSize;
1175 /* For read request Flags field below, following flag is defined for SMB3.02 */
1176 #define SMB2_READFLAG_READ_UNBUFFERED 0x01
1177 #define SMB2_READFLAG_REQUEST_COMPRESSED 0x02 /* See MS-SMB2 2.2.19 */
1179 /* Channel field for read and write: exactly one of following flags can be set*/
1180 #define SMB2_CHANNEL_NONE cpu_to_le32(0x00000000)
1181 #define SMB2_CHANNEL_RDMA_V1 cpu_to_le32(0x00000001) /* SMB3 or later */
1182 #define SMB2_CHANNEL_RDMA_V1_INVALIDATE cpu_to_le32(0x00000002) /* >= SMB3.02 */
1184 /* SMB2 read request without RFC1001 length at the beginning */
1185 struct smb2_read_plain_req {
1186 struct smb2_sync_hdr sync_hdr;
1187 __le16 StructureSize; /* Must be 49 */
1188 __u8 Padding; /* offset from start of SMB2 header to place read */
1189 __u8 Flags; /* MBZ unless SMB3.02 or later */
1192 __u64 PersistentFileId; /* opaque endianness */
1193 __u64 VolatileFileId; /* opaque endianness */
1194 __le32 MinimumCount;
1195 __le32 Channel; /* MBZ except for SMB3 or later */
1196 __le32 RemainingBytes;
1197 __le16 ReadChannelInfoOffset;
1198 __le16 ReadChannelInfoLength;
1202 struct smb2_read_rsp {
1203 struct smb2_sync_hdr sync_hdr;
1204 __le16 StructureSize; /* Must be 17 */
1208 __le32 DataRemaining;
1213 /* For write request Flags field below the following flags are defined: */
1214 #define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
1215 #define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
1217 struct smb2_write_req {
1218 struct smb2_sync_hdr sync_hdr;
1219 __le16 StructureSize; /* Must be 49 */
1220 __le16 DataOffset; /* offset from start of SMB2 header to write data */
1223 __u64 PersistentFileId; /* opaque endianness */
1224 __u64 VolatileFileId; /* opaque endianness */
1225 __le32 Channel; /* MBZ unless SMB3.02 or later */
1226 __le32 RemainingBytes;
1227 __le16 WriteChannelInfoOffset;
1228 __le16 WriteChannelInfoLength;
1233 struct smb2_write_rsp {
1234 struct smb2_sync_hdr sync_hdr;
1235 __le16 StructureSize; /* Must be 17 */
1239 __le32 DataRemaining;
1245 #define SMB2_WATCH_TREE 0x0001
1247 /* notify completion filter flags. See MS-FSCC 2.6 and MS-SMB2 2.2.35 */
1248 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x00000001
1249 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x00000002
1250 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x00000004
1251 #define FILE_NOTIFY_CHANGE_SIZE 0x00000008
1252 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x00000010
1253 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x00000020
1254 #define FILE_NOTIFY_CHANGE_CREATION 0x00000040
1255 #define FILE_NOTIFY_CHANGE_EA 0x00000080
1256 #define FILE_NOTIFY_CHANGE_SECURITY 0x00000100
1257 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1258 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1259 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1261 struct smb2_change_notify_req {
1262 struct smb2_sync_hdr sync_hdr;
1263 __le16 StructureSize;
1265 __le32 OutputBufferLength;
1266 __u64 PersistentFileId; /* opaque endianness */
1267 __u64 VolatileFileId; /* opaque endianness */
1268 __le32 CompletionFilter;
1272 struct smb2_change_notify_rsp {
1273 struct smb2_sync_hdr sync_hdr;
1274 __le16 StructureSize; /* Must be 9 */
1275 __le16 OutputBufferOffset;
1276 __le32 OutputBufferLength;
1277 __u8 Buffer[1]; /* array of file notify structs */
1280 #define SMB2_LOCKFLAG_SHARED_LOCK 0x0001
1281 #define SMB2_LOCKFLAG_EXCLUSIVE_LOCK 0x0002
1282 #define SMB2_LOCKFLAG_UNLOCK 0x0004
1283 #define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
1285 struct smb2_lock_element {
1292 struct smb2_lock_req {
1293 struct smb2_sync_hdr sync_hdr;
1294 __le16 StructureSize; /* Must be 48 */
1297 __u64 PersistentFileId; /* opaque endianness */
1298 __u64 VolatileFileId; /* opaque endianness */
1299 /* Followed by at least one */
1300 struct smb2_lock_element locks[1];
1303 struct smb2_lock_rsp {
1304 struct smb2_sync_hdr sync_hdr;
1305 __le16 StructureSize; /* Must be 4 */
1309 struct smb2_echo_req {
1310 struct smb2_sync_hdr sync_hdr;
1311 __le16 StructureSize; /* Must be 4 */
1315 struct smb2_echo_rsp {
1316 struct smb2_sync_hdr sync_hdr;
1317 __le16 StructureSize; /* Must be 4 */
1321 /* search (query_directory) Flags field */
1322 #define SMB2_RESTART_SCANS 0x01
1323 #define SMB2_RETURN_SINGLE_ENTRY 0x02
1324 #define SMB2_INDEX_SPECIFIED 0x04
1325 #define SMB2_REOPEN 0x10
1327 #define SMB2_QUERY_DIRECTORY_IOV_SIZE 2
1329 struct smb2_query_directory_req {
1330 struct smb2_sync_hdr sync_hdr;
1331 __le16 StructureSize; /* Must be 33 */
1332 __u8 FileInformationClass;
1335 __u64 PersistentFileId; /* opaque endianness */
1336 __u64 VolatileFileId; /* opaque endianness */
1337 __le16 FileNameOffset;
1338 __le16 FileNameLength;
1339 __le32 OutputBufferLength;
1343 struct smb2_query_directory_rsp {
1344 struct smb2_sync_hdr sync_hdr;
1345 __le16 StructureSize; /* Must be 9 */
1346 __le16 OutputBufferOffset;
1347 __le32 OutputBufferLength;
1351 /* Possible InfoType values */
1352 #define SMB2_O_INFO_FILE 0x01
1353 #define SMB2_O_INFO_FILESYSTEM 0x02
1354 #define SMB2_O_INFO_SECURITY 0x03
1355 #define SMB2_O_INFO_QUOTA 0x04
1357 /* Security info type additionalinfo flags. See MS-SMB2 (2.2.37) or MS-DTYP */
1358 #define OWNER_SECINFO 0x00000001
1359 #define GROUP_SECINFO 0x00000002
1360 #define DACL_SECINFO 0x00000004
1361 #define SACL_SECINFO 0x00000008
1362 #define LABEL_SECINFO 0x00000010
1363 #define ATTRIBUTE_SECINFO 0x00000020
1364 #define SCOPE_SECINFO 0x00000040
1365 #define BACKUP_SECINFO 0x00010000
1366 #define UNPROTECTED_SACL_SECINFO 0x10000000
1367 #define UNPROTECTED_DACL_SECINFO 0x20000000
1368 #define PROTECTED_SACL_SECINFO 0x40000000
1369 #define PROTECTED_DACL_SECINFO 0x80000000
1371 /* Flags used for FileFullEAinfo */
1372 #define SL_RESTART_SCAN 0x00000001
1373 #define SL_RETURN_SINGLE_ENTRY 0x00000002
1374 #define SL_INDEX_SPECIFIED 0x00000004
1376 struct smb2_query_info_req {
1377 struct smb2_sync_hdr sync_hdr;
1378 __le16 StructureSize; /* Must be 41 */
1381 __le32 OutputBufferLength;
1382 __le16 InputBufferOffset;
1384 __le32 InputBufferLength;
1385 __le32 AdditionalInformation;
1387 __u64 PersistentFileId; /* opaque endianness */
1388 __u64 VolatileFileId; /* opaque endianness */
1392 struct smb2_query_info_rsp {
1393 struct smb2_sync_hdr sync_hdr;
1394 __le16 StructureSize; /* Must be 9 */
1395 __le16 OutputBufferOffset;
1396 __le32 OutputBufferLength;
1401 * Maximum number of iovs we need for a set-info request.
1402 * The largest one is rename/hardlink
1403 * [0] : struct smb2_set_info_req + smb2_file_[rename|link]_info
1405 * [2] : compound padding
1407 #define SMB2_SET_INFO_IOV_SIZE 3
1409 struct smb2_set_info_req {
1410 struct smb2_sync_hdr sync_hdr;
1411 __le16 StructureSize; /* Must be 33 */
1414 __le32 BufferLength;
1415 __le16 BufferOffset;
1417 __le32 AdditionalInformation;
1418 __u64 PersistentFileId; /* opaque endianness */
1419 __u64 VolatileFileId; /* opaque endianness */
1423 struct smb2_set_info_rsp {
1424 struct smb2_sync_hdr sync_hdr;
1425 __le16 StructureSize; /* Must be 2 */
1428 struct smb2_oplock_break {
1429 struct smb2_sync_hdr sync_hdr;
1430 __le16 StructureSize; /* Must be 24 */
1434 __u64 PersistentFid;
1438 #define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
1440 struct smb2_lease_break {
1441 struct smb2_sync_hdr sync_hdr;
1442 __le16 StructureSize; /* Must be 44 */
1446 __le32 CurrentLeaseState;
1447 __le32 NewLeaseState;
1449 __le32 AccessMaskHint;
1450 __le32 ShareMaskHint;
1453 struct smb2_lease_ack {
1454 struct smb2_sync_hdr sync_hdr;
1455 __le16 StructureSize; /* Must be 36 */
1460 __le64 LeaseDuration;
1464 * PDU infolevel structure definitions
1465 * BB consider moving to a different header
1468 /* File System Information Classes */
1469 #define FS_VOLUME_INFORMATION 1 /* Query */
1470 #define FS_LABEL_INFORMATION 2 /* Local only */
1471 #define FS_SIZE_INFORMATION 3 /* Query */
1472 #define FS_DEVICE_INFORMATION 4 /* Query */
1473 #define FS_ATTRIBUTE_INFORMATION 5 /* Query */
1474 #define FS_CONTROL_INFORMATION 6 /* Query, Set */
1475 #define FS_FULL_SIZE_INFORMATION 7 /* Query */
1476 #define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
1477 #define FS_DRIVER_PATH_INFORMATION 9 /* Local only */
1478 #define FS_VOLUME_FLAGS_INFORMATION 10 /* Local only */
1479 #define FS_SECTOR_SIZE_INFORMATION 11 /* SMB3 or later. Query */
1480 #define FS_POSIX_INFORMATION 100 /* SMB3.1.1 POSIX. Query */
1482 struct smb2_fs_full_size_info {
1483 __le64 TotalAllocationUnits;
1484 __le64 CallerAvailableAllocationUnits;
1485 __le64 ActualAvailableAllocationUnits;
1486 __le32 SectorsPerAllocationUnit;
1487 __le32 BytesPerSector;
1490 #define SSINFO_FLAGS_ALIGNED_DEVICE 0x00000001
1491 #define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
1492 #define SSINFO_FLAGS_NO_SEEK_PENALTY 0x00000004
1493 #define SSINFO_FLAGS_TRIM_ENABLED 0x00000008
1495 /* sector size info struct */
1496 struct smb3_fs_ss_info {
1497 __le32 LogicalBytesPerSector;
1498 __le32 PhysicalBytesPerSectorForAtomicity;
1499 __le32 PhysicalBytesPerSectorForPerf;
1500 __le32 FileSystemEffectivePhysicalBytesPerSectorForAtomicity;
1502 __le32 ByteOffsetForSectorAlignment;
1503 __le32 ByteOffsetForPartitionAlignment;
1506 /* volume info struct - see MS-FSCC 2.5.9 */
1507 #define MAX_VOL_LABEL_LEN 32
1508 struct smb3_fs_vol_info {
1509 __le64 VolumeCreationTime;
1510 __u32 VolumeSerialNumber;
1511 __le32 VolumeLabelLength; /* includes trailing null */
1512 __u8 SupportsObjects; /* True if eg like NTFS, supports objects */
1514 __u8 VolumeLabel[]; /* variable len */
1517 /* partial list of QUERY INFO levels */
1518 #define FILE_DIRECTORY_INFORMATION 1
1519 #define FILE_FULL_DIRECTORY_INFORMATION 2
1520 #define FILE_BOTH_DIRECTORY_INFORMATION 3
1521 #define FILE_BASIC_INFORMATION 4
1522 #define FILE_STANDARD_INFORMATION 5
1523 #define FILE_INTERNAL_INFORMATION 6
1524 #define FILE_EA_INFORMATION 7
1525 #define FILE_ACCESS_INFORMATION 8
1526 #define FILE_NAME_INFORMATION 9
1527 #define FILE_RENAME_INFORMATION 10
1528 #define FILE_LINK_INFORMATION 11
1529 #define FILE_NAMES_INFORMATION 12
1530 #define FILE_DISPOSITION_INFORMATION 13
1531 #define FILE_POSITION_INFORMATION 14
1532 #define FILE_FULL_EA_INFORMATION 15
1533 #define FILE_MODE_INFORMATION 16
1534 #define FILE_ALIGNMENT_INFORMATION 17
1535 #define FILE_ALL_INFORMATION 18
1536 #define FILE_ALLOCATION_INFORMATION 19
1537 #define FILE_END_OF_FILE_INFORMATION 20
1538 #define FILE_ALTERNATE_NAME_INFORMATION 21
1539 #define FILE_STREAM_INFORMATION 22
1540 #define FILE_PIPE_INFORMATION 23
1541 #define FILE_PIPE_LOCAL_INFORMATION 24
1542 #define FILE_PIPE_REMOTE_INFORMATION 25
1543 #define FILE_MAILSLOT_QUERY_INFORMATION 26
1544 #define FILE_MAILSLOT_SET_INFORMATION 27
1545 #define FILE_COMPRESSION_INFORMATION 28
1546 #define FILE_OBJECT_ID_INFORMATION 29
1547 /* Number 30 not defined in documents */
1548 #define FILE_MOVE_CLUSTER_INFORMATION 31
1549 #define FILE_QUOTA_INFORMATION 32
1550 #define FILE_REPARSE_POINT_INFORMATION 33
1551 #define FILE_NETWORK_OPEN_INFORMATION 34
1552 #define FILE_ATTRIBUTE_TAG_INFORMATION 35
1553 #define FILE_TRACKING_INFORMATION 36
1554 #define FILEID_BOTH_DIRECTORY_INFORMATION 37
1555 #define FILEID_FULL_DIRECTORY_INFORMATION 38
1556 #define FILE_VALID_DATA_LENGTH_INFORMATION 39
1557 #define FILE_SHORT_NAME_INFORMATION 40
1558 #define FILE_SFIO_RESERVE_INFORMATION 44
1559 #define FILE_SFIO_VOLUME_INFORMATION 45
1560 #define FILE_HARD_LINK_INFORMATION 46
1561 #define FILE_NORMALIZED_NAME_INFORMATION 48
1562 #define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
1563 #define FILE_STANDARD_LINK_INFORMATION 54
1564 #define FILE_ID_INFORMATION 59
1566 struct smb2_file_internal_info {
1568 } __packed; /* level 6 Query */
1570 struct smb2_file_rename_info { /* encoding of request for level 10 */
1571 __u8 ReplaceIfExists; /* 1 = replace existing target with new */
1572 /* 0 = fail if target already exists */
1574 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
1575 __le32 FileNameLength;
1576 char FileName[]; /* New name to be assigned */
1577 } __packed; /* level 10 Set */
1579 struct smb2_file_link_info { /* encoding of request for level 11 */
1580 __u8 ReplaceIfExists; /* 1 = replace existing link with new */
1581 /* 0 = fail if link already exists */
1583 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
1584 __le32 FileNameLength;
1585 char FileName[]; /* Name to be assigned to new link */
1586 } __packed; /* level 11 Set */
1588 struct smb2_file_full_ea_info { /* encoding of response for level 15 */
1589 __le32 next_entry_offset;
1591 __u8 ea_name_length;
1592 __le16 ea_value_length;
1593 char ea_data[]; /* \0 terminated name plus value */
1594 } __packed; /* level 15 Set */
1597 * This level 18, although with struct with same name is different from cifs
1598 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
1599 * CurrentByteOffset.
1601 struct smb2_file_all_info { /* data block encoding of response to level 18 */
1602 __le64 CreationTime; /* Beginning of FILE_BASIC_INFO equivalent */
1603 __le64 LastAccessTime;
1604 __le64 LastWriteTime;
1607 __u32 Pad1; /* End of FILE_BASIC_INFO_INFO equivalent */
1608 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
1609 __le64 EndOfFile; /* size ie offset to first free byte in file */
1610 __le32 NumberOfLinks; /* hard links */
1613 __u16 Pad2; /* End of FILE_STANDARD_INFO equivalent */
1617 __le64 CurrentByteOffset;
1619 __le32 AlignmentRequirement;
1620 __le32 FileNameLength;
1622 } __packed; /* level 18 Query */
1624 struct smb2_file_eof_info { /* encoding of request for level 10 */
1625 __le64 EndOfFile; /* new end of file value */
1626 } __packed; /* level 20 Set */
1628 struct smb2_file_network_open_info {
1629 __le64 CreationTime;
1630 __le64 LastAccessTime;
1631 __le64 LastWriteTime;
1633 __le64 AllocationSize;
1637 } __packed; /* level 34 Query also similar returned in close rsp and open rsp */
1639 /* See MS-FSCC 2.4.43 */
1640 struct smb2_file_id_information {
1641 __le64 VolumeSerialNumber;
1642 __u64 PersistentFileId; /* opaque endianness */
1643 __u64 VolatileFileId; /* opaque endianness */
1644 } __packed; /* level 59 */
1646 extern char smb2_padding[7];
1648 /* equivalent of the contents of SMB3.1.1 POSIX open context response */
1649 struct create_posix_rsp {
1653 struct cifs_sid owner; /* var-sized on the wire */
1654 struct cifs_sid group; /* var-sized on the wire */
1658 * SMB2-only POSIX info level for query dir
1660 * See posix_info_sid_size(), posix_info_extra_size() and
1661 * posix_info_parse() to help with the handling of this struct.
1663 struct smb2_posix_info {
1664 __le32 NextEntryOffset;
1666 __le64 CreationTime;
1667 __le64 LastAccessTime;
1668 __le64 LastWriteTime;
1671 __le64 AllocationSize;
1672 __le32 DosAttributes;
1676 /* beginning of POSIX Create Context Response */
1681 * var sized owner SID
1682 * var sized group SID
1683 * le32 filenamelength
1688 /* Level 100 query info */
1689 struct smb311_posix_qinfo {
1690 __le64 CreationTime;
1691 __le64 LastAccessTime;
1692 __le64 LastWriteTime;
1695 __le64 AllocationSize;
1696 __le32 DosAttributes;
1700 /* beginning of POSIX Create Context Response */
1706 * var sized owner SID
1707 * var sized group SID
1708 * le32 filenamelength
1714 * Parsed version of the above struct. Allows direct access to the
1715 * variable length fields
1717 struct smb2_posix_info_parsed {
1718 const struct smb2_posix_info *base;
1720 struct cifs_sid owner;
1721 struct cifs_sid group;
1726 #endif /* _SMB2PDU_H */