r838: got rid of rpc_misc.h
[sfrench/samba-autobuild/.git] / source4 / include / smb.h
1 /* 
2    Unix SMB/CIFS implementation.
3    SMB parameters and setup, plus a whole lot more.
4    
5    Copyright (C) Andrew Tridgell              1992-2000
6    Copyright (C) John H Terpstra              1996-2002
7    Copyright (C) Luke Kenneth Casson Leighton 1996-2000
8    Copyright (C) Paul Ashton                  1998-2000
9    Copyright (C) Simo Sorce                   2001-2002
10    Copyright (C) Martin Pool                  2002
11    
12    This program is free software; you can redistribute it and/or modify
13    it under the terms of the GNU General Public License as published by
14    the Free Software Foundation; either version 2 of the License, or
15    (at your option) any later version.
16    
17    This program is distributed in the hope that it will be useful,
18    but WITHOUT ANY WARRANTY; without even the implied warranty of
19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20    GNU General Public License for more details.
21    
22    You should have received a copy of the GNU General Public License
23    along with this program; if not, write to the Free Software
24    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 */
26
27 #ifndef _SMB_H
28 #define _SMB_H
29
30 #define NMB_PORT 137
31 #define DGRAM_PORT 138
32 #define SMB_PORT1 445
33 #define SMB_PORT2 139
34 #define SMB_PORTS "445 139"
35
36 #define False (0)
37 #define True (1)
38 #define Auto (2)
39
40 enum smb_signing_state {SMB_SIGNING_OFF, SMB_SIGNING_SUPPORTED, SMB_SIGNING_REQUIRED};
41
42 #ifndef _BOOL
43 typedef int BOOL;
44 #define _BOOL       /* So we don't typedef BOOL again in vfs.h */
45 #endif
46
47 #define SIZEOFWORD 2
48
49 #ifndef DEF_CREATE_MASK
50 #define DEF_CREATE_MASK (0755)
51 #endif
52
53 /* string manipulation flags - see clistr.c and srvstr.c */
54 #define STR_TERMINATE 1
55 #define STR_UPPER 2
56 #define STR_ASCII 4
57 #define STR_UNICODE 8
58 #define STR_NOALIGN 16
59 #define STR_NO_RANGE_CHECK 32
60 #define STR_LEN8BIT 64
61 #define STR_TERMINATE_ASCII 128 /* only terminate if ascii */
62 #define STR_LEN_NOTERM 256 /* the length field is the unterminated length */
63
64 /* Debugging stuff */
65 #include "debug.h"
66
67 /* types of socket errors */
68 enum socket_error {SOCKET_READ_TIMEOUT,
69                    SOCKET_READ_EOF,
70                    SOCKET_READ_ERROR,
71                    SOCKET_WRITE_ERROR,
72                    SOCKET_READ_BAD_SIG};
73
74 /* deny modes */
75 #define DENY_DOS 0
76 #define DENY_ALL 1
77 #define DENY_WRITE 2
78 #define DENY_READ 3
79 #define DENY_NONE 4
80 #define DENY_FCB 7
81
82 /* open modes */
83 #define DOS_OPEN_RDONLY 0
84 #define DOS_OPEN_WRONLY 1
85 #define DOS_OPEN_RDWR 2
86 #define DOS_OPEN_FCB 0xF
87
88
89 /**********************************/
90 /* SMBopen field definitions      */
91 #define OPEN_FLAGS_DENY_MASK  0x70
92 #define OPEN_FLAGS_DENY_DOS   0x00
93 #define OPEN_FLAGS_DENY_ALL   0x10
94 #define OPEN_FLAGS_DENY_WRITE 0x20
95 #define OPEN_FLAGS_DENY_READ  0x30
96 #define OPEN_FLAGS_DENY_NONE  0x40
97
98 #define OPEN_FLAGS_MODE_MASK  0x0F
99 #define OPEN_FLAGS_OPEN_READ     0
100 #define OPEN_FLAGS_OPEN_WRITE    1
101 #define OPEN_FLAGS_OPEN_RDWR     2
102 #define OPEN_FLAGS_FCB        0xFF
103
104
105 /**********************************/
106 /* SMBopenX field definitions     */
107
108 /* OpenX Flags field. */
109 #define OPENX_FLAGS_ADDITIONAL_INFO      0x01
110 #define OPENX_FLAGS_REQUEST_OPLOCK       0x02
111 #define OPENX_FLAGS_REQUEST_BATCH_OPLOCK 0x04
112 #define OPENX_FLAGS_EA_LEN               0x08
113 #define OPENX_FLAGS_EXTENDED_RETURN      0x10
114
115 /* desired access (open_mode), split info 4 4-bit nibbles */
116 #define OPENX_MODE_ACCESS_MASK   0x000F
117 #define OPENX_MODE_ACCESS_READ   0x0000
118 #define OPENX_MODE_ACCESS_WRITE  0x0001
119 #define OPENX_MODE_ACCESS_RDWR   0x0002
120 #define OPENX_MODE_ACCESS_EXEC   0x0003
121 #define OPENX_MODE_ACCESS_FCB    0x000F
122
123 #define OPENX_MODE_DENY_SHIFT    4
124 #define OPENX_MODE_DENY_MASK     (0xF        << OPENX_MODE_DENY_SHIFT)
125 #define OPENX_MODE_DENY_DOS      (DENY_DOS   << OPENX_MODE_DENY_SHIFT)
126 #define OPENX_MODE_DENY_ALL      (DENY_ALL   << OPENX_MODE_DENY_SHIFT)
127 #define OPENX_MODE_DENY_WRITE    (DENY_WRITE << OPENX_MODE_DENY_SHIFT)
128 #define OPENX_MODE_DENY_READ     (DENY_READ  << OPENX_MODE_DENY_SHIFT)
129 #define OPENX_MODE_DENY_NONE     (DENY_NONE  << OPENX_MODE_DENY_SHIFT)
130 #define OPENX_MODE_DENY_FCB      (0xF        << OPENX_MODE_DENY_SHIFT)
131
132 #define OPENX_MODE_LOCALITY_MASK 0x0F00 /* what does this do? */
133
134 #define OPENX_MODE_NO_CACHE      0x1000
135 #define OPENX_MODE_WRITE_THRU    0x4000
136
137 /* open function values */
138 #define OPENX_OPEN_FUNC_MASK  0x3
139 #define OPENX_OPEN_FUNC_FAIL  0x0
140 #define OPENX_OPEN_FUNC_OPEN  0x1
141 #define OPENX_OPEN_FUNC_TRUNC 0x2
142
143 /* The above can be OR'ed with... */
144 #define OPENX_OPEN_FUNC_CREATE 0x10
145
146 /* openx action in reply */
147 #define OPENX_ACTION_EXISTED    1
148 #define OPENX_ACTION_CREATED    2
149 #define OPENX_ACTION_TRUNCATED  3
150
151
152 /**********************************/
153 /* SMBntcreateX field definitions */
154
155 /* ntcreatex flags field. */
156 #define NTCREATEX_FLAGS_REQUEST_OPLOCK       0x02
157 #define NTCREATEX_FLAGS_REQUEST_BATCH_OPLOCK 0x04
158 #define NTCREATEX_FLAGS_OPEN_DIRECTORY       0x08
159 #define NTCREATEX_FLAGS_EXTENDED             0x10
160
161 /* the ntcreatex access_mask field 
162    this is split into 4 pieces
163    AAAABBBBCCCCCCCCDDDDDDDDDDDDDDDD
164    A -> GENERIC_RIGHT_*
165    B -> SEC_RIGHT_*
166    C -> STD_RIGHT_*
167    D -> SA_RIGHT_*
168    
169    which set of SA_RIGHT_* bits is applicable depends on the type
170    of object.
171 */
172
173
174
175 /* ntcreatex share_access field */
176 #define NTCREATEX_SHARE_ACCESS_NONE   0
177 #define NTCREATEX_SHARE_ACCESS_READ   1
178 #define NTCREATEX_SHARE_ACCESS_WRITE  2
179 #define NTCREATEX_SHARE_ACCESS_DELETE 4
180
181 /* ntcreatex open_disposition field */
182 #define NTCREATEX_DISP_SUPERSEDE 0     /* supersede existing file (if it exists) */
183 #define NTCREATEX_DISP_OPEN 1          /* if file exists open it, else fail */
184 #define NTCREATEX_DISP_CREATE 2        /* if file exists fail, else create it */
185 #define NTCREATEX_DISP_OPEN_IF 3       /* if file exists open it, else create it */
186 #define NTCREATEX_DISP_OVERWRITE 4     /* if exists overwrite, else fail */
187 #define NTCREATEX_DISP_OVERWRITE_IF 5  /* if exists overwrite, else create */
188
189 /* ntcreatex create_options field */
190 #define NTCREATEX_OPTIONS_DIRECTORY            0x0001
191 #define NTCREATEX_OPTIONS_WRITE_THROUGH        0x0002
192 #define NTCREATEX_OPTIONS_SEQUENTIAL_ONLY      0x0004
193 #define NTCREATEX_OPTIONS_SYNC_ALERT           0x0010
194 #define NTCREATEX_OPTIONS_ASYNC_ALERT          0x0020
195 #define NTCREATEX_OPTIONS_NON_DIRECTORY_FILE   0x0040
196 #define NTCREATEX_OPTIONS_NO_EA_KNOWLEDGE      0x0200
197 #define NTCREATEX_OPTIONS_EIGHT_DOT_THREE_ONLY 0x0400
198 #define NTCREATEX_OPTIONS_RANDOM_ACCESS        0x0800
199 #define NTCREATEX_OPTIONS_DELETE_ON_CLOSE      0x1000
200 #define NTCREATEX_OPTIONS_OPEN_BY_FILE_ID      0x2000
201
202 /* ntcreatex impersonation field */
203 #define NTCREATEX_IMPERSONATION_ANONYMOUS      0
204 #define NTCREATEX_IMPERSONATION_IDENTIFICATION 1
205 #define NTCREATEX_IMPERSONATION_IMPERSONATION  2
206 #define NTCREATEX_IMPERSONATION_DELEGATION     3
207
208 /* ntcreatex security flags bit field */
209 #define NTCREATEX_SECURITY_DYNAMIC             1
210 #define NTCREATEX_SECURITY_ALL                 2
211
212 /* ntcreatex create_action in reply */
213 #define NTCREATEX_ACTION_EXISTED     1
214 #define NTCREATEX_ACTION_CREATED     2
215 #define NTCREATEX_ACTION_TRUNCATED   3
216 /* the value 5 can also be returned when you try to create a directory with
217    incorrect parameters - what does it mean? maybe created temporary file? */
218 #define NTCREATEX_ACTION_UNKNOWN 5
219
220 #include "doserr.h"
221
222 /*
223  * SMB UCS2 (16-bit unicode) internal type.
224  */
225
226 typedef uint16 smb_ucs2_t;
227
228 /* ucs2 string types. */
229 typedef smb_ucs2_t wpstring[PSTRING_LEN];
230 typedef smb_ucs2_t wfstring[FSTRING_LEN];
231
232 #ifdef WORDS_BIGENDIAN
233 #define UCS2_SHIFT 8
234 #else
235 #define UCS2_SHIFT 0
236 #endif
237
238 /* turn a 7 bit character into a ucs2 character */
239 #define UCS2_CHAR(c) ((c) << UCS2_SHIFT)
240
241 #define MAX_HOURS_LEN 32
242
243 /* for compatibility */
244 #define SID_NAME_USE samr_SidType
245
246 /*
247  * The complete list of SIDS belonging to this user.
248  * Created when a vuid is registered.
249  * The definition of the user_sids array is as follows :
250  *
251  * token->user_sids[0] = primary user SID.
252  * token->user_sids[1] = primary group SID.
253  * token->user_sids[2..num_sids] = supplementary group SIDS.
254  */
255
256 #define PRIMARY_USER_SID_INDEX 0
257 #define PRIMARY_GROUP_SID_INDEX 1
258
259 typedef struct nt_user_token {
260         size_t num_sids;
261         struct dom_sid **user_sids;
262 } NT_USER_TOKEN;
263
264 /* 32 bit time (sec) since 01jan1970 - cifs6.txt, section 3.5, page 30 */
265 typedef struct time_info
266 {
267   uint32 time;
268 } UTIME;
269
270 /* used to hold an arbitrary blob of data */
271 typedef struct data_blob {
272         uint8 *data;
273         size_t length;
274         void (*free)(struct data_blob *data_blob);
275 } DATA_BLOB;
276
277 #include "enums.h"
278 #include "events.h"
279 #include "librpc/gen_ndr/ndr_misc.h"
280 #include "smb_interfaces.h"
281 #include "librpc/ndr/libndr.h"
282
283 typedef struct userdom_struct {
284         fstring smb_name; /* user name from the client */
285         fstring unix_name; /* unix user name of a validated user */
286         fstring full_name; /* to store full name (such as "Joe Bloggs") from gecos field of password file */
287         fstring domain; /* domain that the client specified */
288 } userdom_struct;
289
290
291 /* used for server information: client, nameserv and ipc */
292 struct server_info_struct
293 {
294   fstring name;
295   uint32 type;
296   fstring comment;
297   fstring domain; /* used ONLY in ipc.c NOT namework.c */
298   BOOL server_added; /* used ONLY in ipc.c NOT namework.c */
299 };
300
301
302 /* used for network interfaces */
303 struct interface
304 {
305         struct interface *next, *prev;
306         struct in_addr ip;
307         struct in_addr bcast;
308         struct in_addr nmask;
309 };
310
311 /* struct returned by get_share_modes */
312 typedef struct {
313         pid_t pid;
314         uint16 op_port;
315         uint16 op_type;
316         int share_mode;
317         uint32 desired_access;
318         struct timeval time;
319         SMB_DEV_T dev;
320         SMB_INO_T inode;
321         unsigned long share_file_id;
322 } share_mode_entry;
323
324
325 #define SHAREMODE_FN_CAST() \
326         void (*)(share_mode_entry *, char*)
327
328 #define SHAREMODE_FN(fn) \
329         void (*fn)(share_mode_entry *, char*)
330
331 #define NT_HASH_LEN 16
332 #define LM_HASH_LEN 16
333
334 /*
335  * Flags for account policy.
336  */
337 #define AP_MIN_PASSWORD_LEN             1
338 #define AP_PASSWORD_HISTORY             2
339 #define AP_USER_MUST_LOGON_TO_CHG_PASS  3
340 #define AP_MAX_PASSWORD_AGE             4
341 #define AP_MIN_PASSWORD_AGE             5
342 #define AP_LOCK_ACCOUNT_DURATION        6
343 #define AP_RESET_COUNT_TIME             7
344 #define AP_BAD_ATTEMPT_LOCKOUT          8
345 #define AP_TIME_TO_LOGOUT               9
346
347
348 /*
349  * Flags for local user manipulation.
350  */
351
352 #define LOCAL_ADD_USER 0x1
353 #define LOCAL_DELETE_USER 0x2
354 #define LOCAL_DISABLE_USER 0x4
355 #define LOCAL_ENABLE_USER 0x8
356 #define LOCAL_TRUST_ACCOUNT 0x10
357 #define LOCAL_SET_NO_PASSWORD 0x20
358 #define LOCAL_SET_PASSWORD 0x40
359 #define LOCAL_SET_LDAP_ADMIN_PW 0x80
360 #define LOCAL_INTERDOM_ACCOUNT 0x100
361 #define LOCAL_AM_ROOT 0x200  /* Act as root */
362
363 /* key and data in the connections database - used in smbstatus and smbd */
364 struct connections_key {
365         pid_t pid;
366         int cnum;
367         fstring name;
368 };
369
370 struct connections_data {
371         int magic;
372         pid_t pid;
373         int cnum;
374         uid_t uid;
375         gid_t gid;
376         char name[24];
377         char addr[24];
378         char machine[FSTRING_LEN];
379         time_t start;
380         uint32 bcast_msg_flags;
381 };
382
383 /* the following are used by loadparm for option lists */
384 typedef enum
385 {
386   P_BOOL,P_BOOLREV,P_CHAR,P_INTEGER,P_OCTAL,P_LIST,
387   P_STRING,P_USTRING,P_ENUM,P_SEP
388 } parm_type;
389
390 typedef enum
391 {
392   P_LOCAL,P_GLOBAL,P_SEPARATOR,P_NONE
393 } parm_class;
394
395 struct enum_list {
396         int value;
397         const char *name;
398 };
399
400 struct parm_struct
401 {
402         const char *label;
403         parm_type type;
404         parm_class class;
405         void *ptr;
406         BOOL (*special)(const char *, char **);
407         const struct enum_list *enum_list;
408         unsigned flags;
409         union {
410                 BOOL bvalue;
411                 int ivalue;
412                 char *svalue;
413                 char cvalue;
414                 char **lvalue;
415         } def;
416 };
417
418 struct bitmap {
419         uint32 *b;
420         unsigned int n;
421 };
422
423 #define FLAG_BASIC      0x0001 /* fundamental options */
424 #define FLAG_SHARE      0x0002 /* file sharing options */
425 #define FLAG_PRINT      0x0004 /* printing options */
426 #define FLAG_GLOBAL     0x0008 /* local options that should be globally settable in SWAT */
427 #define FLAG_WIZARD     0x0010 /* Parameters that the wizard will operate on */
428 #define FLAG_ADVANCED   0x0020 /* Parameters that the wizard will operate on */
429 #define FLAG_DEVELOPER  0x0040 /* Parameters that the wizard will operate on */
430 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
431 #define FLAG_HIDE       0x2000 /* options that should be hidden in SWAT */
432 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */
433 #define FLAG_CMDLINE    0x8000 /* this option was set from the command line */
434
435 #ifndef LOCKING_VERSION
436 #define LOCKING_VERSION 4
437 #endif /* LOCKING_VERSION */
438
439
440 /* the basic packet size, assuming no words or bytes. Does not include the NBT header */
441 #define MIN_SMB_SIZE 35
442
443 /* when using NBT encapsulation every packet has a 4 byte header */
444 #define NBT_HDR_SIZE 4
445
446 /* offsets into message header for common items - NOTE: These have
447    changed from being offsets from the base of the NBT packet to the base of the SMB packet.
448    this has reduced all these values by 4
449 */
450 #define HDR_COM 4
451 #define HDR_RCLS 5
452 #define HDR_REH 6
453 #define HDR_ERR 7
454 #define HDR_FLG 9
455 #define HDR_FLG2 10
456 #define HDR_PIDHIGH 12
457 #define HDR_SS_FIELD 14
458 #define HDR_TID 24
459 #define HDR_PID 26
460 #define HDR_UID 28
461 #define HDR_MID 30
462 #define HDR_WCT 32
463 #define HDR_VWV 33
464
465
466 /* types of buffers in core SMB protocol */
467 #define SMB_DATA_BLOCK 0x1
468 #define SMB_ASCII4     0x4
469
470
471 /* flag defines. CIFS spec 3.1.1 */
472 #define FLAG_SUPPORT_LOCKREAD       0x01
473 #define FLAG_CLIENT_BUF_AVAIL       0x02
474 #define FLAG_RESERVED               0x04
475 #define FLAG_CASELESS_PATHNAMES     0x08
476 #define FLAG_CANONICAL_PATHNAMES    0x10
477 #define FLAG_REQUEST_OPLOCK         0x20
478 #define FLAG_REQUEST_BATCH_OPLOCK   0x40
479 #define FLAG_REPLY                  0x80
480
481 /* the complete */
482 #define SMBmkdir      0x00   /* create directory */
483 #define SMBrmdir      0x01   /* delete directory */
484 #define SMBopen       0x02   /* open file */
485 #define SMBcreate     0x03   /* create file */
486 #define SMBclose      0x04   /* close file */
487 #define SMBflush      0x05   /* flush file */
488 #define SMBunlink     0x06   /* delete file */
489 #define SMBmv         0x07   /* rename file */
490 #define SMBgetatr     0x08   /* get file attributes */
491 #define SMBsetatr     0x09   /* set file attributes */
492 #define SMBread       0x0A   /* read from file */
493 #define SMBwrite      0x0B   /* write to file */
494 #define SMBlock       0x0C   /* lock byte range */
495 #define SMBunlock     0x0D   /* unlock byte range */
496 #define SMBctemp      0x0E   /* create temporary file */
497 #define SMBmknew      0x0F   /* make new file */
498 #define SMBchkpth     0x10   /* check directory path */
499 #define SMBexit       0x11   /* process exit */
500 #define SMBlseek      0x12   /* seek */
501 #define SMBtcon       0x70   /* tree connect */
502 #define SMBtconX      0x75   /* tree connect and X*/
503 #define SMBtdis       0x71   /* tree disconnect */
504 #define SMBnegprot    0x72   /* negotiate protocol */
505 #define SMBdskattr    0x80   /* get disk attributes */
506 #define SMBsearch     0x81   /* search directory */
507 #define SMBsplopen    0xC0   /* open print spool file */
508 #define SMBsplwr      0xC1   /* write to print spool file */
509 #define SMBsplclose   0xC2   /* close print spool file */
510 #define SMBsplretq    0xC3   /* return print queue */
511 #define SMBsends      0xD0   /* send single block message */
512 #define SMBsendb      0xD1   /* send broadcast message */
513 #define SMBfwdname    0xD2   /* forward user name */
514 #define SMBcancelf    0xD3   /* cancel forward */
515 #define SMBgetmac     0xD4   /* get machine name */
516 #define SMBsendstrt   0xD5   /* send start of multi-block message */
517 #define SMBsendend    0xD6   /* send end of multi-block message */
518 #define SMBsendtxt    0xD7   /* send text of multi-block message */
519
520 /* Core+ protocol */
521 #define SMBlockread       0x13   /* Lock a range and read */
522 #define SMBwriteunlock 0x14 /* write then range then unlock it */
523 #define SMBreadbraw   0x1a  /* read a block of data with no smb header */
524 #define SMBwritebraw  0x1d  /* write a block of data with no smb header */
525 #define SMBwritec     0x20  /* secondary write request */
526 #define SMBwriteclose 0x2c  /* write a file then close it */
527
528 /* dos extended protocol */
529 #define SMBreadBraw      0x1A   /* read block raw */
530 #define SMBreadBmpx      0x1B   /* read block multiplexed */
531 #define SMBreadBs        0x1C   /* read block (secondary response) */
532 #define SMBwriteBraw     0x1D   /* write block raw */
533 #define SMBwriteBmpx     0x1E   /* write block multiplexed */
534 #define SMBwriteBs       0x1F   /* write block (secondary request) */
535 #define SMBwriteC        0x20   /* write complete response */
536 #define SMBsetattrE      0x22   /* set file attributes expanded */
537 #define SMBgetattrE      0x23   /* get file attributes expanded */
538 #define SMBlockingX      0x24   /* lock/unlock byte ranges and X */
539 #define SMBtrans         0x25   /* transaction - name, bytes in/out */
540 #define SMBtranss        0x26   /* transaction (secondary request/response) */
541 #define SMBioctl         0x27   /* IOCTL */
542 #define SMBioctls        0x28   /* IOCTL  (secondary request/response) */
543 #define SMBcopy          0x29   /* copy */
544 #define SMBmove          0x2A   /* move */
545 #define SMBecho          0x2B   /* echo */
546 #define SMBopenX         0x2D   /* open and X */
547 #define SMBreadX         0x2E   /* read and X */
548 #define SMBwriteX        0x2F   /* write and X */
549 #define SMBsesssetupX    0x73   /* Session Set Up & X (including User Logon) */
550 #define SMBffirst        0x82   /* find first */
551 #define SMBfunique       0x83   /* find unique */
552 #define SMBfclose        0x84   /* find close */
553 #define SMBkeepalive     0x85   /* keepalive */
554 #define SMBinvalid       0xFE   /* invalid command */
555
556 /* Extended 2.0 protocol */
557 #define SMBtrans2        0x32   /* TRANS2 protocol set */
558 #define SMBtranss2       0x33   /* TRANS2 protocol set, secondary command */
559 #define SMBfindclose     0x34   /* Terminate a TRANSACT2_FINDFIRST */
560 #define SMBfindnclose    0x35   /* Terminate a TRANSACT2_FINDNOTIFYFIRST */
561 #define SMBulogoffX      0x74   /* user logoff */
562
563 /* NT SMB extensions. */
564 #define SMBnttrans       0xA0   /* NT transact */
565 #define SMBnttranss      0xA1   /* NT transact secondary */
566 #define SMBntcreateX     0xA2   /* NT create and X */
567 #define SMBntcancel      0xA4   /* NT cancel */
568 #define SMBntrename      0xA5   /* NT rename */
569
570 /* used to indicate end of chain */
571 #define SMB_CHAIN_NONE   0xFF
572
573 /* These are the trans subcommands */
574 #define TRANSACT_SETNAMEDPIPEHANDLESTATE  0x01 
575 #define TRANSACT_DCERPCCMD                0x26
576 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
577
578 /* These are the NT transact sub commands. */
579 #define NT_TRANSACT_CREATE                1
580 #define NT_TRANSACT_IOCTL                 2
581 #define NT_TRANSACT_SET_SECURITY_DESC     3
582 #define NT_TRANSACT_NOTIFY_CHANGE         4
583 #define NT_TRANSACT_RENAME                5
584 #define NT_TRANSACT_QUERY_SECURITY_DESC   6
585
586 /* this is used on a TConX. I'm not sure the name is very helpful though */
587 #define SMB_SUPPORT_SEARCH_BITS        0x0001
588 #define SMB_SHARE_IN_DFS               0x0002
589
590 /* Named pipe write mode flags. Used in writeX calls. */
591 #define PIPE_RAW_MODE 0x4
592 #define PIPE_START_MESSAGE 0x8
593
594 /* the desired access to use when opening a pipe */
595 #define DESIRED_ACCESS_PIPE 0x2019f
596  
597
598 /* Mapping of generic access rights for files to specific rights. */
599 #define FILE_GENERIC_ALL (STANDARD_RIGHTS_REQUIRED_ACCESS| NT_ACCESS_SYNCHRONIZE_ACCESS|FILE_ALL_ACCESS)
600
601 #define FILE_GENERIC_READ (STANDARD_RIGHTS_READ_ACCESS|FILE_READ_DATA|FILE_READ_ATTRIBUTES|\
602                                                         FILE_READ_EA|NT_ACCESS_SYNCHRONIZE_ACCESS)
603
604 #define FILE_GENERIC_WRITE (STANDARD_RIGHTS_WRITE_ACCESS|FILE_WRITE_DATA|FILE_WRITE_ATTRIBUTES|\
605                             FILE_WRITE_EA|FILE_APPEND_DATA|NT_ACCESS_SYNCHRONIZE_ACCESS)
606
607 #define FILE_GENERIC_EXECUTE (STANDARD_RIGHTS_EXECUTE_ACCESS|FILE_READ_ATTRIBUTES|\
608                             FILE_EXECUTE|NT_ACCESS_SYNCHRONIZE_ACCESS)
609
610
611 /* FileAttributes (search attributes) field */
612 #define FILE_ATTRIBUTE_READONLY         0x0001
613 #define FILE_ATTRIBUTE_HIDDEN           0x0002
614 #define FILE_ATTRIBUTE_SYSTEM           0x0004
615 #define FILE_ATTRIBUTE_VOLUME           0x0008
616 #define FILE_ATTRIBUTE_DIRECTORY        0x0010
617 #define FILE_ATTRIBUTE_ARCHIVE          0x0020
618 #define FILE_ATTRIBUTE_DEVICE           0x0040
619 #define FILE_ATTRIBUTE_NORMAL           0x0080
620 #define FILE_ATTRIBUTE_TEMPORARY        0x0100
621 #define FILE_ATTRIBUTE_SPARSE           0x0200
622 #define FILE_ATTRIBUTE_REPARSE_POINT    0x0400
623 #define FILE_ATTRIBUTE_COMPRESSED       0x0800
624 #define FILE_ATTRIBUTE_OFFLINE          0x1000
625 #define FILE_ATTRIBUTE_NONINDEXED       0x2000
626 #define FILE_ATTRIBUTE_ENCRYPTED        0x4000
627
628 /* Flags - combined with attributes. */
629 #define FILE_FLAG_WRITE_THROUGH    0x80000000L
630 #define FILE_FLAG_NO_BUFFERING     0x20000000L
631 #define FILE_FLAG_RANDOM_ACCESS    0x10000000L
632 #define FILE_FLAG_SEQUENTIAL_SCAN  0x08000000L
633 #define FILE_FLAG_DELETE_ON_CLOSE  0x04000000L
634 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
635 #define FILE_FLAG_POSIX_SEMANTICS  0x01000000L
636
637 /* Responses when opening a file. */
638 #define FILE_WAS_SUPERSEDED 0
639 #define FILE_WAS_OPENED 1
640 #define FILE_WAS_CREATED 2
641 #define FILE_WAS_OVERWRITTEN 3
642
643 /* File type flags */
644 #define FILE_TYPE_DISK  0
645 #define FILE_TYPE_BYTE_MODE_PIPE 1
646 #define FILE_TYPE_MESSAGE_MODE_PIPE 2
647 #define FILE_TYPE_PRINTER 3
648 #define FILE_TYPE_COMM_DEVICE 4
649 #define FILE_TYPE_UNKNOWN 0xFFFF
650
651 /* Flag for NT transact rename call. */
652 #define RENAME_REPLACE_IF_EXISTS 1
653
654 /* flags for SMBntrename call */
655 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
656 #define RENAME_FLAG_HARD_LINK                0x103
657 #define RENAME_FLAG_RENAME                   0x104
658 #define RENAME_FLAG_COPY                     0x105
659
660 /* Filesystem Attributes. */
661 #define FILE_CASE_SENSITIVE_SEARCH 0x01
662 #define FILE_CASE_PRESERVED_NAMES 0x02
663 #define FILE_UNICODE_ON_DISK 0x04
664 /* According to cifs9f, this is 4, not 8 */
665 /* Acconding to testing, this actually sets the security attribute! */
666 #define FILE_PERSISTENT_ACLS 0x08
667 /* These entries added from cifs9f --tsb */
668 #define FILE_FILE_COMPRESSION 0x10
669 #define FILE_VOLUME_QUOTAS 0x20
670 /* I think this is wrong. JRA #define FILE_DEVICE_IS_MOUNTED 0x20 */
671 #define FILE_VOLUME_SPARSE_FILE 0x40
672 #define FILE_VOLUME_IS_COMPRESSED 0x8000
673
674 /* ChangeNotify flags. */
675 #define FILE_NOTIFY_CHANGE_FILE        0x001
676 #define FILE_NOTIFY_CHANGE_DIR_NAME    0x002
677 #define FILE_NOTIFY_CHANGE_ATTRIBUTES  0x004
678 #define FILE_NOTIFY_CHANGE_SIZE        0x008
679 #define FILE_NOTIFY_CHANGE_LAST_WRITE  0x010
680 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
681 #define FILE_NOTIFY_CHANGE_CREATION    0x040
682 #define FILE_NOTIFY_CHANGE_EA          0x080
683 #define FILE_NOTIFY_CHANGE_SECURITY    0x100
684 #define FILE_NOTIFY_CHANGE_FILE_NAME   0x200
685
686 /* change notify action results */
687 #define NOTIFY_ACTION_ADDED 1
688 #define NOTIFY_ACTION_REMOVED 2
689 #define NOTIFY_ACTION_MODIFIED 3
690 #define NOTIFY_ACTION_OLD_NAME 4
691 #define NOTIFY_ACTION_NEW_NAME 5
692 #define NOTIFY_ACTION_ADDED_STREAM 6
693 #define NOTIFY_ACTION_REMOVED_STREAM 7
694 #define NOTIFY_ACTION_MODIFIED_STREAM 8
695
696 /* seek modes for smb_seek */
697 #define SEEK_MODE_START   0
698 #define SEEK_MODE_CURRENT 1
699 #define SEEK_MODE_END     2
700
701 /* where to find the base of the SMB packet proper */
702 /* REWRITE TODO: smb_base needs to be removed */
703 #define smb_base(buf) (((char *)(buf))+4)
704
705 /* we don't allow server strings to be longer than 48 characters as
706    otherwise NT will not honour the announce packets */
707 #define MAX_SERVER_STRING_LENGTH 48
708
709
710 #define SMB_SUCCESS 0  /* The request was successful. */
711
712 #ifdef WITH_DFS
713 void dfs_unlogin(void);
714 extern int dcelogin_atmost_once;
715 #endif
716
717 #ifdef NOSTRDUP
718 char *strdup(char *s);
719 #endif
720
721 #ifndef SIGNAL_CAST
722 #define SIGNAL_CAST (RETSIGTYPE (*)(int))
723 #endif
724
725 #ifndef SELECT_CAST
726 #define SELECT_CAST
727 #endif
728
729 /* these are used in NetServerEnum to choose what to receive */
730 #define SV_TYPE_WORKSTATION         0x00000001
731 #define SV_TYPE_SERVER              0x00000002
732 #define SV_TYPE_SQLSERVER           0x00000004
733 #define SV_TYPE_DOMAIN_CTRL         0x00000008
734 #define SV_TYPE_DOMAIN_BAKCTRL      0x00000010
735 #define SV_TYPE_TIME_SOURCE         0x00000020
736 #define SV_TYPE_AFP                 0x00000040
737 #define SV_TYPE_NOVELL              0x00000080
738 #define SV_TYPE_DOMAIN_MEMBER       0x00000100
739 #define SV_TYPE_PRINTQ_SERVER       0x00000200
740 #define SV_TYPE_DIALIN_SERVER       0x00000400
741 #define SV_TYPE_SERVER_UNIX         0x00000800
742 #define SV_TYPE_NT                  0x00001000
743 #define SV_TYPE_WFW                 0x00002000
744 #define SV_TYPE_SERVER_MFPN         0x00004000
745 #define SV_TYPE_SERVER_NT           0x00008000
746 #define SV_TYPE_POTENTIAL_BROWSER   0x00010000
747 #define SV_TYPE_BACKUP_BROWSER      0x00020000
748 #define SV_TYPE_MASTER_BROWSER      0x00040000
749 #define SV_TYPE_DOMAIN_MASTER       0x00080000
750 #define SV_TYPE_SERVER_OSF          0x00100000
751 #define SV_TYPE_SERVER_VMS          0x00200000
752 #define SV_TYPE_WIN95_PLUS          0x00400000
753 #define SV_TYPE_DFS_SERVER          0x00800000
754 #define SV_TYPE_ALTERNATE_XPORT     0x20000000  
755 #define SV_TYPE_LOCAL_LIST_ONLY     0x40000000  
756 #define SV_TYPE_DOMAIN_ENUM         0x80000000
757 #define SV_TYPE_ALL                 0xFFFFFFFF  
758
759 /* This was set by JHT in liaison with Jeremy Allison early 1997
760  * History:
761  * Version 4.0 - never made public
762  * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
763  *              - Reappeared in 1.9.16p11 with fixed smbd services
764  * Version 4.20 - To indicate that nmbd and browsing now works better
765  * Version 4.50 - Set at release of samba-2.2.0 by JHT
766  *
767  *  Note: In the presence of NT4.X do not set above 4.9
768  *        Setting this above 4.9 can have undesired side-effects.
769  *        This may change again in Samba-3.0 after further testing. JHT
770  */
771  
772 #define DEFAULT_MAJOR_VERSION 0x04
773 #define DEFAULT_MINOR_VERSION 0x09
774
775 /* Browser Election Values */
776 #define BROWSER_ELECTION_VERSION        0x010f
777 #define BROWSER_CONSTANT        0xaa55
778
779 /* Sercurity mode bits. */
780 #define NEGOTIATE_SECURITY_USER_LEVEL           0x01
781 #define NEGOTIATE_SECURITY_CHALLENGE_RESPONSE   0x02
782 #define NEGOTIATE_SECURITY_SIGNATURES_ENABLED   0x04
783 #define NEGOTIATE_SECURITY_SIGNATURES_REQUIRED  0x08
784
785 /* NT Flags2 bits - cifs6.txt section 3.1.2 */
786    
787 #define FLAGS2_LONG_PATH_COMPONENTS    0x0001
788 #define FLAGS2_EXTENDED_ATTRIBUTES     0x0002
789 #define FLAGS2_SMB_SECURITY_SIGNATURES 0x0004
790 #define FLAGS2_IS_LONG_NAME            0x0040
791 #define FLAGS2_EXTENDED_SECURITY       0x0800 
792 #define FLAGS2_DFS_PATHNAMES           0x1000
793 #define FLAGS2_READ_PERMIT_NO_EXECUTE  0x2000
794 #define FLAGS2_32_BIT_ERROR_CODES      0x4000 
795 #define FLAGS2_UNICODE_STRINGS         0x8000
796
797 #define FLAGS2_WIN2K_SIGNATURE         0xC852 /* Hack alert ! For now... JRA. */
798
799 /* Capabilities.  see ftp.microsoft.com/developr/drg/cifs/cifs/cifs4.txt */
800
801 #define CAP_RAW_MODE         0x0001
802 #define CAP_MPX_MODE         0x0002
803 #define CAP_UNICODE          0x0004
804 #define CAP_LARGE_FILES      0x0008
805 #define CAP_NT_SMBS          0x0010
806 #define CAP_RPC_REMOTE_APIS  0x0020
807 #define CAP_STATUS32         0x0040
808 #define CAP_LEVEL_II_OPLOCKS 0x0080
809 #define CAP_LOCK_AND_READ    0x0100
810 #define CAP_NT_FIND          0x0200
811 #define CAP_DFS              0x1000
812 #define CAP_W2K_SMBS         0x2000
813 #define CAP_LARGE_READX      0x4000
814 #define CAP_LARGE_WRITEX     0x8000
815 #define CAP_UNIX             0x800000 /* Capabilities for UNIX extensions. Created by HP. */
816 #define CAP_EXTENDED_SECURITY 0x80000000
817
818 /*
819  * Global value meaing that the smb_uid field should be
820  * ingored (in share level security and protocol level == CORE)
821  */
822
823 #define UID_FIELD_INVALID 0
824 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
825
826 /* Lock types. */
827 #define LOCKING_ANDX_SHARED_LOCK 0x1
828 #define LOCKING_ANDX_OPLOCK_RELEASE 0x2
829 #define LOCKING_ANDX_CHANGE_LOCKTYPE 0x4
830 #define LOCKING_ANDX_CANCEL_LOCK 0x8
831 #define LOCKING_ANDX_LARGE_FILES 0x10
832
833 /* Oplock levels */
834 #define OPLOCKLEVEL_NONE 0
835 #define OPLOCKLEVEL_II 1
836
837 /*
838  * Bits we test with.
839  */
840
841 #define NO_OPLOCK 0
842 #define EXCLUSIVE_OPLOCK 1
843 #define BATCH_OPLOCK 2
844 #define LEVEL_II_OPLOCK 4
845
846 #define CORE_OPLOCK_GRANTED (1<<5)
847 #define EXTENDED_OPLOCK_GRANTED (1<<15)
848
849 /*
850  * Return values for oplock types.
851  */
852
853 #define NO_OPLOCK_RETURN 0
854 #define EXCLUSIVE_OPLOCK_RETURN 1
855 #define BATCH_OPLOCK_RETURN 2
856 #define LEVEL_II_OPLOCK_RETURN 3
857
858 /*
859  * Loopback command offsets.
860  */
861
862 #define OPBRK_CMD_LEN_OFFSET 0
863 #define OPBRK_CMD_PORT_OFFSET 4
864 #define OPBRK_CMD_HEADER_LEN 6
865
866 #define OPBRK_MESSAGE_CMD_OFFSET 0
867
868 /* Message types */
869 #define OPLOCK_BREAK_CMD 0x1
870 #define KERNEL_OPLOCK_BREAK_CMD 0x2
871 #define LEVEL_II_OPLOCK_BREAK_CMD 0x3
872 #define ASYNC_LEVEL_II_OPLOCK_BREAK_CMD 0x4
873
874 /*
875  * Capabilities abstracted for different systems.
876  */
877
878 #define KERNEL_OPLOCK_CAPABILITY 0x1
879
880 /*
881  * Oplock break command code sent via the kernel interface (if it exists).
882  *
883  * Form of this is :
884  *
885  *  0     2       2+devsize 2+devsize+inodesize
886  *  +----+--------+--------+----------+
887  *  | cmd| dev    |  inode |  fileid  |
888  *  +----+--------+--------+----------+
889  */
890 #define KERNEL_OPLOCK_BREAK_DEV_OFFSET 2
891 #define KERNEL_OPLOCK_BREAK_INODE_OFFSET (KERNEL_OPLOCK_BREAK_DEV_OFFSET + sizeof(SMB_DEV_T))
892 #define KERNEL_OPLOCK_BREAK_FILEID_OFFSET (KERNEL_OPLOCK_BREAK_INODE_OFFSET + sizeof(SMB_INO_T))
893 #define KERNEL_OPLOCK_BREAK_MSG_LEN (KERNEL_OPLOCK_BREAK_FILEID_OFFSET + sizeof(unsigned long))
894
895
896 #define CMD_REPLY 0x8000
897
898 #include "smb_macros.h"
899
900 /* A netbios name structure. */
901 struct nmb_name {
902         char         name[17];
903         char         scope[64];
904         unsigned int name_type;
905 };
906
907
908 /* A netbios node status array element. */
909 struct node_status {
910         char name[16];
911         unsigned char type;
912         unsigned char flags;
913 };
914
915 struct pwd_info
916 {
917         BOOL null_pwd;
918         BOOL cleartext;
919         BOOL crypted;
920
921         fstring password;
922
923         uchar smb_lm_pwd[16];
924         uchar smb_nt_pwd[16];
925
926         uchar smb_lm_owf[24];
927         uchar smb_nt_owf[128];
928         size_t nt_owf_len;
929
930         uchar lm_cli_chal[8];
931         uchar nt_cli_chal[128];
932         size_t nt_cli_chal_len;
933
934         uchar sess_key[16];
935 };
936
937 #include "rpc_secdes.h"
938
939 typedef struct user_struct
940 {
941         struct user_struct *next, *prev;
942         uint16 vuid; /* Tag for this entry. */
943
944         DATA_BLOB session_key;
945
946         char *session_keystr; /* used by utmp and pam session code.  
947                                  TDB key string */
948         int homes_snum;
949
950         struct auth_serversupplied_info *server_info;
951
952 } user_struct;
953
954 struct unix_error_map {
955         int unix_error;
956         int dos_class;
957         int dos_code;
958         NTSTATUS nt_error;
959 };
960
961 #include "client.h"
962
963 /*
964  * Size of new password account encoding string.  This is enough space to
965  * hold 11 ACB characters, plus the surrounding [] and a terminating null.
966  * Do not change unless you are adding new ACB bits!
967  */
968
969 #define NEW_PW_FORMAT_SPACE_PADDED_LEN 14
970
971 /*
972    Do you want session setups at user level security with a invalid
973    password to be rejected or allowed in as guest? WinNT rejects them
974    but it can be a pain as it means "net view" needs to use a password
975
976    You have 3 choices in the setting of map_to_guest:
977
978    "NEVER_MAP_TO_GUEST" means session setups with an invalid password
979    are rejected. This is the default.
980
981    "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
982    are rejected, unless the username does not exist, in which case it
983    is treated as a guest login
984
985    "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
986    are treated as a guest login
987
988    Note that map_to_guest only has an effect in user or server
989    level security.
990 */
991
992 #define NEVER_MAP_TO_GUEST 0
993 #define MAP_TO_GUEST_ON_BAD_USER 1
994 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
995
996 #define SAFE_NETBIOS_CHARS ". -_"
997
998 /* generic iconv conversion structure */
999 typedef struct {
1000         size_t (*direct)(void *cd, const char **inbuf, size_t *inbytesleft,
1001                          char **outbuf, size_t *outbytesleft);
1002         size_t (*pull)(void *cd, const char **inbuf, size_t *inbytesleft,
1003                        char **outbuf, size_t *outbytesleft);
1004         size_t (*push)(void *cd, const char **inbuf, size_t *inbytesleft,
1005                        char **outbuf, size_t *outbytesleft);
1006         void *cd_direct, *cd_pull, *cd_push;
1007         char *from_name, *to_name;
1008 } *smb_iconv_t;
1009
1010 /* The maximum length of a trust account password.
1011    Used when we randomly create it, 15 char passwords
1012    exceed NT4's max password length */
1013
1014 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
1015
1016
1017 /* a set of flags to control handling of request structures */
1018 #define REQ_CONTROL_PROTECTED (1<<0) /* don't destroy this request */
1019 #define REQ_CONTROL_LARGE     (1<<1) /* allow replies larger than max_xmit */
1020 #define REQ_CONTROL_ASYNC     (1<<2) /* the backend will answer this one later */
1021
1022 /* passed to br lock code */
1023 enum brl_type {READ_LOCK, WRITE_LOCK, PENDING_LOCK};
1024
1025 #include "popt_common.h"
1026
1027 #endif /* _SMB_H */