4 * Copyright (c) International Business Machines Corp., 2009, 2013
6 * Author(s): Steve French (sfrench@us.ibm.com)
7 * Pavel Shilovsky (pshilovsky@samba.org) 2012
9 * This library is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as published
11 * by the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
17 * the GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this library; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
31 * Note that, due to trying to use names similar to the protocol specifications,
32 * there are many mixed case field names in the structures below. Although
33 * this does not match typical Linux kernel style, it is necessary to be
34 * be able to match against the protocol specfication.
37 * Some commands have minimal (wct=0,bcc=0), or uninteresting, responses
38 * (ie no useful data other than the SMB error code itself) and are marked such.
39 * Knowing this helps avoid response buffer allocations and copy in some cases.
42 /* List of commands in host endian */
43 #define SMB2_NEGOTIATE_HE 0x0000
44 #define SMB2_SESSION_SETUP_HE 0x0001
45 #define SMB2_LOGOFF_HE 0x0002 /* trivial request/resp */
46 #define SMB2_TREE_CONNECT_HE 0x0003
47 #define SMB2_TREE_DISCONNECT_HE 0x0004 /* trivial req/resp */
48 #define SMB2_CREATE_HE 0x0005
49 #define SMB2_CLOSE_HE 0x0006
50 #define SMB2_FLUSH_HE 0x0007 /* trivial resp */
51 #define SMB2_READ_HE 0x0008
52 #define SMB2_WRITE_HE 0x0009
53 #define SMB2_LOCK_HE 0x000A
54 #define SMB2_IOCTL_HE 0x000B
55 #define SMB2_CANCEL_HE 0x000C
56 #define SMB2_ECHO_HE 0x000D
57 #define SMB2_QUERY_DIRECTORY_HE 0x000E
58 #define SMB2_CHANGE_NOTIFY_HE 0x000F
59 #define SMB2_QUERY_INFO_HE 0x0010
60 #define SMB2_SET_INFO_HE 0x0011
61 #define SMB2_OPLOCK_BREAK_HE 0x0012
63 /* The same list in little endian */
64 #define SMB2_NEGOTIATE cpu_to_le16(SMB2_NEGOTIATE_HE)
65 #define SMB2_SESSION_SETUP cpu_to_le16(SMB2_SESSION_SETUP_HE)
66 #define SMB2_LOGOFF cpu_to_le16(SMB2_LOGOFF_HE)
67 #define SMB2_TREE_CONNECT cpu_to_le16(SMB2_TREE_CONNECT_HE)
68 #define SMB2_TREE_DISCONNECT cpu_to_le16(SMB2_TREE_DISCONNECT_HE)
69 #define SMB2_CREATE cpu_to_le16(SMB2_CREATE_HE)
70 #define SMB2_CLOSE cpu_to_le16(SMB2_CLOSE_HE)
71 #define SMB2_FLUSH cpu_to_le16(SMB2_FLUSH_HE)
72 #define SMB2_READ cpu_to_le16(SMB2_READ_HE)
73 #define SMB2_WRITE cpu_to_le16(SMB2_WRITE_HE)
74 #define SMB2_LOCK cpu_to_le16(SMB2_LOCK_HE)
75 #define SMB2_IOCTL cpu_to_le16(SMB2_IOCTL_HE)
76 #define SMB2_CANCEL cpu_to_le16(SMB2_CANCEL_HE)
77 #define SMB2_ECHO cpu_to_le16(SMB2_ECHO_HE)
78 #define SMB2_QUERY_DIRECTORY cpu_to_le16(SMB2_QUERY_DIRECTORY_HE)
79 #define SMB2_CHANGE_NOTIFY cpu_to_le16(SMB2_CHANGE_NOTIFY_HE)
80 #define SMB2_QUERY_INFO cpu_to_le16(SMB2_QUERY_INFO_HE)
81 #define SMB2_SET_INFO cpu_to_le16(SMB2_SET_INFO_HE)
82 #define SMB2_OPLOCK_BREAK cpu_to_le16(SMB2_OPLOCK_BREAK_HE)
84 #define SMB2_INTERNAL_CMD cpu_to_le16(0xFFFF)
86 #define NUMBER_OF_SMB2_COMMANDS 0x0013
88 /* 52 transform hdr + 64 hdr + 88 create rsp */
89 #define SMB2_TRANSFORM_HEADER_SIZE 52
90 #define MAX_SMB2_HDR_SIZE 204
92 #define SMB2_PROTO_NUMBER cpu_to_le32(0x424d53fe)
93 #define SMB2_TRANSFORM_PROTO_NUM cpu_to_le32(0x424d53fd)
96 * SMB2 Header Definition
98 * "MBZ" : Must be Zero
99 * "BB" : BugBug, Something to check/review/analyze later
100 * "PDU" : "Protocol Data Unit" (ie a network "frame")
104 #define SMB2_HEADER_STRUCTURE_SIZE cpu_to_le16(64)
106 struct smb2_sync_hdr {
107 __le32 ProtocolId; /* 0xFE 'S' 'M' 'B' */
108 __le16 StructureSize; /* 64 */
109 __le16 CreditCharge; /* MBZ */
110 __le32 Status; /* Error from server */
112 __le16 CreditRequest; /* CreditResponse */
117 __u32 TreeId; /* opaque - so do not make little endian */
118 __u64 SessionId; /* opaque - so do not make little endian */
122 struct smb2_sync_pdu {
123 struct smb2_sync_hdr sync_hdr;
124 __le16 StructureSize2; /* size of wct area (varies, request specific) */
127 #define SMB3_AES128CCM_NONCE 11
128 #define SMB3_AES128GCM_NONCE 12
130 struct smb2_transform_hdr {
131 __le32 ProtocolId; /* 0xFD 'S' 'M' 'B' */
134 __le32 OriginalMessageSize;
136 __le16 Flags; /* EncryptionAlgorithm */
140 /* See MS-SMB2 2.2.42.1 */
141 struct compression_playload_header {
147 /* See MS-SMB2 2.2.42.2 */
148 struct compression_pattern_payload_v1 {
156 * SMB2 flag definitions
158 #define SMB2_FLAGS_SERVER_TO_REDIR cpu_to_le32(0x00000001)
159 #define SMB2_FLAGS_ASYNC_COMMAND cpu_to_le32(0x00000002)
160 #define SMB2_FLAGS_RELATED_OPERATIONS cpu_to_le32(0x00000004)
161 #define SMB2_FLAGS_SIGNED cpu_to_le32(0x00000008)
162 #define SMB2_FLAGS_PRIORITY_MASK cpu_to_le32(0x00000070) /* SMB3.1.1 */
163 #define SMB2_FLAGS_DFS_OPERATIONS cpu_to_le32(0x10000000)
164 #define SMB2_FLAGS_REPLAY_OPERATION cpu_to_le32(0x20000000) /* SMB3 & up */
167 * Definitions for SMB2 Protocol Data Units (network frames)
169 * See MS-SMB2.PDF specification for protocol details.
170 * The Naming convention is the lower case version of the SMB2
171 * command code name for the struct. Note that structures must be packed.
175 #define COMPOUND_FID 0xFFFFFFFFFFFFFFFFULL
177 #define SMB2_ERROR_STRUCTURE_SIZE2 cpu_to_le16(9)
179 struct smb2_err_rsp {
180 struct smb2_sync_hdr sync_hdr;
181 __le16 StructureSize;
182 __le16 Reserved; /* MBZ */
183 __le32 ByteCount; /* even if zero, at least one byte follows */
184 __u8 ErrorData[1]; /* variable length */
187 #define SYMLINK_ERROR_TAG 0x4c4d5953
189 struct smb2_symlink_err_rsp {
190 __le32 SymLinkLength;
191 __le32 SymLinkErrorTag;
193 __le16 ReparseDataLength;
194 __le16 UnparsedPathLength;
195 __le16 SubstituteNameOffset;
196 __le16 SubstituteNameLength;
197 __le16 PrintNameOffset;
198 __le16 PrintNameLength;
203 /* SMB 3.1.1 and later dialects. See MS-SMB2 section 2.2.2.1 */
204 struct smb2_error_context_rsp {
205 __le32 ErrorDataLength;
207 __u8 ErrorContextData; /* ErrorDataLength long array */
210 /* Defines for Type field below (see MS-SMB2 2.2.2.2.2.1) */
211 #define MOVE_DST_IPADDR_V4 cpu_to_le32(0x00000001)
212 #define MOVE_DST_IPADDR_V6 cpu_to_le32(0x00000002)
214 struct move_dst_ipaddr {
217 __u8 address[16]; /* IPv4 followed by 12 bytes rsvd or IPv6 address */
220 struct share_redirect_error_context_rsp {
221 __le32 StructureSize;
222 __le32 NotificationType;
223 __le32 ResourceNameOffset;
224 __le32 ResourceNameLength;
228 struct move_dst_ipaddr IpAddrMoveList[];
229 /* __u8 ResourceName[] */ /* Name of share as counted Unicode string */
232 #define SMB2_CLIENT_GUID_SIZE 16
234 struct smb2_negotiate_req {
235 struct smb2_sync_hdr sync_hdr;
236 __le16 StructureSize; /* Must be 36 */
239 __le16 Reserved; /* MBZ */
241 __u8 ClientGUID[SMB2_CLIENT_GUID_SIZE];
242 /* In SMB3.02 and earlier next three were MBZ le64 ClientStartTime */
243 __le32 NegotiateContextOffset; /* SMB3.1.1 only. MBZ earlier */
244 __le16 NegotiateContextCount; /* SMB3.1.1 only. MBZ earlier */
246 __le16 Dialects[1]; /* One dialect (vers=) at a time for now */
250 #define SMB10_PROT_ID 0x0000 /* local only, not sent on wire w/CIFS negprot */
251 #define SMB20_PROT_ID 0x0202
252 #define SMB21_PROT_ID 0x0210
253 #define SMB30_PROT_ID 0x0300
254 #define SMB302_PROT_ID 0x0302
255 #define SMB311_PROT_ID 0x0311
256 #define BAD_PROT_ID 0xFFFF
258 /* SecurityMode flags */
259 #define SMB2_NEGOTIATE_SIGNING_ENABLED 0x0001
260 #define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
261 #define SMB2_SEC_MODE_FLAGS_ALL 0x0003
263 /* Capabilities flags */
264 #define SMB2_GLOBAL_CAP_DFS 0x00000001
265 #define SMB2_GLOBAL_CAP_LEASING 0x00000002 /* Resp only New to SMB2.1 */
266 #define SMB2_GLOBAL_CAP_LARGE_MTU 0X00000004 /* Resp only New to SMB2.1 */
267 #define SMB2_GLOBAL_CAP_MULTI_CHANNEL 0x00000008 /* New to SMB3 */
268 #define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
269 #define SMB2_GLOBAL_CAP_DIRECTORY_LEASING 0x00000020 /* New to SMB3 */
270 #define SMB2_GLOBAL_CAP_ENCRYPTION 0x00000040 /* New to SMB3 */
272 #define SMB2_NT_FIND 0x00100000
273 #define SMB2_LARGE_FILES 0x00200000
276 /* Negotiate Contexts - ContextTypes. See MS-SMB2 section 2.2.3.1 for details */
277 #define SMB2_PREAUTH_INTEGRITY_CAPABILITIES cpu_to_le16(1)
278 #define SMB2_ENCRYPTION_CAPABILITIES cpu_to_le16(2)
279 #define SMB2_COMPRESSION_CAPABILITIES cpu_to_le16(3)
280 #define SMB2_NETNAME_NEGOTIATE_CONTEXT_ID cpu_to_le16(5)
281 #define SMB2_POSIX_EXTENSIONS_AVAILABLE cpu_to_le16(0x100)
283 struct smb2_neg_context {
287 /* Followed by array of data */
290 #define SMB311_SALT_SIZE 32
291 /* Hash Algorithm Types */
292 #define SMB2_PREAUTH_INTEGRITY_SHA512 cpu_to_le16(0x0001)
293 #define SMB2_PREAUTH_HASH_SIZE 64
295 #define MIN_PREAUTH_CTXT_DATA_LEN (SMB311_SALT_SIZE + 6)
296 struct smb2_preauth_neg_context {
297 __le16 ContextType; /* 1 */
300 __le16 HashAlgorithmCount; /* 1 */
302 __le16 HashAlgorithms; /* HashAlgorithms[0] since only one defined */
303 __u8 Salt[SMB311_SALT_SIZE];
306 /* Encryption Algorithms Ciphers */
307 #define SMB2_ENCRYPTION_AES128_CCM cpu_to_le16(0x0001)
308 #define SMB2_ENCRYPTION_AES128_GCM cpu_to_le16(0x0002)
310 /* Min encrypt context data is one cipher so 2 bytes + 2 byte count field */
311 #define MIN_ENCRYPT_CTXT_DATA_LEN 4
312 struct smb2_encryption_neg_context {
313 __le16 ContextType; /* 2 */
316 __le16 CipherCount; /* AES-128-GCM and AES-128-CCM */
320 /* See MS-SMB2 2.2.3.1.3 */
321 #define SMB3_COMPRESS_NONE cpu_to_le16(0x0000)
322 #define SMB3_COMPRESS_LZNT1 cpu_to_le16(0x0001)
323 #define SMB3_COMPRESS_LZ77 cpu_to_le16(0x0002)
324 #define SMB3_COMPRESS_LZ77_HUFF cpu_to_le16(0x0003)
325 /* Pattern scanning algorithm See MS-SMB2 3.1.4.4.1 */
326 #define SMB3_COMPRESS_PATTERN cpu_to_le16(0x0004)
328 /* Compression Flags */
329 #define SMB2_COMPRESSION_CAPABILITIES_FLAG_NONE cpu_to_le32(0x00000000)
330 #define SMB2_COMPRESSION_CAPABILITIES_FLAG_CHAINED cpu_to_le32(0x00000001)
332 struct smb2_compression_capabilities_context {
333 __le16 ContextType; /* 3 */
336 __le16 CompressionAlgorithmCount;
339 __le16 CompressionAlgorithms[3];
343 * For smb2_netname_negotiate_context_id See MS-SMB2 2.2.3.1.4.
344 * Its struct simply contains NetName, an array of Unicode characters
346 struct smb2_netname_neg_context {
347 __le16 ContextType; /* 0x100 */
350 __le16 NetName[]; /* hostname of target converted to UCS-2 */
353 #define POSIX_CTXT_DATA_LEN 16
354 struct smb2_posix_neg_context {
355 __le16 ContextType; /* 0x100 */
358 __u8 Name[16]; /* POSIX ctxt GUID 93AD25509CB411E7B42383DE968BCD7C */
361 struct smb2_negotiate_rsp {
362 struct smb2_sync_hdr sync_hdr;
363 __le16 StructureSize; /* Must be 65 */
365 __le16 DialectRevision;
366 __le16 NegotiateContextCount; /* Prior to SMB3.1.1 was Reserved & MBZ */
369 __le32 MaxTransactSize;
372 __le64 SystemTime; /* MBZ */
373 __le64 ServerStartTime;
374 __le16 SecurityBufferOffset;
375 __le16 SecurityBufferLength;
376 __le32 NegotiateContextOffset; /* Pre:SMB3.1.1 was reserved/ignored */
377 __u8 Buffer[1]; /* variable length GSS security buffer */
381 #define SMB2_SESSION_REQ_FLAG_BINDING 0x01
382 #define SMB2_SESSION_REQ_FLAG_ENCRYPT_DATA 0x04
384 struct smb2_sess_setup_req {
385 struct smb2_sync_hdr sync_hdr;
386 __le16 StructureSize; /* Must be 25 */
391 __le16 SecurityBufferOffset;
392 __le16 SecurityBufferLength;
393 __u64 PreviousSessionId;
394 __u8 Buffer[1]; /* variable length GSS security buffer */
397 /* Currently defined SessionFlags */
398 #define SMB2_SESSION_FLAG_IS_GUEST 0x0001
399 #define SMB2_SESSION_FLAG_IS_NULL 0x0002
400 #define SMB2_SESSION_FLAG_ENCRYPT_DATA 0x0004
401 struct smb2_sess_setup_rsp {
402 struct smb2_sync_hdr sync_hdr;
403 __le16 StructureSize; /* Must be 9 */
405 __le16 SecurityBufferOffset;
406 __le16 SecurityBufferLength;
407 __u8 Buffer[1]; /* variable length GSS security buffer */
410 struct smb2_logoff_req {
411 struct smb2_sync_hdr sync_hdr;
412 __le16 StructureSize; /* Must be 4 */
416 struct smb2_logoff_rsp {
417 struct smb2_sync_hdr sync_hdr;
418 __le16 StructureSize; /* Must be 4 */
422 /* Flags/Reserved for SMB3.1.1 */
423 #define SMB2_TREE_CONNECT_FLAG_CLUSTER_RECONNECT cpu_to_le16(0x0001)
424 #define SMB2_TREE_CONNECT_FLAG_REDIRECT_TO_OWNER cpu_to_le16(0x0002)
425 #define SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT cpu_to_le16(0x0004)
427 struct smb2_tree_connect_req {
428 struct smb2_sync_hdr sync_hdr;
429 __le16 StructureSize; /* Must be 9 */
430 __le16 Reserved; /* Flags in SMB3.1.1 */
433 __u8 Buffer[1]; /* variable length */
436 /* See MS-SMB2 section 2.2.9.2 */
438 #define SMB2_RESERVED_TREE_CONNECT_CONTEXT_ID 0x0000
439 #define SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID cpu_to_le16(0x0001)
441 struct tree_connect_contexts {
448 /* Remoted identity tree connect context structures - see MS-SMB2 2.2.9.2.1 */
449 struct smb3_blob_data {
454 /* Valid values for Attr */
455 #define SE_GROUP_MANDATORY 0x00000001
456 #define SE_GROUP_ENABLED_BY_DEFAULT 0x00000002
457 #define SE_GROUP_ENABLED 0x00000004
458 #define SE_GROUP_OWNER 0x00000008
459 #define SE_GROUP_USE_FOR_DENY_ONLY 0x00000010
460 #define SE_GROUP_INTEGRITY 0x00000020
461 #define SE_GROUP_INTEGRITY_ENABLED 0x00000040
462 #define SE_GROUP_RESOURCE 0x20000000
463 #define SE_GROUP_LOGON_ID 0xC0000000
465 /* struct sid_attr_data is SidData array in BlobData format then le32 Attr */
467 struct sid_array_data {
469 /* SidAttrList - array of sid_attr_data structs */
472 struct luid_attr_data {
477 * struct privilege_data is the same as BLOB_DATA - see MS-SMB2 2.2.9.2.1.5
478 * but with size of LUID_ATTR_DATA struct and BlobData set to LUID_ATTR DATA
481 struct privilege_array_data {
482 __le16 PrivilegeCount;
483 /* array of privilege_data structs */
486 struct remoted_identity_tcon_context {
487 __le16 TicketType; /* must be 0x0001 */
488 __le16 TicketSize; /* total size of this struct */
489 __le16 User; /* offset to SID_ATTR_DATA struct with user info */
490 __le16 UserName; /* offset to null terminated Unicode username string */
491 __le16 Domain; /* offset to null terminated Unicode domain name */
492 __le16 Groups; /* offset to SID_ARRAY_DATA struct with group info */
493 __le16 RestrictedGroups; /* similar to above */
494 __le16 Privileges; /* offset to PRIVILEGE_ARRAY_DATA struct */
495 __le16 PrimaryGroup; /* offset to SID_ARRAY_DATA struct */
496 __le16 Owner; /* offset to BLOB_DATA struct */
497 __le16 DefaultDacl; /* offset to BLOB_DATA struct */
498 __le16 DeviceGroups; /* offset to SID_ARRAY_DATA struct */
499 __le16 UserClaims; /* offset to BLOB_DATA struct */
500 __le16 DeviceClaims; /* offset to BLOB_DATA struct */
501 __u8 TicketInfo[]; /* variable length buf - remoted identity data */
504 struct smb2_tree_connect_req_extension {
505 __le32 TreeConnectContextOffset;
506 __le16 TreeConnectContextCount;
508 __u8 PathName[]; /* variable sized array */
509 /* followed by array of TreeConnectContexts */
512 struct smb2_tree_connect_rsp {
513 struct smb2_sync_hdr sync_hdr;
514 __le16 StructureSize; /* Must be 16 */
515 __u8 ShareType; /* see below */
517 __le32 ShareFlags; /* see below */
518 __le32 Capabilities; /* see below */
519 __le32 MaximalAccess;
522 /* Possible ShareType values */
523 #define SMB2_SHARE_TYPE_DISK 0x01
524 #define SMB2_SHARE_TYPE_PIPE 0x02
525 #define SMB2_SHARE_TYPE_PRINT 0x03
528 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
529 * must be set (any of the remaining, SHI1005, flags may be set individually
532 #define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
533 #define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
534 #define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
535 #define SMB2_SHAREFLAG_NO_CACHING 0x00000030
536 #define SHI1005_FLAGS_DFS 0x00000001
537 #define SHI1005_FLAGS_DFS_ROOT 0x00000002
538 #define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS 0x00000100
539 #define SHI1005_FLAGS_FORCE_SHARED_DELETE 0x00000200
540 #define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING 0x00000400
541 #define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
542 #define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK 0x00001000
543 #define SHI1005_FLAGS_ENABLE_HASH_V1 0x00002000
544 #define SHI1005_FLAGS_ENABLE_HASH_V2 0x00004000
545 #define SHI1005_FLAGS_ENCRYPT_DATA 0x00008000
546 #define SMB2_SHAREFLAG_IDENTITY_REMOTING 0x00040000 /* 3.1.1 */
547 #define SHI1005_FLAGS_ALL 0x0004FF33
549 /* Possible share capabilities */
550 #define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
551 #define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
552 #define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
553 #define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
554 #define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
555 #define SMB2_SHARE_CAP_REDIRECT_TO_OWNER cpu_to_le32(0x00000100) /* 3.1.1 */
557 struct smb2_tree_disconnect_req {
558 struct smb2_sync_hdr sync_hdr;
559 __le16 StructureSize; /* Must be 4 */
563 struct smb2_tree_disconnect_rsp {
564 struct smb2_sync_hdr sync_hdr;
565 __le16 StructureSize; /* Must be 4 */
569 /* File Attrubutes */
570 #define FILE_ATTRIBUTE_READONLY 0x00000001
571 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
572 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
573 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
574 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
575 #define FILE_ATTRIBUTE_NORMAL 0x00000080
576 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
577 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
578 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
579 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
580 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
581 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
582 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
583 #define FILE_ATTRIBUTE_INTEGRITY_STREAM 0x00008000
584 #define FILE_ATTRIBUTE_NO_SCRUB_DATA 0x00020000
587 #define SMB2_OPLOCK_LEVEL_NONE 0x00
588 #define SMB2_OPLOCK_LEVEL_II 0x01
589 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE 0x08
590 #define SMB2_OPLOCK_LEVEL_BATCH 0x09
591 #define SMB2_OPLOCK_LEVEL_LEASE 0xFF
592 /* Non-spec internal type */
593 #define SMB2_OPLOCK_LEVEL_NOCHANGE 0x99
595 /* Desired Access Flags */
596 #define FILE_READ_DATA_LE cpu_to_le32(0x00000001)
597 #define FILE_WRITE_DATA_LE cpu_to_le32(0x00000002)
598 #define FILE_APPEND_DATA_LE cpu_to_le32(0x00000004)
599 #define FILE_READ_EA_LE cpu_to_le32(0x00000008)
600 #define FILE_WRITE_EA_LE cpu_to_le32(0x00000010)
601 #define FILE_EXECUTE_LE cpu_to_le32(0x00000020)
602 #define FILE_READ_ATTRIBUTES_LE cpu_to_le32(0x00000080)
603 #define FILE_WRITE_ATTRIBUTES_LE cpu_to_le32(0x00000100)
604 #define FILE_DELETE_LE cpu_to_le32(0x00010000)
605 #define FILE_READ_CONTROL_LE cpu_to_le32(0x00020000)
606 #define FILE_WRITE_DAC_LE cpu_to_le32(0x00040000)
607 #define FILE_WRITE_OWNER_LE cpu_to_le32(0x00080000)
608 #define FILE_SYNCHRONIZE_LE cpu_to_le32(0x00100000)
609 #define FILE_ACCESS_SYSTEM_SECURITY_LE cpu_to_le32(0x01000000)
610 #define FILE_MAXIMAL_ACCESS_LE cpu_to_le32(0x02000000)
611 #define FILE_GENERIC_ALL_LE cpu_to_le32(0x10000000)
612 #define FILE_GENERIC_EXECUTE_LE cpu_to_le32(0x20000000)
613 #define FILE_GENERIC_WRITE_LE cpu_to_le32(0x40000000)
614 #define FILE_GENERIC_READ_LE cpu_to_le32(0x80000000)
616 /* ShareAccess Flags */
617 #define FILE_SHARE_READ_LE cpu_to_le32(0x00000001)
618 #define FILE_SHARE_WRITE_LE cpu_to_le32(0x00000002)
619 #define FILE_SHARE_DELETE_LE cpu_to_le32(0x00000004)
620 #define FILE_SHARE_ALL_LE cpu_to_le32(0x00000007)
622 /* CreateDisposition Flags */
623 #define FILE_SUPERSEDE_LE cpu_to_le32(0x00000000)
624 #define FILE_OPEN_LE cpu_to_le32(0x00000001)
625 #define FILE_CREATE_LE cpu_to_le32(0x00000002)
626 #define FILE_OPEN_IF_LE cpu_to_le32(0x00000003)
627 #define FILE_OVERWRITE_LE cpu_to_le32(0x00000004)
628 #define FILE_OVERWRITE_IF_LE cpu_to_le32(0x00000005)
630 /* CreateOptions Flags */
631 #define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
632 /* same as #define CREATE_NOT_FILE_LE cpu_to_le32(0x00000001) */
633 #define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
634 #define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
635 #define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
636 #define FILE_SYNCHRONOUS_IO_ALERT_LE cpu_to_le32(0x00000010)
637 #define FILE_SYNCHRONOUS_IO_NON_ALERT_LE cpu_to_le32(0x00000020)
638 #define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
639 #define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
640 #define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
641 #define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
642 #define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000)
643 #define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
644 #define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
645 #define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
646 #define FILE_RESERVE_OPFILTER_LE cpu_to_le32(0x00100000)
647 #define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
648 #define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
649 #define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
651 #define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
652 | FILE_READ_ATTRIBUTES_LE)
653 #define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
654 | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
655 #define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
657 /* Impersonation Levels */
658 #define IL_ANONYMOUS cpu_to_le32(0x00000000)
659 #define IL_IDENTIFICATION cpu_to_le32(0x00000001)
660 #define IL_IMPERSONATION cpu_to_le32(0x00000002)
661 #define IL_DELEGATE cpu_to_le32(0x00000003)
663 /* Create Context Values */
664 #define SMB2_CREATE_EA_BUFFER "ExtA" /* extended attributes */
665 #define SMB2_CREATE_SD_BUFFER "SecD" /* security descriptor */
666 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST "DHnQ"
667 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT "DHnC"
668 #define SMB2_CREATE_ALLOCATION_SIZE "AISi"
669 #define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
670 #define SMB2_CREATE_TIMEWARP_REQUEST "TWrp"
671 #define SMB2_CREATE_QUERY_ON_DISK_ID "QFid"
672 #define SMB2_CREATE_REQUEST_LEASE "RqLs"
673 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST_V2 "DH2Q"
674 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT_V2 "DH2C"
675 #define SMB2_CREATE_APP_INSTANCE_ID 0x45BCA66AEFA7F74A9008FA462E144D74
676 #define SMB2_CREATE_APP_INSTANCE_VERSION 0xB982D0B73B56074FA07B524A8116A010
677 #define SVHDX_OPEN_DEVICE_CONTEX 0x9CCBCF9E04C1E643980E158DA1F6EC83
678 #define SMB2_CREATE_TAG_POSIX 0x93AD25509CB411E7B42383DE968BCD7C
680 /* Flag (SMB3 open response) values */
681 #define SMB2_CREATE_FLAG_REPARSEPOINT 0x01
684 * Maximum number of iovs we need for an open/create request.
685 * [0] : struct smb2_create_req
687 * [2] : lease context
688 * [3] : durable context
689 * [4] : posix context
690 * [5] : time warp context
691 * [6] : query id context
692 * [7] : compound padding
694 #define SMB2_CREATE_IOV_SIZE 8
696 struct smb2_create_req {
697 struct smb2_sync_hdr sync_hdr;
698 __le16 StructureSize; /* Must be 57 */
700 __u8 RequestedOplockLevel;
701 __le32 ImpersonationLevel;
702 __le64 SmbCreateFlags;
704 __le32 DesiredAccess;
705 __le32 FileAttributes;
707 __le32 CreateDisposition;
708 __le32 CreateOptions;
711 __le32 CreateContextsOffset;
712 __le32 CreateContextsLength;
717 * Maximum size of a SMB2_CREATE response is 64 (smb2 header) +
718 * 88 (fixed part of create response) + 520 (path) + 208 (contexts) +
719 * 2 bytes of padding.
721 #define MAX_SMB2_CREATE_RESPONSE_SIZE 880
723 struct smb2_create_rsp {
724 struct smb2_sync_hdr sync_hdr;
725 __le16 StructureSize; /* Must be 89 */
727 __u8 Flag; /* 0x01 if reparse point */
730 __le64 LastAccessTime;
731 __le64 LastWriteTime;
733 __le64 AllocationSize;
735 __le32 FileAttributes;
737 __u64 PersistentFileId; /* opaque endianness */
738 __u64 VolatileFileId; /* opaque endianness */
739 __le32 CreateContextsOffset;
740 __le32 CreateContextsLength;
744 struct create_context {
754 #define SMB2_LEASE_READ_CACHING_HE 0x01
755 #define SMB2_LEASE_HANDLE_CACHING_HE 0x02
756 #define SMB2_LEASE_WRITE_CACHING_HE 0x04
758 #define SMB2_LEASE_NONE cpu_to_le32(0x00)
759 #define SMB2_LEASE_READ_CACHING cpu_to_le32(0x01)
760 #define SMB2_LEASE_HANDLE_CACHING cpu_to_le32(0x02)
761 #define SMB2_LEASE_WRITE_CACHING cpu_to_le32(0x04)
763 #define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS cpu_to_le32(0x02)
764 #define SMB2_LEASE_FLAG_PARENT_LEASE_KEY_SET cpu_to_le32(0x00000004)
766 #define SMB2_LEASE_KEY_SIZE 16
768 struct lease_context {
769 u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
772 __le64 LeaseDuration;
775 struct lease_context_v2 {
776 u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
779 __le64 LeaseDuration;
780 __le64 ParentLeaseKeyLow;
781 __le64 ParentLeaseKeyHigh;
786 struct create_lease {
787 struct create_context ccontext;
789 struct lease_context lcontext;
792 struct create_lease_v2 {
793 struct create_context ccontext;
795 struct lease_context_v2 lcontext;
799 struct create_durable {
800 struct create_context ccontext;
805 __u64 PersistentFileId;
806 __u64 VolatileFileId;
811 struct create_posix {
812 struct create_context ccontext;
818 /* See MS-SMB2 2.2.13.2.11 */
820 #define SMB2_DHANDLE_FLAG_PERSISTENT 0x00000002
821 struct durable_context_v2 {
828 struct create_durable_v2 {
829 struct create_context ccontext;
831 struct durable_context_v2 dcontext;
834 /* See MS-SMB2 2.2.13.2.12 */
835 struct durable_reconnect_context_v2 {
837 __u64 PersistentFileId;
838 __u64 VolatileFileId;
841 __le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
844 /* See MS-SMB2 2.2.14.2.9 */
845 struct create_on_disk_id {
846 struct create_context ccontext;
853 /* See MS-SMB2 2.2.14.2.12 */
854 struct durable_reconnect_context_v2_rsp {
856 __le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
859 struct create_durable_handle_reconnect_v2 {
860 struct create_context ccontext;
862 struct durable_reconnect_context_v2 dcontext;
866 /* See MS-SMB2 2.2.13.2.5 */
867 struct crt_twarp_ctxt {
868 struct create_context ccontext;
874 /* See MS-SMB2 2.2.13.2.9 */
875 struct crt_query_id_ctxt {
876 struct create_context ccontext;
881 struct create_context ccontext;
885 /* Followed by at least 4 ACEs */
889 #define COPY_CHUNK_RES_KEY_SIZE 24
890 struct resume_key_req {
891 char ResumeKey[COPY_CHUNK_RES_KEY_SIZE];
892 __le32 ContextLength; /* MBZ */
893 char Context[]; /* ignored, Windows sets to 4 bytes of zero */
896 /* this goes in the ioctl buffer when doing a copychunk request */
897 struct copychunk_ioctl {
898 char SourceKey[COPY_CHUNK_RES_KEY_SIZE];
899 __le32 ChunkCount; /* we are only sending 1 */
901 /* array will only be one chunk long for us */
904 __le32 Length; /* how many bytes to copy */
908 /* this goes in the ioctl buffer when doing FSCTL_SET_ZERO_DATA */
909 struct file_zero_data_information {
911 __le64 BeyondFinalZero;
914 struct copychunk_ioctl_rsp {
915 __le32 ChunksWritten;
916 __le32 ChunkBytesWritten;
917 __le32 TotalBytesWritten;
920 struct fsctl_set_integrity_information_req {
921 __le16 ChecksumAlgorithm;
926 struct fsctl_get_integrity_information_rsp {
927 __le16 ChecksumAlgorithm;
930 __le32 ChecksumChunkSizeInBytes;
931 __le32 ClusterSizeInBytes;
934 struct file_allocated_range_buffer {
939 /* Integrity ChecksumAlgorithm choices for above */
940 #define CHECKSUM_TYPE_NONE 0x0000
941 #define CHECKSUM_TYPE_CRC64 0x0002
942 #define CHECKSUM_TYPE_UNCHANGED 0xFFFF /* set only */
944 /* Integrity flags for above */
945 #define FSCTL_INTEGRITY_FLAG_CHECKSUM_ENFORCEMENT_OFF 0x00000001
947 /* Reparse structures - see MS-FSCC 2.1.2 */
949 /* struct fsctl_reparse_info_req is empty, only response structs (see below) */
951 struct reparse_data_buffer {
953 __le16 ReparseDataLength;
955 __u8 DataBuffer[]; /* Variable Length */
958 struct reparse_guid_data_buffer {
960 __le16 ReparseDataLength;
962 __u8 ReparseGuid[16];
963 __u8 DataBuffer[]; /* Variable Length */
966 struct reparse_mount_point_data_buffer {
968 __le16 ReparseDataLength;
970 __le16 SubstituteNameOffset;
971 __le16 SubstituteNameLength;
972 __le16 PrintNameOffset;
973 __le16 PrintNameLength;
974 __u8 PathBuffer[]; /* Variable Length */
977 #define SYMLINK_FLAG_RELATIVE 0x00000001
979 struct reparse_symlink_data_buffer {
981 __le16 ReparseDataLength;
983 __le16 SubstituteNameOffset;
984 __le16 SubstituteNameLength;
985 __le16 PrintNameOffset;
986 __le16 PrintNameLength;
988 __u8 PathBuffer[]; /* Variable Length */
991 /* See MS-FSCC 2.1.2.6 and cifspdu.h for struct reparse_posix_data */
994 /* See MS-DFSC 2.2.2 */
995 struct fsctl_get_dfs_referral_req {
996 __le16 MaxReferralLevel;
997 __u8 RequestFileName[];
1000 /* DFS response is struct get_dfs_refer_rsp */
1002 /* See MS-SMB2 2.2.31.3 */
1003 struct network_resiliency_req {
1007 /* There is no buffer for the response ie no struct network_resiliency_rsp */
1010 struct validate_negotiate_info_req {
1011 __le32 Capabilities;
1012 __u8 Guid[SMB2_CLIENT_GUID_SIZE];
1013 __le16 SecurityMode;
1014 __le16 DialectCount;
1015 __le16 Dialects[4]; /* BB expand this if autonegotiate > 4 dialects */
1018 struct validate_negotiate_info_rsp {
1019 __le32 Capabilities;
1020 __u8 Guid[SMB2_CLIENT_GUID_SIZE];
1021 __le16 SecurityMode;
1022 __le16 Dialect; /* Dialect in use for the connection */
1025 #define RSS_CAPABLE cpu_to_le32(0x00000001)
1026 #define RDMA_CAPABLE cpu_to_le32(0x00000002)
1028 #define INTERNETWORK cpu_to_le16(0x0002)
1029 #define INTERNETWORKV6 cpu_to_le16(0x0017)
1031 struct network_interface_info_ioctl_rsp {
1032 __le32 Next; /* next interface. zero if this is last one */
1034 __le32 Capability; /* RSS or RDMA Capable */
1041 struct iface_info_ipv4 {
1047 struct iface_info_ipv6 {
1050 __u8 IPv6Address[16];
1054 #define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
1056 struct compress_ioctl {
1057 __le16 CompressionState; /* See cifspdu.h for possible flag values */
1060 struct duplicate_extents_to_file {
1061 __u64 PersistentFileHandle; /* source file handle, opaque endianness */
1062 __u64 VolatileFileHandle;
1063 __le64 SourceFileOffset;
1064 __le64 TargetFileOffset;
1065 __le64 ByteCount; /* Bytes to be copied */
1069 * Maximum number of iovs we need for an ioctl request.
1070 * [0] : struct smb2_ioctl_req
1073 #define SMB2_IOCTL_IOV_SIZE 2
1075 struct smb2_ioctl_req {
1076 struct smb2_sync_hdr sync_hdr;
1077 __le16 StructureSize; /* Must be 57 */
1080 __u64 PersistentFileId; /* opaque endianness */
1081 __u64 VolatileFileId; /* opaque endianness */
1084 __le32 MaxInputResponse;
1085 __le32 OutputOffset;
1087 __le32 MaxOutputResponse;
1093 struct smb2_ioctl_rsp {
1094 struct smb2_sync_hdr sync_hdr;
1095 __le16 StructureSize; /* Must be 57 */
1098 __u64 PersistentFileId; /* opaque endianness */
1099 __u64 VolatileFileId; /* opaque endianness */
1102 __le32 OutputOffset;
1106 /* char * buffer[] */
1109 /* Currently defined values for close flags */
1110 #define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
1111 struct smb2_close_req {
1112 struct smb2_sync_hdr sync_hdr;
1113 __le16 StructureSize; /* Must be 24 */
1116 __u64 PersistentFileId; /* opaque endianness */
1117 __u64 VolatileFileId; /* opaque endianness */
1121 * Maximum size of a SMB2_CLOSE response is 64 (smb2 header) + 60 (data)
1123 #define MAX_SMB2_CLOSE_RESPONSE_SIZE 124
1125 struct smb2_close_rsp {
1126 struct smb2_sync_hdr sync_hdr;
1127 __le16 StructureSize; /* 60 */
1130 __le64 CreationTime;
1131 __le64 LastAccessTime;
1132 __le64 LastWriteTime;
1134 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
1139 struct smb2_flush_req {
1140 struct smb2_sync_hdr sync_hdr;
1141 __le16 StructureSize; /* Must be 24 */
1144 __u64 PersistentFileId; /* opaque endianness */
1145 __u64 VolatileFileId; /* opaque endianness */
1148 struct smb2_flush_rsp {
1149 struct smb2_sync_hdr sync_hdr;
1150 __le16 StructureSize;
1154 /* For read request Flags field below, following flag is defined for SMB3.02 */
1155 #define SMB2_READFLAG_READ_UNBUFFERED 0x01
1156 #define SMB2_READFLAG_REQUEST_COMPRESSED 0x02 /* See MS-SMB2 2.2.19 */
1158 /* Channel field for read and write: exactly one of following flags can be set*/
1159 #define SMB2_CHANNEL_NONE cpu_to_le32(0x00000000)
1160 #define SMB2_CHANNEL_RDMA_V1 cpu_to_le32(0x00000001) /* SMB3 or later */
1161 #define SMB2_CHANNEL_RDMA_V1_INVALIDATE cpu_to_le32(0x00000002) /* >= SMB3.02 */
1163 /* SMB2 read request without RFC1001 length at the beginning */
1164 struct smb2_read_plain_req {
1165 struct smb2_sync_hdr sync_hdr;
1166 __le16 StructureSize; /* Must be 49 */
1167 __u8 Padding; /* offset from start of SMB2 header to place read */
1168 __u8 Flags; /* MBZ unless SMB3.02 or later */
1171 __u64 PersistentFileId; /* opaque endianness */
1172 __u64 VolatileFileId; /* opaque endianness */
1173 __le32 MinimumCount;
1174 __le32 Channel; /* MBZ except for SMB3 or later */
1175 __le32 RemainingBytes;
1176 __le16 ReadChannelInfoOffset;
1177 __le16 ReadChannelInfoLength;
1181 struct smb2_read_rsp {
1182 struct smb2_sync_hdr sync_hdr;
1183 __le16 StructureSize; /* Must be 17 */
1187 __le32 DataRemaining;
1192 /* For write request Flags field below the following flags are defined: */
1193 #define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
1194 #define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
1196 struct smb2_write_req {
1197 struct smb2_sync_hdr sync_hdr;
1198 __le16 StructureSize; /* Must be 49 */
1199 __le16 DataOffset; /* offset from start of SMB2 header to write data */
1202 __u64 PersistentFileId; /* opaque endianness */
1203 __u64 VolatileFileId; /* opaque endianness */
1204 __le32 Channel; /* MBZ unless SMB3.02 or later */
1205 __le32 RemainingBytes;
1206 __le16 WriteChannelInfoOffset;
1207 __le16 WriteChannelInfoLength;
1212 struct smb2_write_rsp {
1213 struct smb2_sync_hdr sync_hdr;
1214 __le16 StructureSize; /* Must be 17 */
1218 __le32 DataRemaining;
1224 #define SMB2_WATCH_TREE 0x0001
1226 /* notify completion filter flags. See MS-FSCC 2.6 and MS-SMB2 2.2.35 */
1227 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x00000001
1228 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x00000002
1229 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x00000004
1230 #define FILE_NOTIFY_CHANGE_SIZE 0x00000008
1231 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x00000010
1232 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x00000020
1233 #define FILE_NOTIFY_CHANGE_CREATION 0x00000040
1234 #define FILE_NOTIFY_CHANGE_EA 0x00000080
1235 #define FILE_NOTIFY_CHANGE_SECURITY 0x00000100
1236 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1237 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1238 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1240 struct smb2_change_notify_req {
1241 struct smb2_sync_hdr sync_hdr;
1242 __le16 StructureSize;
1244 __le32 OutputBufferLength;
1245 __u64 PersistentFileId; /* opaque endianness */
1246 __u64 VolatileFileId; /* opaque endianness */
1247 __le32 CompletionFilter;
1251 struct smb2_change_notify_rsp {
1252 struct smb2_sync_hdr sync_hdr;
1253 __le16 StructureSize; /* Must be 9 */
1254 __le16 OutputBufferOffset;
1255 __le32 OutputBufferLength;
1256 __u8 Buffer[1]; /* array of file notify structs */
1259 #define SMB2_LOCKFLAG_SHARED_LOCK 0x0001
1260 #define SMB2_LOCKFLAG_EXCLUSIVE_LOCK 0x0002
1261 #define SMB2_LOCKFLAG_UNLOCK 0x0004
1262 #define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
1264 struct smb2_lock_element {
1271 struct smb2_lock_req {
1272 struct smb2_sync_hdr sync_hdr;
1273 __le16 StructureSize; /* Must be 48 */
1276 __u64 PersistentFileId; /* opaque endianness */
1277 __u64 VolatileFileId; /* opaque endianness */
1278 /* Followed by at least one */
1279 struct smb2_lock_element locks[1];
1282 struct smb2_lock_rsp {
1283 struct smb2_sync_hdr sync_hdr;
1284 __le16 StructureSize; /* Must be 4 */
1288 struct smb2_echo_req {
1289 struct smb2_sync_hdr sync_hdr;
1290 __le16 StructureSize; /* Must be 4 */
1294 struct smb2_echo_rsp {
1295 struct smb2_sync_hdr sync_hdr;
1296 __le16 StructureSize; /* Must be 4 */
1300 /* search (query_directory) Flags field */
1301 #define SMB2_RESTART_SCANS 0x01
1302 #define SMB2_RETURN_SINGLE_ENTRY 0x02
1303 #define SMB2_INDEX_SPECIFIED 0x04
1304 #define SMB2_REOPEN 0x10
1306 #define SMB2_QUERY_DIRECTORY_IOV_SIZE 2
1308 struct smb2_query_directory_req {
1309 struct smb2_sync_hdr sync_hdr;
1310 __le16 StructureSize; /* Must be 33 */
1311 __u8 FileInformationClass;
1314 __u64 PersistentFileId; /* opaque endianness */
1315 __u64 VolatileFileId; /* opaque endianness */
1316 __le16 FileNameOffset;
1317 __le16 FileNameLength;
1318 __le32 OutputBufferLength;
1322 struct smb2_query_directory_rsp {
1323 struct smb2_sync_hdr sync_hdr;
1324 __le16 StructureSize; /* Must be 9 */
1325 __le16 OutputBufferOffset;
1326 __le32 OutputBufferLength;
1330 /* Possible InfoType values */
1331 #define SMB2_O_INFO_FILE 0x01
1332 #define SMB2_O_INFO_FILESYSTEM 0x02
1333 #define SMB2_O_INFO_SECURITY 0x03
1334 #define SMB2_O_INFO_QUOTA 0x04
1336 /* Security info type additionalinfo flags. See MS-SMB2 (2.2.37) or MS-DTYP */
1337 #define OWNER_SECINFO 0x00000001
1338 #define GROUP_SECINFO 0x00000002
1339 #define DACL_SECINFO 0x00000004
1340 #define SACL_SECINFO 0x00000008
1341 #define LABEL_SECINFO 0x00000010
1342 #define ATTRIBUTE_SECINFO 0x00000020
1343 #define SCOPE_SECINFO 0x00000040
1344 #define BACKUP_SECINFO 0x00010000
1345 #define UNPROTECTED_SACL_SECINFO 0x10000000
1346 #define UNPROTECTED_DACL_SECINFO 0x20000000
1347 #define PROTECTED_SACL_SECINFO 0x40000000
1348 #define PROTECTED_DACL_SECINFO 0x80000000
1350 /* Flags used for FileFullEAinfo */
1351 #define SL_RESTART_SCAN 0x00000001
1352 #define SL_RETURN_SINGLE_ENTRY 0x00000002
1353 #define SL_INDEX_SPECIFIED 0x00000004
1355 struct smb2_query_info_req {
1356 struct smb2_sync_hdr sync_hdr;
1357 __le16 StructureSize; /* Must be 41 */
1360 __le32 OutputBufferLength;
1361 __le16 InputBufferOffset;
1363 __le32 InputBufferLength;
1364 __le32 AdditionalInformation;
1366 __u64 PersistentFileId; /* opaque endianness */
1367 __u64 VolatileFileId; /* opaque endianness */
1371 struct smb2_query_info_rsp {
1372 struct smb2_sync_hdr sync_hdr;
1373 __le16 StructureSize; /* Must be 9 */
1374 __le16 OutputBufferOffset;
1375 __le32 OutputBufferLength;
1380 * Maximum number of iovs we need for a set-info request.
1381 * The largest one is rename/hardlink
1382 * [0] : struct smb2_set_info_req + smb2_file_[rename|link]_info
1384 * [2] : compound padding
1386 #define SMB2_SET_INFO_IOV_SIZE 3
1388 struct smb2_set_info_req {
1389 struct smb2_sync_hdr sync_hdr;
1390 __le16 StructureSize; /* Must be 33 */
1393 __le32 BufferLength;
1394 __le16 BufferOffset;
1396 __le32 AdditionalInformation;
1397 __u64 PersistentFileId; /* opaque endianness */
1398 __u64 VolatileFileId; /* opaque endianness */
1402 struct smb2_set_info_rsp {
1403 struct smb2_sync_hdr sync_hdr;
1404 __le16 StructureSize; /* Must be 2 */
1407 struct smb2_oplock_break {
1408 struct smb2_sync_hdr sync_hdr;
1409 __le16 StructureSize; /* Must be 24 */
1413 __u64 PersistentFid;
1417 #define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
1419 struct smb2_lease_break {
1420 struct smb2_sync_hdr sync_hdr;
1421 __le16 StructureSize; /* Must be 44 */
1425 __le32 CurrentLeaseState;
1426 __le32 NewLeaseState;
1428 __le32 AccessMaskHint;
1429 __le32 ShareMaskHint;
1432 struct smb2_lease_ack {
1433 struct smb2_sync_hdr sync_hdr;
1434 __le16 StructureSize; /* Must be 36 */
1439 __le64 LeaseDuration;
1443 * PDU infolevel structure definitions
1444 * BB consider moving to a different header
1447 /* File System Information Classes */
1448 #define FS_VOLUME_INFORMATION 1 /* Query */
1449 #define FS_LABEL_INFORMATION 2 /* Local only */
1450 #define FS_SIZE_INFORMATION 3 /* Query */
1451 #define FS_DEVICE_INFORMATION 4 /* Query */
1452 #define FS_ATTRIBUTE_INFORMATION 5 /* Query */
1453 #define FS_CONTROL_INFORMATION 6 /* Query, Set */
1454 #define FS_FULL_SIZE_INFORMATION 7 /* Query */
1455 #define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
1456 #define FS_DRIVER_PATH_INFORMATION 9 /* Local only */
1457 #define FS_VOLUME_FLAGS_INFORMATION 10 /* Local only */
1458 #define FS_SECTOR_SIZE_INFORMATION 11 /* SMB3 or later. Query */
1459 #define FS_POSIX_INFORMATION 100 /* SMB3.1.1 POSIX. Query */
1461 struct smb2_fs_full_size_info {
1462 __le64 TotalAllocationUnits;
1463 __le64 CallerAvailableAllocationUnits;
1464 __le64 ActualAvailableAllocationUnits;
1465 __le32 SectorsPerAllocationUnit;
1466 __le32 BytesPerSector;
1469 #define SSINFO_FLAGS_ALIGNED_DEVICE 0x00000001
1470 #define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
1471 #define SSINFO_FLAGS_NO_SEEK_PENALTY 0x00000004
1472 #define SSINFO_FLAGS_TRIM_ENABLED 0x00000008
1474 /* sector size info struct */
1475 struct smb3_fs_ss_info {
1476 __le32 LogicalBytesPerSector;
1477 __le32 PhysicalBytesPerSectorForAtomicity;
1478 __le32 PhysicalBytesPerSectorForPerf;
1479 __le32 FileSystemEffectivePhysicalBytesPerSectorForAtomicity;
1481 __le32 ByteOffsetForSectorAlignment;
1482 __le32 ByteOffsetForPartitionAlignment;
1485 /* volume info struct - see MS-FSCC 2.5.9 */
1486 #define MAX_VOL_LABEL_LEN 32
1487 struct smb3_fs_vol_info {
1488 __le64 VolumeCreationTime;
1489 __u32 VolumeSerialNumber;
1490 __le32 VolumeLabelLength; /* includes trailing null */
1491 __u8 SupportsObjects; /* True if eg like NTFS, supports objects */
1493 __u8 VolumeLabel[]; /* variable len */
1496 /* partial list of QUERY INFO levels */
1497 #define FILE_DIRECTORY_INFORMATION 1
1498 #define FILE_FULL_DIRECTORY_INFORMATION 2
1499 #define FILE_BOTH_DIRECTORY_INFORMATION 3
1500 #define FILE_BASIC_INFORMATION 4
1501 #define FILE_STANDARD_INFORMATION 5
1502 #define FILE_INTERNAL_INFORMATION 6
1503 #define FILE_EA_INFORMATION 7
1504 #define FILE_ACCESS_INFORMATION 8
1505 #define FILE_NAME_INFORMATION 9
1506 #define FILE_RENAME_INFORMATION 10
1507 #define FILE_LINK_INFORMATION 11
1508 #define FILE_NAMES_INFORMATION 12
1509 #define FILE_DISPOSITION_INFORMATION 13
1510 #define FILE_POSITION_INFORMATION 14
1511 #define FILE_FULL_EA_INFORMATION 15
1512 #define FILE_MODE_INFORMATION 16
1513 #define FILE_ALIGNMENT_INFORMATION 17
1514 #define FILE_ALL_INFORMATION 18
1515 #define FILE_ALLOCATION_INFORMATION 19
1516 #define FILE_END_OF_FILE_INFORMATION 20
1517 #define FILE_ALTERNATE_NAME_INFORMATION 21
1518 #define FILE_STREAM_INFORMATION 22
1519 #define FILE_PIPE_INFORMATION 23
1520 #define FILE_PIPE_LOCAL_INFORMATION 24
1521 #define FILE_PIPE_REMOTE_INFORMATION 25
1522 #define FILE_MAILSLOT_QUERY_INFORMATION 26
1523 #define FILE_MAILSLOT_SET_INFORMATION 27
1524 #define FILE_COMPRESSION_INFORMATION 28
1525 #define FILE_OBJECT_ID_INFORMATION 29
1526 /* Number 30 not defined in documents */
1527 #define FILE_MOVE_CLUSTER_INFORMATION 31
1528 #define FILE_QUOTA_INFORMATION 32
1529 #define FILE_REPARSE_POINT_INFORMATION 33
1530 #define FILE_NETWORK_OPEN_INFORMATION 34
1531 #define FILE_ATTRIBUTE_TAG_INFORMATION 35
1532 #define FILE_TRACKING_INFORMATION 36
1533 #define FILEID_BOTH_DIRECTORY_INFORMATION 37
1534 #define FILEID_FULL_DIRECTORY_INFORMATION 38
1535 #define FILE_VALID_DATA_LENGTH_INFORMATION 39
1536 #define FILE_SHORT_NAME_INFORMATION 40
1537 #define FILE_SFIO_RESERVE_INFORMATION 44
1538 #define FILE_SFIO_VOLUME_INFORMATION 45
1539 #define FILE_HARD_LINK_INFORMATION 46
1540 #define FILE_NORMALIZED_NAME_INFORMATION 48
1541 #define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
1542 #define FILE_STANDARD_LINK_INFORMATION 54
1543 #define FILE_ID_INFORMATION 59
1545 struct smb2_file_internal_info {
1547 } __packed; /* level 6 Query */
1549 struct smb2_file_rename_info { /* encoding of request for level 10 */
1550 __u8 ReplaceIfExists; /* 1 = replace existing target with new */
1551 /* 0 = fail if target already exists */
1553 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
1554 __le32 FileNameLength;
1555 char FileName[]; /* New name to be assigned */
1556 } __packed; /* level 10 Set */
1558 struct smb2_file_link_info { /* encoding of request for level 11 */
1559 __u8 ReplaceIfExists; /* 1 = replace existing link with new */
1560 /* 0 = fail if link already exists */
1562 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
1563 __le32 FileNameLength;
1564 char FileName[]; /* Name to be assigned to new link */
1565 } __packed; /* level 11 Set */
1567 struct smb2_file_full_ea_info { /* encoding of response for level 15 */
1568 __le32 next_entry_offset;
1570 __u8 ea_name_length;
1571 __le16 ea_value_length;
1572 char ea_data[]; /* \0 terminated name plus value */
1573 } __packed; /* level 15 Set */
1576 * This level 18, although with struct with same name is different from cifs
1577 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
1578 * CurrentByteOffset.
1580 struct smb2_file_all_info { /* data block encoding of response to level 18 */
1581 __le64 CreationTime; /* Beginning of FILE_BASIC_INFO equivalent */
1582 __le64 LastAccessTime;
1583 __le64 LastWriteTime;
1586 __u32 Pad1; /* End of FILE_BASIC_INFO_INFO equivalent */
1587 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
1588 __le64 EndOfFile; /* size ie offset to first free byte in file */
1589 __le32 NumberOfLinks; /* hard links */
1592 __u16 Pad2; /* End of FILE_STANDARD_INFO equivalent */
1596 __le64 CurrentByteOffset;
1598 __le32 AlignmentRequirement;
1599 __le32 FileNameLength;
1601 } __packed; /* level 18 Query */
1603 struct smb2_file_eof_info { /* encoding of request for level 10 */
1604 __le64 EndOfFile; /* new end of file value */
1605 } __packed; /* level 20 Set */
1607 struct smb2_file_network_open_info {
1608 __le64 CreationTime;
1609 __le64 LastAccessTime;
1610 __le64 LastWriteTime;
1612 __le64 AllocationSize;
1616 } __packed; /* level 34 Query also similar returned in close rsp and open rsp */
1618 /* See MS-FSCC 2.4.43 */
1619 struct smb2_file_id_information {
1620 __le64 VolumeSerialNumber;
1621 __u64 PersistentFileId; /* opaque endianness */
1622 __u64 VolatileFileId; /* opaque endianness */
1623 } __packed; /* level 59 */
1625 extern char smb2_padding[7];
1627 /* equivalent of the contents of SMB3.1.1 POSIX open context response */
1628 struct create_posix_rsp {
1632 struct cifs_sid owner; /* var-sized on the wire */
1633 struct cifs_sid group; /* var-sized on the wire */
1637 * SMB2-only POSIX info level
1639 * See posix_info_sid_size(), posix_info_extra_size() and
1640 * posix_info_parse() to help with the handling of this struct.
1642 struct smb2_posix_info {
1643 __le32 NextEntryOffset;
1645 __le64 CreationTime;
1646 __le64 LastAccessTime;
1647 __le64 LastWriteTime;
1650 __le64 AllocationSize;
1651 __le32 DosAttributes;
1655 /* beginning of POSIX Create Context Response */
1660 * var sized owner SID
1661 * var sized group SID
1662 * le32 filenamelength
1668 * Parsed version of the above struct. Allows direct access to the
1669 * variable length fields
1671 struct smb2_posix_info_parsed {
1672 const struct smb2_posix_info *base;
1674 struct cifs_sid owner;
1675 struct cifs_sid group;
1680 #endif /* _SMB2PDU_H */