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 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 19 /* SMB2 Max Credits */ 20 #define SMB2_MAX_CREDITS 8192 21 22 /* BB FIXME - analyze following length BB */ 23 #define MAX_SMB2_HDR_SIZE 0x78 /* 4 len + 64 hdr + (2*24 wct) + 2 bct + 2 pad */ 24 25 #define SMB21_DEFAULT_IOSIZE (1024 * 1024) 26 #define SMB3_DEFAULT_TRANS_SIZE (1024 * 1024) 27 #define SMB3_MIN_IOSIZE (64 * 1024) 28 #define SMB3_MAX_IOSIZE (8 * 1024 * 1024) 29 #define SMB3_MAX_MSGSIZE (4 * 4096) 30 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 40 struct preauth_integrity_info { 41 /* PreAuth integrity Hash ID */ 42 __le16 Preauth_HashId; 43 /* PreAuth integrity Hash Value */ 44 __u8 Preauth_HashValue[SMB2_PREAUTH_HASH_SIZE]; 45 }; 46 47 /* offset is sizeof smb2_negotiate_rsp but rounded up to 8 bytes. */ 48 #ifdef CONFIG_SMB_SERVER_KERBEROS5 49 /* sizeof(struct smb2_negotiate_rsp) = 50 * header(64) + response(64) + GSS_LENGTH(96) + GSS_PADDING(0) 51 */ 52 #define OFFSET_OF_NEG_CONTEXT 0xe0 53 #else 54 /* sizeof(struct smb2_negotiate_rsp) = 55 * header(64) + response(64) + GSS_LENGTH(74) + GSS_PADDING(6) 56 */ 57 #define OFFSET_OF_NEG_CONTEXT 0xd0 58 #endif 59 60 #define SMB2_SESSION_EXPIRED (0) 61 #define SMB2_SESSION_IN_PROGRESS BIT(0) 62 #define SMB2_SESSION_VALID BIT(1) 63 64 #define SMB2_SESSION_TIMEOUT (10 * HZ) 65 66 /* Apple Defined Contexts */ 67 #define SMB2_CREATE_AAPL "AAPL" 68 69 struct create_durable_req_v2 { 70 struct create_context_hdr ccontext; 71 __u8 Name[8]; 72 __le32 Timeout; 73 __le32 Flags; 74 __u8 Reserved[8]; 75 __u8 CreateGuid[16]; 76 } __packed; 77 78 #define DURABLE_HANDLE_MAX_TIMEOUT 300000 79 80 struct create_durable_reconn_req { 81 struct create_context_hdr ccontext; 82 __u8 Name[8]; 83 union { 84 __u8 Reserved[16]; 85 struct { 86 __u64 PersistentFileId; 87 __u64 VolatileFileId; 88 } Fid; 89 } Data; 90 } __packed; 91 92 struct create_durable_reconn_v2_req { 93 struct create_context_hdr ccontext; 94 __u8 Name[8]; 95 struct { 96 __u64 PersistentFileId; 97 __u64 VolatileFileId; 98 } Fid; 99 __u8 CreateGuid[16]; 100 __le32 Flags; 101 } __packed; 102 103 struct create_alloc_size_req { 104 struct create_context_hdr ccontext; 105 __u8 Name[8]; 106 __le64 AllocationSize; 107 } __packed; 108 109 struct create_durable_rsp { 110 struct create_context_hdr ccontext; 111 __u8 Name[8]; 112 union { 113 __u8 Reserved[8]; 114 __u64 data; 115 } Data; 116 } __packed; 117 118 /* See MS-SMB2 2.2.13.2.11 */ 119 /* Flags */ 120 #define SMB2_DHANDLE_FLAG_PERSISTENT 0x00000002 121 struct create_durable_v2_rsp { 122 struct create_context_hdr ccontext; 123 __u8 Name[8]; 124 __le32 Timeout; 125 __le32 Flags; 126 } __packed; 127 128 /* equivalent of the contents of SMB3.1.1 POSIX open context response */ 129 struct create_posix_rsp { 130 struct create_context_hdr ccontext; 131 __u8 Name[16]; 132 __le32 nlink; 133 __le32 reparse_tag; 134 __le32 mode; 135 /* SidBuffer contain two sids(Domain sid(28), UNIX group sid(16)) */ 136 u8 SidBuffer[44]; 137 } __packed; 138 139 #define SMB2_0_IOCTL_IS_FSCTL 0x00000001 140 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 { 185 __u64 ResumeKey[3]; 186 __le32 ContextLength; 187 __u8 Context[4]; /* ignored, Windows sets to 4 bytes of zero */ 188 } __packed; 189 190 struct srv_copychunk { 191 __le64 SourceOffset; 192 __le64 TargetOffset; 193 __le32 Length; 194 __le32 Reserved; 195 } __packed; 196 197 struct copychunk_ioctl_req { 198 __le64 ResumeKey[3]; 199 __le32 ChunkCount; 200 __le32 Reserved; 201 struct srv_copychunk Chunks[] __counted_by_le(ChunkCount); 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 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 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 269 /* 270 * PDU query infolevel structure definitions 271 * BB consider moving to a different header 272 */ 273 274 struct smb2_file_access_info { 275 __le32 AccessFlags; 276 } __packed; 277 278 struct smb2_file_alignment_info { 279 __le32 AlignmentRequirement; 280 } __packed; 281 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 291 struct smb2_file_alt_name_info { 292 __le32 FileNameLength; 293 char FileName[]; 294 } __packed; 295 296 struct smb2_file_stream_info { 297 __le32 NextEntryOffset; 298 __le32 StreamNameLength; 299 __le64 StreamSize; 300 __le64 StreamAllocationSize; 301 char StreamName[]; 302 } __packed; 303 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 340 #define FILE_MODE_INFO_MASK cpu_to_le32(0x0000100e) 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[]; 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[]; 379 /* optionally followed by value */ 380 } __packed; /* level 15 Query */ 381 382 struct create_ea_buf_req { 383 struct create_context_hdr ccontext; 384 __u8 Name[8]; 385 struct smb2_ea_info ea; 386 } __packed; 387 388 struct create_sd_buf_req { 389 struct create_context_hdr ccontext; 390 __u8 Name[8]; 391 struct smb_ntsd ntsd; 392 } __packed; 393 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; 411 /* SidBuffer contain two sids (UNIX user sid(16), UNIX group sid(16)) */ 412 u8 SidBuffer[32]; 413 __le32 name_len; 414 u8 name[]; 415 /* 416 * var sized owner SID 417 * var sized group SID 418 * le32 filenamelength 419 * u8 filename[] 420 */ 421 } __packed; 422 423 /* functions */ 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); 432 void init_smb2_max_credits(unsigned int sz); 433 434 bool is_smb2_neg_cmd(struct ksmbd_work *work); 435 bool is_smb2_rsp(struct ksmbd_work *work); 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, 452 __le16 dialects_count); 453 struct file_lock *smb_flock_init(struct file *f); 454 int setup_async_work(struct ksmbd_work *work, void (*fn)(void **), 455 void **arg); 456 void release_async_work(struct ksmbd_work *work); 457 void smb2_send_interim_resp(struct ksmbd_work *work, __le32 status); 458 struct channel *lookup_chann_list(struct ksmbd_session *sess, 459 struct ksmbd_conn *conn); 460 void smb3_preauth_hash_rsp(struct ksmbd_work *work); 461 bool smb3_is_transform_hdr(void *buf); 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); 466 bool smb3_encryption_negotiated(struct ksmbd_conn *conn); 467 468 /* smb2 misc functions */ 469 int ksmbd_smb2_check_message(struct ksmbd_work *work); 470 471 /* smb2 command handlers */ 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); 492 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 502 #define POSIX_TYPE_FILE 0 503 #define POSIX_TYPE_DIR 1 504 #define POSIX_TYPE_SYMLINK 2 505 #define POSIX_TYPE_CHARDEV 3 506 #define POSIX_TYPE_BLKDEV 4 507 #define POSIX_TYPE_FIFO 5 508 #define POSIX_TYPE_SOCKET 6 509 510 #define POSIX_FILETYPE_SHIFT 12 511 512 #endif /* _SMB2PDU_H */ 513