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