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
29/*
30 * Note that, due to trying to use names similar to the protocol specifications,
31 * there are many mixed case field names in the structures below. Although
32 * this does not match typical Linux kernel style, it is necessary to be
33 * be able to match against the protocol specfication.
34 *
35 * SMB2 commands
36 * Some commands have minimal (wct=0,bcc=0), or uninteresting, responses
37 * (ie no useful data other than the SMB error code itself) and are marked such.
38 * Knowing this helps avoid response buffer allocations and copy in some cases.
39 */
40
41/* List of commands in host endian */
42#define SMB2_NEGOTIATE_HE 0x0000
43#define SMB2_SESSION_SETUP_HE 0x0001
44#define SMB2_LOGOFF_HE 0x0002 /* trivial request/resp */
45#define SMB2_TREE_CONNECT_HE 0x0003
46#define SMB2_TREE_DISCONNECT_HE 0x0004 /* trivial req/resp */
47#define SMB2_CREATE_HE 0x0005
48#define SMB2_CLOSE_HE 0x0006
49#define SMB2_FLUSH_HE 0x0007 /* trivial resp */
50#define SMB2_READ_HE 0x0008
51#define SMB2_WRITE_HE 0x0009
52#define SMB2_LOCK_HE 0x000A
53#define SMB2_IOCTL_HE 0x000B
54#define SMB2_CANCEL_HE 0x000C
55#define SMB2_ECHO_HE 0x000D
56#define SMB2_QUERY_DIRECTORY_HE 0x000E
57#define SMB2_CHANGE_NOTIFY_HE 0x000F
58#define SMB2_QUERY_INFO_HE 0x0010
59#define SMB2_SET_INFO_HE 0x0011
60#define SMB2_OPLOCK_BREAK_HE 0x0012
61
62/* The same list in little endian */
63#define SMB2_NEGOTIATE cpu_to_le16(SMB2_NEGOTIATE_HE)
64#define SMB2_SESSION_SETUP cpu_to_le16(SMB2_SESSION_SETUP_HE)
65#define SMB2_LOGOFF cpu_to_le16(SMB2_LOGOFF_HE)
66#define SMB2_TREE_CONNECT cpu_to_le16(SMB2_TREE_CONNECT_HE)
67#define SMB2_TREE_DISCONNECT cpu_to_le16(SMB2_TREE_DISCONNECT_HE)
68#define SMB2_CREATE cpu_to_le16(SMB2_CREATE_HE)
69#define SMB2_CLOSE cpu_to_le16(SMB2_CLOSE_HE)
70#define SMB2_FLUSH cpu_to_le16(SMB2_FLUSH_HE)
71#define SMB2_READ cpu_to_le16(SMB2_READ_HE)
72#define SMB2_WRITE cpu_to_le16(SMB2_WRITE_HE)
73#define SMB2_LOCK cpu_to_le16(SMB2_LOCK_HE)
74#define SMB2_IOCTL cpu_to_le16(SMB2_IOCTL_HE)
75#define SMB2_CANCEL cpu_to_le16(SMB2_CANCEL_HE)
76#define SMB2_ECHO cpu_to_le16(SMB2_ECHO_HE)
77#define SMB2_QUERY_DIRECTORY cpu_to_le16(SMB2_QUERY_DIRECTORY_HE)
78#define SMB2_CHANGE_NOTIFY cpu_to_le16(SMB2_CHANGE_NOTIFY_HE)
79#define SMB2_QUERY_INFO cpu_to_le16(SMB2_QUERY_INFO_HE)
80#define SMB2_SET_INFO cpu_to_le16(SMB2_SET_INFO_HE)
81#define SMB2_OPLOCK_BREAK cpu_to_le16(SMB2_OPLOCK_BREAK_HE)
82
83#define SMB2_INTERNAL_CMD cpu_to_le16(0xFFFF)
84
85#define NUMBER_OF_SMB2_COMMANDS 0x0013
86
87/* 4 len + 52 transform hdr + 64 hdr + 56 create rsp */
88#define MAX_SMB2_HDR_SIZE 0x00b0
89
90#define SMB2_PROTO_NUMBER cpu_to_le32(0x424d53fe)
91#define SMB2_TRANSFORM_PROTO_NUM cpu_to_le32(0x424d53fd)
92
93/*
94 * SMB2 Header Definition
95 *
96 * "MBZ" : Must be Zero
97 * "BB" : BugBug, Something to check/review/analyze later
98 * "PDU" : "Protocol Data Unit" (ie a network "frame")
99 *
100 */
101
102#define SMB2_HEADER_STRUCTURE_SIZE cpu_to_le16(64)
103
104struct smb2_sync_hdr {
105 __le32 ProtocolId; /* 0xFE 'S' 'M' 'B' */
106 __le16 StructureSize; /* 64 */
107 __le16 CreditCharge; /* MBZ */
108 __le32 Status; /* Error from server */
109 __le16 Command;
110 __le16 CreditRequest; /* CreditResponse */
111 __le32 Flags;
112 __le32 NextCommand;
113 __le64 MessageId;
114 __le32 ProcessId;
115 __u32 TreeId; /* opaque - so do not make little endian */
116 __u64 SessionId; /* opaque - so do not make little endian */
117 __u8 Signature[16];
118} __packed;
119
120struct smb2_sync_pdu {
121 struct smb2_sync_hdr sync_hdr;
122 __le16 StructureSize2; /* size of wct area (varies, request specific) */
123} __packed;
124
125struct smb2_hdr {
126 __be32 smb2_buf_length; /* big endian on wire */
127 /* length is only two or three bytes - with */
128 /* one or two byte type preceding it that MBZ */
129 struct smb2_sync_hdr sync_hdr;
130} __packed;
131
132struct smb2_pdu {
133 struct smb2_hdr hdr;
134 __le16 StructureSize2; /* size of wct area (varies, request specific) */
135} __packed;
136
137#define SMB3_AES128CMM_NONCE 11
138#define SMB3_AES128GCM_NONCE 12
139
140struct smb2_transform_hdr {
141 __be32 smb2_buf_length; /* big endian on wire */
142 /* length is only two or three bytes - with
143 one or two byte type preceding it that MBZ */
144 __le32 ProtocolId; /* 0xFD 'S' 'M' 'B' */
145 __u8 Signature[16];
146 __u8 Nonce[16];
147 __le32 OriginalMessageSize;
148 __u16 Reserved1;
149 __le16 Flags; /* EncryptionAlgorithm */
150 __u64 SessionId;
151} __packed;
152
153/*
154 * SMB2 flag definitions
155 */
156#define SMB2_FLAGS_SERVER_TO_REDIR cpu_to_le32(0x00000001)
157#define SMB2_FLAGS_ASYNC_COMMAND cpu_to_le32(0x00000002)
158#define SMB2_FLAGS_RELATED_OPERATIONS cpu_to_le32(0x00000004)
159#define SMB2_FLAGS_SIGNED cpu_to_le32(0x00000008)
160#define SMB2_FLAGS_DFS_OPERATIONS cpu_to_le32(0x10000000)
161
162/*
163 * Definitions for SMB2 Protocol Data Units (network frames)
164 *
165 * See MS-SMB2.PDF specification for protocol details.
166 * The Naming convention is the lower case version of the SMB2
167 * command code name for the struct. Note that structures must be packed.
168 *
169 */
170
171#define SMB2_ERROR_STRUCTURE_SIZE2 cpu_to_le16(9)
172
173struct smb2_err_rsp {
174 struct smb2_hdr hdr;
175 __le16 StructureSize;
176 __le16 Reserved; /* MBZ */
177 __le32 ByteCount; /* even if zero, at least one byte follows */
178 __u8 ErrorData[1]; /* variable length */
179} __packed;
180
181struct smb2_symlink_err_rsp {
182 __le32 SymLinkLength;
183 __le32 SymLinkErrorTag;
184 __le32 ReparseTag;
185 __le16 ReparseDataLength;
186 __le16 UnparsedPathLength;
187 __le16 SubstituteNameOffset;
188 __le16 SubstituteNameLength;
189 __le16 PrintNameOffset;
190 __le16 PrintNameLength;
191 __le32 Flags;
192 __u8 PathBuffer[0];
193} __packed;
194
195/* SMB 3.1.1 and later dialects. See MS-SMB2 section 2.2.2.1 */
196struct smb2_error_context_rsp {
197 __le32 ErrorDataLength;
198 __le32 ErrorId;
199 __u8 ErrorContextData; /* ErrorDataLength long array */
200} __packed;
201
202/* Defines for Type field below (see MS-SMB2 2.2.2.2.2.1) */
203#define MOVE_DST_IPADDR_V4 cpu_to_le32(0x00000001)
204#define MOVE_DST_IPADDR_V6 cpu_to_le32(0x00000002)
205
206struct move_dst_ipaddr {
207 __le32 Type;
208 __u32 Reserved;
209 __u8 address[16]; /* IPv4 followed by 12 bytes rsvd or IPv6 address */
210} __packed;
211
212struct share_redirect_error_context_rsp {
213 __le32 StructureSize;
214 __le32 NotificationType;
215 __le32 ResourceNameOffset;
216 __le32 ResourceNameLength;
217 __le16 Flags;
218 __le16 TargetType;
219 __le32 IPAddrCount;
220 struct move_dst_ipaddr IpAddrMoveList[0];
221 /* __u8 ResourceName[] */ /* Name of share as counted Unicode string */
222} __packed;
223
224#define SMB2_CLIENT_GUID_SIZE 16
225
226struct smb2_negotiate_req {
227 struct smb2_sync_hdr sync_hdr;
228 __le16 StructureSize; /* Must be 36 */
229 __le16 DialectCount;
230 __le16 SecurityMode;
231 __le16 Reserved; /* MBZ */
232 __le32 Capabilities;
233 __u8 ClientGUID[SMB2_CLIENT_GUID_SIZE];
234 /* In SMB3.02 and earlier next three were MBZ le64 ClientStartTime */
235 __le32 NegotiateContextOffset; /* SMB3.1.1 only. MBZ earlier */
236 __le16 NegotiateContextCount; /* SMB3.1.1 only. MBZ earlier */
237 __le16 Reserved2;
238 __le16 Dialects[1]; /* One dialect (vers=) at a time for now */
239} __packed;
240
241/* Dialects */
242#define SMB20_PROT_ID 0x0202
243#define SMB21_PROT_ID 0x0210
244#define SMB30_PROT_ID 0x0300
245#define SMB302_PROT_ID 0x0302
246#define SMB311_PROT_ID 0x0311
247#define BAD_PROT_ID 0xFFFF
248
249/* SecurityMode flags */
250#define SMB2_NEGOTIATE_SIGNING_ENABLED 0x0001
251#define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
252#define SMB2_SEC_MODE_FLAGS_ALL 0x0003
253
254/* Capabilities flags */
255#define SMB2_GLOBAL_CAP_DFS 0x00000001
256#define SMB2_GLOBAL_CAP_LEASING 0x00000002 /* Resp only New to SMB2.1 */
257#define SMB2_GLOBAL_CAP_LARGE_MTU 0X00000004 /* Resp only New to SMB2.1 */
258#define SMB2_GLOBAL_CAP_MULTI_CHANNEL 0x00000008 /* New to SMB3 */
259#define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
260#define SMB2_GLOBAL_CAP_DIRECTORY_LEASING 0x00000020 /* New to SMB3 */
261#define SMB2_GLOBAL_CAP_ENCRYPTION 0x00000040 /* New to SMB3 */
262/* Internal types */
263#define SMB2_NT_FIND 0x00100000
264#define SMB2_LARGE_FILES 0x00200000
265
266struct smb2_neg_context {
267 __le16 ContextType;
268 __le16 DataLength;
269 __le32 Reserved;
270 /* Followed by array of data */
271} __packed;
272
273#define SMB311_SALT_SIZE 32
274/* Hash Algorithm Types */
275#define SMB2_PREAUTH_INTEGRITY_SHA512 cpu_to_le16(0x0001)
276#define SMB2_PREAUTH_HASH_SIZE 64
277
278#define MIN_PREAUTH_CTXT_DATA_LEN (SMB311_SALT_SIZE + 6)
279struct smb2_preauth_neg_context {
280 __le16 ContextType; /* 1 */
281 __le16 DataLength;
282 __le32 Reserved;
283 __le16 HashAlgorithmCount; /* 1 */
284 __le16 SaltLength;
285 __le16 HashAlgorithms; /* HashAlgorithms[0] since only one defined */
286 __u8 Salt[SMB311_SALT_SIZE];
287} __packed;
288
289/* Encryption Algorithms Ciphers */
290#define SMB2_ENCRYPTION_AES128_CCM cpu_to_le16(0x0001)
291#define SMB2_ENCRYPTION_AES128_GCM cpu_to_le16(0x0002)
292
293/* Min encrypt context data is one cipher so 2 bytes + 2 byte count field */
294#define MIN_ENCRYPT_CTXT_DATA_LEN 4
295struct smb2_encryption_neg_context {
296 __le16 ContextType; /* 2 */
297 __le16 DataLength;
298 __le32 Reserved;
299 __le16 CipherCount; /* AES-128-GCM and AES-128-CCM */
300 __le16 Ciphers[1]; /* Ciphers[0] since only one used now */
301} __packed;
302
303struct smb2_negotiate_rsp {
304 struct smb2_hdr hdr;
305 __le16 StructureSize; /* Must be 65 */
306 __le16 SecurityMode;
307 __le16 DialectRevision;
308 __le16 NegotiateContextCount; /* Prior to SMB3.1.1 was Reserved & MBZ */
309 __u8 ServerGUID[16];
310 __le32 Capabilities;
311 __le32 MaxTransactSize;
312 __le32 MaxReadSize;
313 __le32 MaxWriteSize;
314 __le64 SystemTime; /* MBZ */
315 __le64 ServerStartTime;
316 __le16 SecurityBufferOffset;
317 __le16 SecurityBufferLength;
318 __le32 NegotiateContextOffset; /* Pre:SMB3.1.1 was reserved/ignored */
319 __u8 Buffer[1]; /* variable length GSS security buffer */
320} __packed;
321
322/* Flags */
323#define SMB2_SESSION_REQ_FLAG_BINDING 0x01
324#define SMB2_SESSION_REQ_FLAG_ENCRYPT_DATA 0x04
325
326struct smb2_sess_setup_req {
327 struct smb2_sync_hdr sync_hdr;
328 __le16 StructureSize; /* Must be 25 */
329 __u8 Flags;
330 __u8 SecurityMode;
331 __le32 Capabilities;
332 __le32 Channel;
333 __le16 SecurityBufferOffset;
334 __le16 SecurityBufferLength;
335 __u64 PreviousSessionId;
336 __u8 Buffer[1]; /* variable length GSS security buffer */
337} __packed;
338
339/* Currently defined SessionFlags */
340#define SMB2_SESSION_FLAG_IS_GUEST 0x0001
341#define SMB2_SESSION_FLAG_IS_NULL 0x0002
342#define SMB2_SESSION_FLAG_ENCRYPT_DATA 0x0004
343struct smb2_sess_setup_rsp {
344 struct smb2_hdr hdr;
345 __le16 StructureSize; /* Must be 9 */
346 __le16 SessionFlags;
347 __le16 SecurityBufferOffset;
348 __le16 SecurityBufferLength;
349 __u8 Buffer[1]; /* variable length GSS security buffer */
350} __packed;
351
352struct smb2_logoff_req {
353 struct smb2_sync_hdr sync_hdr;
354 __le16 StructureSize; /* Must be 4 */
355 __le16 Reserved;
356} __packed;
357
358struct smb2_logoff_rsp {
359 struct smb2_hdr hdr;
360 __le16 StructureSize; /* Must be 4 */
361 __le16 Reserved;
362} __packed;
363
364/* Flags/Reserved for SMB3.1.1 */
365#define SMB2_TREE_CONNECT_FLAG_CLUSTER_RECONNECT cpu_to_le16(0x0001)
366#define SMB2_TREE_CONNECT_FLAG_REDIRECT_TO_OWNER cpu_to_le16(0x0002)
367#define SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT cpu_to_le16(0x0004)
368
369struct smb2_tree_connect_req {
370 struct smb2_sync_hdr sync_hdr;
371 __le16 StructureSize; /* Must be 9 */
372 __le16 Reserved; /* Flags in SMB3.1.1 */
373 __le16 PathOffset;
374 __le16 PathLength;
375 __u8 Buffer[1]; /* variable length */
376} __packed;
377
378/* See MS-SMB2 section 2.2.9.2 */
379/* Context Types */
380#define SMB2_RESERVED_TREE_CONNECT_CONTEXT_ID 0x0000
381#define SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID cpu_to_le16(0x0001)
382
383struct tree_connect_contexts {
384 __le16 ContextType;
385 __le16 DataLength;
386 __le32 Reserved;
387 __u8 Data[0];
388} __packed;
389
390/* Remoted identity tree connect context structures - see MS-SMB2 2.2.9.2.1 */
391struct smb3_blob_data {
392 __le16 BlobSize;
393 __u8 BlobData[0];
394} __packed;
395
396/* Valid values for Attr */
397#define SE_GROUP_MANDATORY 0x00000001
398#define SE_GROUP_ENABLED_BY_DEFAULT 0x00000002
399#define SE_GROUP_ENABLED 0x00000004
400#define SE_GROUP_OWNER 0x00000008
401#define SE_GROUP_USE_FOR_DENY_ONLY 0x00000010
402#define SE_GROUP_INTEGRITY 0x00000020
403#define SE_GROUP_INTEGRITY_ENABLED 0x00000040
404#define SE_GROUP_RESOURCE 0x20000000
405#define SE_GROUP_LOGON_ID 0xC0000000
406
407/* struct sid_attr_data is SidData array in BlobData format then le32 Attr */
408
409struct sid_array_data {
410 __le16 SidAttrCount;
411 /* SidAttrList - array of sid_attr_data structs */
412} __packed;
413
414struct luid_attr_data {
415
416} __packed;
417
418/*
419 * struct privilege_data is the same as BLOB_DATA - see MS-SMB2 2.2.9.2.1.5
420 * but with size of LUID_ATTR_DATA struct and BlobData set to LUID_ATTR DATA
421 */
422
423struct privilege_array_data {
424 __le16 PrivilegeCount;
425 /* array of privilege_data structs */
426} __packed;
427
428struct remoted_identity_tcon_context {
429 __le16 TicketType; /* must be 0x0001 */
430 __le16 TicketSize; /* total size of this struct */
431 __le16 User; /* offset to SID_ATTR_DATA struct with user info */
432 __le16 UserName; /* offset to null terminated Unicode username string */
433 __le16 Domain; /* offset to null terminated Unicode domain name */
434 __le16 Groups; /* offset to SID_ARRAY_DATA struct with group info */
435 __le16 RestrictedGroups; /* similar to above */
436 __le16 Privileges; /* offset to PRIVILEGE_ARRAY_DATA struct */
437 __le16 PrimaryGroup; /* offset to SID_ARRAY_DATA struct */
438 __le16 Owner; /* offset to BLOB_DATA struct */
439 __le16 DefaultDacl; /* offset to BLOB_DATA struct */
440 __le16 DeviceGroups; /* offset to SID_ARRAY_DATA struct */
441 __le16 UserClaims; /* offset to BLOB_DATA struct */
442 __le16 DeviceClaims; /* offset to BLOB_DATA struct */
443 __u8 TicketInfo[0]; /* variable length buf - remoted identity data */
444} __packed;
445
446struct smb2_tree_connect_req_extension {
447 __le32 TreeConnectContextOffset;
448 __le16 TreeConnectContextCount;
449 __u8 Reserved[10];
450 __u8 PathName[0]; /* variable sized array */
451 /* followed by array of TreeConnectContexts */
452} __packed;
453
454struct smb2_tree_connect_rsp {
455 struct smb2_hdr hdr;
456 __le16 StructureSize; /* Must be 16 */
457 __u8 ShareType; /* see below */
458 __u8 Reserved;
459 __le32 ShareFlags; /* see below */
460 __le32 Capabilities; /* see below */
461 __le32 MaximalAccess;
462} __packed;
463
464/* Possible ShareType values */
465#define SMB2_SHARE_TYPE_DISK 0x01
466#define SMB2_SHARE_TYPE_PIPE 0x02
467#define SMB2_SHARE_TYPE_PRINT 0x03
468
469/*
470 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
471 * must be set (any of the remaining, SHI1005, flags may be set individually
472 * or in combination.
473 */
474#define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
475#define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
476#define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
477#define SMB2_SHAREFLAG_NO_CACHING 0x00000030
478#define SHI1005_FLAGS_DFS 0x00000001
479#define SHI1005_FLAGS_DFS_ROOT 0x00000002
480#define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS 0x00000100
481#define SHI1005_FLAGS_FORCE_SHARED_DELETE 0x00000200
482#define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING 0x00000400
483#define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
484#define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK 0x00001000
485#define SHI1005_FLAGS_ENABLE_HASH_V1 0x00002000
486#define SHI1005_FLAGS_ENABLE_HASH_V2 0x00004000
487#define SHI1005_FLAGS_ENCRYPT_DATA 0x00008000
488#define SMB2_SHAREFLAG_IDENTITY_REMOTING 0x00040000 /* 3.1.1 */
489#define SHI1005_FLAGS_ALL 0x0004FF33
490
491/* Possible share capabilities */
492#define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
493#define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
494#define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
495#define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
496#define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
497#define SMB2_SHARE_CAP_REDIRECT_TO_OWNER cpu_to_le32(0x00000100) /* 3.1.1 */
498
499struct smb2_tree_disconnect_req {
500 struct smb2_sync_hdr sync_hdr;
501 __le16 StructureSize; /* Must be 4 */
502 __le16 Reserved;
503} __packed;
504
505struct smb2_tree_disconnect_rsp {
506 struct smb2_hdr hdr;
507 __le16 StructureSize; /* Must be 4 */
508 __le16 Reserved;
509} __packed;
510
511/* File Attrubutes */
512#define FILE_ATTRIBUTE_READONLY 0x00000001
513#define FILE_ATTRIBUTE_HIDDEN 0x00000002
514#define FILE_ATTRIBUTE_SYSTEM 0x00000004
515#define FILE_ATTRIBUTE_DIRECTORY 0x00000010
516#define FILE_ATTRIBUTE_ARCHIVE 0x00000020
517#define FILE_ATTRIBUTE_NORMAL 0x00000080
518#define FILE_ATTRIBUTE_TEMPORARY 0x00000100
519#define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
520#define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
521#define FILE_ATTRIBUTE_COMPRESSED 0x00000800
522#define FILE_ATTRIBUTE_OFFLINE 0x00001000
523#define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
524#define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
525#define FILE_ATTRIBUTE_INTEGRITY_STREAM 0x00008000
526#define FILE_ATTRIBUTE_NO_SCRUB_DATA 0x00020000
527
528/* Oplock levels */
529#define SMB2_OPLOCK_LEVEL_NONE 0x00
530#define SMB2_OPLOCK_LEVEL_II 0x01
531#define SMB2_OPLOCK_LEVEL_EXCLUSIVE 0x08
532#define SMB2_OPLOCK_LEVEL_BATCH 0x09
533#define SMB2_OPLOCK_LEVEL_LEASE 0xFF
534/* Non-spec internal type */
535#define SMB2_OPLOCK_LEVEL_NOCHANGE 0x99
536
537/* Desired Access Flags */
538#define FILE_READ_DATA_LE cpu_to_le32(0x00000001)
539#define FILE_WRITE_DATA_LE cpu_to_le32(0x00000002)
540#define FILE_APPEND_DATA_LE cpu_to_le32(0x00000004)
541#define FILE_READ_EA_LE cpu_to_le32(0x00000008)
542#define FILE_WRITE_EA_LE cpu_to_le32(0x00000010)
543#define FILE_EXECUTE_LE cpu_to_le32(0x00000020)
544#define FILE_READ_ATTRIBUTES_LE cpu_to_le32(0x00000080)
545#define FILE_WRITE_ATTRIBUTES_LE cpu_to_le32(0x00000100)
546#define FILE_DELETE_LE cpu_to_le32(0x00010000)
547#define FILE_READ_CONTROL_LE cpu_to_le32(0x00020000)
548#define FILE_WRITE_DAC_LE cpu_to_le32(0x00040000)
549#define FILE_WRITE_OWNER_LE cpu_to_le32(0x00080000)
550#define FILE_SYNCHRONIZE_LE cpu_to_le32(0x00100000)
551#define FILE_ACCESS_SYSTEM_SECURITY_LE cpu_to_le32(0x01000000)
552#define FILE_MAXIMAL_ACCESS_LE cpu_to_le32(0x02000000)
553#define FILE_GENERIC_ALL_LE cpu_to_le32(0x10000000)
554#define FILE_GENERIC_EXECUTE_LE cpu_to_le32(0x20000000)
555#define FILE_GENERIC_WRITE_LE cpu_to_le32(0x40000000)
556#define FILE_GENERIC_READ_LE cpu_to_le32(0x80000000)
557
558/* ShareAccess Flags */
559#define FILE_SHARE_READ_LE cpu_to_le32(0x00000001)
560#define FILE_SHARE_WRITE_LE cpu_to_le32(0x00000002)
561#define FILE_SHARE_DELETE_LE cpu_to_le32(0x00000004)
562#define FILE_SHARE_ALL_LE cpu_to_le32(0x00000007)
563
564/* CreateDisposition Flags */
565#define FILE_SUPERSEDE_LE cpu_to_le32(0x00000000)
566#define FILE_OPEN_LE cpu_to_le32(0x00000001)
567#define FILE_CREATE_LE cpu_to_le32(0x00000002)
568#define FILE_OPEN_IF_LE cpu_to_le32(0x00000003)
569#define FILE_OVERWRITE_LE cpu_to_le32(0x00000004)
570#define FILE_OVERWRITE_IF_LE cpu_to_le32(0x00000005)
571
572/* CreateOptions Flags */
573#define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
574/* same as #define CREATE_NOT_FILE_LE cpu_to_le32(0x00000001) */
575#define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
576#define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
577#define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
578#define FILE_SYNCHRONOUS_IO_ALERT_LE cpu_to_le32(0x00000010)
579#define FILE_SYNCHRONOUS_IO_NON_ALERT_LE cpu_to_le32(0x00000020)
580#define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
581#define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
582#define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
583#define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
584#define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000)
585#define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
586#define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
587#define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
588#define FILE_RESERVE_OPFILTER_LE cpu_to_le32(0x00100000)
589#define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
590#define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
591#define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
592
593#define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
594 | FILE_READ_ATTRIBUTES_LE)
595#define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
596 | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
597#define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
598
599/* Impersonation Levels */
600#define IL_ANONYMOUS cpu_to_le32(0x00000000)
601#define IL_IDENTIFICATION cpu_to_le32(0x00000001)
602#define IL_IMPERSONATION cpu_to_le32(0x00000002)
603#define IL_DELEGATE cpu_to_le32(0x00000003)
604
605/* Create Context Values */
606#define SMB2_CREATE_EA_BUFFER "ExtA" /* extended attributes */
607#define SMB2_CREATE_SD_BUFFER "SecD" /* security descriptor */
608#define SMB2_CREATE_DURABLE_HANDLE_REQUEST "DHnQ"
609#define SMB2_CREATE_DURABLE_HANDLE_RECONNECT "DHnC"
610#define SMB2_CREATE_ALLOCATION_SIZE "AISi"
611#define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
612#define SMB2_CREATE_TIMEWARP_REQUEST "TWrp"
613#define SMB2_CREATE_QUERY_ON_DISK_ID "QFid"
614#define SMB2_CREATE_REQUEST_LEASE "RqLs"
615#define SMB2_CREATE_DURABLE_HANDLE_REQUEST_V2 "DH2Q"
616#define SMB2_CREATE_DURABLE_HANDLE_RECONNECT_V2 "DH2C"
617#define SMB2_CREATE_APP_INSTANCE_ID 0x45BCA66AEFA7F74A9008FA462E144D74
618#define SVHDX_OPEN_DEVICE_CONTEXT 0x83CE6F1AD851E0986E34401CC9BCFCE9
619
620struct smb2_create_req {
621 struct smb2_sync_hdr sync_hdr;
622 __le16 StructureSize; /* Must be 57 */
623 __u8 SecurityFlags;
624 __u8 RequestedOplockLevel;
625 __le32 ImpersonationLevel;
626 __le64 SmbCreateFlags;
627 __le64 Reserved;
628 __le32 DesiredAccess;
629 __le32 FileAttributes;
630 __le32 ShareAccess;
631 __le32 CreateDisposition;
632 __le32 CreateOptions;
633 __le16 NameOffset;
634 __le16 NameLength;
635 __le32 CreateContextsOffset;
636 __le32 CreateContextsLength;
637 __u8 Buffer[0];
638} __packed;
639
640struct smb2_create_rsp {
641 struct smb2_hdr hdr;
642 __le16 StructureSize; /* Must be 89 */
643 __u8 OplockLevel;
644 __u8 Reserved;
645 __le32 CreateAction;
646 __le64 CreationTime;
647 __le64 LastAccessTime;
648 __le64 LastWriteTime;
649 __le64 ChangeTime;
650 __le64 AllocationSize;
651 __le64 EndofFile;
652 __le32 FileAttributes;
653 __le32 Reserved2;
654 __u64 PersistentFileId; /* opaque endianness */
655 __u64 VolatileFileId; /* opaque endianness */
656 __le32 CreateContextsOffset;
657 __le32 CreateContextsLength;
658 __u8 Buffer[1];
659} __packed;
660
661struct create_context {
662 __le32 Next;
663 __le16 NameOffset;
664 __le16 NameLength;
665 __le16 Reserved;
666 __le16 DataOffset;
667 __le32 DataLength;
668 __u8 Buffer[0];
669} __packed;
670
671#define SMB2_LEASE_READ_CACHING_HE 0x01
672#define SMB2_LEASE_HANDLE_CACHING_HE 0x02
673#define SMB2_LEASE_WRITE_CACHING_HE 0x04
674
675#define SMB2_LEASE_NONE cpu_to_le32(0x00)
676#define SMB2_LEASE_READ_CACHING cpu_to_le32(0x01)
677#define SMB2_LEASE_HANDLE_CACHING cpu_to_le32(0x02)
678#define SMB2_LEASE_WRITE_CACHING cpu_to_le32(0x04)
679
680#define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS cpu_to_le32(0x02)
681#define SMB2_LEASE_FLAG_PARENT_LEASE_KEY_SET cpu_to_le32(0x00000004)
682
683#define SMB2_LEASE_KEY_SIZE 16
684
685struct lease_context {
686 __le64 LeaseKeyLow;
687 __le64 LeaseKeyHigh;
688 __le32 LeaseState;
689 __le32 LeaseFlags;
690 __le64 LeaseDuration;
691} __packed;
692
693struct lease_context_v2 {
694 __le64 LeaseKeyLow;
695 __le64 LeaseKeyHigh;
696 __le32 LeaseState;
697 __le32 LeaseFlags;
698 __le64 LeaseDuration;
699 __le64 ParentLeaseKeyLow;
700 __le64 ParentLeaseKeyHigh;
701 __le16 Epoch;
702 __le16 Reserved;
703} __packed;
704
705struct create_lease {
706 struct create_context ccontext;
707 __u8 Name[8];
708 struct lease_context lcontext;
709} __packed;
710
711struct create_lease_v2 {
712 struct create_context ccontext;
713 __u8 Name[8];
714 struct lease_context_v2 lcontext;
715 __u8 Pad[4];
716} __packed;
717
718struct create_durable {
719 struct create_context ccontext;
720 __u8 Name[8];
721 union {
722 __u8 Reserved[16];
723 struct {
724 __u64 PersistentFileId;
725 __u64 VolatileFileId;
726 } Fid;
727 } Data;
728} __packed;
729
730/* See MS-SMB2 2.2.13.2.11 */
731/* Flags */
732#define SMB2_DHANDLE_FLAG_PERSISTENT 0x00000002
733struct durable_context_v2 {
734 __le32 Timeout;
735 __le32 Flags;
736 __u64 Reserved;
737 __u8 CreateGuid[16];
738} __packed;
739
740struct create_durable_v2 {
741 struct create_context ccontext;
742 __u8 Name[8];
743 struct durable_context_v2 dcontext;
744} __packed;
745
746/* See MS-SMB2 2.2.13.2.12 */
747struct durable_reconnect_context_v2 {
748 struct {
749 __u64 PersistentFileId;
750 __u64 VolatileFileId;
751 } Fid;
752 __u8 CreateGuid[16];
753 __le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
754} __packed;
755
756/* See MS-SMB2 2.2.14.2.12 */
757struct durable_reconnect_context_v2_rsp {
758 __le32 Timeout;
759 __le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
760} __packed;
761
762struct create_durable_handle_reconnect_v2 {
763 struct create_context ccontext;
764 __u8 Name[8];
765 struct durable_reconnect_context_v2 dcontext;
766} __packed;
767
768#define COPY_CHUNK_RES_KEY_SIZE 24
769struct resume_key_req {
770 char ResumeKey[COPY_CHUNK_RES_KEY_SIZE];
771 __le32 ContextLength; /* MBZ */
772 char Context[0]; /* ignored, Windows sets to 4 bytes of zero */
773} __packed;
774
775/* this goes in the ioctl buffer when doing a copychunk request */
776struct copychunk_ioctl {
777 char SourceKey[COPY_CHUNK_RES_KEY_SIZE];
778 __le32 ChunkCount; /* we are only sending 1 */
779 __le32 Reserved;
780 /* array will only be one chunk long for us */
781 __le64 SourceOffset;
782 __le64 TargetOffset;
783 __le32 Length; /* how many bytes to copy */
784 __u32 Reserved2;
785} __packed;
786
787/* this goes in the ioctl buffer when doing FSCTL_SET_ZERO_DATA */
788struct file_zero_data_information {
789 __le64 FileOffset;
790 __le64 BeyondFinalZero;
791} __packed;
792
793struct copychunk_ioctl_rsp {
794 __le32 ChunksWritten;
795 __le32 ChunkBytesWritten;
796 __le32 TotalBytesWritten;
797} __packed;
798
799struct fsctl_set_integrity_information_req {
800 __le16 ChecksumAlgorithm;
801 __le16 Reserved;
802 __le32 Flags;
803} __packed;
804
805struct fsctl_get_integrity_information_rsp {
806 __le16 ChecksumAlgorithm;
807 __le16 Reserved;
808 __le32 Flags;
809 __le32 ChecksumChunkSizeInBytes;
810 __le32 ClusterSizeInBytes;
811} __packed;
812
813/* Integrity ChecksumAlgorithm choices for above */
814#define CHECKSUM_TYPE_NONE 0x0000
815#define CHECKSUM_TYPE_CRC64 0x0002
816#define CHECKSUM_TYPE_UNCHANGED 0xFFFF /* set only */
817
818/* Integrity flags for above */
819#define FSCTL_INTEGRITY_FLAG_CHECKSUM_ENFORCEMENT_OFF 0x00000001
820
821/* See MS-DFSC 2.2.2 */
822struct fsctl_get_dfs_referral_req {
823 __le16 MaxReferralLevel;
824 __u8 RequestFileName[];
825} __packed;
826
827/* DFS response is struct get_dfs_refer_rsp */
828
829/* See MS-SMB2 2.2.31.3 */
830struct network_resiliency_req {
831 __le32 Timeout;
832 __le32 Reserved;
833} __packed;
834/* There is no buffer for the response ie no struct network_resiliency_rsp */
835
836
837struct validate_negotiate_info_req {
838 __le32 Capabilities;
839 __u8 Guid[SMB2_CLIENT_GUID_SIZE];
840 __le16 SecurityMode;
841 __le16 DialectCount;
842 __le16 Dialects[3]; /* BB expand this if autonegotiate > 3 dialects */
843} __packed;
844
845struct validate_negotiate_info_rsp {
846 __le32 Capabilities;
847 __u8 Guid[SMB2_CLIENT_GUID_SIZE];
848 __le16 SecurityMode;
849 __le16 Dialect; /* Dialect in use for the connection */
850} __packed;
851
852#define RSS_CAPABLE 0x00000001
853#define RDMA_CAPABLE 0x00000002
854
855struct network_interface_info_ioctl_rsp {
856 __le32 Next; /* next interface. zero if this is last one */
857 __le32 IfIndex;
858 __le32 Capability; /* RSS or RDMA Capable */
859 __le32 Reserved;
860 __le64 LinkSpeed;
861 char SockAddr_Storage[128];
862} __packed;
863
864#define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
865
866struct compress_ioctl {
867 __le16 CompressionState; /* See cifspdu.h for possible flag values */
868} __packed;
869
870struct duplicate_extents_to_file {
871 __u64 PersistentFileHandle; /* source file handle, opaque endianness */
872 __u64 VolatileFileHandle;
873 __le64 SourceFileOffset;
874 __le64 TargetFileOffset;
875 __le64 ByteCount; /* Bytes to be copied */
876} __packed;
877
878struct smb2_ioctl_req {
879 struct smb2_sync_hdr sync_hdr;
880 __le16 StructureSize; /* Must be 57 */
881 __u16 Reserved;
882 __le32 CtlCode;
883 __u64 PersistentFileId; /* opaque endianness */
884 __u64 VolatileFileId; /* opaque endianness */
885 __le32 InputOffset;
886 __le32 InputCount;
887 __le32 MaxInputResponse;
888 __le32 OutputOffset;
889 __le32 OutputCount;
890 __le32 MaxOutputResponse;
891 __le32 Flags;
892 __u32 Reserved2;
893 __u8 Buffer[0];
894} __packed;
895
896struct smb2_ioctl_rsp {
897 struct smb2_hdr hdr;
898 __le16 StructureSize; /* Must be 57 */
899 __u16 Reserved;
900 __le32 CtlCode;
901 __u64 PersistentFileId; /* opaque endianness */
902 __u64 VolatileFileId; /* opaque endianness */
903 __le32 InputOffset;
904 __le32 InputCount;
905 __le32 OutputOffset;
906 __le32 OutputCount;
907 __le32 Flags;
908 __u32 Reserved2;
909 /* char * buffer[] */
910} __packed;
911
912/* Currently defined values for close flags */
913#define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
914struct smb2_close_req {
915 struct smb2_sync_hdr sync_hdr;
916 __le16 StructureSize; /* Must be 24 */
917 __le16 Flags;
918 __le32 Reserved;
919 __u64 PersistentFileId; /* opaque endianness */
920 __u64 VolatileFileId; /* opaque endianness */
921} __packed;
922
923struct smb2_close_rsp {
924 struct smb2_hdr hdr;
925 __le16 StructureSize; /* 60 */
926 __le16 Flags;
927 __le32 Reserved;
928 __le64 CreationTime;
929 __le64 LastAccessTime;
930 __le64 LastWriteTime;
931 __le64 ChangeTime;
932 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
933 __le64 EndOfFile;
934 __le32 Attributes;
935} __packed;
936
937struct smb2_flush_req {
938 struct smb2_sync_hdr sync_hdr;
939 __le16 StructureSize; /* Must be 24 */
940 __le16 Reserved1;
941 __le32 Reserved2;
942 __u64 PersistentFileId; /* opaque endianness */
943 __u64 VolatileFileId; /* opaque endianness */
944} __packed;
945
946struct smb2_flush_rsp {
947 struct smb2_hdr hdr;
948 __le16 StructureSize;
949 __le16 Reserved;
950} __packed;
951
952/* For read request Flags field below, following flag is defined for SMB3.02 */
953#define SMB2_READFLAG_READ_UNBUFFERED 0x01
954
955/* Channel field for read and write: exactly one of following flags can be set*/
956#define SMB2_CHANNEL_NONE cpu_to_le32(0x00000000)
957#define SMB2_CHANNEL_RDMA_V1 cpu_to_le32(0x00000001) /* SMB3 or later */
958#define SMB2_CHANNEL_RDMA_V1_INVALIDATE cpu_to_le32(0x00000002) /* >= SMB3.02 */
959
960/* SMB2 read request without RFC1001 length at the beginning */
961struct smb2_read_plain_req {
962 struct smb2_sync_hdr sync_hdr;
963 __le16 StructureSize; /* Must be 49 */
964 __u8 Padding; /* offset from start of SMB2 header to place read */
965 __u8 Flags; /* MBZ unless SMB3.02 or later */
966 __le32 Length;
967 __le64 Offset;
968 __u64 PersistentFileId; /* opaque endianness */
969 __u64 VolatileFileId; /* opaque endianness */
970 __le32 MinimumCount;
971 __le32 Channel; /* MBZ except for SMB3 or later */
972 __le32 RemainingBytes;
973 __le16 ReadChannelInfoOffset;
974 __le16 ReadChannelInfoLength;
975 __u8 Buffer[1];
976} __packed;
977
978struct smb2_read_rsp {
979 struct smb2_hdr hdr;
980 __le16 StructureSize; /* Must be 17 */
981 __u8 DataOffset;
982 __u8 Reserved;
983 __le32 DataLength;
984 __le32 DataRemaining;
985 __u32 Reserved2;
986 __u8 Buffer[1];
987} __packed;
988
989/* For write request Flags field below the following flags are defined: */
990#define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
991#define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
992
993struct smb2_write_req {
994 struct smb2_sync_hdr sync_hdr;
995 __le16 StructureSize; /* Must be 49 */
996 __le16 DataOffset; /* offset from start of SMB2 header to write data */
997 __le32 Length;
998 __le64 Offset;
999 __u64 PersistentFileId; /* opaque endianness */
1000 __u64 VolatileFileId; /* opaque endianness */
1001 __le32 Channel; /* Reserved MBZ */
1002 __le32 RemainingBytes;
1003 __le16 WriteChannelInfoOffset;
1004 __le16 WriteChannelInfoLength;
1005 __le32 Flags;
1006 __u8 Buffer[1];
1007} __packed;
1008
1009struct smb2_write_rsp {
1010 struct smb2_hdr hdr;
1011 __le16 StructureSize; /* Must be 17 */
1012 __u8 DataOffset;
1013 __u8 Reserved;
1014 __le32 DataLength;
1015 __le32 DataRemaining;
1016 __u32 Reserved2;
1017 __u8 Buffer[1];
1018} __packed;
1019
1020#define SMB2_LOCKFLAG_SHARED_LOCK 0x0001
1021#define SMB2_LOCKFLAG_EXCLUSIVE_LOCK 0x0002
1022#define SMB2_LOCKFLAG_UNLOCK 0x0004
1023#define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
1024
1025struct smb2_lock_element {
1026 __le64 Offset;
1027 __le64 Length;
1028 __le32 Flags;
1029 __le32 Reserved;
1030} __packed;
1031
1032struct smb2_lock_req {
1033 struct smb2_sync_hdr sync_hdr;
1034 __le16 StructureSize; /* Must be 48 */
1035 __le16 LockCount;
1036 __le32 Reserved;
1037 __u64 PersistentFileId; /* opaque endianness */
1038 __u64 VolatileFileId; /* opaque endianness */
1039 /* Followed by at least one */
1040 struct smb2_lock_element locks[1];
1041} __packed;
1042
1043struct smb2_lock_rsp {
1044 struct smb2_hdr hdr;
1045 __le16 StructureSize; /* Must be 4 */
1046 __le16 Reserved;
1047} __packed;
1048
1049struct smb2_echo_req {
1050 struct smb2_sync_hdr sync_hdr;
1051 __le16 StructureSize; /* Must be 4 */
1052 __u16 Reserved;
1053} __packed;
1054
1055struct smb2_echo_rsp {
1056 struct smb2_hdr hdr;
1057 __le16 StructureSize; /* Must be 4 */
1058 __u16 Reserved;
1059} __packed;
1060
1061/* search (query_directory) Flags field */
1062#define SMB2_RESTART_SCANS 0x01
1063#define SMB2_RETURN_SINGLE_ENTRY 0x02
1064#define SMB2_INDEX_SPECIFIED 0x04
1065#define SMB2_REOPEN 0x10
1066
1067struct smb2_query_directory_req {
1068 struct smb2_sync_hdr sync_hdr;
1069 __le16 StructureSize; /* Must be 33 */
1070 __u8 FileInformationClass;
1071 __u8 Flags;
1072 __le32 FileIndex;
1073 __u64 PersistentFileId; /* opaque endianness */
1074 __u64 VolatileFileId; /* opaque endianness */
1075 __le16 FileNameOffset;
1076 __le16 FileNameLength;
1077 __le32 OutputBufferLength;
1078 __u8 Buffer[1];
1079} __packed;
1080
1081struct smb2_query_directory_rsp {
1082 struct smb2_hdr hdr;
1083 __le16 StructureSize; /* Must be 9 */
1084 __le16 OutputBufferOffset;
1085 __le32 OutputBufferLength;
1086 __u8 Buffer[1];
1087} __packed;
1088
1089/* Possible InfoType values */
1090#define SMB2_O_INFO_FILE 0x01
1091#define SMB2_O_INFO_FILESYSTEM 0x02
1092#define SMB2_O_INFO_SECURITY 0x03
1093#define SMB2_O_INFO_QUOTA 0x04
1094
1095/* Security info type additionalinfo flags. See MS-SMB2 (2.2.37) or MS-DTYP */
1096#define OWNER_SECINFO 0x00000001
1097#define GROUP_SECINFO 0x00000002
1098#define DACL_SECINFO 0x00000004
1099#define SACL_SECINFO 0x00000008
1100#define LABEL_SECINFO 0x00000010
1101#define ATTRIBUTE_SECINFO 0x00000020
1102#define SCOPE_SECINFO 0x00000040
1103#define BACKUP_SECINFO 0x00010000
1104#define UNPROTECTED_SACL_SECINFO 0x10000000
1105#define UNPROTECTED_DACL_SECINFO 0x20000000
1106#define PROTECTED_SACL_SECINFO 0x40000000
1107#define PROTECTED_DACL_SECINFO 0x80000000
1108
1109/* Flags used for FileFullEAinfo */
1110#define SL_RESTART_SCAN 0x00000001
1111#define SL_RETURN_SINGLE_ENTRY 0x00000002
1112#define SL_INDEX_SPECIFIED 0x00000004
1113
1114struct smb2_query_info_req {
1115 struct smb2_sync_hdr sync_hdr;
1116 __le16 StructureSize; /* Must be 41 */
1117 __u8 InfoType;
1118 __u8 FileInfoClass;
1119 __le32 OutputBufferLength;
1120 __le16 InputBufferOffset;
1121 __u16 Reserved;
1122 __le32 InputBufferLength;
1123 __le32 AdditionalInformation;
1124 __le32 Flags;
1125 __u64 PersistentFileId; /* opaque endianness */
1126 __u64 VolatileFileId; /* opaque endianness */
1127 __u8 Buffer[1];
1128} __packed;
1129
1130struct smb2_query_info_rsp {
1131 struct smb2_hdr hdr;
1132 __le16 StructureSize; /* Must be 9 */
1133 __le16 OutputBufferOffset;
1134 __le32 OutputBufferLength;
1135 __u8 Buffer[1];
1136} __packed;
1137
1138struct smb2_set_info_req {
1139 struct smb2_sync_hdr sync_hdr;
1140 __le16 StructureSize; /* Must be 33 */
1141 __u8 InfoType;
1142 __u8 FileInfoClass;
1143 __le32 BufferLength;
1144 __le16 BufferOffset;
1145 __u16 Reserved;
1146 __le32 AdditionalInformation;
1147 __u64 PersistentFileId; /* opaque endianness */
1148 __u64 VolatileFileId; /* opaque endianness */
1149 __u8 Buffer[1];
1150} __packed;
1151
1152struct smb2_set_info_rsp {
1153 struct smb2_hdr hdr;
1154 __le16 StructureSize; /* Must be 2 */
1155} __packed;
1156
1157/* oplock break without an rfc1002 header */
1158struct smb2_oplock_break_req {
1159 struct smb2_sync_hdr sync_hdr;
1160 __le16 StructureSize; /* Must be 24 */
1161 __u8 OplockLevel;
1162 __u8 Reserved;
1163 __le32 Reserved2;
1164 __u64 PersistentFid;
1165 __u64 VolatileFid;
1166} __packed;
1167
1168/* oplock break with an rfc1002 header */
1169struct smb2_oplock_break_rsp {
1170 struct smb2_hdr hdr;
1171 __le16 StructureSize; /* Must be 24 */
1172 __u8 OplockLevel;
1173 __u8 Reserved;
1174 __le32 Reserved2;
1175 __u64 PersistentFid;
1176 __u64 VolatileFid;
1177} __packed;
1178
1179#define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
1180
1181struct smb2_lease_break {
1182 struct smb2_hdr hdr;
1183 __le16 StructureSize; /* Must be 44 */
1184 __le16 Reserved;
1185 __le32 Flags;
1186 __u8 LeaseKey[16];
1187 __le32 CurrentLeaseState;
1188 __le32 NewLeaseState;
1189 __le32 BreakReason;
1190 __le32 AccessMaskHint;
1191 __le32 ShareMaskHint;
1192} __packed;
1193
1194struct smb2_lease_ack {
1195 struct smb2_sync_hdr sync_hdr;
1196 __le16 StructureSize; /* Must be 36 */
1197 __le16 Reserved;
1198 __le32 Flags;
1199 __u8 LeaseKey[16];
1200 __le32 LeaseState;
1201 __le64 LeaseDuration;
1202} __packed;
1203
1204/*
1205 * PDU infolevel structure definitions
1206 * BB consider moving to a different header
1207 */
1208
1209/* File System Information Classes */
1210#define FS_VOLUME_INFORMATION 1 /* Query */
1211#define FS_LABEL_INFORMATION 2 /* Local only */
1212#define FS_SIZE_INFORMATION 3 /* Query */
1213#define FS_DEVICE_INFORMATION 4 /* Query */
1214#define FS_ATTRIBUTE_INFORMATION 5 /* Query */
1215#define FS_CONTROL_INFORMATION 6 /* Query, Set */
1216#define FS_FULL_SIZE_INFORMATION 7 /* Query */
1217#define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
1218#define FS_DRIVER_PATH_INFORMATION 9 /* Local only */
1219#define FS_VOLUME_FLAGS_INFORMATION 10 /* Local only */
1220#define FS_SECTOR_SIZE_INFORMATION 11 /* SMB3 or later. Query */
1221
1222struct smb2_fs_full_size_info {
1223 __le64 TotalAllocationUnits;
1224 __le64 CallerAvailableAllocationUnits;
1225 __le64 ActualAvailableAllocationUnits;
1226 __le32 SectorsPerAllocationUnit;
1227 __le32 BytesPerSector;
1228} __packed;
1229
1230#define SSINFO_FLAGS_ALIGNED_DEVICE 0x00000001
1231#define SSINFO_FLAGS_PARTITION_ALIGNED_ON_DEVICE 0x00000002
1232#define SSINFO_FLAGS_NO_SEEK_PENALTY 0x00000004
1233#define SSINFO_FLAGS_TRIM_ENABLED 0x00000008
1234
1235/* sector size info struct */
1236struct smb3_fs_ss_info {
1237 __le32 LogicalBytesPerSector;
1238 __le32 PhysicalBytesPerSectorForAtomicity;
1239 __le32 PhysicalBytesPerSectorForPerf;
1240 __le32 FileSystemEffectivePhysicalBytesPerSectorForAtomicity;
1241 __le32 Flags;
1242 __le32 ByteOffsetForSectorAlignment;
1243 __le32 ByteOffsetForPartitionAlignment;
1244} __packed;
1245
1246/* partial list of QUERY INFO levels */
1247#define FILE_DIRECTORY_INFORMATION 1
1248#define FILE_FULL_DIRECTORY_INFORMATION 2
1249#define FILE_BOTH_DIRECTORY_INFORMATION 3
1250#define FILE_BASIC_INFORMATION 4
1251#define FILE_STANDARD_INFORMATION 5
1252#define FILE_INTERNAL_INFORMATION 6
1253#define FILE_EA_INFORMATION 7
1254#define FILE_ACCESS_INFORMATION 8
1255#define FILE_NAME_INFORMATION 9
1256#define FILE_RENAME_INFORMATION 10
1257#define FILE_LINK_INFORMATION 11
1258#define FILE_NAMES_INFORMATION 12
1259#define FILE_DISPOSITION_INFORMATION 13
1260#define FILE_POSITION_INFORMATION 14
1261#define FILE_FULL_EA_INFORMATION 15
1262#define FILE_MODE_INFORMATION 16
1263#define FILE_ALIGNMENT_INFORMATION 17
1264#define FILE_ALL_INFORMATION 18
1265#define FILE_ALLOCATION_INFORMATION 19
1266#define FILE_END_OF_FILE_INFORMATION 20
1267#define FILE_ALTERNATE_NAME_INFORMATION 21
1268#define FILE_STREAM_INFORMATION 22
1269#define FILE_PIPE_INFORMATION 23
1270#define FILE_PIPE_LOCAL_INFORMATION 24
1271#define FILE_PIPE_REMOTE_INFORMATION 25
1272#define FILE_MAILSLOT_QUERY_INFORMATION 26
1273#define FILE_MAILSLOT_SET_INFORMATION 27
1274#define FILE_COMPRESSION_INFORMATION 28
1275#define FILE_OBJECT_ID_INFORMATION 29
1276/* Number 30 not defined in documents */
1277#define FILE_MOVE_CLUSTER_INFORMATION 31
1278#define FILE_QUOTA_INFORMATION 32
1279#define FILE_REPARSE_POINT_INFORMATION 33
1280#define FILE_NETWORK_OPEN_INFORMATION 34
1281#define FILE_ATTRIBUTE_TAG_INFORMATION 35
1282#define FILE_TRACKING_INFORMATION 36
1283#define FILEID_BOTH_DIRECTORY_INFORMATION 37
1284#define FILEID_FULL_DIRECTORY_INFORMATION 38
1285#define FILE_VALID_DATA_LENGTH_INFORMATION 39
1286#define FILE_SHORT_NAME_INFORMATION 40
1287#define FILE_SFIO_RESERVE_INFORMATION 44
1288#define FILE_SFIO_VOLUME_INFORMATION 45
1289#define FILE_HARD_LINK_INFORMATION 46
1290#define FILE_NORMALIZED_NAME_INFORMATION 48
1291#define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
1292#define FILE_STANDARD_LINK_INFORMATION 54
1293
1294struct smb2_file_internal_info {
1295 __le64 IndexNumber;
1296} __packed; /* level 6 Query */
1297
1298struct smb2_file_rename_info { /* encoding of request for level 10 */
1299 __u8 ReplaceIfExists; /* 1 = replace existing target with new */
1300 /* 0 = fail if target already exists */
1301 __u8 Reserved[7];
1302 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
1303 __le32 FileNameLength;
1304 char FileName[0]; /* New name to be assigned */
1305} __packed; /* level 10 Set */
1306
1307struct smb2_file_link_info { /* encoding of request for level 11 */
1308 __u8 ReplaceIfExists; /* 1 = replace existing link with new */
1309 /* 0 = fail if link already exists */
1310 __u8 Reserved[7];
1311 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
1312 __le32 FileNameLength;
1313 char FileName[0]; /* Name to be assigned to new link */
1314} __packed; /* level 11 Set */
1315
1316#define SMB2_MIN_EA_BUF 2048
1317#define SMB2_MAX_EA_BUF 65536
1318
1319struct smb2_file_full_ea_info { /* encoding of response for level 15 */
1320 __le32 next_entry_offset;
1321 __u8 flags;
1322 __u8 ea_name_length;
1323 __le16 ea_value_length;
1324 char ea_data[0]; /* \0 terminated name plus value */
1325} __packed; /* level 15 Set */
1326
1327/*
1328 * This level 18, although with struct with same name is different from cifs
1329 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
1330 * CurrentByteOffset.
1331 */
1332struct smb2_file_all_info { /* data block encoding of response to level 18 */
1333 __le64 CreationTime; /* Beginning of FILE_BASIC_INFO equivalent */
1334 __le64 LastAccessTime;
1335 __le64 LastWriteTime;
1336 __le64 ChangeTime;
1337 __le32 Attributes;
1338 __u32 Pad1; /* End of FILE_BASIC_INFO_INFO equivalent */
1339 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
1340 __le64 EndOfFile; /* size ie offset to first free byte in file */
1341 __le32 NumberOfLinks; /* hard links */
1342 __u8 DeletePending;
1343 __u8 Directory;
1344 __u16 Pad2; /* End of FILE_STANDARD_INFO equivalent */
1345 __le64 IndexNumber;
1346 __le32 EASize;
1347 __le32 AccessFlags;
1348 __le64 CurrentByteOffset;
1349 __le32 Mode;
1350 __le32 AlignmentRequirement;
1351 __le32 FileNameLength;
1352 char FileName[1];
1353} __packed; /* level 18 Query */
1354
1355struct smb2_file_eof_info { /* encoding of request for level 10 */
1356 __le64 EndOfFile; /* new end of file value */
1357} __packed; /* level 20 Set */
1358
1359#endif /* _SMB2PDU_H */