1/*
2   Unix SMB/CIFS implementation.
3   SMB transaction2 handling
4   Copyright (C) Jeremy Allison 1994-2002.
5
6   Extensively modified by Andrew Tridgell, 1995
7
8   This program is free software; you can redistribute it and/or modify
9   it under the terms of the GNU General Public License as published by
10   the Free Software Foundation; either version 2 of the License, or
11   (at your option) any later version.
12
13   This program is distributed in the hope that it will be useful,
14   but WITHOUT ANY WARRANTY; without even the implied warranty of
15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16   GNU General Public License for more details.
17
18   You should have received a copy of the GNU General Public License
19   along with this program; if not, write to the Free Software
20   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21*/
22
23#ifndef _TRANS2_H_
24#define _TRANS2_H_
25
26/* Define the structures needed for the trans2 calls. */
27
28/*******************************************************
29 For DosFindFirst/DosFindNext - level 1
30
31MAXFILENAMELEN = 255;
32FDATE == uint16
33FTIME == uint16
34ULONG == uint32
35USHORT == uint16
36
37typedef struct _FILEFINDBUF {
38Byte offset   Type     name                description
39-------------+-------+-------------------+--------------
400             FDATE    fdateCreation;
412             FTIME    ftimeCreation;
424             FDATE    fdateLastAccess;
436             FTIME    ftimeLastAccess;
448             FDATE    fdateLastWrite;
4510            FTIME    ftimeLastWrite;
4612            ULONG    cbFile               file length in bytes
4716            ULONG    cbFileAlloc          size of file allocation unit
4820            USHORT   attrFile
4922            UCHAR    cchName              length of name to follow (not including zero)
5023            UCHAR    achName[MAXFILENAMELEN]; Null terminated name
51} FILEFINDBUF;
52*********************************************************/
53
54#define l1_fdateCreation 0
55#define l1_fdateLastAccess 4
56#define l1_fdateLastWrite 8
57#define l1_cbFile 12
58#define l1_cbFileAlloc 16
59#define l1_attrFile 20
60#define l1_cchName 22
61#define l1_achName 23
62
63/**********************************************************
64For DosFindFirst/DosFindNext - level 2
65
66typedef struct _FILEFINDBUF2 {
67Byte offset   Type     name                description
68-------------+-------+-------------------+--------------
690             FDATE    fdateCreation;
702             FTIME    ftimeCreation;
714             FDATE    fdateLastAccess;
726             FTIME    ftimeLastAccess;
738             FDATE    fdateLastWrite;
7410            FTIME    ftimeLastWrite;
7512            ULONG    cbFile               file length in bytes
7616            ULONG    cbFileAlloc          size of file allocation unit
7720            USHORT   attrFile
7822            ULONG    cbList               Extended attribute list (always 0)
7926            UCHAR    cchName              length of name to follow (not including zero)
8027            UCHAR    achName[MAXFILENAMELEN]; Null terminated name
81} FILEFINDBUF2;
82*************************************************************/
83
84#define l2_fdateCreation 0
85#define l2_fdateLastAccess 4
86#define l2_fdateLastWrite 8
87#define l2_cbFile 12
88#define l2_cbFileAlloc 16
89#define l2_attrFile 20
90#define l2_cbList 22
91#define l2_cchName 26
92#define l2_achName 27
93
94
95/**********************************************************
96For DosFindFirst/DosFindNext - level 260
97
98typedef struct _FILEFINDBUF260 {
99Byte offset   Type     name                description
100-------------+-------+-------------------+--------------
1010              ULONG  NextEntryOffset;
1024              ULONG  FileIndex;
1038              LARGE_INTEGER CreationTime;
10416             LARGE_INTEGER LastAccessTime;
10524             LARGE_INTEGER LastWriteTime;
10632             LARGE_INTEGER ChangeTime;
10740             LARGE_INTEGER EndOfFile;
10848             LARGE_INTEGER AllocationSize;
10956             ULONG FileAttributes;
11060             ULONG FileNameLength;
11164             ULONG EaSize;
11268             CHAR ShortNameLength;
11370             UNICODE ShortName[12];
11494             UNICODE FileName[];
115*************************************************************/
116
117#define l260_achName 94
118
119
120/**********************************************************
121For DosQueryPathInfo/DosQueryFileInfo/DosSetPathInfo/
122DosSetFileInfo - level 1
123
124typedef struct _FILESTATUS {
125Byte offset   Type     name                description
126-------------+-------+-------------------+--------------
1270             FDATE    fdateCreation;
1282             FTIME    ftimeCreation;
1294             FDATE    fdateLastAccess;
1306             FTIME    ftimeLastAccess;
1318             FDATE    fdateLastWrite;
13210            FTIME    ftimeLastWrite;
13312            ULONG    cbFile               file length in bytes
13416            ULONG    cbFileAlloc          size of file allocation unit
13520            USHORT   attrFile
136} FILESTATUS;
137*************************************************************/
138
139/* Use the l1_ defines from DosFindFirst */
140
141/**********************************************************
142For DosQueryPathInfo/DosQueryFileInfo/DosSetPathInfo/
143DosSetFileInfo - level 2
144
145typedef struct _FILESTATUS2 {
146Byte offset   Type     name                description
147-------------+-------+-------------------+--------------
1480             FDATE    fdateCreation;
1492             FTIME    ftimeCreation;
1504             FDATE    fdateLastAccess;
1516             FTIME    ftimeLastAccess;
1528             FDATE    fdateLastWrite;
15310            FTIME    ftimeLastWrite;
15412            ULONG    cbFile               file length in bytes
15516            ULONG    cbFileAlloc          size of file allocation unit
15620            USHORT   attrFile
15722            ULONG    cbList               Length of EA's (0)
158} FILESTATUS2;
159*************************************************************/
160
161/* Use the l2_ #defines from DosFindFirst */
162
163/**********************************************************
164For DosQFSInfo/DosSetFSInfo - level 1
165
166typedef struct _FSALLOCATE {
167Byte offset   Type     name                description
168-------------+-------+-------------------+--------------
1690             ULONG    idFileSystem       id of file system
1704             ULONG    cSectorUnit        number of sectors per allocation unit
1718             ULONG    cUnit              number of allocation units
17212            ULONG    cUnitAvail         Available allocation units
17316            USHORT   cbSector           bytes per sector
174} FSALLOCATE;
175*************************************************************/
176
177#define l1_idFileSystem 0
178#define l1_cSectorUnit 4
179#define l1_cUnit 8
180#define l1_cUnitAvail 12
181#define l1_cbSector 16
182
183/**********************************************************
184For DosQFSInfo/DosSetFSInfo - level 2
185
186typedef struct _FSINFO {
187Byte offset   Type     name                description
188-------------+-------+-------------------+--------------
1890             FDATE   vol_fdateCreation
1902             FTIME   vol_ftimeCreation
1914             UCHAR   vol_cch             length of volume name (excluding NULL)
1925             UCHAR   vol_szVolLabel[12]  volume name
193} FSINFO;
194*************************************************************/
195
196#define SMB_INFO_STANDARD               1  /* FILESTATUS3 struct */
197#define SMB_INFO_SET_EA                 2  /* EAOP2 struct, only valid on set not query */
198#define SMB_INFO_QUERY_EA_SIZE          2  /* FILESTATUS4 struct, only valid on query not set */
199#define SMB_INFO_QUERY_EAS_FROM_LIST    3  /* only valid on query not set */
200#define SMB_INFO_QUERY_ALL_EAS          4  /* only valid on query not set */
201#define SMB_INFO_IS_NAME_VALID          6
202#define SMB_INFO_STANDARD_LONG          11  /* similar to level 1, ie struct FileStatus3 */
203#define SMB_QUERY_EA_SIZE_LONG          12  /* similar to level 2, ie struct FileStatus4 */
204#define SMB_QUERY_FS_LABEL_INFO         0x101
205#define SMB_QUERY_FS_VOLUME_INFO        0x102
206#define SMB_QUERY_FS_SIZE_INFO          0x103
207#define SMB_QUERY_FS_DEVICE_INFO        0x104
208#define SMB_QUERY_FS_ATTRIBUTE_INFO     0x105
209#if 0
210#define SMB_QUERY_FS_QUOTA_INFO
211#endif
212
213#define l2_vol_fdateCreation 0
214#define l2_vol_cch 4
215#define l2_vol_szVolLabel 5
216
217
218#define SMB_QUERY_FILE_BASIC_INFO	0x101
219#define SMB_QUERY_FILE_STANDARD_INFO	0x102
220#define SMB_QUERY_FILE_EA_INFO		0x103
221#define SMB_QUERY_FILE_NAME_INFO	0x104
222#define SMB_QUERY_FILE_ALLOCATION_INFO	0x105
223#define SMB_QUERY_FILE_END_OF_FILEINFO	0x106
224#define SMB_QUERY_FILE_ALL_INFO		0x107
225#define SMB_QUERY_FILE_ALT_NAME_INFO	0x108
226#define SMB_QUERY_FILE_STREAM_INFO	0x109
227#define SMB_QUERY_COMPRESSION_INFO	0x10b
228
229#define SMB_FIND_FILE_DIRECTORY_INFO		0x101
230#define SMB_FIND_FILE_FULL_DIRECTORY_INFO	0x102
231#define SMB_FIND_FILE_NAMES_INFO		0x103
232#define SMB_FIND_FILE_BOTH_DIRECTORY_INFO	0x104
233#define SMB_FIND_ID_FULL_DIRECTORY_INFO		0x105
234#define SMB_FIND_ID_BOTH_DIRECTORY_INFO		0x106
235
236#define SMB_SET_FILE_BASIC_INFO		0x101
237#define SMB_SET_FILE_DISPOSITION_INFO	0x102
238#define SMB_SET_FILE_ALLOCATION_INFO	0x103
239#define SMB_SET_FILE_END_OF_FILE_INFO	0x104
240
241/* Query FS info. */
242#define SMB_INFO_ALLOCATION		1
243#define SMB_INFO_VOLUME			2
244
245/*
246 * Thursby MAC extensions....
247 */
248
249/*
250 * MAC CIFS Extensions have the range 0x300 - 0x2FF reserved.
251 * Supposedly Microsoft have agreed to this.
252 */
253
254#define MIN_MAC_INFO_LEVEL 0x300
255#define MAX_MAC_INFO_LEVEL 0x3FF
256
257#define SMB_MAC_QUERY_FS_INFO           0x301
258
259#define DIRLEN_GUESS (45+MAX(l1_achName,l2_achName))
260
261/*
262 * DeviceType and Characteristics returned in a
263 * SMB_QUERY_FS_DEVICE_INFO call.
264 */
265
266#define DEVICETYPE_CD_ROM		0x2
267#define DEVICETYPE_CD_ROM_FILE_SYSTEM	0x3
268#define DEVICETYPE_DISK			0x7
269#define DEVICETYPE_DISK_FILE_SYSTEM	0x8
270#define DEVICETYPE_FILE_SYSTEM		0x9
271
272/* Characteristics. */
273#define TYPE_REMOVABLE_MEDIA		0x1
274#define TYPE_READ_ONLY_DEVICE		0x2
275#define TYPE_FLOPPY			0x4
276#define TYPE_WORM			0x8
277#define TYPE_REMOTE			0x10
278#define TYPE_MOUNTED			0x20
279#define TYPE_VIRTUAL			0x40
280
281/* NT passthrough levels... */
282
283#define SMB_FILE_DIRECTORY_INFORMATION			1001
284#define SMB_FILE_FULL_DIRECTORY_INFORMATION		1002
285#define SMB_FILE_BOTH_DIRECTORY_INFORMATION		1003
286#define SMB_FILE_BASIC_INFORMATION			1004
287#define SMB_FILE_STANDARD_INFORMATION			1005
288#define SMB_FILE_INTERNAL_INFORMATION			1006
289#define SMB_FILE_EA_INFORMATION				1007
290#define SMB_FILE_ACCESS_INFORMATION			1008
291#define SMB_FILE_NAME_INFORMATION			1009
292#define SMB_FILE_RENAME_INFORMATION			1010
293#define SMB_FILE_LINK_INFORMATION			1011
294#define SMB_FILE_NAMES_INFORMATION			1012
295#define SMB_FILE_DISPOSITION_INFORMATION		1013
296#define SMB_FILE_POSITION_INFORMATION			1014
297#define SMB_FILE_FULL_EA_INFORMATION			1015
298#define SMB_FILE_MODE_INFORMATION			1016
299#define SMB_FILE_ALIGNMENT_INFORMATION			1017
300#define SMB_FILE_ALL_INFORMATION			1018
301#define SMB_FILE_ALLOCATION_INFORMATION			1019
302#define SMB_FILE_END_OF_FILE_INFORMATION		1020
303#define SMB_FILE_ALTERNATE_NAME_INFORMATION		1021
304#define SMB_FILE_STREAM_INFORMATION			1022
305#define SMB_FILE_PIPE_INFORMATION			1023
306#define SMB_FILE_PIPE_LOCAL_INFORMATION			1024
307#define SMB_FILE_PIPE_REMOTE_INFORMATION		1025
308#define SMB_FILE_MAILSLOT_QUERY_INFORMATION		1026
309#define SMB_FILE_MAILSLOT_SET_INFORMATION		1027
310#define SMB_FILE_COMPRESSION_INFORMATION		1028
311#define SMB_FILE_OBJECTID_INFORMATION			1029
312#define SMB_FILE_COMPLETION_INFORMATION			1030
313#define SMB_FILE_MOVE_CLUSTER_INFORMATION		1031
314#define SMB_FILE_QUOTA_INFORMATION			1032
315#define SMB_FILE_REPARSEPOINT_INFORMATION		1033
316#define SMB_FILE_NETWORK_OPEN_INFORMATION		1034
317#define SMB_FILE_ATTRIBUTE_TAG_INFORMATION		1035
318#define SMB_FILE_TRACKING_INFORMATION			1036
319#define SMB_FILE_MAXIMUM_INFORMATION			1037
320
321/* NT passthough levels for qfsinfo. */
322
323#define SMB_FS_VOLUME_INFORMATION			1001
324#define SMB_FS_LABEL_INFORMATION			1002
325#define SMB_FS_SIZE_INFORMATION				1003
326#define SMB_FS_DEVICE_INFORMATION			1004
327#define SMB_FS_ATTRIBUTE_INFORMATION			1005
328#define SMB_FS_QUOTA_INFORMATION			1006
329#define SMB_FS_FULL_SIZE_INFORMATION			1007
330#define SMB_FS_OBJECTID_INFORMATION			1008
331
332/* flags on trans2 findfirst/findnext that control search */
333#define FLAG_TRANS2_FIND_CLOSE          0x1
334#define FLAG_TRANS2_FIND_CLOSE_IF_END   0x2
335#define FLAG_TRANS2_FIND_REQUIRE_RESUME 0x4
336#define FLAG_TRANS2_FIND_CONTINUE       0x8
337#define FLAG_TRANS2_FIND_BACKUP_INTENT  0x10
338
339/* UNIX CIFS Extensions - created by HP */
340/*
341 * UNIX CIFS Extensions have the range 0x200 - 0x2FF reserved.
342 * Supposedly Microsoft have agreed to this.
343 */
344
345#define MIN_UNIX_INFO_LEVEL 0x200
346#define MAX_UNIX_INFO_LEVEL 0x2FF
347
348#define INFO_LEVEL_IS_UNIX(level) (((level) >= MIN_UNIX_INFO_LEVEL) && ((level) <= MAX_UNIX_INFO_LEVEL))
349
350#define SMB_QUERY_FILE_UNIX_BASIC      0x200   /* UNIX File Info*/
351#define SMB_SET_FILE_UNIX_BASIC        0x200
352
353#define SMB_MODE_NO_CHANGE                 0xFFFFFFFF     /* file mode value which */
354                                              /* means "don't change it" */
355#define SMB_UID_NO_CHANGE                  0xFFFFFFFF
356#define SMB_GID_NO_CHANGE                  0xFFFFFFFF
357
358#define SMB_SIZE_NO_CHANGE_LO              0xFFFFFFFF
359#define SMB_SIZE_NO_CHANGE_HI              0xFFFFFFFF
360
361#define SMB_TIME_NO_CHANGE_LO              0xFFFFFFFF
362#define SMB_TIME_NO_CHANGE_HI              0xFFFFFFFF
363
364/*
365Offset Size         Name
3660      LARGE_INTEGER EndOfFile                File size
3678      LARGE_INTEGER Blocks                   Number of bytes used on disk (st_blocks).
36816     LARGE_INTEGER CreationTime             Creation time
36924     LARGE_INTEGER LastAccessTime           Last access time
37032     LARGE_INTEGER LastModificationTime     Last modification time
37140     LARGE_INTEGER Uid                      Numeric user id for the owner
37248     LARGE_INTEGER Gid                      Numeric group id of owner
37356     ULONG Type                             Enumeration specifying the pathname type:
374                                              0 -- File
375                                              1 -- Directory
376                                              2 -- Symbolic link
377                                              3 -- Character device
378                                              4 -- Block device
379                                              5 -- FIFO (named pipe)
380                                              6 -- Unix domain socket
381
38260     LARGE_INTEGER devmajor                 Major device number if type is device
38368     LARGE_INTEGER devminor                 Minor device number if type is device
38476     LARGE_INTEGER uniqueid                 This is a server-assigned unique id for the file. The client
385                                              will typically map this onto an inode number. The scope of
386                                              uniqueness is the share.
38784     LARGE_INTEGER permissions              Standard UNIX file permissions  - see below.
38892     LARGE_INTEGER nlinks                   The number of directory entries that map to this entry
389                                              (number of hard links)
390
391100 - end.
392*/
393
394/* UNIX filetype mappings. */
395
396#define UNIX_TYPE_FILE 0
397#define UNIX_TYPE_DIR 1
398#define UNIX_TYPE_SYMLINK 2
399#define UNIX_TYPE_CHARDEV 3
400#define UNIX_TYPE_BLKDEV 4
401#define UNIX_TYPE_FIFO 5
402#define UNIX_TYPE_SOCKET 6
403#define UNIX_TYPE_UNKNOWN 0xFFFFFFFF
404
405/*
406 * Oh this is fun. "Standard UNIX permissions" has no
407 * meaning in POSIX. We need to define the mapping onto
408 * and off the wire as this was not done in the original HP
409 * spec. JRA.
410 */
411
412#define UNIX_X_OTH			0000001
413#define UNIX_W_OTH			0000002
414#define UNIX_R_OTH			0000004
415#define UNIX_X_GRP			0000010
416#define UNIX_W_GRP                      0000020
417#define UNIX_R_GRP                      0000040
418#define UNIX_X_USR                      0000100
419#define UNIX_W_USR                      0000200
420#define UNIX_R_USR                      0000400
421#define UNIX_STICKY                     0001000
422#define UNIX_SET_GID                    0002000
423#define UNIX_SET_UID                    0004000
424
425/* Masks for the above */
426#define UNIX_OTH_MASK                   0000007
427#define UNIX_GRP_MASK                   0000070
428#define UNIX_USR_MASK                   0000700
429#define UNIX_PERM_MASK                  0000777
430#define UNIX_EXTRA_MASK                 0007000
431#define UNIX_ALL_MASK                   0007777
432
433#define SMB_QUERY_FILE_UNIX_LINK       0x201
434#define SMB_SET_FILE_UNIX_LINK         0x201
435#define SMB_SET_FILE_UNIX_HLINK        0x203
436/* SMB_QUERY_POSIX_ACL 0x204 see below */
437#define SMB_QUERY_XATTR                0x205 /* need for non-user XATTRs */
438#define SMB_QUERY_ATTR_FLAGS           0x206 /* chflags, chattr */
439#define SMB_SET_ATTR_FLAGS             0x206
440
441/* Transact 2 Find First levels */
442#define SMB_FIND_FILE_UNIX             0x202
443
444/*
445 Info level for QVOLINFO - returns version of CIFS UNIX extensions, plus
446 64-bits worth of capability fun :-).
447*/
448
449#define SMB_QUERY_CIFS_UNIX_INFO      0x200
450
451/* Returns the following.
452
453  UINT16             major version number
454  UINT16             minor version number
455  LARGE_INTEGER      capability bitfield
456
457*/
458
459#define CIFS_UNIX_MAJOR_VERSION 1
460#define CIFS_UNIX_MINOR_VERSION 0
461
462#define CIFS_UNIX_FCNTL_LOCKS_CAP           0x1
463#define CIFS_UNIX_POSIX_ACLS_CAP            0x2
464
465#define SMB_QUERY_POSIX_FS_INFO     0x201
466
467/* Returns FILE_SYSTEM_POSIX_INFO struct as follows
468      (NB   For undefined values return -1 in that field)
469   le32 OptimalTransferSize;    bsize on some os, iosize on other os, This
470				is a hint to the client about best size. Server
471				can return -1 if no preference, ie if SMB
472				negotiated size is adequate for optimal
473				read/write performance
474   le32 BlockSize; (often 512 bytes) NB: BlockSize * TotalBlocks = disk space
475   le64 TotalBlocks;  redundant with other infolevels but easy to ret here
476   le64 BlocksAvail;  although redundant, easy to return
477   le64 UserBlocksAvail;      bavail
478   le64 TotalFileNodes;
479   le64 FreeFileNodes;
480   le64 FileSysIdentifier;    fsid
481   (NB statfs field Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call)
482   (NB statfs field flags can come from FILE_SYSTEM_DEVICE_INFO call)
483*/
484
485/* ... more as we think of them :-). */
486
487/* SMB POSIX ACL definitions. */
488/* Wire format is (all little endian) :
489
490[2 bytes]              -     Version number.
491[2 bytes]              -     Number of ACE entries to follow.
492[2 bytes]              -     Number of default ACE entries to follow.
493-------------------------------------
494^
495|
496ACE entries
497|
498v
499-------------------------------------
500^
501|
502Default ACE entries
503|
504v
505-------------------------------------
506
507Where an ACE entry looks like :
508
509[1 byte]           - Entry type.
510
511Entry types are :
512
513ACL_USER_OBJ            0x01
514ACL_USER                0x02
515ACL_GROUP_OBJ           0x04
516ACL_GROUP               0x08
517ACL_MASK                0x10
518ACL_OTHER               0x20
519
520[1 byte]          - permissions (perm_t)
521
522perm_t types are :
523
524ACL_READ                0x04
525ACL_WRITE               0x02
526ACL_EXECUTE             0x01
527
528[8 bytes]         - uid/gid to apply this permission to.
529
530In the same format as the uid/gid fields in the other
531UNIX extensions definitions. Use 0xFFFFFFFFFFFFFFFF for
532the MASK and OTHER entry types.
533
534If the Number of ACE entries for either file or default ACE's
535is set to 0xFFFF this means ignore this kind of ACE (and the
536number of entries sent will be zero.
537
538*/
539
540/* The query/set info levels for POSIX ACLs. */
541#define SMB_QUERY_POSIX_ACL  0x204
542#define SMB_SET_POSIX_ACL  0x204
543
544/* Current on the wire ACL version. */
545#define SMB_POSIX_ACL_VERSION 1
546
547/* ACE entry type. */
548#define SMB_POSIX_ACL_USER_OBJ            0x01
549#define SMB_POSIX_ACL_USER                0x02
550#define SMB_POSIX_ACL_GROUP_OBJ           0x04
551#define SMB_POSIX_ACL_GROUP               0x08
552#define SMB_POSIX_ACL_MASK                0x10
553#define SMB_POSIX_ACL_OTHER               0x20
554
555/* perm_t types. */
556#define SMB_POSIX_ACL_READ                0x04
557#define SMB_POSIX_ACL_WRITE               0x02
558#define SMB_POSIX_ACL_EXECUTE             0x01
559
560#define SMB_POSIX_ACL_HEADER_SIZE         6
561#define SMB_POSIX_ACL_ENTRY_SIZE         10
562
563#define SMB_POSIX_IGNORE_ACE_ENTRIES	0xFFFF
564#endif
565