4 * Copyright (c) International Business Machines Corp., 2009, 2013
6 * Author(s): Steve French (sfrench@us.ibm.com)
7 * Pavel Shilovsky (pshilovsky@samba.org) 2012
9 * This library is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as published
11 * by the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
17 * the GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this library; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 * Note that, due to trying to use names similar to the protocol specifications,
31 * there are many mixed case field names in the structures below. Although
32 * this does not match typical Linux kernel style, it is necessary to be
33 * be able to match against the protocol specfication.
36 * Some commands have minimal (wct=0,bcc=0), or uninteresting, responses
37 * (ie no useful data other than the SMB error code itself) and are marked such.
38 * Knowing this helps avoid response buffer allocations and copy in some cases.
41 /* List of commands in host endian */
42 #define SMB2_NEGOTIATE_HE 0x0000
43 #define SMB2_SESSION_SETUP_HE 0x0001
44 #define SMB2_LOGOFF_HE 0x0002 /* trivial request/resp */
45 #define SMB2_TREE_CONNECT_HE 0x0003
46 #define SMB2_TREE_DISCONNECT_HE 0x0004 /* trivial req/resp */
47 #define SMB2_CREATE_HE 0x0005
48 #define SMB2_CLOSE_HE 0x0006
49 #define SMB2_FLUSH_HE 0x0007 /* trivial resp */
50 #define SMB2_READ_HE 0x0008
51 #define SMB2_WRITE_HE 0x0009
52 #define SMB2_LOCK_HE 0x000A
53 #define SMB2_IOCTL_HE 0x000B
54 #define SMB2_CANCEL_HE 0x000C
55 #define SMB2_ECHO_HE 0x000D
56 #define SMB2_QUERY_DIRECTORY_HE 0x000E
57 #define SMB2_CHANGE_NOTIFY_HE 0x000F
58 #define SMB2_QUERY_INFO_HE 0x0010
59 #define SMB2_SET_INFO_HE 0x0011
60 #define SMB2_OPLOCK_BREAK_HE 0x0012
62 /* The same list in little endian */
63 #define SMB2_NEGOTIATE cpu_to_le16(SMB2_NEGOTIATE_HE)
64 #define SMB2_SESSION_SETUP cpu_to_le16(SMB2_SESSION_SETUP_HE)
65 #define SMB2_LOGOFF cpu_to_le16(SMB2_LOGOFF_HE)
66 #define SMB2_TREE_CONNECT cpu_to_le16(SMB2_TREE_CONNECT_HE)
67 #define SMB2_TREE_DISCONNECT cpu_to_le16(SMB2_TREE_DISCONNECT_HE)
68 #define SMB2_CREATE cpu_to_le16(SMB2_CREATE_HE)
69 #define SMB2_CLOSE cpu_to_le16(SMB2_CLOSE_HE)
70 #define SMB2_FLUSH cpu_to_le16(SMB2_FLUSH_HE)
71 #define SMB2_READ cpu_to_le16(SMB2_READ_HE)
72 #define SMB2_WRITE cpu_to_le16(SMB2_WRITE_HE)
73 #define SMB2_LOCK cpu_to_le16(SMB2_LOCK_HE)
74 #define SMB2_IOCTL cpu_to_le16(SMB2_IOCTL_HE)
75 #define SMB2_CANCEL cpu_to_le16(SMB2_CANCEL_HE)
76 #define SMB2_ECHO cpu_to_le16(SMB2_ECHO_HE)
77 #define SMB2_QUERY_DIRECTORY cpu_to_le16(SMB2_QUERY_DIRECTORY_HE)
78 #define SMB2_CHANGE_NOTIFY cpu_to_le16(SMB2_CHANGE_NOTIFY_HE)
79 #define SMB2_QUERY_INFO cpu_to_le16(SMB2_QUERY_INFO_HE)
80 #define SMB2_SET_INFO cpu_to_le16(SMB2_SET_INFO_HE)
81 #define SMB2_OPLOCK_BREAK cpu_to_le16(SMB2_OPLOCK_BREAK_HE)
83 #define NUMBER_OF_SMB2_COMMANDS 0x0013
85 /* BB FIXME - analyze following length BB */
86 #define MAX_SMB2_HDR_SIZE 0x78 /* 4 len + 64 hdr + (2*24 wct) + 2 bct + 2 pad */
88 #define SMB2_PROTO_NUMBER __constant_cpu_to_le32(0x424d53fe)
91 * SMB2 Header Definition
93 * "MBZ" : Must be Zero
94 * "BB" : BugBug, Something to check/review/analyze later
95 * "PDU" : "Protocol Data Unit" (ie a network "frame")
99 #define SMB2_HEADER_STRUCTURE_SIZE __constant_cpu_to_le16(64)
102 __be32 smb2_buf_length
; /* big endian on wire */
103 /* length is only two or three bytes - with
104 one or two byte type preceding it that MBZ */
105 __u8 ProtocolId
[4]; /* 0xFE 'S' 'M' 'B' */
106 __le16 StructureSize
; /* 64 */
107 __le16 CreditCharge
; /* MBZ */
108 __le32 Status
; /* Error from server */
110 __le16 CreditRequest
; /* CreditResponse */
113 __u64 MessageId
; /* opaque - so can stay little endian */
115 __u32 TreeId
; /* opaque - so do not make little endian */
116 __u64 SessionId
; /* opaque - so do not make little endian */
122 __le16 StructureSize2
; /* size of wct area (varies, request specific) */
126 * SMB2 flag definitions
128 #define SMB2_FLAGS_SERVER_TO_REDIR __constant_cpu_to_le32(0x00000001)
129 #define SMB2_FLAGS_ASYNC_COMMAND __constant_cpu_to_le32(0x00000002)
130 #define SMB2_FLAGS_RELATED_OPERATIONS __constant_cpu_to_le32(0x00000004)
131 #define SMB2_FLAGS_SIGNED __constant_cpu_to_le32(0x00000008)
132 #define SMB2_FLAGS_DFS_OPERATIONS __constant_cpu_to_le32(0x10000000)
135 * Definitions for SMB2 Protocol Data Units (network frames)
137 * See MS-SMB2.PDF specification for protocol details.
138 * The Naming convention is the lower case version of the SMB2
139 * command code name for the struct. Note that structures must be packed.
143 #define SMB2_ERROR_STRUCTURE_SIZE2 __constant_cpu_to_le16(9)
145 struct smb2_err_rsp
{
147 __le16 StructureSize
;
148 __le16 Reserved
; /* MBZ */
149 __le32 ByteCount
; /* even if zero, at least one byte follows */
150 __u8 ErrorData
[1]; /* variable length */
153 struct smb2_symlink_err_rsp
{
154 __le32 SymLinkLength
;
155 __le32 SymLinkErrorTag
;
157 __le16 ReparseDataLength
;
158 __le16 UnparsedPathLength
;
159 __le16 SubstituteNameOffset
;
160 __le16 SubstituteNameLength
;
161 __le16 PrintNameOffset
;
162 __le16 PrintNameLength
;
167 #define SMB2_CLIENT_GUID_SIZE 16
169 struct smb2_negotiate_req
{
171 __le16 StructureSize
; /* Must be 36 */
174 __le16 Reserved
; /* MBZ */
176 __u8 ClientGUID
[SMB2_CLIENT_GUID_SIZE
];
177 __le64 ClientStartTime
; /* MBZ */
178 __le16 Dialects
[1]; /* One dialect (vers=) at a time for now */
182 #define SMB20_PROT_ID 0x0202
183 #define SMB21_PROT_ID 0x0210
184 #define SMB30_PROT_ID 0x0300
185 #define SMB302_PROT_ID 0x0302
186 #define BAD_PROT_ID 0xFFFF
188 /* SecurityMode flags */
189 #define SMB2_NEGOTIATE_SIGNING_ENABLED 0x0001
190 #define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
191 /* Capabilities flags */
192 #define SMB2_GLOBAL_CAP_DFS 0x00000001
193 #define SMB2_GLOBAL_CAP_LEASING 0x00000002 /* Resp only New to SMB2.1 */
194 #define SMB2_GLOBAL_CAP_LARGE_MTU 0X00000004 /* Resp only New to SMB2.1 */
195 #define SMB2_GLOBAL_CAP_MULTI_CHANNEL 0x00000008 /* New to SMB3 */
196 #define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
197 #define SMB2_GLOBAL_CAP_DIRECTORY_LEASING 0x00000020 /* New to SMB3 */
198 #define SMB2_GLOBAL_CAP_ENCRYPTION 0x00000040 /* New to SMB3 */
200 #define SMB2_NT_FIND 0x00100000
201 #define SMB2_LARGE_FILES 0x00200000
203 struct smb2_negotiate_rsp
{
205 __le16 StructureSize
; /* Must be 65 */
207 __le16 DialectRevision
;
208 __le16 Reserved
; /* MBZ */
211 __le32 MaxTransactSize
;
214 __le64 SystemTime
; /* MBZ */
215 __le64 ServerStartTime
;
216 __le16 SecurityBufferOffset
;
217 __le16 SecurityBufferLength
;
218 __le32 Reserved2
; /* may be any value, ignore */
219 __u8 Buffer
[1]; /* variable length GSS security buffer */
222 struct smb2_sess_setup_req
{
224 __le16 StructureSize
; /* Must be 25 */
229 __le16 SecurityBufferOffset
;
230 __le16 SecurityBufferLength
;
231 __le64 PreviousSessionId
;
232 __u8 Buffer
[1]; /* variable length GSS security buffer */
235 /* Currently defined SessionFlags */
236 #define SMB2_SESSION_FLAG_IS_GUEST 0x0001
237 #define SMB2_SESSION_FLAG_IS_NULL 0x0002
238 struct smb2_sess_setup_rsp
{
240 __le16 StructureSize
; /* Must be 9 */
242 __le16 SecurityBufferOffset
;
243 __le16 SecurityBufferLength
;
244 __u8 Buffer
[1]; /* variable length GSS security buffer */
247 struct smb2_logoff_req
{
249 __le16 StructureSize
; /* Must be 4 */
253 struct smb2_logoff_rsp
{
255 __le16 StructureSize
; /* Must be 4 */
259 struct smb2_tree_connect_req
{
261 __le16 StructureSize
; /* Must be 9 */
265 __u8 Buffer
[1]; /* variable length */
268 struct smb2_tree_connect_rsp
{
270 __le16 StructureSize
; /* Must be 16 */
271 __u8 ShareType
; /* see below */
273 __le32 ShareFlags
; /* see below */
274 __le32 Capabilities
; /* see below */
275 __le32 MaximalAccess
;
278 /* Possible ShareType values */
279 #define SMB2_SHARE_TYPE_DISK 0x01
280 #define SMB2_SHARE_TYPE_PIPE 0x02
281 #define SMB2_SHARE_TYPE_PRINT 0x03
284 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
285 * must be set (any of the remaining, SHI1005, flags may be set individually
288 #define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
289 #define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
290 #define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
291 #define SMB2_SHAREFLAG_NO_CACHING 0x00000030
292 #define SHI1005_FLAGS_DFS 0x00000001
293 #define SHI1005_FLAGS_DFS_ROOT 0x00000002
294 #define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS 0x00000100
295 #define SHI1005_FLAGS_FORCE_SHARED_DELETE 0x00000200
296 #define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING 0x00000400
297 #define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
298 #define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK 0x00001000
299 #define SHI1005_FLAGS_ENABLE_HASH_V1 0x00002000
300 #define SHI1005_FLAGS_ENABLE_HASH_V2 0x00004000
301 #define SHI1005_FLAGS_ENCRYPT_DATA 0x00008000
302 #define SHI1005_FLAGS_ALL 0x0000FF33
304 /* Possible share capabilities */
305 #define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
306 #define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
307 #define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
308 #define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
309 #define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
311 struct smb2_tree_disconnect_req
{
313 __le16 StructureSize
; /* Must be 4 */
317 struct smb2_tree_disconnect_rsp
{
319 __le16 StructureSize
; /* Must be 4 */
323 /* File Attrubutes */
324 #define FILE_ATTRIBUTE_READONLY 0x00000001
325 #define FILE_ATTRIBUTE_HIDDEN 0x00000002
326 #define FILE_ATTRIBUTE_SYSTEM 0x00000004
327 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010
328 #define FILE_ATTRIBUTE_ARCHIVE 0x00000020
329 #define FILE_ATTRIBUTE_NORMAL 0x00000080
330 #define FILE_ATTRIBUTE_TEMPORARY 0x00000100
331 #define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
332 #define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
333 #define FILE_ATTRIBUTE_COMPRESSED 0x00000800
334 #define FILE_ATTRIBUTE_OFFLINE 0x00001000
335 #define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
336 #define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
339 #define SMB2_OPLOCK_LEVEL_NONE 0x00
340 #define SMB2_OPLOCK_LEVEL_II 0x01
341 #define SMB2_OPLOCK_LEVEL_EXCLUSIVE 0x08
342 #define SMB2_OPLOCK_LEVEL_BATCH 0x09
343 #define SMB2_OPLOCK_LEVEL_LEASE 0xFF
344 /* Non-spec internal type */
345 #define SMB2_OPLOCK_LEVEL_NOCHANGE 0x99
347 /* Desired Access Flags */
348 #define FILE_READ_DATA_LE cpu_to_le32(0x00000001)
349 #define FILE_WRITE_DATA_LE cpu_to_le32(0x00000002)
350 #define FILE_APPEND_DATA_LE cpu_to_le32(0x00000004)
351 #define FILE_READ_EA_LE cpu_to_le32(0x00000008)
352 #define FILE_WRITE_EA_LE cpu_to_le32(0x00000010)
353 #define FILE_EXECUTE_LE cpu_to_le32(0x00000020)
354 #define FILE_READ_ATTRIBUTES_LE cpu_to_le32(0x00000080)
355 #define FILE_WRITE_ATTRIBUTES_LE cpu_to_le32(0x00000100)
356 #define FILE_DELETE_LE cpu_to_le32(0x00010000)
357 #define FILE_READ_CONTROL_LE cpu_to_le32(0x00020000)
358 #define FILE_WRITE_DAC_LE cpu_to_le32(0x00040000)
359 #define FILE_WRITE_OWNER_LE cpu_to_le32(0x00080000)
360 #define FILE_SYNCHRONIZE_LE cpu_to_le32(0x00100000)
361 #define FILE_ACCESS_SYSTEM_SECURITY_LE cpu_to_le32(0x01000000)
362 #define FILE_MAXIMAL_ACCESS_LE cpu_to_le32(0x02000000)
363 #define FILE_GENERIC_ALL_LE cpu_to_le32(0x10000000)
364 #define FILE_GENERIC_EXECUTE_LE cpu_to_le32(0x20000000)
365 #define FILE_GENERIC_WRITE_LE cpu_to_le32(0x40000000)
366 #define FILE_GENERIC_READ_LE cpu_to_le32(0x80000000)
368 /* ShareAccess Flags */
369 #define FILE_SHARE_READ_LE cpu_to_le32(0x00000001)
370 #define FILE_SHARE_WRITE_LE cpu_to_le32(0x00000002)
371 #define FILE_SHARE_DELETE_LE cpu_to_le32(0x00000004)
372 #define FILE_SHARE_ALL_LE cpu_to_le32(0x00000007)
374 /* CreateDisposition Flags */
375 #define FILE_SUPERSEDE_LE cpu_to_le32(0x00000000)
376 #define FILE_OPEN_LE cpu_to_le32(0x00000001)
377 #define FILE_CREATE_LE cpu_to_le32(0x00000002)
378 #define FILE_OPEN_IF_LE cpu_to_le32(0x00000003)
379 #define FILE_OVERWRITE_LE cpu_to_le32(0x00000004)
380 #define FILE_OVERWRITE_IF_LE cpu_to_le32(0x00000005)
382 /* CreateOptions Flags */
383 #define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
384 /* same as #define CREATE_NOT_FILE_LE cpu_to_le32(0x00000001) */
385 #define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
386 #define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
387 #define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
388 #define FILE_SYNCHRONOUS_IO_ALERT_LE cpu_to_le32(0x00000010)
389 #define FILE_SYNCHRONOUS_IO_NON_ALERT_LE cpu_to_le32(0x00000020)
390 #define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
391 #define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
392 #define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
393 #define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
394 #define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000)
395 #define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
396 #define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
397 #define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
398 #define FILE_RESERVE_OPFILTER_LE cpu_to_le32(0x00100000)
399 #define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
400 #define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
401 #define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
403 #define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
404 | FILE_READ_ATTRIBUTES_LE)
405 #define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
406 | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
407 #define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
409 /* Impersonation Levels */
410 #define IL_ANONYMOUS cpu_to_le32(0x00000000)
411 #define IL_IDENTIFICATION cpu_to_le32(0x00000001)
412 #define IL_IMPERSONATION cpu_to_le32(0x00000002)
413 #define IL_DELEGATE cpu_to_le32(0x00000003)
415 /* Create Context Values */
416 #define SMB2_CREATE_EA_BUFFER "ExtA" /* extended attributes */
417 #define SMB2_CREATE_SD_BUFFER "SecD" /* security descriptor */
418 #define SMB2_CREATE_DURABLE_HANDLE_REQUEST "DHnQ"
419 #define SMB2_CREATE_DURABLE_HANDLE_RECONNECT "DHnC"
420 #define SMB2_CREATE_ALLOCATION_SIZE "AlSi"
421 #define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
422 #define SMB2_CREATE_TIMEWARP_REQUEST "TWrp"
423 #define SMB2_CREATE_QUERY_ON_DISK_ID "QFid"
424 #define SMB2_CREATE_REQUEST_LEASE "RqLs"
426 struct smb2_create_req
{
428 __le16 StructureSize
; /* Must be 57 */
430 __u8 RequestedOplockLevel
;
431 __le32 ImpersonationLevel
;
432 __le64 SmbCreateFlags
;
434 __le32 DesiredAccess
;
435 __le32 FileAttributes
;
437 __le32 CreateDisposition
;
438 __le32 CreateOptions
;
441 __le32 CreateContextsOffset
;
442 __le32 CreateContextsLength
;
446 struct smb2_create_rsp
{
448 __le16 StructureSize
; /* Must be 89 */
453 __le64 LastAccessTime
;
454 __le64 LastWriteTime
;
456 __le64 AllocationSize
;
458 __le32 FileAttributes
;
460 __u64 PersistentFileId
; /* opaque endianness */
461 __u64 VolatileFileId
; /* opaque endianness */
462 __le32 CreateContextsOffset
;
463 __le32 CreateContextsLength
;
467 struct create_context
{
477 #define SMB2_LEASE_READ_CACHING_HE 0x01
478 #define SMB2_LEASE_HANDLE_CACHING_HE 0x02
479 #define SMB2_LEASE_WRITE_CACHING_HE 0x04
481 #define SMB2_LEASE_NONE __constant_cpu_to_le32(0x00)
482 #define SMB2_LEASE_READ_CACHING __constant_cpu_to_le32(0x01)
483 #define SMB2_LEASE_HANDLE_CACHING __constant_cpu_to_le32(0x02)
484 #define SMB2_LEASE_WRITE_CACHING __constant_cpu_to_le32(0x04)
486 #define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS __constant_cpu_to_le32(0x02)
488 #define SMB2_LEASE_KEY_SIZE 16
490 struct lease_context
{
495 __le64 LeaseDuration
;
498 struct lease_context_v2
{
503 __le64 LeaseDuration
;
504 __le64 ParentLeaseKeyLow
;
505 __le64 ParentLeaseKeyHigh
;
510 struct create_lease
{
511 struct create_context ccontext
;
513 struct lease_context lcontext
;
516 struct create_lease_v2
{
517 struct create_context ccontext
;
519 struct lease_context_v2 lcontext
;
523 struct create_durable
{
524 struct create_context ccontext
;
529 __u64 PersistentFileId
;
530 __u64 VolatileFileId
;
535 /* this goes in the ioctl buffer when doing a copychunk request */
536 struct copychunk_ioctl
{
538 __le32 ChunkCount
; /* we are only sending 1 */
540 /* array will only be one chunk long for us */
543 __le32 Length
; /* how many bytes to copy */
547 struct validate_negotiate_info_req
{
549 __u8 Guid
[SMB2_CLIENT_GUID_SIZE
];
552 __le16 Dialects
[1]; /* dialect (someday maybe list) client asked for */
555 struct validate_negotiate_info_rsp
{
557 __u8 Guid
[SMB2_CLIENT_GUID_SIZE
];
559 __le16 Dialect
; /* Dialect in use for the connection */
562 #define RSS_CAPABLE 0x00000001
563 #define RDMA_CAPABLE 0x00000002
565 struct network_interface_info_ioctl_rsp
{
566 __le32 Next
; /* next interface. zero if this is last one */
568 __le32 Capability
; /* RSS or RDMA Capable */
571 char SockAddr_Storage
[128];
574 #define NO_FILE_ID 0xFFFFFFFFFFFFFFFFULL /* general ioctls to srv not to file */
576 struct smb2_ioctl_req
{
578 __le16 StructureSize
; /* Must be 57 */
581 __u64 PersistentFileId
; /* opaque endianness */
582 __u64 VolatileFileId
; /* opaque endianness */
585 __le32 MaxInputResponse
;
588 __le32 MaxOutputResponse
;
594 struct smb2_ioctl_rsp
{
596 __le16 StructureSize
; /* Must be 57 */
599 __u64 PersistentFileId
; /* opaque endianness */
600 __u64 VolatileFileId
; /* opaque endianness */
607 /* char * buffer[] */
610 /* Currently defined values for close flags */
611 #define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
612 struct smb2_close_req
{
614 __le16 StructureSize
; /* Must be 24 */
617 __u64 PersistentFileId
; /* opaque endianness */
618 __u64 VolatileFileId
; /* opaque endianness */
621 struct smb2_close_rsp
{
623 __le16 StructureSize
; /* 60 */
627 __le64 LastAccessTime
;
628 __le64 LastWriteTime
;
630 __le64 AllocationSize
; /* Beginning of FILE_STANDARD_INFO equivalent */
635 struct smb2_flush_req
{
637 __le16 StructureSize
; /* Must be 24 */
640 __u64 PersistentFileId
; /* opaque endianness */
641 __u64 VolatileFileId
; /* opaque endianness */
644 struct smb2_flush_rsp
{
646 __le16 StructureSize
;
650 /* For read request Flags field below, following flag is defined for SMB3.02 */
651 #define SMB2_READFLAG_READ_UNBUFFERED 0x01
653 /* Channel field for read and write: exactly one of following flags can be set*/
654 #define SMB2_CHANNEL_NONE 0x00000000
655 #define SMB2_CHANNEL_RDMA_V1 0x00000001 /* SMB3 or later */
656 #define SMB2_CHANNEL_RDMA_V1_INVALIDATE 0x00000001 /* SMB3.02 or later */
658 struct smb2_read_req
{
660 __le16 StructureSize
; /* Must be 49 */
661 __u8 Padding
; /* offset from start of SMB2 header to place read */
662 __u8 Flags
; /* MBZ unless SMB3.02 or later */
665 __u64 PersistentFileId
; /* opaque endianness */
666 __u64 VolatileFileId
; /* opaque endianness */
668 __le32 Channel
; /* MBZ except for SMB3 or later */
669 __le32 RemainingBytes
;
670 __le16 ReadChannelInfoOffset
; /* Reserved MBZ */
671 __le16 ReadChannelInfoLength
; /* Reserved MBZ */
675 struct smb2_read_rsp
{
677 __le16 StructureSize
; /* Must be 17 */
681 __le32 DataRemaining
;
686 /* For write request Flags field below the following flags are defined: */
687 #define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
688 #define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
690 struct smb2_write_req
{
692 __le16 StructureSize
; /* Must be 49 */
693 __le16 DataOffset
; /* offset from start of SMB2 header to write data */
696 __u64 PersistentFileId
; /* opaque endianness */
697 __u64 VolatileFileId
; /* opaque endianness */
698 __le32 Channel
; /* Reserved MBZ */
699 __le32 RemainingBytes
;
700 __le16 WriteChannelInfoOffset
; /* Reserved MBZ */
701 __le16 WriteChannelInfoLength
; /* Reserved MBZ */
706 struct smb2_write_rsp
{
708 __le16 StructureSize
; /* Must be 17 */
712 __le32 DataRemaining
;
717 #define SMB2_LOCKFLAG_SHARED_LOCK 0x0001
718 #define SMB2_LOCKFLAG_EXCLUSIVE_LOCK 0x0002
719 #define SMB2_LOCKFLAG_UNLOCK 0x0004
720 #define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
722 struct smb2_lock_element
{
729 struct smb2_lock_req
{
731 __le16 StructureSize
; /* Must be 48 */
734 __u64 PersistentFileId
; /* opaque endianness */
735 __u64 VolatileFileId
; /* opaque endianness */
736 /* Followed by at least one */
737 struct smb2_lock_element locks
[1];
740 struct smb2_lock_rsp
{
742 __le16 StructureSize
; /* Must be 4 */
746 struct smb2_echo_req
{
748 __le16 StructureSize
; /* Must be 4 */
752 struct smb2_echo_rsp
{
754 __le16 StructureSize
; /* Must be 4 */
758 /* search (query_directory) Flags field */
759 #define SMB2_RESTART_SCANS 0x01
760 #define SMB2_RETURN_SINGLE_ENTRY 0x02
761 #define SMB2_INDEX_SPECIFIED 0x04
762 #define SMB2_REOPEN 0x10
764 struct smb2_query_directory_req
{
766 __le16 StructureSize
; /* Must be 33 */
767 __u8 FileInformationClass
;
770 __u64 PersistentFileId
; /* opaque endianness */
771 __u64 VolatileFileId
; /* opaque endianness */
772 __le16 FileNameOffset
;
773 __le16 FileNameLength
;
774 __le32 OutputBufferLength
;
778 struct smb2_query_directory_rsp
{
780 __le16 StructureSize
; /* Must be 9 */
781 __le16 OutputBufferOffset
;
782 __le32 OutputBufferLength
;
786 /* Possible InfoType values */
787 #define SMB2_O_INFO_FILE 0x01
788 #define SMB2_O_INFO_FILESYSTEM 0x02
789 #define SMB2_O_INFO_SECURITY 0x03
790 #define SMB2_O_INFO_QUOTA 0x04
792 struct smb2_query_info_req
{
794 __le16 StructureSize
; /* Must be 41 */
797 __le32 OutputBufferLength
;
798 __le16 InputBufferOffset
;
800 __le32 InputBufferLength
;
801 __le32 AdditionalInformation
;
803 __u64 PersistentFileId
; /* opaque endianness */
804 __u64 VolatileFileId
; /* opaque endianness */
808 struct smb2_query_info_rsp
{
810 __le16 StructureSize
; /* Must be 9 */
811 __le16 OutputBufferOffset
;
812 __le32 OutputBufferLength
;
816 struct smb2_set_info_req
{
818 __le16 StructureSize
; /* Must be 33 */
824 __le32 AdditionalInformation
;
825 __u64 PersistentFileId
; /* opaque endianness */
826 __u64 VolatileFileId
; /* opaque endianness */
830 struct smb2_set_info_rsp
{
832 __le16 StructureSize
; /* Must be 2 */
835 struct smb2_oplock_break
{
837 __le16 StructureSize
; /* Must be 24 */
845 #define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
847 struct smb2_lease_break
{
849 __le16 StructureSize
; /* Must be 44 */
853 __le32 CurrentLeaseState
;
854 __le32 NewLeaseState
;
856 __le32 AccessMaskHint
;
857 __le32 ShareMaskHint
;
860 struct smb2_lease_ack
{
862 __le16 StructureSize
; /* Must be 36 */
867 __le64 LeaseDuration
;
871 * PDU infolevel structure definitions
872 * BB consider moving to a different header
875 /* File System Information Classes */
876 #define FS_VOLUME_INFORMATION 1 /* Query */
877 #define FS_LABEL_INFORMATION 2 /* Set */
878 #define FS_SIZE_INFORMATION 3 /* Query */
879 #define FS_DEVICE_INFORMATION 4 /* Query */
880 #define FS_ATTRIBUTE_INFORMATION 5 /* Query */
881 #define FS_CONTROL_INFORMATION 6 /* Query, Set */
882 #define FS_FULL_SIZE_INFORMATION 7 /* Query */
883 #define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
884 #define FS_DRIVER_PATH_INFORMATION 9 /* Query */
886 struct smb2_fs_full_size_info
{
887 __le64 TotalAllocationUnits
;
888 __le64 CallerAvailableAllocationUnits
;
889 __le64 ActualAvailableAllocationUnits
;
890 __le32 SectorsPerAllocationUnit
;
891 __le32 BytesPerSector
;
894 /* partial list of QUERY INFO levels */
895 #define FILE_DIRECTORY_INFORMATION 1
896 #define FILE_FULL_DIRECTORY_INFORMATION 2
897 #define FILE_BOTH_DIRECTORY_INFORMATION 3
898 #define FILE_BASIC_INFORMATION 4
899 #define FILE_STANDARD_INFORMATION 5
900 #define FILE_INTERNAL_INFORMATION 6
901 #define FILE_EA_INFORMATION 7
902 #define FILE_ACCESS_INFORMATION 8
903 #define FILE_NAME_INFORMATION 9
904 #define FILE_RENAME_INFORMATION 10
905 #define FILE_LINK_INFORMATION 11
906 #define FILE_NAMES_INFORMATION 12
907 #define FILE_DISPOSITION_INFORMATION 13
908 #define FILE_POSITION_INFORMATION 14
909 #define FILE_FULL_EA_INFORMATION 15
910 #define FILE_MODE_INFORMATION 16
911 #define FILE_ALIGNMENT_INFORMATION 17
912 #define FILE_ALL_INFORMATION 18
913 #define FILE_ALLOCATION_INFORMATION 19
914 #define FILE_END_OF_FILE_INFORMATION 20
915 #define FILE_ALTERNATE_NAME_INFORMATION 21
916 #define FILE_STREAM_INFORMATION 22
917 #define FILE_PIPE_INFORMATION 23
918 #define FILE_PIPE_LOCAL_INFORMATION 24
919 #define FILE_PIPE_REMOTE_INFORMATION 25
920 #define FILE_MAILSLOT_QUERY_INFORMATION 26
921 #define FILE_MAILSLOT_SET_INFORMATION 27
922 #define FILE_COMPRESSION_INFORMATION 28
923 #define FILE_OBJECT_ID_INFORMATION 29
924 /* Number 30 not defined in documents */
925 #define FILE_MOVE_CLUSTER_INFORMATION 31
926 #define FILE_QUOTA_INFORMATION 32
927 #define FILE_REPARSE_POINT_INFORMATION 33
928 #define FILE_NETWORK_OPEN_INFORMATION 34
929 #define FILE_ATTRIBUTE_TAG_INFORMATION 35
930 #define FILE_TRACKING_INFORMATION 36
931 #define FILEID_BOTH_DIRECTORY_INFORMATION 37
932 #define FILEID_FULL_DIRECTORY_INFORMATION 38
933 #define FILE_VALID_DATA_LENGTH_INFORMATION 39
934 #define FILE_SHORT_NAME_INFORMATION 40
935 #define FILE_SFIO_RESERVE_INFORMATION 44
936 #define FILE_SFIO_VOLUME_INFORMATION 45
937 #define FILE_HARD_LINK_INFORMATION 46
938 #define FILE_NORMALIZED_NAME_INFORMATION 48
939 #define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
940 #define FILE_STANDARD_LINK_INFORMATION 54
942 struct smb2_file_internal_info
{
944 } __packed
; /* level 6 Query */
946 struct smb2_file_rename_info
{ /* encoding of request for level 10 */
947 __u8 ReplaceIfExists
; /* 1 = replace existing target with new */
948 /* 0 = fail if target already exists */
950 __u64 RootDirectory
; /* MBZ for network operations (why says spec?) */
951 __le32 FileNameLength
;
952 char FileName
[0]; /* New name to be assigned */
953 } __packed
; /* level 10 Set */
955 struct smb2_file_link_info
{ /* encoding of request for level 11 */
956 __u8 ReplaceIfExists
; /* 1 = replace existing link with new */
957 /* 0 = fail if link already exists */
959 __u64 RootDirectory
; /* MBZ for network operations (why says spec?) */
960 __le32 FileNameLength
;
961 char FileName
[0]; /* Name to be assigned to new link */
962 } __packed
; /* level 11 Set */
965 * This level 18, although with struct with same name is different from cifs
966 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
969 struct smb2_file_all_info
{ /* data block encoding of response to level 18 */
970 __le64 CreationTime
; /* Beginning of FILE_BASIC_INFO equivalent */
971 __le64 LastAccessTime
;
972 __le64 LastWriteTime
;
975 __u32 Pad1
; /* End of FILE_BASIC_INFO_INFO equivalent */
976 __le64 AllocationSize
; /* Beginning of FILE_STANDARD_INFO equivalent */
977 __le64 EndOfFile
; /* size ie offset to first free byte in file */
978 __le32 NumberOfLinks
; /* hard links */
981 __u16 Pad2
; /* End of FILE_STANDARD_INFO equivalent */
985 __le64 CurrentByteOffset
;
987 __le32 AlignmentRequirement
;
988 __le32 FileNameLength
;
990 } __packed
; /* level 18 Query */
992 struct smb2_file_eof_info
{ /* encoding of request for level 10 */
993 __le64 EndOfFile
; /* new end of file value */
994 } __packed
; /* level 20 Set */
996 #endif /* _SMB2PDU_H */