4 * Copyright (c) International Business Machines Corp., 2009, 2013
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
30 * Note that, due to trying to use names similar to the protocol specifications,
31 * there are many mixed case field names in the structures below. Although
32 * this does not match typical Linux kernel style, it is necessary to be
33 * be able to match against the protocol specfication.
36 * Some commands have minimal (wct=0,bcc=0), or uninteresting, responses
37 * (ie no useful data other than the SMB error code itself) and are marked such.
38 * Knowing this helps avoid response buffer allocations and copy in some cases.
41 /* List of commands in host endian */
42 #define SMB2_NEGOTIATE_HE 0x0000
43 #define SMB2_SESSION_SETUP_HE 0x0001
44 #define SMB2_LOGOFF_HE 0x0002 /* trivial request/resp */
45 #define SMB2_TREE_CONNECT_HE 0x0003
46 #define SMB2_TREE_DISCONNECT_HE 0x0004 /* trivial req/resp */
47 #define SMB2_CREATE_HE 0x0005
48 #define SMB2_CLOSE_HE 0x0006
49 #define SMB2_FLUSH_HE 0x0007 /* trivial resp */
50 #define SMB2_READ_HE 0x0008
51 #define SMB2_WRITE_HE 0x0009
52 #define SMB2_LOCK_HE 0x000A
53 #define SMB2_IOCTL_HE 0x000B
54 #define SMB2_CANCEL_HE 0x000C
55 #define SMB2_ECHO_HE 0x000D
56 #define SMB2_QUERY_DIRECTORY_HE 0x000E
57 #define SMB2_CHANGE_NOTIFY_HE 0x000F
58 #define SMB2_QUERY_INFO_HE 0x0010
59 #define SMB2_SET_INFO_HE 0x0011
60 #define SMB2_OPLOCK_BREAK_HE 0x0012
62 /* The same list in little endian */
63 #define SMB2_NEGOTIATE cpu_to_le16(SMB2_NEGOTIATE_HE)
64 #define SMB2_SESSION_SETUP cpu_to_le16(SMB2_SESSION_SETUP_HE)
65 #define SMB2_LOGOFF cpu_to_le16(SMB2_LOGOFF_HE)
66 #define SMB2_TREE_CONNECT cpu_to_le16(SMB2_TREE_CONNECT_HE)
67 #define SMB2_TREE_DISCONNECT cpu_to_le16(SMB2_TREE_DISCONNECT_HE)
68 #define SMB2_CREATE cpu_to_le16(SMB2_CREATE_HE)
69 #define SMB2_CLOSE cpu_to_le16(SMB2_CLOSE_HE)
70 #define SMB2_FLUSH cpu_to_le16(SMB2_FLUSH_HE)
71 #define SMB2_READ cpu_to_le16(SMB2_READ_HE)
72 #define SMB2_WRITE cpu_to_le16(SMB2_WRITE_HE)
73 #define SMB2_LOCK cpu_to_le16(SMB2_LOCK_HE)
74 #define SMB2_IOCTL cpu_to_le16(SMB2_IOCTL_HE)
75 #define SMB2_CANCEL cpu_to_le16(SMB2_CANCEL_HE)
76 #define SMB2_ECHO cpu_to_le16(SMB2_ECHO_HE)
77 #define SMB2_QUERY_DIRECTORY cpu_to_le16(SMB2_QUERY_DIRECTORY_HE)
78 #define SMB2_CHANGE_NOTIFY cpu_to_le16(SMB2_CHANGE_NOTIFY_HE)
79 #define SMB2_QUERY_INFO cpu_to_le16(SMB2_QUERY_INFO_HE)
80 #define SMB2_SET_INFO cpu_to_le16(SMB2_SET_INFO_HE)
81 #define SMB2_OPLOCK_BREAK cpu_to_le16(SMB2_OPLOCK_BREAK_HE)
83 #define SMB2_INTERNAL_CMD cpu_to_le16(0xFFFF)
85 #define NUMBER_OF_SMB2_COMMANDS 0x0013
87 /* 52 transform hdr + 64 hdr + 88 create rsp */
88 #define SMB2_TRANSFORM_HEADER_SIZE 52
89 #define MAX_SMB2_HDR_SIZE 204
91 #define SMB2_PROTO_NUMBER cpu_to_le32(0x424d53fe)
92 #define SMB2_TRANSFORM_PROTO_NUM cpu_to_le32(0x424d53fd)
95 * SMB2 Header Definition
97 * "MBZ" : Must be Zero
98 * "BB" : BugBug, Something to check/review/analyze later
99 * "PDU" : "Protocol Data Unit" (ie a network "frame")
103 #define SMB2_HEADER_STRUCTURE_SIZE cpu_to_le16(64)
105 struct smb2_sync_hdr {
106 __le32 ProtocolId; /* 0xFE 'S' 'M' 'B' */
107 __le16 StructureSize; /* 64 */
108 __le16 CreditCharge; /* MBZ */
109 __le32 Status; /* Error from server */
111 __le16 CreditRequest; /* CreditResponse */
116 __u32 TreeId; /* opaque - so do not make little endian */
117 __u64 SessionId; /* opaque - so do not make little endian */
121 struct smb2_sync_pdu {
122 struct smb2_sync_hdr sync_hdr;
123 __le16 StructureSize2; /* size of wct area (varies, request specific) */
126 #define SMB3_AES128CCM_NONCE 11
127 #define SMB3_AES128GCM_NONCE 12
129 struct smb2_transform_hdr {
130 __le32 ProtocolId; /* 0xFD 'S' 'M' 'B' */
133 __le32 OriginalMessageSize;
135 __le16 Flags; /* EncryptionAlgorithm */
140 * SMB2 flag definitions
142 #define SMB2_FLAGS_SERVER_TO_REDIR cpu_to_le32(0x00000001)
143 #define SMB2_FLAGS_ASYNC_COMMAND cpu_to_le32(0x00000002)
144 #define SMB2_FLAGS_RELATED_OPERATIONS cpu_to_le32(0x00000004)
145 #define SMB2_FLAGS_SIGNED cpu_to_le32(0x00000008)
146 #define SMB2_FLAGS_DFS_OPERATIONS cpu_to_le32(0x10000000)
149 * Definitions for SMB2 Protocol Data Units (network frames)
151 * See MS-SMB2.PDF specification for protocol details.
152 * The Naming convention is the lower case version of the SMB2
153 * command code name for the struct. Note that structures must be packed.
157 #define COMPOUND_FID 0xFFFFFFFFFFFFFFFFULL
159 #define SMB2_ERROR_STRUCTURE_SIZE2 cpu_to_le16(9)
161 struct smb2_err_rsp {
162 struct smb2_sync_hdr sync_hdr;
163 __le16 StructureSize;
164 __le16 Reserved; /* MBZ */
165 __le32 ByteCount; /* even if zero, at least one byte follows */
166 __u8 ErrorData[1]; /* variable length */
169 #define SYMLINK_ERROR_TAG 0x4c4d5953
171 struct smb2_symlink_err_rsp {
172 __le32 SymLinkLength;
173 __le32 SymLinkErrorTag;
175 __le16 ReparseDataLength;
176 __le16 UnparsedPathLength;
177 __le16 SubstituteNameOffset;
178 __le16 SubstituteNameLength;
179 __le16 PrintNameOffset;
180 __le16 PrintNameLength;
185 /* SMB 3.1.1 and later dialects. See MS-SMB2 section 2.2.2.1 */
186 struct smb2_error_context_rsp {
187 __le32 ErrorDataLength;
189 __u8 ErrorContextData; /* ErrorDataLength long array */
192 /* Defines for Type field below (see MS-SMB2 2.2.2.2.2.1) */
193 #define MOVE_DST_IPADDR_V4 cpu_to_le32(0x00000001)
194 #define MOVE_DST_IPADDR_V6 cpu_to_le32(0x00000002)
196 struct move_dst_ipaddr {
199 __u8 address[16]; /* IPv4 followed by 12 bytes rsvd or IPv6 address */
202 struct share_redirect_error_context_rsp {
203 __le32 StructureSize;
204 __le32 NotificationType;
205 __le32 ResourceNameOffset;
206 __le32 ResourceNameLength;
210 struct move_dst_ipaddr IpAddrMoveList[0];
211 /* __u8 ResourceName[] */ /* Name of share as counted Unicode string */
214 #define SMB2_CLIENT_GUID_SIZE 16
216 struct smb2_negotiate_req {
217 struct smb2_sync_hdr sync_hdr;
218 __le16 StructureSize; /* Must be 36 */
221 __le16 Reserved; /* MBZ */
223 __u8 ClientGUID[SMB2_CLIENT_GUID_SIZE];
224 /* In SMB3.02 and earlier next three were MBZ le64 ClientStartTime */
225 __le32 NegotiateContextOffset; /* SMB3.1.1 only. MBZ earlier */
226 __le16 NegotiateContextCount; /* SMB3.1.1 only. MBZ earlier */
228 __le16 Dialects[1]; /* One dialect (vers=) at a time for now */
232 #define SMB10_PROT_ID 0x0000 /* local only, not sent on wire w/CIFS negprot */
233 #define SMB20_PROT_ID 0x0202
234 #define SMB21_PROT_ID 0x0210
235 #define SMB30_PROT_ID 0x0300
236 #define SMB302_PROT_ID 0x0302
237 #define SMB311_PROT_ID 0x0311
238 #define BAD_PROT_ID 0xFFFF
240 /* SecurityMode flags */
241 #define SMB2_NEGOTIATE_SIGNING_ENABLED 0x0001
242 #define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
243 #define SMB2_SEC_MODE_FLAGS_ALL 0x0003
245 /* Capabilities flags */
246 #define SMB2_GLOBAL_CAP_DFS 0x00000001
247 #define SMB2_GLOBAL_CAP_LEASING 0x00000002 /* Resp only New to SMB2.1 */
248 #define SMB2_GLOBAL_CAP_LARGE_MTU 0X00000004 /* Resp only New to SMB2.1 */
249 #define SMB2_GLOBAL_CAP_MULTI_CHANNEL 0x00000008 /* New to SMB3 */
250 #define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
251 #define SMB2_GLOBAL_CAP_DIRECTORY_LEASING 0x00000020 /* New to SMB3 */
252 #define SMB2_GLOBAL_CAP_ENCRYPTION 0x00000040 /* New to SMB3 */
254 #define SMB2_NT_FIND 0x00100000
255 #define SMB2_LARGE_FILES 0x00200000
258 /* Negotiate Contexts - ContextTypes. See MS-SMB2 section 2.2.3.1 for details */
259 #define SMB2_PREAUTH_INTEGRITY_CAPABILITIES cpu_to_le16(1)
260 #define SMB2_ENCRYPTION_CAPABILITIES cpu_to_le16(2)
261 #define SMB2_COMPRESSION_CAPABILITIES cpu_to_le16(3)
262 #define SMB2_NETNAME_NEGOTIATE_CONTEXT_ID cpu_to_le16(5)
263 #define SMB2_POSIX_EXTENSIONS_AVAILABLE cpu_to_le16(0x100)
265 struct smb2_neg_context {
269 /* Followed by array of data */
272 #define SMB311_SALT_SIZE 32
273 /* Hash Algorithm Types */
274 #define SMB2_PREAUTH_INTEGRITY_SHA512 cpu_to_le16(0x0001)
275 #define SMB2_PREAUTH_HASH_SIZE 64
277 #define MIN_PREAUTH_CTXT_DATA_LEN (SMB311_SALT_SIZE + 6)
278 struct smb2_preauth_neg_context {
279 __le16 ContextType; /* 1 */
282 __le16 HashAlgorithmCount; /* 1 */
284 __le16 HashAlgorithms; /* HashAlgorithms[0] since only one defined */
285 __u8 Salt[SMB311_SALT_SIZE];
288 /* Encryption Algorithms Ciphers */
289 #define SMB2_ENCRYPTION_AES128_CCM cpu_to_le16(0x0001)
290 #define SMB2_ENCRYPTION_AES128_GCM cpu_to_le16(0x0002)
292 /* Min encrypt context data is one cipher so 2 bytes + 2 byte count field */
293 #define MIN_ENCRYPT_CTXT_DATA_LEN 4
294 struct smb2_encryption_neg_context {
295 __le16 ContextType; /* 2 */
298 __le16 CipherCount; /* AES-128-GCM and AES-128-CCM */
302 /* See MS-SMB2 2.2.3.1.3 */
303 #define SMB3_COMPRESS_NONE cpu_to_le16(0x0000)
304 #define SMB3_COMPRESS_LZNT1 cpu_to_le16(0x0001)
305 #define SMB3_COMPRESS_LZ77 cpu_to_le16(0x0002)
306 #define SMB3_COMPRESS_LZ77_HUFF cpu_to_le16(0x0003)
308 struct smb2_compression_capabilities_context {
309 __le16 ContextType; /* 3 */
312 __le16 CompressionAlgorithmCount;
315 __le16 CompressionAlgorithms[3];
319 * For smb2_netname_negotiate_context_id See MS-SMB2 2.2.3.1.4.
320 * Its struct simply contains NetName, an array of Unicode characters
322 struct smb2_netname_neg_context {
323 __le16 ContextType; /* 0x100 */
326 __le16 NetName[0]; /* hostname of target converted to UCS-2 */
329 #define POSIX_CTXT_DATA_LEN 16
330 struct smb2_posix_neg_context {
331 __le16 ContextType; /* 0x100 */
334 __u8 Name[16]; /* POSIX ctxt GUID 93AD25509CB411E7B42383DE968BCD7C */
337 struct smb2_negotiate_rsp {
338 struct smb2_sync_hdr sync_hdr;
339 __le16 StructureSize; /* Must be 65 */
341 __le16 DialectRevision;
342 __le16 NegotiateContextCount; /* Prior to SMB3.1.1 was Reserved & MBZ */
345 __le32 MaxTransactSize;
348 __le64 SystemTime; /* MBZ */
349 __le64 ServerStartTime;
350 __le16 SecurityBufferOffset;
351 __le16 SecurityBufferLength;
352 __le32 NegotiateContextOffset; /* Pre:SMB3.1.1 was reserved/ignored */
353 __u8 Buffer[1]; /* variable length GSS security buffer */
357 #define SMB2_SESSION_REQ_FLAG_BINDING 0x01
358 #define SMB2_SESSION_REQ_FLAG_ENCRYPT_DATA 0x04
360 struct smb2_sess_setup_req {
361 struct smb2_sync_hdr sync_hdr;
362 __le16 StructureSize; /* Must be 25 */
367 __le16 SecurityBufferOffset;
368 __le16 SecurityBufferLength;
369 __u64 PreviousSessionId;
370 __u8 Buffer[1]; /* variable length GSS security buffer */
373 /* Currently defined SessionFlags */
374 #define SMB2_SESSION_FLAG_IS_GUEST 0x0001
375 #define SMB2_SESSION_FLAG_IS_NULL 0x0002
376 #define SMB2_SESSION_FLAG_ENCRYPT_DATA 0x0004
377 struct smb2_sess_setup_rsp {
378 struct smb2_sync_hdr sync_hdr;
379 __le16 StructureSize; /* Must be 9 */
381 __le16 SecurityBufferOffset;
382 __le16 SecurityBufferLength;
383 __u8 Buffer[1]; /* variable length GSS security buffer */
386 struct smb2_logoff_req {
387 struct smb2_sync_hdr sync_hdr;
388 __le16 StructureSize; /* Must be 4 */
392 struct smb2_logoff_rsp {
393 struct smb2_sync_hdr sync_hdr;
394 __le16 StructureSize; /* Must be 4 */
398 /* Flags/Reserved for SMB3.1.1 */
399 #define SMB2_TREE_CONNECT_FLAG_CLUSTER_RECONNECT cpu_to_le16(0x0001)
400 #define SMB2_TREE_CONNECT_FLAG_REDIRECT_TO_OWNER cpu_to_le16(0x0002)
401 #define SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT cpu_to_le16(0x0004)
403 struct smb2_tree_connect_req {
404 struct smb2_sync_hdr sync_hdr;
405 __le16 StructureSize; /* Must be 9 */
406 __le16 Reserved; /* Flags in SMB3.1.1 */
409 __u8 Buffer[1]; /* variable length */
412 /* See MS-SMB2 section 2.2.9.2 */
414 #define SMB2_RESERVED_TREE_CONNECT_CONTEXT_ID 0x0000
415 #define SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID cpu_to_le16(0x0001)
417 struct tree_connect_contexts {
424 /* Remoted identity tree connect context structures - see MS-SMB2 2.2.9.2.1 */
425 struct smb3_blob_data {
430 /* Valid values for Attr */
431 #define SE_GROUP_MANDATORY 0x00000001
432 #define SE_GROUP_ENABLED_BY_DEFAULT 0x00000002
433 #define SE_GROUP_ENABLED 0x00000004
434 #define SE_GROUP_OWNER 0x00000008
435 #define SE_GROUP_USE_FOR_DENY_ONLY 0x00000010
436 #define SE_GROUP_INTEGRITY 0x00000020
437 #define SE_GROUP_INTEGRITY_ENABLED 0x00000040
438 #define SE_GROUP_RESOURCE 0x20000000
439 #define SE_GROUP_LOGON_ID 0xC0000000
441 /* struct sid_attr_data is SidData array in BlobData format then le32 Attr */
443 struct sid_array_data {
445 /* SidAttrList - array of sid_attr_data structs */
448 struct luid_attr_data {
453 * struct privilege_data is the same as BLOB_DATA - see MS-SMB2 2.2.9.2.1.5
454 * but with size of LUID_ATTR_DATA struct and BlobData set to LUID_ATTR DATA
457 struct privilege_array_data {
458 __le16 PrivilegeCount;
459 /* array of privilege_data structs */
462 struct remoted_identity_tcon_context {
463 __le16 TicketType; /* must be 0x0001 */
464 __le16 TicketSize; /* total size of this struct */
465 __le16 User; /* offset to SID_ATTR_DATA struct with user info */
466 __le16 UserName; /* offset to null terminated Unicode username string */
467 __le16 Domain; /* offset to null terminated Unicode domain name */
468 __le16 Groups; /* offset to SID_ARRAY_DATA struct with group info */
469 __le16 RestrictedGroups; /* similar to above */
470 __le16 Privileges; /* offset to PRIVILEGE_ARRAY_DATA struct */
471 __le16 PrimaryGroup; /* offset to SID_ARRAY_DATA struct */
472 __le16 Owner; /* offset to BLOB_DATA struct */
473 __le16 DefaultDacl; /* offset to BLOB_DATA struct */
474 __le16 DeviceGroups; /* offset to SID_ARRAY_DATA struct */
475 __le16 UserClaims; /* offset to BLOB_DATA struct */
476 __le16 DeviceClaims; /* offset to BLOB_DATA struct */
477 __u8 TicketInfo[0]; /* variable length buf - remoted identity data */
480 struct smb2_tree_connect_req_extension {
481 __le32 TreeConnectContextOffset;
482 __le16 TreeConnectContextCount;
484 __u8 PathName[0]; /* variable sized array */
485 /* followed by array of TreeConnectContexts */
488 struct smb2_tree_connect_rsp {
489 struct smb2_sync_hdr sync_hdr;
490 __le16 StructureSize; /* Must be 16 */
491 __u8 ShareType; /* see below */
493 __le32 ShareFlags; /* see below */
494 __le32 Capabilities; /* see below */
495 __le32 MaximalAccess;
498 /* Possible ShareType values */
499 #define SMB2_SHARE_TYPE_DISK 0x01
500 #define SMB2_SHARE_TYPE_PIPE 0x02
501 #define SMB2_SHARE_TYPE_PRINT 0x03
504 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
505 * must be set (any of the remaining, SHI1005, flags may be set individually
508 #define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
509 #define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
510 #define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
511 #define SMB2_SHAREFLAG_NO_CACHING 0x00000030
512 #define SHI1005_FLAGS_DFS 0x00000001
513 #define SHI1005_FLAGS_DFS_ROOT 0x00000002
514 #define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS 0x00000100
515 #define SHI1005_FLAGS_FORCE_SHARED_DELETE 0x00000200
516 #define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING 0x00000400
517 #define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
518 #define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK 0x00001000
519 #define SHI1005_FLAGS_ENABLE_HASH_V1 0x00002000
520 #define SHI1005_FLAGS_ENABLE_HASH_V2 0x00004000
521 #define SHI1005_FLAGS_ENCRYPT_DATA 0x00008000
522 #define SMB2_SHAREFLAG_IDENTITY_REMOTING 0x00040000 /* 3.1.1 */
523 #define SHI1005_FLAGS_ALL 0x0004FF33
525 /* Possible share capabilities */
526 #define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
527 #define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
528 #define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
529 #define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
530 #define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
531 #define SMB2_SHARE_CAP_REDIRECT_TO_OWNER cpu_to_le32(0x00000100) /* 3.1.1 */
533 struct smb2_tree_disconnect_req {
534 struct smb2_sync_hdr sync_hdr;
535 __le16 StructureSize; /* Must be 4 */
539 struct smb2_tree_disconnect_rsp {
540 struct smb2_sync_hdr sync_hdr;
541 __le16 StructureSize; /* Must be 4 */
545 /* File Attrubutes */
546 #define FILE_ATTRIBUTE_READONLY 0x00000001
547 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
548 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
549 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
550 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
551 #define FILE_ATTRIBUTE_NORMAL 0x00000080
552 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
553 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
554 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
555 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
556 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
557 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
558 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
559 #define FILE_ATTRIBUTE_INTEGRITY_STREAM 0x00008000
560 #define FILE_ATTRIBUTE_NO_SCRUB_DATA 0x00020000
563 #define SMB2_OPLOCK_LEVEL_NONE 0x00
564 #define SMB2_OPLOCK_LEVEL_II 0x01
565 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE 0x08
566 #define SMB2_OPLOCK_LEVEL_BATCH 0x09
567 #define SMB2_OPLOCK_LEVEL_LEASE 0xFF
568 /* Non-spec internal type */
569 #define SMB2_OPLOCK_LEVEL_NOCHANGE 0x99
571 /* Desired Access Flags */
572 #define FILE_READ_DATA_LE cpu_to_le32(0x00000001)
573 #define FILE_WRITE_DATA_LE cpu_to_le32(0x00000002)
574 #define FILE_APPEND_DATA_LE cpu_to_le32(0x00000004)
575 #define FILE_READ_EA_LE cpu_to_le32(0x00000008)
576 #define FILE_WRITE_EA_LE cpu_to_le32(0x00000010)
577 #define FILE_EXECUTE_LE cpu_to_le32(0x00000020)
578 #define FILE_READ_ATTRIBUTES_LE cpu_to_le32(0x00000080)
579 #define FILE_WRITE_ATTRIBUTES_LE cpu_to_le32(0x00000100)
580 #define FILE_DELETE_LE cpu_to_le32(0x00010000)
581 #define FILE_READ_CONTROL_LE cpu_to_le32(0x00020000)
582 #define FILE_WRITE_DAC_LE cpu_to_le32(0x00040000)
583 #define FILE_WRITE_OWNER_LE cpu_to_le32(0x00080000)
584 #define FILE_SYNCHRONIZE_LE cpu_to_le32(0x00100000)
585 #define FILE_ACCESS_SYSTEM_SECURITY_LE cpu_to_le32(0x01000000)
586 #define FILE_MAXIMAL_ACCESS_LE cpu_to_le32(0x02000000)
587 #define FILE_GENERIC_ALL_LE cpu_to_le32(0x10000000)
588 #define FILE_GENERIC_EXECUTE_LE cpu_to_le32(0x20000000)
589 #define FILE_GENERIC_WRITE_LE cpu_to_le32(0x40000000)
590 #define FILE_GENERIC_READ_LE cpu_to_le32(0x80000000)
592 /* ShareAccess Flags */
593 #define FILE_SHARE_READ_LE cpu_to_le32(0x00000001)
594 #define FILE_SHARE_WRITE_LE cpu_to_le32(0x00000002)
595 #define FILE_SHARE_DELETE_LE cpu_to_le32(0x00000004)
596 #define FILE_SHARE_ALL_LE cpu_to_le32(0x00000007)
598 /* CreateDisposition Flags */
599 #define FILE_SUPERSEDE_LE cpu_to_le32(0x00000000)
600 #define FILE_OPEN_LE cpu_to_le32(0x00000001)
601 #define FILE_CREATE_LE cpu_to_le32(0x00000002)
602 #define FILE_OPEN_IF_LE cpu_to_le32(0x00000003)
603 #define FILE_OVERWRITE_LE cpu_to_le32(0x00000004)
604 #define FILE_OVERWRITE_IF_LE cpu_to_le32(0x00000005)
606 /* CreateOptions Flags */
607 #define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
608 /* same as #define CREATE_NOT_FILE_LE cpu_to_le32(0x00000001) */
609 #define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
610 #define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
611 #define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
612 #define FILE_SYNCHRONOUS_IO_ALERT_LE cpu_to_le32(0x00000010)
613 #define FILE_SYNCHRONOUS_IO_NON_ALERT_LE cpu_to_le32(0x00000020)
614 #define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
615 #define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
616 #define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
617 #define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
618 #define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000)
619 #define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
620 #define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
621 #define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
622 #define FILE_RESERVE_OPFILTER_LE cpu_to_le32(0x00100000)
623 #define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
624 #define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
625 #define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
627 #define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
628 | FILE_READ_ATTRIBUTES_LE)
629 #define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
630 | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
631 #define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
633 /* Impersonation Levels */
634 #define IL_ANONYMOUS cpu_to_le32(0x00000000)
635 #define IL_IDENTIFICATION cpu_to_le32(0x00000001)
636 #define IL_IMPERSONATION cpu_to_le32(0x00000002)
637 #define IL_DELEGATE cpu_to_le32(0x00000003)
639 /* Create Context Values */
640 #define SMB2_CREATE_EA_BUFFER "ExtA" /* extended attributes */
641 #define SMB2_CREATE_SD_BUFFER "SecD" /* security descriptor */
642 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST "DHnQ"
643 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT "DHnC"
644 #define SMB2_CREATE_ALLOCATION_SIZE "AISi"
645 #define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
646 #define SMB2_CREATE_TIMEWARP_REQUEST "TWrp"
647 #define SMB2_CREATE_QUERY_ON_DISK_ID "QFid"
648 #define SMB2_CREATE_REQUEST_LEASE "RqLs"
649 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST_V2 "DH2Q"
650 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT_V2 "DH2C"
651 #define SMB2_CREATE_APP_INSTANCE_ID 0x45BCA66AEFA7F74A9008FA462E144D74
652 #define SMB2_CREATE_APP_INSTANCE_VERSION 0xB982D0B73B56074FA07B524A8116A010
653 #define SVHDX_OPEN_DEVICE_CONTEX 0x9CCBCF9E04C1E643980E158DA1F6EC83
654 #define SMB2_CREATE_TAG_POSIX 0x93AD25509CB411E7B42383DE968BCD7C
656 /* Flag (SMB3 open response) values */
657 #define SMB2_CREATE_FLAG_REPARSEPOINT 0x01
660 * Maximum number of iovs we need for an open/create request.
661 * [0] : struct smb2_create_req
663 * [2] : lease context
664 * [3] : durable context
665 * [4] : posix context
666 * [5] : time warp context
667 * [6] : query id context
668 * [7] : compound padding
670 #define SMB2_CREATE_IOV_SIZE 8
672 struct smb2_create_req {
673 struct smb2_sync_hdr sync_hdr;
674 __le16 StructureSize; /* Must be 57 */
676 __u8 RequestedOplockLevel;
677 __le32 ImpersonationLevel;
678 __le64 SmbCreateFlags;
680 __le32 DesiredAccess;
681 __le32 FileAttributes;
683 __le32 CreateDisposition;
684 __le32 CreateOptions;
687 __le32 CreateContextsOffset;
688 __le32 CreateContextsLength;
693 * Maximum size of a SMB2_CREATE response is 64 (smb2 header) +
694 * 88 (fixed part of create response) + 520 (path) + 208 (contexts) +
695 * 2 bytes of padding.
697 #define MAX_SMB2_CREATE_RESPONSE_SIZE 880
699 struct smb2_create_rsp {
700 struct smb2_sync_hdr sync_hdr;
701 __le16 StructureSize; /* Must be 89 */
703 __u8 Flag; /* 0x01 if reparse point */
706 __le64 LastAccessTime;
707 __le64 LastWriteTime;
709 __le64 AllocationSize;
711 __le32 FileAttributes;
713 __u64 PersistentFileId; /* opaque endianness */
714 __u64 VolatileFileId; /* opaque endianness */
715 __le32 CreateContextsOffset;
716 __le32 CreateContextsLength;
720 struct create_context {
730 #define SMB2_LEASE_READ_CACHING_HE 0x01
731 #define SMB2_LEASE_HANDLE_CACHING_HE 0x02
732 #define SMB2_LEASE_WRITE_CACHING_HE 0x04
734 #define SMB2_LEASE_NONE cpu_to_le32(0x00)
735 #define SMB2_LEASE_READ_CACHING cpu_to_le32(0x01)
736 #define SMB2_LEASE_HANDLE_CACHING cpu_to_le32(0x02)
737 #define SMB2_LEASE_WRITE_CACHING cpu_to_le32(0x04)
739 #define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS cpu_to_le32(0x02)
740 #define SMB2_LEASE_FLAG_PARENT_LEASE_KEY_SET cpu_to_le32(0x00000004)
742 #define SMB2_LEASE_KEY_SIZE 16
744 struct lease_context {
745 u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
748 __le64 LeaseDuration;
751 struct lease_context_v2 {
752 u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
755 __le64 LeaseDuration;
756 __le64 ParentLeaseKeyLow;
757 __le64 ParentLeaseKeyHigh;
762 struct create_lease {
763 struct create_context ccontext;
765 struct lease_context lcontext;
768 struct create_lease_v2 {
769 struct create_context ccontext;
771 struct lease_context_v2 lcontext;
775 struct create_durable {
776 struct create_context ccontext;
781 __u64 PersistentFileId;
782 __u64 VolatileFileId;
787 struct create_posix {
788 struct create_context ccontext;
794 /* See MS-SMB2 2.2.13.2.11 */
796 #define SMB2_DHANDLE_FLAG_PERSISTENT 0x00000002
797 struct durable_context_v2 {
804 struct create_durable_v2 {
805 struct create_context ccontext;
807 struct durable_context_v2 dcontext;
810 /* See MS-SMB2 2.2.13.2.12 */
811 struct durable_reconnect_context_v2 {
813 __u64 PersistentFileId;
814 __u64 VolatileFileId;
817 __le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
820 /* See MS-SMB2 2.2.14.2.9 */
821 struct create_on_disk_id {
822 struct create_context ccontext;
829 /* See MS-SMB2 2.2.14.2.12 */
830 struct durable_reconnect_context_v2_rsp {
832 __le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
835 struct create_durable_handle_reconnect_v2 {
836 struct create_context ccontext;
838 struct durable_reconnect_context_v2 dcontext;
841 /* See MS-SMB2 2.2.13.2.5 */
842 struct crt_twarp_ctxt {
843 struct create_context ccontext;
849 /* See MS-SMB2 2.2.13.2.9 */
850 struct crt_query_id_ctxt {
851 struct create_context ccontext;
855 #define COPY_CHUNK_RES_KEY_SIZE 24
856 struct resume_key_req {
857 char ResumeKey[COPY_CHUNK_RES_KEY_SIZE];
858 __le32 ContextLength; /* MBZ */
859 char Context[0]; /* ignored, Windows sets to 4 bytes of zero */
862 /* this goes in the ioctl buffer when doing a copychunk request */
863 struct copychunk_ioctl {
864 char SourceKey[COPY_CHUNK_RES_KEY_SIZE];
865 __le32 ChunkCount; /* we are only sending 1 */
867 /* array will only be one chunk long for us */
870 __le32 Length; /* how many bytes to copy */
874 /* this goes in the ioctl buffer when doing FSCTL_SET_ZERO_DATA */
875 struct file_zero_data_information {
877 __le64 BeyondFinalZero;
880 struct copychunk_ioctl_rsp {
881 __le32 ChunksWritten;
882 __le32 ChunkBytesWritten;
883 __le32 TotalBytesWritten;
886 struct fsctl_set_integrity_information_req {
887 __le16 ChecksumAlgorithm;
892 struct fsctl_get_integrity_information_rsp {
893 __le16 ChecksumAlgorithm;
896 __le32 ChecksumChunkSizeInBytes;
897 __le32 ClusterSizeInBytes;
900 struct file_allocated_range_buffer {
905 /* Integrity ChecksumAlgorithm choices for above */
906 #define CHECKSUM_TYPE_NONE 0x0000
907 #define CHECKSUM_TYPE_CRC64 0x0002
908 #define CHECKSUM_TYPE_UNCHANGED 0xFFFF /* set only */
910 /* Integrity flags for above */
911 #define FSCTL_INTEGRITY_FLAG_CHECKSUM_ENFORCEMENT_OFF 0x00000001
913 /* Reparse structures - see MS-FSCC 2.1.2 */
915 /* struct fsctl_reparse_info_req is empty, only response structs (see below) */
917 struct reparse_data_buffer {
919 __le16 ReparseDataLength;
921 __u8 DataBuffer[0]; /* Variable Length */
924 struct reparse_guid_data_buffer {
926 __le16 ReparseDataLength;
928 __u8 ReparseGuid[16];
929 __u8 DataBuffer[0]; /* Variable Length */
932 struct reparse_mount_point_data_buffer {
934 __le16 ReparseDataLength;
936 __le16 SubstituteNameOffset;
937 __le16 SubstituteNameLength;
938 __le16 PrintNameOffset;
939 __le16 PrintNameLength;
940 __u8 PathBuffer[0]; /* Variable Length */
943 #define SYMLINK_FLAG_RELATIVE 0x00000001
945 struct reparse_symlink_data_buffer {
947 __le16 ReparseDataLength;
949 __le16 SubstituteNameOffset;
950 __le16 SubstituteNameLength;
951 __le16 PrintNameOffset;
952 __le16 PrintNameLength;
954 __u8 PathBuffer[0]; /* Variable Length */
957 /* See MS-FSCC 2.1.2.6 and cifspdu.h for struct reparse_posix_data */
960 /* See MS-DFSC 2.2.2 */
961 struct fsctl_get_dfs_referral_req {
962 __le16 MaxReferralLevel;
963 __u8 RequestFileName[];
966 /* DFS response is struct get_dfs_refer_rsp */
968 /* See MS-SMB2 2.2.31.3 */
969 struct network_resiliency_req {
973 /* There is no buffer for the response ie no struct network_resiliency_rsp */
976 struct validate_negotiate_info_req {
978 __u8 Guid[SMB2_CLIENT_GUID_SIZE];
981 __le16 Dialects[4]; /* BB expand this if autonegotiate > 4 dialects */
984 struct validate_negotiate_info_rsp {
986 __u8 Guid[SMB2_CLIENT_GUID_SIZE];
988 __le16 Dialect; /* Dialect in use for the connection */
991 #define RSS_CAPABLE cpu_to_le32(0x00000001)
992 #define RDMA_CAPABLE cpu_to_le32(0x00000002)
994 #define INTERNETWORK cpu_to_le16(0x0002)
995 #define INTERNETWORKV6 cpu_to_le16(0x0017)
997 struct network_interface_info_ioctl_rsp {
998 __le32 Next; /* next interface. zero if this is last one */
1000 __le32 Capability; /* RSS or RDMA Capable */
1007 struct iface_info_ipv4 {
1013 struct iface_info_ipv6 {
1016 __u8 IPv6Address[16];
1020 #define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
1022 struct compress_ioctl {
1023 __le16 CompressionState; /* See cifspdu.h for possible flag values */
1026 struct duplicate_extents_to_file {
1027 __u64 PersistentFileHandle; /* source file handle, opaque endianness */
1028 __u64 VolatileFileHandle;
1029 __le64 SourceFileOffset;
1030 __le64 TargetFileOffset;
1031 __le64 ByteCount; /* Bytes to be copied */
1035 * Maximum number of iovs we need for an ioctl request.
1036 * [0] : struct smb2_ioctl_req
1039 #define SMB2_IOCTL_IOV_SIZE 2
1041 struct smb2_ioctl_req {
1042 struct smb2_sync_hdr sync_hdr;
1043 __le16 StructureSize; /* Must be 57 */
1046 __u64 PersistentFileId; /* opaque endianness */
1047 __u64 VolatileFileId; /* opaque endianness */
1050 __le32 MaxInputResponse;
1051 __le32 OutputOffset;
1053 __le32 MaxOutputResponse;
1059 struct smb2_ioctl_rsp {
1060 struct smb2_sync_hdr sync_hdr;
1061 __le16 StructureSize; /* Must be 57 */
1064 __u64 PersistentFileId; /* opaque endianness */
1065 __u64 VolatileFileId; /* opaque endianness */
1068 __le32 OutputOffset;
1072 /* char * buffer[] */
1075 /* Currently defined values for close flags */
1076 #define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
1077 struct smb2_close_req {
1078 struct smb2_sync_hdr sync_hdr;
1079 __le16 StructureSize; /* Must be 24 */
1082 __u64 PersistentFileId; /* opaque endianness */
1083 __u64 VolatileFileId; /* opaque endianness */
1087 * Maximum size of a SMB2_CLOSE response is 64 (smb2 header) + 60 (data)
1089 #define MAX_SMB2_CLOSE_RESPONSE_SIZE 124
1091 struct smb2_close_rsp {
1092 struct smb2_sync_hdr sync_hdr;
1093 __le16 StructureSize; /* 60 */
1096 __le64 CreationTime;
1097 __le64 LastAccessTime;
1098 __le64 LastWriteTime;
1100 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
1105 struct smb2_flush_req {
1106 struct smb2_sync_hdr sync_hdr;
1107 __le16 StructureSize; /* Must be 24 */
1110 __u64 PersistentFileId; /* opaque endianness */
1111 __u64 VolatileFileId; /* opaque endianness */
1114 struct smb2_flush_rsp {
1115 struct smb2_sync_hdr sync_hdr;
1116 __le16 StructureSize;
1120 /* For read request Flags field below, following flag is defined for SMB3.02 */
1121 #define SMB2_READFLAG_READ_UNBUFFERED 0x01
1122 #define SMB2_READFLAG_REQUEST_COMPRESSED 0x02 /* See MS-SMB2 2.2.19 */
1124 /* Channel field for read and write: exactly one of following flags can be set*/
1125 #define SMB2_CHANNEL_NONE cpu_to_le32(0x00000000)
1126 #define SMB2_CHANNEL_RDMA_V1 cpu_to_le32(0x00000001) /* SMB3 or later */
1127 #define SMB2_CHANNEL_RDMA_V1_INVALIDATE cpu_to_le32(0x00000002) /* >= SMB3.02 */
1129 /* SMB2 read request without RFC1001 length at the beginning */
1130 struct smb2_read_plain_req {
1131 struct smb2_sync_hdr sync_hdr;
1132 __le16 StructureSize; /* Must be 49 */
1133 __u8 Padding; /* offset from start of SMB2 header to place read */
1134 __u8 Flags; /* MBZ unless SMB3.02 or later */
1137 __u64 PersistentFileId; /* opaque endianness */
1138 __u64 VolatileFileId; /* opaque endianness */
1139 __le32 MinimumCount;
1140 __le32 Channel; /* MBZ except for SMB3 or later */
1141 __le32 RemainingBytes;
1142 __le16 ReadChannelInfoOffset;
1143 __le16 ReadChannelInfoLength;
1147 struct smb2_read_rsp {
1148 struct smb2_sync_hdr sync_hdr;
1149 __le16 StructureSize; /* Must be 17 */
1153 __le32 DataRemaining;
1158 /* For write request Flags field below the following flags are defined: */
1159 #define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
1160 #define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
1162 struct smb2_write_req {
1163 struct smb2_sync_hdr sync_hdr;
1164 __le16 StructureSize; /* Must be 49 */
1165 __le16 DataOffset; /* offset from start of SMB2 header to write data */
1168 __u64 PersistentFileId; /* opaque endianness */
1169 __u64 VolatileFileId; /* opaque endianness */
1170 __le32 Channel; /* Reserved MBZ */
1171 __le32 RemainingBytes;
1172 __le16 WriteChannelInfoOffset;
1173 __le16 WriteChannelInfoLength;
1178 struct smb2_write_rsp {
1179 struct smb2_sync_hdr sync_hdr;
1180 __le16 StructureSize; /* Must be 17 */
1184 __le32 DataRemaining;
1190 #define SMB2_WATCH_TREE 0x0001
1192 /* notify completion filter flags. See MS-FSCC 2.6 and MS-SMB2 2.2.35 */
1193 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x00000001
1194 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x00000002
1195 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x00000004
1196 #define FILE_NOTIFY_CHANGE_SIZE 0x00000008
1197 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x00000010
1198 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x00000020
1199 #define FILE_NOTIFY_CHANGE_CREATION 0x00000040
1200 #define FILE_NOTIFY_CHANGE_EA 0x00000080
1201 #define FILE_NOTIFY_CHANGE_SECURITY 0x00000100
1202 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1203 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1204 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1206 struct smb2_change_notify_req {
1207 struct smb2_sync_hdr sync_hdr;
1208 __le16 StructureSize;
1210 __le32 OutputBufferLength;
1211 __u64 PersistentFileId; /* opaque endianness */
1212 __u64 VolatileFileId; /* opaque endianness */
1213 __le32 CompletionFilter;
1217 struct smb2_change_notify_rsp {
1218 struct smb2_sync_hdr sync_hdr;
1219 __le16 StructureSize; /* Must be 9 */
1220 __le16 OutputBufferOffset;
1221 __le32 OutputBufferLength;
1222 __u8 Buffer[1]; /* array of file notify structs */
1225 #define SMB2_LOCKFLAG_SHARED_LOCK 0x0001
1226 #define SMB2_LOCKFLAG_EXCLUSIVE_LOCK 0x0002
1227 #define SMB2_LOCKFLAG_UNLOCK 0x0004
1228 #define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
1230 struct smb2_lock_element {
1237 struct smb2_lock_req {
1238 struct smb2_sync_hdr sync_hdr;
1239 __le16 StructureSize; /* Must be 48 */
1242 __u64 PersistentFileId; /* opaque endianness */
1243 __u64 VolatileFileId; /* opaque endianness */
1244 /* Followed by at least one */
1245 struct smb2_lock_element locks[1];
1248 struct smb2_lock_rsp {
1249 struct smb2_sync_hdr sync_hdr;
1250 __le16 StructureSize; /* Must be 4 */
1254 struct smb2_echo_req {
1255 struct smb2_sync_hdr sync_hdr;
1256 __le16 StructureSize; /* Must be 4 */
1260 struct smb2_echo_rsp {
1261 struct smb2_sync_hdr sync_hdr;
1262 __le16 StructureSize; /* Must be 4 */
1266 /* search (query_directory) Flags field */
1267 #define SMB2_RESTART_SCANS 0x01
1268 #define SMB2_RETURN_SINGLE_ENTRY 0x02
1269 #define SMB2_INDEX_SPECIFIED 0x04
1270 #define SMB2_REOPEN 0x10
1272 struct smb2_query_directory_req {
1273 struct smb2_sync_hdr sync_hdr;
1274 __le16 StructureSize; /* Must be 33 */
1275 __u8 FileInformationClass;
1278 __u64 PersistentFileId; /* opaque endianness */
1279 __u64 VolatileFileId; /* opaque endianness */
1280 __le16 FileNameOffset;
1281 __le16 FileNameLength;
1282 __le32 OutputBufferLength;
1286 struct smb2_query_directory_rsp {
1287 struct smb2_sync_hdr sync_hdr;
1288 __le16 StructureSize; /* Must be 9 */
1289 __le16 OutputBufferOffset;
1290 __le32 OutputBufferLength;
1294 /* Possible InfoType values */
1295 #define SMB2_O_INFO_FILE 0x01
1296 #define SMB2_O_INFO_FILESYSTEM 0x02
1297 #define SMB2_O_INFO_SECURITY 0x03
1298 #define SMB2_O_INFO_QUOTA 0x04
1300 /* Security info type additionalinfo flags. See MS-SMB2 (2.2.37) or MS-DTYP */
1301 #define OWNER_SECINFO 0x00000001
1302 #define GROUP_SECINFO 0x00000002
1303 #define DACL_SECINFO 0x00000004
1304 #define SACL_SECINFO 0x00000008
1305 #define LABEL_SECINFO 0x00000010
1306 #define ATTRIBUTE_SECINFO 0x00000020
1307 #define SCOPE_SECINFO 0x00000040
1308 #define BACKUP_SECINFO 0x00010000
1309 #define UNPROTECTED_SACL_SECINFO 0x10000000
1310 #define UNPROTECTED_DACL_SECINFO 0x20000000
1311 #define PROTECTED_SACL_SECINFO 0x40000000
1312 #define PROTECTED_DACL_SECINFO 0x80000000
1314 /* Flags used for FileFullEAinfo */
1315 #define SL_RESTART_SCAN 0x00000001
1316 #define SL_RETURN_SINGLE_ENTRY 0x00000002
1317 #define SL_INDEX_SPECIFIED 0x00000004
1319 struct smb2_query_info_req {
1320 struct smb2_sync_hdr sync_hdr;
1321 __le16 StructureSize; /* Must be 41 */
1324 __le32 OutputBufferLength;
1325 __le16 InputBufferOffset;
1327 __le32 InputBufferLength;
1328 __le32 AdditionalInformation;
1330 __u64 PersistentFileId; /* opaque endianness */
1331 __u64 VolatileFileId; /* opaque endianness */
1335 struct smb2_query_info_rsp {
1336 struct smb2_sync_hdr sync_hdr;
1337 __le16 StructureSize; /* Must be 9 */
1338 __le16 OutputBufferOffset;
1339 __le32 OutputBufferLength;
1344 * Maximum number of iovs we need for a set-info request.
1345 * The largest one is rename/hardlink
1346 * [0] : struct smb2_set_info_req + smb2_file_[rename|link]_info
1348 * [2] : compound padding
1350 #define SMB2_SET_INFO_IOV_SIZE 3
1352 struct smb2_set_info_req {
1353 struct smb2_sync_hdr sync_hdr;
1354 __le16 StructureSize; /* Must be 33 */
1357 __le32 BufferLength;
1358 __le16 BufferOffset;
1360 __le32 AdditionalInformation;
1361 __u64 PersistentFileId; /* opaque endianness */
1362 __u64 VolatileFileId; /* opaque endianness */
1366 struct smb2_set_info_rsp {
1367 struct smb2_sync_hdr sync_hdr;
1368 __le16 StructureSize; /* Must be 2 */
1371 struct smb2_oplock_break {
1372 struct smb2_sync_hdr sync_hdr;
1373 __le16 StructureSize; /* Must be 24 */
1377 __u64 PersistentFid;
1381 #define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
1383 struct smb2_lease_break {
1384 struct smb2_sync_hdr sync_hdr;
1385 __le16 StructureSize; /* Must be 44 */
1389 __le32 CurrentLeaseState;
1390 __le32 NewLeaseState;
1392 __le32 AccessMaskHint;
1393 __le32 ShareMaskHint;
1396 struct smb2_lease_ack {
1397 struct smb2_sync_hdr sync_hdr;
1398 __le16 StructureSize; /* Must be 36 */
1403 __le64 LeaseDuration;
1407 * PDU infolevel structure definitions
1408 * BB consider moving to a different header
1411 /* File System Information Classes */
1412 #define FS_VOLUME_INFORMATION 1 /* Query */
1413 #define FS_LABEL_INFORMATION 2 /* Local only */
1414 #define FS_SIZE_INFORMATION 3 /* Query */
1415 #define FS_DEVICE_INFORMATION 4 /* Query */
1416 #define FS_ATTRIBUTE_INFORMATION 5 /* Query */
1417 #define FS_CONTROL_INFORMATION 6 /* Query, Set */
1418 #define FS_FULL_SIZE_INFORMATION 7 /* Query */
1419 #define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
1420 #define FS_DRIVER_PATH_INFORMATION 9 /* Local only */
1421 #define FS_VOLUME_FLAGS_INFORMATION 10 /* Local only */
1422 #define FS_SECTOR_SIZE_INFORMATION 11 /* SMB3 or later. Query */
1423 #define FS_POSIX_INFORMATION 100 /* SMB3.1.1 POSIX. Query */
1425 struct smb2_fs_full_size_info {
1426 __le64 TotalAllocationUnits;
1427 __le64 CallerAvailableAllocationUnits;
1428 __le64 ActualAvailableAllocationUnits;
1429 __le32 SectorsPerAllocationUnit;
1430 __le32 BytesPerSector;
1433 #define SSINFO_FLAGS_ALIGNED_DEVICE 0x00000001
1434 #define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
1435 #define SSINFO_FLAGS_NO_SEEK_PENALTY 0x00000004
1436 #define SSINFO_FLAGS_TRIM_ENABLED 0x00000008
1438 /* sector size info struct */
1439 struct smb3_fs_ss_info {
1440 __le32 LogicalBytesPerSector;
1441 __le32 PhysicalBytesPerSectorForAtomicity;
1442 __le32 PhysicalBytesPerSectorForPerf;
1443 __le32 FileSystemEffectivePhysicalBytesPerSectorForAtomicity;
1445 __le32 ByteOffsetForSectorAlignment;
1446 __le32 ByteOffsetForPartitionAlignment;
1449 /* volume info struct - see MS-FSCC 2.5.9 */
1450 #define MAX_VOL_LABEL_LEN 32
1451 struct smb3_fs_vol_info {
1452 __le64 VolumeCreationTime;
1453 __u32 VolumeSerialNumber;
1454 __le32 VolumeLabelLength; /* includes trailing null */
1455 __u8 SupportsObjects; /* True if eg like NTFS, supports objects */
1457 __u8 VolumeLabel[0]; /* variable len */
1460 /* partial list of QUERY INFO levels */
1461 #define FILE_DIRECTORY_INFORMATION 1
1462 #define FILE_FULL_DIRECTORY_INFORMATION 2
1463 #define FILE_BOTH_DIRECTORY_INFORMATION 3
1464 #define FILE_BASIC_INFORMATION 4
1465 #define FILE_STANDARD_INFORMATION 5
1466 #define FILE_INTERNAL_INFORMATION 6
1467 #define FILE_EA_INFORMATION 7
1468 #define FILE_ACCESS_INFORMATION 8
1469 #define FILE_NAME_INFORMATION 9
1470 #define FILE_RENAME_INFORMATION 10
1471 #define FILE_LINK_INFORMATION 11
1472 #define FILE_NAMES_INFORMATION 12
1473 #define FILE_DISPOSITION_INFORMATION 13
1474 #define FILE_POSITION_INFORMATION 14
1475 #define FILE_FULL_EA_INFORMATION 15
1476 #define FILE_MODE_INFORMATION 16
1477 #define FILE_ALIGNMENT_INFORMATION 17
1478 #define FILE_ALL_INFORMATION 18
1479 #define FILE_ALLOCATION_INFORMATION 19
1480 #define FILE_END_OF_FILE_INFORMATION 20
1481 #define FILE_ALTERNATE_NAME_INFORMATION 21
1482 #define FILE_STREAM_INFORMATION 22
1483 #define FILE_PIPE_INFORMATION 23
1484 #define FILE_PIPE_LOCAL_INFORMATION 24
1485 #define FILE_PIPE_REMOTE_INFORMATION 25
1486 #define FILE_MAILSLOT_QUERY_INFORMATION 26
1487 #define FILE_MAILSLOT_SET_INFORMATION 27
1488 #define FILE_COMPRESSION_INFORMATION 28
1489 #define FILE_OBJECT_ID_INFORMATION 29
1490 /* Number 30 not defined in documents */
1491 #define FILE_MOVE_CLUSTER_INFORMATION 31
1492 #define FILE_QUOTA_INFORMATION 32
1493 #define FILE_REPARSE_POINT_INFORMATION 33
1494 #define FILE_NETWORK_OPEN_INFORMATION 34
1495 #define FILE_ATTRIBUTE_TAG_INFORMATION 35
1496 #define FILE_TRACKING_INFORMATION 36
1497 #define FILEID_BOTH_DIRECTORY_INFORMATION 37
1498 #define FILEID_FULL_DIRECTORY_INFORMATION 38
1499 #define FILE_VALID_DATA_LENGTH_INFORMATION 39
1500 #define FILE_SHORT_NAME_INFORMATION 40
1501 #define FILE_SFIO_RESERVE_INFORMATION 44
1502 #define FILE_SFIO_VOLUME_INFORMATION 45
1503 #define FILE_HARD_LINK_INFORMATION 46
1504 #define FILE_NORMALIZED_NAME_INFORMATION 48
1505 #define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
1506 #define FILE_STANDARD_LINK_INFORMATION 54
1508 struct smb2_file_internal_info {
1510 } __packed; /* level 6 Query */
1512 struct smb2_file_rename_info { /* encoding of request for level 10 */
1513 __u8 ReplaceIfExists; /* 1 = replace existing target with new */
1514 /* 0 = fail if target already exists */
1516 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
1517 __le32 FileNameLength;
1518 char FileName[0]; /* New name to be assigned */
1519 } __packed; /* level 10 Set */
1521 struct smb2_file_link_info { /* encoding of request for level 11 */
1522 __u8 ReplaceIfExists; /* 1 = replace existing link with new */
1523 /* 0 = fail if link already exists */
1525 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
1526 __le32 FileNameLength;
1527 char FileName[0]; /* Name to be assigned to new link */
1528 } __packed; /* level 11 Set */
1530 struct smb2_file_full_ea_info { /* encoding of response for level 15 */
1531 __le32 next_entry_offset;
1533 __u8 ea_name_length;
1534 __le16 ea_value_length;
1535 char ea_data[0]; /* \0 terminated name plus value */
1536 } __packed; /* level 15 Set */
1539 * This level 18, although with struct with same name is different from cifs
1540 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
1541 * CurrentByteOffset.
1543 struct smb2_file_all_info { /* data block encoding of response to level 18 */
1544 __le64 CreationTime; /* Beginning of FILE_BASIC_INFO equivalent */
1545 __le64 LastAccessTime;
1546 __le64 LastWriteTime;
1549 __u32 Pad1; /* End of FILE_BASIC_INFO_INFO equivalent */
1550 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
1551 __le64 EndOfFile; /* size ie offset to first free byte in file */
1552 __le32 NumberOfLinks; /* hard links */
1555 __u16 Pad2; /* End of FILE_STANDARD_INFO equivalent */
1559 __le64 CurrentByteOffset;
1561 __le32 AlignmentRequirement;
1562 __le32 FileNameLength;
1564 } __packed; /* level 18 Query */
1566 struct smb2_file_eof_info { /* encoding of request for level 10 */
1567 __le64 EndOfFile; /* new end of file value */
1568 } __packed; /* level 20 Set */
1570 extern char smb2_padding[7];
1572 #endif /* _SMB2PDU_H */