| blob | 68358344f4e071a3184688b95b29590458cfd80c |
1 /*
2 Unix SMB/CIFS implementation.
3 SMB transaction2 handling
4 Copyright (C) Jeremy Allison 1994-2002.
6 Extensively modified by Andrew Tridgell, 1995
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.
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.
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 */
23 #ifndef _TRANS2_H_
24 #define _TRANS2_H_
26 /* Define the structures needed for the trans2 calls. */
28 /*******************************************************
29 For DosFindFirst/DosFindNext - level 1
31 MAXFILENAMELEN = 255;
32 FDATE == uint16
33 FTIME == uint16
34 ULONG == uint32
35 USHORT == uint16
37 typedef struct _FILEFINDBUF {
38 Byte offset Type name description
39 -------------+-------+-------------------+--------------
40 0 FDATE fdateCreation;
41 2 FTIME ftimeCreation;
42 4 FDATE fdateLastAccess;
43 6 FTIME ftimeLastAccess;
44 8 FDATE fdateLastWrite;
45 10 FTIME ftimeLastWrite;
46 12 ULONG cbFile file length in bytes
47 16 ULONG cbFileAlloc size of file allocation unit
48 20 USHORT attrFile
49 22 UCHAR cchName length of name to follow (not including zero)
50 23 UCHAR achName[MAXFILENAMELEN]; Null terminated name
51 } FILEFINDBUF;
52 *********************************************************/
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
63 /**********************************************************
64 For DosFindFirst/DosFindNext - level 2
66 typedef struct _FILEFINDBUF2 {
67 Byte offset Type name description
68 -------------+-------+-------------------+--------------
69 0 FDATE fdateCreation;
70 2 FTIME ftimeCreation;
71 4 FDATE fdateLastAccess;
72 6 FTIME ftimeLastAccess;
73 8 FDATE fdateLastWrite;
74 10 FTIME ftimeLastWrite;
75 12 ULONG cbFile file length in bytes
76 16 ULONG cbFileAlloc size of file allocation unit
77 20 USHORT attrFile
78 22 ULONG cbList Extended attribute list (always 0)
79 26 UCHAR cchName length of name to follow (not including zero)
80 27 UCHAR achName[MAXFILENAMELEN]; Null terminated name
81 } FILEFINDBUF2;
82 *************************************************************/
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
95 /**********************************************************
96 For DosFindFirst/DosFindNext - level 260
98 typedef struct _FILEFINDBUF260 {
99 Byte offset Type name description
100 -------------+-------+-------------------+--------------
101 0 ULONG NextEntryOffset;
102 4 ULONG FileIndex;
103 8 LARGE_INTEGER CreationTime;
104 16 LARGE_INTEGER LastAccessTime;
105 24 LARGE_INTEGER LastWriteTime;
106 32 LARGE_INTEGER ChangeTime;
107 40 LARGE_INTEGER EndOfFile;
108 48 LARGE_INTEGER AllocationSize;
109 56 ULONG FileAttributes;
110 60 ULONG FileNameLength;
111 64 ULONG EaSize;
112 68 CHAR ShortNameLength;
113 70 UNICODE ShortName[12];
114 94 UNICODE FileName[];
115 *************************************************************/
117 #define l260_achName 94
120 /**********************************************************
121 For DosQueryPathInfo/DosQueryFileInfo/DosSetPathInfo/
122 DosSetFileInfo - level 1
124 typedef struct _FILESTATUS {
125 Byte offset Type name description
126 -------------+-------+-------------------+--------------
127 0 FDATE fdateCreation;
128 2 FTIME ftimeCreation;
129 4 FDATE fdateLastAccess;
130 6 FTIME ftimeLastAccess;
131 8 FDATE fdateLastWrite;
132 10 FTIME ftimeLastWrite;
133 12 ULONG cbFile file length in bytes
134 16 ULONG cbFileAlloc size of file allocation unit
135 20 USHORT attrFile
136 } FILESTATUS;
137 *************************************************************/
139 /* Use the l1_ defines from DosFindFirst */
141 /**********************************************************
142 For DosQueryPathInfo/DosQueryFileInfo/DosSetPathInfo/
143 DosSetFileInfo - level 2
145 typedef struct _FILESTATUS2 {
146 Byte offset Type name description
147 -------------+-------+-------------------+--------------
148 0 FDATE fdateCreation;
149 2 FTIME ftimeCreation;
150 4 FDATE fdateLastAccess;
151 6 FTIME ftimeLastAccess;
152 8 FDATE fdateLastWrite;
153 10 FTIME ftimeLastWrite;
154 12 ULONG cbFile file length in bytes
155 16 ULONG cbFileAlloc size of file allocation unit
156 20 USHORT attrFile
157 22 ULONG cbList Length of EA's (0)
158 } FILESTATUS2;
159 *************************************************************/
161 /* Use the l2_ #defines from DosFindFirst */
163 /**********************************************************
164 For DosQFSInfo/DosSetFSInfo - level 1
166 typedef struct _FSALLOCATE {
167 Byte offset Type name description
168 -------------+-------+-------------------+--------------
169 0 ULONG idFileSystem id of file system
170 4 ULONG cSectorUnit number of sectors per allocation unit
171 8 ULONG cUnit number of allocation units
172 12 ULONG cUnitAvail Available allocation units
173 16 USHORT cbSector bytes per sector
174 } FSALLOCATE;
175 *************************************************************/
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
183 /**********************************************************
184 For DosQFSInfo/DosSetFSInfo - level 2
186 typedef struct _FSINFO {
187 Byte offset Type name description
188 -------------+-------+-------------------+--------------
189 0 FDATE vol_fdateCreation
190 2 FTIME vol_ftimeCreation
191 4 UCHAR vol_cch length of volume name (excluding NULL)
192 5 UCHAR vol_szVolLabel[12] volume name
193 } FSINFO;
194 *************************************************************/
201 #define SMB_INFO_IS_NAME_VALID 6
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
213 #define l2_vol_fdateCreation 0
214 #define l2_vol_cch 4
215 #define l2_vol_szVolLabel 5
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
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
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
241 /* Query FS info. */
242 #define SMB_INFO_ALLOCATION 1
243 #define SMB_INFO_VOLUME 2
245 /*
246 * Thursby MAC extensions....
247 */
249 /*
250 * MAC CIFS Extensions have the range 0x300 - 0x2FF reserved.
251 * Supposedly Microsoft have agreed to this.
252 */
254 #define MIN_MAC_INFO_LEVEL 0x300
255 #define MAX_MAC_INFO_LEVEL 0x3FF
257 #define SMB_MAC_QUERY_FS_INFO 0x301
259 #define DIRLEN_GUESS (45+MAX(l1_achName,l2_achName))
261 /*
262 * DeviceType and Characteristics returned in a
263 * SMB_QUERY_FS_DEVICE_INFO call.
264 */
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
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
281 /* NT passthrough levels... */
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
321 /* NT passthough levels for qfsinfo. */
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
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
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 */
345 #define MIN_UNIX_INFO_LEVEL 0x200
346 #define MAX_UNIX_INFO_LEVEL 0x2FF
348 #define INFO_LEVEL_IS_UNIX(level) (((level) >= MIN_UNIX_INFO_LEVEL) && ((level) <= MAX_UNIX_INFO_LEVEL))
351 #define SMB_SET_FILE_UNIX_BASIC 0x200
354 /* means "don't change it" */
355 #define SMB_UID_NO_CHANGE 0xFFFFFFFF
356 #define SMB_GID_NO_CHANGE 0xFFFFFFFF
358 #define SMB_SIZE_NO_CHANGE_LO 0xFFFFFFFF
359 #define SMB_SIZE_NO_CHANGE_HI 0xFFFFFFFF
361 #define SMB_TIME_NO_CHANGE_LO 0xFFFFFFFF
362 #define SMB_TIME_NO_CHANGE_HI 0xFFFFFFFF
364 /*
365 Offset Size Name
366 0 LARGE_INTEGER EndOfFile File size
367 8 LARGE_INTEGER Blocks Number of bytes used on disk (st_blocks).
368 16 LARGE_INTEGER CreationTime Creation time
369 24 LARGE_INTEGER LastAccessTime Last access time
370 32 LARGE_INTEGER LastModificationTime Last modification time
371 40 LARGE_INTEGER Uid Numeric user id for the owner
372 48 LARGE_INTEGER Gid Numeric group id of owner
373 56 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
382 60 LARGE_INTEGER devmajor Major device number if type is device
383 68 LARGE_INTEGER devminor Minor device number if type is device
384 76 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.
387 84 LARGE_INTEGER permissions Standard UNIX file permissions - see below.
388 92 LARGE_INTEGER nlinks The number of directory entries that map to this entry
389 (number of hard links)
391 100 - end.
392 */
394 /* UNIX filetype mappings. */
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
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 */
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
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
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 */
439 #define SMB_SET_ATTR_FLAGS 0x206
441 /* Transact 2 Find First levels */
442 #define SMB_FIND_FILE_UNIX 0x202
444 /*
445 Info level for QVOLINFO - returns version of CIFS UNIX extensions, plus
446 64-bits worth of capability fun :-).
447 */
449 #define SMB_QUERY_CIFS_UNIX_INFO 0x200
451 /* Returns the following.
453 UINT16 major version number
454 UINT16 minor version number
455 LARGE_INTEGER capability bitfield
457 */
459 #define CIFS_UNIX_MAJOR_VERSION 1
460 #define CIFS_UNIX_MINOR_VERSION 0
462 #define CIFS_UNIX_FCNTL_LOCKS_CAP 0x1
463 #define CIFS_UNIX_POSIX_ACLS_CAP 0x2
465 #define SMB_QUERY_POSIX_FS_INFO 0x201
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 */
485 /* ... more as we think of them :-). */
487 /* SMB POSIX ACL definitions. */
488 /* Wire format is (all little endian) :
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 |
496 ACE entries
497 |
498 v
499 -------------------------------------
500 ^
501 |
502 Default ACE entries
503 |
504 v
505 -------------------------------------
507 Where an ACE entry looks like :
509 [1 byte] - Entry type.
511 Entry types are :
513 ACL_USER_OBJ 0x01
514 ACL_USER 0x02
515 ACL_GROUP_OBJ 0x04
516 ACL_GROUP 0x08
517 ACL_MASK 0x10
518 ACL_OTHER 0x20
520 [1 byte] - permissions (perm_t)
522 perm_t types are :
524 ACL_READ 0x04
525 ACL_WRITE 0x02
526 ACL_EXECUTE 0x01
528 [8 bytes] - uid/gid to apply this permission to.
530 In the same format as the uid/gid fields in the other
531 UNIX extensions definitions. Use 0xFFFFFFFFFFFFFFFF for
532 the MASK and OTHER entry types.
534 If the Number of ACE entries for either file or default ACE's
535 is set to 0xFFFF this means ignore this kind of ACE (and the
536 number of entries sent will be zero.
538 */
540 /* The query/set info levels for POSIX ACLs. */
541 #define SMB_QUERY_POSIX_ACL 0x204
542 #define SMB_SET_POSIX_ACL 0x204
544 /* Current on the wire ACL version. */
545 #define SMB_POSIX_ACL_VERSION 1
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
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
560 #define SMB_POSIX_ACL_HEADER_SIZE 6
561 #define SMB_POSIX_ACL_ENTRY_SIZE 10
563 #define SMB_POSIX_IGNORE_ACE_ENTRIES 0xFFFF
564 #endif