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

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 *   Copyright (C) 2016 Namjae Jeon <linkinjeon@kernel.org>
 *   Copyright (C) 2018 Samsung Electronics Co., Ltd.
 */

#ifndef _SMB2PDU_H
#define _SMB2PDU_H

#include "ntlmssp.h"
#include "smbacl.h"

/*Create Action Flags*/
#define FILE_SUPERSEDED                0x00000000
#define FILE_OPENED            0x00000001
#define FILE_CREATED           0x00000002
#define FILE_OVERWRITTEN       0x00000003

/* SMB2 Max Credits */
#define SMB2_MAX_CREDITS		8192

/* BB FIXME - analyze following length BB */
#define MAX_SMB2_HDR_SIZE 0x78 /* 4 len + 64 hdr + (2*24 wct) + 2 bct + 2 pad */

#define SMB21_DEFAULT_IOSIZE	(1024 * 1024)
#define SMB3_DEFAULT_TRANS_SIZE	(1024 * 1024)
#define SMB3_MIN_IOSIZE		(64 * 1024)
#define SMB3_MAX_IOSIZE		(8 * 1024 * 1024)
#define SMB3_MAX_MSGSIZE	(4 * 4096)

/*
 *	Definitions for SMB2 Protocol Data Units (network frames)
 *
 *  See MS-SMB2.PDF specification for protocol details.
 *  The Naming convention is the lower case version of the SMB2
 *  command code name for the struct. Note that structures must be packed.
 *
 */

struct preauth_integrity_info {
	/* PreAuth integrity Hash ID */
	__le16			Preauth_HashId;
	/* PreAuth integrity Hash Value */
	__u8			Preauth_HashValue[SMB2_PREAUTH_HASH_SIZE];
};

/* offset is sizeof smb2_negotiate_rsp but rounded up to 8 bytes. */
#ifdef CONFIG_SMB_SERVER_KERBEROS5
/* sizeof(struct smb2_negotiate_rsp) =
 * header(64) + response(64) + GSS_LENGTH(96) + GSS_PADDING(0)
 */
#define OFFSET_OF_NEG_CONTEXT	0xe0
#else
/* sizeof(struct smb2_negotiate_rsp) =
 * header(64) + response(64) + GSS_LENGTH(74) + GSS_PADDING(6)
 */
#define OFFSET_OF_NEG_CONTEXT	0xd0
#endif

#define SMB2_SESSION_EXPIRED		(0)
#define SMB2_SESSION_IN_PROGRESS	BIT(0)
#define SMB2_SESSION_VALID		BIT(1)

struct create_durable_req_v2 {
	struct create_context ccontext;
	__u8   Name[8];
	__le32 Timeout;
	__le32 Flags;
	__u8 Reserved[8];
	__u8 CreateGuid[16];
} __packed;

struct create_durable_reconn_v2_req {
	struct create_context ccontext;
	__u8   Name[8];
	struct {
		__u64 PersistentFileId;
		__u64 VolatileFileId;
	} Fid;
	__u8 CreateGuid[16];
	__le32 Flags;
} __packed;

struct create_app_inst_id {
	struct create_context ccontext;
	__u8 Name[8];
	__u8 Reserved[8];
	__u8 AppInstanceId[16];
} __packed;

struct create_app_inst_id_vers {
	struct create_context ccontext;
	__u8 Name[8];
	__u8 Reserved[2];
	__u8 Padding[4];
	__le64 AppInstanceVersionHigh;
	__le64 AppInstanceVersionLow;
} __packed;

struct create_alloc_size_req {
	struct create_context ccontext;
	__u8   Name[8];
	__le64 AllocationSize;
} __packed;

struct create_durable_rsp {
	struct create_context ccontext;
	__u8   Name[8];
	union {
		__u8  Reserved[8];
		__u64 data;
	} Data;
} __packed;

struct create_durable_v2_rsp {
	struct create_context ccontext;
	__u8   Name[8];
	__le32 Timeout;
	__le32 Flags;
} __packed;

/* equivalent of the contents of SMB3.1.1 POSIX open context response */
struct create_posix_rsp {
	struct create_context ccontext;
	__u8    Name[16];
	__le32 nlink;
	__le32 reparse_tag;
	__le32 mode;
	/* SidBuffer contain two sids(Domain sid(28), UNIX group sid(16)) */
	u8 SidBuffer[44];
} __packed;

struct smb2_buffer_desc_v1 {
	__le64 offset;
	__le32 token;
	__le32 length;
} __packed;

#define SMB2_0_IOCTL_IS_FSCTL 0x00000001

struct smb_sockaddr_in {
	__be16 Port;
	__be32 IPv4address;
	__u8 Reserved[8];
} __packed;

struct smb_sockaddr_in6 {
	__be16 Port;
	__be32 FlowInfo;
	__u8 IPv6address[16];
	__be32 ScopeId;
} __packed;

#define INTERNETWORK	0x0002
#define INTERNETWORKV6	0x0017

struct sockaddr_storage_rsp {
	__le16 Family;
	union {
		struct smb_sockaddr_in addr4;
		struct smb_sockaddr_in6 addr6;
	};
} __packed;

#define RSS_CAPABLE	0x00000001
#define RDMA_CAPABLE	0x00000002

struct network_interface_info_ioctl_rsp {
	__le32 Next; /* next interface. zero if this is last one */
	__le32 IfIndex;
	__le32 Capability; /* RSS or RDMA Capable */
	__le32 Reserved;
	__le64 LinkSpeed;
	char	SockAddr_Storage[128];
} __packed;

struct file_object_buf_type1_ioctl_rsp {
	__u8 ObjectId[16];
	__u8 BirthVolumeId[16];
	__u8 BirthObjectId[16];
	__u8 DomainId[16];
} __packed;

struct resume_key_ioctl_rsp {
	__u64 ResumeKey[3];
	__le32 ContextLength;
	__u8 Context[4]; /* ignored, Windows sets to 4 bytes of zero */
} __packed;

struct copychunk_ioctl_req {
	__le64 ResumeKey[3];
	__le32 ChunkCount;
	__le32 Reserved;
	__u8 Chunks[1]; /* array of srv_copychunk */
} __packed;

struct srv_copychunk {
	__le64 SourceOffset;
	__le64 TargetOffset;
	__le32 Length;
	__le32 Reserved;
} __packed;

struct copychunk_ioctl_rsp {
	__le32 ChunksWritten;
	__le32 ChunkBytesWritten;
	__le32 TotalBytesWritten;
} __packed;

struct file_sparse {
	__u8	SetSparse;
} __packed;

/* FILE Info response size */
#define FILE_DIRECTORY_INFORMATION_SIZE       1
#define FILE_FULL_DIRECTORY_INFORMATION_SIZE  2
#define FILE_BOTH_DIRECTORY_INFORMATION_SIZE  3
#define FILE_BASIC_INFORMATION_SIZE           40
#define FILE_STANDARD_INFORMATION_SIZE        24
#define FILE_INTERNAL_INFORMATION_SIZE        8
#define FILE_EA_INFORMATION_SIZE              4
#define FILE_ACCESS_INFORMATION_SIZE          4
#define FILE_NAME_INFORMATION_SIZE            9
#define FILE_RENAME_INFORMATION_SIZE          10
#define FILE_LINK_INFORMATION_SIZE            11
#define FILE_NAMES_INFORMATION_SIZE           12
#define FILE_DISPOSITION_INFORMATION_SIZE     13
#define FILE_POSITION_INFORMATION_SIZE        14
#define FILE_FULL_EA_INFORMATION_SIZE         15
#define FILE_MODE_INFORMATION_SIZE            4
#define FILE_ALIGNMENT_INFORMATION_SIZE       4
#define FILE_ALL_INFORMATION_SIZE             104
#define FILE_ALLOCATION_INFORMATION_SIZE      19
#define FILE_END_OF_FILE_INFORMATION_SIZE     20
#define FILE_ALTERNATE_NAME_INFORMATION_SIZE  8
#define FILE_STREAM_INFORMATION_SIZE          32
#define FILE_PIPE_INFORMATION_SIZE            23
#define FILE_PIPE_LOCAL_INFORMATION_SIZE      24
#define FILE_PIPE_REMOTE_INFORMATION_SIZE     25
#define FILE_MAILSLOT_QUERY_INFORMATION_SIZE  26
#define FILE_MAILSLOT_SET_INFORMATION_SIZE    27
#define FILE_COMPRESSION_INFORMATION_SIZE     16
#define FILE_OBJECT_ID_INFORMATION_SIZE       29
/* Number 30 not defined in documents */
#define FILE_MOVE_CLUSTER_INFORMATION_SIZE    31
#define FILE_QUOTA_INFORMATION_SIZE           32
#define FILE_REPARSE_POINT_INFORMATION_SIZE   33
#define FILE_NETWORK_OPEN_INFORMATION_SIZE    56
#define FILE_ATTRIBUTE_TAG_INFORMATION_SIZE   8

/* FS Info response  size */
#define FS_DEVICE_INFORMATION_SIZE     8
#define FS_ATTRIBUTE_INFORMATION_SIZE  16
#define FS_VOLUME_INFORMATION_SIZE     24
#define FS_SIZE_INFORMATION_SIZE       24
#define FS_FULL_SIZE_INFORMATION_SIZE  32
#define FS_SECTOR_SIZE_INFORMATION_SIZE 28
#define FS_OBJECT_ID_INFORMATION_SIZE 64
#define FS_CONTROL_INFORMATION_SIZE 48
#define FS_POSIX_INFORMATION_SIZE 56

/* FS_ATTRIBUTE_File_System_Name */
#define FS_TYPE_SUPPORT_SIZE   44
struct fs_type_info {
	char		*fs_name;
	long		magic_number;
} __packed;

/*
 *	PDU query infolevel structure definitions
 *	BB consider moving to a different header
 */

struct smb2_file_access_info {
	__le32 AccessFlags;
} __packed;

struct smb2_file_alignment_info {
	__le32 AlignmentRequirement;
} __packed;

struct smb2_file_basic_info { /* data block encoding of response to level 18 */
	__le64 CreationTime;	/* Beginning of FILE_BASIC_INFO equivalent */
	__le64 LastAccessTime;
	__le64 LastWriteTime;
	__le64 ChangeTime;
	__le32 Attributes;
	__u32  Pad1;		/* End of FILE_BASIC_INFO_INFO equivalent */
} __packed;

struct smb2_file_alt_name_info {
	__le32 FileNameLength;
	char FileName[];
} __packed;

struct smb2_file_stream_info {
	__le32  NextEntryOffset;
	__le32  StreamNameLength;
	__le64 StreamSize;
	__le64 StreamAllocationSize;
	char   StreamName[];
} __packed;

struct smb2_file_ntwrk_info {
	__le64 CreationTime;
	__le64 LastAccessTime;
	__le64 LastWriteTime;
	__le64 ChangeTime;
	__le64 AllocationSize;
	__le64 EndOfFile;
	__le32 Attributes;
	__le32 Reserved;
} __packed;

struct smb2_file_standard_info {
	__le64 AllocationSize;
	__le64 EndOfFile;
	__le32 NumberOfLinks;	/* hard links */
	__u8   DeletePending;
	__u8   Directory;
	__le16 Reserved;
} __packed; /* level 18 Query */

struct smb2_file_ea_info {
	__le32 EASize;
} __packed;

struct smb2_file_alloc_info {
	__le64 AllocationSize;
} __packed;

struct smb2_file_disposition_info {
	__u8 DeletePending;
} __packed;

struct smb2_file_pos_info {
	__le64 CurrentByteOffset;
} __packed;

#define FILE_MODE_INFO_MASK cpu_to_le32(0x0000100e)

struct smb2_file_mode_info {
	__le32 Mode;
} __packed;

#define COMPRESSION_FORMAT_NONE 0x0000
#define COMPRESSION_FORMAT_LZNT1 0x0002

struct smb2_file_comp_info {
	__le64 CompressedFileSize;
	__le16 CompressionFormat;
	__u8 CompressionUnitShift;
	__u8 ChunkShift;
	__u8 ClusterShift;
	__u8 Reserved[3];
} __packed;

struct smb2_file_attr_tag_info {
	__le32 FileAttributes;
	__le32 ReparseTag;
} __packed;

#define SL_RESTART_SCAN	0x00000001
#define SL_RETURN_SINGLE_ENTRY	0x00000002
#define SL_INDEX_SPECIFIED	0x00000004

struct smb2_ea_info_req {
	__le32 NextEntryOffset;
	__u8   EaNameLength;
	char name[1];
} __packed; /* level 15 Query */

struct smb2_ea_info {
	__le32 NextEntryOffset;
	__u8   Flags;
	__u8   EaNameLength;
	__le16 EaValueLength;
	char name[1];
	/* optionally followed by value */
} __packed; /* level 15 Query */

struct create_ea_buf_req {
	struct create_context ccontext;
	__u8   Name[8];
	struct smb2_ea_info ea;
} __packed;

struct create_sd_buf_req {
	struct create_context ccontext;
	__u8   Name[8];
	struct smb_ntsd ntsd;
} __packed;

struct smb2_posix_info {
	__le32 NextEntryOffset;
	__u32 Ignored;
	__le64 CreationTime;
	__le64 LastAccessTime;
	__le64 LastWriteTime;
	__le64 ChangeTime;
	__le64 EndOfFile;
	__le64 AllocationSize;
	__le32 DosAttributes;
	__le64 Inode;
	__le32 DeviceId;
	__le32 Zero;
	/* beginning of POSIX Create Context Response */
	__le32 HardLinks;
	__le32 ReparseTag;
	__le32 Mode;
	/* SidBuffer contain two sids (UNIX user sid(16), UNIX group sid(16)) */
	u8 SidBuffer[32];
	__le32 name_len;
	u8 name[];
	/*
	 * var sized owner SID
	 * var sized group SID
	 * le32 filenamelength
	 * u8  filename[]
	 */
} __packed;

/* functions */
void init_smb2_1_server(struct ksmbd_conn *conn);
void init_smb3_0_server(struct ksmbd_conn *conn);
void init_smb3_02_server(struct ksmbd_conn *conn);
int init_smb3_11_server(struct ksmbd_conn *conn);

void init_smb2_max_read_size(unsigned int sz);
void init_smb2_max_write_size(unsigned int sz);
void init_smb2_max_trans_size(unsigned int sz);
void init_smb2_max_credits(unsigned int sz);

bool is_smb2_neg_cmd(struct ksmbd_work *work);
bool is_smb2_rsp(struct ksmbd_work *work);

u16 get_smb2_cmd_val(struct ksmbd_work *work);
void set_smb2_rsp_status(struct ksmbd_work *work, __le32 err);
int init_smb2_rsp_hdr(struct ksmbd_work *work);
int smb2_allocate_rsp_buf(struct ksmbd_work *work);
bool is_chained_smb2_message(struct ksmbd_work *work);
int init_smb2_neg_rsp(struct ksmbd_work *work);
void smb2_set_err_rsp(struct ksmbd_work *work);
int smb2_check_user_session(struct ksmbd_work *work);
int smb2_get_ksmbd_tcon(struct ksmbd_work *work);
bool smb2_is_sign_req(struct ksmbd_work *work, unsigned int command);
int smb2_check_sign_req(struct ksmbd_work *work);
void smb2_set_sign_rsp(struct ksmbd_work *work);
int smb3_check_sign_req(struct ksmbd_work *work);
void smb3_set_sign_rsp(struct ksmbd_work *work);
int find_matching_smb2_dialect(int start_index, __le16 *cli_dialects,
			       __le16 dialects_count);
struct file_lock *smb_flock_init(struct file *f);
int setup_async_work(struct ksmbd_work *work, void (*fn)(void **),
		     void **arg);
void release_async_work(struct ksmbd_work *work);
void smb2_send_interim_resp(struct ksmbd_work *work, __le32 status);
struct channel *lookup_chann_list(struct ksmbd_session *sess,
				  struct ksmbd_conn *conn);
void smb3_preauth_hash_rsp(struct ksmbd_work *work);
bool smb3_is_transform_hdr(void *buf);
int smb3_decrypt_req(struct ksmbd_work *work);
int smb3_encrypt_resp(struct ksmbd_work *work);
bool smb3_11_final_sess_setup_resp(struct ksmbd_work *work);
int smb2_set_rsp_credits(struct ksmbd_work *work);
bool smb3_encryption_negotiated(struct ksmbd_conn *conn);

/* smb2 misc functions */
int ksmbd_smb2_check_message(struct ksmbd_work *work);

/* smb2 command handlers */
int smb2_handle_negotiate(struct ksmbd_work *work);
int smb2_negotiate_request(struct ksmbd_work *work);
int smb2_sess_setup(struct ksmbd_work *work);
int smb2_tree_connect(struct ksmbd_work *work);
int smb2_tree_disconnect(struct ksmbd_work *work);
int smb2_session_logoff(struct ksmbd_work *work);
int smb2_open(struct ksmbd_work *work);
int smb2_query_info(struct ksmbd_work *work);
int smb2_query_dir(struct ksmbd_work *work);
int smb2_close(struct ksmbd_work *work);
int smb2_echo(struct ksmbd_work *work);
int smb2_set_info(struct ksmbd_work *work);
int smb2_read(struct ksmbd_work *work);
int smb2_write(struct ksmbd_work *work);
int smb2_flush(struct ksmbd_work *work);
int smb2_cancel(struct ksmbd_work *work);
int smb2_lock(struct ksmbd_work *work);
int smb2_ioctl(struct ksmbd_work *work);
int smb2_oplock_break(struct ksmbd_work *work);
int smb2_notify(struct ksmbd_work *ksmbd_work);

/*
 * Get the body of the smb2 message excluding the 4 byte rfc1002 headers
 * from request/response buffer.
 */
static inline void *smb2_get_msg(void *buf)
{
	return buf + 4;
}

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