s3:include: remove unused forward declaration of deferred_open_record in smb.h
[Samba/gebeck_regimport.git] / source3 / include / smb.h
blobb9b9f6476e6a1d965873dfa7f8ab885f4fe43808
1 /*
2 Unix SMB/CIFS implementation.
3 SMB parameters and setup, plus a whole lot more.
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
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 3 of the License, or
15 (at your option) any later version.
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.
22 You should have received a copy of the GNU General Public License
23 along with this program. If not, see <http://www.gnu.org/licenses/>.
26 #ifndef _SMB_H
27 #define _SMB_H
29 #include "libcli/smb/smb_common.h"
30 #include "libds/common/roles.h"
32 /* logged when starting the various Samba daemons */
33 #define COPYRIGHT_STARTUP_MESSAGE "Copyright Andrew Tridgell and the Samba Team 1992-2012"
36 #define BUFFER_SIZE (128*1024)
38 #define SAFETY_MARGIN 1024
39 #define LARGE_WRITEX_HDR_SIZE 65
41 #define NMB_PORT 137
42 #define DGRAM_PORT 138
43 #define NBT_SMB_PORT 139 /* Port for SMB over NBT transport (IETF STD#19). */
44 #define TCP_SMB_PORT 445 /* Port for SMB over naked TCP transport. */
45 #define SMB_PORTS "445 139"
47 #define Undefined (-1)
48 #define False false
49 #define True true
50 #define Auto (2)
51 #define Required (3)
53 #define SIZEOFWORD 2
55 #ifndef DEF_CREATE_MASK
56 #define DEF_CREATE_MASK (0755)
57 #endif
59 /* string manipulation flags - see clistr.c and srvstr.c */
60 #define STR_TERMINATE 1
61 #define STR_UPPER 2
62 #define STR_ASCII 4
63 #define STR_UNICODE 8
64 #define STR_NOALIGN 16
65 #define STR_TERMINATE_ASCII 128
67 /* how long to wait for secondary SMB packets (milli-seconds) */
68 #define SMB_SECONDARY_WAIT (60*1000)
70 #define DIR_STRUCT_SIZE 43
72 /* deny modes */
73 #define DENY_DOS 0
74 #define DENY_ALL 1
75 #define DENY_WRITE 2
76 #define DENY_READ 3
77 #define DENY_NONE 4
78 #define DENY_FCB 7
80 /* open modes */
81 #define DOS_OPEN_RDONLY 0
82 #define DOS_OPEN_WRONLY 1
83 #define DOS_OPEN_RDWR 2
84 #define DOS_OPEN_EXEC 3
85 #define DOS_OPEN_FCB 0xF
87 /* define shifts and masks for share and open modes. */
88 #define OPENX_MODE_MASK 0xF
89 #define DENY_MODE_SHIFT 4
90 #define DENY_MODE_MASK 0x7
91 #define GET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
92 #define SET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
93 #define GET_DENY_MODE(x) (((x)>>DENY_MODE_SHIFT) & DENY_MODE_MASK)
94 #define SET_DENY_MODE(x) (((x) & DENY_MODE_MASK) <<DENY_MODE_SHIFT)
96 /* Sync on open file (not sure if used anymore... ?) */
97 #define FILE_SYNC_OPENMODE (1<<14)
98 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
100 /* open disposition values */
101 #define OPENX_FILE_EXISTS_FAIL 0
102 #define OPENX_FILE_EXISTS_OPEN 1
103 #define OPENX_FILE_EXISTS_TRUNCATE 2
105 /* mask for open disposition. */
106 #define OPENX_FILE_OPEN_MASK 0x3
108 #define GET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
109 #define SET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
111 /* The above can be OR'ed with... */
112 #define OPENX_FILE_CREATE_IF_NOT_EXIST 0x10
113 #define OPENX_FILE_FAIL_IF_NOT_EXIST 0
115 /* pipe string names */
117 #ifndef MAXSUBAUTHS
118 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
119 #endif
121 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
123 #include "librpc/gen_ndr/security.h"
125 struct idle_event;
126 struct share_mode_entry;
127 struct uuid;
128 struct named_mutex;
129 struct wb_context;
130 struct rpc_cli_smbd_conn;
131 struct fncall_context;
133 /* the basic packet size, assuming no words or bytes */
134 #define smb_size 39
136 struct notify_change {
137 uint32_t action;
138 const char *name;
141 struct notify_mid_map;
142 struct notify_db_entry;
143 struct notify_event;
144 struct notify_change_request;
145 struct sys_notify_backend;
146 struct sys_notify_context {
147 struct event_context *ev;
148 void *private_data; /* For use by the system backend */
151 #include "ntquotas.h"
152 #include "sysquotas.h"
154 /* Include VFS stuff */
156 #include "smb_acls.h"
157 #include "vfs.h"
159 struct current_user {
160 struct connection_struct *conn;
161 uint16 vuid;
162 struct security_unix_token ut;
163 struct security_token *nt_user_token;
166 struct smbd_smb2_request;
167 struct privilege_paths;
169 struct smb_request {
170 uint8_t cmd;
171 uint16 flags2;
172 uint16 smbpid;
173 uint64_t mid; /* For compatibility with SMB2. */
174 uint32_t seqnum;
175 uint16 vuid;
176 uint16 tid;
177 uint8 wct;
178 const uint16_t *vwv;
179 uint16_t buflen;
180 const uint8_t *buf;
181 const uint8 *inbuf;
184 * Async handling in the main smb processing loop is directed by
185 * outbuf: reply_xxx routines indicate sync behaviour by putting their
186 * reply into "outbuf". If they leave it as NULL, they take care of it
187 * themselves, possibly later.
189 * If async handling is wanted, the reply_xxx routine must make sure
190 * that it talloc_move()s the smb_req somewhere else.
192 uint8 *outbuf;
194 size_t unread_bytes;
195 bool encrypted;
196 connection_struct *conn;
197 struct smbd_server_connection *sconn;
198 struct smb_perfcount_data pcd;
201 * Chained request handling
203 struct files_struct *chain_fsp;
206 * state information for async smb handling
208 void *async_priv;
211 * Back pointer to smb2 request.
213 struct smbd_smb2_request *smb2req;
216 * Pathnames used if request done
217 * under privilege.
219 struct privilege_paths *priv_paths;
222 * Request list for chained requests, we're part of it.
224 struct smb_request **chain;
227 /* Defines for the sent_oplock_break field above. */
228 #define NO_BREAK_SENT 0
229 #define BREAK_TO_NONE_SENT 1
230 #define LEVEL_II_BREAK_SENT 2
232 typedef struct {
233 fstring smb_name; /* user name from the client */
234 fstring unix_name; /* unix user name of a validated user */
235 fstring domain; /* domain that the client specified */
236 } userdom_struct;
238 /* used for network interfaces */
239 struct interface {
240 struct interface *next, *prev;
241 char *name;
242 int flags;
243 struct sockaddr_storage ip;
244 struct sockaddr_storage netmask;
245 struct sockaddr_storage bcast;
248 #define SHARE_MODE_FLAG_POSIX_OPEN 0x1
250 #include "librpc/gen_ndr/server_id.h"
252 /* oplock break message definition - linearization of share_mode_entry.
254 Offset Data length.
255 0 struct server_id pid 4
256 4 uint16 op_mid 8
257 12 uint16 op_type 2
258 14 uint32 access_mask 4
259 18 uint32 share_access 4
260 22 uint32 private_options 4
261 26 uint32 time sec 4
262 30 uint32 time usec 4
263 34 uint64 dev 8 bytes
264 42 uint64 inode 8 bytes
265 50 uint64 extid 8 bytes
266 58 unsigned long file_id 4 bytes
267 62 uint32 uid 4 bytes
268 66 uint16 flags 2 bytes
269 68 uint32 name_hash 4 bytes
274 #define OP_BREAK_MSG_PID_OFFSET 0
275 #define OP_BREAK_MSG_MID_OFFSET 4
276 #define OP_BREAK_MSG_OP_TYPE_OFFSET 12
277 #define OP_BREAK_MSG_ACCESS_MASK_OFFSET 14
278 #define OP_BREAK_MSG_SHARE_ACCESS_OFFSET 18
279 #define OP_BREAK_MSG_PRIV_OFFSET 22
280 #define OP_BREAK_MSG_TIME_SEC_OFFSET 26
281 #define OP_BREAK_MSG_TIME_USEC_OFFSET 30
282 #define OP_BREAK_MSG_DEV_OFFSET 34
283 #define OP_BREAK_MSG_INO_OFFSET 42
284 #define OP_BREAK_MSG_EXTID_OFFSET 50
285 #define OP_BREAK_MSG_FILE_ID_OFFSET 58
286 #define OP_BREAK_MSG_UID_OFFSET 62
287 #define OP_BREAK_MSG_FLAGS_OFFSET 66
288 #define OP_BREAK_MSG_NAME_HASH_OFFSET 68
290 #define OP_BREAK_MSG_VNN_OFFSET 72
291 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 76
293 #define NT_HASH_LEN 16
294 #define LM_HASH_LEN 16
296 /* offsets into message for common items */
297 #define smb_com (NBT_HDR_SIZE+HDR_COM)
298 #define smb_rcls (NBT_HDR_SIZE+HDR_RCLS)
299 #define smb_reh (NBT_HDR_SIZE+HDR_REH)
300 #define smb_err (NBT_HDR_SIZE+HDR_ERR)
301 #define smb_flg (NBT_HDR_SIZE+HDR_FLG)
302 #define smb_flg2 (NBT_HDR_SIZE+HDR_FLG2)
303 #define smb_pidhigh (NBT_HDR_SIZE+HDR_PIDHIGH)
304 #define smb_ss_field (NBT_HDR_SIZE+HDR_SS_FIELD)
305 #define smb_tid (NBT_HDR_SIZE+HDR_TID)
306 #define smb_pid (NBT_HDR_SIZE+HDR_PID)
307 #define smb_uid (NBT_HDR_SIZE+HDR_UID)
308 #define smb_mid (NBT_HDR_SIZE+HDR_MID)
309 #define smb_wct (NBT_HDR_SIZE+HDR_WCT)
310 #define smb_vwv (NBT_HDR_SIZE+HDR_VWV)
311 #define smb_vwv0 (smb_vwv+( 0*2))
312 #define smb_vwv1 (smb_vwv+( 1*2))
313 #define smb_vwv2 (smb_vwv+( 2*2))
314 #define smb_vwv3 (smb_vwv+( 3*2))
315 #define smb_vwv4 (smb_vwv+( 4*2))
316 #define smb_vwv5 (smb_vwv+( 5*2))
317 #define smb_vwv6 (smb_vwv+( 6*2))
318 #define smb_vwv7 (smb_vwv+( 7*2))
319 #define smb_vwv8 (smb_vwv+( 8*2))
320 #define smb_vwv9 (smb_vwv+( 9*2))
321 #define smb_vwv10 (smb_vwv+(10*2))
322 #define smb_vwv11 (smb_vwv+(11*2))
323 #define smb_vwv12 (smb_vwv+(12*2))
324 #define smb_vwv13 (smb_vwv+(13*2))
325 #define smb_vwv14 (smb_vwv+(14*2))
326 #define smb_vwv15 (smb_vwv+(15*2))
327 #define smb_vwv16 (smb_vwv+(16*2))
328 #define smb_vwv17 (smb_vwv+(17*2))
330 /* These are the trans subcommands */
331 #define TRANSACT_SETNAMEDPIPEHANDLESTATE 0x01
332 #define TRANSACT_DCERPCCMD 0x26
333 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
335 /* These are the TRANS2 sub commands */
336 #define TRANSACT2_OPEN 0x00
337 #define TRANSACT2_FINDFIRST 0x01
338 #define TRANSACT2_FINDNEXT 0x02
339 #define TRANSACT2_QFSINFO 0x03
340 #define TRANSACT2_SETFSINFO 0x04
341 #define TRANSACT2_QPATHINFO 0x05
342 #define TRANSACT2_SETPATHINFO 0x06
343 #define TRANSACT2_QFILEINFO 0x07
344 #define TRANSACT2_SETFILEINFO 0x08
345 #define TRANSACT2_FSCTL 0x09
346 #define TRANSACT2_IOCTL 0x0A
347 #define TRANSACT2_FINDNOTIFYFIRST 0x0B
348 #define TRANSACT2_FINDNOTIFYNEXT 0x0C
349 #define TRANSACT2_MKDIR 0x0D
350 #define TRANSACT2_SESSION_SETUP 0x0E
351 #define TRANSACT2_GET_DFS_REFERRAL 0x10
352 #define TRANSACT2_REPORT_DFS_INCONSISTANCY 0x11
354 /* These are the NT transact sub commands. */
355 #define NT_TRANSACT_CREATE 1
356 #define NT_TRANSACT_IOCTL 2
357 #define NT_TRANSACT_SET_SECURITY_DESC 3
358 #define NT_TRANSACT_NOTIFY_CHANGE 4
359 #define NT_TRANSACT_RENAME 5
360 #define NT_TRANSACT_QUERY_SECURITY_DESC 6
361 #define NT_TRANSACT_GET_USER_QUOTA 7
362 #define NT_TRANSACT_SET_USER_QUOTA 8
364 /* These are the NT transact_get_user_quota sub commands */
365 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE 0x0000
366 #define TRANSACT_GET_USER_QUOTA_LIST_START 0x0100
367 #define TRANSACT_GET_USER_QUOTA_FOR_SID 0x0101
369 /* Relevant IOCTL codes */
370 #define IOCTL_QUERY_JOB_INFO 0x530060
372 /* these are the trans2 sub fields for primary requests */
373 #define smb_tpscnt smb_vwv0
374 #define smb_tdscnt smb_vwv1
375 #define smb_mprcnt smb_vwv2
376 #define smb_mdrcnt smb_vwv3
377 #define smb_msrcnt smb_vwv4
378 #define smb_flags smb_vwv5
379 #define smb_timeout smb_vwv6
380 #define smb_pscnt smb_vwv9
381 #define smb_psoff smb_vwv10
382 #define smb_dscnt smb_vwv11
383 #define smb_dsoff smb_vwv12
384 #define smb_suwcnt smb_vwv13
385 #define smb_setup smb_vwv14
386 #define smb_setup0 smb_setup
387 #define smb_setup1 (smb_setup+2)
388 #define smb_setup2 (smb_setup+4)
390 /* these are for the secondary requests */
391 #define smb_spscnt smb_vwv2
392 #define smb_spsoff smb_vwv3
393 #define smb_spsdisp smb_vwv4
394 #define smb_sdscnt smb_vwv5
395 #define smb_sdsoff smb_vwv6
396 #define smb_sdsdisp smb_vwv7
397 #define smb_sfid smb_vwv8
399 /* and these for responses */
400 #define smb_tprcnt smb_vwv0
401 #define smb_tdrcnt smb_vwv1
402 #define smb_prcnt smb_vwv3
403 #define smb_proff smb_vwv4
404 #define smb_prdisp smb_vwv5
405 #define smb_drcnt smb_vwv6
406 #define smb_droff smb_vwv7
407 #define smb_drdisp smb_vwv8
409 /* these are for the NT trans primary request. */
410 #define smb_nt_MaxSetupCount smb_vwv0
411 #define smb_nt_Flags (smb_vwv0 + 1)
412 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
413 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
414 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
415 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
416 #define smb_nt_ParameterCount (smb_vwv0 + 19)
417 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
418 #define smb_nt_DataCount (smb_vwv0 + 27)
419 #define smb_nt_DataOffset (smb_vwv0 + 31)
420 #define smb_nt_SetupCount (smb_vwv0 + 35)
421 #define smb_nt_Function (smb_vwv0 + 36)
422 #define smb_nt_SetupStart (smb_vwv0 + 38)
424 /* these are for the NT trans secondary request. */
425 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
426 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
427 #define smb_nts_ParameterCount (smb_vwv0 + 11)
428 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
429 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
430 #define smb_nts_DataCount (smb_vwv0 + 23)
431 #define smb_nts_DataOffset (smb_vwv0 + 27)
432 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
434 /* these are for the NT trans reply. */
435 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
436 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
437 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
438 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
439 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
440 #define smb_ntr_DataCount (smb_vwv0 + 23)
441 #define smb_ntr_DataOffset (smb_vwv0 + 27)
442 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
444 /* these are for the NT create_and_X */
445 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
446 #define smb_ntcreate_Flags (smb_vwv0 + 7)
447 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
448 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
449 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
450 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
451 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
452 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
453 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
454 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
455 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
457 /* this is used on a TConX. I'm not sure the name is very helpful though */
458 #define SMB_SUPPORT_SEARCH_BITS 0x0001
459 #define SMB_SHARE_IN_DFS 0x0002
461 /* Named pipe write mode flags. Used in writeX calls. */
462 #define PIPE_RAW_MODE 0x4
463 #define PIPE_START_MESSAGE 0x8
465 /* the desired access to use when opening a pipe */
466 #define DESIRED_ACCESS_PIPE 0x2019f
468 /* Mapping of access rights to UNIX perms. */
469 #define UNIX_ACCESS_RWX FILE_GENERIC_ALL
470 #define UNIX_ACCESS_R FILE_GENERIC_READ
471 #define UNIX_ACCESS_W FILE_GENERIC_WRITE
472 #define UNIX_ACCESS_X FILE_GENERIC_EXECUTE
474 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
475 #define UNIX_DIRECTORY_ACCESS_RWX FILE_GENERIC_ALL
476 #define UNIX_DIRECTORY_ACCESS_R FILE_GENERIC_READ
477 #define UNIX_DIRECTORY_ACCESS_W (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
478 #define UNIX_DIRECTORY_ACCESS_X FILE_GENERIC_EXECUTE
480 #if 0
482 * This is the old mapping we used to use. To get W2KSP2 profiles
483 * working we need to map to the canonical file perms.
485 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
486 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
487 FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
488 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
489 FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
490 FILE_APPEND_DATA|FILE_WRITE_DATA)
491 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
492 FILE_EXECUTE|FILE_READ_ATTRIBUTES)
493 #endif
495 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
497 /* Flags field. */
498 #define REQUEST_OPLOCK 2
499 #define REQUEST_BATCH_OPLOCK 4
500 #define OPEN_DIRECTORY 8
501 #define EXTENDED_RESPONSE_REQUIRED 0x10
503 /* ShareAccess field. */
504 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
505 #define FILE_SHARE_READ 1
506 #define FILE_SHARE_WRITE 2
507 #define FILE_SHARE_DELETE 4
509 /* Flags - combined with attributes. */
510 #define FILE_FLAG_WRITE_THROUGH 0x80000000L
511 #define FILE_FLAG_NO_BUFFERING 0x20000000L
512 #define FILE_FLAG_RANDOM_ACCESS 0x10000000L
513 #define FILE_FLAG_SEQUENTIAL_SCAN 0x08000000L
514 #define FILE_FLAG_DELETE_ON_CLOSE 0x04000000L
515 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
516 #define FILE_FLAG_POSIX_SEMANTICS 0x01000000L
518 /* CreateDisposition field. */
519 #define FILE_SUPERSEDE 0 /* File exists overwrite/supersede. File not exist create. */
520 #define FILE_OPEN 1 /* File exists open. File not exist fail. */
521 #define FILE_CREATE 2 /* File exists fail. File not exist create. */
522 #define FILE_OPEN_IF 3 /* File exists open. File not exist create. */
523 #define FILE_OVERWRITE 4 /* File exists overwrite. File not exist fail. */
524 #define FILE_OVERWRITE_IF 5 /* File exists overwrite. File not exist create. */
526 /* CreateOptions field. */
527 #define FILE_DIRECTORY_FILE 0x0001
528 #define FILE_WRITE_THROUGH 0x0002
529 #define FILE_SEQUENTIAL_ONLY 0x0004
530 #define FILE_NO_INTERMEDIATE_BUFFERING 0x0008
531 #define FILE_SYNCHRONOUS_IO_ALERT 0x0010 /* may be ignored */
532 #define FILE_SYNCHRONOUS_IO_NONALERT 0x0020 /* may be ignored */
533 #define FILE_NON_DIRECTORY_FILE 0x0040
534 #define FILE_CREATE_TREE_CONNECTION 0x0080 /* ignore, should be zero */
535 #define FILE_COMPLETE_IF_OPLOCKED 0x0100 /* ignore, should be zero */
536 #define FILE_NO_EA_KNOWLEDGE 0x0200
537 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400 /* aka OPEN_FOR_RECOVERY: ignore, should be zero */
538 #define FILE_RANDOM_ACCESS 0x0800
539 #define FILE_DELETE_ON_CLOSE 0x1000
540 #define FILE_OPEN_BY_FILE_ID 0x2000
541 #define FILE_OPEN_FOR_BACKUP_INTENT 0x4000
542 #define FILE_NO_COMPRESSION 0x8000
543 #define FILE_RESERVER_OPFILTER 0x00100000 /* ignore, should be zero */
544 #define FILE_OPEN_REPARSE_POINT 0x00200000
545 #define FILE_OPEN_NO_RECALL 0x00400000
546 #define FILE_OPEN_FOR_FREE_SPACE_QUERY 0x00800000 /* ignore should be zero */
548 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK (0x008F0480)
550 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK (0xFF100030)
553 * Private create options used by the ntcreatex processing code. From Samba4.
554 * We reuse some ignored flags for private use. Passed in the private_flags
555 * argument.
557 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS 0x0001
558 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB 0x0002
560 /* Private options for streams support */
561 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x0004
563 /* Private options for printer support */
564 #define NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE 0x0008
566 /* Responses when opening a file. */
567 #define FILE_WAS_SUPERSEDED 0
568 #define FILE_WAS_OPENED 1
569 #define FILE_WAS_CREATED 2
570 #define FILE_WAS_OVERWRITTEN 3
572 /* Flag for NT transact rename call. */
573 #define RENAME_REPLACE_IF_EXISTS 1
575 /* flags for SMBntrename call (from Samba4) */
576 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
577 #define RENAME_FLAG_HARD_LINK 0x103
578 #define RENAME_FLAG_RENAME 0x104
579 #define RENAME_FLAG_COPY 0x105
581 /* Filesystem Attributes. */
582 #define FILE_CASE_SENSITIVE_SEARCH 0x00000001
583 #define FILE_CASE_PRESERVED_NAMES 0x00000002
584 #define FILE_UNICODE_ON_DISK 0x00000004
585 /* According to cifs9f, this is 4, not 8 */
586 /* Acconding to testing, this actually sets the security attribute! */
587 #define FILE_PERSISTENT_ACLS 0x00000008
588 #define FILE_FILE_COMPRESSION 0x00000010
589 #define FILE_VOLUME_QUOTAS 0x00000020
590 #define FILE_SUPPORTS_SPARSE_FILES 0x00000040
591 #define FILE_SUPPORTS_REPARSE_POINTS 0x00000080
592 #define FILE_SUPPORTS_REMOTE_STORAGE 0x00000100
593 #define FS_LFN_APIS 0x00004000
594 #define FILE_VOLUME_IS_COMPRESSED 0x00008000
595 #define FILE_SUPPORTS_OBJECT_IDS 0x00010000
596 #define FILE_SUPPORTS_ENCRYPTION 0x00020000
597 #define FILE_NAMED_STREAMS 0x00040000
598 #define FILE_READ_ONLY_VOLUME 0x00080000
600 /* ChangeNotify flags. */
601 #define FILE_NOTIFY_CHANGE_FILE_NAME 0x001
602 #define FILE_NOTIFY_CHANGE_DIR_NAME 0x002
603 #define FILE_NOTIFY_CHANGE_ATTRIBUTES 0x004
604 #define FILE_NOTIFY_CHANGE_SIZE 0x008
605 #define FILE_NOTIFY_CHANGE_LAST_WRITE 0x010
606 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
607 #define FILE_NOTIFY_CHANGE_CREATION 0x040
608 #define FILE_NOTIFY_CHANGE_EA 0x080
609 #define FILE_NOTIFY_CHANGE_SECURITY 0x100
610 #define FILE_NOTIFY_CHANGE_STREAM_NAME 0x00000200
611 #define FILE_NOTIFY_CHANGE_STREAM_SIZE 0x00000400
612 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
614 #define FILE_NOTIFY_CHANGE_NAME \
615 (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
617 #define FILE_NOTIFY_CHANGE_ALL \
618 (FILE_NOTIFY_CHANGE_FILE_NAME | FILE_NOTIFY_CHANGE_DIR_NAME | \
619 FILE_NOTIFY_CHANGE_ATTRIBUTES | FILE_NOTIFY_CHANGE_SIZE | \
620 FILE_NOTIFY_CHANGE_LAST_WRITE | FILE_NOTIFY_CHANGE_LAST_ACCESS | \
621 FILE_NOTIFY_CHANGE_CREATION | FILE_NOTIFY_CHANGE_EA | \
622 FILE_NOTIFY_CHANGE_SECURITY | FILE_NOTIFY_CHANGE_STREAM_NAME | \
623 FILE_NOTIFY_CHANGE_STREAM_SIZE | FILE_NOTIFY_CHANGE_STREAM_WRITE)
625 /* change notify action results */
626 #define NOTIFY_ACTION_ADDED 1
627 #define NOTIFY_ACTION_REMOVED 2
628 #define NOTIFY_ACTION_MODIFIED 3
629 #define NOTIFY_ACTION_OLD_NAME 4
630 #define NOTIFY_ACTION_NEW_NAME 5
631 #define NOTIFY_ACTION_ADDED_STREAM 6
632 #define NOTIFY_ACTION_REMOVED_STREAM 7
633 #define NOTIFY_ACTION_MODIFIED_STREAM 8
636 /* where to find the base of the SMB packet proper */
637 #define smb_base(buf) (((const char *)(buf))+4)
639 /* we don't allow server strings to be longer than 48 characters as
640 otherwise NT will not honour the announce packets */
641 #define MAX_SERVER_STRING_LENGTH 48
644 #define SMB_SUCCESS 0 /* The request was successful. */
646 #ifdef WITH_DFS
647 void dfs_unlogin(void);
648 extern int dcelogin_atmost_once;
649 #endif
651 #ifdef NOSTRDUP
652 char *strdup(char *s);
653 #endif
655 #ifndef SELECT_CAST
656 #define SELECT_CAST
657 #endif
659 /* This was set by JHT in liaison with Jeremy Allison early 1997
660 * History:
661 * Version 4.0 - never made public
662 * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
663 * - Reappeared in 1.9.16p11 with fixed smbd services
664 * Version 4.20 - To indicate that nmbd and browsing now works better
665 * Version 4.50 - Set at release of samba-2.2.0 by JHT
667 * Note: In the presence of NT4.X do not set above 4.9
668 * Setting this above 4.9 can have undesired side-effects.
669 * This may change again in Samba-3.0 after further testing. JHT
672 #define SAMBA_MAJOR_NBT_ANNOUNCE_VERSION 0x04
673 #define SAMBA_MINOR_NBT_ANNOUNCE_VERSION 0x09
675 /* Browser Election Values */
676 #define BROWSER_ELECTION_VERSION 0x010f
677 #define BROWSER_CONSTANT 0xaa55
679 /* TCONX Flag (smb_vwv2). */
680 #define TCONX_FLAG_EXTENDED_RESPONSE 0x8
682 /* File Status Flags. See:
684 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
687 #define NO_EAS 0x1
688 #define NO_SUBSTREAMS 0x2
689 #define NO_REPARSETAG 0x4
691 /* printing types */
692 enum printing_types {PRINT_BSD,PRINT_SYSV,PRINT_AIX,PRINT_HPUX,
693 PRINT_QNX,PRINT_PLP,PRINT_LPRNG,PRINT_SOFTQ,
694 PRINT_CUPS,PRINT_LPRNT,PRINT_LPROS2,PRINT_IPRINT
695 #if defined(DEVELOPER) || defined(ENABLE_BUILD_FARM_HACKS)
696 ,PRINT_TEST,PRINT_VLP
697 #endif /* DEVELOPER */
700 /* LDAP SSL options */
701 enum ldap_ssl_types {LDAP_SSL_OFF, LDAP_SSL_START_TLS};
703 /* LDAP PASSWD SYNC methods */
704 enum ldap_passwd_sync_types {LDAP_PASSWD_SYNC_ON, LDAP_PASSWD_SYNC_OFF, LDAP_PASSWD_SYNC_ONLY};
707 * This should be under the HAVE_KRB5 flag but since they're used
708 * in lp_kerberos_method(), they ned to be always available
709 * If you add any entries to KERBEROS_VERIFY defines, please modify USE.*KEYTAB macros
710 * so they remain accurate.
713 #define KERBEROS_VERIFY_SECRETS 0
714 #define KERBEROS_VERIFY_SYSTEM_KEYTAB 1
715 #define KERBEROS_VERIFY_DEDICATED_KEYTAB 2
716 #define KERBEROS_VERIFY_SECRETS_AND_KEYTAB 3
718 /* Remote architectures we know about. */
719 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
720 RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
721 RA_SAMBA, RA_CIFSFS, RA_WINXP64, RA_OSX};
723 /* case handling */
724 enum case_handling {CASE_LOWER,CASE_UPPER};
726 /* ACL compatibility */
727 enum acl_compatibility {ACL_COMPAT_AUTO, ACL_COMPAT_WINNT, ACL_COMPAT_WIN2K};
729 * Global value meaing that the smb_uid field should be
730 * ingored (in share level security and protocol level == CORE)
733 #define UID_FIELD_INVALID 0
734 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
737 * Size of buffer to use when moving files across filesystems.
739 #define COPYBUF_SIZE (8*1024)
742 * Map the Core and Extended Oplock requesst bits down
743 * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
747 * Core protocol.
749 #define CORE_OPLOCK_REQUEST(inbuf) \
750 ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
753 * Extended protocol.
755 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
758 * Bits we test with.
759 * Note these must fit into 16-bits.
762 #define NO_OPLOCK OPLOCK_NONE
763 #define EXCLUSIVE_OPLOCK OPLOCK_EXCLUSIVE
764 #define BATCH_OPLOCK OPLOCK_BATCH
765 #define LEVEL_II_OPLOCK OPLOCK_LEVEL_II
767 /* The following are Samba-private. */
768 #define INTERNAL_OPEN_ONLY 0x8
769 #define FAKE_LEVEL_II_OPLOCK 0x10 /* Client requested no_oplock, but we have to
770 * inform potential level2 holders on
771 * write. */
772 #define DEFERRED_OPEN_ENTRY 0x20
773 /* #define UNUSED_SHARE_MODE_ENTRY 0x40 */ /* Not used anymore */
774 #define FORCE_OPLOCK_BREAK_TO_NONE 0x80
776 /* None of the following should ever appear in fsp->oplock_request. */
777 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
779 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
780 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
781 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
783 /* kernel_oplock_message definition.
785 struct kernel_oplock_message {
786 uint64_t dev;
787 uint64_t inode;
788 unit64_t extid;
789 unsigned long file_id;
792 Offset Data length.
793 0 uint64_t dev 8 bytes
794 8 uint64_t inode 8 bytes
795 16 uint64_t extid 8 bytes
796 24 unsigned long file_id 4 bytes
800 #define MSG_SMB_KERNEL_BREAK_SIZE 28
802 /* file_renamed_message definition.
804 struct file_renamed_message {
805 uint64_t dev;
806 uint64_t inode;
807 char names[1]; A variable area containing sharepath and filename.
810 Offset Data length.
811 0 uint64_t dev 8 bytes
812 8 uint64_t inode 8 bytes
813 16 unit64_t extid 8 bytes
814 24 char [] name zero terminated namelen bytes
815 minimum length == 24.
819 #define MSG_FILE_RENAMED_MIN_SIZE 24
822 * On the wire return values for oplock types.
825 #define CORE_OPLOCK_GRANTED (1<<5)
826 #define EXTENDED_OPLOCK_GRANTED (1<<15)
828 #define NO_OPLOCK_RETURN 0
829 #define EXCLUSIVE_OPLOCK_RETURN 1
830 #define BATCH_OPLOCK_RETURN 2
831 #define LEVEL_II_OPLOCK_RETURN 3
833 /* Oplock levels */
834 #define OPLOCKLEVEL_NONE 0
835 #define OPLOCKLEVEL_II 1
838 * Capabilities abstracted for different systems.
841 enum smbd_capability {
842 KERNEL_OPLOCK_CAPABILITY,
843 DMAPI_ACCESS_CAPABILITY,
844 LEASE_CAPABILITY
848 * Kernel oplocks capability flags.
851 /* Level 2 oplocks are supported natively by kernel oplocks. */
852 #define KOPLOCKS_LEVEL2_SUPPORTED 0x1
854 /* The kernel notifies deferred openers when they can retry the open. */
855 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION 0x2
857 /* The kernel notifies smbds when an oplock break times out. */
858 #define KOPLOCKS_TIMEOUT_NOTIFICATION 0x4
860 /* The kernel notifies smbds when an oplock is broken. */
861 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION 0x8
863 struct kernel_oplocks_ops;
864 struct kernel_oplocks {
865 const struct kernel_oplocks_ops *ops;
866 uint32_t flags;
867 void *private_data;
870 enum level2_contention_type {
871 LEVEL2_CONTEND_ALLOC_SHRINK,
872 LEVEL2_CONTEND_ALLOC_GROW,
873 LEVEL2_CONTEND_SET_FILE_LEN,
874 LEVEL2_CONTEND_FILL_SPARSE,
875 LEVEL2_CONTEND_WRITE,
876 LEVEL2_CONTEND_WINDOWS_BRL,
877 LEVEL2_CONTEND_POSIX_BRL
880 /* if a kernel does support oplocks then a structure of the following
881 typee is used to describe how to interact with the kernel */
882 struct kernel_oplocks_ops {
883 bool (*set_oplock)(struct kernel_oplocks *ctx,
884 files_struct *fsp, int oplock_type);
885 void (*release_oplock)(struct kernel_oplocks *ctx,
886 files_struct *fsp, int oplock_type);
887 void (*contend_level2_oplocks_begin)(files_struct *fsp,
888 enum level2_contention_type type);
889 void (*contend_level2_oplocks_end)(files_struct *fsp,
890 enum level2_contention_type type);
893 #include "smb_macros.h"
895 #define MAX_NETBIOSNAME_LEN 16
896 /* DOS character, NetBIOS namestring. Type used on the wire. */
897 typedef char nstring[MAX_NETBIOSNAME_LEN];
898 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
899 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
901 /* A netbios name structure. */
902 struct nmb_name {
903 nstring name;
904 char scope[64];
905 unsigned int name_type;
908 /* A netbios node status array element. */
909 struct node_status {
910 nstring name;
911 unsigned char type;
912 unsigned char flags;
915 /* The extra info from a NetBIOS node status query */
916 struct node_status_extra {
917 unsigned char mac_addr[6];
918 /* There really is more here ... */
921 typedef struct user_struct {
922 struct user_struct *next, *prev;
923 uint16 vuid; /* Tag for this entry. */
925 char *session_keystr; /* used by utmp and pam session code.
926 TDB key string */
927 int homes_snum;
929 struct auth_session_info *session_info;
931 struct gensec_security *gensec_security;
932 } user_struct;
935 Do you want session setups at user level security with a invalid
936 password to be rejected or allowed in as guest? WinNT rejects them
937 but it can be a pain as it means "net view" needs to use a password
939 You have 3 choices in the setting of map_to_guest:
941 "NEVER_MAP_TO_GUEST" means session setups with an invalid password
942 are rejected. This is the default.
944 "MAP_TO_GUEST_ON_BAD_USER" means session setups with an invalid password
945 are rejected, unless the username does not exist, in which case it
946 is treated as a guest login
948 "MAP_TO_GUEST_ON_BAD_PASSWORD" means session setups with an invalid password
949 are treated as a guest login
951 Note that map_to_guest only has an effect in user or server
952 level security.
955 #define NEVER_MAP_TO_GUEST 0
956 #define MAP_TO_GUEST_ON_BAD_USER 1
957 #define MAP_TO_GUEST_ON_BAD_PASSWORD 2
958 #define MAP_TO_GUEST_ON_BAD_UID 3
960 #define SAFE_NETBIOS_CHARS ". -_"
962 /* The maximum length of a trust account password.
963 Used when we randomly create it, 15 char passwords
964 exceed NT4's max password length */
966 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
968 #define PORT_NONE 0
969 #ifndef LDAP_PORT
970 #define LDAP_PORT 389
971 #endif
972 #define LDAP_GC_PORT 3268
974 /* used by the IP comparison function */
975 struct ip_service {
976 struct sockaddr_storage ss;
977 unsigned port;
980 struct ea_struct {
981 uint8 flags;
982 char *name;
983 DATA_BLOB value;
986 struct ea_list {
987 struct ea_list *next, *prev;
988 struct ea_struct ea;
991 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
992 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
993 /* EA to use for DOS attributes */
994 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
995 /* Prefix for DosStreams in the vfs_streams_xattr module */
996 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
997 /* Prefix for xattrs storing streams. */
998 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
1000 /* map readonly options */
1001 enum mapreadonly_options {MAP_READONLY_NO, MAP_READONLY_YES, MAP_READONLY_PERMISSIONS};
1003 /* usershare error codes. */
1004 enum usershare_err {
1005 USERSHARE_OK=0,
1006 USERSHARE_MALFORMED_FILE,
1007 USERSHARE_BAD_VERSION,
1008 USERSHARE_MALFORMED_PATH,
1009 USERSHARE_MALFORMED_COMMENT_DEF,
1010 USERSHARE_MALFORMED_ACL_DEF,
1011 USERSHARE_ACL_ERR,
1012 USERSHARE_PATH_NOT_ABSOLUTE,
1013 USERSHARE_PATH_IS_DENIED,
1014 USERSHARE_PATH_NOT_ALLOWED,
1015 USERSHARE_PATH_NOT_DIRECTORY,
1016 USERSHARE_POSIX_ERR,
1017 USERSHARE_MALFORMED_SHARENAME_DEF,
1018 USERSHARE_BAD_SHARENAME
1021 /* Different reasons for closing a file. */
1022 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
1024 /* Used in SMB_FS_OBJECTID_INFORMATION requests. Must be exactly 48 bytes. */
1025 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
1026 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
1027 struct smb_extended_info {
1028 uint32 samba_magic; /* Always SAMBA_EXTRA_INFO_MAGIC */
1029 uint32 samba_version; /* Major/Minor/Release/Revision */
1030 uint32 samba_subversion; /* Prerelease/RC/Vendor patch */
1031 NTTIME samba_gitcommitdate;
1032 char samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
1035 /* Used inside aio code. */
1036 struct aio_extra;
1039 * Reasons for cache flush.
1042 enum flush_reason_enum {
1043 SEEK_FLUSH,
1044 READ_FLUSH,
1045 WRITE_FLUSH,
1046 READRAW_FLUSH,
1047 OPLOCK_RELEASE_FLUSH,
1048 CLOSE_FLUSH,
1049 SYNC_FLUSH,
1050 SIZECHANGE_FLUSH,
1051 /* NUM_FLUSH_REASONS must remain the last value in the enumeration. */
1052 NUM_FLUSH_REASONS};
1054 #endif /* _SMB_H */