?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
doc-xml/smbdotconf: fix server [min|max] protocol documentation
[Samba/gebeck_regimport.git] / source3 / include / trans2.h
blob7a8c411396fdaf9a4b1433e150eee6823da4c4fb
1 /*
2 Unix SMB/CIFS implementation.
3 SMB transaction2 handling
4
5 Copyright (C) James Peach 2007
6 Copyright (C) Jeremy Allison 1994-2002.
7
8 Extensively modified by Andrew Tridgell, 1995
9
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 */
23
24 #ifndef _TRANS2_H_
25 #define _TRANS2_H_
26
27 /* Define the structures needed for the trans2 calls. */
28
29 /*******************************************************
30 For DosFindFirst/DosFindNext - level 1
31
32 MAXFILENAMELEN = 255;
33 FDATE == uint16
34 FTIME == uint16
35 ULONG == uint32
36 USHORT == uint16
37
38 typedef struct _FILEFINDBUF {
39 Byte offset Type name description
40 -------------+-------+-------------------+--------------
41 0 FDATE fdateCreation;
42 2 FTIME ftimeCreation;
43 4 FDATE fdateLastAccess;
44 6 FTIME ftimeLastAccess;
45 8 FDATE fdateLastWrite;
46 10 FTIME ftimeLastWrite;
47 12 ULONG cbFile file length in bytes
48 16 ULONG cbFileAlloc size of file allocation unit
49 20 USHORT attrFile
50 22 UCHAR cchName length of name to follow (not including zero)
51 23 UCHAR achName[MAXFILENAMELEN]; Null terminated name
52 } FILEFINDBUF;
53 *********************************************************/
54
55 #define l1_fdateCreation 0
56 #define l1_fdateLastAccess 4
57 #define l1_fdateLastWrite 8
58 #define l1_cbFile 12
59 #define l1_cbFileAlloc 16
60 #define l1_attrFile 20
61 #define l1_cchName 22
62 #define l1_achName 23
63
64 /**********************************************************
65 For DosFindFirst/DosFindNext - level 2
66
67 typedef struct _FILEFINDBUF2 {
68 Byte offset Type name description
69 -------------+-------+-------------------+--------------
70 0 FDATE fdateCreation;
71 2 FTIME ftimeCreation;
72 4 FDATE fdateLastAccess;
73 6 FTIME ftimeLastAccess;
74 8 FDATE fdateLastWrite;
75 10 FTIME ftimeLastWrite;
76 12 ULONG cbFile file length in bytes
77 16 ULONG cbFileAlloc size of file allocation unit
78 20 USHORT attrFile
79 22 ULONG cbList Extended attribute list (always 0)
80 26 UCHAR cchName length of name to follow (not including zero)
81 27 UCHAR achName[MAXFILENAMELEN]; Null terminated name
82 } FILEFINDBUF2;
83 *************************************************************/
84
85 #define l2_fdateCreation 0
86 #define l2_fdateLastAccess 4
87 #define l2_fdateLastWrite 8
88 #define l2_cbFile 12
89 #define l2_cbFileAlloc 16
90 #define l2_attrFile 20
91 #define l2_cbList 22
92 #define l2_cchName 26
93 #define l2_achName 27
94
95
96 /**********************************************************
97 For DosFindFirst/DosFindNext - level 260
98
99 typedef struct _FILEFINDBUF260 {
100 Byte offset Type name description
101 -------------+-------+-------------------+--------------
102 0 ULONG NextEntryOffset;
103 4 ULONG FileIndex;
104 8 LARGE_INTEGER CreationTime;
105 16 LARGE_INTEGER LastAccessTime;
106 24 LARGE_INTEGER LastWriteTime;
107 32 LARGE_INTEGER ChangeTime;
108 40 LARGE_INTEGER EndOfFile;
109 48 LARGE_INTEGER AllocationSize;
110 56 ULONG FileAttributes;
111 60 ULONG FileNameLength;
112 64 ULONG EaSize;
113 68 CHAR ShortNameLength;
114 70 UNICODE ShortName[12];
115 94 UNICODE FileName[];
116 *************************************************************/
117
118 #define l260_achName 94
119
120
121 /**********************************************************
122 For DosQueryPathInfo/DosQueryFileInfo/DosSetPathInfo/
123 DosSetFileInfo - level 1
124
125 typedef struct _FILESTATUS {
126 Byte offset Type name description
127 -------------+-------+-------------------+--------------
128 0 FDATE fdateCreation;
129 2 FTIME ftimeCreation;
130 4 FDATE fdateLastAccess;
131 6 FTIME ftimeLastAccess;
132 8 FDATE fdateLastWrite;
133 10 FTIME ftimeLastWrite;
134 12 ULONG cbFile file length in bytes
135 16 ULONG cbFileAlloc size of file allocation unit
136 20 USHORT attrFile
137 } FILESTATUS;
138 *************************************************************/
139
140 /* Use the l1_ defines from DosFindFirst */
141
142 /**********************************************************
143 For DosQueryPathInfo/DosQueryFileInfo/DosSetPathInfo/
144 DosSetFileInfo - level 2
145
146 typedef struct _FILESTATUS2 {
147 Byte offset Type name description
148 -------------+-------+-------------------+--------------
149 0 FDATE fdateCreation;
150 2 FTIME ftimeCreation;
151 4 FDATE fdateLastAccess;
152 6 FTIME ftimeLastAccess;
153 8 FDATE fdateLastWrite;
154 10 FTIME ftimeLastWrite;
155 12 ULONG cbFile file length in bytes
156 16 ULONG cbFileAlloc size of file allocation unit
157 20 USHORT attrFile
158 22 ULONG cbList Length of EA's (0)
159 } FILESTATUS2;
160 *************************************************************/
161
162 /* Use the l2_ #defines from DosFindFirst */
163
164 /**********************************************************
165 For DosQFSInfo/DosSetFSInfo - level 1
166
167 typedef struct _FSALLOCATE {
168 Byte offset Type name description
169 -------------+-------+-------------------+--------------
170 0 ULONG idFileSystem id of file system
171 4 ULONG cSectorUnit number of sectors per allocation unit
172 8 ULONG cUnit number of allocation units
173 12 ULONG cUnitAvail Available allocation units
174 16 USHORT cbSector bytes per sector
175 } FSALLOCATE;
176 *************************************************************/
177
178 #define l1_idFileSystem 0
179 #define l1_cSectorUnit 4
180 #define l1_cUnit 8
181 #define l1_cUnitAvail 12
182 #define l1_cbSector 16
183
184 /**********************************************************
185 For DosQFSInfo/DosSetFSInfo - level 2
186
187 typedef struct _FSINFO {
188 Byte offset Type name description
189 -------------+-------+-------------------+--------------
190 0 FDATE vol_fdateCreation
191 2 FTIME vol_ftimeCreation
192 4 UCHAR vol_cch length of volume name (excluding NULL)
193 5 UCHAR vol_szVolLabel[12] volume name
194 } FSINFO;
195 *************************************************************/
196
197 #define SMB_INFO_STANDARD 1 /* FILESTATUS3 struct */
198 #define SMB_INFO_SET_EA 2 /* EAOP2 struct, only valid on set not query */
199 #define SMB_INFO_QUERY_EA_SIZE 2 /* FILESTATUS4 struct, only valid on query not set */
200 #define SMB_INFO_QUERY_EAS_FROM_LIST 3 /* only valid on query not set */
201 #define SMB_INFO_QUERY_ALL_EAS 4 /* only valid on query not set */
202 #define SMB_INFO_IS_NAME_VALID 6
203 #define SMB_INFO_STANDARD_LONG 11 /* similar to level 1, ie struct FileStatus3 */
204 #define SMB_QUERY_EA_SIZE_LONG 12 /* similar to level 2, ie struct FileStatus4 */
205 #define SMB_QUERY_FS_LABEL_INFO 0x101
206 #define SMB_QUERY_FS_VOLUME_INFO 0x102
207 #define SMB_QUERY_FS_SIZE_INFO 0x103
208 #define SMB_QUERY_FS_DEVICE_INFO 0x104
209 #define SMB_QUERY_FS_ATTRIBUTE_INFO 0x105
210 #if 0
211 #define SMB_QUERY_FS_QUOTA_INFO
212 #endif
213
214 #define l2_vol_fdateCreation 0
215 #define l2_vol_cch 4
216 #define l2_vol_szVolLabel 5
217
218
219 #define SMB_QUERY_FILE_BASIC_INFO 0x101
220 #define SMB_QUERY_FILE_STANDARD_INFO 0x102
221 #define SMB_QUERY_FILE_EA_INFO 0x103
222 #define SMB_QUERY_FILE_NAME_INFO 0x104
223 #define SMB_QUERY_FILE_ALLOCATION_INFO 0x105
224 #define SMB_QUERY_FILE_END_OF_FILEINFO 0x106
225 #define SMB_QUERY_FILE_ALL_INFO 0x107
226 #define SMB_QUERY_FILE_ALT_NAME_INFO 0x108
227 #define SMB_QUERY_FILE_STREAM_INFO 0x109
228 #define SMB_QUERY_COMPRESSION_INFO 0x10b
229
230 #define SMB_FIND_INFO_STANDARD 1
231 #define SMB_FIND_EA_SIZE 2
232 #define SMB_FIND_EA_LIST 3
233 #define SMB_FIND_FILE_DIRECTORY_INFO 0x101
234 #define SMB_FIND_FILE_FULL_DIRECTORY_INFO 0x102
235 #define SMB_FIND_FILE_NAMES_INFO 0x103
236 #define SMB_FIND_FILE_BOTH_DIRECTORY_INFO 0x104
237 #define SMB_FIND_ID_FULL_DIRECTORY_INFO 0x105
238 #define SMB_FIND_ID_BOTH_DIRECTORY_INFO 0x106
239
240 #define SMB_SET_FILE_BASIC_INFO 0x101
241 #define SMB_SET_FILE_DISPOSITION_INFO 0x102
242 #define SMB_SET_FILE_ALLOCATION_INFO 0x103
243 #define SMB_SET_FILE_END_OF_FILE_INFO 0x104
244
245 /* Query FS info. */
246 #define SMB_INFO_ALLOCATION 1
247 #define SMB_INFO_VOLUME 2
248
249 /*
250 * Thursby MAC extensions....
251 */
252
253 /*
254 * MAC CIFS Extensions have the range 0x300 - 0x2FF reserved.
255 * Supposedly Microsoft have agreed to this.
256 */
257
258 #define MIN_MAC_INFO_LEVEL 0x300
259 #define MAX_MAC_INFO_LEVEL 0x3FF
260
261 #define SMB_MAC_QUERY_FS_INFO 0x301
262
263 #define DIRLEN_GUESS (45+MAX(l1_achName,l2_achName))
264
265 /*
266 * DeviceType and Characteristics returned in a
267 * SMB_QUERY_FS_DEVICE_INFO call.
268 */
269
270 #define DEVICETYPE_CD_ROM 0x2
271 #define DEVICETYPE_CD_ROM_FILE_SYSTEM 0x3
272 #define DEVICETYPE_DISK 0x7
273 #define DEVICETYPE_DISK_FILE_SYSTEM 0x8
274 #define DEVICETYPE_FILE_SYSTEM 0x9
275
276 /* Characteristics. */
277 #define TYPE_REMOVABLE_MEDIA 0x1
278 #define TYPE_READ_ONLY_DEVICE 0x2
279 #define TYPE_FLOPPY 0x4
280 #define TYPE_WORM 0x8
281 #define TYPE_REMOTE 0x10
282 #define TYPE_MOUNTED 0x20
283 #define TYPE_VIRTUAL 0x40
284
285 /* NT passthrough levels... */
286
287 #define SMB_FILE_DIRECTORY_INFORMATION 1001
288 #define SMB_FILE_FULL_DIRECTORY_INFORMATION 1002
289 #define SMB_FILE_BOTH_DIRECTORY_INFORMATION 1003
290 #define SMB_FILE_BASIC_INFORMATION 1004
291 #define SMB_FILE_STANDARD_INFORMATION 1005
292 #define SMB_FILE_INTERNAL_INFORMATION 1006
293 #define SMB_FILE_EA_INFORMATION 1007
294 #define SMB_FILE_ACCESS_INFORMATION 1008
295 #define SMB_FILE_NAME_INFORMATION 1009
296 #define SMB_FILE_RENAME_INFORMATION 1010
297 #define SMB2_FILE_RENAME_INFORMATION_INTERNAL 0xFF0A /* Internal mapped version. */
298 #define SMB_FILE_LINK_INFORMATION 1011
299 #define SMB_FILE_NAMES_INFORMATION 1012
300 #define SMB_FILE_DISPOSITION_INFORMATION 1013
301 #define SMB_FILE_POSITION_INFORMATION 1014
302 #define SMB_FILE_FULL_EA_INFORMATION 1015
303 #define SMB_FILE_MODE_INFORMATION 1016
304 #define SMB_FILE_ALIGNMENT_INFORMATION 1017
305 #define SMB_FILE_ALL_INFORMATION 1018
306 #define SMB_FILE_ALLOCATION_INFORMATION 1019
307 #define SMB_FILE_END_OF_FILE_INFORMATION 1020
308 #define SMB_FILE_ALTERNATE_NAME_INFORMATION 1021
309 #define SMB_FILE_STREAM_INFORMATION 1022
310 #define SMB_FILE_PIPE_INFORMATION 1023
311 #define SMB_FILE_PIPE_LOCAL_INFORMATION 1024
312 #define SMB_FILE_PIPE_REMOTE_INFORMATION 1025
313 #define SMB_FILE_MAILSLOT_QUERY_INFORMATION 1026
314 #define SMB_FILE_MAILSLOT_SET_INFORMATION 1027
315 #define SMB_FILE_COMPRESSION_INFORMATION 1028
316 #define SMB_FILE_OBJECTID_INFORMATION 1029
317 #define SMB_FILE_COMPLETION_INFORMATION 1030
318 #define SMB_FILE_MOVE_CLUSTER_INFORMATION 1031
319 #define SMB_FILE_QUOTA_INFORMATION 1032
320 #define SMB_FILE_REPARSEPOINT_INFORMATION 1033
321 #define SMB_FILE_NETWORK_OPEN_INFORMATION 1034
322 #define SMB_FILE_ATTRIBUTE_TAG_INFORMATION 1035
323 #define SMB_FILE_TRACKING_INFORMATION 1036
324 #define SMB_FILE_MAXIMUM_INFORMATION 1037
325
326 /* NT passthough levels for qfsinfo. */
327
328 #define SMB_FS_VOLUME_INFORMATION 1001
329 #define SMB_FS_LABEL_INFORMATION 1002
330 #define SMB_FS_SIZE_INFORMATION 1003
331 #define SMB_FS_DEVICE_INFORMATION 1004
332 #define SMB_FS_ATTRIBUTE_INFORMATION 1005
333 #define SMB_FS_QUOTA_INFORMATION 1006
334 #define SMB_FS_FULL_SIZE_INFORMATION 1007
335 #define SMB_FS_OBJECTID_INFORMATION 1008
336
337 /* SMB_FS_DEVICE_INFORMATION device types. */
338 #define FILE_DEVICE_CD_ROM 0x2
339 #define FILE_DEVICE_DISK 0x7
340
341 /* SMB_FS_DEVICE_INFORMATION characteristics. */
342 #define FILE_REMOVABLE_MEDIA 0x001
343 #define FILE_READ_ONLY_DEVICE 0x002
344 #define FILE_FLOPPY_DISKETTE 0x004
345 #define FILE_WRITE_ONCE_MEDIA 0x008
346 #define FILE_REMOTE_DEVICE 0x010
347 #define FILE_DEVICE_IS_MOUNTED 0x020
348 #define FILE_VIRTUAL_VOLUME 0x040
349 #define FILE_DEVICE_SECURE_OPEN 0x100
350
351 /* flags on trans2 findfirst/findnext that control search */
352 #define FLAG_TRANS2_FIND_CLOSE 0x1
353 #define FLAG_TRANS2_FIND_CLOSE_IF_END 0x2
354 #define FLAG_TRANS2_FIND_REQUIRE_RESUME 0x4
355 #define FLAG_TRANS2_FIND_CONTINUE 0x8
356 #define FLAG_TRANS2_FIND_BACKUP_INTENT 0x10
357
358 #endif
reg import