mirror of
https://mirrors.bfsu.edu.cn/git/linux.git
synced 2025-01-06 22:04:22 +08:00
0d35e382e4
This file will contain all the definitions we need for SMB2 packets and will follow the naming convention of MS-SMB2.PDF as closely as possible to make it easier to cross-reference beween the definitions and the standard. The content of this file will mostly consist of migration of existing definitions in the cifs/smb2.pdu.h and ksmbd/smb2pdu.h files with some additional tweaks as the two files have diverged. This patch introduces the new smbfs_common/smb2pdu.h file and migrates the SMB2 header as well as TREE_CONNECT and TREE_DISCONNECT to the shared file. Signed-off-by: Ronnie Sahlberg <lsahlber@redhat.com> Reviewed-by: Namjae Jeon <linkinjeon@kernel.org> Signed-off-by: Steve French <stfrench@microsoft.com>
319 lines
10 KiB
C
319 lines
10 KiB
C
/* SPDX-License-Identifier: LGPL-2.1 */
|
|
#ifndef _COMMON_SMB2PDU_H
|
|
#define _COMMON_SMB2PDU_H
|
|
|
|
/*
|
|
* Note that, due to trying to use names similar to the protocol specifications,
|
|
* there are many mixed case field names in the structures below. Although
|
|
* this does not match typical Linux kernel style, it is necessary to be
|
|
* able to match against the protocol specfication.
|
|
*
|
|
* SMB2 commands
|
|
* Some commands have minimal (wct=0,bcc=0), or uninteresting, responses
|
|
* (ie no useful data other than the SMB error code itself) and are marked such.
|
|
* Knowing this helps avoid response buffer allocations and copy in some cases.
|
|
*/
|
|
|
|
/* List of commands in host endian */
|
|
#define SMB2_NEGOTIATE_HE 0x0000
|
|
#define SMB2_SESSION_SETUP_HE 0x0001
|
|
#define SMB2_LOGOFF_HE 0x0002 /* trivial request/resp */
|
|
#define SMB2_TREE_CONNECT_HE 0x0003
|
|
#define SMB2_TREE_DISCONNECT_HE 0x0004 /* trivial req/resp */
|
|
#define SMB2_CREATE_HE 0x0005
|
|
#define SMB2_CLOSE_HE 0x0006
|
|
#define SMB2_FLUSH_HE 0x0007 /* trivial resp */
|
|
#define SMB2_READ_HE 0x0008
|
|
#define SMB2_WRITE_HE 0x0009
|
|
#define SMB2_LOCK_HE 0x000A
|
|
#define SMB2_IOCTL_HE 0x000B
|
|
#define SMB2_CANCEL_HE 0x000C
|
|
#define SMB2_ECHO_HE 0x000D
|
|
#define SMB2_QUERY_DIRECTORY_HE 0x000E
|
|
#define SMB2_CHANGE_NOTIFY_HE 0x000F
|
|
#define SMB2_QUERY_INFO_HE 0x0010
|
|
#define SMB2_SET_INFO_HE 0x0011
|
|
#define SMB2_OPLOCK_BREAK_HE 0x0012
|
|
|
|
/* The same list in little endian */
|
|
#define SMB2_NEGOTIATE cpu_to_le16(SMB2_NEGOTIATE_HE)
|
|
#define SMB2_SESSION_SETUP cpu_to_le16(SMB2_SESSION_SETUP_HE)
|
|
#define SMB2_LOGOFF cpu_to_le16(SMB2_LOGOFF_HE)
|
|
#define SMB2_TREE_CONNECT cpu_to_le16(SMB2_TREE_CONNECT_HE)
|
|
#define SMB2_TREE_DISCONNECT cpu_to_le16(SMB2_TREE_DISCONNECT_HE)
|
|
#define SMB2_CREATE cpu_to_le16(SMB2_CREATE_HE)
|
|
#define SMB2_CLOSE cpu_to_le16(SMB2_CLOSE_HE)
|
|
#define SMB2_FLUSH cpu_to_le16(SMB2_FLUSH_HE)
|
|
#define SMB2_READ cpu_to_le16(SMB2_READ_HE)
|
|
#define SMB2_WRITE cpu_to_le16(SMB2_WRITE_HE)
|
|
#define SMB2_LOCK cpu_to_le16(SMB2_LOCK_HE)
|
|
#define SMB2_IOCTL cpu_to_le16(SMB2_IOCTL_HE)
|
|
#define SMB2_CANCEL cpu_to_le16(SMB2_CANCEL_HE)
|
|
#define SMB2_ECHO cpu_to_le16(SMB2_ECHO_HE)
|
|
#define SMB2_QUERY_DIRECTORY cpu_to_le16(SMB2_QUERY_DIRECTORY_HE)
|
|
#define SMB2_CHANGE_NOTIFY cpu_to_le16(SMB2_CHANGE_NOTIFY_HE)
|
|
#define SMB2_QUERY_INFO cpu_to_le16(SMB2_QUERY_INFO_HE)
|
|
#define SMB2_SET_INFO cpu_to_le16(SMB2_SET_INFO_HE)
|
|
#define SMB2_OPLOCK_BREAK cpu_to_le16(SMB2_OPLOCK_BREAK_HE)
|
|
|
|
#define SMB2_INTERNAL_CMD cpu_to_le16(0xFFFF)
|
|
|
|
#define NUMBER_OF_SMB2_COMMANDS 0x0013
|
|
|
|
/*
|
|
* SMB2 Header Definition
|
|
*
|
|
* "MBZ" : Must be Zero
|
|
* "BB" : BugBug, Something to check/review/analyze later
|
|
* "PDU" : "Protocol Data Unit" (ie a network "frame")
|
|
*
|
|
*/
|
|
|
|
#define __SMB2_HEADER_STRUCTURE_SIZE 64
|
|
#define SMB2_HEADER_STRUCTURE_SIZE \
|
|
cpu_to_le16(__SMB2_HEADER_STRUCTURE_SIZE)
|
|
|
|
#define SMB2_PROTO_NUMBER cpu_to_le32(0x424d53fe)
|
|
#define SMB2_TRANSFORM_PROTO_NUM cpu_to_le32(0x424d53fd)
|
|
#define SMB2_COMPRESSION_TRANSFORM_ID cpu_to_le32(0x424d53fc)
|
|
|
|
/*
|
|
* SMB2 flag definitions
|
|
*/
|
|
#define SMB2_FLAGS_SERVER_TO_REDIR cpu_to_le32(0x00000001)
|
|
#define SMB2_FLAGS_ASYNC_COMMAND cpu_to_le32(0x00000002)
|
|
#define SMB2_FLAGS_RELATED_OPERATIONS cpu_to_le32(0x00000004)
|
|
#define SMB2_FLAGS_SIGNED cpu_to_le32(0x00000008)
|
|
#define SMB2_FLAGS_PRIORITY_MASK cpu_to_le32(0x00000070) /* SMB3.1.1 */
|
|
#define SMB2_FLAGS_DFS_OPERATIONS cpu_to_le32(0x10000000)
|
|
#define SMB2_FLAGS_REPLAY_OPERATION cpu_to_le32(0x20000000) /* SMB3 & up */
|
|
|
|
/* See MS-SMB2 section 2.2.1 */
|
|
struct smb2_hdr {
|
|
__le32 ProtocolId; /* 0xFE 'S' 'M' 'B' */
|
|
__le16 StructureSize; /* 64 */
|
|
__le16 CreditCharge; /* MBZ */
|
|
__le32 Status; /* Error from server */
|
|
__le16 Command;
|
|
__le16 CreditRequest; /* CreditResponse */
|
|
__le32 Flags;
|
|
__le32 NextCommand;
|
|
__le64 MessageId;
|
|
union {
|
|
struct {
|
|
__le32 ProcessId;
|
|
__le32 TreeId;
|
|
} __packed SyncId;
|
|
__le64 AsyncId;
|
|
} __packed Id;
|
|
__le64 SessionId;
|
|
__u8 Signature[16];
|
|
} __packed;
|
|
|
|
struct smb2_pdu {
|
|
struct smb2_hdr hdr;
|
|
__le16 StructureSize2; /* size of wct area (varies, request specific) */
|
|
} __packed;
|
|
|
|
#define SMB3_AES_CCM_NONCE 11
|
|
#define SMB3_AES_GCM_NONCE 12
|
|
|
|
/* Transform flags (for 3.0 dialect this flag indicates CCM */
|
|
#define TRANSFORM_FLAG_ENCRYPTED 0x0001
|
|
struct smb2_transform_hdr {
|
|
__le32 ProtocolId; /* 0xFD 'S' 'M' 'B' */
|
|
__u8 Signature[16];
|
|
__u8 Nonce[16];
|
|
__le32 OriginalMessageSize;
|
|
__u16 Reserved1;
|
|
__le16 Flags; /* EncryptionAlgorithm for 3.0, enc enabled for 3.1.1 */
|
|
__le64 SessionId;
|
|
} __packed;
|
|
|
|
|
|
/* See MS-SMB2 2.2.42 */
|
|
struct smb2_compression_transform_hdr_unchained {
|
|
__le32 ProtocolId; /* 0xFC 'S' 'M' 'B' */
|
|
__le32 OriginalCompressedSegmentSize;
|
|
__le16 CompressionAlgorithm;
|
|
__le16 Flags;
|
|
__le16 Length; /* if chained it is length, else offset */
|
|
} __packed;
|
|
|
|
/* See MS-SMB2 2.2.42.1 */
|
|
#define SMB2_COMPRESSION_FLAG_NONE 0x0000
|
|
#define SMB2_COMPRESSION_FLAG_CHAINED 0x0001
|
|
|
|
struct compression_payload_header {
|
|
__le16 CompressionAlgorithm;
|
|
__le16 Flags;
|
|
__le32 Length; /* length of compressed playload including field below if present */
|
|
/* __le32 OriginalPayloadSize; */ /* optional, present when LZNT1, LZ77, LZ77+Huffman */
|
|
} __packed;
|
|
|
|
/* See MS-SMB2 2.2.42.2 */
|
|
struct smb2_compression_transform_hdr_chained {
|
|
__le32 ProtocolId; /* 0xFC 'S' 'M' 'B' */
|
|
__le32 OriginalCompressedSegmentSize;
|
|
/* struct compression_payload_header[] */
|
|
} __packed;
|
|
|
|
/* See MS-SMB2 2.2.42.2.2 */
|
|
struct compression_pattern_payload_v1 {
|
|
__le16 Pattern;
|
|
__le16 Reserved1;
|
|
__le16 Reserved2;
|
|
__le32 Repetitions;
|
|
} __packed;
|
|
|
|
/* See MS-SMB2 section 2.2.9.2 */
|
|
/* Context Types */
|
|
#define SMB2_RESERVED_TREE_CONNECT_CONTEXT_ID 0x0000
|
|
#define SMB2_REMOTED_IDENTITY_TREE_CONNECT_CONTEXT_ID cpu_to_le16(0x0001)
|
|
|
|
struct tree_connect_contexts {
|
|
__le16 ContextType;
|
|
__le16 DataLength;
|
|
__le32 Reserved;
|
|
__u8 Data[];
|
|
} __packed;
|
|
|
|
/* Remoted identity tree connect context structures - see MS-SMB2 2.2.9.2.1 */
|
|
struct smb3_blob_data {
|
|
__le16 BlobSize;
|
|
__u8 BlobData[];
|
|
} __packed;
|
|
|
|
/* Valid values for Attr */
|
|
#define SE_GROUP_MANDATORY 0x00000001
|
|
#define SE_GROUP_ENABLED_BY_DEFAULT 0x00000002
|
|
#define SE_GROUP_ENABLED 0x00000004
|
|
#define SE_GROUP_OWNER 0x00000008
|
|
#define SE_GROUP_USE_FOR_DENY_ONLY 0x00000010
|
|
#define SE_GROUP_INTEGRITY 0x00000020
|
|
#define SE_GROUP_INTEGRITY_ENABLED 0x00000040
|
|
#define SE_GROUP_RESOURCE 0x20000000
|
|
#define SE_GROUP_LOGON_ID 0xC0000000
|
|
|
|
/* struct sid_attr_data is SidData array in BlobData format then le32 Attr */
|
|
|
|
struct sid_array_data {
|
|
__le16 SidAttrCount;
|
|
/* SidAttrList - array of sid_attr_data structs */
|
|
} __packed;
|
|
|
|
struct luid_attr_data {
|
|
|
|
} __packed;
|
|
|
|
/*
|
|
* struct privilege_data is the same as BLOB_DATA - see MS-SMB2 2.2.9.2.1.5
|
|
* but with size of LUID_ATTR_DATA struct and BlobData set to LUID_ATTR DATA
|
|
*/
|
|
|
|
struct privilege_array_data {
|
|
__le16 PrivilegeCount;
|
|
/* array of privilege_data structs */
|
|
} __packed;
|
|
|
|
struct remoted_identity_tcon_context {
|
|
__le16 TicketType; /* must be 0x0001 */
|
|
__le16 TicketSize; /* total size of this struct */
|
|
__le16 User; /* offset to SID_ATTR_DATA struct with user info */
|
|
__le16 UserName; /* offset to null terminated Unicode username string */
|
|
__le16 Domain; /* offset to null terminated Unicode domain name */
|
|
__le16 Groups; /* offset to SID_ARRAY_DATA struct with group info */
|
|
__le16 RestrictedGroups; /* similar to above */
|
|
__le16 Privileges; /* offset to PRIVILEGE_ARRAY_DATA struct */
|
|
__le16 PrimaryGroup; /* offset to SID_ARRAY_DATA struct */
|
|
__le16 Owner; /* offset to BLOB_DATA struct */
|
|
__le16 DefaultDacl; /* offset to BLOB_DATA struct */
|
|
__le16 DeviceGroups; /* offset to SID_ARRAY_DATA struct */
|
|
__le16 UserClaims; /* offset to BLOB_DATA struct */
|
|
__le16 DeviceClaims; /* offset to BLOB_DATA struct */
|
|
__u8 TicketInfo[]; /* variable length buf - remoted identity data */
|
|
} __packed;
|
|
|
|
struct smb2_tree_connect_req_extension {
|
|
__le32 TreeConnectContextOffset;
|
|
__le16 TreeConnectContextCount;
|
|
__u8 Reserved[10];
|
|
__u8 PathName[]; /* variable sized array */
|
|
/* followed by array of TreeConnectContexts */
|
|
} __packed;
|
|
|
|
/* Flags/Reserved for SMB3.1.1 */
|
|
#define SMB2_TREE_CONNECT_FLAG_CLUSTER_RECONNECT cpu_to_le16(0x0001)
|
|
#define SMB2_TREE_CONNECT_FLAG_REDIRECT_TO_OWNER cpu_to_le16(0x0002)
|
|
#define SMB2_TREE_CONNECT_FLAG_EXTENSION_PRESENT cpu_to_le16(0x0004)
|
|
|
|
struct smb2_tree_connect_req {
|
|
struct smb2_hdr hdr;
|
|
__le16 StructureSize; /* Must be 9 */
|
|
__le16 Flags; /* Flags in SMB3.1.1 */
|
|
__le16 PathOffset;
|
|
__le16 PathLength;
|
|
__u8 Buffer[1]; /* variable length */
|
|
} __packed;
|
|
|
|
/* Possible ShareType values */
|
|
#define SMB2_SHARE_TYPE_DISK 0x01
|
|
#define SMB2_SHARE_TYPE_PIPE 0x02
|
|
#define SMB2_SHARE_TYPE_PRINT 0x03
|
|
|
|
/*
|
|
* Possible ShareFlags - exactly one and only one of the first 4 caching flags
|
|
* must be set (any of the remaining, SHI1005, flags may be set individually
|
|
* or in combination.
|
|
*/
|
|
#define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
|
|
#define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
|
|
#define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
|
|
#define SMB2_SHAREFLAG_NO_CACHING 0x00000030
|
|
#define SHI1005_FLAGS_DFS 0x00000001
|
|
#define SHI1005_FLAGS_DFS_ROOT 0x00000002
|
|
#define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS 0x00000100
|
|
#define SHI1005_FLAGS_FORCE_SHARED_DELETE 0x00000200
|
|
#define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING 0x00000400
|
|
#define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
|
|
#define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK 0x00001000
|
|
#define SHI1005_FLAGS_ENABLE_HASH_V1 0x00002000
|
|
#define SHI1005_FLAGS_ENABLE_HASH_V2 0x00004000
|
|
#define SHI1005_FLAGS_ENCRYPT_DATA 0x00008000
|
|
#define SMB2_SHAREFLAG_IDENTITY_REMOTING 0x00040000 /* 3.1.1 */
|
|
#define SMB2_SHAREFLAG_COMPRESS_DATA 0x00100000 /* 3.1.1 */
|
|
#define SHI1005_FLAGS_ALL 0x0014FF33
|
|
|
|
/* Possible share capabilities */
|
|
#define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
|
|
#define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
|
|
#define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
|
|
#define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
|
|
#define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
|
|
#define SMB2_SHARE_CAP_REDIRECT_TO_OWNER cpu_to_le32(0x00000100) /* 3.1.1 */
|
|
|
|
struct smb2_tree_connect_rsp {
|
|
struct smb2_hdr hdr;
|
|
__le16 StructureSize; /* Must be 16 */
|
|
__u8 ShareType; /* see below */
|
|
__u8 Reserved;
|
|
__le32 ShareFlags; /* see below */
|
|
__le32 Capabilities; /* see below */
|
|
__le32 MaximalAccess;
|
|
} __packed;
|
|
|
|
struct smb2_tree_disconnect_req {
|
|
struct smb2_hdr hdr;
|
|
__le16 StructureSize; /* Must be 4 */
|
|
__le16 Reserved;
|
|
} __packed;
|
|
|
|
struct smb2_tree_disconnect_rsp {
|
|
struct smb2_hdr hdr;
|
|
__le16 StructureSize; /* Must be 4 */
|
|
__le16 Reserved;
|
|
} __packed;
|
|
|
|
|
|
#endif /* _COMMON_SMB2PDU_H */
|