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