1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * Copyright (C) 2016 Namjae Jeon <linkinjeon@kernel.org>
4 * Copyright (C) 2018 Samsung Electronics Co., Ltd.
13 /*Create Action Flags*/
14 #define FILE_SUPERSEDED 0x00000000
15 #define FILE_OPENED 0x00000001
16 #define FILE_CREATED 0x00000002
17 #define FILE_OVERWRITTEN 0x00000003
19 /* SMB2 Max Credits */
20 #define SMB2_MAX_CREDITS 8192
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 */
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)
32 * Definitions for SMB2 Protocol Data Units (network frames)
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.
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];
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)
52 #define OFFSET_OF_NEG_CONTEXT 0xe0
54 /* sizeof(struct smb2_negotiate_rsp) =
55 * header(64) + response(64) + GSS_LENGTH(74) + GSS_PADDING(6)
57 #define OFFSET_OF_NEG_CONTEXT 0xd0
60 #define SMB2_SESSION_EXPIRED (0)
61 #define SMB2_SESSION_IN_PROGRESS BIT(0)
62 #define SMB2_SESSION_VALID BIT(1)
64 #define SMB2_SESSION_TIMEOUT (10 * HZ)
66 struct create_durable_req_v2 {
67 struct create_context ccontext;
75 struct create_durable_reconn_req {
76 struct create_context ccontext;
81 __u64 PersistentFileId;
87 struct create_durable_reconn_v2_req {
88 struct create_context ccontext;
91 __u64 PersistentFileId;
98 struct create_app_inst_id {
99 struct create_context ccontext;
102 __u8 AppInstanceId[16];
105 struct create_app_inst_id_vers {
106 struct create_context ccontext;
110 __le64 AppInstanceVersionHigh;
111 __le64 AppInstanceVersionLow;
114 struct create_mxac_req {
115 struct create_context ccontext;
120 struct create_alloc_size_req {
121 struct create_context ccontext;
123 __le64 AllocationSize;
126 struct create_durable_rsp {
127 struct create_context ccontext;
135 struct create_durable_v2_rsp {
136 struct create_context ccontext;
142 struct create_mxac_rsp {
143 struct create_context ccontext;
146 __le32 MaximalAccess;
149 struct create_disk_id_rsp {
150 struct create_context ccontext;
157 /* equivalent of the contents of SMB3.1.1 POSIX open context response */
158 struct create_posix_rsp {
159 struct create_context ccontext;
164 /* SidBuffer contain two sids(Domain sid(28), UNIX group sid(16)) */
168 struct smb2_buffer_desc_v1 {
174 #define SMB2_0_IOCTL_IS_FSCTL 0x00000001
176 struct smb_sockaddr_in {
182 struct smb_sockaddr_in6 {
185 __u8 IPv6address[16];
189 #define INTERNETWORK 0x0002
190 #define INTERNETWORKV6 0x0017
192 struct sockaddr_storage_rsp {
195 struct smb_sockaddr_in addr4;
196 struct smb_sockaddr_in6 addr6;
200 #define RSS_CAPABLE 0x00000001
201 #define RDMA_CAPABLE 0x00000002
203 struct network_interface_info_ioctl_rsp {
204 __le32 Next; /* next interface. zero if this is last one */
206 __le32 Capability; /* RSS or RDMA Capable */
209 char SockAddr_Storage[128];
212 struct file_object_buf_type1_ioctl_rsp {
214 __u8 BirthVolumeId[16];
215 __u8 BirthObjectId[16];
219 struct resume_key_ioctl_rsp {
221 __le32 ContextLength;
222 __u8 Context[4]; /* ignored, Windows sets to 4 bytes of zero */
225 struct copychunk_ioctl_req {
229 __u8 Chunks[1]; /* array of srv_copychunk */
232 struct srv_copychunk {
239 struct copychunk_ioctl_rsp {
240 __le32 ChunksWritten;
241 __le32 ChunkBytesWritten;
242 __le32 TotalBytesWritten;
249 /* FILE Info response size */
250 #define FILE_DIRECTORY_INFORMATION_SIZE 1
251 #define FILE_FULL_DIRECTORY_INFORMATION_SIZE 2
252 #define FILE_BOTH_DIRECTORY_INFORMATION_SIZE 3
253 #define FILE_BASIC_INFORMATION_SIZE 40
254 #define FILE_STANDARD_INFORMATION_SIZE 24
255 #define FILE_INTERNAL_INFORMATION_SIZE 8
256 #define FILE_EA_INFORMATION_SIZE 4
257 #define FILE_ACCESS_INFORMATION_SIZE 4
258 #define FILE_NAME_INFORMATION_SIZE 9
259 #define FILE_RENAME_INFORMATION_SIZE 10
260 #define FILE_LINK_INFORMATION_SIZE 11
261 #define FILE_NAMES_INFORMATION_SIZE 12
262 #define FILE_DISPOSITION_INFORMATION_SIZE 13
263 #define FILE_POSITION_INFORMATION_SIZE 14
264 #define FILE_FULL_EA_INFORMATION_SIZE 15
265 #define FILE_MODE_INFORMATION_SIZE 4
266 #define FILE_ALIGNMENT_INFORMATION_SIZE 4
267 #define FILE_ALL_INFORMATION_SIZE 104
268 #define FILE_ALLOCATION_INFORMATION_SIZE 19
269 #define FILE_END_OF_FILE_INFORMATION_SIZE 20
270 #define FILE_ALTERNATE_NAME_INFORMATION_SIZE 8
271 #define FILE_STREAM_INFORMATION_SIZE 32
272 #define FILE_PIPE_INFORMATION_SIZE 23
273 #define FILE_PIPE_LOCAL_INFORMATION_SIZE 24
274 #define FILE_PIPE_REMOTE_INFORMATION_SIZE 25
275 #define FILE_MAILSLOT_QUERY_INFORMATION_SIZE 26
276 #define FILE_MAILSLOT_SET_INFORMATION_SIZE 27
277 #define FILE_COMPRESSION_INFORMATION_SIZE 16
278 #define FILE_OBJECT_ID_INFORMATION_SIZE 29
279 /* Number 30 not defined in documents */
280 #define FILE_MOVE_CLUSTER_INFORMATION_SIZE 31
281 #define FILE_QUOTA_INFORMATION_SIZE 32
282 #define FILE_REPARSE_POINT_INFORMATION_SIZE 33
283 #define FILE_NETWORK_OPEN_INFORMATION_SIZE 56
284 #define FILE_ATTRIBUTE_TAG_INFORMATION_SIZE 8
286 /* FS Info response size */
287 #define FS_DEVICE_INFORMATION_SIZE 8
288 #define FS_ATTRIBUTE_INFORMATION_SIZE 16
289 #define FS_VOLUME_INFORMATION_SIZE 24
290 #define FS_SIZE_INFORMATION_SIZE 24
291 #define FS_FULL_SIZE_INFORMATION_SIZE 32
292 #define FS_SECTOR_SIZE_INFORMATION_SIZE 28
293 #define FS_OBJECT_ID_INFORMATION_SIZE 64
294 #define FS_CONTROL_INFORMATION_SIZE 48
295 #define FS_POSIX_INFORMATION_SIZE 56
297 /* FS_ATTRIBUTE_File_System_Name */
298 #define FS_TYPE_SUPPORT_SIZE 44
299 struct fs_type_info {
305 * PDU query infolevel structure definitions
306 * BB consider moving to a different header
309 struct smb2_file_access_info {
313 struct smb2_file_alignment_info {
314 __le32 AlignmentRequirement;
317 struct smb2_file_basic_info { /* data block encoding of response to level 18 */
318 __le64 CreationTime; /* Beginning of FILE_BASIC_INFO equivalent */
319 __le64 LastAccessTime;
320 __le64 LastWriteTime;
323 __u32 Pad1; /* End of FILE_BASIC_INFO_INFO equivalent */
326 struct smb2_file_alt_name_info {
327 __le32 FileNameLength;
331 struct smb2_file_stream_info {
332 __le32 NextEntryOffset;
333 __le32 StreamNameLength;
335 __le64 StreamAllocationSize;
339 struct smb2_file_ntwrk_info {
341 __le64 LastAccessTime;
342 __le64 LastWriteTime;
344 __le64 AllocationSize;
350 struct smb2_file_standard_info {
351 __le64 AllocationSize;
353 __le32 NumberOfLinks; /* hard links */
357 } __packed; /* level 18 Query */
359 struct smb2_file_ea_info {
363 struct smb2_file_alloc_info {
364 __le64 AllocationSize;
367 struct smb2_file_disposition_info {
371 struct smb2_file_pos_info {
372 __le64 CurrentByteOffset;
375 #define FILE_MODE_INFO_MASK cpu_to_le32(0x0000100e)
377 struct smb2_file_mode_info {
381 #define COMPRESSION_FORMAT_NONE 0x0000
382 #define COMPRESSION_FORMAT_LZNT1 0x0002
384 struct smb2_file_comp_info {
385 __le64 CompressedFileSize;
386 __le16 CompressionFormat;
387 __u8 CompressionUnitShift;
393 struct smb2_file_attr_tag_info {
394 __le32 FileAttributes;
398 #define SL_RESTART_SCAN 0x00000001
399 #define SL_RETURN_SINGLE_ENTRY 0x00000002
400 #define SL_INDEX_SPECIFIED 0x00000004
402 struct smb2_ea_info_req {
403 __le32 NextEntryOffset;
406 } __packed; /* level 15 Query */
408 struct smb2_ea_info {
409 __le32 NextEntryOffset;
412 __le16 EaValueLength;
414 /* optionally followed by value */
415 } __packed; /* level 15 Query */
417 struct create_ea_buf_req {
418 struct create_context ccontext;
420 struct smb2_ea_info ea;
423 struct create_sd_buf_req {
424 struct create_context ccontext;
426 struct smb_ntsd ntsd;
429 struct smb2_posix_info {
430 __le32 NextEntryOffset;
433 __le64 LastAccessTime;
434 __le64 LastWriteTime;
437 __le64 AllocationSize;
438 __le32 DosAttributes;
442 /* beginning of POSIX Create Context Response */
446 /* SidBuffer contain two sids (UNIX user sid(16), UNIX group sid(16)) */
451 * var sized owner SID
452 * var sized group SID
453 * le32 filenamelength
459 void init_smb2_1_server(struct ksmbd_conn *conn);
460 void init_smb3_0_server(struct ksmbd_conn *conn);
461 void init_smb3_02_server(struct ksmbd_conn *conn);
462 int init_smb3_11_server(struct ksmbd_conn *conn);
464 void init_smb2_max_read_size(unsigned int sz);
465 void init_smb2_max_write_size(unsigned int sz);
466 void init_smb2_max_trans_size(unsigned int sz);
467 void init_smb2_max_credits(unsigned int sz);
469 bool is_smb2_neg_cmd(struct ksmbd_work *work);
470 bool is_smb2_rsp(struct ksmbd_work *work);
472 u16 get_smb2_cmd_val(struct ksmbd_work *work);
473 void set_smb2_rsp_status(struct ksmbd_work *work, __le32 err);
474 int init_smb2_rsp_hdr(struct ksmbd_work *work);
475 int smb2_allocate_rsp_buf(struct ksmbd_work *work);
476 bool is_chained_smb2_message(struct ksmbd_work *work);
477 int init_smb2_neg_rsp(struct ksmbd_work *work);
478 void smb2_set_err_rsp(struct ksmbd_work *work);
479 int smb2_check_user_session(struct ksmbd_work *work);
480 int smb2_get_ksmbd_tcon(struct ksmbd_work *work);
481 bool smb2_is_sign_req(struct ksmbd_work *work, unsigned int command);
482 int smb2_check_sign_req(struct ksmbd_work *work);
483 void smb2_set_sign_rsp(struct ksmbd_work *work);
484 int smb3_check_sign_req(struct ksmbd_work *work);
485 void smb3_set_sign_rsp(struct ksmbd_work *work);
486 int find_matching_smb2_dialect(int start_index, __le16 *cli_dialects,
487 __le16 dialects_count);
488 struct file_lock *smb_flock_init(struct file *f);
489 int setup_async_work(struct ksmbd_work *work, void (*fn)(void **),
491 void release_async_work(struct ksmbd_work *work);
492 void smb2_send_interim_resp(struct ksmbd_work *work, __le32 status);
493 struct channel *lookup_chann_list(struct ksmbd_session *sess,
494 struct ksmbd_conn *conn);
495 void smb3_preauth_hash_rsp(struct ksmbd_work *work);
496 bool smb3_is_transform_hdr(void *buf);
497 int smb3_decrypt_req(struct ksmbd_work *work);
498 int smb3_encrypt_resp(struct ksmbd_work *work);
499 bool smb3_11_final_sess_setup_resp(struct ksmbd_work *work);
500 int smb2_set_rsp_credits(struct ksmbd_work *work);
501 bool smb3_encryption_negotiated(struct ksmbd_conn *conn);
503 /* smb2 misc functions */
504 int ksmbd_smb2_check_message(struct ksmbd_work *work);
506 /* smb2 command handlers */
507 int smb2_handle_negotiate(struct ksmbd_work *work);
508 int smb2_negotiate_request(struct ksmbd_work *work);
509 int smb2_sess_setup(struct ksmbd_work *work);
510 int smb2_tree_connect(struct ksmbd_work *work);
511 int smb2_tree_disconnect(struct ksmbd_work *work);
512 int smb2_session_logoff(struct ksmbd_work *work);
513 int smb2_open(struct ksmbd_work *work);
514 int smb2_query_info(struct ksmbd_work *work);
515 int smb2_query_dir(struct ksmbd_work *work);
516 int smb2_close(struct ksmbd_work *work);
517 int smb2_echo(struct ksmbd_work *work);
518 int smb2_set_info(struct ksmbd_work *work);
519 int smb2_read(struct ksmbd_work *work);
520 int smb2_write(struct ksmbd_work *work);
521 int smb2_flush(struct ksmbd_work *work);
522 int smb2_cancel(struct ksmbd_work *work);
523 int smb2_lock(struct ksmbd_work *work);
524 int smb2_ioctl(struct ksmbd_work *work);
525 int smb2_oplock_break(struct ksmbd_work *work);
526 int smb2_notify(struct ksmbd_work *ksmbd_work);
529 * Get the body of the smb2 message excluding the 4 byte rfc1002 headers
530 * from request/response buffer.
532 static inline void *smb2_get_msg(void *buf)
537 #endif /* _SMB2PDU_H */