1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * Copyright (C) 2018 Samsung Electronics Co., Ltd.
6 #ifndef __SMB_COMMON_H__
7 #define __SMB_COMMON_H__
9 #include <linux/kernel.h>
15 /* ksmbd's Specific ERRNO */
21 /* multi-protocol negotiate request */
26 #define BAD_PROT 0xFFFF
28 #define SMB1_VERSION_STRING "1.0"
29 #define SMB20_VERSION_STRING "2.0"
30 #define SMB21_VERSION_STRING "2.1"
31 #define SMB30_VERSION_STRING "3.0"
32 #define SMB302_VERSION_STRING "3.02"
33 #define SMB311_VERSION_STRING "3.1.1"
36 #define SMB10_PROT_ID 0x00
37 #define SMB20_PROT_ID 0x0202
38 #define SMB21_PROT_ID 0x0210
39 /* multi-protocol negotiate request */
40 #define SMB2X_PROT_ID 0x02FF
41 #define SMB30_PROT_ID 0x0300
42 #define SMB302_PROT_ID 0x0302
43 #define SMB311_PROT_ID 0x0311
44 #define BAD_PROT_ID 0xFFFF
46 #define SMB_ECHO_INTERVAL (60 * HZ)
48 #define CIFS_DEFAULT_IOSIZE (64 * 1024)
49 #define MAX_CIFS_SMALL_BUFFER_SIZE 448 /* big enough for most */
51 /* RFC 1002 session packet types */
52 #define RFC1002_SESSION_MESSAGE 0x00
53 #define RFC1002_SESSION_REQUEST 0x81
54 #define RFC1002_POSITIVE_SESSION_RESPONSE 0x82
55 #define RFC1002_NEGATIVE_SESSION_RESPONSE 0x83
56 #define RFC1002_RETARGET_SESSION_RESPONSE 0x84
57 #define RFC1002_SESSION_KEEP_ALIVE 0x85
59 /* Responses when opening a file. */
60 #define F_SUPERSEDED 0
63 #define F_OVERWRITTEN 3
66 * File Attribute flags
68 #define ATTR_READONLY 0x0001
69 #define ATTR_HIDDEN 0x0002
70 #define ATTR_SYSTEM 0x0004
71 #define ATTR_VOLUME 0x0008
72 #define ATTR_DIRECTORY 0x0010
73 #define ATTR_ARCHIVE 0x0020
74 #define ATTR_DEVICE 0x0040
75 #define ATTR_NORMAL 0x0080
76 #define ATTR_TEMPORARY 0x0100
77 #define ATTR_SPARSE 0x0200
78 #define ATTR_REPARSE 0x0400
79 #define ATTR_COMPRESSED 0x0800
80 #define ATTR_OFFLINE 0x1000
81 #define ATTR_NOT_CONTENT_INDEXED 0x2000
82 #define ATTR_ENCRYPTED 0x4000
83 #define ATTR_POSIX_SEMANTICS 0x01000000
84 #define ATTR_BACKUP_SEMANTICS 0x02000000
85 #define ATTR_DELETE_ON_CLOSE 0x04000000
86 #define ATTR_SEQUENTIAL_SCAN 0x08000000
87 #define ATTR_RANDOM_ACCESS 0x10000000
88 #define ATTR_NO_BUFFERING 0x20000000
89 #define ATTR_WRITE_THROUGH 0x80000000
91 #define ATTR_READONLY_LE cpu_to_le32(ATTR_READONLY)
92 #define ATTR_HIDDEN_LE cpu_to_le32(ATTR_HIDDEN)
93 #define ATTR_SYSTEM_LE cpu_to_le32(ATTR_SYSTEM)
94 #define ATTR_DIRECTORY_LE cpu_to_le32(ATTR_DIRECTORY)
95 #define ATTR_ARCHIVE_LE cpu_to_le32(ATTR_ARCHIVE)
96 #define ATTR_NORMAL_LE cpu_to_le32(ATTR_NORMAL)
97 #define ATTR_TEMPORARY_LE cpu_to_le32(ATTR_TEMPORARY)
98 #define ATTR_SPARSE_FILE_LE cpu_to_le32(ATTR_SPARSE)
99 #define ATTR_REPARSE_POINT_LE cpu_to_le32(ATTR_REPARSE)
100 #define ATTR_COMPRESSED_LE cpu_to_le32(ATTR_COMPRESSED)
101 #define ATTR_OFFLINE_LE cpu_to_le32(ATTR_OFFLINE)
102 #define ATTR_NOT_CONTENT_INDEXED_LE cpu_to_le32(ATTR_NOT_CONTENT_INDEXED)
103 #define ATTR_ENCRYPTED_LE cpu_to_le32(ATTR_ENCRYPTED)
104 #define ATTR_INTEGRITY_STREAML_LE cpu_to_le32(0x00008000)
105 #define ATTR_NO_SCRUB_DATA_LE cpu_to_le32(0x00020000)
106 #define ATTR_MASK_LE cpu_to_le32(0x00007FB7)
108 /* List of FileSystemAttributes - see 2.5.1 of MS-FSCC */
109 #define FILE_SUPPORTS_SPARSE_VDL 0x10000000 /* faster nonsparse extend */
110 #define FILE_SUPPORTS_BLOCK_REFCOUNTING 0x08000000 /* allow ioctl dup extents */
111 #define FILE_SUPPORT_INTEGRITY_STREAMS 0x04000000
112 #define FILE_SUPPORTS_USN_JOURNAL 0x02000000
113 #define FILE_SUPPORTS_OPEN_BY_FILE_ID 0x01000000
114 #define FILE_SUPPORTS_EXTENDED_ATTRIBUTES 0x00800000
115 #define FILE_SUPPORTS_HARD_LINKS 0x00400000
116 #define FILE_SUPPORTS_TRANSACTIONS 0x00200000
117 #define FILE_SEQUENTIAL_WRITE_ONCE 0x00100000
118 #define FILE_READ_ONLY_VOLUME 0x00080000
119 #define FILE_NAMED_STREAMS 0x00040000
120 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
121 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
122 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
123 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
124 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
125 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
126 #define FILE_VOLUME_QUOTAS 0x00000020
127 #define FILE_FILE_COMPRESSION 0x00000010
128 #define FILE_PERSISTENT_ACLS 0x00000008
129 #define FILE_UNICODE_ON_DISK 0x00000004
130 #define FILE_CASE_PRESERVED_NAMES 0x00000002
131 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
133 #define FILE_READ_DATA 0x00000001 /* Data can be read from the file */
134 #define FILE_WRITE_DATA 0x00000002 /* Data can be written to the file */
135 #define FILE_APPEND_DATA 0x00000004 /* Data can be appended to the file */
136 #define FILE_READ_EA 0x00000008 /* Extended attributes associated */
137 /* with the file can be read */
138 #define FILE_WRITE_EA 0x00000010 /* Extended attributes associated */
139 /* with the file can be written */
140 #define FILE_EXECUTE 0x00000020 /*Data can be read into memory from */
141 /* the file using system paging I/O */
142 #define FILE_DELETE_CHILD 0x00000040
143 #define FILE_READ_ATTRIBUTES 0x00000080 /* Attributes associated with the */
144 /* file can be read */
145 #define FILE_WRITE_ATTRIBUTES 0x00000100 /* Attributes associated with the */
146 /* file can be written */
147 #define DELETE 0x00010000 /* The file can be deleted */
148 #define READ_CONTROL 0x00020000 /* The access control list and */
149 /* ownership associated with the */
150 /* file can be read */
151 #define WRITE_DAC 0x00040000 /* The access control list and */
152 /* ownership associated with the */
153 /* file can be written. */
154 #define WRITE_OWNER 0x00080000 /* Ownership information associated */
155 /* with the file can be written */
156 #define SYNCHRONIZE 0x00100000 /* The file handle can waited on to */
157 /* synchronize with the completion */
158 /* of an input/output request */
159 #define GENERIC_ALL 0x10000000
160 #define GENERIC_EXECUTE 0x20000000
161 #define GENERIC_WRITE 0x40000000
162 #define GENERIC_READ 0x80000000
163 /* In summary - Relevant file */
164 /* access flags from CIFS are */
165 /* file_read_data, file_write_data */
166 /* file_execute, file_read_attributes*/
167 /* write_dac, and delete. */
169 #define FILE_READ_RIGHTS (FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES)
170 #define FILE_WRITE_RIGHTS (FILE_WRITE_DATA | FILE_APPEND_DATA \
171 | FILE_WRITE_EA | FILE_WRITE_ATTRIBUTES)
172 #define FILE_EXEC_RIGHTS (FILE_EXECUTE)
174 #define SET_FILE_READ_RIGHTS (FILE_READ_DATA | FILE_READ_EA \
175 | FILE_READ_ATTRIBUTES \
176 | DELETE | READ_CONTROL | WRITE_DAC \
177 | WRITE_OWNER | SYNCHRONIZE)
178 #define SET_FILE_WRITE_RIGHTS (FILE_WRITE_DATA | FILE_APPEND_DATA \
180 | FILE_DELETE_CHILD \
181 | FILE_WRITE_ATTRIBUTES \
182 | DELETE | READ_CONTROL | WRITE_DAC \
183 | WRITE_OWNER | SYNCHRONIZE)
184 #define SET_FILE_EXEC_RIGHTS (FILE_READ_EA | FILE_WRITE_EA | FILE_EXECUTE \
185 | FILE_READ_ATTRIBUTES \
186 | FILE_WRITE_ATTRIBUTES \
187 | DELETE | READ_CONTROL | WRITE_DAC \
188 | WRITE_OWNER | SYNCHRONIZE)
190 #define SET_MINIMUM_RIGHTS (FILE_READ_EA | FILE_READ_ATTRIBUTES \
191 | READ_CONTROL | SYNCHRONIZE)
193 /* generic flags for file open */
194 #define GENERIC_READ_FLAGS (READ_CONTROL | FILE_READ_DATA | \
195 FILE_READ_ATTRIBUTES | \
196 FILE_READ_EA | SYNCHRONIZE)
198 #define GENERIC_WRITE_FLAGS (READ_CONTROL | FILE_WRITE_DATA | \
199 FILE_WRITE_ATTRIBUTES | FILE_WRITE_EA | \
200 FILE_APPEND_DATA | SYNCHRONIZE)
202 #define GENERIC_EXECUTE_FLAGS (READ_CONTROL | FILE_EXECUTE | \
203 FILE_READ_ATTRIBUTES | SYNCHRONIZE)
205 #define GENERIC_ALL_FLAGS (DELETE | READ_CONTROL | WRITE_DAC | \
206 WRITE_OWNER | SYNCHRONIZE | FILE_READ_DATA | \
207 FILE_WRITE_DATA | FILE_APPEND_DATA | \
208 FILE_READ_EA | FILE_WRITE_EA | \
209 FILE_EXECUTE | FILE_DELETE_CHILD | \
210 FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES)
212 #define SMB1_PROTO_NUMBER cpu_to_le32(0x424d53ff)
214 #define SMB1_CLIENT_GUID_SIZE (16)
216 __be32 smb_buf_length;
228 __le16 Flags2; /* note: le */
232 __le32 SequenceNumber; /* le */
233 __u32 Reserved; /* zero */
235 __u8 SecuritySignature[8]; /* le */
236 } __packed Signature;
245 struct smb_negotiate_req {
246 struct smb_hdr hdr; /* wct = 0 */
248 unsigned char DialectsArray[1];
251 struct smb_negotiate_rsp {
252 struct smb_hdr hdr; /* wct = 17 */
253 __le16 DialectIndex; /* 0xFFFF = no dialect acceptable */
257 __le32 MaxBufferSize;
260 __le32 Capabilities; /* see below */
261 __le32 SystemTimeLow;
262 __le32 SystemTimeHigh;
263 __le16 ServerTimeZone;
264 __u8 EncryptionKeyLength;
267 unsigned char EncryptionKey[8]; /* cap extended security off */
268 /* followed by Domain name - if extended security is off */
269 /* followed by 16 bytes of server GUID */
270 /* then security blob if cap_extended_security negotiated */
272 unsigned char GUID[SMB1_CLIENT_GUID_SIZE];
273 unsigned char SecurityBlob[1];
274 } __packed extended_response;
278 struct filesystem_attribute_info {
280 __le32 MaxPathNameComponentLength;
281 __le32 FileSystemNameLen;
282 __le16 FileSystemName[1]; /* do not have to save this - get subset? */
285 struct filesystem_device_info {
287 __le32 DeviceCharacteristics;
288 } __packed; /* device info level 0x104 */
290 struct filesystem_vol_info {
291 __le64 VolumeCreationTime;
293 __le32 VolumeLabelSize;
295 __le16 VolumeLabel[1];
298 struct filesystem_info {
299 __le64 TotalAllocationUnits;
300 __le64 FreeAllocationUnits;
301 __le32 SectorsPerAllocationUnit;
302 __le32 BytesPerSector;
303 } __packed; /* size info, level 0x103 */
305 #define EXTENDED_INFO_MAGIC 0x43667364 /* Cfsd */
306 #define STRING_LENGTH 28
308 struct fs_extended_info {
313 char version_string[STRING_LENGTH];
316 struct object_id_info {
318 struct fs_extended_info extended_info;
321 struct file_directory_info {
322 __le32 NextEntryOffset;
325 __le64 LastAccessTime;
326 __le64 LastWriteTime;
329 __le64 AllocationSize;
330 __le32 ExtFileAttributes;
331 __le32 FileNameLength;
333 } __packed; /* level 0x101 FF resp data */
335 struct file_names_info {
336 __le32 NextEntryOffset;
338 __le32 FileNameLength;
340 } __packed; /* level 0xc FF resp data */
342 struct file_full_directory_info {
343 __le32 NextEntryOffset;
346 __le64 LastAccessTime;
347 __le64 LastWriteTime;
350 __le64 AllocationSize;
351 __le32 ExtFileAttributes;
352 __le32 FileNameLength;
355 } __packed; /* level 0x102 FF resp */
357 struct file_both_directory_info {
358 __le32 NextEntryOffset;
361 __le64 LastAccessTime;
362 __le64 LastWriteTime;
365 __le64 AllocationSize;
366 __le32 ExtFileAttributes;
367 __le32 FileNameLength;
368 __le32 EaSize; /* length of the xattrs */
369 __u8 ShortNameLength;
373 } __packed; /* level 0x104 FFrsp data */
375 struct file_id_both_directory_info {
376 __le32 NextEntryOffset;
379 __le64 LastAccessTime;
380 __le64 LastWriteTime;
383 __le64 AllocationSize;
384 __le32 ExtFileAttributes;
385 __le32 FileNameLength;
386 __le32 EaSize; /* length of the xattrs */
387 __u8 ShortNameLength;
395 struct file_id_full_dir_info {
396 __le32 NextEntryOffset;
399 __le64 LastAccessTime;
400 __le64 LastWriteTime;
403 __le64 AllocationSize;
404 __le32 ExtFileAttributes;
405 __le32 FileNameLength;
406 __le32 EaSize; /* EA size */
408 __le64 UniqueId; /* inode num - le since Samba puts ino in low 32 bit*/
410 } __packed; /* level 0x105 FF rsp data */
412 struct smb_version_values {
413 char *version_string;
418 __u32 max_write_size;
419 __u32 max_trans_size;
420 __u32 large_lock_type;
421 __u32 exclusive_lock_type;
422 __u32 shared_lock_type;
423 __u32 unlock_lock_type;
425 size_t max_header_size;
426 size_t read_rsp_size;
427 unsigned int cap_unix;
428 unsigned int cap_nt_find;
429 unsigned int cap_large_files;
430 __u16 signing_enabled;
431 __u16 signing_required;
432 size_t create_lease_size;
433 size_t create_durable_size;
434 size_t create_durable_v2_size;
435 size_t create_mxac_size;
436 size_t create_disk_id_size;
437 size_t create_posix_size;
440 struct filesystem_posix_info {
441 /* For undefined recommended transfer size return -1 in that field */
442 __le32 OptimalTransferSize; /* bsize on some os, iosize on other os */
444 /* The next three fields are in terms of the block size.
445 * (above). If block size is unknown, 4096 would be a
446 * reasonable block size for a server to report.
447 * Note that returning the blocks/blocksavail removes need
448 * to make a second call (to QFSInfo level 0x103 to get this info.
449 * UserBlockAvail is typically less than or equal to BlocksAvail,
450 * if no distinction is made return the same value in each
453 __le64 BlocksAvail; /* bfree */
454 __le64 UserBlocksAvail; /* bavail */
455 /* For undefined Node fields or FSID return -1 */
456 __le64 TotalFileNodes;
457 __le64 FreeFileNodes;
458 __le64 FileSysIdentifier; /* fsid */
459 /* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
460 /* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
463 struct smb_version_ops {
464 u16 (*get_cmd_val)(struct ksmbd_work *swork);
465 int (*init_rsp_hdr)(struct ksmbd_work *swork);
466 void (*set_rsp_status)(struct ksmbd_work *swork, __le32 err);
467 int (*allocate_rsp_buf)(struct ksmbd_work *work);
468 int (*set_rsp_credits)(struct ksmbd_work *work);
469 int (*check_user_session)(struct ksmbd_work *work);
470 int (*get_ksmbd_tcon)(struct ksmbd_work *work);
471 bool (*is_sign_req)(struct ksmbd_work *work, unsigned int command);
472 int (*check_sign_req)(struct ksmbd_work *work);
473 void (*set_sign_rsp)(struct ksmbd_work *work);
474 int (*generate_signingkey)(struct ksmbd_session *sess, struct ksmbd_conn *conn);
475 int (*generate_encryptionkey)(struct ksmbd_session *sess);
476 bool (*is_transform_hdr)(void *buf);
477 int (*decrypt_req)(struct ksmbd_work *work);
478 int (*encrypt_resp)(struct ksmbd_work *work);
481 struct smb_version_cmds {
482 int (*proc)(struct ksmbd_work *swork);
486 smb2_hdr_size_no_buflen(struct smb_version_values *vals)
488 return vals->header_size - 4;
491 int ksmbd_min_protocol(void);
492 int ksmbd_max_protocol(void);
494 int ksmbd_lookup_protocol_idx(char *str);
496 int ksmbd_verify_smb_message(struct ksmbd_work *work);
497 bool ksmbd_smb_request(struct ksmbd_conn *conn);
499 int ksmbd_lookup_dialect_by_id(__le16 *cli_dialects, __le16 dialects_count);
501 int ksmbd_init_smb_server(struct ksmbd_work *work);
503 bool ksmbd_pdu_size_has_room(unsigned int pdu);
506 int ksmbd_populate_dot_dotdot_entries(struct ksmbd_work *work,
508 struct ksmbd_file *dir,
509 struct ksmbd_dir_info *d_info,
510 char *search_pattern,
511 int (*fn)(struct ksmbd_conn *,
513 struct ksmbd_dir_info *,
514 struct ksmbd_kstat *));
516 int ksmbd_extract_shortname(struct ksmbd_conn *conn,
517 const char *longname,
520 int ksmbd_smb_negotiate_common(struct ksmbd_work *work, unsigned int command);
522 int ksmbd_smb_check_shared_mode(struct file *filp, struct ksmbd_file *curr_fp);
523 int ksmbd_override_fsids(struct ksmbd_work *work);
524 void ksmbd_revert_fsids(struct ksmbd_work *work);
526 unsigned int ksmbd_server_side_copy_max_chunk_count(void);
527 unsigned int ksmbd_server_side_copy_max_chunk_size(void);
528 unsigned int ksmbd_server_side_copy_max_total_size(void);
529 bool is_asterisk(char *p);
530 __le32 smb_map_generic_desired_access(__le32 daccess);
532 static inline unsigned int get_rfc1002_len(void *buf)
534 return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
537 static inline void inc_rfc1001_len(void *buf, int count)
539 be32_add_cpu((__be32 *)buf, count);
541 #endif /* __SMB_COMMON_H__ */