1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3 * Copyright (C) 2016 Namjae Jeon <linkinjeon@kernel.org>
4 * Copyright (C) 2018 Samsung Electronics Co., Ltd.
5 */
6
7 #ifndef _SMB2PDU_H
8 #define _SMB2PDU_H
9
10 #include "ntlmssp.h"
11 #include "smbacl.h"
12
13 /*Create Action Flags*/
14 #define FILE_SUPERSEDED 0x00000000
15 #define FILE_OPENED 0x00000001
16 #define FILE_CREATED 0x00000002
17 #define FILE_OVERWRITTEN 0x00000003
18
19 /* SMB2 Max Credits */
20 #define SMB2_MAX_CREDITS 8192
21
22 /* BB FIXME - analyze following length BB */
23 #define MAX_SMB2_HDR_SIZE 0x78 /* 4 len + 64 hdr + (2*24 wct) + 2 bct + 2 pad */
24
25 #define SMB21_DEFAULT_IOSIZE (1024 * 1024)
26 #define SMB3_DEFAULT_TRANS_SIZE (1024 * 1024)
27 #define SMB3_MIN_IOSIZE (64 * 1024)
28 #define SMB3_MAX_IOSIZE (8 * 1024 * 1024)
29 #define SMB3_MAX_MSGSIZE (4 * 4096)
30
31 /*
32 * Definitions for SMB2 Protocol Data Units (network frames)
33 *
34 * See MS-SMB2.PDF specification for protocol details.
35 * The Naming convention is the lower case version of the SMB2
36 * command code name for the struct. Note that structures must be packed.
37 *
38 */
39
40 struct preauth_integrity_info {
41 /* PreAuth integrity Hash ID */
42 __le16 Preauth_HashId;
43 /* PreAuth integrity Hash Value */
44 __u8 Preauth_HashValue[SMB2_PREAUTH_HASH_SIZE];
45 };
46
47 /* offset is sizeof smb2_negotiate_rsp but rounded up to 8 bytes. */
48 #ifdef CONFIG_SMB_SERVER_KERBEROS5
49 /* sizeof(struct smb2_negotiate_rsp) =
50 * header(64) + response(64) + GSS_LENGTH(96) + GSS_PADDING(0)
51 */
52 #define OFFSET_OF_NEG_CONTEXT 0xe0
53 #else
54 /* sizeof(struct smb2_negotiate_rsp) =
55 * header(64) + response(64) + GSS_LENGTH(74) + GSS_PADDING(6)
56 */
57 #define OFFSET_OF_NEG_CONTEXT 0xd0
58 #endif
59
60 #define SMB2_SESSION_EXPIRED (0)
61 #define SMB2_SESSION_IN_PROGRESS BIT(0)
62 #define SMB2_SESSION_VALID BIT(1)
63
64 #define SMB2_SESSION_TIMEOUT (10 * HZ)
65
66 /* Apple Defined Contexts */
67 #define SMB2_CREATE_AAPL "AAPL"
68
69 struct create_durable_req_v2 {
70 struct create_context_hdr ccontext;
71 __u8 Name[8];
72 __le32 Timeout;
73 __le32 Flags;
74 __u8 Reserved[8];
75 __u8 CreateGuid[16];
76 } __packed;
77
78 struct create_durable_reconn_req {
79 struct create_context_hdr ccontext;
80 __u8 Name[8];
81 union {
82 __u8 Reserved[16];
83 struct {
84 __u64 PersistentFileId;
85 __u64 VolatileFileId;
86 } Fid;
87 } Data;
88 } __packed;
89
90 struct create_durable_reconn_v2_req {
91 struct create_context_hdr ccontext;
92 __u8 Name[8];
93 struct {
94 __u64 PersistentFileId;
95 __u64 VolatileFileId;
96 } Fid;
97 __u8 CreateGuid[16];
98 __le32 Flags;
99 } __packed;
100
101 struct create_alloc_size_req {
102 struct create_context_hdr ccontext;
103 __u8 Name[8];
104 __le64 AllocationSize;
105 } __packed;
106
107 struct create_durable_rsp {
108 struct create_context_hdr ccontext;
109 __u8 Name[8];
110 union {
111 __u8 Reserved[8];
112 __u64 data;
113 } Data;
114 } __packed;
115
116 /* See MS-SMB2 2.2.13.2.11 */
117 /* Flags */
118 #define SMB2_DHANDLE_FLAG_PERSISTENT 0x00000002
119 struct create_durable_v2_rsp {
120 struct create_context_hdr ccontext;
121 __u8 Name[8];
122 __le32 Timeout;
123 __le32 Flags;
124 } __packed;
125
126 /* equivalent of the contents of SMB3.1.1 POSIX open context response */
127 struct create_posix_rsp {
128 struct create_context_hdr ccontext;
129 __u8 Name[16];
130 __le32 nlink;
131 __le32 reparse_tag;
132 __le32 mode;
133 /* SidBuffer contain two sids(Domain sid(28), UNIX group sid(16)) */
134 u8 SidBuffer[44];
135 } __packed;
136
137 struct smb2_buffer_desc_v1 {
138 __le64 offset;
139 __le32 token;
140 __le32 length;
141 } __packed;
142
143 #define SMB2_0_IOCTL_IS_FSCTL 0x00000001
144
145 struct smb_sockaddr_in {
146 __be16 Port;
147 __be32 IPv4address;
148 __u8 Reserved[8];
149 } __packed;
150
151 struct smb_sockaddr_in6 {
152 __be16 Port;
153 __be32 FlowInfo;
154 __u8 IPv6address[16];
155 __be32 ScopeId;
156 } __packed;
157
158 #define INTERNETWORK 0x0002
159 #define INTERNETWORKV6 0x0017
160
161 struct sockaddr_storage_rsp {
162 __le16 Family;
163 union {
164 struct smb_sockaddr_in addr4;
165 struct smb_sockaddr_in6 addr6;
166 };
167 } __packed;
168
169 #define RSS_CAPABLE 0x00000001
170 #define RDMA_CAPABLE 0x00000002
171
172 struct network_interface_info_ioctl_rsp {
173 __le32 Next; /* next interface. zero if this is last one */
174 __le32 IfIndex;
175 __le32 Capability; /* RSS or RDMA Capable */
176 __le32 Reserved;
177 __le64 LinkSpeed;
178 char SockAddr_Storage[128];
179 } __packed;
180
181 struct file_object_buf_type1_ioctl_rsp {
182 __u8 ObjectId[16];
183 __u8 BirthVolumeId[16];
184 __u8 BirthObjectId[16];
185 __u8 DomainId[16];
186 } __packed;
187
188 struct resume_key_ioctl_rsp {
189 __u64 ResumeKey[3];
190 __le32 ContextLength;
191 __u8 Context[4]; /* ignored, Windows sets to 4 bytes of zero */
192 } __packed;
193
194 struct copychunk_ioctl_req {
195 __le64 ResumeKey[3];
196 __le32 ChunkCount;
197 __le32 Reserved;
198 __u8 Chunks[1]; /* array of srv_copychunk */
199 } __packed;
200
201 struct srv_copychunk {
202 __le64 SourceOffset;
203 __le64 TargetOffset;
204 __le32 Length;
205 __le32 Reserved;
206 } __packed;
207
208 struct copychunk_ioctl_rsp {
209 __le32 ChunksWritten;
210 __le32 ChunkBytesWritten;
211 __le32 TotalBytesWritten;
212 } __packed;
213
214 struct file_sparse {
215 __u8 SetSparse;
216 } __packed;
217
218 /* FILE Info response size */
219 #define FILE_DIRECTORY_INFORMATION_SIZE 1
220 #define FILE_FULL_DIRECTORY_INFORMATION_SIZE 2
221 #define FILE_BOTH_DIRECTORY_INFORMATION_SIZE 3
222 #define FILE_BASIC_INFORMATION_SIZE 40
223 #define FILE_STANDARD_INFORMATION_SIZE 24
224 #define FILE_INTERNAL_INFORMATION_SIZE 8
225 #define FILE_EA_INFORMATION_SIZE 4
226 #define FILE_ACCESS_INFORMATION_SIZE 4
227 #define FILE_NAME_INFORMATION_SIZE 9
228 #define FILE_RENAME_INFORMATION_SIZE 10
229 #define FILE_LINK_INFORMATION_SIZE 11
230 #define FILE_NAMES_INFORMATION_SIZE 12
231 #define FILE_DISPOSITION_INFORMATION_SIZE 13
232 #define FILE_POSITION_INFORMATION_SIZE 14
233 #define FILE_FULL_EA_INFORMATION_SIZE 15
234 #define FILE_MODE_INFORMATION_SIZE 4
235 #define FILE_ALIGNMENT_INFORMATION_SIZE 4
236 #define FILE_ALL_INFORMATION_SIZE 104
237 #define FILE_ALLOCATION_INFORMATION_SIZE 19
238 #define FILE_END_OF_FILE_INFORMATION_SIZE 20
239 #define FILE_ALTERNATE_NAME_INFORMATION_SIZE 8
240 #define FILE_STREAM_INFORMATION_SIZE 32
241 #define FILE_PIPE_INFORMATION_SIZE 23
242 #define FILE_PIPE_LOCAL_INFORMATION_SIZE 24
243 #define FILE_PIPE_REMOTE_INFORMATION_SIZE 25
244 #define FILE_MAILSLOT_QUERY_INFORMATION_SIZE 26
245 #define FILE_MAILSLOT_SET_INFORMATION_SIZE 27
246 #define FILE_COMPRESSION_INFORMATION_SIZE 16
247 #define FILE_OBJECT_ID_INFORMATION_SIZE 29
248 /* Number 30 not defined in documents */
249 #define FILE_MOVE_CLUSTER_INFORMATION_SIZE 31
250 #define FILE_QUOTA_INFORMATION_SIZE 32
251 #define FILE_REPARSE_POINT_INFORMATION_SIZE 33
252 #define FILE_NETWORK_OPEN_INFORMATION_SIZE 56
253 #define FILE_ATTRIBUTE_TAG_INFORMATION_SIZE 8
254
255 /* FS Info response size */
256 #define FS_DEVICE_INFORMATION_SIZE 8
257 #define FS_ATTRIBUTE_INFORMATION_SIZE 16
258 #define FS_VOLUME_INFORMATION_SIZE 24
259 #define FS_SIZE_INFORMATION_SIZE 24
260 #define FS_FULL_SIZE_INFORMATION_SIZE 32
261 #define FS_SECTOR_SIZE_INFORMATION_SIZE 28
262 #define FS_OBJECT_ID_INFORMATION_SIZE 64
263 #define FS_CONTROL_INFORMATION_SIZE 48
264 #define FS_POSIX_INFORMATION_SIZE 56
265
266 /* FS_ATTRIBUTE_File_System_Name */
267 #define FS_TYPE_SUPPORT_SIZE 44
268 struct fs_type_info {
269 char *fs_name;
270 long magic_number;
271 } __packed;
272
273 /*
274 * PDU query infolevel structure definitions
275 * BB consider moving to a different header
276 */
277
278 struct smb2_file_access_info {
279 __le32 AccessFlags;
280 } __packed;
281
282 struct smb2_file_alignment_info {
283 __le32 AlignmentRequirement;
284 } __packed;
285
286 struct smb2_file_basic_info { /* data block encoding of response to level 18 */
287 __le64 CreationTime; /* Beginning of FILE_BASIC_INFO equivalent */
288 __le64 LastAccessTime;
289 __le64 LastWriteTime;
290 __le64 ChangeTime;
291 __le32 Attributes;
292 __u32 Pad1; /* End of FILE_BASIC_INFO_INFO equivalent */
293 } __packed;
294
295 struct smb2_file_alt_name_info {
296 __le32 FileNameLength;
297 char FileName[];
298 } __packed;
299
300 struct smb2_file_stream_info {
301 __le32 NextEntryOffset;
302 __le32 StreamNameLength;
303 __le64 StreamSize;
304 __le64 StreamAllocationSize;
305 char StreamName[];
306 } __packed;
307
308 struct smb2_file_ntwrk_info {
309 __le64 CreationTime;
310 __le64 LastAccessTime;
311 __le64 LastWriteTime;
312 __le64 ChangeTime;
313 __le64 AllocationSize;
314 __le64 EndOfFile;
315 __le32 Attributes;
316 __le32 Reserved;
317 } __packed;
318
319 struct smb2_file_standard_info {
320 __le64 AllocationSize;
321 __le64 EndOfFile;
322 __le32 NumberOfLinks; /* hard links */
323 __u8 DeletePending;
324 __u8 Directory;
325 __le16 Reserved;
326 } __packed; /* level 18 Query */
327
328 struct smb2_file_ea_info {
329 __le32 EASize;
330 } __packed;
331
332 struct smb2_file_alloc_info {
333 __le64 AllocationSize;
334 } __packed;
335
336 struct smb2_file_disposition_info {
337 __u8 DeletePending;
338 } __packed;
339
340 struct smb2_file_pos_info {
341 __le64 CurrentByteOffset;
342 } __packed;
343
344 #define FILE_MODE_INFO_MASK cpu_to_le32(0x0000100e)
345
346 struct smb2_file_mode_info {
347 __le32 Mode;
348 } __packed;
349
350 #define COMPRESSION_FORMAT_NONE 0x0000
351 #define COMPRESSION_FORMAT_LZNT1 0x0002
352
353 struct smb2_file_comp_info {
354 __le64 CompressedFileSize;
355 __le16 CompressionFormat;
356 __u8 CompressionUnitShift;
357 __u8 ChunkShift;
358 __u8 ClusterShift;
359 __u8 Reserved[3];
360 } __packed;
361
362 struct smb2_file_attr_tag_info {
363 __le32 FileAttributes;
364 __le32 ReparseTag;
365 } __packed;
366
367 #define SL_RESTART_SCAN 0x00000001
368 #define SL_RETURN_SINGLE_ENTRY 0x00000002
369 #define SL_INDEX_SPECIFIED 0x00000004
370
371 struct smb2_ea_info_req {
372 __le32 NextEntryOffset;
373 __u8 EaNameLength;
374 char name[1];
375 } __packed; /* level 15 Query */
376
377 struct smb2_ea_info {
378 __le32 NextEntryOffset;
379 __u8 Flags;
380 __u8 EaNameLength;
381 __le16 EaValueLength;
382 char name[];
383 /* optionally followed by value */
384 } __packed; /* level 15 Query */
385
386 struct create_ea_buf_req {
387 struct create_context_hdr ccontext;
388 __u8 Name[8];
389 struct smb2_ea_info ea;
390 } __packed;
391
392 struct create_sd_buf_req {
393 struct create_context_hdr ccontext;
394 __u8 Name[8];
395 struct smb_ntsd ntsd;
396 } __packed;
397
398 struct smb2_posix_info {
399 __le32 NextEntryOffset;
400 __u32 Ignored;
401 __le64 CreationTime;
402 __le64 LastAccessTime;
403 __le64 LastWriteTime;
404 __le64 ChangeTime;
405 __le64 EndOfFile;
406 __le64 AllocationSize;
407 __le32 DosAttributes;
408 __le64 Inode;
409 __le32 DeviceId;
410 __le32 Zero;
411 /* beginning of POSIX Create Context Response */
412 __le32 HardLinks;
413 __le32 ReparseTag;
414 __le32 Mode;
415 /* SidBuffer contain two sids (UNIX user sid(16), UNIX group sid(16)) */
416 u8 SidBuffer[32];
417 __le32 name_len;
418 u8 name[];
419 /*
420 * var sized owner SID
421 * var sized group SID
422 * le32 filenamelength
423 * u8 filename[]
424 */
425 } __packed;
426
427 /* functions */
428 void init_smb2_1_server(struct ksmbd_conn *conn);
429 void init_smb3_0_server(struct ksmbd_conn *conn);
430 void init_smb3_02_server(struct ksmbd_conn *conn);
431 int init_smb3_11_server(struct ksmbd_conn *conn);
432
433 void init_smb2_max_read_size(unsigned int sz);
434 void init_smb2_max_write_size(unsigned int sz);
435 void init_smb2_max_trans_size(unsigned int sz);
436 void init_smb2_max_credits(unsigned int sz);
437
438 bool is_smb2_neg_cmd(struct ksmbd_work *work);
439 bool is_smb2_rsp(struct ksmbd_work *work);
440
441 u16 get_smb2_cmd_val(struct ksmbd_work *work);
442 void set_smb2_rsp_status(struct ksmbd_work *work, __le32 err);
443 int init_smb2_rsp_hdr(struct ksmbd_work *work);
444 int smb2_allocate_rsp_buf(struct ksmbd_work *work);
445 bool is_chained_smb2_message(struct ksmbd_work *work);
446 int init_smb2_neg_rsp(struct ksmbd_work *work);
447 void smb2_set_err_rsp(struct ksmbd_work *work);
448 int smb2_check_user_session(struct ksmbd_work *work);
449 int smb2_get_ksmbd_tcon(struct ksmbd_work *work);
450 bool smb2_is_sign_req(struct ksmbd_work *work, unsigned int command);
451 int smb2_check_sign_req(struct ksmbd_work *work);
452 void smb2_set_sign_rsp(struct ksmbd_work *work);
453 int smb3_check_sign_req(struct ksmbd_work *work);
454 void smb3_set_sign_rsp(struct ksmbd_work *work);
455 int find_matching_smb2_dialect(int start_index, __le16 *cli_dialects,
456 __le16 dialects_count);
457 struct file_lock *smb_flock_init(struct file *f);
458 int setup_async_work(struct ksmbd_work *work, void (*fn)(void **),
459 void **arg);
460 void release_async_work(struct ksmbd_work *work);
461 void smb2_send_interim_resp(struct ksmbd_work *work, __le32 status);
462 struct channel *lookup_chann_list(struct ksmbd_session *sess,
463 struct ksmbd_conn *conn);
464 void smb3_preauth_hash_rsp(struct ksmbd_work *work);
465 bool smb3_is_transform_hdr(void *buf);
466 int smb3_decrypt_req(struct ksmbd_work *work);
467 int smb3_encrypt_resp(struct ksmbd_work *work);
468 bool smb3_11_final_sess_setup_resp(struct ksmbd_work *work);
469 int smb2_set_rsp_credits(struct ksmbd_work *work);
470 bool smb3_encryption_negotiated(struct ksmbd_conn *conn);
471
472 /* smb2 misc functions */
473 int ksmbd_smb2_check_message(struct ksmbd_work *work);
474
475 /* smb2 command handlers */
476 int smb2_handle_negotiate(struct ksmbd_work *work);
477 int smb2_negotiate_request(struct ksmbd_work *work);
478 int smb2_sess_setup(struct ksmbd_work *work);
479 int smb2_tree_connect(struct ksmbd_work *work);
480 int smb2_tree_disconnect(struct ksmbd_work *work);
481 int smb2_session_logoff(struct ksmbd_work *work);
482 int smb2_open(struct ksmbd_work *work);
483 int smb2_query_info(struct ksmbd_work *work);
484 int smb2_query_dir(struct ksmbd_work *work);
485 int smb2_close(struct ksmbd_work *work);
486 int smb2_echo(struct ksmbd_work *work);
487 int smb2_set_info(struct ksmbd_work *work);
488 int smb2_read(struct ksmbd_work *work);
489 int smb2_write(struct ksmbd_work *work);
490 int smb2_flush(struct ksmbd_work *work);
491 int smb2_cancel(struct ksmbd_work *work);
492 int smb2_lock(struct ksmbd_work *work);
493 int smb2_ioctl(struct ksmbd_work *work);
494 int smb2_oplock_break(struct ksmbd_work *work);
495 int smb2_notify(struct ksmbd_work *ksmbd_work);
496
497 /*
498 * Get the body of the smb2 message excluding the 4 byte rfc1002 headers
499 * from request/response buffer.
500 */
smb2_get_msg(void * buf)501 static inline void *smb2_get_msg(void *buf)
502 {
503 return buf + 4;
504 }
505
506 #define POSIX_TYPE_FILE 0
507 #define POSIX_TYPE_DIR 1
508 #define POSIX_TYPE_SYMLINK 2
509 #define POSIX_TYPE_CHARDEV 3
510 #define POSIX_TYPE_BLKDEV 4
511 #define POSIX_TYPE_FIFO 5
512 #define POSIX_TYPE_SOCKET 6
513
514 #define POSIX_FILETYPE_SHIFT 12
515
516 #endif /* _SMB2PDU_H */
517