]> git.ipfire.org Git - thirdparty/linux.git/blame - fs/cifs/smb2pdu.h
projects / thirdparty / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
cifs: using strlcpy instead of strncpy
[thirdparty/linux.git] / fs / cifs / smb2pdu.h
CommitLineData
ddfbefbd
SF		 1/*
2 * fs/cifs/smb2pdu.h
3 *
be7457d3 4 * Copyright (c) International Business Machines Corp., 2009, 2013
ddfbefbd
SF		 5 * Etersoft, 2012
6 * Author(s): Steve French (sfrench@us.ibm.com)
7 * Pavel Shilovsky (pshilovsky@samba.org) 2012
8 *
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.
13 *
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.
18 *
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
22 */
23
24#ifndef _SMB2PDU_H
25#define _SMB2PDU_H
26
27#include <net/sock.h>
28
2dc7e1c0
PS		 29/*
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.
34 *
35 * SMB2 commands
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.
39 */
40
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
61
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)
82
83#define NUMBER_OF_SMB2_COMMANDS 0x0013
84
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 */
87
093b2bda
PS		 88#define SMB2_PROTO_NUMBER __constant_cpu_to_le32(0x424d53fe)
89
ddfbefbd
SF		 90/*
91 * SMB2 Header Definition
92 *
93 * "MBZ" : Must be Zero
94 * "BB" : BugBug, Something to check/review/analyze later
95 * "PDU" : "Protocol Data Unit" (ie a network "frame")
96 *
97 */
74112860 98
b2ede58e 99#define SMB2_HEADER_STRUCTURE_SIZE __constant_cpu_to_le16(64)
74112860 100
ddfbefbd
SF		 101struct smb2_hdr {
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 */
109 __le16 Command;
110 __le16 CreditRequest; /* CreditResponse */
111 __le32 Flags;
112 __le32 NextCommand;
113 __u64 MessageId; /* opaque - so can stay little endian */
114 __le32 ProcessId;
115 __u32 TreeId; /* opaque - so do not make little endian */
116 __u64 SessionId; /* opaque - so do not make little endian */
117 __u8 Signature[16];
118} __packed;
119
093b2bda
PS		 120struct smb2_pdu {
121 struct smb2_hdr hdr;
122 __le16 StructureSize2; /* size of wct area (varies, request specific) */
123} __packed;
124
125/*
126 * SMB2 flag definitions
127 */
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)
133
134/*
135 * Definitions for SMB2 Protocol Data Units (network frames)
136 *
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.
140 *
141 */
74112860 142
b2ede58e 143#define SMB2_ERROR_STRUCTURE_SIZE2 __constant_cpu_to_le16(9)
74112860 144
093b2bda
PS		 145struct smb2_err_rsp {
146 struct smb2_hdr hdr;
147 __le16 StructureSize;
148 __le16 Reserved; /* MBZ */
149 __le32 ByteCount; /* even if zero, at least one byte follows */
150 __u8 ErrorData[1]; /* variable length */
151} __packed;
152
b8c32dbb
PS		 153#define SMB2_CLIENT_GUID_SIZE 16
154
155extern __u8 cifs_client_guid[SMB2_CLIENT_GUID_SIZE];
156
ec2e4523
PS		 157struct smb2_negotiate_req {
158 struct smb2_hdr hdr;
159 __le16 StructureSize; /* Must be 36 */
160 __le16 DialectCount;
161 __le16 SecurityMode;
162 __le16 Reserved; /* MBZ */
163 __le32 Capabilities;
b8c32dbb 164 __u8 ClientGUID[SMB2_CLIENT_GUID_SIZE];
ec2e4523 165 __le64 ClientStartTime; /* MBZ */
e4aa25e7 166 __le16 Dialects[1]; /* One dialect (vers=) at a time for now */
ec2e4523
PS		 167} __packed;
168
e4aa25e7
SF		 169/* Dialects */
170#define SMB20_PROT_ID 0x0202
171#define SMB21_PROT_ID 0x0210
172#define SMB30_PROT_ID 0x0300
20b6d8b4 173#define SMB302_PROT_ID 0x0302
e4aa25e7
SF		 174#define BAD_PROT_ID 0xFFFF
175
ec2e4523
PS		 176/* SecurityMode flags */
177#define SMB2_NEGOTIATE_SIGNING_ENABLED 0x0001
178#define SMB2_NEGOTIATE_SIGNING_REQUIRED 0x0002
179/* Capabilities flags */
180#define SMB2_GLOBAL_CAP_DFS 0x00000001
181#define SMB2_GLOBAL_CAP_LEASING 0x00000002 /* Resp only New to SMB2.1 */
182#define SMB2_GLOBAL_CAP_LARGE_MTU 0X00000004 /* Resp only New to SMB2.1 */
e4aa25e7
SF		 183#define SMB2_GLOBAL_CAP_MULTI_CHANNEL 0x00000008 /* New to SMB3 */
184#define SMB2_GLOBAL_CAP_PERSISTENT_HANDLES 0x00000010 /* New to SMB3 */
185#define SMB2_GLOBAL_CAP_DIRECTORY_LEASING 0x00000020 /* New to SMB3 */
186#define SMB2_GLOBAL_CAP_ENCRYPTION 0x00000040 /* New to SMB3 */
29e20f9c
PS		 187/* Internal types */
188#define SMB2_NT_FIND 0x00100000
189#define SMB2_LARGE_FILES 0x00200000
ec2e4523
PS		 190
191struct smb2_negotiate_rsp {
192 struct smb2_hdr hdr;
193 __le16 StructureSize; /* Must be 65 */
194 __le16 SecurityMode;
195 __le16 DialectRevision;
196 __le16 Reserved; /* MBZ */
197 __u8 ServerGUID[16];
198 __le32 Capabilities;
199 __le32 MaxTransactSize;
200 __le32 MaxReadSize;
201 __le32 MaxWriteSize;
202 __le64 SystemTime; /* MBZ */
203 __le64 ServerStartTime;
204 __le16 SecurityBufferOffset;
205 __le16 SecurityBufferLength;
206 __le32 Reserved2; /* may be any value, ignore */
207 __u8 Buffer[1]; /* variable length GSS security buffer */
208} __packed;
209
5478f9ba
PS		 210struct smb2_sess_setup_req {
211 struct smb2_hdr hdr;
212 __le16 StructureSize; /* Must be 25 */
213 __u8 VcNumber;
214 __u8 SecurityMode;
215 __le32 Capabilities;
216 __le32 Channel;
217 __le16 SecurityBufferOffset;
218 __le16 SecurityBufferLength;
219 __le64 PreviousSessionId;
220 __u8 Buffer[1]; /* variable length GSS security buffer */
221} __packed;
222
223/* Currently defined SessionFlags */
224#define SMB2_SESSION_FLAG_IS_GUEST 0x0001
225#define SMB2_SESSION_FLAG_IS_NULL 0x0002
226struct smb2_sess_setup_rsp {
227 struct smb2_hdr hdr;
228 __le16 StructureSize; /* Must be 9 */
229 __le16 SessionFlags;
230 __le16 SecurityBufferOffset;
231 __le16 SecurityBufferLength;
232 __u8 Buffer[1]; /* variable length GSS security buffer */
233} __packed;
234
235struct smb2_logoff_req {
236 struct smb2_hdr hdr;
237 __le16 StructureSize; /* Must be 4 */
238 __le16 Reserved;
239} __packed;
240
241struct smb2_logoff_rsp {
242 struct smb2_hdr hdr;
243 __le16 StructureSize; /* Must be 4 */
244 __le16 Reserved;
245} __packed;
246
faaf946a
PS		 247struct smb2_tree_connect_req {
248 struct smb2_hdr hdr;
249 __le16 StructureSize; /* Must be 9 */
250 __le16 Reserved;
251 __le16 PathOffset;
252 __le16 PathLength;
253 __u8 Buffer[1]; /* variable length */
254} __packed;
255
256struct smb2_tree_connect_rsp {
257 struct smb2_hdr hdr;
258 __le16 StructureSize; /* Must be 16 */
259 __u8 ShareType; /* see below */
260 __u8 Reserved;
261 __le32 ShareFlags; /* see below */
262 __le32 Capabilities; /* see below */
263 __le32 MaximalAccess;
264} __packed;
265
266/* Possible ShareType values */
267#define SMB2_SHARE_TYPE_DISK 0x01
268#define SMB2_SHARE_TYPE_PIPE 0x02
269#define SMB2_SHARE_TYPE_PRINT 0x03
270
271/*
272 * Possible ShareFlags - exactly one and only one of the first 4 caching flags
273 * must be set (any of the remaining, SHI1005, flags may be set individually
274 * or in combination.
275 */
276#define SMB2_SHAREFLAG_MANUAL_CACHING 0x00000000
277#define SMB2_SHAREFLAG_AUTO_CACHING 0x00000010
278#define SMB2_SHAREFLAG_VDO_CACHING 0x00000020
279#define SMB2_SHAREFLAG_NO_CACHING 0x00000030
280#define SHI1005_FLAGS_DFS 0x00000001
281#define SHI1005_FLAGS_DFS_ROOT 0x00000002
282#define SHI1005_FLAGS_RESTRICT_EXCLUSIVE_OPENS 0x00000100
283#define SHI1005_FLAGS_FORCE_SHARED_DELETE 0x00000200
284#define SHI1005_FLAGS_ALLOW_NAMESPACE_CACHING 0x00000400
285#define SHI1005_FLAGS_ACCESS_BASED_DIRECTORY_ENUM 0x00000800
286#define SHI1005_FLAGS_FORCE_LEVELII_OPLOCK 0x00001000
287#define SHI1005_FLAGS_ENABLE_HASH 0x00002000
288
289/* Possible share capabilities */
2b5dc286
SF		 290#define SMB2_SHARE_CAP_DFS cpu_to_le32(0x00000008) /* all dialects */
291#define SMB2_SHARE_CAP_CONTINUOUS_AVAILABILITY cpu_to_le32(0x00000010) /* 3.0 */
292#define SMB2_SHARE_CAP_SCALEOUT cpu_to_le32(0x00000020) /* 3.0 */
293#define SMB2_SHARE_CAP_CLUSTER cpu_to_le32(0x00000040) /* 3.0 */
294#define SMB2_SHARE_CAP_ASYMMETRIC cpu_to_le32(0x00000080) /* 3.02 */
faaf946a
PS		 295
296struct smb2_tree_disconnect_req {
297 struct smb2_hdr hdr;
298 __le16 StructureSize; /* Must be 4 */
299 __le16 Reserved;
300} __packed;
301
302struct smb2_tree_disconnect_rsp {
303 struct smb2_hdr hdr;
304 __le16 StructureSize; /* Must be 4 */
305 __le16 Reserved;
306} __packed;
307
2503a0db
PS		 308/* File Attrubutes */
309#define FILE_ATTRIBUTE_READONLY 0x00000001
310#define FILE_ATTRIBUTE_HIDDEN 0x00000002
311#define FILE_ATTRIBUTE_SYSTEM 0x00000004
312#define FILE_ATTRIBUTE_DIRECTORY 0x00000010
313#define FILE_ATTRIBUTE_ARCHIVE 0x00000020
314#define FILE_ATTRIBUTE_NORMAL 0x00000080
315#define FILE_ATTRIBUTE_TEMPORARY 0x00000100
316#define FILE_ATTRIBUTE_SPARSE_FILE 0x00000200
317#define FILE_ATTRIBUTE_REPARSE_POINT 0x00000400
318#define FILE_ATTRIBUTE_COMPRESSED 0x00000800
319#define FILE_ATTRIBUTE_OFFLINE 0x00001000
320#define FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 0x00002000
321#define FILE_ATTRIBUTE_ENCRYPTED 0x00004000
322
323/* Oplock levels */
324#define SMB2_OPLOCK_LEVEL_NONE 0x00
325#define SMB2_OPLOCK_LEVEL_II 0x01
326#define SMB2_OPLOCK_LEVEL_EXCLUSIVE 0x08
327#define SMB2_OPLOCK_LEVEL_BATCH 0x09
328#define SMB2_OPLOCK_LEVEL_LEASE 0xFF
b8c32dbb
PS		 329/* Non-spec internal type */
330#define SMB2_OPLOCK_LEVEL_NOCHANGE 0x99
2503a0db
PS		 331
332/* Desired Access Flags */
333#define FILE_READ_DATA_LE cpu_to_le32(0x00000001)
334#define FILE_WRITE_DATA_LE cpu_to_le32(0x00000002)
335#define FILE_APPEND_DATA_LE cpu_to_le32(0x00000004)
336#define FILE_READ_EA_LE cpu_to_le32(0x00000008)
337#define FILE_WRITE_EA_LE cpu_to_le32(0x00000010)
338#define FILE_EXECUTE_LE cpu_to_le32(0x00000020)
339#define FILE_READ_ATTRIBUTES_LE cpu_to_le32(0x00000080)
340#define FILE_WRITE_ATTRIBUTES_LE cpu_to_le32(0x00000100)
341#define FILE_DELETE_LE cpu_to_le32(0x00010000)
342#define FILE_READ_CONTROL_LE cpu_to_le32(0x00020000)
343#define FILE_WRITE_DAC_LE cpu_to_le32(0x00040000)
344#define FILE_WRITE_OWNER_LE cpu_to_le32(0x00080000)
345#define FILE_SYNCHRONIZE_LE cpu_to_le32(0x00100000)
346#define FILE_ACCESS_SYSTEM_SECURITY_LE cpu_to_le32(0x01000000)
347#define FILE_MAXIMAL_ACCESS_LE cpu_to_le32(0x02000000)
348#define FILE_GENERIC_ALL_LE cpu_to_le32(0x10000000)
349#define FILE_GENERIC_EXECUTE_LE cpu_to_le32(0x20000000)
350#define FILE_GENERIC_WRITE_LE cpu_to_le32(0x40000000)
351#define FILE_GENERIC_READ_LE cpu_to_le32(0x80000000)
352
353/* ShareAccess Flags */
354#define FILE_SHARE_READ_LE cpu_to_le32(0x00000001)
355#define FILE_SHARE_WRITE_LE cpu_to_le32(0x00000002)
356#define FILE_SHARE_DELETE_LE cpu_to_le32(0x00000004)
357#define FILE_SHARE_ALL_LE cpu_to_le32(0x00000007)
358
359/* CreateDisposition Flags */
360#define FILE_SUPERSEDE_LE cpu_to_le32(0x00000000)
361#define FILE_OPEN_LE cpu_to_le32(0x00000001)
362#define FILE_CREATE_LE cpu_to_le32(0x00000002)
363#define FILE_OPEN_IF_LE cpu_to_le32(0x00000003)
364#define FILE_OVERWRITE_LE cpu_to_le32(0x00000004)
365#define FILE_OVERWRITE_IF_LE cpu_to_le32(0x00000005)
366
367/* CreateOptions Flags */
368#define FILE_DIRECTORY_FILE_LE cpu_to_le32(0x00000001)
369/* same as #define CREATE_NOT_FILE_LE cpu_to_le32(0x00000001) */
370#define FILE_WRITE_THROUGH_LE cpu_to_le32(0x00000002)
371#define FILE_SEQUENTIAL_ONLY_LE cpu_to_le32(0x00000004)
372#define FILE_NO_INTERMEDIATE_BUFFERRING_LE cpu_to_le32(0x00000008)
373#define FILE_SYNCHRONOUS_IO_ALERT_LE cpu_to_le32(0x00000010)
374#define FILE_SYNCHRONOUS_IO_NON_ALERT_LE cpu_to_le32(0x00000020)
375#define FILE_NON_DIRECTORY_FILE_LE cpu_to_le32(0x00000040)
376#define FILE_COMPLETE_IF_OPLOCKED_LE cpu_to_le32(0x00000100)
377#define FILE_NO_EA_KNOWLEDGE_LE cpu_to_le32(0x00000200)
378#define FILE_RANDOM_ACCESS_LE cpu_to_le32(0x00000800)
379#define FILE_DELETE_ON_CLOSE_LE cpu_to_le32(0x00001000)
380#define FILE_OPEN_BY_FILE_ID_LE cpu_to_le32(0x00002000)
381#define FILE_OPEN_FOR_BACKUP_INTENT_LE cpu_to_le32(0x00004000)
382#define FILE_NO_COMPRESSION_LE cpu_to_le32(0x00008000)
383#define FILE_RESERVE_OPFILTER_LE cpu_to_le32(0x00100000)
384#define FILE_OPEN_REPARSE_POINT_LE cpu_to_le32(0x00200000)
385#define FILE_OPEN_NO_RECALL_LE cpu_to_le32(0x00400000)
386#define FILE_OPEN_FOR_FREE_SPACE_QUERY_LE cpu_to_le32(0x00800000)
387
388#define FILE_READ_RIGHTS_LE (FILE_READ_DATA_LE | FILE_READ_EA_LE \
389 | FILE_READ_ATTRIBUTES_LE)
390#define FILE_WRITE_RIGHTS_LE (FILE_WRITE_DATA_LE | FILE_APPEND_DATA_LE \
391 | FILE_WRITE_EA_LE | FILE_WRITE_ATTRIBUTES_LE)
392#define FILE_EXEC_RIGHTS_LE (FILE_EXECUTE_LE)
393
394/* Impersonation Levels */
395#define IL_ANONYMOUS cpu_to_le32(0x00000000)
396#define IL_IDENTIFICATION cpu_to_le32(0x00000001)
397#define IL_IMPERSONATION cpu_to_le32(0x00000002)
398#define IL_DELEGATE cpu_to_le32(0x00000003)
399
400/* Create Context Values */
401#define SMB2_CREATE_EA_BUFFER "ExtA" /* extended attributes */
402#define SMB2_CREATE_SD_BUFFER "SecD" /* security descriptor */
403#define SMB2_CREATE_DURABLE_HANDLE_REQUEST "DHnQ"
404#define SMB2_CREATE_DURABLE_HANDLE_RECONNECT "DHnC"
405#define SMB2_CREATE_ALLOCATION_SIZE "AlSi"
406#define SMB2_CREATE_QUERY_MAXIMAL_ACCESS_REQUEST "MxAc"
407#define SMB2_CREATE_TIMEWARP_REQUEST "TWrp"
408#define SMB2_CREATE_QUERY_ON_DISK_ID "QFid"
409#define SMB2_CREATE_REQUEST_LEASE "RqLs"
410
411struct smb2_create_req {
412 struct smb2_hdr hdr;
413 __le16 StructureSize; /* Must be 57 */
414 __u8 SecurityFlags;
415 __u8 RequestedOplockLevel;
416 __le32 ImpersonationLevel;
417 __le64 SmbCreateFlags;
418 __le64 Reserved;
419 __le32 DesiredAccess;
420 __le32 FileAttributes;
421 __le32 ShareAccess;
422 __le32 CreateDisposition;
423 __le32 CreateOptions;
424 __le16 NameOffset;
425 __le16 NameLength;
426 __le32 CreateContextsOffset;
427 __le32 CreateContextsLength;
b8c32dbb 428 __u8 Buffer[8];
2503a0db
PS		 429} __packed;
430
431struct smb2_create_rsp {
432 struct smb2_hdr hdr;
433 __le16 StructureSize; /* Must be 89 */
434 __u8 OplockLevel;
435 __u8 Reserved;
436 __le32 CreateAction;
437 __le64 CreationTime;
438 __le64 LastAccessTime;
439 __le64 LastWriteTime;
440 __le64 ChangeTime;
441 __le64 AllocationSize;
442 __le64 EndofFile;
443 __le32 FileAttributes;
444 __le32 Reserved2;
445 __u64 PersistentFileId; /* opaque endianness */
446 __u64 VolatileFileId; /* opaque endianness */
447 __le32 CreateContextsOffset;
448 __le32 CreateContextsLength;
449 __u8 Buffer[1];
450} __packed;
451
b8c32dbb
PS		 452struct create_context {
453 __le32 Next;
454 __le16 NameOffset;
455 __le16 NameLength;
456 __le16 Reserved;
457 __le16 DataOffset;
458 __le32 DataLength;
459 __u8 Buffer[0];
460} __packed;
461
462#define SMB2_LEASE_NONE __constant_cpu_to_le32(0x00)
463#define SMB2_LEASE_READ_CACHING __constant_cpu_to_le32(0x01)
464#define SMB2_LEASE_HANDLE_CACHING __constant_cpu_to_le32(0x02)
465#define SMB2_LEASE_WRITE_CACHING __constant_cpu_to_le32(0x04)
466
467#define SMB2_LEASE_FLAG_BREAK_IN_PROGRESS __constant_cpu_to_le32(0x02)
468
469#define SMB2_LEASE_KEY_SIZE 16
470
471struct lease_context {
472 __le64 LeaseKeyLow;
473 __le64 LeaseKeyHigh;
474 __le32 LeaseState;
475 __le32 LeaseFlags;
476 __le64 LeaseDuration;
477} __packed;
478
479struct create_lease {
480 struct create_context ccontext;
481 __u8 Name[8];
482 struct lease_context lcontext;
483} __packed;
484
be7457d3
SF		 485/* this goes in the ioctl buffer when doing a copychunk request */
486struct copychunk_ioctl {
487 char SourceKey[24];
488 __le32 ChunkCount; /* we are only sending 1 */
489 __le32 Reserved;
490 /* array will only be one chunk long for us */
491 __le64 SourceOffset;
492 __le64 TargetOffset;
493 __u32 Length; /* how many bytes to copy */
494 __u32 Reserved2;
495} __packed;
496
497struct smb2_ioctl_req {
498 struct smb2_hdr hdr;
499 __le16 StructureSize; /* Must be 57 */
500 __u16 Reserved;
501 __le32 CtlCode;
502 __u64 PersistentFileId; /* opaque endianness */
503 __u64 VolatileFileId; /* opaque endianness */
504 __le32 InputOffset;
505 __le32 InputCount;
506 __le32 MaxInputResponse;
507 __le32 OutputOffset;
508 __le32 OutputCount;
509 __le32 MaxOutputResponse;
510 __le32 Flags;
511 __u32 Reserved2;
512 char Buffer[0];
513} __packed;
514
515struct smb2_ioctl_rsp {
516 struct smb2_hdr hdr;
517 __le16 StructureSize; /* Must be 57 */
518 __u16 Reserved;
519 __le32 CtlCode;
520 __u64 PersistentFileId; /* opaque endianness */
521 __u64 VolatileFileId; /* opaque endianness */
522 __le32 InputOffset;
523 __le32 InputCount;
524 __le32 OutputOffset;
525 __le32 OutputCount;
526 __le32 Flags;
527 __u32 Reserved2;
528 /* char * buffer[] */
529} __packed;
530
2503a0db
PS		 531/* Currently defined values for close flags */
532#define SMB2_CLOSE_FLAG_POSTQUERY_ATTRIB cpu_to_le16(0x0001)
533struct smb2_close_req {
534 struct smb2_hdr hdr;
535 __le16 StructureSize; /* Must be 24 */
536 __le16 Flags;
537 __le32 Reserved;
538 __u64 PersistentFileId; /* opaque endianness */
539 __u64 VolatileFileId; /* opaque endianness */
540} __packed;
541
542struct smb2_close_rsp {
543 struct smb2_hdr hdr;
544 __le16 StructureSize; /* 60 */
545 __le16 Flags;
546 __le32 Reserved;
547 __le64 CreationTime;
548 __le64 LastAccessTime;
549 __le64 LastWriteTime;
550 __le64 ChangeTime;
551 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
552 __le64 EndOfFile;
553 __le32 Attributes;
554} __packed;
555
7a5cfb19
PS		 556struct smb2_flush_req {
557 struct smb2_hdr hdr;
558 __le16 StructureSize; /* Must be 24 */
559 __le16 Reserved1;
560 __le32 Reserved2;
561 __u64 PersistentFileId; /* opaque endianness */
562 __u64 VolatileFileId; /* opaque endianness */
563} __packed;
564
565struct smb2_flush_rsp {
566 struct smb2_hdr hdr;
567 __le16 StructureSize;
568 __le16 Reserved;
569} __packed;
570
2b5dc286
SF		 571/* For read request Flags field below, following flag is defined for SMB3.02 */
572#define SMB2_READFLAG_READ_UNBUFFERED 0x01
573
574/* Channel field for read and write: exactly one of following flags can be set*/
575#define SMB2_CHANNEL_NONE 0x00000000
576#define SMB2_CHANNEL_RDMA_V1 0x00000001 /* SMB3 or later */
577#define SMB2_CHANNEL_RDMA_V1_INVALIDATE 0x00000001 /* SMB3.02 or later */
578
09a4707e
PS		 579struct smb2_read_req {
580 struct smb2_hdr hdr;
581 __le16 StructureSize; /* Must be 49 */
582 __u8 Padding; /* offset from start of SMB2 header to place read */
2b5dc286 583 __u8 Flags; /* MBZ unless SMB3.02 or later */
09a4707e
PS		 584 __le32 Length;
585 __le64 Offset;
586 __u64 PersistentFileId; /* opaque endianness */
587 __u64 VolatileFileId; /* opaque endianness */
588 __le32 MinimumCount;
2b5dc286 589 __le32 Channel; /* MBZ except for SMB3 or later */
09a4707e
PS		 590 __le32 RemainingBytes;
591 __le16 ReadChannelInfoOffset; /* Reserved MBZ */
592 __le16 ReadChannelInfoLength; /* Reserved MBZ */
593 __u8 Buffer[1];
594} __packed;
595
596struct smb2_read_rsp {
597 struct smb2_hdr hdr;
598 __le16 StructureSize; /* Must be 17 */
599 __u8 DataOffset;
33319141
PS		 600 __u8 Reserved;
601 __le32 DataLength;
602 __le32 DataRemaining;
603 __u32 Reserved2;
604 __u8 Buffer[1];
605} __packed;
606
2b5dc286
SF		 607/* For write request Flags field below the following flags are defined: */
608#define SMB2_WRITEFLAG_WRITE_THROUGH 0x00000001 /* SMB2.1 or later */
609#define SMB2_WRITEFLAG_WRITE_UNBUFFERED 0x00000002 /* SMB3.02 or later */
33319141
PS		 610
611struct smb2_write_req {
612 struct smb2_hdr hdr;
613 __le16 StructureSize; /* Must be 49 */
614 __le16 DataOffset; /* offset from start of SMB2 header to write data */
615 __le32 Length;
616 __le64 Offset;
617 __u64 PersistentFileId; /* opaque endianness */
618 __u64 VolatileFileId; /* opaque endianness */
619 __le32 Channel; /* Reserved MBZ */
620 __le32 RemainingBytes;
621 __le16 WriteChannelInfoOffset; /* Reserved MBZ */
622 __le16 WriteChannelInfoLength; /* Reserved MBZ */
623 __le32 Flags;
624 __u8 Buffer[1];
625} __packed;
626
627struct smb2_write_rsp {
628 struct smb2_hdr hdr;
629 __le16 StructureSize; /* Must be 17 */
630 __u8 DataOffset;
09a4707e
PS		 631 __u8 Reserved;
632 __le32 DataLength;
633 __le32 DataRemaining;
634 __u32 Reserved2;
635 __u8 Buffer[1];
636} __packed;
637
027e8eec
PS		 638#define SMB2_LOCKFLAG_SHARED_LOCK 0x0001
639#define SMB2_LOCKFLAG_EXCLUSIVE_LOCK 0x0002
640#define SMB2_LOCKFLAG_UNLOCK 0x0004
641#define SMB2_LOCKFLAG_FAIL_IMMEDIATELY 0x0010
642
f7ba7fe6
PS		 643struct smb2_lock_element {
644 __le64 Offset;
645 __le64 Length;
646 __le32 Flags;
647 __le32 Reserved;
648} __packed;
649
650struct smb2_lock_req {
651 struct smb2_hdr hdr;
652 __le16 StructureSize; /* Must be 48 */
653 __le16 LockCount;
654 __le32 Reserved;
655 __u64 PersistentFileId; /* opaque endianness */
656 __u64 VolatileFileId; /* opaque endianness */
657 /* Followed by at least one */
658 struct smb2_lock_element locks[1];
659} __packed;
660
661struct smb2_lock_rsp {
662 struct smb2_hdr hdr;
663 __le16 StructureSize; /* Must be 4 */
664 __le16 Reserved;
665} __packed;
666
9094fad1
PS		 667struct smb2_echo_req {
668 struct smb2_hdr hdr;
669 __le16 StructureSize; /* Must be 4 */
670 __u16 Reserved;
671} __packed;
672
673struct smb2_echo_rsp {
674 struct smb2_hdr hdr;
675 __le16 StructureSize; /* Must be 4 */
676 __u16 Reserved;
677} __packed;
678
d324f08d
PS		 679/* search (query_directory) Flags field */
680#define SMB2_RESTART_SCANS 0x01
681#define SMB2_RETURN_SINGLE_ENTRY 0x02
682#define SMB2_INDEX_SPECIFIED 0x04
683#define SMB2_REOPEN 0x10
684
685struct smb2_query_directory_req {
686 struct smb2_hdr hdr;
687 __le16 StructureSize; /* Must be 33 */
688 __u8 FileInformationClass;
689 __u8 Flags;
690 __le32 FileIndex;
691 __u64 PersistentFileId; /* opaque endianness */
692 __u64 VolatileFileId; /* opaque endianness */
693 __le16 FileNameOffset;
694 __le16 FileNameLength;
695 __le32 OutputBufferLength;
696 __u8 Buffer[1];
697} __packed;
698
699struct smb2_query_directory_rsp {
700 struct smb2_hdr hdr;
701 __le16 StructureSize; /* Must be 9 */
702 __le16 OutputBufferOffset;
703 __le32 OutputBufferLength;
704 __u8 Buffer[1];
705} __packed;
706
be4cb9e3
PS		 707/* Possible InfoType values */
708#define SMB2_O_INFO_FILE 0x01
709#define SMB2_O_INFO_FILESYSTEM 0x02
710#define SMB2_O_INFO_SECURITY 0x03
711#define SMB2_O_INFO_QUOTA 0x04
712
713struct smb2_query_info_req {
714 struct smb2_hdr hdr;
715 __le16 StructureSize; /* Must be 41 */
716 __u8 InfoType;
717 __u8 FileInfoClass;
718 __le32 OutputBufferLength;
719 __le16 InputBufferOffset;
720 __u16 Reserved;
721 __le32 InputBufferLength;
722 __le32 AdditionalInformation;
723 __le32 Flags;
724 __u64 PersistentFileId; /* opaque endianness */
725 __u64 VolatileFileId; /* opaque endianness */
726 __u8 Buffer[1];
727} __packed;
728
729struct smb2_query_info_rsp {
730 struct smb2_hdr hdr;
731 __le16 StructureSize; /* Must be 9 */
732 __le16 OutputBufferOffset;
733 __le32 OutputBufferLength;
734 __u8 Buffer[1];
735} __packed;
736
35143eb5
PS		 737struct smb2_set_info_req {
738 struct smb2_hdr hdr;
739 __le16 StructureSize; /* Must be 33 */
740 __u8 InfoType;
741 __u8 FileInfoClass;
742 __le32 BufferLength;
743 __le16 BufferOffset;
744 __u16 Reserved;
745 __le32 AdditionalInformation;
746 __u64 PersistentFileId; /* opaque endianness */
747 __u64 VolatileFileId; /* opaque endianness */
748 __u8 Buffer[1];
749} __packed;
750
751struct smb2_set_info_rsp {
752 struct smb2_hdr hdr;
753 __le16 StructureSize; /* Must be 2 */
754} __packed;
755
983c88a4
PS		 756struct smb2_oplock_break {
757 struct smb2_hdr hdr;
758 __le16 StructureSize; /* Must be 24 */
759 __u8 OplockLevel;
760 __u8 Reserved;
761 __le32 Reserved2;
762 __u64 PersistentFid;
763 __u64 VolatileFid;
764} __packed;
765
0822f514
PS		 766#define SMB2_NOTIFY_BREAK_LEASE_FLAG_ACK_REQUIRED cpu_to_le32(0x01)
767
768struct smb2_lease_break {
769 struct smb2_hdr hdr;
770 __le16 StructureSize; /* Must be 44 */
771 __le16 Reserved;
772 __le32 Flags;
773 __u8 LeaseKey[16];
774 __le32 CurrentLeaseState;
775 __le32 NewLeaseState;
776 __le32 BreakReason;
777 __le32 AccessMaskHint;
778 __le32 ShareMaskHint;
779} __packed;
780
781struct smb2_lease_ack {
782 struct smb2_hdr hdr;
783 __le16 StructureSize; /* Must be 36 */
784 __le16 Reserved;
785 __le32 Flags;
786 __u8 LeaseKey[16];
787 __le32 LeaseState;
788 __le64 LeaseDuration;
789} __packed;
790
be4cb9e3
PS		 791/*
792 * PDU infolevel structure definitions
793 * BB consider moving to a different header
794 */
795
6fc05c25
PS		 796/* File System Information Classes */
797#define FS_VOLUME_INFORMATION 1 /* Query */
798#define FS_LABEL_INFORMATION 2 /* Set */
799#define FS_SIZE_INFORMATION 3 /* Query */
800#define FS_DEVICE_INFORMATION 4 /* Query */
801#define FS_ATTRIBUTE_INFORMATION 5 /* Query */
802#define FS_CONTROL_INFORMATION 6 /* Query, Set */
803#define FS_FULL_SIZE_INFORMATION 7 /* Query */
804#define FS_OBJECT_ID_INFORMATION 8 /* Query, Set */
805#define FS_DRIVER_PATH_INFORMATION 9 /* Query */
806
807struct smb2_fs_full_size_info {
808 __le64 TotalAllocationUnits;
809 __le64 CallerAvailableAllocationUnits;
810 __le64 ActualAvailableAllocationUnits;
811 __le32 SectorsPerAllocationUnit;
812 __le32 BytesPerSector;
813} __packed;
814
be4cb9e3
PS		 815/* partial list of QUERY INFO levels */
816#define FILE_DIRECTORY_INFORMATION 1
817#define FILE_FULL_DIRECTORY_INFORMATION 2
818#define FILE_BOTH_DIRECTORY_INFORMATION 3
819#define FILE_BASIC_INFORMATION 4
820#define FILE_STANDARD_INFORMATION 5
821#define FILE_INTERNAL_INFORMATION 6
822#define FILE_EA_INFORMATION 7
823#define FILE_ACCESS_INFORMATION 8
824#define FILE_NAME_INFORMATION 9
825#define FILE_RENAME_INFORMATION 10
826#define FILE_LINK_INFORMATION 11
827#define FILE_NAMES_INFORMATION 12
828#define FILE_DISPOSITION_INFORMATION 13
829#define FILE_POSITION_INFORMATION 14
830#define FILE_FULL_EA_INFORMATION 15
831#define FILE_MODE_INFORMATION 16
832#define FILE_ALIGNMENT_INFORMATION 17
833#define FILE_ALL_INFORMATION 18
834#define FILE_ALLOCATION_INFORMATION 19
835#define FILE_END_OF_FILE_INFORMATION 20
836#define FILE_ALTERNATE_NAME_INFORMATION 21
837#define FILE_STREAM_INFORMATION 22
838#define FILE_PIPE_INFORMATION 23
839#define FILE_PIPE_LOCAL_INFORMATION 24
840#define FILE_PIPE_REMOTE_INFORMATION 25
841#define FILE_MAILSLOT_QUERY_INFORMATION 26
842#define FILE_MAILSLOT_SET_INFORMATION 27
843#define FILE_COMPRESSION_INFORMATION 28
844#define FILE_OBJECT_ID_INFORMATION 29
845/* Number 30 not defined in documents */
846#define FILE_MOVE_CLUSTER_INFORMATION 31
847#define FILE_QUOTA_INFORMATION 32
848#define FILE_REPARSE_POINT_INFORMATION 33
849#define FILE_NETWORK_OPEN_INFORMATION 34
850#define FILE_ATTRIBUTE_TAG_INFORMATION 35
851#define FILE_TRACKING_INFORMATION 36
852#define FILEID_BOTH_DIRECTORY_INFORMATION 37
853#define FILEID_FULL_DIRECTORY_INFORMATION 38
854#define FILE_VALID_DATA_LENGTH_INFORMATION 39
855#define FILE_SHORT_NAME_INFORMATION 40
856#define FILE_SFIO_RESERVE_INFORMATION 44
857#define FILE_SFIO_VOLUME_INFORMATION 45
858#define FILE_HARD_LINK_INFORMATION 46
859#define FILE_NORMALIZED_NAME_INFORMATION 48
860#define FILEID_GLOBAL_TX_DIRECTORY_INFORMATION 50
861#define FILE_STANDARD_LINK_INFORMATION 54
862
f0df737e
PS		 863struct smb2_file_internal_info {
864 __le64 IndexNumber;
865} __packed; /* level 6 Query */
866
35143eb5
PS		 867struct smb2_file_rename_info { /* encoding of request for level 10 */
868 __u8 ReplaceIfExists; /* 1 = replace existing target with new */
869 /* 0 = fail if target already exists */
870 __u8 Reserved[7];
871 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
872 __le32 FileNameLength;
873 char FileName[0]; /* New name to be assigned */
874} __packed; /* level 10 Set */
875
568798cc
PS		 876struct smb2_file_link_info { /* encoding of request for level 11 */
877 __u8 ReplaceIfExists; /* 1 = replace existing link with new */
878 /* 0 = fail if link already exists */
879 __u8 Reserved[7];
880 __u64 RootDirectory; /* MBZ for network operations (why says spec?) */
881 __le32 FileNameLength;
882 char FileName[0]; /* Name to be assigned to new link */
883} __packed; /* level 11 Set */
884
be4cb9e3
PS		 885/*
886 * This level 18, although with struct with same name is different from cifs
887 * level 0x107. Level 0x107 has an extra u64 between AccessFlags and
888 * CurrentByteOffset.
889 */
890struct smb2_file_all_info { /* data block encoding of response to level 18 */
891 __le64 CreationTime; /* Beginning of FILE_BASIC_INFO equivalent */
892 __le64 LastAccessTime;
893 __le64 LastWriteTime;
894 __le64 ChangeTime;
895 __le32 Attributes;
896 __u32 Pad1; /* End of FILE_BASIC_INFO_INFO equivalent */
897 __le64 AllocationSize; /* Beginning of FILE_STANDARD_INFO equivalent */
898 __le64 EndOfFile; /* size ie offset to first free byte in file */
899 __le32 NumberOfLinks; /* hard links */
900 __u8 DeletePending;
901 __u8 Directory;
902 __u16 Pad2; /* End of FILE_STANDARD_INFO equivalent */
903 __le64 IndexNumber;
904 __le32 EASize;
905 __le32 AccessFlags;
906 __le64 CurrentByteOffset;
907 __le32 Mode;
908 __le32 AlignmentRequirement;
909 __le32 FileNameLength;
910 char FileName[1];
911} __packed; /* level 18 Query */
912
c839ff24
PS		 913struct smb2_file_eof_info { /* encoding of request for level 10 */
914 __le64 EndOfFile; /* new end of file value */
915} __packed; /* level 20 Set */
916
ddfbefbd 917#endif /* _SMB2PDU_H */
A mirror of Linus' kernel repository