[linux-block.git] / fs / ksmbd / smb_common.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 *   Copyright (C) 2018 Samsung Electronics Co., Ltd.
 */

#ifndef __SMB_COMMON_H__
#define __SMB_COMMON_H__

#include <linux/kernel.h>

#include "glob.h"
#include "nterr.h"
#include "smb2pdu.h"

/* ksmbd's Specific ERRNO */
#define ESHARE			50000

#define SMB1_PROT		0
#define SMB2_PROT		1
#define SMB21_PROT		2
/* multi-protocol negotiate request */
#define SMB2X_PROT		3
#define SMB30_PROT		4
#define SMB302_PROT		5
#define SMB311_PROT		6
#define BAD_PROT		0xFFFF

#define SMB1_VERSION_STRING	"1.0"
#define SMB20_VERSION_STRING	"2.0"
#define SMB21_VERSION_STRING	"2.1"
#define SMB30_VERSION_STRING	"3.0"
#define SMB302_VERSION_STRING	"3.02"
#define SMB311_VERSION_STRING	"3.1.1"

/* Dialects */
#define SMB10_PROT_ID		0x00
#define SMB20_PROT_ID		0x0202
#define SMB21_PROT_ID		0x0210
/* multi-protocol negotiate request */
#define SMB2X_PROT_ID		0x02FF
#define SMB30_PROT_ID		0x0300
#define SMB302_PROT_ID		0x0302
#define SMB311_PROT_ID		0x0311
#define BAD_PROT_ID		0xFFFF

#define SMB_ECHO_INTERVAL	(60 * HZ)

#define CIFS_DEFAULT_IOSIZE	(64 * 1024)
#define MAX_CIFS_SMALL_BUFFER_SIZE 448 /* big enough for most */

/* Responses when opening a file. */
#define F_SUPERSEDED	0
#define F_OPENED	1
#define F_CREATED	2
#define F_OVERWRITTEN	3

/*
 * File Attribute flags
 */
#define ATTR_READONLY			0x0001
#define ATTR_HIDDEN			0x0002
#define ATTR_SYSTEM			0x0004
#define ATTR_VOLUME			0x0008
#define ATTR_DIRECTORY			0x0010
#define ATTR_ARCHIVE			0x0020
#define ATTR_DEVICE			0x0040
#define ATTR_NORMAL			0x0080
#define ATTR_TEMPORARY			0x0100
#define ATTR_SPARSE			0x0200
#define ATTR_REPARSE			0x0400
#define ATTR_COMPRESSED			0x0800
#define ATTR_OFFLINE			0x1000
#define ATTR_NOT_CONTENT_INDEXED	0x2000
#define ATTR_ENCRYPTED			0x4000
#define ATTR_POSIX_SEMANTICS		0x01000000
#define ATTR_BACKUP_SEMANTICS		0x02000000
#define ATTR_DELETE_ON_CLOSE		0x04000000
#define ATTR_SEQUENTIAL_SCAN		0x08000000
#define ATTR_RANDOM_ACCESS		0x10000000
#define ATTR_NO_BUFFERING		0x20000000
#define ATTR_WRITE_THROUGH		0x80000000

#define ATTR_READONLY_LE		cpu_to_le32(ATTR_READONLY)
#define ATTR_HIDDEN_LE			cpu_to_le32(ATTR_HIDDEN)
#define ATTR_SYSTEM_LE			cpu_to_le32(ATTR_SYSTEM)
#define ATTR_DIRECTORY_LE		cpu_to_le32(ATTR_DIRECTORY)
#define ATTR_ARCHIVE_LE			cpu_to_le32(ATTR_ARCHIVE)
#define ATTR_NORMAL_LE			cpu_to_le32(ATTR_NORMAL)
#define ATTR_TEMPORARY_LE		cpu_to_le32(ATTR_TEMPORARY)
#define ATTR_SPARSE_FILE_LE		cpu_to_le32(ATTR_SPARSE)
#define ATTR_REPARSE_POINT_LE		cpu_to_le32(ATTR_REPARSE)
#define ATTR_COMPRESSED_LE		cpu_to_le32(ATTR_COMPRESSED)
#define ATTR_OFFLINE_LE			cpu_to_le32(ATTR_OFFLINE)
#define ATTR_NOT_CONTENT_INDEXED_LE	cpu_to_le32(ATTR_NOT_CONTENT_INDEXED)
#define ATTR_ENCRYPTED_LE		cpu_to_le32(ATTR_ENCRYPTED)
#define ATTR_INTEGRITY_STREAML_LE	cpu_to_le32(0x00008000)
#define ATTR_NO_SCRUB_DATA_LE		cpu_to_le32(0x00020000)
#define ATTR_MASK_LE			cpu_to_le32(0x00007FB7)

/* List of FileSystemAttributes - see 2.5.1 of MS-FSCC */
#define FILE_SUPPORTS_SPARSE_VDL	0x10000000 /* faster nonsparse extend */
#define FILE_SUPPORTS_BLOCK_REFCOUNTING	0x08000000 /* allow ioctl dup extents */
#define FILE_SUPPORT_INTEGRITY_STREAMS	0x04000000
#define FILE_SUPPORTS_USN_JOURNAL	0x02000000
#define FILE_SUPPORTS_OPEN_BY_FILE_ID	0x01000000
#define FILE_SUPPORTS_EXTENDED_ATTRIBUTES 0x00800000
#define FILE_SUPPORTS_HARD_LINKS	0x00400000
#define FILE_SUPPORTS_TRANSACTIONS	0x00200000
#define FILE_SEQUENTIAL_WRITE_ONCE	0x00100000
#define FILE_READ_ONLY_VOLUME		0x00080000
#define FILE_NAMED_STREAMS		0x00040000
#define FILE_SUPPORTS_ENCRYPTION	0x00020000
#define FILE_SUPPORTS_OBJECT_IDS	0x00010000
#define FILE_VOLUME_IS_COMPRESSED	0x00008000
#define FILE_SUPPORTS_REMOTE_STORAGE	0x00000100
#define FILE_SUPPORTS_REPARSE_POINTS	0x00000080
#define FILE_SUPPORTS_SPARSE_FILES	0x00000040
#define FILE_VOLUME_QUOTAS		0x00000020
#define FILE_FILE_COMPRESSION		0x00000010
#define FILE_PERSISTENT_ACLS		0x00000008
#define FILE_UNICODE_ON_DISK		0x00000004
#define FILE_CASE_PRESERVED_NAMES	0x00000002
#define FILE_CASE_SENSITIVE_SEARCH	0x00000001

#define FILE_READ_DATA        0x00000001  /* Data can be read from the file   */
#define FILE_WRITE_DATA       0x00000002  /* Data can be written to the file  */
#define FILE_APPEND_DATA      0x00000004  /* Data can be appended to the file */
#define FILE_READ_EA          0x00000008  /* Extended attributes associated   */
/* with the file can be read        */
#define FILE_WRITE_EA         0x00000010  /* Extended attributes associated   */
/* with the file can be written     */
#define FILE_EXECUTE          0x00000020  /*Data can be read into memory from */
/* the file using system paging I/O */
#define FILE_DELETE_CHILD     0x00000040
#define FILE_READ_ATTRIBUTES  0x00000080  /* Attributes associated with the   */
/* file can be read                 */
#define FILE_WRITE_ATTRIBUTES 0x00000100  /* Attributes associated with the   */
/* file can be written              */
#define DELETE                0x00010000  /* The file can be deleted          */
#define READ_CONTROL          0x00020000  /* The access control list and      */
/* ownership associated with the    */
/* file can be read                 */
#define WRITE_DAC             0x00040000  /* The access control list and      */
/* ownership associated with the    */
/* file can be written.             */
#define WRITE_OWNER           0x00080000  /* Ownership information associated */
/* with the file can be written     */
#define SYNCHRONIZE           0x00100000  /* The file handle can waited on to */
/* synchronize with the completion  */
/* of an input/output request       */
#define GENERIC_ALL           0x10000000
#define GENERIC_EXECUTE       0x20000000
#define GENERIC_WRITE         0x40000000
#define GENERIC_READ          0x80000000
/* In summary - Relevant file       */
/* access flags from CIFS are       */
/* file_read_data, file_write_data  */
/* file_execute, file_read_attributes*/
/* write_dac, and delete.           */

#define FILE_READ_RIGHTS (FILE_READ_DATA | FILE_READ_EA | FILE_READ_ATTRIBUTES)
#define FILE_WRITE_RIGHTS (FILE_WRITE_DATA | FILE_APPEND_DATA \
		| FILE_WRITE_EA | FILE_WRITE_ATTRIBUTES)
#define FILE_EXEC_RIGHTS (FILE_EXECUTE)

#define SET_FILE_READ_RIGHTS (FILE_READ_DATA | FILE_READ_EA \
		| FILE_READ_ATTRIBUTES \
		| DELETE | READ_CONTROL | WRITE_DAC \
		| WRITE_OWNER | SYNCHRONIZE)
#define SET_FILE_WRITE_RIGHTS (FILE_WRITE_DATA | FILE_APPEND_DATA \
		| FILE_WRITE_EA \
		| FILE_DELETE_CHILD \
		| FILE_WRITE_ATTRIBUTES \
		| DELETE | READ_CONTROL | WRITE_DAC \
		| WRITE_OWNER | SYNCHRONIZE)
#define SET_FILE_EXEC_RIGHTS (FILE_READ_EA | FILE_WRITE_EA | FILE_EXECUTE \
		| FILE_READ_ATTRIBUTES \
		| FILE_WRITE_ATTRIBUTES \
		| DELETE | READ_CONTROL | WRITE_DAC \
		| WRITE_OWNER | SYNCHRONIZE)

#define SET_MINIMUM_RIGHTS (FILE_READ_EA | FILE_READ_ATTRIBUTES \
		| READ_CONTROL | SYNCHRONIZE)

/* generic flags for file open */
#define GENERIC_READ_FLAGS	(READ_CONTROL | FILE_READ_DATA | \
		FILE_READ_ATTRIBUTES | \
		FILE_READ_EA | SYNCHRONIZE)

#define GENERIC_WRITE_FLAGS	(READ_CONTROL | FILE_WRITE_DATA | \
		FILE_WRITE_ATTRIBUTES | FILE_WRITE_EA | \
		FILE_APPEND_DATA | SYNCHRONIZE)

#define GENERIC_EXECUTE_FLAGS	(READ_CONTROL | FILE_EXECUTE | \
		FILE_READ_ATTRIBUTES | SYNCHRONIZE)

#define GENERIC_ALL_FLAGS	(DELETE | READ_CONTROL | WRITE_DAC | \
		WRITE_OWNER | SYNCHRONIZE | FILE_READ_DATA | \
		FILE_WRITE_DATA | FILE_APPEND_DATA | \
		FILE_READ_EA | FILE_WRITE_EA | \
		FILE_EXECUTE | FILE_DELETE_CHILD | \
		FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES)

#define SMB1_PROTO_NUMBER		cpu_to_le32(0x424d53ff)
#define SMB_COM_NEGOTIATE		0x72

#define SMB1_CLIENT_GUID_SIZE		(16)
struct smb_hdr {
	__be32 smb_buf_length;
	__u8 Protocol[4];
	__u8 Command;
	union {
		struct {
			__u8 ErrorClass;
			__u8 Reserved;
			__le16 Error;
		} __packed DosError;
		__le32 CifsError;
	} __packed Status;
	__u8 Flags;
	__le16 Flags2;          /* note: le */
	__le16 PidHigh;
	union {
		struct {
			__le32 SequenceNumber;  /* le */
			__u32 Reserved; /* zero */
		} __packed Sequence;
		__u8 SecuritySignature[8];      /* le */
	} __packed Signature;
	__u8 pad[2];
	__le16 Tid;
	__le16 Pid;
	__le16 Uid;
	__le16 Mid;
	__u8 WordCount;
} __packed;

struct smb_negotiate_req {
	struct smb_hdr hdr;     /* wct = 0 */
	__le16 ByteCount;
	unsigned char DialectsArray[1];
} __packed;

struct smb_negotiate_rsp {
	struct smb_hdr hdr;     /* wct = 17 */
	__le16 DialectIndex; /* 0xFFFF = no dialect acceptable */
	__u8 SecurityMode;
	__le16 MaxMpxCount;
	__le16 MaxNumberVcs;
	__le32 MaxBufferSize;
	__le32 MaxRawSize;
	__le32 SessionKey;
	__le32 Capabilities;    /* see below */
	__le32 SystemTimeLow;
	__le32 SystemTimeHigh;
	__le16 ServerTimeZone;
	__u8 EncryptionKeyLength;
	__le16 ByteCount;
	union {
		unsigned char EncryptionKey[8]; /* cap extended security off */
		/* followed by Domain name - if extended security is off */
		/* followed by 16 bytes of server GUID */
		/* then security blob if cap_extended_security negotiated */
		struct {
			unsigned char GUID[SMB1_CLIENT_GUID_SIZE];
			unsigned char SecurityBlob[1];
		} __packed extended_response;
	} __packed u;
} __packed;

struct filesystem_attribute_info {
	__le32 Attributes;
	__le32 MaxPathNameComponentLength;
	__le32 FileSystemNameLen;
	__le16 FileSystemName[1]; /* do not have to save this - get subset? */
} __packed;

struct filesystem_device_info {
	__le32 DeviceType;
	__le32 DeviceCharacteristics;
} __packed; /* device info level 0x104 */

struct filesystem_vol_info {
	__le64 VolumeCreationTime;
	__le32 SerialNumber;
	__le32 VolumeLabelSize;
	__le16 Reserved;
	__le16 VolumeLabel[1];
} __packed;

struct filesystem_info {
	__le64 TotalAllocationUnits;
	__le64 FreeAllocationUnits;
	__le32 SectorsPerAllocationUnit;
	__le32 BytesPerSector;
} __packed;     /* size info, level 0x103 */

#define EXTENDED_INFO_MAGIC 0x43667364	/* Cfsd */
#define STRING_LENGTH 28

struct fs_extended_info {
	__le32 magic;
	__le32 version;
	__le32 release;
	__u64 rel_date;
	char    version_string[STRING_LENGTH];
} __packed;

struct object_id_info {
	char objid[16];
	struct fs_extended_info extended_info;
} __packed;

struct file_directory_info {
	__le32 NextEntryOffset;
	__u32 FileIndex;
	__le64 CreationTime;
	__le64 LastAccessTime;
	__le64 LastWriteTime;
	__le64 ChangeTime;
	__le64 EndOfFile;
	__le64 AllocationSize;
	__le32 ExtFileAttributes;
	__le32 FileNameLength;
	char FileName[1];
} __packed;   /* level 0x101 FF resp data */

struct file_names_info {
	__le32 NextEntryOffset;
	__u32 FileIndex;
	__le32 FileNameLength;
	char FileName[1];
} __packed;   /* level 0xc FF resp data */

struct file_full_directory_info {
	__le32 NextEntryOffset;
	__u32 FileIndex;
	__le64 CreationTime;
	__le64 LastAccessTime;
	__le64 LastWriteTime;
	__le64 ChangeTime;
	__le64 EndOfFile;
	__le64 AllocationSize;
	__le32 ExtFileAttributes;
	__le32 FileNameLength;
	__le32 EaSize;
	char FileName[1];
} __packed; /* level 0x102 FF resp */

struct file_both_directory_info {
	__le32 NextEntryOffset;
	__u32 FileIndex;
	__le64 CreationTime;
	__le64 LastAccessTime;
	__le64 LastWriteTime;
	__le64 ChangeTime;
	__le64 EndOfFile;
	__le64 AllocationSize;
	__le32 ExtFileAttributes;
	__le32 FileNameLength;
	__le32 EaSize; /* length of the xattrs */
	__u8   ShortNameLength;
	__u8   Reserved;
	__u8   ShortName[24];
	char FileName[1];
} __packed; /* level 0x104 FFrsp data */

struct file_id_both_directory_info {
	__le32 NextEntryOffset;
	__u32 FileIndex;
	__le64 CreationTime;
	__le64 LastAccessTime;
	__le64 LastWriteTime;
	__le64 ChangeTime;
	__le64 EndOfFile;
	__le64 AllocationSize;
	__le32 ExtFileAttributes;
	__le32 FileNameLength;
	__le32 EaSize; /* length of the xattrs */
	__u8   ShortNameLength;
	__u8   Reserved;
	__u8   ShortName[24];
	__le16 Reserved2;
	__le64 UniqueId;
	char FileName[1];
} __packed;

struct file_id_full_dir_info {
	__le32 NextEntryOffset;
	__u32 FileIndex;
	__le64 CreationTime;
	__le64 LastAccessTime;
	__le64 LastWriteTime;
	__le64 ChangeTime;
	__le64 EndOfFile;
	__le64 AllocationSize;
	__le32 ExtFileAttributes;
	__le32 FileNameLength;
	__le32 EaSize; /* EA size */
	__le32 Reserved;
	__le64 UniqueId; /* inode num - le since Samba puts ino in low 32 bit*/
	char FileName[1];
} __packed; /* level 0x105 FF rsp data */

struct smb_version_values {
	char		*version_string;
	__u16		protocol_id;
	__le16		lock_cmd;
	__u32		capabilities;
	__u32		max_read_size;
	__u32		max_write_size;
	__u32		max_trans_size;
	__u32		large_lock_type;
	__u32		exclusive_lock_type;
	__u32		shared_lock_type;
	__u32		unlock_lock_type;
	size_t		header_size;
	size_t		max_header_size;
	size_t		read_rsp_size;
	unsigned int	cap_unix;
	unsigned int	cap_nt_find;
	unsigned int	cap_large_files;
	__u16		signing_enabled;
	__u16		signing_required;
	size_t		create_lease_size;
	size_t		create_durable_size;
	size_t		create_durable_v2_size;
	size_t		create_mxac_size;
	size_t		create_disk_id_size;
	size_t		create_posix_size;
};

struct filesystem_posix_info {
	/* For undefined recommended transfer size return -1 in that field */
	__le32 OptimalTransferSize;  /* bsize on some os, iosize on other os */
	__le32 BlockSize;
	/* The next three fields are in terms of the block size.
	 * (above). If block size is unknown, 4096 would be a
	 * reasonable block size for a server to report.
	 * Note that returning the blocks/blocksavail removes need
	 * to make a second call (to QFSInfo level 0x103 to get this info.
	 * UserBlockAvail is typically less than or equal to BlocksAvail,
	 * if no distinction is made return the same value in each
	 */
	__le64 TotalBlocks;
	__le64 BlocksAvail;       /* bfree */
	__le64 UserBlocksAvail;   /* bavail */
	/* For undefined Node fields or FSID return -1 */
	__le64 TotalFileNodes;
	__le64 FreeFileNodes;
	__le64 FileSysIdentifier;   /* fsid */
	/* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
	/* NB flags can come from FILE_SYSTEM_DEVICE_INFO call   */
} __packed;

struct smb_version_ops {
	u16 (*get_cmd_val)(struct ksmbd_work *swork);
	int (*init_rsp_hdr)(struct ksmbd_work *swork);
	void (*set_rsp_status)(struct ksmbd_work *swork, __le32 err);
	int (*allocate_rsp_buf)(struct ksmbd_work *work);
	int (*set_rsp_credits)(struct ksmbd_work *work);
	int (*check_user_session)(struct ksmbd_work *work);
	int (*get_ksmbd_tcon)(struct ksmbd_work *work);
	bool (*is_sign_req)(struct ksmbd_work *work, unsigned int command);
	int (*check_sign_req)(struct ksmbd_work *work);
	void (*set_sign_rsp)(struct ksmbd_work *work);
	int (*generate_signingkey)(struct ksmbd_session *sess, struct ksmbd_conn *conn);
	int (*generate_encryptionkey)(struct ksmbd_session *sess);
	bool (*is_transform_hdr)(void *buf);
	int (*decrypt_req)(struct ksmbd_work *work);
	int (*encrypt_resp)(struct ksmbd_work *work);
};

struct smb_version_cmds {
	int (*proc)(struct ksmbd_work *swork);
};

static inline size_t
smb2_hdr_size_no_buflen(struct smb_version_values *vals)
{
	return vals->header_size - 4;
}

int ksmbd_min_protocol(void);
int ksmbd_max_protocol(void);

int ksmbd_lookup_protocol_idx(char *str);

int ksmbd_verify_smb_message(struct ksmbd_work *work);
bool ksmbd_smb_request(struct ksmbd_conn *conn);

int ksmbd_lookup_dialect_by_id(__le16 *cli_dialects, __le16 dialects_count);

int ksmbd_init_smb_server(struct ksmbd_work *work);

bool ksmbd_pdu_size_has_room(unsigned int pdu);

struct ksmbd_kstat;
int ksmbd_populate_dot_dotdot_entries(struct ksmbd_work *work,
				      int info_level,
				      struct ksmbd_file *dir,
				      struct ksmbd_dir_info *d_info,
				      char *search_pattern,
				      int (*fn)(struct ksmbd_conn *,
						int,
						struct ksmbd_dir_info *,
						struct ksmbd_kstat *));

int ksmbd_extract_shortname(struct ksmbd_conn *conn,
			    const char *longname,
			    char *shortname);

int ksmbd_smb_negotiate_common(struct ksmbd_work *work, unsigned int command);

int ksmbd_smb_check_shared_mode(struct file *filp, struct ksmbd_file *curr_fp);
int ksmbd_override_fsids(struct ksmbd_work *work);
void ksmbd_revert_fsids(struct ksmbd_work *work);

unsigned int ksmbd_server_side_copy_max_chunk_count(void);
unsigned int ksmbd_server_side_copy_max_chunk_size(void);
unsigned int ksmbd_server_side_copy_max_total_size(void);
bool is_asterisk(char *p);
__le32 smb_map_generic_desired_access(__le32 daccess);

static inline unsigned int get_rfc1002_len(void *buf)
{
	return be32_to_cpu(*((__be32 *)buf)) & 0xffffff;
}

static inline void inc_rfc1001_len(void *buf, int count)
{
	be32_add_cpu((__be32 *)buf, count);
}
#endif /* __SMB_COMMON_H__ */
Commit	Line	Data
e2f34481 NJ	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
	2	/*
	3	* Copyright (C) 2018 Samsung Electronics Co., Ltd.
	4	*/
	5
	6	#ifndef __SMB_COMMON_H__
	7	#define __SMB_COMMON_H__
	8
	9	#include <linux/kernel.h>
	10
	11	#include "glob.h"
	12	#include "nterr.h"
	13	#include "smb2pdu.h"
	14
	15	/* ksmbd's Specific ERRNO */
	16	#define ESHARE 50000
	17
	18	#define SMB1_PROT 0
	19	#define SMB2_PROT 1
	20	#define SMB21_PROT 2
	21	/* multi-protocol negotiate request */
	22	#define SMB2X_PROT 3
	23	#define SMB30_PROT 4
	24	#define SMB302_PROT 5
	25	#define SMB311_PROT 6
	26	#define BAD_PROT 0xFFFF
	27
	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"
	34
	35	/* Dialects */
	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
	45
64b39f4a	46	#define SMB_ECHO_INTERVAL (60 * HZ)
e2f34481 NJ	47
	48	#define CIFS_DEFAULT_IOSIZE (64 * 1024)
	49	#define MAX_CIFS_SMALL_BUFFER_SIZE 448 /* big enough for most */
	50
e2f34481 NJ	51	/* Responses when opening a file. */
	52	#define F_SUPERSEDED 0
	53	#define F_OPENED 1
	54	#define F_CREATED 2
	55	#define F_OVERWRITTEN 3
	56
	57	/*
	58	* File Attribute flags
	59	*/
	60	#define ATTR_READONLY 0x0001
	61	#define ATTR_HIDDEN 0x0002
	62	#define ATTR_SYSTEM 0x0004
	63	#define ATTR_VOLUME 0x0008
	64	#define ATTR_DIRECTORY 0x0010
	65	#define ATTR_ARCHIVE 0x0020
	66	#define ATTR_DEVICE 0x0040
	67	#define ATTR_NORMAL 0x0080
	68	#define ATTR_TEMPORARY 0x0100
	69	#define ATTR_SPARSE 0x0200
	70	#define ATTR_REPARSE 0x0400
	71	#define ATTR_COMPRESSED 0x0800
	72	#define ATTR_OFFLINE 0x1000
	73	#define ATTR_NOT_CONTENT_INDEXED 0x2000
	74	#define ATTR_ENCRYPTED 0x4000
	75	#define ATTR_POSIX_SEMANTICS 0x01000000
	76	#define ATTR_BACKUP_SEMANTICS 0x02000000
	77	#define ATTR_DELETE_ON_CLOSE 0x04000000
	78	#define ATTR_SEQUENTIAL_SCAN 0x08000000
	79	#define ATTR_RANDOM_ACCESS 0x10000000
	80	#define ATTR_NO_BUFFERING 0x20000000
	81	#define ATTR_WRITE_THROUGH 0x80000000
	82
	83	#define ATTR_READONLY_LE cpu_to_le32(ATTR_READONLY)
	84	#define ATTR_HIDDEN_LE cpu_to_le32(ATTR_HIDDEN)
	85	#define ATTR_SYSTEM_LE cpu_to_le32(ATTR_SYSTEM)
	86	#define ATTR_DIRECTORY_LE cpu_to_le32(ATTR_DIRECTORY)
	87	#define ATTR_ARCHIVE_LE cpu_to_le32(ATTR_ARCHIVE)
	88	#define ATTR_NORMAL_LE cpu_to_le32(ATTR_NORMAL)
	89	#define ATTR_TEMPORARY_LE cpu_to_le32(ATTR_TEMPORARY)
	90	#define ATTR_SPARSE_FILE_LE cpu_to_le32(ATTR_SPARSE)
	91	#define ATTR_REPARSE_POINT_LE cpu_to_le32(ATTR_REPARSE)
	92	#define ATTR_COMPRESSED_LE cpu_to_le32(ATTR_COMPRESSED)
	93	#define ATTR_OFFLINE_LE cpu_to_le32(ATTR_OFFLINE)
	94	#define ATTR_NOT_CONTENT_INDEXED_LE cpu_to_le32(ATTR_NOT_CONTENT_INDEXED)
	95	#define ATTR_ENCRYPTED_LE cpu_to_le32(ATTR_ENCRYPTED)
	96	#define ATTR_INTEGRITY_STREAML_LE cpu_to_le32(0x00008000)
	97	#define ATTR_NO_SCRUB_DATA_LE cpu_to_le32(0x00020000)
	98	#define ATTR_MASK_LE cpu_to_le32(0x00007FB7)
	99
	100	/* List of FileSystemAttributes - see 2.5.1 of MS-FSCC */
	101	#define FILE_SUPPORTS_SPARSE_VDL 0x10000000 /* faster nonsparse extend */
	102	#define FILE_SUPPORTS_BLOCK_REFCOUNTING 0x08000000 /* allow ioctl dup extents */
	103	#define FILE_SUPPORT_INTEGRITY_STREAMS 0x04000000
	104	#define FILE_SUPPORTS_USN_JOURNAL 0x02000000
	105	#define FILE_SUPPORTS_OPEN_BY_FILE_ID 0x01000000
	106	#define FILE_SUPPORTS_EXTENDED_ATTRIBUTES 0x00800000
	107	#define FILE_SUPPORTS_HARD_LINKS 0x00400000
	108	#define FILE_SUPPORTS_TRANSACTIONS 0x00200000
	109	#define FILE_SEQUENTIAL_WRITE_ONCE 0x00100000
	110	#define FILE_READ_ONLY_VOLUME 0x00080000
	111	#define FILE_NAMED_STREAMS 0x00040000
	112	#define FILE_SUPPORTS_ENCRYPTION 0x00020000
	113	#define FILE_SUPPORTS_OBJECT_IDS 0x00010000
	114	#define FILE_VOLUME_IS_COMPRESSED 0x00008000
115	#define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
116	#define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
117	#define FILE_SUPPORTS_SPARSE_FILES 0x00000040
118	#define FILE_VOLUME_QUOTAS 0x00000020
119	#define FILE_FILE_COMPRESSION 0x00000010
120	#define FILE_PERSISTENT_ACLS 0x00000008
121	#define FILE_UNICODE_ON_DISK 0x00000004
122	#define FILE_CASE_PRESERVED_NAMES 0x00000002
123	#define FILE_CASE_SENSITIVE_SEARCH 0x00000001
124
125	#define FILE_READ_DATA 0x00000001 /* Data can be read from the file */
126	#define FILE_WRITE_DATA 0x00000002 /* Data can be written to the file */
127	#define FILE_APPEND_DATA 0x00000004 /* Data can be appended to the file */
128	#define FILE_READ_EA 0x00000008 /* Extended attributes associated */
129	/* with the file can be read */
130	#define FILE_WRITE_EA 0x00000010 /* Extended attributes associated */
131	/* with the file can be written */
132	#define FILE_EXECUTE 0x00000020 /Data can be read into memory from /
133	/* the file using system paging I/O */
134	#define FILE_DELETE_CHILD 0x00000040
135	#define FILE_READ_ATTRIBUTES 0x00000080 /* Attributes associated with the */
136	/* file can be read */
137	#define FILE_WRITE_ATTRIBUTES 0x00000100 /* Attributes associated with the */
138	/* file can be written */
139	#define DELETE 0x00010000 /* The file can be deleted */
140	#define READ_CONTROL 0x00020000 /* The access control list and */
141	/* ownership associated with the */
142	/* file can be read */
143	#define WRITE_DAC 0x00040000 /* The access control list and */
144	/* ownership associated with the */
145	/* file can be written. */
146	#define WRITE_OWNER 0x00080000 /* Ownership information associated */
147	/* with the file can be written */
148	#define SYNCHRONIZE 0x00100000 /* The file handle can waited on to */
149	/* synchronize with the completion */
150	/* of an input/output request */
151	#define GENERIC_ALL 0x10000000
152	#define GENERIC_EXECUTE 0x20000000
153	#define GENERIC_WRITE 0x40000000
154	#define GENERIC_READ 0x80000000
155	/* In summary - Relevant file */
156	/* access flags from CIFS are */
157	/* file_read_data, file_write_data */
158	/* file_execute, file_read_attributes*/
159	/* write_dac, and delete. */
160
161	#define FILE_READ_RIGHTS (FILE_READ_DATA \| FILE_READ_EA \| FILE_READ_ATTRIBUTES)
162	#define FILE_WRITE_RIGHTS (FILE_WRITE_DATA \| FILE_APPEND_DATA \
163	\| FILE_WRITE_EA \| FILE_WRITE_ATTRIBUTES)
164	#define FILE_EXEC_RIGHTS (FILE_EXECUTE)
165
166	#define SET_FILE_READ_RIGHTS (FILE_READ_DATA \| FILE_READ_EA \
167	\| FILE_READ_ATTRIBUTES \
168	\| DELETE \| READ_CONTROL \| WRITE_DAC \
169	\| WRITE_OWNER \| SYNCHRONIZE)
170	#define SET_FILE_WRITE_RIGHTS (FILE_WRITE_DATA \| FILE_APPEND_DATA \
171	\| FILE_WRITE_EA \
172	\| FILE_DELETE_CHILD \
173	\| FILE_WRITE_ATTRIBUTES \
174	\| DELETE \| READ_CONTROL \| WRITE_DAC \
175	\| WRITE_OWNER \| SYNCHRONIZE)
176	#define SET_FILE_EXEC_RIGHTS (FILE_READ_EA \| FILE_WRITE_EA \| FILE_EXECUTE \
177	\| FILE_READ_ATTRIBUTES \
178	\| FILE_WRITE_ATTRIBUTES \
179	\| DELETE \| READ_CONTROL \| WRITE_DAC \
180	\| WRITE_OWNER \| SYNCHRONIZE)
181
182	#define SET_MINIMUM_RIGHTS (FILE_READ_EA \| FILE_READ_ATTRIBUTES \
183	\| READ_CONTROL \| SYNCHRONIZE)
184
185	/* generic flags for file open */
186	#define GENERIC_READ_FLAGS (READ_CONTROL \| FILE_READ_DATA \| \
187	FILE_READ_ATTRIBUTES \| \
188	FILE_READ_EA \| SYNCHRONIZE)
189
190	#define GENERIC_WRITE_FLAGS (READ_CONTROL \| FILE_WRITE_DATA \| \
191	FILE_WRITE_ATTRIBUTES \| FILE_WRITE_EA \| \
192	FILE_APPEND_DATA \| SYNCHRONIZE)
193
194	#define GENERIC_EXECUTE_FLAGS (READ_CONTROL \| FILE_EXECUTE \| \
195	FILE_READ_ATTRIBUTES \| SYNCHRONIZE)
196
197	#define GENERIC_ALL_FLAGS (DELETE \| READ_CONTROL \| WRITE_DAC \| \
198	WRITE_OWNER \| SYNCHRONIZE \| FILE_READ_DATA \| \
199	FILE_WRITE_DATA \| FILE_APPEND_DATA \| \
200	FILE_READ_EA \| FILE_WRITE_EA \| \
201	FILE_EXECUTE \| FILE_DELETE_CHILD \| \
202	FILE_READ_ATTRIBUTES \| FILE_WRITE_ATTRIBUTES)
203
204	#define SMB1_PROTO_NUMBER cpu_to_le32(0x424d53ff)
18a015bc	205	#define SMB_COM_NEGOTIATE 0x72
e2f34481 NJ	206
	207	#define SMB1_CLIENT_GUID_SIZE (16)
	208	struct smb_hdr {
	209	__be32 smb_buf_length;
	210	__u8 Protocol[4];
	211	__u8 Command;
	212	union {
	213	struct {
	214	__u8 ErrorClass;
	215	__u8 Reserved;
	216	__le16 Error;
	217	} __packed DosError;
	218	__le32 CifsError;
	219	} __packed Status;
	220	__u8 Flags;
	221	__le16 Flags2; /* note: le */
	222	__le16 PidHigh;
	223	union {
	224	struct {
	225	__le32 SequenceNumber; /* le */
	226	__u32 Reserved; /* zero */
	227	} __packed Sequence;
	228	__u8 SecuritySignature[8]; /* le */
	229	} __packed Signature;
	230	__u8 pad[2];
	231	__le16 Tid;
	232	__le16 Pid;
	233	__le16 Uid;
	234	__le16 Mid;
	235	__u8 WordCount;
	236	} __packed;
	237
	238	struct smb_negotiate_req {
	239	struct smb_hdr hdr; /* wct = 0 */
	240	__le16 ByteCount;
	241	unsigned char DialectsArray[1];
	242	} __packed;
	243
	244	struct smb_negotiate_rsp {
	245	struct smb_hdr hdr; /* wct = 17 */
	246	__le16 DialectIndex; /* 0xFFFF = no dialect acceptable */
	247	__u8 SecurityMode;
	248	__le16 MaxMpxCount;
	249	__le16 MaxNumberVcs;
	250	__le32 MaxBufferSize;
	251	__le32 MaxRawSize;
	252	__le32 SessionKey;
	253	__le32 Capabilities; /* see below */
	254	__le32 SystemTimeLow;
	255	__le32 SystemTimeHigh;
	256	__le16 ServerTimeZone;
	257	__u8 EncryptionKeyLength;
	258	__le16 ByteCount;
	259	union {
	260	unsigned char EncryptionKey[8]; /* cap extended security off */
	261	/* followed by Domain name - if extended security is off */
	262	/* followed by 16 bytes of server GUID */
	263	/* then security blob if cap_extended_security negotiated */
	264	struct {
	265	unsigned char GUID[SMB1_CLIENT_GUID_SIZE];
	266	unsigned char SecurityBlob[1];
	267	} __packed extended_response;
	268	} __packed u;
	269	} __packed;
270
271	struct filesystem_attribute_info {
272	__le32 Attributes;
273	__le32 MaxPathNameComponentLength;
274	__le32 FileSystemNameLen;
275	__le16 FileSystemName[1]; /* do not have to save this - get subset? */
276	} __packed;
277
278	struct filesystem_device_info {
279	__le32 DeviceType;
280	__le32 DeviceCharacteristics;
281	} __packed; /* device info level 0x104 */
282
283	struct filesystem_vol_info {
284	__le64 VolumeCreationTime;
285	__le32 SerialNumber;
286	__le32 VolumeLabelSize;
287	__le16 Reserved;
288	__le16 VolumeLabel[1];
289	} __packed;
290
291	struct filesystem_info {
292	__le64 TotalAllocationUnits;
293	__le64 FreeAllocationUnits;
294	__le32 SectorsPerAllocationUnit;
295	__le32 BytesPerSector;
296	} __packed; /* size info, level 0x103 */
297
298	#define EXTENDED_INFO_MAGIC 0x43667364 /* Cfsd */
299	#define STRING_LENGTH 28
300
301	struct fs_extended_info {
302	__le32 magic;
303	__le32 version;
304	__le32 release;
305	__u64 rel_date;
306	char version_string[STRING_LENGTH];
307	} __packed;
308
309	struct object_id_info {
310	char objid[16];
311	struct fs_extended_info extended_info;
312	} __packed;
313
314	struct file_directory_info {
315	__le32 NextEntryOffset;
316	__u32 FileIndex;
317	__le64 CreationTime;
318	__le64 LastAccessTime;
319	__le64 LastWriteTime;
320	__le64 ChangeTime;
321	__le64 EndOfFile;
322	__le64 AllocationSize;
323	__le32 ExtFileAttributes;
324	__le32 FileNameLength;
325	char FileName[1];
326	} __packed; /* level 0x101 FF resp data */
327
328	struct file_names_info {
329	__le32 NextEntryOffset;
330	__u32 FileIndex;
331	__le32 FileNameLength;
332	char FileName[1];
333	} __packed; /* level 0xc FF resp data */
334
335	struct file_full_directory_info {
336	__le32 NextEntryOffset;
337	__u32 FileIndex;
338	__le64 CreationTime;
339	__le64 LastAccessTime;
340	__le64 LastWriteTime;
341	__le64 ChangeTime;
342	__le64 EndOfFile;
343	__le64 AllocationSize;
344	__le32 ExtFileAttributes;
345	__le32 FileNameLength;
346	__le32 EaSize;
347	char FileName[1];
348	} __packed; /* level 0x102 FF resp */
349
350	struct file_both_directory_info {
351	__le32 NextEntryOffset;
352	__u32 FileIndex;
353	__le64 CreationTime;
354	__le64 LastAccessTime;
355	__le64 LastWriteTime;
356	__le64 ChangeTime;
357	__le64 EndOfFile;
358	__le64 AllocationSize;
359	__le32 ExtFileAttributes;
360	__le32 FileNameLength;
361	__le32 EaSize; /* length of the xattrs */
362	__u8 ShortNameLength;
363	__u8 Reserved;
364	__u8 ShortName[24];
365	char FileName[1];
366	} __packed; /* level 0x104 FFrsp data */
367
368	struct file_id_both_directory_info {
369	__le32 NextEntryOffset;
370	__u32 FileIndex;
371	__le64 CreationTime;
372	__le64 LastAccessTime;
373	__le64 LastWriteTime;
374	__le64 ChangeTime;
375	__le64 EndOfFile;
376	__le64 AllocationSize;
377	__le32 ExtFileAttributes;
378	__le32 FileNameLength;
379	__le32 EaSize; /* length of the xattrs */
380	__u8 ShortNameLength;
381	__u8 Reserved;
382	__u8 ShortName[24];
383	__le16 Reserved2;
384	__le64 UniqueId;
385	char FileName[1];
386	} __packed;
387
388	struct file_id_full_dir_info {
389	__le32 NextEntryOffset;
390	__u32 FileIndex;
391	__le64 CreationTime;
392	__le64 LastAccessTime;
393	__le64 LastWriteTime;
394	__le64 ChangeTime;
395	__le64 EndOfFile;
396	__le64 AllocationSize;
397	__le32 ExtFileAttributes;
398	__le32 FileNameLength;
399	__le32 EaSize; /* EA size */
400	__le32 Reserved;
401	__le64 UniqueId; /* inode num - le since Samba puts ino in low 32 bit*/
402	char FileName[1];
403	} __packed; /* level 0x105 FF rsp data */
404
405	struct smb_version_values {
406	char *version_string;
407	__u16 protocol_id;
408	__le16 lock_cmd;
409	__u32 capabilities;
410	__u32 max_read_size;
411	__u32 max_write_size;
412	__u32 max_trans_size;
413	__u32 large_lock_type;
414	__u32 exclusive_lock_type;
415	__u32 shared_lock_type;
416	__u32 unlock_lock_type;
417	size_t header_size;
418	size_t max_header_size;
419	size_t read_rsp_size;
420	unsigned int cap_unix;
421	unsigned int cap_nt_find;
422	unsigned int cap_large_files;
423	__u16 signing_enabled;
424	__u16 signing_required;
425	size_t create_lease_size;
426	size_t create_durable_size;
427	size_t create_durable_v2_size;
428	size_t create_mxac_size;
429	size_t create_disk_id_size;
430	size_t create_posix_size;
431	};
432
433	struct filesystem_posix_info {
434	/* For undefined recommended transfer size return -1 in that field */
435	__le32 OptimalTransferSize; /* bsize on some os, iosize on other os */
436	__le32 BlockSize;
437	/* The next three fields are in terms of the block size.
438	* (above). If block size is unknown, 4096 would be a
439	* reasonable block size for a server to report.
440	* Note that returning the blocks/blocksavail removes need
441	* to make a second call (to QFSInfo level 0x103 to get this info.
442	* UserBlockAvail is typically less than or equal to BlocksAvail,
443	* if no distinction is made return the same value in each
444	*/
445	__le64 TotalBlocks;
446	__le64 BlocksAvail; /* bfree */
447	__le64 UserBlocksAvail; /* bavail */
448	/* For undefined Node fields or FSID return -1 */
449	__le64 TotalFileNodes;
450	__le64 FreeFileNodes;
451	__le64 FileSysIdentifier; /* fsid */
452	/* NB Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call */
453	/* NB flags can come from FILE_SYSTEM_DEVICE_INFO call */
454	} __packed;
455
456	struct smb_version_ops {
fc2d1b58	457	u16 (get_cmd_val)(struct ksmbd_work swork);
e2f34481 NJ	458	int (init_rsp_hdr)(struct ksmbd_work swork);
	459	void (set_rsp_status)(struct ksmbd_work swork, __le32 err);
	460	int (allocate_rsp_buf)(struct ksmbd_work work);
	461	int (set_rsp_credits)(struct ksmbd_work work);
	462	int (check_user_session)(struct ksmbd_work work);
	463	int (get_ksmbd_tcon)(struct ksmbd_work work);
	464	bool (is_sign_req)(struct ksmbd_work work, unsigned int command);
	465	int (check_sign_req)(struct ksmbd_work work);
	466	void (set_sign_rsp)(struct ksmbd_work work);
f5a544e3	467	int (generate_signingkey)(struct ksmbd_session sess, struct ksmbd_conn *conn);
e2f34481	468	int (generate_encryptionkey)(struct ksmbd_session sess);
f4228b67	469	bool (is_transform_hdr)(void buf);
e2f34481 NJ	470	int (decrypt_req)(struct ksmbd_work work);
	471	int (encrypt_resp)(struct ksmbd_work work);
	472	};
	473
	474	struct smb_version_cmds {
	475	int (proc)(struct ksmbd_work swork);
	476	};
	477
d8fb2998 HL	478	static inline size_t
	479	smb2_hdr_size_no_buflen(struct smb_version_values *vals)
	480	{
	481	return vals->header_size - 4;
	482	}
	483
e2f34481 NJ	484	int ksmbd_min_protocol(void);
	485	int ksmbd_max_protocol(void);
	486
	487	int ksmbd_lookup_protocol_idx(char *str);
	488
	489	int ksmbd_verify_smb_message(struct ksmbd_work *work);
	490	bool ksmbd_smb_request(struct ksmbd_conn *conn);
	491
	492	int ksmbd_lookup_dialect_by_id(__le16 *cli_dialects, __le16 dialects_count);
	493
e2f34481 NJ	494	int ksmbd_init_smb_server(struct ksmbd_work *work);
	495
	496	bool ksmbd_pdu_size_has_room(unsigned int pdu);
	497
	498	struct ksmbd_kstat;
	499	int ksmbd_populate_dot_dotdot_entries(struct ksmbd_work *work,
	500	int info_level,
	501	struct ksmbd_file *dir,
	502	struct ksmbd_dir_info *d_info,
	503	char *search_pattern,
	504	int (fn)(struct ksmbd_conn ,
	505	int,
	506	struct ksmbd_dir_info *,
	507	struct ksmbd_kstat *));
	508
	509	int ksmbd_extract_shortname(struct ksmbd_conn *conn,
	510	const char *longname,
	511	char *shortname);
	512
	513	int ksmbd_smb_negotiate_common(struct ksmbd_work *work, unsigned int command);
	514
	515	int ksmbd_smb_check_shared_mode(struct file filp, struct ksmbd_file curr_fp);
	516	int ksmbd_override_fsids(struct ksmbd_work *work);
	517	void ksmbd_revert_fsids(struct ksmbd_work *work);
	518
	519	unsigned int ksmbd_server_side_copy_max_chunk_count(void);
	520	unsigned int ksmbd_server_side_copy_max_chunk_size(void);
	521	unsigned int ksmbd_server_side_copy_max_total_size(void);
	522	bool is_asterisk(char *p);
	523	__le32 smb_map_generic_desired_access(__le32 daccess);
	524
	525	static inline unsigned int get_rfc1002_len(void *buf)
	526	{
	527	return be32_to_cpu(((__be32 )buf)) & 0xffffff;
	528	}
	529
	530	static inline void inc_rfc1001_len(void *buf, int count)
	531	{
	532	be32_add_cpu((__be32 *)buf, count);
	533	}
	534	#endif /* __SMB_COMMON_H__ */