proc->thread stage 2: MAJOR revamping of system calls, ucred, jail API,
[dragonfly.git] / sys / netproto / smb / smb.h
1 /*
2  * Copyright (c) 2000-2001 Boris Popov
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *    This product includes software developed by Boris Popov.
16  * 4. Neither the name of the author nor the names of any co-contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  * $FreeBSD: src/sys/netsmb/smb.h,v 1.1.2.3 2002/04/23 03:45:01 bp Exp $
33  * $DragonFly: src/sys/netproto/smb/smb.h,v 1.2 2003/06/17 04:28:54 dillon Exp $
34  */
35
36 /*
37  * Common definintions and structures for SMB/CIFS protocol
38  */
39  
40 #ifndef _NETSMB_SMB_H_
41 #define _NETSMB_SMB_H_
42
43 #define SMB_TCP_PORT    139
44 /*
45  * SMB dialects that we have to deal with.
46  */
47 enum smb_dialects { 
48         SMB_DIALECT_NONE,
49         SMB_DIALECT_CORE,               /* PC NETWORK PROGRAM 1.0, PCLAN1.0 */
50         SMB_DIALECT_COREPLUS,           /* MICROSOFT NETWORKS 1.03 */
51         SMB_DIALECT_LANMAN1_0,          /* MICROSOFT NETWORKS 3.0, LANMAN1.0 */
52         SMB_DIALECT_LANMAN2_0,          /* LM1.2X002, DOS LM1.2X002, Samba */
53         SMB_DIALECT_LANMAN2_1,          /* DOS LANMAN2.1, LANMAN2.1 */
54         SMB_DIALECT_NTLM0_12            /* NT LM 0.12, Windows for Workgroups 3.1a,
55                                          * NT LANMAN 1.0 */
56 };
57
58 /*
59  * Formats of data/string buffers
60  */
61 #define SMB_DT_DATA             1
62 #define SMB_DT_DIALECT          2
63 #define SMB_DT_PATHNAME         3
64 #define SMB_DT_ASCII            4
65 #define SMB_DT_VARIABLE         5
66
67 /*
68  * SMB header
69  */
70 #define SMB_SIGNATURE           "\xFFSMB"
71 #define SMB_SIGLEN              4
72 #define SMB_HDRMID(p)           (*(u_short*)((u_char*)(p) + 30))
73 #define SMB_HDRLEN              32
74 /*
75  * bits in the smb_flags field
76  */
77 #define SMB_FLAGS_CASELESS      0x08
78 #define SMB_FLAGS_SERVER_RESP   0x80    /* indicates a response */
79
80 /*
81  * bits in the smb_flags2 field
82  */
83 #define SMB_FLAGS2_KNOWS_LONG_NAMES     0x0001
84 #define SMB_FLAGS2_KNOWS_EAS            0x0002  /* client know about EAs */
85 #define SMB_FLAGS2_SECURITY_SIGNATURE   0x0004  /* check SMB integrity */
86 #define SMB_FLAGS2_IS_LONG_NAME         0x0040  /* any path name is a long name */
87 #define SMB_FLAGS2_EXT_SEC              0x0800  /* client aware of Extended
88                                                  * Security negotiation */
89 #define SMB_FLAGS2_DFS                  0x1000  /* resolve paths in DFS */
90 #define SMB_FLAGS2_PAGING_IO            0x2000  /* for exec */
91 #define SMB_FLAGS2_ERR_STATUS           0x4000  /* 1 - status.status */
92 #define SMB_FLAGS2_UNICODE              0x8000  /* use Unicode for all strings */
93
94 #define SMB_UID_UNKNOWN         0xffff
95 #define SMB_TID_UNKNOWN         0xffff
96
97 /*
98  * Security mode bits
99  */
100 #define SMB_SM_USER             0x01            /* server in the user security mode */
101 #define SMB_SM_ENCRYPT          0x02            /* use challenge/response */
102
103 /*
104  * NTLM capabilities
105  */
106 #define SMB_CAP_RAW_MODE        0x0001
107 #define SMB_CAP_MPX_MODE        0x0002
108 #define SMB_CAP_UNICODE         0x0004
109 #define SMB_CAP_LARGE_FILES     0x0008          /* 64 bit offsets supported */
110 #define SMB_CAP_NT_SMBS         0x0010
111 #define SMB_CAP_NT_FIND         0x0200
112 #define SMB_CAP_EXT_SECURITY    0x80000000
113
114 /*
115  * File attributes
116  */
117 #define SMB_FA_RDONLY           0x01
118 #define SMB_FA_HIDDEN           0x02
119 #define SMB_FA_SYSTEM           0x04
120 #define SMB_FA_VOLUME           0x08
121 #define SMB_FA_DIR              0x10
122 #define SMB_FA_ARCHIVE          0x20
123
124 /*
125  * Extended file attributes
126  */
127 #define SMB_EFA_RDONLY          0x0001
128 #define SMB_EFA_HIDDEN          0x0002
129 #define SMB_EFA_SYSTEM          0x0004
130 #define SMB_EFA_ARCHIVE         0x0020
131 #define SMB_EFA_NORMAL          0x0080
132 #define SMB_EFA_TEMPORARY       0x0100
133 #define SMB_EFA_COMPRESSED      0x0800
134 #define SMB_EFA_POSIX_SEMANTICS 0x00100000
135 #define SMB_EFA_BACKUP_SEMANTICS 0x02000000
136 #define SMB_EFA_DELETE_ON_CLOSE 0x04000000
137 #define SMB_EFA_SEQUENTIAL_SCAN 0x08000000
138 #define SMB_EFA_RANDOM_ACCESS   0x10000000
139 #define SMB_EFA_NO_BUFFERING    0x20000000
140 #define SMB_EFA_WRITE_THROUGH   0x80000000
141
142 /*
143  * Access Mode Encoding
144  */
145 #define SMB_AM_OPENREAD         0x0000
146 #define SMB_AM_OPENWRITE        0x0001
147 #define SMB_AM_OPENRW           0x0002
148 #define SMB_AM_OPENEXEC         0x0003
149 #define SMB_SM_COMPAT           0x0000
150 #define SMB_SM_EXCLUSIVE        0x0010
151 #define SMB_SM_DENYWRITE        0x0020
152 #define SMB_SM_DENYREADEXEC     0x0030
153 #define SMB_SM_DENYNONE         0x0040
154
155 /*
156  * SMB commands
157  */
158 #define SMB_COM_CREATE_DIRECTORY        0x00
159 #define SMB_COM_DELETE_DIRECTORY        0x01
160 #define SMB_COM_OPEN                    0x02
161 #define SMB_COM_CREATE                  0x03
162 #define SMB_COM_CLOSE                   0x04
163 #define SMB_COM_FLUSH                   0x05
164 #define SMB_COM_DELETE                  0x06
165 #define SMB_COM_RENAME                  0x07
166 #define SMB_COM_QUERY_INFORMATION       0x08
167 #define SMB_COM_SET_INFORMATION         0x09
168 #define SMB_COM_READ                    0x0A
169 #define SMB_COM_WRITE                   0x0B
170 #define SMB_COM_LOCK_BYTE_RANGE         0x0C
171 #define SMB_COM_UNLOCK_BYTE_RANGE       0x0D
172 #define SMB_COM_CREATE_TEMPORARY        0x0E
173 #define SMB_COM_CREATE_NEW              0x0F
174 #define SMB_COM_CHECK_DIRECTORY         0x10
175 #define SMB_COM_PROCESS_EXIT            0x11
176 #define SMB_COM_SEEK                    0x12
177 #define SMB_COM_LOCK_AND_READ           0x13
178 #define SMB_COM_WRITE_AND_UNLOCK        0x14
179 #define SMB_COM_READ_RAW                0x1A
180 #define SMB_COM_READ_MPX                0x1B
181 #define SMB_COM_READ_MPX_SECONDARY      0x1C
182 #define SMB_COM_WRITE_RAW               0x1D
183 #define SMB_COM_WRITE_MPX               0x1E
184 #define SMB_COM_WRITE_COMPLETE          0x20
185 #define SMB_COM_SET_INFORMATION2        0x22
186 #define SMB_COM_QUERY_INFORMATION2      0x23
187 #define SMB_COM_LOCKING_ANDX            0x24
188 #define SMB_COM_TRANSACTION             0x25
189 #define SMB_COM_TRANSACTION_SECONDARY   0x26
190 #define SMB_COM_IOCTL                   0x27
191 #define SMB_COM_IOCTL_SECONDARY         0x28
192 #define SMB_COM_COPY                    0x29
193 #define SMB_COM_MOVE                    0x2A
194 #define SMB_COM_ECHO                    0x2B
195 #define SMB_COM_WRITE_AND_CLOSE         0x2C
196 #define SMB_COM_OPEN_ANDX               0x2D
197 #define SMB_COM_READ_ANDX               0x2E
198 #define SMB_COM_WRITE_ANDX              0x2F
199 #define SMB_COM_CLOSE_AND_TREE_DISC     0x31
200 #define SMB_COM_TRANSACTION2            0x32
201 #define SMB_COM_TRANSACTION2_SECONDARY  0x33
202 #define SMB_COM_FIND_CLOSE2             0x34
203 #define SMB_COM_FIND_NOTIFY_CLOSE       0x35
204 #define SMB_COM_TREE_CONNECT            0x70
205 #define SMB_COM_TREE_DISCONNECT         0x71
206 #define SMB_COM_NEGOTIATE               0x72
207 #define SMB_COM_SESSION_SETUP_ANDX      0x73
208 #define SMB_COM_LOGOFF_ANDX             0x74
209 #define SMB_COM_TREE_CONNECT_ANDX       0x75
210 #define SMB_COM_QUERY_INFORMATION_DISK  0x80
211 #define SMB_COM_SEARCH                  0x81
212 #define SMB_COM_FIND                    0x82
213 #define SMB_COM_FIND_UNIQUE             0x83
214 #define SMB_COM_NT_TRANSACT             0xA0
215 #define SMB_COM_NT_TRANSACT_SECONDARY   0xA1
216 #define SMB_COM_NT_CREATE_ANDX          0xA2
217 #define SMB_COM_NT_CANCEL               0xA4
218 #define SMB_COM_OPEN_PRINT_FILE         0xC0
219 #define SMB_COM_WRITE_PRINT_FILE        0xC1
220 #define SMB_COM_CLOSE_PRINT_FILE        0xC2
221 #define SMB_COM_GET_PRINT_QUEUE         0xC3
222 #define SMB_COM_READ_BULK               0xD8
223 #define SMB_COM_WRITE_BULK              0xD9
224 #define SMB_COM_WRITE_BULK_DATA         0xDA
225
226 /*
227  * TRANS2 commands
228  */
229 #define SMB_TRANS2_OPEN2                        0x00
230 #define SMB_TRANS2_FIND_FIRST2                  0x01
231 #define SMB_TRANS2_FIND_NEXT2                   0x02
232 #define SMB_TRANS2_QUERY_FS_INFORMATION         0x03
233 #define SMB_TRANS2_QUERY_PATH_INFORMATION       0x05
234 #define SMB_TRANS2_SET_PATH_INFORMATION         0x06
235 #define SMB_TRANS2_QUERY_FILE_INFORMATION       0x07
236 #define SMB_TRANS2_SET_FILE_INFORMATION         0x08
237 #define SMB_TRANS2_FSCTL                        0x09
238 #define SMB_TRANS2_IOCTL2                       0x0A
239 #define SMB_TRANS2_FIND_NOTIFY_FIRST            0x0B
240 #define SMB_TRANS2_FIND_NOTIFY_NEXT             0x0C
241 #define SMB_TRANS2_CREATE_DIRECTORY             0x0D
242 #define SMB_TRANS2_SESSION_SETUP                0x0E
243 #define SMB_TRANS2_GET_DFS_REFERRAL             0x10
244 #define SMB_TRANS2_REPORT_DFS_INCONSISTENCY     0x11
245
246 /*
247  * SMB_TRANS2_QUERY_FS_INFORMATION levels
248  */
249 #define SMB_INFO_ALLOCATION             1
250 #define SMB_INFO_VOLUME                 2
251 #define SMB_QUERY_FS_VOLUME_INFO        0x102
252 #define SMB_QUERY_FS_SIZE_INFO          0x103
253 #define SMB_QUERY_FS_DEVICE_INFO        0x104
254 #define SMB_QUERY_FS_ATTRIBUTE_INFO     0x105
255
256 /*
257  * SMB_TRANS2_FIND_FIRST2 information levels
258  */
259 #define SMB_INFO_STANDARD               1
260 #define SMB_INFO_QUERY_EA_SIZE          2
261 #define SMB_INFO_QUERY_EAS_FROM_LIST    3
262 #define SMB_FIND_FILE_DIRECTORY_INFO    0x101
263 #define SMB_FIND_FULL_DIRECTORY_INFO    0x102
264 #define SMB_FIND_FILE_NAMES_INFO        0x103
265 #define SMB_FIND_BOTH_DIRECTORY_INFO    0x104
266
267 /*
268  * Set PATH/FILE information levels
269  */
270 #define SMB_SET_FILE_BASIC_INFO         0x101
271 #define SMB_SET_FILE_END_OF_FILE_INFO   0x104
272
273 /*
274  * LOCKING_ANDX LockType flags
275  */
276 #define SMB_LOCKING_ANDX_SHARED_LOCK    0x01
277 #define SMB_LOCKING_ANDX_OPLOCK_RELEASE 0x02
278 #define SMB_LOCKING_ANDX_CHANGE_LOCKTYPE 0x04
279 #define SMB_LOCKING_ANDX_CANCEL_LOCK    0x08
280 #define SMB_LOCKING_ANDX_LARGE_FILES    0x10
281
282 /*
283  * Some names length limitations. Some of them aren't declared by specs,
284  * but we need reasonable limits.
285  */
286 #define SMB_MAXSRVNAMELEN       15      /* NetBIOS limit */
287 #define SMB_MAXUSERNAMELEN      128
288 #define SMB_MAXPASSWORDLEN      128
289 #define SMB_MAXSHARENAMELEN     128
290 #define SMB_MAXPKTLEN           0x1FFFF
291 #define SMB_MAXCHALLENGELEN     8
292 #define SMB_MAXFNAMELEN         255     /* Keep in sync with MAXNAMLEN */
293
294 #define SMB_MAXRCN              3       /* number of reconnect attempts */
295
296 /*
297  * Error classes
298  */
299 #define SMBSUCCESS      0x00
300 #define ERRDOS          0x01
301 #define ERRSRV          0x02
302 #define ERRHRD          0x03    /* Error is an hardware error. */
303 #define ERRCMD          0xFF    /* Command was not in the "SMB" format. */
304
305 /*
306  * Error codes for the ERRDOS class
307  */
308 #define ERRbadfunc      1       /* Invalid function */
309 #define ERRbadfile      2       /* File not found (last component) */
310 #define ERRbadpath      3       /* Directory invalid */
311 #define ERRnofids       4       /* Too many open files */
312 #define ERRnoaccess     5       /* Access denied */
313 #define ERRbadfid       6       /* Invalid file handle */
314 #define ERRbadmcb       7       /* Memory control blocks destroyed (huh ?) */
315 #define ERRnomem        8       /* Insufficient memory */
316 #define ERRbadmem       9       /* Invalid memory block address */
317 #define ERRbadenv       10      /* Invalid environment */
318 #define ERRbadformat    11      /* Invalid format */
319 #define ERRbadaccess    12      /* Invalid open mode */
320 #define ERRbaddata      13      /* Invalid data */
321 #define ERRbaddrive     15      /* Invalid drive specified */
322 #define ERRremcd        16      /* An attempt to delete current directory */
323 #define ERRdiffdevice   17      /* cross fs rename/move */
324 #define ERRnofiles      18      /* no more files found in file search */
325 #define ERRbadshare     32      /* Share mode can't be granted */
326 #define ERRlock         33      /* A lock request conflicts with existing lock */
327 #define ERRfilexists    80      /* The file named in the request already exists */
328
329 /*
330  * Error codes for the ERRSRV class
331  */
332 #define ERRerror        1       /* Non-specific error code */
333 #define ERRbadpw        2       /* Bad password */
334 #define ERRaccess       4       /* The client doesn't have enough access rights */
335 #define ERRinvnid       5       /* The Tid specified in a command is invalid */
336 #define ERRinvnetname   6       /* Invalid server name in the tree connect */
337 #define ERRinvdevice    7       /* Printer and not printer devices are mixed */
338 #define ERRqfull        49      /* Print queue full */
339 #define ERRqtoobig      50      /* Print queue full - no space */
340 #define ERRinvpfid      52      /* Invalid print file FID */
341 #define ERRsmbcmd       64      /* The server did not recognize the command */
342 #define ERRsrverror     65      /* The server encountered and internal error */
343 #define ERRfilespecs    67      /* The Fid and path name contains an invalid combination */
344 #define ERRbadpermits   69      /* Access mode invalid */
345 #define ERRsetattrmode  71      /* Attribute mode invalid */
346 #define ERRpaused       81      /* Server is paused */
347 #define ERRmsgoff       82      /* Not receiving messages */
348 #define ERRnoroom       83      /* No room to buffer message */
349 #define ERRrmuns        87      /* Too many remote user names */
350 #define ERRtimeout      88      /* Operation timed out */
351 #define ERRnoresource   89      /* No resources currently available for request */
352 #define ERRtoomanyuids  90      /* Too many UIDs active on this session */
353 #define ERRbaduid       91      /* The UID is not known in this session */
354 #define ERRusempx       250     /* Temporarily unable to support Raw, use MPX mode */
355 #define ERRusestd       251     /* Temporarily unable to support Raw, use standard r/w */
356 #define ERRcontmpx      252     /* Continue in MPX mode */
357 #define ERRnosupport    65535   /* Invalid function */
358
359 /*
360  * Error codes for the ERRHRD class
361  */
362 #define ERRnowrite      19      /* write protected media */
363 #define ERRbadunit      20      /* Unknown unit */
364 #define ERRnotready     21      /* Drive not ready */
365 #define ERRbadcmd       22      /* Unknown command */
366 #define ERRdata         23      /* Data error (CRC) */
367 #define ERRbadreq       24      /* Bad request structure length */
368 #define ERRseek         25      /* Seek error */
369 #define ERRbadmedia     26      /* Unknown media type */
370 #define ERRbadsector    27      /* Sector not found */
371 #define ERRnopaper      28      /* Printer out of paper */
372 #define ERRwrite        29      /* Write fault */
373 #define ERRread         30      /* Read fault */
374 #define ERRgeneral      31      /* General failure */
375 #define ERRbadshare     32      /* A open conflicts with an existing open */
376 #define ERRlock         33      /* lock/unlock conflict */
377 #define ERRwrongdisk    34      /* The wrong disk was found in a drive */
378 #define ERRFCBunavail   35      /* No FCBs available */
379 #define ERRsharebufexc  36      /* A sharing buffer has been exceeded */
380
381 /*
382  * RAP error codes (it seems that they returned not only by RAP)
383  */
384 #define SMB_ERROR_ACCESS_DENIED         5
385 #define SMB_ERROR_NETWORK_ACCESS_DENIED 65
386 #define SMB_ERROR_MORE_DATA             234
387
388 typedef u_int16_t       smbfh;
389
390 #endif /* _NETSMB_SMB_H_ */