Loading...
1/* SPDX-License-Identifier: LGPL-2.1 */
2/*
3 * fs/cifs/smb2pdu.h
4 *
5 * Copyright (c) International Business Machines Corp., 2009, 2013
6 * Etersoft, 2012
7 * Author(s): Steve French (sfrench@us.ibm.com)
8 * Pavel Shilovsky (pshilovsky@samba.org) 2012
9 *
10 */
11
12#ifndef _SMB2PDU_H
13#define _SMB2PDU_H
14
15#include <net/sock.h>
16#include "cifsacl.h"
17
18/*
19 * Note that, due to trying to use names similar to the protocol specifications,
20 * there are many mixed case field names in the structures below. Although
21 * this does not match typical Linux kernel style, it is necessary to be
22 * able to match against the protocol specfication.
23 *
24 * SMB2 commands
25 * Some commands have minimal (wct=0,bcc=0), or uninteresting, responses
26 * (ie no useful data other than the SMB error code itself) and are marked such.
27 * Knowing this helps avoid response buffer allocations and copy in some cases.
28 */
29
30/* List of commands in host endian */
31#define SMB2_NEGOTIATE_HE 0x0000
32#define SMB2_SESSION_SETUP_HE 0x0001
33#define SMB2_LOGOFF_HE 0x0002 /* trivial request/resp */
34#define SMB2_TREE_CONNECT_HE 0x0003
35#define SMB2_TREE_DISCONNECT_HE 0x0004 /* trivial req/resp */
36#define SMB2_CREATE_HE 0x0005
37#define SMB2_CLOSE_HE 0x0006
38#define SMB2_FLUSH_HE 0x0007 /* trivial resp */
39#define SMB2_READ_HE 0x0008
40#define SMB2_WRITE_HE 0x0009
41#define SMB2_LOCK_HE 0x000A
42#define SMB2_IOCTL_HE 0x000B
43#define SMB2_CANCEL_HE 0x000C
44#define SMB2_ECHO_HE 0x000D
45#define SMB2_QUERY_DIRECTORY_HE 0x000E
46#define SMB2_CHANGE_NOTIFY_HE 0x000F
47#define SMB2_QUERY_INFO_HE 0x0010
48#define SMB2_SET_INFO_HE 0x0011
49#define SMB2_OPLOCK_BREAK_HE 0x0012
50
51/* The same list in little endian */
52#define SMB2_NEGOTIATE cpu_to_le16(SMB2_NEGOTIATE_HE)
53#define SMB2_SESSION_SETUP cpu_to_le16(SMB2_SESSION_SETUP_HE)
54#define SMB2_LOGOFF cpu_to_le16(SMB2_LOGOFF_HE)
55#define SMB2_TREE_CONNECT cpu_to_le16(SMB2_TREE_CONNECT_HE)
56#define SMB2_TREE_DISCONNECT cpu_to_le16(SMB2_TREE_DISCONNECT_HE)
57#define SMB2_CREATE cpu_to_le16(SMB2_CREATE_HE)
58#define SMB2_CLOSE cpu_to_le16(SMB2_CLOSE_HE)
59#define SMB2_FLUSH cpu_to_le16(SMB2_FLUSH_HE)
60#define SMB2_READ cpu_to_le16(SMB2_READ_HE)
61#define SMB2_WRITE cpu_to_le16(SMB2_WRITE_HE)
62#define SMB2_LOCK cpu_to_le16(SMB2_LOCK_HE)
63#define SMB2_IOCTL cpu_to_le16(SMB2_IOCTL_HE)
64#define SMB2_CANCEL cpu_to_le16(SMB2_CANCEL_HE)
65#define SMB2_ECHO cpu_to_le16(SMB2_ECHO_HE)
66#define SMB2_QUERY_DIRECTORY cpu_to_le16(SMB2_QUERY_DIRECTORY_HE)
67#define SMB2_CHANGE_NOTIFY cpu_to_le16(SMB2_CHANGE_NOTIFY_HE)
68#define SMB2_QUERY_INFO cpu_to_le16(SMB2_QUERY_INFO_HE)
69#define SMB2_SET_INFO cpu_to_le16(SMB2_SET_INFO_HE)
70#define SMB2_OPLOCK_BREAK cpu_to_le16(SMB2_OPLOCK_BREAK_HE)
71
72#define SMB2_INTERNAL_CMD cpu_to_le16(0xFFFF)
73
74#define NUMBER_OF_SMB2_COMMANDS 0x0013
75
76/* 52 transform hdr + 64 hdr + 88 create rsp */
77#define SMB2_TRANSFORM_HEADER_SIZE 52
78#define MAX_SMB2_HDR_SIZE 204
79
80#define SMB2_PROTO_NUMBER cpu_to_le32(0x424d53fe)
81#define SMB2_TRANSFORM_PROTO_NUM cpu_to_le32(0x424d53fd)
82#define SMB2_COMPRESSION_TRANSFORM_ID cpu_to_le32(0x424d53fc)
83
84/*
85 * SMB2 Header Definition
86 *
87 * "MBZ" : Must be Zero
88 * "BB" : BugBug, Something to check/review/analyze later
89 * "PDU" : "Protocol Data Unit" (ie a network "frame")
90 *
91 */
92
93#define SMB2_HEADER_STRUCTURE_SIZE cpu_to_le16(64)
94
95struct smb2_sync_hdr {
96 __le32 ProtocolId; /* 0xFE 'S' 'M' 'B' */
97 __le16 StructureSize; /* 64 */
98 __le16 CreditCharge; /* MBZ */
99 __le32 Status; /* Error from server */
100 __le16 Command;
101 __le16 CreditRequest; /* CreditResponse */
102 __le32 Flags;
103 __le32 NextCommand;
104 __le64 MessageId;
105 __le32 ProcessId;
106 __u32 TreeId; /* opaque - so do not make little endian */
107 __u64 SessionId; /* opaque - so do not make little endian */
108 __u8 Signature[16];
109} __packed;
110
111/* The total header size for SMB2 read and write */
112#define SMB2_READWRITE_PDU_HEADER_SIZE (48 + sizeof(struct smb2_sync_hdr))
113
114struct smb2_sync_pdu {
115 struct smb2_sync_hdr sync_hdr;
116 __le16 StructureSize2; /* size of wct area (varies, request specific) */
117} __packed;
118
119#define SMB3_AES_CCM_NONCE 11
120#define SMB3_AES_GCM_NONCE 12
121
122/* Transform flags (for 3.0 dialect this flag indicates CCM */
123#define TRANSFORM_FLAG_ENCRYPTED 0x0001
124struct smb2_transform_hdr {
125 __le32 ProtocolId; /* 0xFD 'S' 'M' 'B' */
126 __u8 Signature[16];
127 __u8 Nonce[16];
128 __le32 OriginalMessageSize;
129 __u16 Reserved1;
130 __le16 Flags; /* EncryptionAlgorithm for 3.0, enc enabled for 3.1.1 */
131 __u64 SessionId;
132} __packed;
133
134/* See MS-SMB2 2.2.42 */
135struct smb2_compression_transform_hdr_unchained {
136 __le32 ProtocolId; /* 0xFC 'S' 'M' 'B' */
137 __le32 OriginalCompressedSegmentSize;
138 __le16 CompressionAlgorithm;
139 __le16 Flags;
140 __le16 Length; /* if chained it is length, else offset */
141} __packed;
142
143/* See MS-SMB2 2.2.42.1 */
144#define SMB2_COMPRESSION_FLAG_NONE 0x0000
145#define SMB2_COMPRESSION_FLAG_CHAINED 0x0001
146
147struct compression_payload_header {
148 __le16 CompressionAlgorithm;
149 __le16 Flags;
150 __le32 Length; /* length of compressed playload including field below if present */
151 /* __le32 OriginalPayloadSize; */ /* optional, present when LZNT1, LZ77, LZ77+Huffman */
152} __packed;
153
154/* See MS-SMB2 2.2.42.2 */
155struct smb2_compression_transform_hdr_chained {
156 __le32 ProtocolId; /* 0xFC 'S' 'M' 'B' */
157 __le32 OriginalCompressedSegmentSize;
158 /* struct compression_payload_header[] */
159} __packed;
160
161/* See MS-SMB2 2.2.42.2.2 */
162struct compression_pattern_payload_v1 {
163 __le16 Pattern;
164 __le16 Reserved1;
165 __le16 Reserved2;
166 __le32 Repetitions;
167} __packed;
168
169/* See MS-SMB2 2.2.43 */
170struct smb2_rdma_transform {
171 __le16 RdmaDescriptorOffset;
172 __le16 RdmaDescriptorLength;
173 __le32 Channel; /* for values see channel description in smb2 read above */
174 __le16 TransformCount;
175 __le16 Reserved1;
176 __le32 Reserved2;
177} __packed;
178
179/* TransformType */
180#define SMB2_RDMA_TRANSFORM_TYPE_ENCRYPTION 0x0001
181#define SMB2_RDMA_TRANSFORM_TYPE_SIGNING 0x0002
182
183struct smb2_rdma_crypto_transform {
184 __le16 TransformType;
185 __le16 SignatureLength;
186 __le16 NonceLength;
187 __u16 Reserved;
188 __u8 Signature[]; /* variable length */
189 /* u8 Nonce[] */
190 /* followed by padding */
191} __packed;
192
193/*
194 * SMB2 flag definitions
195 */
196#define SMB2_FLAGS_SERVER_TO_REDIR cpu_to_le32(0x00000001)
197#define SMB2_FLAGS_ASYNC_COMMAND cpu_to_le32(0x00000002)
198#define SMB2_FLAGS_RELATED_OPERATIONS cpu_to_le32(0x00000004)
199#define SMB2_FLAGS_SIGNED cpu_to_le32(0x00000008)
200#define SMB2_FLAGS_PRIORITY_MASK cpu_to_le32(0x00000070) /* SMB3.1.1 */
201#define SMB2_FLAGS_DFS_OPERATIONS cpu_to_le32(0x10000000)
202#define SMB2_FLAGS_REPLAY_OPERATION cpu_to_le32(0x20000000) /* SMB3 & up */
203
204/*
205 * Definitions for SMB2 Protocol Data Units (network frames)
206 *
207 * See MS-SMB2.PDF specification for protocol details.
208 * The Naming convention is the lower case version of the SMB2
209 * command code name for the struct. Note that structures must be packed.
210 *
211 */
212
213#define COMPOUND_FID 0xFFFFFFFFFFFFFFFFULL
214
215#define SMB2_ERROR_STRUCTURE_SIZE2 cpu_to_le16(9)
216
217struct smb2_err_rsp {
218 struct smb2_sync_hdr sync_hdr;
219 __le16 StructureSize;
220 __le16 Reserved; /* MBZ */
221 __le32 ByteCount; /* even if zero, at least one byte follows */
222 __u8 ErrorData[1]; /* variable length */
223} __packed;
224
225#define SYMLINK_ERROR_TAG 0x4c4d5953
226
227struct smb2_symlink_err_rsp {
228 __le32 SymLinkLength;
229 __le32 SymLinkErrorTag;
230 __le32 ReparseTag;
231 __le16 ReparseDataLength;
232 __le16 UnparsedPathLength;
233 __le16 SubstituteNameOffset;
234 __le16 SubstituteNameLength;
235 __le16 PrintNameOffset;
236 __le16 PrintNameLength;
237 __le32 Flags;
238 __u8 PathBuffer[];
239} __packed;
240
241/* SMB 3.1.1 and later dialects. See MS-SMB2 section 2.2.2.1 */
242struct smb2_error_context_rsp {
243 __le32 ErrorDataLength;
244 __le32 ErrorId;
245 __u8 ErrorContextData; /* ErrorDataLength long array */
246} __packed;
247
248/* ErrorId values */
249#define SMB2_ERROR_ID_DEFAULT 0x00000000
250#define SMB2_ERROR_ID_SHARE_REDIRECT cpu_to_le32(0x72645253) /* "rdRS" */
251
252/* Defines for Type field below (see MS-SMB2 2.2.2.2.2.1) */
253#define MOVE_DST_IPADDR_V4 cpu_to_le32(0x00000001)
254#define MOVE_DST_IPADDR_V6 cpu_to_le32(0x00000002)
255
256struct move_dst_ipaddr {
257 __le32 Type;
258 __u32 Reserved;
259 __u8 address[16]; /* IPv4 followed by 12 bytes rsvd or IPv6 address */
260} __packed;
261
262struct share_redirect_error_context_rsp {
263 __le32 StructureSize;
264 __le32 NotificationType;
265 __le32 ResourceNameOffset;
266 __le32 ResourceNameLength;
267 __le16 Reserved;
268 __le16 TargetType;
269 __le32 IPAddrCount;
270 struct move_dst_ipaddr IpAddrMoveList[];
271 /* __u8 ResourceName[] */ /* Name of share as counted Unicode string */
272} __packed;
273
274#define SMB2_CLIENT_GUID_SIZE 16
275
276struct smb2_negotiate_req {
277 struct smb2_sync_hdr sync_hdr;
278 __le16 StructureSize; /* Must be 36 */
279 __le16 DialectCount;
280 __le16 SecurityMode;
281 __le16 Reserved; /* MBZ */
282 __le32 Capabilities;
283 __u8 ClientGUID[SMB2_CLIENT_GUID_SIZE];
284 /* In SMB3.02 and earlier next three were MBZ le64 ClientStartTime */
285 __le32 NegotiateContextOffset; /* SMB3.1.1 only. MBZ earlier */
286 __le16 NegotiateContextCount; /* SMB3.1.1 only. MBZ earlier */
287 __le16 Reserved2;
288 __le16 Dialects[4]; /* BB expand this if autonegotiate > 4 dialects */
289} __packed;
290
291/* Dialects */
292#define SMB10_PROT_ID 0x0000 /* local only, not sent on wire w/CIFS negprot */
293#define SMB20_PROT_ID 0x0202
294#define SMB21_PROT_ID 0x0210
295#define SMB30_PROT_ID 0x0300
296#define SMB302_PROT_ID 0x0302
297#define SMB311_PROT_ID 0x0311
298#define BAD_PROT_ID 0xFFFF
299
300/* SecurityMode flags */
301#define SMB2_NEGOTIATE_SIGNING_ENABLED 0x0001
302#define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
303#define SMB2_SEC_MODE_FLAGS_ALL 0x0003
304
305/* Capabilities flags */
306#define SMB2_GLOBAL_CAP_DFS 0x00000001
307#define SMB2_GLOBAL_CAP_LEASING 0x00000002 /* Resp only New to SMB2.1 */
308#define SMB2_GLOBAL_CAP_LARGE_MTU 0X00000004 /* Resp only New to SMB2.1 */
309#define SMB2_GLOBAL_CAP_MULTI_CHANNEL 0x00000008 /* New to SMB3 */
310#define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
311#define SMB2_GLOBAL_CAP_DIRECTORY_LEASING 0x00000020 /* New to SMB3 */
312#define SMB2_GLOBAL_CAP_ENCRYPTION 0x00000040 /* New to SMB3 */
313/* Internal types */
314#define SMB2_NT_FIND 0x00100000
315#define SMB2_LARGE_FILES 0x00200000
316
317
318/* Negotiate Contexts - ContextTypes. See MS-SMB2 section 2.2.3.1 for details */
319#define SMB2_PREAUTH_INTEGRITY_CAPABILITIES cpu_to_le16(1)
320#define SMB2_ENCRYPTION_CAPABILITIES cpu_to_le16(2)
321#define SMB2_COMPRESSION_CAPABILITIES cpu_to_le16(3)
322#define SMB2_NETNAME_NEGOTIATE_CONTEXT_ID cpu_to_le16(5)
323#define SMB2_TRANSPORT_CAPABILITIES cpu_to_le16(6)
324#define SMB2_RDMA_TRANSFORM_CAPABILITIES cpu_to_le16(7)
325#define SMB2_SIGNING_CAPABILITIES cpu_to_le16(8)
326#define SMB2_POSIX_EXTENSIONS_AVAILABLE cpu_to_le16(0x100)
327
328struct smb2_neg_context {
329 __le16 ContextType;
330 __le16 DataLength;
331 __le32 Reserved;
332 /* Followed by array of data. NOTE: some servers require padding to 8 byte boundary */
333} __packed;
334
335#define SMB311_LINUX_CLIENT_SALT_SIZE 32
336/* Hash Algorithm Types */
337#define SMB2_PREAUTH_INTEGRITY_SHA512 cpu_to_le16(0x0001)
338#define SMB2_PREAUTH_HASH_SIZE 64
339
340/*
341 * SaltLength that the server send can be zero, so the only three required
342 * fields (all __le16) end up six bytes total, so the minimum context data len
343 * in the response is six bytes which accounts for
344 *
345 * HashAlgorithmCount, SaltLength, and 1 HashAlgorithm.
346 */
347#define MIN_PREAUTH_CTXT_DATA_LEN 6
348
349struct smb2_preauth_neg_context {
350 __le16 ContextType; /* 1 */
351 __le16 DataLength;
352 __le32 Reserved;
353 __le16 HashAlgorithmCount; /* 1 */
354 __le16 SaltLength;
355 __le16 HashAlgorithms; /* HashAlgorithms[0] since only one defined */
356 __u8 Salt[SMB311_LINUX_CLIENT_SALT_SIZE];
357} __packed;
358
359/* Encryption Algorithms Ciphers */
360#define SMB2_ENCRYPTION_AES128_CCM cpu_to_le16(0x0001)
361#define SMB2_ENCRYPTION_AES128_GCM cpu_to_le16(0x0002)
362/* we currently do not request AES256_CCM since presumably GCM faster */
363#define SMB2_ENCRYPTION_AES256_CCM cpu_to_le16(0x0003)
364#define SMB2_ENCRYPTION_AES256_GCM cpu_to_le16(0x0004)
365
366/* Min encrypt context data is one cipher so 2 bytes + 2 byte count field */
367#define MIN_ENCRYPT_CTXT_DATA_LEN 4
368struct smb2_encryption_neg_context {
369 __le16 ContextType; /* 2 */
370 __le16 DataLength;
371 __le32 Reserved;
372 /* CipherCount usally 2, but can be 3 when AES256-GCM enabled */
373 __le16 CipherCount; /* AES128-GCM and AES128-CCM by default */
374 __le16 Ciphers[3];
375} __packed;
376
377/* See MS-SMB2 2.2.3.1.3 */
378#define SMB3_COMPRESS_NONE cpu_to_le16(0x0000)
379#define SMB3_COMPRESS_LZNT1 cpu_to_le16(0x0001)
380#define SMB3_COMPRESS_LZ77 cpu_to_le16(0x0002)
381#define SMB3_COMPRESS_LZ77_HUFF cpu_to_le16(0x0003)
382/* Pattern scanning algorithm See MS-SMB2 3.1.4.4.1 */
383#define SMB3_COMPRESS_PATTERN cpu_to_le16(0x0004) /* Pattern_V1 */
384
385/* Compression Flags */
386#define SMB2_COMPRESSION_CAPABILITIES_FLAG_NONE cpu_to_le32(0x00000000)
387#define SMB2_COMPRESSION_CAPABILITIES_FLAG_CHAINED cpu_to_le32(0x00000001)
388
389struct smb2_compression_capabilities_context {
390 __le16 ContextType; /* 3 */
391 __le16 DataLength;
392 __u32 Reserved;
393 __le16 CompressionAlgorithmCount;
394 __u16 Padding;
395 __u32 Flags;
396 __le16 CompressionAlgorithms[3];
397 __u16 Pad; /* Some servers require pad to DataLen multiple of 8 */
398 /* Check if pad needed */
399} __packed;
400
401/*
402 * For smb2_netname_negotiate_context_id See MS-SMB2 2.2.3.1.4.
403 * Its struct simply contains NetName, an array of Unicode characters
404 */
405struct smb2_netname_neg_context {
406 __le16 ContextType; /* 5 */
407 __le16 DataLength;
408 __le32 Reserved;
409 __le16 NetName[]; /* hostname of target converted to UCS-2 */
410} __packed;
411
412/*
413 * For smb2_transport_capabilities context see MS-SMB2 2.2.3.1.5
414 * and 2.2.4.1.5
415 */
416
417/* Flags */
418#define SMB2_ACCEPT_TRANSFORM_LEVEL_SECURITY 0x00000001
419
420struct smb2_transport_capabilities_context {
421 __le16 ContextType; /* 6 */
422 __le16 DataLength;
423 __u32 Reserved;
424 __le32 Flags;
425 __u32 Pad;
426} __packed;
427
428/*
429 * For rdma transform capabilities context see MS-SMB2 2.2.3.1.6
430 * and 2.2.4.1.6
431 */
432
433/* RDMA Transform IDs */
434#define SMB2_RDMA_TRANSFORM_NONE 0x0000
435#define SMB2_RDMA_TRANSFORM_ENCRYPTION 0x0001
436#define SMB2_RDMA_TRANSFORM_SIGNING 0x0002
437
438struct smb2_rdma_transform_capabilities_context {
439 __le16 ContextType; /* 7 */
440 __le16 DataLength;
441 __u32 Reserved;
442 __le16 TransformCount;
443 __u16 Reserved1;
444 __u32 Reserved2;
445 __le16 RDMATransformIds[];
446} __packed;
447
448/*
449 * For signing capabilities context see MS-SMB2 2.2.3.1.7
450 * and 2.2.4.1.7
451 */
452
453/* Signing algorithms */
454#define SIGNING_ALG_HMAC_SHA256 0
455#define SIGNING_ALG_AES_CMAC 1
456#define SIGNING_ALG_AES_GMAC 2
457
458struct smb2_signing_capabilities {
459 __le16 ContextType; /* 8 */
460 __le16 DataLength;
461 __u32 Reserved;
462 __le16 SigningAlgorithmCount;
463 __le16 SigningAlgorithms[];
464 /* Followed by padding to 8 byte boundary (required by some servers) */
465} __packed;
466
467#define POSIX_CTXT_DATA_LEN 16
468struct smb2_posix_neg_context {
469 __le16 ContextType; /* 0x100 */
470 __le16 DataLength;
471 __le32 Reserved;
472 __u8 Name[16]; /* POSIX ctxt GUID 93AD25509CB411E7B42383DE968BCD7C */
473} __packed;
474
475struct smb2_negotiate_rsp {
476 struct smb2_sync_hdr sync_hdr;
477 __le16 StructureSize; /* Must be 65 */
478 __le16 SecurityMode;
479 __le16 DialectRevision;
480 __le16 NegotiateContextCount; /* Prior to SMB3.1.1 was Reserved & MBZ */
481 __u8 ServerGUID[16];
482 __le32 Capabilities;
483 __le32 MaxTransactSize;
484 __le32 MaxReadSize;
485 __le32 MaxWriteSize;
486 __le64 SystemTime; /* MBZ */
487 __le64 ServerStartTime;
488 __le16 SecurityBufferOffset;
489 __le16 SecurityBufferLength;
490 __le32 NegotiateContextOffset; /* Pre:SMB3.1.1 was reserved/ignored */
491 __u8 Buffer[1]; /* variable length GSS security buffer */
492} __packed;
493
494/* Flags */
495#define SMB2_SESSION_REQ_FLAG_BINDING 0x01
496#define SMB2_SESSION_REQ_FLAG_ENCRYPT_DATA 0x04
497
498struct smb2_sess_setup_req {
499 struct smb2_sync_hdr sync_hdr;
500 __le16 StructureSize; /* Must be 25 */
501 __u8 Flags;
502 __u8 SecurityMode;
503 __le32 Capabilities;
504 __le32 Channel;
505 __le16 SecurityBufferOffset;
506 __le16 SecurityBufferLength;
507 __u64 PreviousSessionId;
508 __u8 Buffer[1]; /* variable length GSS security buffer */
509} __packed;
510
511/* Currently defined SessionFlags */
512#define SMB2_SESSION_FLAG_IS_GUEST 0x0001
513#define SMB2_SESSION_FLAG_IS_NULL 0x0002
514#define SMB2_SESSION_FLAG_ENCRYPT_DATA 0x0004
515struct smb2_sess_setup_rsp {
516 struct smb2_sync_hdr sync_hdr;
517 __le16 StructureSize; /* Must be 9 */
518 __le16 SessionFlags;
519 __le16 SecurityBufferOffset;
520 __le16 SecurityBufferLength;
521 __u8 Buffer[1]; /* variable length GSS security buffer */
522} __packed;
523
524struct smb2_logoff_req {
525 struct smb2_sync_hdr sync_hdr;
526 __le16 StructureSize; /* Must be 4 */
527 __le16 Reserved;
528} __packed;
529
530struct smb2_logoff_rsp {
531 struct smb2_sync_hdr sync_hdr;
532 __le16 StructureSize; /* Must be 4 */
533 __le16 Reserved;
534} __packed;
535
536/* Flags/Reserved for SMB3.1.1 */
537#define SMB2_TREE_CONNECT_FLAG_CLUSTER_RECONNECT cpu_to_le16(0x0001)
538#define SMB2_TREE_CONNECT_FLAG_REDIRECT_TO_OWNER cpu_to_le16(0x0002)
539#define SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT cpu_to_le16(0x0004)
540
541struct smb2_tree_connect_req {
542 struct smb2_sync_hdr sync_hdr;
543 __le16 StructureSize; /* Must be 9 */
544 __le16 Flags; /* Reserved MBZ for dialects prior to SMB3.1.1 */
545 __le16 PathOffset;
546 __le16 PathLength;
547 __u8 Buffer[1]; /* variable length */
548} __packed;
549
550/* See MS-SMB2 section 2.2.9.2 */
551/* Context Types */
552#define SMB2_RESERVED_TREE_CONNECT_CONTEXT_ID 0x0000
553#define SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID cpu_to_le16(0x0001)
554
555struct tree_connect_contexts {
556 __le16 ContextType;
557 __le16 DataLength;
558 __le32 Reserved;
559 __u8 Data[];
560} __packed;
561
562/* Remoted identity tree connect context structures - see MS-SMB2 2.2.9.2.1 */
563struct smb3_blob_data {
564 __le16 BlobSize;
565 __u8 BlobData[];
566} __packed;
567
568/* Valid values for Attr */
569#define SE_GROUP_MANDATORY 0x00000001
570#define SE_GROUP_ENABLED_BY_DEFAULT 0x00000002
571#define SE_GROUP_ENABLED 0x00000004
572#define SE_GROUP_OWNER 0x00000008
573#define SE_GROUP_USE_FOR_DENY_ONLY 0x00000010
574#define SE_GROUP_INTEGRITY 0x00000020
575#define SE_GROUP_INTEGRITY_ENABLED 0x00000040
576#define SE_GROUP_RESOURCE 0x20000000
577#define SE_GROUP_LOGON_ID 0xC0000000
578
579/* struct sid_attr_data is SidData array in BlobData format then le32 Attr */
580
581struct sid_array_data {
582 __le16 SidAttrCount;
583 /* SidAttrList - array of sid_attr_data structs */
584} __packed;
585
586struct luid_attr_data {
587
588} __packed;
589
590/*
591 * struct privilege_data is the same as BLOB_DATA - see MS-SMB2 2.2.9.2.1.5
592 * but with size of LUID_ATTR_DATA struct and BlobData set to LUID_ATTR DATA
593 */
594
595struct privilege_array_data {
596 __le16 PrivilegeCount;
597 /* array of privilege_data structs */
598} __packed;
599
600struct remoted_identity_tcon_context {
601 __le16 TicketType; /* must be 0x0001 */
602 __le16 TicketSize; /* total size of this struct */
603 __le16 User; /* offset to SID_ATTR_DATA struct with user info */
604 __le16 UserName; /* offset to null terminated Unicode username string */
605 __le16 Domain; /* offset to null terminated Unicode domain name */
606 __le16 Groups; /* offset to SID_ARRAY_DATA struct with group info */
607 __le16 RestrictedGroups; /* similar to above */
608 __le16 Privileges; /* offset to PRIVILEGE_ARRAY_DATA struct */
609 __le16 PrimaryGroup; /* offset to SID_ARRAY_DATA struct */
610 __le16 Owner; /* offset to BLOB_DATA struct */
611 __le16 DefaultDacl; /* offset to BLOB_DATA struct */
612 __le16 DeviceGroups; /* offset to SID_ARRAY_DATA struct */
613 __le16 UserClaims; /* offset to BLOB_DATA struct */
614 __le16 DeviceClaims; /* offset to BLOB_DATA struct */
615 __u8 TicketInfo[]; /* variable length buf - remoted identity data */
616} __packed;
617
618struct smb2_tree_connect_req_extension {
619 __le32 TreeConnectContextOffset;
620 __le16 TreeConnectContextCount;
621 __u8 Reserved[10];
622 __u8 PathName[]; /* variable sized array */
623 /* followed by array of TreeConnectContexts */
624} __packed;
625
626struct smb2_tree_connect_rsp {
627 struct smb2_sync_hdr sync_hdr;
628 __le16 StructureSize; /* Must be 16 */
629 __u8 ShareType; /* see below */
630 __u8 Reserved;
631 __le32 ShareFlags; /* see below */
632 __le32 Capabilities; /* see below */
633 __le32 MaximalAccess;
634} __packed;
635
636/* Possible ShareType values */
637#define SMB2_SHARE_TYPE_DISK 0x01
638#define SMB2_SHARE_TYPE_PIPE 0x02
639#define SMB2_SHARE_TYPE_PRINT 0x03
640
641/*
642 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
643 * must be set (any of the remaining, SHI1005, flags may be set individually
644 * or in combination.
645 */
646#define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
647#define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
648#define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
649#define SMB2_SHAREFLAG_NO_CACHING 0x00000030
650#define SHI1005_FLAGS_DFS 0x00000001
651#define SHI1005_FLAGS_DFS_ROOT 0x00000002
652#define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS 0x00000100
653#define SHI1005_FLAGS_FORCE_SHARED_DELETE 0x00000200
654#define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING 0x00000400
655#define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
656#define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK 0x00001000
657#define SHI1005_FLAGS_ENABLE_HASH_V1 0x00002000
658#define SHI1005_FLAGS_ENABLE_HASH_V2 0x00004000
659#define SHI1005_FLAGS_ENCRYPT_DATA 0x00008000
660#define SMB2_SHAREFLAG_IDENTITY_REMOTING 0x00040000 /* 3.1.1 */
661#define SMB2_SHAREFLAG_COMPRESS_DATA 0x00100000 /* 3.1.1 */
662#define SHI1005_FLAGS_ALL 0x0014FF33
663
664/* Possible share capabilities */
665#define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
666#define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
667#define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
668#define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
669#define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
670#define SMB2_SHARE_CAP_REDIRECT_TO_OWNER cpu_to_le32(0x00000100) /* 3.1.1 */
671
672struct smb2_tree_disconnect_req {
673 struct smb2_sync_hdr sync_hdr;
674 __le16 StructureSize; /* Must be 4 */
675 __le16 Reserved;
676} __packed;
677
678struct smb2_tree_disconnect_rsp {
679 struct smb2_sync_hdr sync_hdr;
680 __le16 StructureSize; /* Must be 4 */
681 __le16 Reserved;
682} __packed;
683
684/* File Attrubutes */
685#define FILE_ATTRIBUTE_READONLY 0x00000001
686#define FILE_ATTRIBUTE_HIDDEN 0x00000002
687#define FILE_ATTRIBUTE_SYSTEM 0x00000004
688#define FILE_ATTRIBUTE_DIRECTORY 0x00000010
689#define FILE_ATTRIBUTE_ARCHIVE 0x00000020
690#define FILE_ATTRIBUTE_NORMAL 0x00000080
691#define FILE_ATTRIBUTE_TEMPORARY 0x00000100
692#define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
693#define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
694#define FILE_ATTRIBUTE_COMPRESSED 0x00000800
695#define FILE_ATTRIBUTE_OFFLINE 0x00001000
696#define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
697#define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
698#define FILE_ATTRIBUTE_INTEGRITY_STREAM 0x00008000
699#define FILE_ATTRIBUTE_NO_SCRUB_DATA 0x00020000
700
701/* Oplock levels */
702#define SMB2_OPLOCK_LEVEL_NONE 0x00
703#define SMB2_OPLOCK_LEVEL_II 0x01
704#define SMB2_OPLOCK_LEVEL_EXCLUSIVE 0x08
705#define SMB2_OPLOCK_LEVEL_BATCH 0x09
706#define SMB2_OPLOCK_LEVEL_LEASE 0xFF
707/* Non-spec internal type */
708#define SMB2_OPLOCK_LEVEL_NOCHANGE 0x99
709
710/* Desired Access Flags */
711#define FILE_READ_DATA_LE cpu_to_le32(0x00000001)
712#define FILE_WRITE_DATA_LE cpu_to_le32(0x00000002)
713#define FILE_APPEND_DATA_LE cpu_to_le32(0x00000004)
714#define FILE_READ_EA_LE cpu_to_le32(0x00000008)
715#define FILE_WRITE_EA_LE cpu_to_le32(0x00000010)
716#define FILE_EXECUTE_LE cpu_to_le32(0x00000020)
717#define FILE_READ_ATTRIBUTES_LE cpu_to_le32(0x00000080)
718#define FILE_WRITE_ATTRIBUTES_LE cpu_to_le32(0x00000100)
719#define FILE_DELETE_LE cpu_to_le32(0x00010000)
720#define FILE_READ_CONTROL_LE cpu_to_le32(0x00020000)
721#define FILE_WRITE_DAC_LE cpu_to_le32(0x00040000)
722#define FILE_WRITE_OWNER_LE cpu_to_le32(0x00080000)
723#define FILE_SYNCHRONIZE_LE cpu_to_le32(0x00100000)
724#define FILE_ACCESS_SYSTEM_SECURITY_LE cpu_to_le32(0x01000000)
725#define FILE_MAXIMAL_ACCESS_LE cpu_to_le32(0x02000000)
726#define FILE_GENERIC_ALL_LE cpu_to_le32(0x10000000)
727#define FILE_GENERIC_EXECUTE_LE cpu_to_le32(0x20000000)
728#define FILE_GENERIC_WRITE_LE cpu_to_le32(0x40000000)
729#define FILE_GENERIC_READ_LE cpu_to_le32(0x80000000)
730
731/* ShareAccess Flags */
732#define FILE_SHARE_READ_LE cpu_to_le32(0x00000001)
733#define FILE_SHARE_WRITE_LE cpu_to_le32(0x00000002)
734#define FILE_SHARE_DELETE_LE cpu_to_le32(0x00000004)
735#define FILE_SHARE_ALL_LE cpu_to_le32(0x00000007)
736
737/* CreateDisposition Flags */
738#define FILE_SUPERSEDE_LE cpu_to_le32(0x00000000)
739#define FILE_OPEN_LE cpu_to_le32(0x00000001)
740#define FILE_CREATE_LE cpu_to_le32(0x00000002)
741#define FILE_OPEN_IF_LE cpu_to_le32(0x00000003)
742#define FILE_OVERWRITE_LE cpu_to_le32(0x00000004)
743#define FILE_OVERWRITE_IF_LE cpu_to_le32(0x00000005)
744
745/* CreateOptions Flags */
746#define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
747/* same as #define CREATE_NOT_FILE_LE cpu_to_le32(0x00000001) */
748#define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
749#define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
750#define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
751#define FILE_SYNCHRONOUS_IO_ALERT_LE cpu_to_le32(0x00000010)
752#define FILE_SYNCHRONOUS_IO_NON_ALERT_LE cpu_to_le32(0x00000020)
753#define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
754#define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
755#define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
756#define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
757#define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000)
758#define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
759#define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
760#define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
761#define FILE_RESERVE_OPFILTER_LE cpu_to_le32(0x00100000)
762#define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
763#define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
764#define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
765
766#define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
767 | FILE_READ_ATTRIBUTES_LE)
768#define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
769 | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
770#define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
771
772/* Impersonation Levels. See MS-WPO section 9.7 and MSDN-IMPERS */
773#define IL_ANONYMOUS cpu_to_le32(0x00000000)
774#define IL_IDENTIFICATION cpu_to_le32(0x00000001)
775#define IL_IMPERSONATION cpu_to_le32(0x00000002)
776#define IL_DELEGATE cpu_to_le32(0x00000003)
777
778/* Create Context Values */
779#define SMB2_CREATE_EA_BUFFER "ExtA" /* extended attributes */
780#define SMB2_CREATE_SD_BUFFER "SecD" /* security descriptor */
781#define SMB2_CREATE_DURABLE_HANDLE_REQUEST "DHnQ"
782#define SMB2_CREATE_DURABLE_HANDLE_RECONNECT "DHnC"
783#define SMB2_CREATE_ALLOCATION_SIZE "AISi"
784#define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
785#define SMB2_CREATE_TIMEWARP_REQUEST "TWrp"
786#define SMB2_CREATE_QUERY_ON_DISK_ID "QFid"
787#define SMB2_CREATE_REQUEST_LEASE "RqLs"
788#define SMB2_CREATE_DURABLE_HANDLE_REQUEST_V2 "DH2Q"
789#define SMB2_CREATE_DURABLE_HANDLE_RECONNECT_V2 "DH2C"
790#define SMB2_CREATE_APP_INSTANCE_ID 0x45BCA66AEFA7F74A9008FA462E144D74
791#define SMB2_CREATE_APP_INSTANCE_VERSION 0xB982D0B73B56074FA07B524A8116A010
792#define SVHDX_OPEN_DEVICE_CONTEX 0x9CCBCF9E04C1E643980E158DA1F6EC83
793#define SMB2_CREATE_TAG_POSIX 0x93AD25509CB411E7B42383DE968BCD7C
794
795/* Flag (SMB3 open response) values */
796#define SMB2_CREATE_FLAG_REPARSEPOINT 0x01
797
798/*
799 * Maximum number of iovs we need for an open/create request.
800 * [0] : struct smb2_create_req
801 * [1] : path
802 * [2] : lease context
803 * [3] : durable context
804 * [4] : posix context
805 * [5] : time warp context
806 * [6] : query id context
807 * [7] : compound padding
808 */
809#define SMB2_CREATE_IOV_SIZE 8
810
811struct smb2_create_req {
812 struct smb2_sync_hdr sync_hdr;
813 __le16 StructureSize; /* Must be 57 */
814 __u8 SecurityFlags;
815 __u8 RequestedOplockLevel;
816 __le32 ImpersonationLevel;
817 __le64 SmbCreateFlags;
818 __le64 Reserved;
819 __le32 DesiredAccess;
820 __le32 FileAttributes;
821 __le32 ShareAccess;
822 __le32 CreateDisposition;
823 __le32 CreateOptions;
824 __le16 NameOffset;
825 __le16 NameLength;
826 __le32 CreateContextsOffset;
827 __le32 CreateContextsLength;
828 __u8 Buffer[];
829} __packed;
830
831/*
832 * Maximum size of a SMB2_CREATE response is 64 (smb2 header) +
833 * 88 (fixed part of create response) + 520 (path) + 208 (contexts) +
834 * 2 bytes of padding.
835 */
836#define MAX_SMB2_CREATE_RESPONSE_SIZE 880
837
838struct smb2_create_rsp {
839 struct smb2_sync_hdr sync_hdr;
840 __le16 StructureSize; /* Must be 89 */
841 __u8 OplockLevel;
842 __u8 Flag; /* 0x01 if reparse point */
843 __le32 CreateAction;
844 __le64 CreationTime;
845 __le64 LastAccessTime;
846 __le64 LastWriteTime;
847 __le64 ChangeTime;
848 __le64 AllocationSize;
849 __le64 EndofFile;
850 __le32 FileAttributes;
851 __le32 Reserved2;
852 __u64 PersistentFileId; /* opaque endianness */
853 __u64 VolatileFileId; /* opaque endianness */
854 __le32 CreateContextsOffset;
855 __le32 CreateContextsLength;
856 __u8 Buffer[1];
857} __packed;
858
859struct create_context {
860 __le32 Next;
861 __le16 NameOffset;
862 __le16 NameLength;
863 __le16 Reserved;
864 __le16 DataOffset;
865 __le32 DataLength;
866 __u8 Buffer[];
867} __packed;
868
869#define SMB2_LEASE_READ_CACHING_HE 0x01
870#define SMB2_LEASE_HANDLE_CACHING_HE 0x02
871#define SMB2_LEASE_WRITE_CACHING_HE 0x04
872
873#define SMB2_LEASE_NONE cpu_to_le32(0x00)
874#define SMB2_LEASE_READ_CACHING cpu_to_le32(0x01)
875#define SMB2_LEASE_HANDLE_CACHING cpu_to_le32(0x02)
876#define SMB2_LEASE_WRITE_CACHING cpu_to_le32(0x04)
877
878#define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS cpu_to_le32(0x00000002)
879#define SMB2_LEASE_FLAG_PARENT_LEASE_KEY_SET cpu_to_le32(0x00000004)
880
881#define SMB2_LEASE_KEY_SIZE 16
882
883struct lease_context {
884 u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
885 __le32 LeaseState;
886 __le32 LeaseFlags;
887 __le64 LeaseDuration;
888} __packed;
889
890struct lease_context_v2 {
891 u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
892 __le32 LeaseState;
893 __le32 LeaseFlags;
894 __le64 LeaseDuration;
895 __le64 ParentLeaseKeyLow;
896 __le64 ParentLeaseKeyHigh;
897 __le16 Epoch;
898 __le16 Reserved;
899} __packed;
900
901struct create_lease {
902 struct create_context ccontext;
903 __u8 Name[8];
904 struct lease_context lcontext;
905} __packed;
906
907struct create_lease_v2 {
908 struct create_context ccontext;
909 __u8 Name[8];
910 struct lease_context_v2 lcontext;
911 __u8 Pad[4];
912} __packed;
913
914struct create_durable {
915 struct create_context ccontext;
916 __u8 Name[8];
917 union {
918 __u8 Reserved[16];
919 struct {
920 __u64 PersistentFileId;
921 __u64 VolatileFileId;
922 } Fid;
923 } Data;
924} __packed;
925
926struct create_posix {
927 struct create_context ccontext;
928 __u8 Name[16];
929 __le32 Mode;
930 __u32 Reserved;
931} __packed;
932
933/* See MS-SMB2 2.2.13.2.11 */
934/* Flags */
935#define SMB2_DHANDLE_FLAG_PERSISTENT 0x00000002
936struct durable_context_v2 {
937 __le32 Timeout;
938 __le32 Flags;
939 __u64 Reserved;
940 __u8 CreateGuid[16];
941} __packed;
942
943struct create_durable_v2 {
944 struct create_context ccontext;
945 __u8 Name[8];
946 struct durable_context_v2 dcontext;
947} __packed;
948
949/* See MS-SMB2 2.2.13.2.12 */
950struct durable_reconnect_context_v2 {
951 struct {
952 __u64 PersistentFileId;
953 __u64 VolatileFileId;
954 } Fid;
955 __u8 CreateGuid[16];
956 __le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
957} __packed;
958
959/* See MS-SMB2 2.2.14.2.9 */
960struct create_on_disk_id {
961 struct create_context ccontext;
962 __u8 Name[8];
963 __le64 DiskFileId;
964 __le64 VolumeId;
965 __u32 Reserved[4];
966} __packed;
967
968/* See MS-SMB2 2.2.14.2.12 */
969struct durable_reconnect_context_v2_rsp {
970 __le32 Timeout;
971 __le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
972} __packed;
973
974struct create_durable_handle_reconnect_v2 {
975 struct create_context ccontext;
976 __u8 Name[8];
977 struct durable_reconnect_context_v2 dcontext;
978 __u8 Pad[4];
979} __packed;
980
981/* See MS-SMB2 2.2.13.2.5 */
982struct crt_twarp_ctxt {
983 struct create_context ccontext;
984 __u8 Name[8];
985 __le64 Timestamp;
986
987} __packed;
988
989/* See MS-SMB2 2.2.13.2.9 */
990struct crt_query_id_ctxt {
991 struct create_context ccontext;
992 __u8 Name[8];
993} __packed;
994
995struct crt_sd_ctxt {
996 struct create_context ccontext;
997 __u8 Name[8];
998 struct smb3_sd sd;
999} __packed;
1000
1001
1002#define COPY_CHUNK_RES_KEY_SIZE 24
1003struct resume_key_req {
1004 char ResumeKey[COPY_CHUNK_RES_KEY_SIZE];
1005 __le32 ContextLength; /* MBZ */
1006 char Context[]; /* ignored, Windows sets to 4 bytes of zero */
1007} __packed;
1008
1009/* this goes in the ioctl buffer when doing a copychunk request */
1010struct copychunk_ioctl {
1011 char SourceKey[COPY_CHUNK_RES_KEY_SIZE];
1012 __le32 ChunkCount; /* we are only sending 1 */
1013 __le32 Reserved;
1014 /* array will only be one chunk long for us */
1015 __le64 SourceOffset;
1016 __le64 TargetOffset;
1017 __le32 Length; /* how many bytes to copy */
1018 __u32 Reserved2;
1019} __packed;
1020
1021/* this goes in the ioctl buffer when doing FSCTL_SET_ZERO_DATA */
1022struct file_zero_data_information {
1023 __le64 FileOffset;
1024 __le64 BeyondFinalZero;
1025} __packed;
1026
1027struct copychunk_ioctl_rsp {
1028 __le32 ChunksWritten;
1029 __le32 ChunkBytesWritten;
1030 __le32 TotalBytesWritten;
1031} __packed;
1032
1033/* See MS-FSCC 2.3.29 and 2.3.30 */
1034struct get_retrieval_pointer_count_req {
1035 __le64 StartingVcn; /* virtual cluster number (signed) */
1036} __packed;
1037
1038struct get_retrieval_pointer_count_rsp {
1039 __le32 ExtentCount;
1040} __packed;
1041
1042/*
1043 * See MS-FSCC 2.3.33 and 2.3.34
1044 * request is the same as get_retrieval_point_count_req struct above
1045 */
1046struct smb3_extents {
1047 __le64 NextVcn;
1048 __le64 Lcn; /* logical cluster number */
1049} __packed;
1050
1051struct get_retrieval_pointers_refcount_rsp {
1052 __le32 ExtentCount;
1053 __u32 Reserved;
1054 __le64 StartingVcn;
1055 struct smb3_extents extents[];
1056} __packed;
1057
1058struct fsctl_set_integrity_information_req {
1059 __le16 ChecksumAlgorithm;
1060 __le16 Reserved;
1061 __le32 Flags;
1062} __packed;
1063
1064struct fsctl_get_integrity_information_rsp {
1065 __le16 ChecksumAlgorithm;
1066 __le16 Reserved;
1067 __le32 Flags;
1068 __le32 ChecksumChunkSizeInBytes;
1069 __le32 ClusterSizeInBytes;
1070} __packed;
1071
1072struct file_allocated_range_buffer {
1073 __le64 file_offset;
1074 __le64 length;
1075} __packed;
1076
1077/* Integrity ChecksumAlgorithm choices for above */
1078#define CHECKSUM_TYPE_NONE 0x0000
1079#define CHECKSUM_TYPE_CRC64 0x0002
1080#define CHECKSUM_TYPE_UNCHANGED 0xFFFF /* set only */
1081
1082/* Integrity flags for above */
1083#define FSCTL_INTEGRITY_FLAG_CHECKSUM_ENFORCEMENT_OFF 0x00000001
1084
1085/* Reparse structures - see MS-FSCC 2.1.2 */
1086
1087/* struct fsctl_reparse_info_req is empty, only response structs (see below) */
1088
1089struct reparse_data_buffer {
1090 __le32 ReparseTag;
1091 __le16 ReparseDataLength;
1092 __u16 Reserved;
1093 __u8 DataBuffer[]; /* Variable Length */
1094} __packed;
1095
1096struct reparse_guid_data_buffer {
1097 __le32 ReparseTag;
1098 __le16 ReparseDataLength;
1099 __u16 Reserved;
1100 __u8 ReparseGuid[16];
1101 __u8 DataBuffer[]; /* Variable Length */
1102} __packed;
1103
1104struct reparse_mount_point_data_buffer {
1105 __le32 ReparseTag;
1106 __le16 ReparseDataLength;
1107 __u16 Reserved;
1108 __le16 SubstituteNameOffset;
1109 __le16 SubstituteNameLength;
1110 __le16 PrintNameOffset;
1111 __le16 PrintNameLength;
1112 __u8 PathBuffer[]; /* Variable Length */
1113} __packed;
1114
1115#define SYMLINK_FLAG_RELATIVE 0x00000001
1116
1117struct reparse_symlink_data_buffer {
1118 __le32 ReparseTag;
1119 __le16 ReparseDataLength;
1120 __u16 Reserved;
1121 __le16 SubstituteNameOffset;
1122 __le16 SubstituteNameLength;
1123 __le16 PrintNameOffset;
1124 __le16 PrintNameLength;
1125 __le32 Flags;
1126 __u8 PathBuffer[]; /* Variable Length */
1127} __packed;
1128
1129/* See MS-FSCC 2.1.2.6 and cifspdu.h for struct reparse_posix_data */
1130
1131
1132/* See MS-DFSC 2.2.2 */
1133struct fsctl_get_dfs_referral_req {
1134 __le16 MaxReferralLevel;
1135 __u8 RequestFileName[];
1136} __packed;
1137
1138/* DFS response is struct get_dfs_refer_rsp */
1139
1140/* See MS-SMB2 2.2.31.3 */
1141struct network_resiliency_req {
1142 __le32 Timeout;
1143 __le32 Reserved;
1144} __packed;
1145/* There is no buffer for the response ie no struct network_resiliency_rsp */
1146
1147
1148struct validate_negotiate_info_req {
1149 __le32 Capabilities;
1150 __u8 Guid[SMB2_CLIENT_GUID_SIZE];
1151 __le16 SecurityMode;
1152 __le16 DialectCount;
1153 __le16 Dialects[4]; /* BB expand this if autonegotiate > 4 dialects */
1154} __packed;
1155
1156struct validate_negotiate_info_rsp {
1157 __le32 Capabilities;
1158 __u8 Guid[SMB2_CLIENT_GUID_SIZE];
1159 __le16 SecurityMode;
1160 __le16 Dialect; /* Dialect in use for the connection */
1161} __packed;
1162
1163#define RSS_CAPABLE cpu_to_le32(0x00000001)
1164#define RDMA_CAPABLE cpu_to_le32(0x00000002)
1165
1166#define INTERNETWORK cpu_to_le16(0x0002)
1167#define INTERNETWORKV6 cpu_to_le16(0x0017)
1168
1169struct network_interface_info_ioctl_rsp {
1170 __le32 Next; /* next interface. zero if this is last one */
1171 __le32 IfIndex;
1172 __le32 Capability; /* RSS or RDMA Capable */
1173 __le32 Reserved;
1174 __le64 LinkSpeed;
1175 __le16 Family;
1176 __u8 Buffer[126];
1177} __packed;
1178
1179struct iface_info_ipv4 {
1180 __be16 Port;
1181 __be32 IPv4Address;
1182 __be64 Reserved;
1183} __packed;
1184
1185struct iface_info_ipv6 {
1186 __be16 Port;
1187 __be32 FlowInfo;
1188 __u8 IPv6Address[16];
1189 __be32 ScopeId;
1190} __packed;
1191
1192#define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
1193
1194struct compress_ioctl {
1195 __le16 CompressionState; /* See cifspdu.h for possible flag values */
1196} __packed;
1197
1198struct duplicate_extents_to_file {
1199 __u64 PersistentFileHandle; /* source file handle, opaque endianness */
1200 __u64 VolatileFileHandle;
1201 __le64 SourceFileOffset;
1202 __le64 TargetFileOffset;
1203 __le64 ByteCount; /* Bytes to be copied */
1204} __packed;
1205
1206/*
1207 * Maximum number of iovs we need for an ioctl request.
1208 * [0] : struct smb2_ioctl_req
1209 * [1] : in_data
1210 */
1211#define SMB2_IOCTL_IOV_SIZE 2
1212
1213struct smb2_ioctl_req {
1214 struct smb2_sync_hdr sync_hdr;
1215 __le16 StructureSize; /* Must be 57 */
1216 __u16 Reserved;
1217 __le32 CtlCode;
1218 __u64 PersistentFileId; /* opaque endianness */
1219 __u64 VolatileFileId; /* opaque endianness */
1220 __le32 InputOffset;
1221 __le32 InputCount;
1222 __le32 MaxInputResponse;
1223 __le32 OutputOffset;
1224 __le32 OutputCount;
1225 __le32 MaxOutputResponse;
1226 __le32 Flags;
1227 __u32 Reserved2;
1228 __u8 Buffer[];
1229} __packed;
1230
1231struct smb2_ioctl_rsp {
1232 struct smb2_sync_hdr sync_hdr;
1233 __le16 StructureSize; /* Must be 57 */
1234 __u16 Reserved;
1235 __le32 CtlCode;
1236 __u64 PersistentFileId; /* opaque endianness */
1237 __u64 VolatileFileId; /* opaque endianness */
1238 __le32 InputOffset;
1239 __le32 InputCount;
1240 __le32 OutputOffset;
1241 __le32 OutputCount;
1242 __le32 Flags;
1243 __u32 Reserved2;
1244 /* char * buffer[] */
1245} __packed;
1246
1247/* Currently defined values for close flags */
1248#define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
1249struct smb2_close_req {
1250 struct smb2_sync_hdr sync_hdr;
1251 __le16 StructureSize; /* Must be 24 */
1252 __le16 Flags;
1253 __le32 Reserved;
1254 __u64 PersistentFileId; /* opaque endianness */
1255 __u64 VolatileFileId; /* opaque endianness */
1256} __packed;
1257
1258/*
1259 * Maximum size of a SMB2_CLOSE response is 64 (smb2 header) + 60 (data)
1260 */
1261#define MAX_SMB2_CLOSE_RESPONSE_SIZE 124
1262
1263struct smb2_close_rsp {
1264 struct smb2_sync_hdr sync_hdr;
1265 __le16 StructureSize; /* 60 */
1266 __le16 Flags;
1267 __le32 Reserved;
1268 __le64 CreationTime;
1269 __le64 LastAccessTime;
1270 __le64 LastWriteTime;
1271 __le64 ChangeTime;
1272 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
1273 __le64 EndOfFile;
1274 __le32 Attributes;
1275} __packed;
1276
1277struct smb2_flush_req {
1278 struct smb2_sync_hdr sync_hdr;
1279 __le16 StructureSize; /* Must be 24 */
1280 __le16 Reserved1;
1281 __le32 Reserved2;
1282 __u64 PersistentFileId; /* opaque endianness */
1283 __u64 VolatileFileId; /* opaque endianness */
1284} __packed;
1285
1286struct smb2_flush_rsp {
1287 struct smb2_sync_hdr sync_hdr;
1288 __le16 StructureSize;
1289 __le16 Reserved;
1290} __packed;
1291
1292/* For read request Flags field below, following flag is defined for SMB3.02 */
1293#define SMB2_READFLAG_READ_UNBUFFERED 0x01
1294#define SMB2_READFLAG_REQUEST_COMPRESSED 0x02 /* See MS-SMB2 2.2.19 */
1295
1296/* Channel field for read and write: exactly one of following flags can be set*/
1297#define SMB2_CHANNEL_NONE cpu_to_le32(0x00000000)
1298#define SMB2_CHANNEL_RDMA_V1 cpu_to_le32(0x00000001) /* SMB3 or later */
1299#define SMB2_CHANNEL_RDMA_V1_INVALIDATE cpu_to_le32(0x00000002) /* >= SMB3.02 */
1300#define SMB2_CHANNEL_RDMA_TRANSFORM cpu_to_le32(0x00000003) /* >= SMB3.02, only used on write */
1301
1302/* SMB2 read request without RFC1001 length at the beginning */
1303struct smb2_read_plain_req {
1304 struct smb2_sync_hdr sync_hdr;
1305 __le16 StructureSize; /* Must be 49 */
1306 __u8 Padding; /* offset from start of SMB2 header to place read */
1307 __u8 Flags; /* MBZ unless SMB3.02 or later */
1308 __le32 Length;
1309 __le64 Offset;
1310 __u64 PersistentFileId; /* opaque endianness */
1311 __u64 VolatileFileId; /* opaque endianness */
1312 __le32 MinimumCount;
1313 __le32 Channel; /* MBZ except for SMB3 or later */
1314 __le32 RemainingBytes;
1315 __le16 ReadChannelInfoOffset;
1316 __le16 ReadChannelInfoLength;
1317 __u8 Buffer[1];
1318} __packed;
1319
1320/* Read flags */
1321#define SMB2_READFLAG_RESPONSE_NONE 0x00000000
1322#define SMB2_READFLAG_RESPONSE_RDMA_TRANSFORM 0x00000001
1323
1324struct smb2_read_rsp {
1325 struct smb2_sync_hdr sync_hdr;
1326 __le16 StructureSize; /* Must be 17 */
1327 __u8 DataOffset;
1328 __u8 Reserved;
1329 __le32 DataLength;
1330 __le32 DataRemaining;
1331 __u32 Flags;
1332 __u8 Buffer[1];
1333} __packed;
1334
1335/* For write request Flags field below the following flags are defined: */
1336#define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
1337#define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
1338
1339struct smb2_write_req {
1340 struct smb2_sync_hdr sync_hdr;
1341 __le16 StructureSize; /* Must be 49 */
1342 __le16 DataOffset; /* offset from start of SMB2 header to write data */
1343 __le32 Length;
1344 __le64 Offset;
1345 __u64 PersistentFileId; /* opaque endianness */
1346 __u64 VolatileFileId; /* opaque endianness */
1347 __le32 Channel; /* MBZ unless SMB3.02 or later */
1348 __le32 RemainingBytes;
1349 __le16 WriteChannelInfoOffset;
1350 __le16 WriteChannelInfoLength;
1351 __le32 Flags;
1352 __u8 Buffer[1];
1353} __packed;
1354
1355struct smb2_write_rsp {
1356 struct smb2_sync_hdr sync_hdr;
1357 __le16 StructureSize; /* Must be 17 */
1358 __u8 DataOffset;
1359 __u8 Reserved;
1360 __le32 DataLength;
1361 __le32 DataRemaining;
1362 __u32 Reserved2;
1363 __u8 Buffer[1];
1364} __packed;
1365
1366/* notify flags */
1367#define SMB2_WATCH_TREE 0x0001
1368
1369/* notify completion filter flags. See MS-FSCC 2.6 and MS-SMB2 2.2.35 */
1370#define FILE_NOTIFY_CHANGE_FILE_NAME 0x00000001
1371#define FILE_NOTIFY_CHANGE_DIR_NAME 0x00000002
1372#define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x00000004
1373#define FILE_NOTIFY_CHANGE_SIZE 0x00000008
1374#define FILE_NOTIFY_CHANGE_LAST_WRITE 0x00000010
1375#define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x00000020
1376#define FILE_NOTIFY_CHANGE_CREATION 0x00000040
1377#define FILE_NOTIFY_CHANGE_EA 0x00000080
1378#define FILE_NOTIFY_CHANGE_SECURITY 0x00000100
1379#define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1380#define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1381#define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1382
1383struct smb2_change_notify_req {
1384 struct smb2_sync_hdr sync_hdr;
1385 __le16 StructureSize;
1386 __le16 Flags;
1387 __le32 OutputBufferLength;
1388 __u64 PersistentFileId; /* opaque endianness */
1389 __u64 VolatileFileId; /* opaque endianness */
1390 __le32 CompletionFilter;
1391 __u32 Reserved;
1392} __packed;
1393
1394struct smb2_change_notify_rsp {
1395 struct smb2_sync_hdr sync_hdr;
1396 __le16 StructureSize; /* Must be 9 */
1397 __le16 OutputBufferOffset;
1398 __le32 OutputBufferLength;
1399 __u8 Buffer[1]; /* array of file notify structs */
1400} __packed;
1401
1402#define SMB2_LOCKFLAG_SHARED_LOCK 0x0001
1403#define SMB2_LOCKFLAG_EXCLUSIVE_LOCK 0x0002
1404#define SMB2_LOCKFLAG_UNLOCK 0x0004
1405#define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
1406
1407struct smb2_lock_element {
1408 __le64 Offset;
1409 __le64 Length;
1410 __le32 Flags;
1411 __le32 Reserved;
1412} __packed;
1413
1414struct smb2_lock_req {
1415 struct smb2_sync_hdr sync_hdr;
1416 __le16 StructureSize; /* Must be 48 */
1417 __le16 LockCount;
1418 /*
1419 * The least significant four bits are the index, the other 28 bits are
1420 * the lock sequence number (0 to 64). See MS-SMB2 2.2.26
1421 */
1422 __le32 LockSequenceNumber;
1423 __u64 PersistentFileId; /* opaque endianness */
1424 __u64 VolatileFileId; /* opaque endianness */
1425 /* Followed by at least one */
1426 struct smb2_lock_element locks[1];
1427} __packed;
1428
1429struct smb2_lock_rsp {
1430 struct smb2_sync_hdr sync_hdr;
1431 __le16 StructureSize; /* Must be 4 */
1432 __le16 Reserved;
1433} __packed;
1434
1435struct smb2_echo_req {
1436 struct smb2_sync_hdr sync_hdr;
1437 __le16 StructureSize; /* Must be 4 */
1438 __u16 Reserved;
1439} __packed;
1440
1441struct smb2_echo_rsp {
1442 struct smb2_sync_hdr sync_hdr;
1443 __le16 StructureSize; /* Must be 4 */
1444 __u16 Reserved;
1445} __packed;
1446
1447/* search (query_directory) Flags field */
1448#define SMB2_RESTART_SCANS 0x01
1449#define SMB2_RETURN_SINGLE_ENTRY 0x02
1450#define SMB2_INDEX_SPECIFIED 0x04
1451#define SMB2_REOPEN 0x10
1452
1453#define SMB2_QUERY_DIRECTORY_IOV_SIZE 2
1454
1455/*
1456 * Valid FileInformation classes.
1457 *
1458 * Note that these are a subset of the (file) QUERY_INFO levels defined
1459 * later in this file (but since QUERY_DIRECTORY uses equivalent numbers
1460 * we do not redefine them here)
1461 *
1462 * FileDirectoryInfomation 0x01
1463 * FileFullDirectoryInformation 0x02
1464 * FileIdFullDirectoryInformation 0x26
1465 * FileBothDirectoryInformation 0x03
1466 * FileIdBothDirectoryInformation 0x25
1467 * FileNamesInformation 0x0C
1468 * FileIdExtdDirectoryInformation 0x3C
1469 */
1470
1471struct smb2_query_directory_req {
1472 struct smb2_sync_hdr sync_hdr;
1473 __le16 StructureSize; /* Must be 33 */
1474 __u8 FileInformationClass;
1475 __u8 Flags;
1476 __le32 FileIndex;
1477 __u64 PersistentFileId; /* opaque endianness */
1478 __u64 VolatileFileId; /* opaque endianness */
1479 __le16 FileNameOffset;
1480 __le16 FileNameLength;
1481 __le32 OutputBufferLength;
1482 __u8 Buffer[1];
1483} __packed;
1484
1485struct smb2_query_directory_rsp {
1486 struct smb2_sync_hdr sync_hdr;
1487 __le16 StructureSize; /* Must be 9 */
1488 __le16 OutputBufferOffset;
1489 __le32 OutputBufferLength;
1490 __u8 Buffer[1];
1491} __packed;
1492
1493/* Possible InfoType values */
1494#define SMB2_O_INFO_FILE 0x01
1495#define SMB2_O_INFO_FILESYSTEM 0x02
1496#define SMB2_O_INFO_SECURITY 0x03
1497#define SMB2_O_INFO_QUOTA 0x04
1498
1499/* Security info type additionalinfo flags. See MS-SMB2 (2.2.37) or MS-DTYP */
1500#define OWNER_SECINFO 0x00000001
1501#define GROUP_SECINFO 0x00000002
1502#define DACL_SECINFO 0x00000004
1503#define SACL_SECINFO 0x00000008
1504#define LABEL_SECINFO 0x00000010
1505#define ATTRIBUTE_SECINFO 0x00000020
1506#define SCOPE_SECINFO 0x00000040
1507#define BACKUP_SECINFO 0x00010000
1508#define UNPROTECTED_SACL_SECINFO 0x10000000
1509#define UNPROTECTED_DACL_SECINFO 0x20000000
1510#define PROTECTED_SACL_SECINFO 0x40000000
1511#define PROTECTED_DACL_SECINFO 0x80000000
1512
1513/* Flags used for FileFullEAinfo */
1514#define SL_RESTART_SCAN 0x00000001
1515#define SL_RETURN_SINGLE_ENTRY 0x00000002
1516#define SL_INDEX_SPECIFIED 0x00000004
1517
1518struct smb2_query_info_req {
1519 struct smb2_sync_hdr sync_hdr;
1520 __le16 StructureSize; /* Must be 41 */
1521 __u8 InfoType;
1522 __u8 FileInfoClass;
1523 __le32 OutputBufferLength;
1524 __le16 InputBufferOffset;
1525 __u16 Reserved;
1526 __le32 InputBufferLength;
1527 __le32 AdditionalInformation;
1528 __le32 Flags;
1529 __u64 PersistentFileId; /* opaque endianness */
1530 __u64 VolatileFileId; /* opaque endianness */
1531 __u8 Buffer[1];
1532} __packed;
1533
1534struct smb2_query_info_rsp {
1535 struct smb2_sync_hdr sync_hdr;
1536 __le16 StructureSize; /* Must be 9 */
1537 __le16 OutputBufferOffset;
1538 __le32 OutputBufferLength;
1539 __u8 Buffer[1];
1540} __packed;
1541
1542/*
1543 * Maximum number of iovs we need for a set-info request.
1544 * The largest one is rename/hardlink
1545 * [0] : struct smb2_set_info_req + smb2_file_[rename|link]_info
1546 * [1] : path
1547 * [2] : compound padding
1548 */
1549#define SMB2_SET_INFO_IOV_SIZE 3
1550
1551struct smb2_set_info_req {
1552 struct smb2_sync_hdr sync_hdr;
1553 __le16 StructureSize; /* Must be 33 */
1554 __u8 InfoType;
1555 __u8 FileInfoClass;
1556 __le32 BufferLength;
1557 __le16 BufferOffset;
1558 __u16 Reserved;
1559 __le32 AdditionalInformation;
1560 __u64 PersistentFileId; /* opaque endianness */
1561 __u64 VolatileFileId; /* opaque endianness */
1562 __u8 Buffer[1];
1563} __packed;
1564
1565struct smb2_set_info_rsp {
1566 struct smb2_sync_hdr sync_hdr;
1567 __le16 StructureSize; /* Must be 2 */
1568} __packed;
1569
1570struct smb2_oplock_break {
1571 struct smb2_sync_hdr sync_hdr;
1572 __le16 StructureSize; /* Must be 24 */
1573 __u8 OplockLevel;
1574 __u8 Reserved;
1575 __le32 Reserved2;
1576 __u64 PersistentFid;
1577 __u64 VolatileFid;
1578} __packed;
1579
1580#define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
1581
1582struct smb2_lease_break {
1583 struct smb2_sync_hdr sync_hdr;
1584 __le16 StructureSize; /* Must be 44 */
1585 __le16 Epoch;
1586 __le32 Flags;
1587 __u8 LeaseKey[16];
1588 __le32 CurrentLeaseState;
1589 __le32 NewLeaseState;
1590 __le32 BreakReason;
1591 __le32 AccessMaskHint;
1592 __le32 ShareMaskHint;
1593} __packed;
1594
1595struct smb2_lease_ack {
1596 struct smb2_sync_hdr sync_hdr;
1597 __le16 StructureSize; /* Must be 36 */
1598 __le16 Reserved;
1599 __le32 Flags;
1600 __u8 LeaseKey[16];
1601 __le32 LeaseState;
1602 __le64 LeaseDuration;
1603} __packed;
1604
1605/*
1606 * PDU infolevel structure definitions
1607 * BB consider moving to a different header
1608 */
1609
1610/* File System Information Classes */
1611#define FS_VOLUME_INFORMATION 1 /* Query */
1612#define FS_LABEL_INFORMATION 2 /* Local only */
1613#define FS_SIZE_INFORMATION 3 /* Query */
1614#define FS_DEVICE_INFORMATION 4 /* Query */
1615#define FS_ATTRIBUTE_INFORMATION 5 /* Query */
1616#define FS_CONTROL_INFORMATION 6 /* Query, Set */
1617#define FS_FULL_SIZE_INFORMATION 7 /* Query */
1618#define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
1619#define FS_DRIVER_PATH_INFORMATION 9 /* Local only */
1620#define FS_VOLUME_FLAGS_INFORMATION 10 /* Local only */
1621#define FS_SECTOR_SIZE_INFORMATION 11 /* SMB3 or later. Query */
1622#define FS_POSIX_INFORMATION 100 /* SMB3.1.1 POSIX. Query */
1623
1624struct smb2_fs_full_size_info {
1625 __le64 TotalAllocationUnits;
1626 __le64 CallerAvailableAllocationUnits;
1627 __le64 ActualAvailableAllocationUnits;
1628 __le32 SectorsPerAllocationUnit;
1629 __le32 BytesPerSector;
1630} __packed;
1631
1632#define SSINFO_FLAGS_ALIGNED_DEVICE 0x00000001
1633#define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
1634#define SSINFO_FLAGS_NO_SEEK_PENALTY 0x00000004
1635#define SSINFO_FLAGS_TRIM_ENABLED 0x00000008
1636
1637/* sector size info struct */
1638struct smb3_fs_ss_info {
1639 __le32 LogicalBytesPerSector;
1640 __le32 PhysicalBytesPerSectorForAtomicity;
1641 __le32 PhysicalBytesPerSectorForPerf;
1642 __le32 FileSystemEffectivePhysicalBytesPerSectorForAtomicity;
1643 __le32 Flags;
1644 __le32 ByteOffsetForSectorAlignment;
1645 __le32 ByteOffsetForPartitionAlignment;
1646} __packed;
1647
1648/* volume info struct - see MS-FSCC 2.5.9 */
1649#define MAX_VOL_LABEL_LEN 32
1650struct smb3_fs_vol_info {
1651 __le64 VolumeCreationTime;
1652 __u32 VolumeSerialNumber;
1653 __le32 VolumeLabelLength; /* includes trailing null */
1654 __u8 SupportsObjects; /* True if eg like NTFS, supports objects */
1655 __u8 Reserved;
1656 __u8 VolumeLabel[]; /* variable len */
1657} __packed;
1658
1659/* partial list of QUERY INFO levels */
1660#define FILE_DIRECTORY_INFORMATION 1
1661#define FILE_FULL_DIRECTORY_INFORMATION 2
1662#define FILE_BOTH_DIRECTORY_INFORMATION 3
1663#define FILE_BASIC_INFORMATION 4
1664#define FILE_STANDARD_INFORMATION 5
1665#define FILE_INTERNAL_INFORMATION 6
1666#define FILE_EA_INFORMATION 7
1667#define FILE_ACCESS_INFORMATION 8
1668#define FILE_NAME_INFORMATION 9
1669#define FILE_RENAME_INFORMATION 10
1670#define FILE_LINK_INFORMATION 11
1671#define FILE_NAMES_INFORMATION 12
1672#define FILE_DISPOSITION_INFORMATION 13
1673#define FILE_POSITION_INFORMATION 14
1674#define FILE_FULL_EA_INFORMATION 15
1675#define FILE_MODE_INFORMATION 16
1676#define FILE_ALIGNMENT_INFORMATION 17
1677#define FILE_ALL_INFORMATION 18
1678#define FILE_ALLOCATION_INFORMATION 19
1679#define FILE_END_OF_FILE_INFORMATION 20
1680#define FILE_ALTERNATE_NAME_INFORMATION 21
1681#define FILE_STREAM_INFORMATION 22
1682#define FILE_PIPE_INFORMATION 23
1683#define FILE_PIPE_LOCAL_INFORMATION 24
1684#define FILE_PIPE_REMOTE_INFORMATION 25
1685#define FILE_MAILSLOT_QUERY_INFORMATION 26
1686#define FILE_MAILSLOT_SET_INFORMATION 27
1687#define FILE_COMPRESSION_INFORMATION 28
1688#define FILE_OBJECT_ID_INFORMATION 29
1689/* Number 30 not defined in documents */
1690#define FILE_MOVE_CLUSTER_INFORMATION 31
1691#define FILE_QUOTA_INFORMATION 32
1692#define FILE_REPARSE_POINT_INFORMATION 33
1693#define FILE_NETWORK_OPEN_INFORMATION 34
1694#define FILE_ATTRIBUTE_TAG_INFORMATION 35
1695#define FILE_TRACKING_INFORMATION 36
1696#define FILEID_BOTH_DIRECTORY_INFORMATION 37
1697#define FILEID_FULL_DIRECTORY_INFORMATION 38
1698#define FILE_VALID_DATA_LENGTH_INFORMATION 39
1699#define FILE_SHORT_NAME_INFORMATION 40
1700#define FILE_SFIO_RESERVE_INFORMATION 44
1701#define FILE_SFIO_VOLUME_INFORMATION 45
1702#define FILE_HARD_LINK_INFORMATION 46
1703#define FILE_NORMALIZED_NAME_INFORMATION 48
1704#define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
1705#define FILE_STANDARD_LINK_INFORMATION 54
1706#define FILE_ID_INFORMATION 59
1707#define FILE_ID_EXTD_DIRECTORY_INFORMATION 60
1708
1709struct smb2_file_internal_info {
1710 __le64 IndexNumber;
1711} __packed; /* level 6 Query */
1712
1713struct smb2_file_rename_info { /* encoding of request for level 10 */
1714 __u8 ReplaceIfExists; /* 1 = replace existing target with new */
1715 /* 0 = fail if target already exists */
1716 __u8 Reserved[7];
1717 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
1718 __le32 FileNameLength;
1719 char FileName[]; /* New name to be assigned */
1720 /* padding - overall struct size must be >= 24 so filename + pad >= 6 */
1721} __packed; /* level 10 Set */
1722
1723struct smb2_file_link_info { /* encoding of request for level 11 */
1724 __u8 ReplaceIfExists; /* 1 = replace existing link with new */
1725 /* 0 = fail if link already exists */
1726 __u8 Reserved[7];
1727 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
1728 __le32 FileNameLength;
1729 char FileName[]; /* Name to be assigned to new link */
1730} __packed; /* level 11 Set */
1731
1732struct smb2_file_full_ea_info { /* encoding of response for level 15 */
1733 __le32 next_entry_offset;
1734 __u8 flags;
1735 __u8 ea_name_length;
1736 __le16 ea_value_length;
1737 char ea_data[]; /* \0 terminated name plus value */
1738} __packed; /* level 15 Set */
1739
1740/*
1741 * This level 18, although with struct with same name is different from cifs
1742 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
1743 * CurrentByteOffset.
1744 */
1745struct smb2_file_all_info { /* data block encoding of response to level 18 */
1746 __le64 CreationTime; /* Beginning of FILE_BASIC_INFO equivalent */
1747 __le64 LastAccessTime;
1748 __le64 LastWriteTime;
1749 __le64 ChangeTime;
1750 __le32 Attributes;
1751 __u32 Pad1; /* End of FILE_BASIC_INFO_INFO equivalent */
1752 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
1753 __le64 EndOfFile; /* size ie offset to first free byte in file */
1754 __le32 NumberOfLinks; /* hard links */
1755 __u8 DeletePending;
1756 __u8 Directory;
1757 __u16 Pad2; /* End of FILE_STANDARD_INFO equivalent */
1758 __le64 IndexNumber;
1759 __le32 EASize;
1760 __le32 AccessFlags;
1761 __le64 CurrentByteOffset;
1762 __le32 Mode;
1763 __le32 AlignmentRequirement;
1764 __le32 FileNameLength;
1765 char FileName[1];
1766} __packed; /* level 18 Query */
1767
1768struct smb2_file_eof_info { /* encoding of request for level 10 */
1769 __le64 EndOfFile; /* new end of file value */
1770} __packed; /* level 20 Set */
1771
1772struct smb2_file_reparse_point_info {
1773 __le64 IndexNumber;
1774 __le32 Tag;
1775} __packed;
1776
1777struct smb2_file_network_open_info {
1778 __le64 CreationTime;
1779 __le64 LastAccessTime;
1780 __le64 LastWriteTime;
1781 __le64 ChangeTime;
1782 __le64 AllocationSize;
1783 __le64 EndOfFile;
1784 __le32 Attributes;
1785 __le32 Reserved;
1786} __packed; /* level 34 Query also similar returned in close rsp and open rsp */
1787
1788/* See MS-FSCC 2.4.21 */
1789struct smb2_file_id_information {
1790 __le64 VolumeSerialNumber;
1791 __u64 PersistentFileId; /* opaque endianness */
1792 __u64 VolatileFileId; /* opaque endianness */
1793} __packed; /* level 59 */
1794
1795/* See MS-FSCC 2.4.18 */
1796struct smb2_file_id_extd_directory_info {
1797 __le32 NextEntryOffset;
1798 __u32 FileIndex;
1799 __le64 CreationTime;
1800 __le64 LastAccessTime;
1801 __le64 LastWriteTime;
1802 __le64 ChangeTime;
1803 __le64 EndOfFile;
1804 __le64 AllocationSize;
1805 __le32 FileAttributes;
1806 __le32 FileNameLength;
1807 __le32 EaSize; /* EA size */
1808 __le32 ReparsePointTag; /* valid if FILE_ATTR_REPARSE_POINT set in FileAttributes */
1809 __le64 UniqueId; /* inode num - le since Samba puts ino in low 32 bit */
1810 char FileName[1];
1811} __packed; /* level 60 */
1812
1813extern char smb2_padding[7];
1814
1815/* equivalent of the contents of SMB3.1.1 POSIX open context response */
1816struct create_posix_rsp {
1817 u32 nlink;
1818 u32 reparse_tag;
1819 u32 mode;
1820 struct cifs_sid owner; /* var-sized on the wire */
1821 struct cifs_sid group; /* var-sized on the wire */
1822} __packed;
1823
1824/*
1825 * SMB2-only POSIX info level for query dir
1826 *
1827 * See posix_info_sid_size(), posix_info_extra_size() and
1828 * posix_info_parse() to help with the handling of this struct.
1829 */
1830struct smb2_posix_info {
1831 __le32 NextEntryOffset;
1832 __u32 Ignored;
1833 __le64 CreationTime;
1834 __le64 LastAccessTime;
1835 __le64 LastWriteTime;
1836 __le64 ChangeTime;
1837 __le64 EndOfFile;
1838 __le64 AllocationSize;
1839 __le32 DosAttributes;
1840 __le64 Inode;
1841 __le32 DeviceId;
1842 __le32 Zero;
1843 /* beginning of POSIX Create Context Response */
1844 __le32 HardLinks;
1845 __le32 ReparseTag;
1846 __le32 Mode;
1847 /*
1848 * var sized owner SID
1849 * var sized group SID
1850 * le32 filenamelength
1851 * u8 filename[]
1852 */
1853} __packed;
1854
1855/* Level 100 query info */
1856struct smb311_posix_qinfo {
1857 __le64 CreationTime;
1858 __le64 LastAccessTime;
1859 __le64 LastWriteTime;
1860 __le64 ChangeTime;
1861 __le64 EndOfFile;
1862 __le64 AllocationSize;
1863 __le32 DosAttributes;
1864 __le64 Inode;
1865 __le32 DeviceId;
1866 __le32 Zero;
1867 /* beginning of POSIX Create Context Response */
1868 __le32 HardLinks;
1869 __le32 ReparseTag;
1870 __le32 Mode;
1871 u8 Sids[];
1872 /*
1873 * var sized owner SID
1874 * var sized group SID
1875 * le32 filenamelength
1876 * u8 filename[]
1877 */
1878} __packed;
1879
1880/*
1881 * Parsed version of the above struct. Allows direct access to the
1882 * variable length fields
1883 */
1884struct smb2_posix_info_parsed {
1885 const struct smb2_posix_info *base;
1886 size_t size;
1887 struct cifs_sid owner;
1888 struct cifs_sid group;
1889 int name_len;
1890 const u8 *name;
1891};
1892
1893#endif /* _SMB2PDU_H */
1/*
2 * fs/cifs/smb2pdu.h
3 *
4 * Copyright (c) International Business Machines Corp., 2009, 2013
5 * Etersoft, 2012
6 * Author(s): Steve French (sfrench@us.ibm.com)
7 * Pavel Shilovsky (pshilovsky@samba.org) 2012
8 *
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.
13 *
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.
18 *
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
22 */
23
24#ifndef _SMB2PDU_H
25#define _SMB2PDU_H
26
27#include <net/sock.h>
28#include <cifsacl.h>
29
30/*
31 * Note that, due to trying to use names similar to the protocol specifications,
32 * there are many mixed case field names in the structures below. Although
33 * this does not match typical Linux kernel style, it is necessary to be
34 * able to match against the protocol specfication.
35 *
36 * SMB2 commands
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.
40 */
41
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
62
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)
83
84#define SMB2_INTERNAL_CMD cpu_to_le16(0xFFFF)
85
86#define NUMBER_OF_SMB2_COMMANDS 0x0013
87
88/* 52 transform hdr + 64 hdr + 88 create rsp */
89#define SMB2_TRANSFORM_HEADER_SIZE 52
90#define MAX_SMB2_HDR_SIZE 204
91
92#define SMB2_PROTO_NUMBER cpu_to_le32(0x424d53fe)
93#define SMB2_TRANSFORM_PROTO_NUM cpu_to_le32(0x424d53fd)
94#define SMB2_COMPRESSION_TRANSFORM_ID cpu_to_le32(0x424d53fc)
95
96/*
97 * SMB2 Header Definition
98 *
99 * "MBZ" : Must be Zero
100 * "BB" : BugBug, Something to check/review/analyze later
101 * "PDU" : "Protocol Data Unit" (ie a network "frame")
102 *
103 */
104
105#define SMB2_HEADER_STRUCTURE_SIZE cpu_to_le16(64)
106
107struct smb2_sync_hdr {
108 __le32 ProtocolId; /* 0xFE 'S' 'M' 'B' */
109 __le16 StructureSize; /* 64 */
110 __le16 CreditCharge; /* MBZ */
111 __le32 Status; /* Error from server */
112 __le16 Command;
113 __le16 CreditRequest; /* CreditResponse */
114 __le32 Flags;
115 __le32 NextCommand;
116 __le64 MessageId;
117 __le32 ProcessId;
118 __u32 TreeId; /* opaque - so do not make little endian */
119 __u64 SessionId; /* opaque - so do not make little endian */
120 __u8 Signature[16];
121} __packed;
122
123/* The total header size for SMB2 read and write */
124#define SMB2_READWRITE_PDU_HEADER_SIZE (48 + sizeof(struct smb2_sync_hdr))
125
126struct smb2_sync_pdu {
127 struct smb2_sync_hdr sync_hdr;
128 __le16 StructureSize2; /* size of wct area (varies, request specific) */
129} __packed;
130
131#define SMB3_AES128CCM_NONCE 11
132#define SMB3_AES128GCM_NONCE 12
133
134/* Transform flags (for 3.0 dialect this flag indicates CCM */
135#define TRANSFORM_FLAG_ENCRYPTED 0x0001
136struct smb2_transform_hdr {
137 __le32 ProtocolId; /* 0xFD 'S' 'M' 'B' */
138 __u8 Signature[16];
139 __u8 Nonce[16];
140 __le32 OriginalMessageSize;
141 __u16 Reserved1;
142 __le16 Flags; /* EncryptionAlgorithm for 3.0, enc enabled for 3.1.1 */
143 __u64 SessionId;
144} __packed;
145
146/* See MS-SMB2 2.2.42 */
147struct smb2_compression_transform_hdr {
148 __le32 ProtocolId; /* 0xFC 'S' 'M' 'B' */
149 __le32 OriginalCompressedSegmentSize;
150 __le16 CompressionAlgorithm;
151 __le16 Flags;
152 __le16 Length; /* if chained it is length, else offset */
153} __packed;
154
155/* See MS-SMB2 2.2.42.1 */
156struct compression_payload_header {
157 __le16 AlgorithmId;
158 __le16 Reserved;
159 __le32 Length;
160} __packed;
161
162/* See MS-SMB2 2.2.42.2 */
163struct compression_pattern_payload_v1 {
164 __le16 Pattern;
165 __le16 Reserved1;
166 __le16 Reserved2;
167 __le32 Repetitions;
168} __packed;
169
170/*
171 * SMB2 flag definitions
172 */
173#define SMB2_FLAGS_SERVER_TO_REDIR cpu_to_le32(0x00000001)
174#define SMB2_FLAGS_ASYNC_COMMAND cpu_to_le32(0x00000002)
175#define SMB2_FLAGS_RELATED_OPERATIONS cpu_to_le32(0x00000004)
176#define SMB2_FLAGS_SIGNED cpu_to_le32(0x00000008)
177#define SMB2_FLAGS_PRIORITY_MASK cpu_to_le32(0x00000070) /* SMB3.1.1 */
178#define SMB2_FLAGS_DFS_OPERATIONS cpu_to_le32(0x10000000)
179#define SMB2_FLAGS_REPLAY_OPERATION cpu_to_le32(0x20000000) /* SMB3 & up */
180
181/*
182 * Definitions for SMB2 Protocol Data Units (network frames)
183 *
184 * See MS-SMB2.PDF specification for protocol details.
185 * The Naming convention is the lower case version of the SMB2
186 * command code name for the struct. Note that structures must be packed.
187 *
188 */
189
190#define COMPOUND_FID 0xFFFFFFFFFFFFFFFFULL
191
192#define SMB2_ERROR_STRUCTURE_SIZE2 cpu_to_le16(9)
193
194struct smb2_err_rsp {
195 struct smb2_sync_hdr sync_hdr;
196 __le16 StructureSize;
197 __le16 Reserved; /* MBZ */
198 __le32 ByteCount; /* even if zero, at least one byte follows */
199 __u8 ErrorData[1]; /* variable length */
200} __packed;
201
202#define SYMLINK_ERROR_TAG 0x4c4d5953
203
204struct smb2_symlink_err_rsp {
205 __le32 SymLinkLength;
206 __le32 SymLinkErrorTag;
207 __le32 ReparseTag;
208 __le16 ReparseDataLength;
209 __le16 UnparsedPathLength;
210 __le16 SubstituteNameOffset;
211 __le16 SubstituteNameLength;
212 __le16 PrintNameOffset;
213 __le16 PrintNameLength;
214 __le32 Flags;
215 __u8 PathBuffer[];
216} __packed;
217
218/* SMB 3.1.1 and later dialects. See MS-SMB2 section 2.2.2.1 */
219struct smb2_error_context_rsp {
220 __le32 ErrorDataLength;
221 __le32 ErrorId;
222 __u8 ErrorContextData; /* ErrorDataLength long array */
223} __packed;
224
225/* ErrorId values */
226#define SMB2_ERROR_ID_DEFAULT 0x00000000
227#define SMB2_ERROR_ID_SHARE_REDIRECT cpu_to_le32(0x72645253) /* "rdRS" */
228
229/* Defines for Type field below (see MS-SMB2 2.2.2.2.2.1) */
230#define MOVE_DST_IPADDR_V4 cpu_to_le32(0x00000001)
231#define MOVE_DST_IPADDR_V6 cpu_to_le32(0x00000002)
232
233struct move_dst_ipaddr {
234 __le32 Type;
235 __u32 Reserved;
236 __u8 address[16]; /* IPv4 followed by 12 bytes rsvd or IPv6 address */
237} __packed;
238
239struct share_redirect_error_context_rsp {
240 __le32 StructureSize;
241 __le32 NotificationType;
242 __le32 ResourceNameOffset;
243 __le32 ResourceNameLength;
244 __le16 Flags;
245 __le16 TargetType;
246 __le32 IPAddrCount;
247 struct move_dst_ipaddr IpAddrMoveList[];
248 /* __u8 ResourceName[] */ /* Name of share as counted Unicode string */
249} __packed;
250
251#define SMB2_CLIENT_GUID_SIZE 16
252
253struct smb2_negotiate_req {
254 struct smb2_sync_hdr sync_hdr;
255 __le16 StructureSize; /* Must be 36 */
256 __le16 DialectCount;
257 __le16 SecurityMode;
258 __le16 Reserved; /* MBZ */
259 __le32 Capabilities;
260 __u8 ClientGUID[SMB2_CLIENT_GUID_SIZE];
261 /* In SMB3.02 and earlier next three were MBZ le64 ClientStartTime */
262 __le32 NegotiateContextOffset; /* SMB3.1.1 only. MBZ earlier */
263 __le16 NegotiateContextCount; /* SMB3.1.1 only. MBZ earlier */
264 __le16 Reserved2;
265 __le16 Dialects[1]; /* One dialect (vers=) at a time for now */
266} __packed;
267
268/* Dialects */
269#define SMB10_PROT_ID 0x0000 /* local only, not sent on wire w/CIFS negprot */
270#define SMB20_PROT_ID 0x0202
271#define SMB21_PROT_ID 0x0210
272#define SMB30_PROT_ID 0x0300
273#define SMB302_PROT_ID 0x0302
274#define SMB311_PROT_ID 0x0311
275#define BAD_PROT_ID 0xFFFF
276
277/* SecurityMode flags */
278#define SMB2_NEGOTIATE_SIGNING_ENABLED 0x0001
279#define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
280#define SMB2_SEC_MODE_FLAGS_ALL 0x0003
281
282/* Capabilities flags */
283#define SMB2_GLOBAL_CAP_DFS 0x00000001
284#define SMB2_GLOBAL_CAP_LEASING 0x00000002 /* Resp only New to SMB2.1 */
285#define SMB2_GLOBAL_CAP_LARGE_MTU 0X00000004 /* Resp only New to SMB2.1 */
286#define SMB2_GLOBAL_CAP_MULTI_CHANNEL 0x00000008 /* New to SMB3 */
287#define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
288#define SMB2_GLOBAL_CAP_DIRECTORY_LEASING 0x00000020 /* New to SMB3 */
289#define SMB2_GLOBAL_CAP_ENCRYPTION 0x00000040 /* New to SMB3 */
290/* Internal types */
291#define SMB2_NT_FIND 0x00100000
292#define SMB2_LARGE_FILES 0x00200000
293
294
295/* Negotiate Contexts - ContextTypes. See MS-SMB2 section 2.2.3.1 for details */
296#define SMB2_PREAUTH_INTEGRITY_CAPABILITIES cpu_to_le16(1)
297#define SMB2_ENCRYPTION_CAPABILITIES cpu_to_le16(2)
298#define SMB2_COMPRESSION_CAPABILITIES cpu_to_le16(3)
299#define SMB2_NETNAME_NEGOTIATE_CONTEXT_ID cpu_to_le16(5)
300#define SMB2_POSIX_EXTENSIONS_AVAILABLE cpu_to_le16(0x100)
301
302struct smb2_neg_context {
303 __le16 ContextType;
304 __le16 DataLength;
305 __le32 Reserved;
306 /* Followed by array of data */
307} __packed;
308
309#define SMB311_SALT_SIZE 32
310/* Hash Algorithm Types */
311#define SMB2_PREAUTH_INTEGRITY_SHA512 cpu_to_le16(0x0001)
312#define SMB2_PREAUTH_HASH_SIZE 64
313
314#define MIN_PREAUTH_CTXT_DATA_LEN (SMB311_SALT_SIZE + 6)
315struct smb2_preauth_neg_context {
316 __le16 ContextType; /* 1 */
317 __le16 DataLength;
318 __le32 Reserved;
319 __le16 HashAlgorithmCount; /* 1 */
320 __le16 SaltLength;
321 __le16 HashAlgorithms; /* HashAlgorithms[0] since only one defined */
322 __u8 Salt[SMB311_SALT_SIZE];
323} __packed;
324
325/* Encryption Algorithms Ciphers */
326#define SMB2_ENCRYPTION_AES128_CCM cpu_to_le16(0x0001)
327#define SMB2_ENCRYPTION_AES128_GCM cpu_to_le16(0x0002)
328
329/* Min encrypt context data is one cipher so 2 bytes + 2 byte count field */
330#define MIN_ENCRYPT_CTXT_DATA_LEN 4
331struct smb2_encryption_neg_context {
332 __le16 ContextType; /* 2 */
333 __le16 DataLength;
334 __le32 Reserved;
335 __le16 CipherCount; /* AES-128-GCM and AES-128-CCM */
336 __le16 Ciphers[2];
337} __packed;
338
339/* See MS-SMB2 2.2.3.1.3 */
340#define SMB3_COMPRESS_NONE cpu_to_le16(0x0000)
341#define SMB3_COMPRESS_LZNT1 cpu_to_le16(0x0001)
342#define SMB3_COMPRESS_LZ77 cpu_to_le16(0x0002)
343#define SMB3_COMPRESS_LZ77_HUFF cpu_to_le16(0x0003)
344/* Pattern scanning algorithm See MS-SMB2 3.1.4.4.1 */
345#define SMB3_COMPRESS_PATTERN cpu_to_le16(0x0004) /* Pattern_V1 */
346
347/* Compression Flags */
348#define SMB2_COMPRESSION_CAPABILITIES_FLAG_NONE cpu_to_le32(0x00000000)
349#define SMB2_COMPRESSION_CAPABILITIES_FLAG_CHAINED cpu_to_le32(0x00000001)
350
351struct smb2_compression_capabilities_context {
352 __le16 ContextType; /* 3 */
353 __le16 DataLength;
354 __u32 Flags;
355 __le16 CompressionAlgorithmCount;
356 __u16 Padding;
357 __u32 Reserved1;
358 __le16 CompressionAlgorithms[3];
359} __packed;
360
361/*
362 * For smb2_netname_negotiate_context_id See MS-SMB2 2.2.3.1.4.
363 * Its struct simply contains NetName, an array of Unicode characters
364 */
365struct smb2_netname_neg_context {
366 __le16 ContextType; /* 0x100 */
367 __le16 DataLength;
368 __le32 Reserved;
369 __le16 NetName[]; /* hostname of target converted to UCS-2 */
370} __packed;
371
372#define POSIX_CTXT_DATA_LEN 16
373struct smb2_posix_neg_context {
374 __le16 ContextType; /* 0x100 */
375 __le16 DataLength;
376 __le32 Reserved;
377 __u8 Name[16]; /* POSIX ctxt GUID 93AD25509CB411E7B42383DE968BCD7C */
378} __packed;
379
380struct smb2_negotiate_rsp {
381 struct smb2_sync_hdr sync_hdr;
382 __le16 StructureSize; /* Must be 65 */
383 __le16 SecurityMode;
384 __le16 DialectRevision;
385 __le16 NegotiateContextCount; /* Prior to SMB3.1.1 was Reserved & MBZ */
386 __u8 ServerGUID[16];
387 __le32 Capabilities;
388 __le32 MaxTransactSize;
389 __le32 MaxReadSize;
390 __le32 MaxWriteSize;
391 __le64 SystemTime; /* MBZ */
392 __le64 ServerStartTime;
393 __le16 SecurityBufferOffset;
394 __le16 SecurityBufferLength;
395 __le32 NegotiateContextOffset; /* Pre:SMB3.1.1 was reserved/ignored */
396 __u8 Buffer[1]; /* variable length GSS security buffer */
397} __packed;
398
399/* Flags */
400#define SMB2_SESSION_REQ_FLAG_BINDING 0x01
401#define SMB2_SESSION_REQ_FLAG_ENCRYPT_DATA 0x04
402
403struct smb2_sess_setup_req {
404 struct smb2_sync_hdr sync_hdr;
405 __le16 StructureSize; /* Must be 25 */
406 __u8 Flags;
407 __u8 SecurityMode;
408 __le32 Capabilities;
409 __le32 Channel;
410 __le16 SecurityBufferOffset;
411 __le16 SecurityBufferLength;
412 __u64 PreviousSessionId;
413 __u8 Buffer[1]; /* variable length GSS security buffer */
414} __packed;
415
416/* Currently defined SessionFlags */
417#define SMB2_SESSION_FLAG_IS_GUEST 0x0001
418#define SMB2_SESSION_FLAG_IS_NULL 0x0002
419#define SMB2_SESSION_FLAG_ENCRYPT_DATA 0x0004
420struct smb2_sess_setup_rsp {
421 struct smb2_sync_hdr sync_hdr;
422 __le16 StructureSize; /* Must be 9 */
423 __le16 SessionFlags;
424 __le16 SecurityBufferOffset;
425 __le16 SecurityBufferLength;
426 __u8 Buffer[1]; /* variable length GSS security buffer */
427} __packed;
428
429struct smb2_logoff_req {
430 struct smb2_sync_hdr sync_hdr;
431 __le16 StructureSize; /* Must be 4 */
432 __le16 Reserved;
433} __packed;
434
435struct smb2_logoff_rsp {
436 struct smb2_sync_hdr sync_hdr;
437 __le16 StructureSize; /* Must be 4 */
438 __le16 Reserved;
439} __packed;
440
441/* Flags/Reserved for SMB3.1.1 */
442#define SMB2_TREE_CONNECT_FLAG_CLUSTER_RECONNECT cpu_to_le16(0x0001)
443#define SMB2_TREE_CONNECT_FLAG_REDIRECT_TO_OWNER cpu_to_le16(0x0002)
444#define SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT cpu_to_le16(0x0004)
445
446struct smb2_tree_connect_req {
447 struct smb2_sync_hdr sync_hdr;
448 __le16 StructureSize; /* Must be 9 */
449 __le16 Flags; /* Reserved MBZ for dialects prior to SMB3.1.1 */
450 __le16 PathOffset;
451 __le16 PathLength;
452 __u8 Buffer[1]; /* variable length */
453} __packed;
454
455/* See MS-SMB2 section 2.2.9.2 */
456/* Context Types */
457#define SMB2_RESERVED_TREE_CONNECT_CONTEXT_ID 0x0000
458#define SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID cpu_to_le16(0x0001)
459
460struct tree_connect_contexts {
461 __le16 ContextType;
462 __le16 DataLength;
463 __le32 Reserved;
464 __u8 Data[];
465} __packed;
466
467/* Remoted identity tree connect context structures - see MS-SMB2 2.2.9.2.1 */
468struct smb3_blob_data {
469 __le16 BlobSize;
470 __u8 BlobData[];
471} __packed;
472
473/* Valid values for Attr */
474#define SE_GROUP_MANDATORY 0x00000001
475#define SE_GROUP_ENABLED_BY_DEFAULT 0x00000002
476#define SE_GROUP_ENABLED 0x00000004
477#define SE_GROUP_OWNER 0x00000008
478#define SE_GROUP_USE_FOR_DENY_ONLY 0x00000010
479#define SE_GROUP_INTEGRITY 0x00000020
480#define SE_GROUP_INTEGRITY_ENABLED 0x00000040
481#define SE_GROUP_RESOURCE 0x20000000
482#define SE_GROUP_LOGON_ID 0xC0000000
483
484/* struct sid_attr_data is SidData array in BlobData format then le32 Attr */
485
486struct sid_array_data {
487 __le16 SidAttrCount;
488 /* SidAttrList - array of sid_attr_data structs */
489} __packed;
490
491struct luid_attr_data {
492
493} __packed;
494
495/*
496 * struct privilege_data is the same as BLOB_DATA - see MS-SMB2 2.2.9.2.1.5
497 * but with size of LUID_ATTR_DATA struct and BlobData set to LUID_ATTR DATA
498 */
499
500struct privilege_array_data {
501 __le16 PrivilegeCount;
502 /* array of privilege_data structs */
503} __packed;
504
505struct remoted_identity_tcon_context {
506 __le16 TicketType; /* must be 0x0001 */
507 __le16 TicketSize; /* total size of this struct */
508 __le16 User; /* offset to SID_ATTR_DATA struct with user info */
509 __le16 UserName; /* offset to null terminated Unicode username string */
510 __le16 Domain; /* offset to null terminated Unicode domain name */
511 __le16 Groups; /* offset to SID_ARRAY_DATA struct with group info */
512 __le16 RestrictedGroups; /* similar to above */
513 __le16 Privileges; /* offset to PRIVILEGE_ARRAY_DATA struct */
514 __le16 PrimaryGroup; /* offset to SID_ARRAY_DATA struct */
515 __le16 Owner; /* offset to BLOB_DATA struct */
516 __le16 DefaultDacl; /* offset to BLOB_DATA struct */
517 __le16 DeviceGroups; /* offset to SID_ARRAY_DATA struct */
518 __le16 UserClaims; /* offset to BLOB_DATA struct */
519 __le16 DeviceClaims; /* offset to BLOB_DATA struct */
520 __u8 TicketInfo[]; /* variable length buf - remoted identity data */
521} __packed;
522
523struct smb2_tree_connect_req_extension {
524 __le32 TreeConnectContextOffset;
525 __le16 TreeConnectContextCount;
526 __u8 Reserved[10];
527 __u8 PathName[]; /* variable sized array */
528 /* followed by array of TreeConnectContexts */
529} __packed;
530
531struct smb2_tree_connect_rsp {
532 struct smb2_sync_hdr sync_hdr;
533 __le16 StructureSize; /* Must be 16 */
534 __u8 ShareType; /* see below */
535 __u8 Reserved;
536 __le32 ShareFlags; /* see below */
537 __le32 Capabilities; /* see below */
538 __le32 MaximalAccess;
539} __packed;
540
541/* Possible ShareType values */
542#define SMB2_SHARE_TYPE_DISK 0x01
543#define SMB2_SHARE_TYPE_PIPE 0x02
544#define SMB2_SHARE_TYPE_PRINT 0x03
545
546/*
547 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
548 * must be set (any of the remaining, SHI1005, flags may be set individually
549 * or in combination.
550 */
551#define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
552#define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
553#define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
554#define SMB2_SHAREFLAG_NO_CACHING 0x00000030
555#define SHI1005_FLAGS_DFS 0x00000001
556#define SHI1005_FLAGS_DFS_ROOT 0x00000002
557#define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS 0x00000100
558#define SHI1005_FLAGS_FORCE_SHARED_DELETE 0x00000200
559#define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING 0x00000400
560#define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
561#define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK 0x00001000
562#define SHI1005_FLAGS_ENABLE_HASH_V1 0x00002000
563#define SHI1005_FLAGS_ENABLE_HASH_V2 0x00004000
564#define SHI1005_FLAGS_ENCRYPT_DATA 0x00008000
565#define SMB2_SHAREFLAG_IDENTITY_REMOTING 0x00040000 /* 3.1.1 */
566#define SHI1005_FLAGS_ALL 0x0004FF33
567
568/* Possible share capabilities */
569#define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
570#define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
571#define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
572#define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
573#define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
574#define SMB2_SHARE_CAP_REDIRECT_TO_OWNER cpu_to_le32(0x00000100) /* 3.1.1 */
575
576struct smb2_tree_disconnect_req {
577 struct smb2_sync_hdr sync_hdr;
578 __le16 StructureSize; /* Must be 4 */
579 __le16 Reserved;
580} __packed;
581
582struct smb2_tree_disconnect_rsp {
583 struct smb2_sync_hdr sync_hdr;
584 __le16 StructureSize; /* Must be 4 */
585 __le16 Reserved;
586} __packed;
587
588/* File Attrubutes */
589#define FILE_ATTRIBUTE_READONLY 0x00000001
590#define FILE_ATTRIBUTE_HIDDEN 0x00000002
591#define FILE_ATTRIBUTE_SYSTEM 0x00000004
592#define FILE_ATTRIBUTE_DIRECTORY 0x00000010
593#define FILE_ATTRIBUTE_ARCHIVE 0x00000020
594#define FILE_ATTRIBUTE_NORMAL 0x00000080
595#define FILE_ATTRIBUTE_TEMPORARY 0x00000100
596#define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
597#define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
598#define FILE_ATTRIBUTE_COMPRESSED 0x00000800
599#define FILE_ATTRIBUTE_OFFLINE 0x00001000
600#define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
601#define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
602#define FILE_ATTRIBUTE_INTEGRITY_STREAM 0x00008000
603#define FILE_ATTRIBUTE_NO_SCRUB_DATA 0x00020000
604
605/* Oplock levels */
606#define SMB2_OPLOCK_LEVEL_NONE 0x00
607#define SMB2_OPLOCK_LEVEL_II 0x01
608#define SMB2_OPLOCK_LEVEL_EXCLUSIVE 0x08
609#define SMB2_OPLOCK_LEVEL_BATCH 0x09
610#define SMB2_OPLOCK_LEVEL_LEASE 0xFF
611/* Non-spec internal type */
612#define SMB2_OPLOCK_LEVEL_NOCHANGE 0x99
613
614/* Desired Access Flags */
615#define FILE_READ_DATA_LE cpu_to_le32(0x00000001)
616#define FILE_WRITE_DATA_LE cpu_to_le32(0x00000002)
617#define FILE_APPEND_DATA_LE cpu_to_le32(0x00000004)
618#define FILE_READ_EA_LE cpu_to_le32(0x00000008)
619#define FILE_WRITE_EA_LE cpu_to_le32(0x00000010)
620#define FILE_EXECUTE_LE cpu_to_le32(0x00000020)
621#define FILE_READ_ATTRIBUTES_LE cpu_to_le32(0x00000080)
622#define FILE_WRITE_ATTRIBUTES_LE cpu_to_le32(0x00000100)
623#define FILE_DELETE_LE cpu_to_le32(0x00010000)
624#define FILE_READ_CONTROL_LE cpu_to_le32(0x00020000)
625#define FILE_WRITE_DAC_LE cpu_to_le32(0x00040000)
626#define FILE_WRITE_OWNER_LE cpu_to_le32(0x00080000)
627#define FILE_SYNCHRONIZE_LE cpu_to_le32(0x00100000)
628#define FILE_ACCESS_SYSTEM_SECURITY_LE cpu_to_le32(0x01000000)
629#define FILE_MAXIMAL_ACCESS_LE cpu_to_le32(0x02000000)
630#define FILE_GENERIC_ALL_LE cpu_to_le32(0x10000000)
631#define FILE_GENERIC_EXECUTE_LE cpu_to_le32(0x20000000)
632#define FILE_GENERIC_WRITE_LE cpu_to_le32(0x40000000)
633#define FILE_GENERIC_READ_LE cpu_to_le32(0x80000000)
634
635/* ShareAccess Flags */
636#define FILE_SHARE_READ_LE cpu_to_le32(0x00000001)
637#define FILE_SHARE_WRITE_LE cpu_to_le32(0x00000002)
638#define FILE_SHARE_DELETE_LE cpu_to_le32(0x00000004)
639#define FILE_SHARE_ALL_LE cpu_to_le32(0x00000007)
640
641/* CreateDisposition Flags */
642#define FILE_SUPERSEDE_LE cpu_to_le32(0x00000000)
643#define FILE_OPEN_LE cpu_to_le32(0x00000001)
644#define FILE_CREATE_LE cpu_to_le32(0x00000002)
645#define FILE_OPEN_IF_LE cpu_to_le32(0x00000003)
646#define FILE_OVERWRITE_LE cpu_to_le32(0x00000004)
647#define FILE_OVERWRITE_IF_LE cpu_to_le32(0x00000005)
648
649/* CreateOptions Flags */
650#define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
651/* same as #define CREATE_NOT_FILE_LE cpu_to_le32(0x00000001) */
652#define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
653#define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
654#define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
655#define FILE_SYNCHRONOUS_IO_ALERT_LE cpu_to_le32(0x00000010)
656#define FILE_SYNCHRONOUS_IO_NON_ALERT_LE cpu_to_le32(0x00000020)
657#define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
658#define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
659#define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
660#define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
661#define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000)
662#define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
663#define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
664#define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
665#define FILE_RESERVE_OPFILTER_LE cpu_to_le32(0x00100000)
666#define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
667#define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
668#define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
669
670#define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
671 | FILE_READ_ATTRIBUTES_LE)
672#define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
673 | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
674#define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
675
676/* Impersonation Levels. See MS-WPO section 9.7 and MSDN-IMPERS */
677#define IL_ANONYMOUS cpu_to_le32(0x00000000)
678#define IL_IDENTIFICATION cpu_to_le32(0x00000001)
679#define IL_IMPERSONATION cpu_to_le32(0x00000002)
680#define IL_DELEGATE cpu_to_le32(0x00000003)
681
682/* Create Context Values */
683#define SMB2_CREATE_EA_BUFFER "ExtA" /* extended attributes */
684#define SMB2_CREATE_SD_BUFFER "SecD" /* security descriptor */
685#define SMB2_CREATE_DURABLE_HANDLE_REQUEST "DHnQ"
686#define SMB2_CREATE_DURABLE_HANDLE_RECONNECT "DHnC"
687#define SMB2_CREATE_ALLOCATION_SIZE "AISi"
688#define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
689#define SMB2_CREATE_TIMEWARP_REQUEST "TWrp"
690#define SMB2_CREATE_QUERY_ON_DISK_ID "QFid"
691#define SMB2_CREATE_REQUEST_LEASE "RqLs"
692#define SMB2_CREATE_DURABLE_HANDLE_REQUEST_V2 "DH2Q"
693#define SMB2_CREATE_DURABLE_HANDLE_RECONNECT_V2 "DH2C"
694#define SMB2_CREATE_APP_INSTANCE_ID 0x45BCA66AEFA7F74A9008FA462E144D74
695#define SMB2_CREATE_APP_INSTANCE_VERSION 0xB982D0B73B56074FA07B524A8116A010
696#define SVHDX_OPEN_DEVICE_CONTEX 0x9CCBCF9E04C1E643980E158DA1F6EC83
697#define SMB2_CREATE_TAG_POSIX 0x93AD25509CB411E7B42383DE968BCD7C
698
699/* Flag (SMB3 open response) values */
700#define SMB2_CREATE_FLAG_REPARSEPOINT 0x01
701
702/*
703 * Maximum number of iovs we need for an open/create request.
704 * [0] : struct smb2_create_req
705 * [1] : path
706 * [2] : lease context
707 * [3] : durable context
708 * [4] : posix context
709 * [5] : time warp context
710 * [6] : query id context
711 * [7] : compound padding
712 */
713#define SMB2_CREATE_IOV_SIZE 8
714
715struct smb2_create_req {
716 struct smb2_sync_hdr sync_hdr;
717 __le16 StructureSize; /* Must be 57 */
718 __u8 SecurityFlags;
719 __u8 RequestedOplockLevel;
720 __le32 ImpersonationLevel;
721 __le64 SmbCreateFlags;
722 __le64 Reserved;
723 __le32 DesiredAccess;
724 __le32 FileAttributes;
725 __le32 ShareAccess;
726 __le32 CreateDisposition;
727 __le32 CreateOptions;
728 __le16 NameOffset;
729 __le16 NameLength;
730 __le32 CreateContextsOffset;
731 __le32 CreateContextsLength;
732 __u8 Buffer[];
733} __packed;
734
735/*
736 * Maximum size of a SMB2_CREATE response is 64 (smb2 header) +
737 * 88 (fixed part of create response) + 520 (path) + 208 (contexts) +
738 * 2 bytes of padding.
739 */
740#define MAX_SMB2_CREATE_RESPONSE_SIZE 880
741
742struct smb2_create_rsp {
743 struct smb2_sync_hdr sync_hdr;
744 __le16 StructureSize; /* Must be 89 */
745 __u8 OplockLevel;
746 __u8 Flag; /* 0x01 if reparse point */
747 __le32 CreateAction;
748 __le64 CreationTime;
749 __le64 LastAccessTime;
750 __le64 LastWriteTime;
751 __le64 ChangeTime;
752 __le64 AllocationSize;
753 __le64 EndofFile;
754 __le32 FileAttributes;
755 __le32 Reserved2;
756 __u64 PersistentFileId; /* opaque endianness */
757 __u64 VolatileFileId; /* opaque endianness */
758 __le32 CreateContextsOffset;
759 __le32 CreateContextsLength;
760 __u8 Buffer[1];
761} __packed;
762
763struct create_context {
764 __le32 Next;
765 __le16 NameOffset;
766 __le16 NameLength;
767 __le16 Reserved;
768 __le16 DataOffset;
769 __le32 DataLength;
770 __u8 Buffer[];
771} __packed;
772
773#define SMB2_LEASE_READ_CACHING_HE 0x01
774#define SMB2_LEASE_HANDLE_CACHING_HE 0x02
775#define SMB2_LEASE_WRITE_CACHING_HE 0x04
776
777#define SMB2_LEASE_NONE cpu_to_le32(0x00)
778#define SMB2_LEASE_READ_CACHING cpu_to_le32(0x01)
779#define SMB2_LEASE_HANDLE_CACHING cpu_to_le32(0x02)
780#define SMB2_LEASE_WRITE_CACHING cpu_to_le32(0x04)
781
782#define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS cpu_to_le32(0x00000002)
783#define SMB2_LEASE_FLAG_PARENT_LEASE_KEY_SET cpu_to_le32(0x00000004)
784
785#define SMB2_LEASE_KEY_SIZE 16
786
787struct lease_context {
788 u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
789 __le32 LeaseState;
790 __le32 LeaseFlags;
791 __le64 LeaseDuration;
792} __packed;
793
794struct lease_context_v2 {
795 u8 LeaseKey[SMB2_LEASE_KEY_SIZE];
796 __le32 LeaseState;
797 __le32 LeaseFlags;
798 __le64 LeaseDuration;
799 __le64 ParentLeaseKeyLow;
800 __le64 ParentLeaseKeyHigh;
801 __le16 Epoch;
802 __le16 Reserved;
803} __packed;
804
805struct create_lease {
806 struct create_context ccontext;
807 __u8 Name[8];
808 struct lease_context lcontext;
809} __packed;
810
811struct create_lease_v2 {
812 struct create_context ccontext;
813 __u8 Name[8];
814 struct lease_context_v2 lcontext;
815 __u8 Pad[4];
816} __packed;
817
818struct create_durable {
819 struct create_context ccontext;
820 __u8 Name[8];
821 union {
822 __u8 Reserved[16];
823 struct {
824 __u64 PersistentFileId;
825 __u64 VolatileFileId;
826 } Fid;
827 } Data;
828} __packed;
829
830struct create_posix {
831 struct create_context ccontext;
832 __u8 Name[16];
833 __le32 Mode;
834 __u32 Reserved;
835} __packed;
836
837/* See MS-SMB2 2.2.13.2.11 */
838/* Flags */
839#define SMB2_DHANDLE_FLAG_PERSISTENT 0x00000002
840struct durable_context_v2 {
841 __le32 Timeout;
842 __le32 Flags;
843 __u64 Reserved;
844 __u8 CreateGuid[16];
845} __packed;
846
847struct create_durable_v2 {
848 struct create_context ccontext;
849 __u8 Name[8];
850 struct durable_context_v2 dcontext;
851} __packed;
852
853/* See MS-SMB2 2.2.13.2.12 */
854struct durable_reconnect_context_v2 {
855 struct {
856 __u64 PersistentFileId;
857 __u64 VolatileFileId;
858 } Fid;
859 __u8 CreateGuid[16];
860 __le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
861} __packed;
862
863/* See MS-SMB2 2.2.14.2.9 */
864struct create_on_disk_id {
865 struct create_context ccontext;
866 __u8 Name[8];
867 __le64 DiskFileId;
868 __le64 VolumeId;
869 __u32 Reserved[4];
870} __packed;
871
872/* See MS-SMB2 2.2.14.2.12 */
873struct durable_reconnect_context_v2_rsp {
874 __le32 Timeout;
875 __le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
876} __packed;
877
878struct create_durable_handle_reconnect_v2 {
879 struct create_context ccontext;
880 __u8 Name[8];
881 struct durable_reconnect_context_v2 dcontext;
882 __u8 Pad[4];
883} __packed;
884
885/* See MS-SMB2 2.2.13.2.5 */
886struct crt_twarp_ctxt {
887 struct create_context ccontext;
888 __u8 Name[8];
889 __le64 Timestamp;
890
891} __packed;
892
893/* See MS-SMB2 2.2.13.2.9 */
894struct crt_query_id_ctxt {
895 struct create_context ccontext;
896 __u8 Name[8];
897} __packed;
898
899struct crt_sd_ctxt {
900 struct create_context ccontext;
901 __u8 Name[8];
902 struct smb3_sd sd;
903 struct smb3_acl acl;
904 /* Followed by at least 4 ACEs */
905} __packed;
906
907
908#define COPY_CHUNK_RES_KEY_SIZE 24
909struct resume_key_req {
910 char ResumeKey[COPY_CHUNK_RES_KEY_SIZE];
911 __le32 ContextLength; /* MBZ */
912 char Context[]; /* ignored, Windows sets to 4 bytes of zero */
913} __packed;
914
915/* this goes in the ioctl buffer when doing a copychunk request */
916struct copychunk_ioctl {
917 char SourceKey[COPY_CHUNK_RES_KEY_SIZE];
918 __le32 ChunkCount; /* we are only sending 1 */
919 __le32 Reserved;
920 /* array will only be one chunk long for us */
921 __le64 SourceOffset;
922 __le64 TargetOffset;
923 __le32 Length; /* how many bytes to copy */
924 __u32 Reserved2;
925} __packed;
926
927/* this goes in the ioctl buffer when doing FSCTL_SET_ZERO_DATA */
928struct file_zero_data_information {
929 __le64 FileOffset;
930 __le64 BeyondFinalZero;
931} __packed;
932
933struct copychunk_ioctl_rsp {
934 __le32 ChunksWritten;
935 __le32 ChunkBytesWritten;
936 __le32 TotalBytesWritten;
937} __packed;
938
939struct fsctl_set_integrity_information_req {
940 __le16 ChecksumAlgorithm;
941 __le16 Reserved;
942 __le32 Flags;
943} __packed;
944
945struct fsctl_get_integrity_information_rsp {
946 __le16 ChecksumAlgorithm;
947 __le16 Reserved;
948 __le32 Flags;
949 __le32 ChecksumChunkSizeInBytes;
950 __le32 ClusterSizeInBytes;
951} __packed;
952
953struct file_allocated_range_buffer {
954 __le64 file_offset;
955 __le64 length;
956} __packed;
957
958/* Integrity ChecksumAlgorithm choices for above */
959#define CHECKSUM_TYPE_NONE 0x0000
960#define CHECKSUM_TYPE_CRC64 0x0002
961#define CHECKSUM_TYPE_UNCHANGED 0xFFFF /* set only */
962
963/* Integrity flags for above */
964#define FSCTL_INTEGRITY_FLAG_CHECKSUM_ENFORCEMENT_OFF 0x00000001
965
966/* Reparse structures - see MS-FSCC 2.1.2 */
967
968/* struct fsctl_reparse_info_req is empty, only response structs (see below) */
969
970struct reparse_data_buffer {
971 __le32 ReparseTag;
972 __le16 ReparseDataLength;
973 __u16 Reserved;
974 __u8 DataBuffer[]; /* Variable Length */
975} __packed;
976
977struct reparse_guid_data_buffer {
978 __le32 ReparseTag;
979 __le16 ReparseDataLength;
980 __u16 Reserved;
981 __u8 ReparseGuid[16];
982 __u8 DataBuffer[]; /* Variable Length */
983} __packed;
984
985struct reparse_mount_point_data_buffer {
986 __le32 ReparseTag;
987 __le16 ReparseDataLength;
988 __u16 Reserved;
989 __le16 SubstituteNameOffset;
990 __le16 SubstituteNameLength;
991 __le16 PrintNameOffset;
992 __le16 PrintNameLength;
993 __u8 PathBuffer[]; /* Variable Length */
994} __packed;
995
996#define SYMLINK_FLAG_RELATIVE 0x00000001
997
998struct reparse_symlink_data_buffer {
999 __le32 ReparseTag;
1000 __le16 ReparseDataLength;
1001 __u16 Reserved;
1002 __le16 SubstituteNameOffset;
1003 __le16 SubstituteNameLength;
1004 __le16 PrintNameOffset;
1005 __le16 PrintNameLength;
1006 __le32 Flags;
1007 __u8 PathBuffer[]; /* Variable Length */
1008} __packed;
1009
1010/* See MS-FSCC 2.1.2.6 and cifspdu.h for struct reparse_posix_data */
1011
1012
1013/* See MS-DFSC 2.2.2 */
1014struct fsctl_get_dfs_referral_req {
1015 __le16 MaxReferralLevel;
1016 __u8 RequestFileName[];
1017} __packed;
1018
1019/* DFS response is struct get_dfs_refer_rsp */
1020
1021/* See MS-SMB2 2.2.31.3 */
1022struct network_resiliency_req {
1023 __le32 Timeout;
1024 __le32 Reserved;
1025} __packed;
1026/* There is no buffer for the response ie no struct network_resiliency_rsp */
1027
1028
1029struct validate_negotiate_info_req {
1030 __le32 Capabilities;
1031 __u8 Guid[SMB2_CLIENT_GUID_SIZE];
1032 __le16 SecurityMode;
1033 __le16 DialectCount;
1034 __le16 Dialects[4]; /* BB expand this if autonegotiate > 4 dialects */
1035} __packed;
1036
1037struct validate_negotiate_info_rsp {
1038 __le32 Capabilities;
1039 __u8 Guid[SMB2_CLIENT_GUID_SIZE];
1040 __le16 SecurityMode;
1041 __le16 Dialect; /* Dialect in use for the connection */
1042} __packed;
1043
1044#define RSS_CAPABLE cpu_to_le32(0x00000001)
1045#define RDMA_CAPABLE cpu_to_le32(0x00000002)
1046
1047#define INTERNETWORK cpu_to_le16(0x0002)
1048#define INTERNETWORKV6 cpu_to_le16(0x0017)
1049
1050struct network_interface_info_ioctl_rsp {
1051 __le32 Next; /* next interface. zero if this is last one */
1052 __le32 IfIndex;
1053 __le32 Capability; /* RSS or RDMA Capable */
1054 __le32 Reserved;
1055 __le64 LinkSpeed;
1056 __le16 Family;
1057 __u8 Buffer[126];
1058} __packed;
1059
1060struct iface_info_ipv4 {
1061 __be16 Port;
1062 __be32 IPv4Address;
1063 __be64 Reserved;
1064} __packed;
1065
1066struct iface_info_ipv6 {
1067 __be16 Port;
1068 __be32 FlowInfo;
1069 __u8 IPv6Address[16];
1070 __be32 ScopeId;
1071} __packed;
1072
1073#define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
1074
1075struct compress_ioctl {
1076 __le16 CompressionState; /* See cifspdu.h for possible flag values */
1077} __packed;
1078
1079struct duplicate_extents_to_file {
1080 __u64 PersistentFileHandle; /* source file handle, opaque endianness */
1081 __u64 VolatileFileHandle;
1082 __le64 SourceFileOffset;
1083 __le64 TargetFileOffset;
1084 __le64 ByteCount; /* Bytes to be copied */
1085} __packed;
1086
1087/*
1088 * Maximum number of iovs we need for an ioctl request.
1089 * [0] : struct smb2_ioctl_req
1090 * [1] : in_data
1091 */
1092#define SMB2_IOCTL_IOV_SIZE 2
1093
1094struct smb2_ioctl_req {
1095 struct smb2_sync_hdr sync_hdr;
1096 __le16 StructureSize; /* Must be 57 */
1097 __u16 Reserved;
1098 __le32 CtlCode;
1099 __u64 PersistentFileId; /* opaque endianness */
1100 __u64 VolatileFileId; /* opaque endianness */
1101 __le32 InputOffset;
1102 __le32 InputCount;
1103 __le32 MaxInputResponse;
1104 __le32 OutputOffset;
1105 __le32 OutputCount;
1106 __le32 MaxOutputResponse;
1107 __le32 Flags;
1108 __u32 Reserved2;
1109 __u8 Buffer[];
1110} __packed;
1111
1112struct smb2_ioctl_rsp {
1113 struct smb2_sync_hdr sync_hdr;
1114 __le16 StructureSize; /* Must be 57 */
1115 __u16 Reserved;
1116 __le32 CtlCode;
1117 __u64 PersistentFileId; /* opaque endianness */
1118 __u64 VolatileFileId; /* opaque endianness */
1119 __le32 InputOffset;
1120 __le32 InputCount;
1121 __le32 OutputOffset;
1122 __le32 OutputCount;
1123 __le32 Flags;
1124 __u32 Reserved2;
1125 /* char * buffer[] */
1126} __packed;
1127
1128/* Currently defined values for close flags */
1129#define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
1130struct smb2_close_req {
1131 struct smb2_sync_hdr sync_hdr;
1132 __le16 StructureSize; /* Must be 24 */
1133 __le16 Flags;
1134 __le32 Reserved;
1135 __u64 PersistentFileId; /* opaque endianness */
1136 __u64 VolatileFileId; /* opaque endianness */
1137} __packed;
1138
1139/*
1140 * Maximum size of a SMB2_CLOSE response is 64 (smb2 header) + 60 (data)
1141 */
1142#define MAX_SMB2_CLOSE_RESPONSE_SIZE 124
1143
1144struct smb2_close_rsp {
1145 struct smb2_sync_hdr sync_hdr;
1146 __le16 StructureSize; /* 60 */
1147 __le16 Flags;
1148 __le32 Reserved;
1149 __le64 CreationTime;
1150 __le64 LastAccessTime;
1151 __le64 LastWriteTime;
1152 __le64 ChangeTime;
1153 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
1154 __le64 EndOfFile;
1155 __le32 Attributes;
1156} __packed;
1157
1158struct smb2_flush_req {
1159 struct smb2_sync_hdr sync_hdr;
1160 __le16 StructureSize; /* Must be 24 */
1161 __le16 Reserved1;
1162 __le32 Reserved2;
1163 __u64 PersistentFileId; /* opaque endianness */
1164 __u64 VolatileFileId; /* opaque endianness */
1165} __packed;
1166
1167struct smb2_flush_rsp {
1168 struct smb2_sync_hdr sync_hdr;
1169 __le16 StructureSize;
1170 __le16 Reserved;
1171} __packed;
1172
1173/* For read request Flags field below, following flag is defined for SMB3.02 */
1174#define SMB2_READFLAG_READ_UNBUFFERED 0x01
1175#define SMB2_READFLAG_REQUEST_COMPRESSED 0x02 /* See MS-SMB2 2.2.19 */
1176
1177/* Channel field for read and write: exactly one of following flags can be set*/
1178#define SMB2_CHANNEL_NONE cpu_to_le32(0x00000000)
1179#define SMB2_CHANNEL_RDMA_V1 cpu_to_le32(0x00000001) /* SMB3 or later */
1180#define SMB2_CHANNEL_RDMA_V1_INVALIDATE cpu_to_le32(0x00000002) /* >= SMB3.02 */
1181
1182/* SMB2 read request without RFC1001 length at the beginning */
1183struct smb2_read_plain_req {
1184 struct smb2_sync_hdr sync_hdr;
1185 __le16 StructureSize; /* Must be 49 */
1186 __u8 Padding; /* offset from start of SMB2 header to place read */
1187 __u8 Flags; /* MBZ unless SMB3.02 or later */
1188 __le32 Length;
1189 __le64 Offset;
1190 __u64 PersistentFileId; /* opaque endianness */
1191 __u64 VolatileFileId; /* opaque endianness */
1192 __le32 MinimumCount;
1193 __le32 Channel; /* MBZ except for SMB3 or later */
1194 __le32 RemainingBytes;
1195 __le16 ReadChannelInfoOffset;
1196 __le16 ReadChannelInfoLength;
1197 __u8 Buffer[1];
1198} __packed;
1199
1200struct smb2_read_rsp {
1201 struct smb2_sync_hdr sync_hdr;
1202 __le16 StructureSize; /* Must be 17 */
1203 __u8 DataOffset;
1204 __u8 Reserved;
1205 __le32 DataLength;
1206 __le32 DataRemaining;
1207 __u32 Reserved2;
1208 __u8 Buffer[1];
1209} __packed;
1210
1211/* For write request Flags field below the following flags are defined: */
1212#define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
1213#define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
1214
1215struct smb2_write_req {
1216 struct smb2_sync_hdr sync_hdr;
1217 __le16 StructureSize; /* Must be 49 */
1218 __le16 DataOffset; /* offset from start of SMB2 header to write data */
1219 __le32 Length;
1220 __le64 Offset;
1221 __u64 PersistentFileId; /* opaque endianness */
1222 __u64 VolatileFileId; /* opaque endianness */
1223 __le32 Channel; /* MBZ unless SMB3.02 or later */
1224 __le32 RemainingBytes;
1225 __le16 WriteChannelInfoOffset;
1226 __le16 WriteChannelInfoLength;
1227 __le32 Flags;
1228 __u8 Buffer[1];
1229} __packed;
1230
1231struct smb2_write_rsp {
1232 struct smb2_sync_hdr sync_hdr;
1233 __le16 StructureSize; /* Must be 17 */
1234 __u8 DataOffset;
1235 __u8 Reserved;
1236 __le32 DataLength;
1237 __le32 DataRemaining;
1238 __u32 Reserved2;
1239 __u8 Buffer[1];
1240} __packed;
1241
1242/* notify flags */
1243#define SMB2_WATCH_TREE 0x0001
1244
1245/* notify completion filter flags. See MS-FSCC 2.6 and MS-SMB2 2.2.35 */
1246#define FILE_NOTIFY_CHANGE_FILE_NAME 0x00000001
1247#define FILE_NOTIFY_CHANGE_DIR_NAME 0x00000002
1248#define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x00000004
1249#define FILE_NOTIFY_CHANGE_SIZE 0x00000008
1250#define FILE_NOTIFY_CHANGE_LAST_WRITE 0x00000010
1251#define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x00000020
1252#define FILE_NOTIFY_CHANGE_CREATION 0x00000040
1253#define FILE_NOTIFY_CHANGE_EA 0x00000080
1254#define FILE_NOTIFY_CHANGE_SECURITY 0x00000100
1255#define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
1256#define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
1257#define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
1258
1259struct smb2_change_notify_req {
1260 struct smb2_sync_hdr sync_hdr;
1261 __le16 StructureSize;
1262 __le16 Flags;
1263 __le32 OutputBufferLength;
1264 __u64 PersistentFileId; /* opaque endianness */
1265 __u64 VolatileFileId; /* opaque endianness */
1266 __le32 CompletionFilter;
1267 __u32 Reserved;
1268} __packed;
1269
1270struct smb2_change_notify_rsp {
1271 struct smb2_sync_hdr sync_hdr;
1272 __le16 StructureSize; /* Must be 9 */
1273 __le16 OutputBufferOffset;
1274 __le32 OutputBufferLength;
1275 __u8 Buffer[1]; /* array of file notify structs */
1276} __packed;
1277
1278#define SMB2_LOCKFLAG_SHARED_LOCK 0x0001
1279#define SMB2_LOCKFLAG_EXCLUSIVE_LOCK 0x0002
1280#define SMB2_LOCKFLAG_UNLOCK 0x0004
1281#define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
1282
1283struct smb2_lock_element {
1284 __le64 Offset;
1285 __le64 Length;
1286 __le32 Flags;
1287 __le32 Reserved;
1288} __packed;
1289
1290struct smb2_lock_req {
1291 struct smb2_sync_hdr sync_hdr;
1292 __le16 StructureSize; /* Must be 48 */
1293 __le16 LockCount;
1294 __le32 Reserved;
1295 __u64 PersistentFileId; /* opaque endianness */
1296 __u64 VolatileFileId; /* opaque endianness */
1297 /* Followed by at least one */
1298 struct smb2_lock_element locks[1];
1299} __packed;
1300
1301struct smb2_lock_rsp {
1302 struct smb2_sync_hdr sync_hdr;
1303 __le16 StructureSize; /* Must be 4 */
1304 __le16 Reserved;
1305} __packed;
1306
1307struct smb2_echo_req {
1308 struct smb2_sync_hdr sync_hdr;
1309 __le16 StructureSize; /* Must be 4 */
1310 __u16 Reserved;
1311} __packed;
1312
1313struct smb2_echo_rsp {
1314 struct smb2_sync_hdr sync_hdr;
1315 __le16 StructureSize; /* Must be 4 */
1316 __u16 Reserved;
1317} __packed;
1318
1319/* search (query_directory) Flags field */
1320#define SMB2_RESTART_SCANS 0x01
1321#define SMB2_RETURN_SINGLE_ENTRY 0x02
1322#define SMB2_INDEX_SPECIFIED 0x04
1323#define SMB2_REOPEN 0x10
1324
1325#define SMB2_QUERY_DIRECTORY_IOV_SIZE 2
1326
1327struct smb2_query_directory_req {
1328 struct smb2_sync_hdr sync_hdr;
1329 __le16 StructureSize; /* Must be 33 */
1330 __u8 FileInformationClass;
1331 __u8 Flags;
1332 __le32 FileIndex;
1333 __u64 PersistentFileId; /* opaque endianness */
1334 __u64 VolatileFileId; /* opaque endianness */
1335 __le16 FileNameOffset;
1336 __le16 FileNameLength;
1337 __le32 OutputBufferLength;
1338 __u8 Buffer[1];
1339} __packed;
1340
1341struct smb2_query_directory_rsp {
1342 struct smb2_sync_hdr sync_hdr;
1343 __le16 StructureSize; /* Must be 9 */
1344 __le16 OutputBufferOffset;
1345 __le32 OutputBufferLength;
1346 __u8 Buffer[1];
1347} __packed;
1348
1349/* Possible InfoType values */
1350#define SMB2_O_INFO_FILE 0x01
1351#define SMB2_O_INFO_FILESYSTEM 0x02
1352#define SMB2_O_INFO_SECURITY 0x03
1353#define SMB2_O_INFO_QUOTA 0x04
1354
1355/* Security info type additionalinfo flags. See MS-SMB2 (2.2.37) or MS-DTYP */
1356#define OWNER_SECINFO 0x00000001
1357#define GROUP_SECINFO 0x00000002
1358#define DACL_SECINFO 0x00000004
1359#define SACL_SECINFO 0x00000008
1360#define LABEL_SECINFO 0x00000010
1361#define ATTRIBUTE_SECINFO 0x00000020
1362#define SCOPE_SECINFO 0x00000040
1363#define BACKUP_SECINFO 0x00010000
1364#define UNPROTECTED_SACL_SECINFO 0x10000000
1365#define UNPROTECTED_DACL_SECINFO 0x20000000
1366#define PROTECTED_SACL_SECINFO 0x40000000
1367#define PROTECTED_DACL_SECINFO 0x80000000
1368
1369/* Flags used for FileFullEAinfo */
1370#define SL_RESTART_SCAN 0x00000001
1371#define SL_RETURN_SINGLE_ENTRY 0x00000002
1372#define SL_INDEX_SPECIFIED 0x00000004
1373
1374struct smb2_query_info_req {
1375 struct smb2_sync_hdr sync_hdr;
1376 __le16 StructureSize; /* Must be 41 */
1377 __u8 InfoType;
1378 __u8 FileInfoClass;
1379 __le32 OutputBufferLength;
1380 __le16 InputBufferOffset;
1381 __u16 Reserved;
1382 __le32 InputBufferLength;
1383 __le32 AdditionalInformation;
1384 __le32 Flags;
1385 __u64 PersistentFileId; /* opaque endianness */
1386 __u64 VolatileFileId; /* opaque endianness */
1387 __u8 Buffer[1];
1388} __packed;
1389
1390struct smb2_query_info_rsp {
1391 struct smb2_sync_hdr sync_hdr;
1392 __le16 StructureSize; /* Must be 9 */
1393 __le16 OutputBufferOffset;
1394 __le32 OutputBufferLength;
1395 __u8 Buffer[1];
1396} __packed;
1397
1398/*
1399 * Maximum number of iovs we need for a set-info request.
1400 * The largest one is rename/hardlink
1401 * [0] : struct smb2_set_info_req + smb2_file_[rename|link]_info
1402 * [1] : path
1403 * [2] : compound padding
1404 */
1405#define SMB2_SET_INFO_IOV_SIZE 3
1406
1407struct smb2_set_info_req {
1408 struct smb2_sync_hdr sync_hdr;
1409 __le16 StructureSize; /* Must be 33 */
1410 __u8 InfoType;
1411 __u8 FileInfoClass;
1412 __le32 BufferLength;
1413 __le16 BufferOffset;
1414 __u16 Reserved;
1415 __le32 AdditionalInformation;
1416 __u64 PersistentFileId; /* opaque endianness */
1417 __u64 VolatileFileId; /* opaque endianness */
1418 __u8 Buffer[1];
1419} __packed;
1420
1421struct smb2_set_info_rsp {
1422 struct smb2_sync_hdr sync_hdr;
1423 __le16 StructureSize; /* Must be 2 */
1424} __packed;
1425
1426struct smb2_oplock_break {
1427 struct smb2_sync_hdr sync_hdr;
1428 __le16 StructureSize; /* Must be 24 */
1429 __u8 OplockLevel;
1430 __u8 Reserved;
1431 __le32 Reserved2;
1432 __u64 PersistentFid;
1433 __u64 VolatileFid;
1434} __packed;
1435
1436#define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
1437
1438struct smb2_lease_break {
1439 struct smb2_sync_hdr sync_hdr;
1440 __le16 StructureSize; /* Must be 44 */
1441 __le16 Epoch;
1442 __le32 Flags;
1443 __u8 LeaseKey[16];
1444 __le32 CurrentLeaseState;
1445 __le32 NewLeaseState;
1446 __le32 BreakReason;
1447 __le32 AccessMaskHint;
1448 __le32 ShareMaskHint;
1449} __packed;
1450
1451struct smb2_lease_ack {
1452 struct smb2_sync_hdr sync_hdr;
1453 __le16 StructureSize; /* Must be 36 */
1454 __le16 Reserved;
1455 __le32 Flags;
1456 __u8 LeaseKey[16];
1457 __le32 LeaseState;
1458 __le64 LeaseDuration;
1459} __packed;
1460
1461/*
1462 * PDU infolevel structure definitions
1463 * BB consider moving to a different header
1464 */
1465
1466/* File System Information Classes */
1467#define FS_VOLUME_INFORMATION 1 /* Query */
1468#define FS_LABEL_INFORMATION 2 /* Local only */
1469#define FS_SIZE_INFORMATION 3 /* Query */
1470#define FS_DEVICE_INFORMATION 4 /* Query */
1471#define FS_ATTRIBUTE_INFORMATION 5 /* Query */
1472#define FS_CONTROL_INFORMATION 6 /* Query, Set */
1473#define FS_FULL_SIZE_INFORMATION 7 /* Query */
1474#define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
1475#define FS_DRIVER_PATH_INFORMATION 9 /* Local only */
1476#define FS_VOLUME_FLAGS_INFORMATION 10 /* Local only */
1477#define FS_SECTOR_SIZE_INFORMATION 11 /* SMB3 or later. Query */
1478#define FS_POSIX_INFORMATION 100 /* SMB3.1.1 POSIX. Query */
1479
1480struct smb2_fs_full_size_info {
1481 __le64 TotalAllocationUnits;
1482 __le64 CallerAvailableAllocationUnits;
1483 __le64 ActualAvailableAllocationUnits;
1484 __le32 SectorsPerAllocationUnit;
1485 __le32 BytesPerSector;
1486} __packed;
1487
1488#define SSINFO_FLAGS_ALIGNED_DEVICE 0x00000001
1489#define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
1490#define SSINFO_FLAGS_NO_SEEK_PENALTY 0x00000004
1491#define SSINFO_FLAGS_TRIM_ENABLED 0x00000008
1492
1493/* sector size info struct */
1494struct smb3_fs_ss_info {
1495 __le32 LogicalBytesPerSector;
1496 __le32 PhysicalBytesPerSectorForAtomicity;
1497 __le32 PhysicalBytesPerSectorForPerf;
1498 __le32 FileSystemEffectivePhysicalBytesPerSectorForAtomicity;
1499 __le32 Flags;
1500 __le32 ByteOffsetForSectorAlignment;
1501 __le32 ByteOffsetForPartitionAlignment;
1502} __packed;
1503
1504/* volume info struct - see MS-FSCC 2.5.9 */
1505#define MAX_VOL_LABEL_LEN 32
1506struct smb3_fs_vol_info {
1507 __le64 VolumeCreationTime;
1508 __u32 VolumeSerialNumber;
1509 __le32 VolumeLabelLength; /* includes trailing null */
1510 __u8 SupportsObjects; /* True if eg like NTFS, supports objects */
1511 __u8 Reserved;
1512 __u8 VolumeLabel[]; /* variable len */
1513} __packed;
1514
1515/* partial list of QUERY INFO levels */
1516#define FILE_DIRECTORY_INFORMATION 1
1517#define FILE_FULL_DIRECTORY_INFORMATION 2
1518#define FILE_BOTH_DIRECTORY_INFORMATION 3
1519#define FILE_BASIC_INFORMATION 4
1520#define FILE_STANDARD_INFORMATION 5
1521#define FILE_INTERNAL_INFORMATION 6
1522#define FILE_EA_INFORMATION 7
1523#define FILE_ACCESS_INFORMATION 8
1524#define FILE_NAME_INFORMATION 9
1525#define FILE_RENAME_INFORMATION 10
1526#define FILE_LINK_INFORMATION 11
1527#define FILE_NAMES_INFORMATION 12
1528#define FILE_DISPOSITION_INFORMATION 13
1529#define FILE_POSITION_INFORMATION 14
1530#define FILE_FULL_EA_INFORMATION 15
1531#define FILE_MODE_INFORMATION 16
1532#define FILE_ALIGNMENT_INFORMATION 17
1533#define FILE_ALL_INFORMATION 18
1534#define FILE_ALLOCATION_INFORMATION 19
1535#define FILE_END_OF_FILE_INFORMATION 20
1536#define FILE_ALTERNATE_NAME_INFORMATION 21
1537#define FILE_STREAM_INFORMATION 22
1538#define FILE_PIPE_INFORMATION 23
1539#define FILE_PIPE_LOCAL_INFORMATION 24
1540#define FILE_PIPE_REMOTE_INFORMATION 25
1541#define FILE_MAILSLOT_QUERY_INFORMATION 26
1542#define FILE_MAILSLOT_SET_INFORMATION 27
1543#define FILE_COMPRESSION_INFORMATION 28
1544#define FILE_OBJECT_ID_INFORMATION 29
1545/* Number 30 not defined in documents */
1546#define FILE_MOVE_CLUSTER_INFORMATION 31
1547#define FILE_QUOTA_INFORMATION 32
1548#define FILE_REPARSE_POINT_INFORMATION 33
1549#define FILE_NETWORK_OPEN_INFORMATION 34
1550#define FILE_ATTRIBUTE_TAG_INFORMATION 35
1551#define FILE_TRACKING_INFORMATION 36
1552#define FILEID_BOTH_DIRECTORY_INFORMATION 37
1553#define FILEID_FULL_DIRECTORY_INFORMATION 38
1554#define FILE_VALID_DATA_LENGTH_INFORMATION 39
1555#define FILE_SHORT_NAME_INFORMATION 40
1556#define FILE_SFIO_RESERVE_INFORMATION 44
1557#define FILE_SFIO_VOLUME_INFORMATION 45
1558#define FILE_HARD_LINK_INFORMATION 46
1559#define FILE_NORMALIZED_NAME_INFORMATION 48
1560#define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
1561#define FILE_STANDARD_LINK_INFORMATION 54
1562#define FILE_ID_INFORMATION 59
1563
1564struct smb2_file_internal_info {
1565 __le64 IndexNumber;
1566} __packed; /* level 6 Query */
1567
1568struct smb2_file_rename_info { /* encoding of request for level 10 */
1569 __u8 ReplaceIfExists; /* 1 = replace existing target with new */
1570 /* 0 = fail if target already exists */
1571 __u8 Reserved[7];
1572 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
1573 __le32 FileNameLength;
1574 char FileName[]; /* New name to be assigned */
1575} __packed; /* level 10 Set */
1576
1577struct smb2_file_link_info { /* encoding of request for level 11 */
1578 __u8 ReplaceIfExists; /* 1 = replace existing link with new */
1579 /* 0 = fail if link already exists */
1580 __u8 Reserved[7];
1581 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
1582 __le32 FileNameLength;
1583 char FileName[]; /* Name to be assigned to new link */
1584} __packed; /* level 11 Set */
1585
1586struct smb2_file_full_ea_info { /* encoding of response for level 15 */
1587 __le32 next_entry_offset;
1588 __u8 flags;
1589 __u8 ea_name_length;
1590 __le16 ea_value_length;
1591 char ea_data[]; /* \0 terminated name plus value */
1592} __packed; /* level 15 Set */
1593
1594/*
1595 * This level 18, although with struct with same name is different from cifs
1596 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
1597 * CurrentByteOffset.
1598 */
1599struct smb2_file_all_info { /* data block encoding of response to level 18 */
1600 __le64 CreationTime; /* Beginning of FILE_BASIC_INFO equivalent */
1601 __le64 LastAccessTime;
1602 __le64 LastWriteTime;
1603 __le64 ChangeTime;
1604 __le32 Attributes;
1605 __u32 Pad1; /* End of FILE_BASIC_INFO_INFO equivalent */
1606 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
1607 __le64 EndOfFile; /* size ie offset to first free byte in file */
1608 __le32 NumberOfLinks; /* hard links */
1609 __u8 DeletePending;
1610 __u8 Directory;
1611 __u16 Pad2; /* End of FILE_STANDARD_INFO equivalent */
1612 __le64 IndexNumber;
1613 __le32 EASize;
1614 __le32 AccessFlags;
1615 __le64 CurrentByteOffset;
1616 __le32 Mode;
1617 __le32 AlignmentRequirement;
1618 __le32 FileNameLength;
1619 char FileName[1];
1620} __packed; /* level 18 Query */
1621
1622struct smb2_file_eof_info { /* encoding of request for level 10 */
1623 __le64 EndOfFile; /* new end of file value */
1624} __packed; /* level 20 Set */
1625
1626struct smb2_file_network_open_info {
1627 __le64 CreationTime;
1628 __le64 LastAccessTime;
1629 __le64 LastWriteTime;
1630 __le64 ChangeTime;
1631 __le64 AllocationSize;
1632 __le64 EndOfFile;
1633 __le32 Attributes;
1634 __le32 Reserved;
1635} __packed; /* level 34 Query also similar returned in close rsp and open rsp */
1636
1637/* See MS-FSCC 2.4.43 */
1638struct smb2_file_id_information {
1639 __le64 VolumeSerialNumber;
1640 __u64 PersistentFileId; /* opaque endianness */
1641 __u64 VolatileFileId; /* opaque endianness */
1642} __packed; /* level 59 */
1643
1644extern char smb2_padding[7];
1645
1646/* equivalent of the contents of SMB3.1.1 POSIX open context response */
1647struct create_posix_rsp {
1648 u32 nlink;
1649 u32 reparse_tag;
1650 u32 mode;
1651 struct cifs_sid owner; /* var-sized on the wire */
1652 struct cifs_sid group; /* var-sized on the wire */
1653} __packed;
1654
1655/*
1656 * SMB2-only POSIX info level for query dir
1657 *
1658 * See posix_info_sid_size(), posix_info_extra_size() and
1659 * posix_info_parse() to help with the handling of this struct.
1660 */
1661struct smb2_posix_info {
1662 __le32 NextEntryOffset;
1663 __u32 Ignored;
1664 __le64 CreationTime;
1665 __le64 LastAccessTime;
1666 __le64 LastWriteTime;
1667 __le64 ChangeTime;
1668 __le64 EndOfFile;
1669 __le64 AllocationSize;
1670 __le32 DosAttributes;
1671 __le64 Inode;
1672 __le32 DeviceId;
1673 __le32 Zero;
1674 /* beginning of POSIX Create Context Response */
1675 __le32 HardLinks;
1676 __le32 ReparseTag;
1677 __le32 Mode;
1678 /*
1679 * var sized owner SID
1680 * var sized group SID
1681 * le32 filenamelength
1682 * u8 filename[]
1683 */
1684} __packed;
1685
1686/* Level 100 query info */
1687struct smb311_posix_qinfo {
1688 __le64 CreationTime;
1689 __le64 LastAccessTime;
1690 __le64 LastWriteTime;
1691 __le64 ChangeTime;
1692 __le64 EndOfFile;
1693 __le64 AllocationSize;
1694 __le32 DosAttributes;
1695 __le64 Inode;
1696 __le32 DeviceId;
1697 __le32 Zero;
1698 /* beginning of POSIX Create Context Response */
1699 __le32 HardLinks;
1700 __le32 ReparseTag;
1701 __le32 Mode;
1702 u8 Sids[];
1703 /*
1704 * var sized owner SID
1705 * var sized group SID
1706 * le32 filenamelength
1707 * u8 filename[]
1708 */
1709} __packed;
1710
1711/*
1712 * Parsed version of the above struct. Allows direct access to the
1713 * variable length fields
1714 */
1715struct smb2_posix_info_parsed {
1716 const struct smb2_posix_info *base;
1717 size_t size;
1718 struct cifs_sid owner;
1719 struct cifs_sid group;
1720 int name_len;
1721 const u8 *name;
1722};
1723
1724#endif /* _SMB2PDU_H */