1 /* SPDX-License-Identifier: LGPL-2.1 */
2 /*
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  */
10 
11 #ifndef _SMB2PDU_H
12 #define _SMB2PDU_H
13 
14 #include <net/sock.h>
15 #include "cifsacl.h"
16 
17 /* 52 transform hdr + 64 hdr + 88 create rsp */
18 #define SMB2_TRANSFORM_HEADER_SIZE 52
19 #define MAX_SMB2_HDR_SIZE 204
20 
21 /* The total header size for SMB2 read and write */
22 #define SMB2_READWRITE_PDU_HEADER_SIZE (48 + sizeof(struct smb2_hdr))
23 
24 /* See MS-SMB2 2.2.43 */
25 struct smb2_rdma_transform {
26 	__le16 RdmaDescriptorOffset;
27 	__le16 RdmaDescriptorLength;
28 	__le32 Channel; /* for values see channel description in smb2 read above */
29 	__le16 TransformCount;
30 	__le16 Reserved1;
31 	__le32 Reserved2;
32 } __packed;
33 
34 /* TransformType */
35 #define SMB2_RDMA_TRANSFORM_TYPE_ENCRYPTION	0x0001
36 #define SMB2_RDMA_TRANSFORM_TYPE_SIGNING	0x0002
37 
38 struct smb2_rdma_crypto_transform {
39 	__le16	TransformType;
40 	__le16	SignatureLength;
41 	__le16	NonceLength;
42 	__u16	Reserved;
43 	__u8	Signature[]; /* variable length */
44 	/* u8 Nonce[] */
45 	/* followed by padding */
46 } __packed;
47 
48 /*
49  *	Definitions for SMB2 Protocol Data Units (network frames)
50  *
51  *  See MS-SMB2.PDF specification for protocol details.
52  *  The Naming convention is the lower case version of the SMB2
53  *  command code name for the struct. Note that structures must be packed.
54  *
55  */
56 
57 #define COMPOUND_FID 0xFFFFFFFFFFFFFFFFULL
58 
59 #define SMB2_SYMLINK_STRUCT_SIZE \
60 	(sizeof(struct smb2_err_rsp) + sizeof(struct smb2_symlink_err_rsp))
61 
62 #define SYMLINK_ERROR_TAG 0x4c4d5953
63 
64 struct smb2_symlink_err_rsp {
65 	__le32 SymLinkLength;
66 	__le32 SymLinkErrorTag;
67 	__le32 ReparseTag;
68 	__le16 ReparseDataLength;
69 	__le16 UnparsedPathLength;
70 	__le16 SubstituteNameOffset;
71 	__le16 SubstituteNameLength;
72 	__le16 PrintNameOffset;
73 	__le16 PrintNameLength;
74 	__le32 Flags;
75 	__u8  PathBuffer[];
76 } __packed;
77 
78 /* SMB 3.1.1 and later dialects. See MS-SMB2 section 2.2.2.1 */
79 struct smb2_error_context_rsp {
80 	__le32 ErrorDataLength;
81 	__le32 ErrorId;
82 	__u8  ErrorContextData; /* ErrorDataLength long array */
83 } __packed;
84 
85 /* ErrorId values */
86 #define SMB2_ERROR_ID_DEFAULT		0x00000000
87 #define SMB2_ERROR_ID_SHARE_REDIRECT	cpu_to_le32(0x72645253)	/* "rdRS" */
88 
89 /* Defines for Type field below (see MS-SMB2 2.2.2.2.2.1) */
90 #define MOVE_DST_IPADDR_V4	cpu_to_le32(0x00000001)
91 #define MOVE_DST_IPADDR_V6	cpu_to_le32(0x00000002)
92 
93 struct move_dst_ipaddr {
94 	__le32 Type;
95 	__u32  Reserved;
96 	__u8   address[16]; /* IPv4 followed by 12 bytes rsvd or IPv6 address */
97 } __packed;
98 
99 struct share_redirect_error_context_rsp {
100 	__le32 StructureSize;
101 	__le32 NotificationType;
102 	__le32 ResourceNameOffset;
103 	__le32 ResourceNameLength;
104 	__le16 Reserved;
105 	__le16 TargetType;
106 	__le32 IPAddrCount;
107 	struct move_dst_ipaddr IpAddrMoveList[];
108 	/* __u8 ResourceName[] */ /* Name of share as counted Unicode string */
109 } __packed;
110 
111 /*
112  * Maximum number of iovs we need for an open/create request.
113  * [0] : struct smb2_create_req
114  * [1] : path
115  * [2] : lease context
116  * [3] : durable context
117  * [4] : posix context
118  * [5] : time warp context
119  * [6] : query id context
120  * [7] : compound padding
121  */
122 #define SMB2_CREATE_IOV_SIZE 8
123 
124 /*
125  * Maximum size of a SMB2_CREATE response is 64 (smb2 header) +
126  * 88 (fixed part of create response) + 520 (path) + 208 (contexts) +
127  * 2 bytes of padding.
128  */
129 #define MAX_SMB2_CREATE_RESPONSE_SIZE 880
130 
131 #define SMB2_LEASE_READ_CACHING_HE	0x01
132 #define SMB2_LEASE_HANDLE_CACHING_HE	0x02
133 #define SMB2_LEASE_WRITE_CACHING_HE	0x04
134 
135 
136 /* See MS-SMB2 2.2.13.2.11 */
137 /* Flags */
138 #define SMB2_DHANDLE_FLAG_PERSISTENT	0x00000002
139 struct durable_context_v2 {
140 	__le32 Timeout;
141 	__le32 Flags;
142 	__u64 Reserved;
143 	__u8 CreateGuid[16];
144 } __packed;
145 
146 struct create_durable_v2 {
147 	struct create_context ccontext;
148 	__u8   Name[8];
149 	struct durable_context_v2 dcontext;
150 } __packed;
151 
152 /* See MS-SMB2 2.2.13.2.12 */
153 struct durable_reconnect_context_v2 {
154 	struct {
155 		__u64 PersistentFileId;
156 		__u64 VolatileFileId;
157 	} Fid;
158 	__u8 CreateGuid[16];
159 	__le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
160 } __packed;
161 
162 /* See MS-SMB2 2.2.14.2.12 */
163 struct durable_reconnect_context_v2_rsp {
164 	__le32 Timeout;
165 	__le32 Flags; /* see above DHANDLE_FLAG_PERSISTENT */
166 } __packed;
167 
168 struct create_durable_handle_reconnect_v2 {
169 	struct create_context ccontext;
170 	__u8   Name[8];
171 	struct durable_reconnect_context_v2 dcontext;
172 	__u8   Pad[4];
173 } __packed;
174 
175 /* See MS-SMB2 2.2.13.2.5 */
176 struct crt_twarp_ctxt {
177 	struct create_context ccontext;
178 	__u8	Name[8];
179 	__le64	Timestamp;
180 
181 } __packed;
182 
183 /* See MS-SMB2 2.2.13.2.9 */
184 struct crt_query_id_ctxt {
185 	struct create_context ccontext;
186 	__u8	Name[8];
187 } __packed;
188 
189 struct crt_sd_ctxt {
190 	struct create_context ccontext;
191 	__u8	Name[8];
192 	struct smb3_sd sd;
193 } __packed;
194 
195 
196 #define COPY_CHUNK_RES_KEY_SIZE	24
197 struct resume_key_req {
198 	char ResumeKey[COPY_CHUNK_RES_KEY_SIZE];
199 	__le32	ContextLength;	/* MBZ */
200 	char	Context[];	/* ignored, Windows sets to 4 bytes of zero */
201 } __packed;
202 
203 /* this goes in the ioctl buffer when doing a copychunk request */
204 struct copychunk_ioctl {
205 	char SourceKey[COPY_CHUNK_RES_KEY_SIZE];
206 	__le32 ChunkCount; /* we are only sending 1 */
207 	__le32 Reserved;
208 	/* array will only be one chunk long for us */
209 	__le64 SourceOffset;
210 	__le64 TargetOffset;
211 	__le32 Length; /* how many bytes to copy */
212 	__u32 Reserved2;
213 } __packed;
214 
215 struct copychunk_ioctl_rsp {
216 	__le32 ChunksWritten;
217 	__le32 ChunkBytesWritten;
218 	__le32 TotalBytesWritten;
219 } __packed;
220 
221 /* See MS-FSCC 2.3.29 and 2.3.30 */
222 struct get_retrieval_pointer_count_req {
223 	__le64 StartingVcn; /* virtual cluster number (signed) */
224 } __packed;
225 
226 struct get_retrieval_pointer_count_rsp {
227 	__le32 ExtentCount;
228 } __packed;
229 
230 /*
231  * See MS-FSCC 2.3.33 and 2.3.34
232  * request is the same as get_retrieval_point_count_req struct above
233  */
234 struct smb3_extents {
235 	__le64 NextVcn;
236 	__le64 Lcn; /* logical cluster number */
237 } __packed;
238 
239 struct get_retrieval_pointers_refcount_rsp {
240 	__le32 ExtentCount;
241 	__u32  Reserved;
242 	__le64 StartingVcn;
243 	struct smb3_extents extents[];
244 } __packed;
245 
246 /* See MS-DFSC 2.2.2 */
247 struct fsctl_get_dfs_referral_req {
248 	__le16 MaxReferralLevel;
249 	__u8 RequestFileName[];
250 } __packed;
251 
252 /* DFS response is struct get_dfs_refer_rsp */
253 
254 /* See MS-SMB2 2.2.31.3 */
255 struct network_resiliency_req {
256 	__le32 Timeout;
257 	__le32 Reserved;
258 } __packed;
259 /* There is no buffer for the response ie no struct network_resiliency_rsp */
260 
261 #define RSS_CAPABLE	cpu_to_le32(0x00000001)
262 #define RDMA_CAPABLE	cpu_to_le32(0x00000002)
263 
264 #define INTERNETWORK	cpu_to_le16(0x0002)
265 #define INTERNETWORKV6	cpu_to_le16(0x0017)
266 
267 struct network_interface_info_ioctl_rsp {
268 	__le32 Next; /* next interface. zero if this is last one */
269 	__le32 IfIndex;
270 	__le32 Capability; /* RSS or RDMA Capable */
271 	__le32 Reserved;
272 	__le64 LinkSpeed;
273 	__le16 Family;
274 	__u8 Buffer[126];
275 } __packed;
276 
277 struct iface_info_ipv4 {
278 	__be16 Port;
279 	__be32 IPv4Address;
280 	__be64 Reserved;
281 } __packed;
282 
283 struct iface_info_ipv6 {
284 	__be16 Port;
285 	__be32 FlowInfo;
286 	__u8   IPv6Address[16];
287 	__be32 ScopeId;
288 } __packed;
289 
290 #define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
291 
292 struct compress_ioctl {
293 	__le16 CompressionState; /* See cifspdu.h for possible flag values */
294 } __packed;
295 
296 /*
297  * Maximum number of iovs we need for an ioctl request.
298  * [0] : struct smb2_ioctl_req
299  * [1] : in_data
300  */
301 #define SMB2_IOCTL_IOV_SIZE 2
302 
303 /*
304  *	PDU query infolevel structure definitions
305  *	BB consider moving to a different header
306  */
307 
308 struct smb2_file_full_ea_info { /* encoding of response for level 15 */
309 	__le32 next_entry_offset;
310 	__u8   flags;
311 	__u8   ea_name_length;
312 	__le16 ea_value_length;
313 	char   ea_data[]; /* \0 terminated name plus value */
314 } __packed; /* level 15 Set */
315 
316 struct smb2_file_reparse_point_info {
317 	__le64 IndexNumber;
318 	__le32 Tag;
319 } __packed;
320 
321 struct smb2_file_network_open_info {
322 	struct_group(network_open_info,
323 		__le64 CreationTime;
324 		__le64 LastAccessTime;
325 		__le64 LastWriteTime;
326 		__le64 ChangeTime;
327 		__le64 AllocationSize;
328 		__le64 EndOfFile;
329 		__le32 Attributes;
330 	);
331 	__le32 Reserved;
332 } __packed; /* level 34 Query also similar returned in close rsp and open rsp */
333 
334 /* See MS-FSCC 2.4.21 */
335 struct smb2_file_id_information {
336 	__le64	VolumeSerialNumber;
337 	__u64  PersistentFileId; /* opaque endianness */
338 	__u64  VolatileFileId; /* opaque endianness */
339 } __packed; /* level 59 */
340 
341 /* See MS-FSCC 2.4.18 */
342 struct smb2_file_id_extd_directory_info {
343 	__le32 NextEntryOffset;
344 	__u32 FileIndex;
345 	__le64 CreationTime;
346 	__le64 LastAccessTime;
347 	__le64 LastWriteTime;
348 	__le64 ChangeTime;
349 	__le64 EndOfFile;
350 	__le64 AllocationSize;
351 	__le32 FileAttributes;
352 	__le32 FileNameLength;
353 	__le32 EaSize; /* EA size */
354 	__le32 ReparsePointTag; /* valid if FILE_ATTR_REPARSE_POINT set in FileAttributes */
355 	__le64 UniqueId; /* inode num - le since Samba puts ino in low 32 bit */
356 	char FileName[];
357 } __packed; /* level 60 */
358 
359 extern char smb2_padding[7];
360 
361 /* equivalent of the contents of SMB3.1.1 POSIX open context response */
362 struct create_posix_rsp {
363 	u32 nlink;
364 	u32 reparse_tag;
365 	u32 mode;
366 	struct cifs_sid owner; /* var-sized on the wire */
367 	struct cifs_sid group; /* var-sized on the wire */
368 } __packed;
369 
370 #define SMB2_QUERY_DIRECTORY_IOV_SIZE 2
371 
372 /*
373  * SMB2-only POSIX info level for query dir
374  *
375  * See posix_info_sid_size(), posix_info_extra_size() and
376  * posix_info_parse() to help with the handling of this struct.
377  */
378 struct smb2_posix_info {
379 	__le32 NextEntryOffset;
380 	__u32 Ignored;
381 	__le64 CreationTime;
382 	__le64 LastAccessTime;
383 	__le64 LastWriteTime;
384 	__le64 ChangeTime;
385 	__le64 EndOfFile;
386 	__le64 AllocationSize;
387 	__le32 DosAttributes;
388 	__le64 Inode;
389 	__le32 DeviceId;
390 	__le32 Zero;
391 	/* beginning of POSIX Create Context Response */
392 	__le32 HardLinks;
393 	__le32 ReparseTag;
394 	__le32 Mode;
395 	/*
396 	 * var sized owner SID
397 	 * var sized group SID
398 	 * le32 filenamelength
399 	 * u8  filename[]
400 	 */
401 } __packed;
402 
403 /*
404  * Parsed version of the above struct. Allows direct access to the
405  * variable length fields
406  */
407 struct smb2_posix_info_parsed {
408 	const struct smb2_posix_info *base;
409 	size_t size;
410 	struct cifs_sid owner;
411 	struct cifs_sid group;
412 	int name_len;
413 	const u8 *name;
414 };
415 
416 #endif				/* _SMB2PDU_H */
417