source3/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 3 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, see <http://www.gnu.org/licenses/>.
  24 */
  25
  26 #ifndef _SMB_H
  27 #define _SMB_H
  28
  29 #include "libcli/smb/smb_common.h"
  30 #include "libds/common/roles.h"
  31
  32 /* logged when starting the various Samba daemons */
  33 #define COPYRIGHT_STARTUP_MESSAGE       "Copyright Andrew Tridgell and the Samba Team 1992-2012"
  34
  35
  36 #define BUFFER_SIZE (128*1024)
  37
  38 #define SAFETY_MARGIN 1024
  39 #define LARGE_WRITEX_HDR_SIZE 65
  40
  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"
  46
  47 #define Undefined (-1)
  48 #define False false
  49 #define True true
  50 #define Auto (2)
  51 #define Required (3)
  52
  53 #define SIZEOFWORD 2
  54
  55 #ifndef DEF_CREATE_MASK
  56 #define DEF_CREATE_MASK (0755)
  57 #endif
  58
  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
  66
  67 /* how long to wait for secondary SMB packets (milli-seconds) */
  68 #define SMB_SECONDARY_WAIT (60*1000)
  69
  70 #define DIR_STRUCT_SIZE 43
  71
  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
  79
  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
  86
  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)
  95
  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)
  99
 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
 104
 105 /* mask for open disposition. */
 106 #define OPENX_FILE_OPEN_MASK 0x3
 107
 108 #define GET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
 109 #define SET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
 110
 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
 114
 115 /* pipe string names */
 116
 117 #ifndef MAXSUBAUTHS
 118 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
 119 #endif
 120
 121 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
 122
 123 #include "librpc/gen_ndr/security.h"
 124
 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;
 132
 133 /* the basic packet size, assuming no words or bytes */
 134 #define smb_size 39
 135
 136 struct notify_change {
 137         uint32_t action;
 138         const char *name;
 139 };
 140
 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 */
 149 };
 150
 151 #include "ntquotas.h"
 152 #include "sysquotas.h"
 153
 154 /* Include VFS stuff */
 155
 156 #include "smb_acls.h"
 157 /*
 158  * smbXsrv.h: currently needed for vfs.h, as long as
 159  * the smbXsrv structures are still referenced as a
 160  * backling from files_struct and connection_struct.
 161  */
 162 #include "librpc/gen_ndr/smbXsrv.h"
 163 #include "vfs.h"
 164
 165 struct current_user {
 166         struct connection_struct *conn;
 167         uint64_t vuid; /* SMB2 compat */
 168         struct security_unix_token ut;
 169         struct security_token *nt_user_token;
 170 };
 171
 172 /* Defines for the sent_oplock_break field above. */
 173 #define NO_BREAK_SENT 0
 174 #define BREAK_TO_NONE_SENT 1
 175 #define LEVEL_II_BREAK_SENT 2
 176
 177 typedef struct {
 178         fstring smb_name; /* user name from the client */
 179         fstring unix_name; /* unix user name of a validated user */
 180         fstring domain; /* domain that the client specified */
 181 } userdom_struct;
 182
 183 /* used for network interfaces */
 184 struct interface {
 185         struct interface *next, *prev;
 186         char *name;
 187         int flags;
 188         struct sockaddr_storage ip;
 189         struct sockaddr_storage netmask;
 190         struct sockaddr_storage bcast;
 191 };
 192
 193 #define SHARE_MODE_FLAG_POSIX_OPEN      0x1
 194
 195 #include "librpc/gen_ndr/server_id.h"
 196
 197 /* oplock break message definition - linearization of share_mode_entry.
 198
 199 Offset  Data                    length.
 200 0       struct server_id pid    4
 201 4       uint16 op_mid           8
 202 12      uint16 op_type          2
 203 14      uint32 access_mask      4
 204 18      uint32 share_access     4
 205 22      uint32 private_options  4
 206 26      uint32 time sec         4
 207 30      uint32 time usec        4
 208 34      uint64 dev              8 bytes
 209 42      uint64 inode            8 bytes
 210 50      uint64 extid            8 bytes
 211 58      unsigned long file_id   4 bytes
 212 62      uint32 uid              4 bytes
 213 66      uint16 flags            2 bytes
 214 68      uint32 name_hash        4 bytes
 215 72
 216
 217 */
 218
 219 #define OP_BREAK_MSG_PID_OFFSET 0
 220 #define OP_BREAK_MSG_MID_OFFSET 4
 221 #define OP_BREAK_MSG_OP_TYPE_OFFSET 12
 222 #define OP_BREAK_MSG_ACCESS_MASK_OFFSET 14
 223 #define OP_BREAK_MSG_SHARE_ACCESS_OFFSET 18
 224 #define OP_BREAK_MSG_PRIV_OFFSET 22
 225 #define OP_BREAK_MSG_TIME_SEC_OFFSET 26
 226 #define OP_BREAK_MSG_TIME_USEC_OFFSET 30
 227 #define OP_BREAK_MSG_DEV_OFFSET 34
 228 #define OP_BREAK_MSG_INO_OFFSET 42
 229 #define OP_BREAK_MSG_EXTID_OFFSET 50
 230 #define OP_BREAK_MSG_FILE_ID_OFFSET 58
 231 #define OP_BREAK_MSG_UID_OFFSET 62
 232 #define OP_BREAK_MSG_FLAGS_OFFSET 66
 233 #define OP_BREAK_MSG_NAME_HASH_OFFSET 68
 234
 235 #define OP_BREAK_MSG_VNN_OFFSET 72
 236 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 76
 237
 238 #define NT_HASH_LEN 16
 239 #define LM_HASH_LEN 16
 240
 241 /* offsets into message for common items */
 242 #define smb_com         (NBT_HDR_SIZE+HDR_COM)
 243 #define smb_rcls        (NBT_HDR_SIZE+HDR_RCLS)
 244 #define smb_reh         (NBT_HDR_SIZE+HDR_REH)
 245 #define smb_err         (NBT_HDR_SIZE+HDR_ERR)
 246 #define smb_flg         (NBT_HDR_SIZE+HDR_FLG)
 247 #define smb_flg2        (NBT_HDR_SIZE+HDR_FLG2)
 248 #define smb_pidhigh     (NBT_HDR_SIZE+HDR_PIDHIGH)
 249 #define smb_ss_field    (NBT_HDR_SIZE+HDR_SS_FIELD)
 250 #define smb_tid         (NBT_HDR_SIZE+HDR_TID)
 251 #define smb_pid         (NBT_HDR_SIZE+HDR_PID)
 252 #define smb_uid         (NBT_HDR_SIZE+HDR_UID)
 253 #define smb_mid         (NBT_HDR_SIZE+HDR_MID)
 254 #define smb_wct         (NBT_HDR_SIZE+HDR_WCT)
 255 #define smb_vwv         (NBT_HDR_SIZE+HDR_VWV)
 256 #define smb_vwv0        (smb_vwv+( 0*2))
 257 #define smb_vwv1        (smb_vwv+( 1*2))
 258 #define smb_vwv2        (smb_vwv+( 2*2))
 259 #define smb_vwv3        (smb_vwv+( 3*2))
 260 #define smb_vwv4        (smb_vwv+( 4*2))
 261 #define smb_vwv5        (smb_vwv+( 5*2))
 262 #define smb_vwv6        (smb_vwv+( 6*2))
 263 #define smb_vwv7        (smb_vwv+( 7*2))
 264 #define smb_vwv8        (smb_vwv+( 8*2))
 265 #define smb_vwv9        (smb_vwv+( 9*2))
 266 #define smb_vwv10       (smb_vwv+(10*2))
 267 #define smb_vwv11       (smb_vwv+(11*2))
 268 #define smb_vwv12       (smb_vwv+(12*2))
 269 #define smb_vwv13       (smb_vwv+(13*2))
 270 #define smb_vwv14       (smb_vwv+(14*2))
 271 #define smb_vwv15       (smb_vwv+(15*2))
 272 #define smb_vwv16       (smb_vwv+(16*2))
 273 #define smb_vwv17       (smb_vwv+(17*2))
 274
 275 /* These are the trans subcommands */
 276 #define TRANSACT_SETNAMEDPIPEHANDLESTATE  0x01
 277 #define TRANSACT_DCERPCCMD                0x26
 278 #define TRANSACT_WAITNAMEDPIPEHANDLESTATE 0x53
 279
 280 /* These are the TRANS2 sub commands */
 281 #define TRANSACT2_OPEN                          0x00
 282 #define TRANSACT2_FINDFIRST                     0x01
 283 #define TRANSACT2_FINDNEXT                      0x02
 284 #define TRANSACT2_QFSINFO                       0x03
 285 #define TRANSACT2_SETFSINFO                     0x04
 286 #define TRANSACT2_QPATHINFO                     0x05
 287 #define TRANSACT2_SETPATHINFO                   0x06
 288 #define TRANSACT2_QFILEINFO                     0x07
 289 #define TRANSACT2_SETFILEINFO                   0x08
 290 #define TRANSACT2_FSCTL                         0x09
 291 #define TRANSACT2_IOCTL                         0x0A
 292 #define TRANSACT2_FINDNOTIFYFIRST               0x0B
 293 #define TRANSACT2_FINDNOTIFYNEXT                0x0C
 294 #define TRANSACT2_MKDIR                         0x0D
 295 #define TRANSACT2_SESSION_SETUP                 0x0E
 296 #define TRANSACT2_GET_DFS_REFERRAL              0x10
 297 #define TRANSACT2_REPORT_DFS_INCONSISTANCY      0x11
 298
 299 /* These are the NT transact sub commands. */
 300 #define NT_TRANSACT_CREATE                1
 301 #define NT_TRANSACT_IOCTL                 2
 302 #define NT_TRANSACT_SET_SECURITY_DESC     3
 303 #define NT_TRANSACT_NOTIFY_CHANGE         4
 304 #define NT_TRANSACT_RENAME                5
 305 #define NT_TRANSACT_QUERY_SECURITY_DESC   6
 306 #define NT_TRANSACT_GET_USER_QUOTA        7
 307 #define NT_TRANSACT_SET_USER_QUOTA        8
 308
 309 /* These are the NT transact_get_user_quota sub commands */
 310 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE   0x0000
 311 #define TRANSACT_GET_USER_QUOTA_LIST_START      0x0100
 312 #define TRANSACT_GET_USER_QUOTA_FOR_SID         0x0101
 313
 314 /* Relevant IOCTL codes */
 315 #define IOCTL_QUERY_JOB_INFO      0x530060
 316
 317 /* these are the trans2 sub fields for primary requests */
 318 #define smb_tpscnt smb_vwv0
 319 #define smb_tdscnt smb_vwv1
 320 #define smb_mprcnt smb_vwv2
 321 #define smb_mdrcnt smb_vwv3
 322 #define smb_msrcnt smb_vwv4
 323 #define smb_flags smb_vwv5
 324 #define smb_timeout smb_vwv6
 325 #define smb_pscnt smb_vwv9
 326 #define smb_psoff smb_vwv10
 327 #define smb_dscnt smb_vwv11
 328 #define smb_dsoff smb_vwv12
 329 #define smb_suwcnt smb_vwv13
 330 #define smb_setup smb_vwv14
 331 #define smb_setup0 smb_setup
 332 #define smb_setup1 (smb_setup+2)
 333 #define smb_setup2 (smb_setup+4)
 334
 335 /* these are for the secondary requests */
 336 #define smb_spscnt smb_vwv2
 337 #define smb_spsoff smb_vwv3
 338 #define smb_spsdisp smb_vwv4
 339 #define smb_sdscnt smb_vwv5
 340 #define smb_sdsoff smb_vwv6
 341 #define smb_sdsdisp smb_vwv7
 342 #define smb_sfid smb_vwv8
 343
 344 /* and these for responses */
 345 #define smb_tprcnt smb_vwv0
 346 #define smb_tdrcnt smb_vwv1
 347 #define smb_prcnt smb_vwv3
 348 #define smb_proff smb_vwv4
 349 #define smb_prdisp smb_vwv5
 350 #define smb_drcnt smb_vwv6
 351 #define smb_droff smb_vwv7
 352 #define smb_drdisp smb_vwv8
 353
 354 /* these are for the NT trans primary request. */
 355 #define smb_nt_MaxSetupCount smb_vwv0
 356 #define smb_nt_Flags (smb_vwv0 + 1)
 357 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
 358 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
 359 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
 360 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
 361 #define smb_nt_ParameterCount (smb_vwv0 + 19)
 362 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
 363 #define smb_nt_DataCount (smb_vwv0 + 27)
 364 #define smb_nt_DataOffset (smb_vwv0 + 31)
 365 #define smb_nt_SetupCount (smb_vwv0 + 35)
 366 #define smb_nt_Function (smb_vwv0 + 36)
 367 #define smb_nt_SetupStart (smb_vwv0 + 38)
 368
 369 /* these are for the NT trans secondary request. */
 370 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
 371 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
 372 #define smb_nts_ParameterCount (smb_vwv0 + 11)
 373 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
 374 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
 375 #define smb_nts_DataCount (smb_vwv0 + 23)
 376 #define smb_nts_DataOffset (smb_vwv0 + 27)
 377 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
 378
 379 /* these are for the NT trans reply. */
 380 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
 381 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
 382 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
 383 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
 384 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
 385 #define smb_ntr_DataCount (smb_vwv0 + 23)
 386 #define smb_ntr_DataOffset (smb_vwv0 + 27)
 387 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
 388
 389 /* these are for the NT create_and_X */
 390 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
 391 #define smb_ntcreate_Flags (smb_vwv0 + 7)
 392 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
 393 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
 394 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
 395 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
 396 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
 397 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
 398 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
 399 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
 400 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
 401
 402 /* this is used on a TConX. I'm not sure the name is very helpful though */
 403 #define SMB_SUPPORT_SEARCH_BITS        0x0001
 404 #define SMB_SHARE_IN_DFS               0x0002
 405
 406 /* Named pipe write mode flags. Used in writeX calls. */
 407 #define PIPE_RAW_MODE 0x4
 408 #define PIPE_START_MESSAGE 0x8
 409
 410 /* the desired access to use when opening a pipe */
 411 #define DESIRED_ACCESS_PIPE 0x2019f
 412
 413 /* Mapping of access rights to UNIX perms. */
 414 #define UNIX_ACCESS_RWX         FILE_GENERIC_ALL
 415 #define UNIX_ACCESS_R           FILE_GENERIC_READ
 416 #define UNIX_ACCESS_W           FILE_GENERIC_WRITE
 417 #define UNIX_ACCESS_X           FILE_GENERIC_EXECUTE
 418
 419 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
 420 #define UNIX_DIRECTORY_ACCESS_RWX               FILE_GENERIC_ALL
 421 #define UNIX_DIRECTORY_ACCESS_R                 FILE_GENERIC_READ
 422 #define UNIX_DIRECTORY_ACCESS_W                 (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
 423 #define UNIX_DIRECTORY_ACCESS_X                 FILE_GENERIC_EXECUTE
 424
 425 #if 0
 426 /*
 427  * This is the old mapping we used to use. To get W2KSP2 profiles
 428  * working we need to map to the canonical file perms.
 429  */
 430 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
 431 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
 432                         FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
 433 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
 434                         FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
 435                         FILE_APPEND_DATA|FILE_WRITE_DATA)
 436 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
 437                         FILE_EXECUTE|FILE_READ_ATTRIBUTES)
 438 #endif
 439
 440 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
 441
 442 /* Flags field. */
 443 #define REQUEST_OPLOCK 2
 444 #define REQUEST_BATCH_OPLOCK 4
 445 #define OPEN_DIRECTORY 8
 446 #define EXTENDED_RESPONSE_REQUIRED 0x10
 447
 448 /* ShareAccess field. */
 449 #define FILE_SHARE_NONE 0 /* Cannot be used in bitmask. */
 450 #define FILE_SHARE_READ 1
 451 #define FILE_SHARE_WRITE 2
 452 #define FILE_SHARE_DELETE 4
 453
 454 /* Flags - combined with attributes. */
 455 #define FILE_FLAG_WRITE_THROUGH    0x80000000L
 456 #define FILE_FLAG_NO_BUFFERING     0x20000000L
 457 #define FILE_FLAG_RANDOM_ACCESS    0x10000000L
 458 #define FILE_FLAG_SEQUENTIAL_SCAN  0x08000000L
 459 #define FILE_FLAG_DELETE_ON_CLOSE  0x04000000L
 460 #define FILE_FLAG_BACKUP_SEMANTICS 0x02000000L
 461 #define FILE_FLAG_POSIX_SEMANTICS  0x01000000L
 462
 463 /* CreateDisposition field. */
 464 #define FILE_SUPERSEDE 0                /* File exists overwrite/supersede. File not exist create. */
 465 #define FILE_OPEN 1                     /* File exists open. File not exist fail. */
 466 #define FILE_CREATE 2                   /* File exists fail. File not exist create. */
 467 #define FILE_OPEN_IF 3                  /* File exists open. File not exist create. */
 468 #define FILE_OVERWRITE 4                /* File exists overwrite. File not exist fail. */
 469 #define FILE_OVERWRITE_IF 5             /* File exists overwrite. File not exist create. */
 470
 471 /* CreateOptions field. */
 472 #define FILE_DIRECTORY_FILE       0x0001
 473 #define FILE_WRITE_THROUGH        0x0002
 474 #define FILE_SEQUENTIAL_ONLY      0x0004
 475 #define FILE_NO_INTERMEDIATE_BUFFERING 0x0008
 476 #define FILE_SYNCHRONOUS_IO_ALERT      0x0010   /* may be ignored */
 477 #define FILE_SYNCHRONOUS_IO_NONALERT   0x0020   /* may be ignored */
 478 #define FILE_NON_DIRECTORY_FILE   0x0040
 479 #define FILE_CREATE_TREE_CONNECTION    0x0080   /* ignore, should be zero */
 480 #define FILE_COMPLETE_IF_OPLOCKED      0x0100   /* ignore, should be zero */
 481 #define FILE_NO_EA_KNOWLEDGE      0x0200
 482 #define FILE_EIGHT_DOT_THREE_ONLY 0x0400 /* aka OPEN_FOR_RECOVERY: ignore, should be zero */
 483 #define FILE_RANDOM_ACCESS        0x0800
 484 #define FILE_DELETE_ON_CLOSE      0x1000
 485 #define FILE_OPEN_BY_FILE_ID      0x2000
 486 #define FILE_OPEN_FOR_BACKUP_INTENT    0x4000
 487 #define FILE_NO_COMPRESSION       0x8000
 488 #define FILE_RESERVER_OPFILTER    0x00100000    /* ignore, should be zero */
 489 #define FILE_OPEN_REPARSE_POINT   0x00200000
 490 #define FILE_OPEN_NO_RECALL       0x00400000
 491 #define FILE_OPEN_FOR_FREE_SPACE_QUERY 0x00800000 /* ignore should be zero */
 492
 493 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK      (0x008F0480)
 494
 495 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK    (0xFF100030)
 496
 497 /*
 498  * Private create options used by the ntcreatex processing code. From Samba4.
 499  * We reuse some ignored flags for private use. Passed in the private_flags
 500  * argument.
 501  */
 502 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS     0x0001
 503 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB     0x0002
 504
 505 /* Private options for streams support */
 506 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x0004
 507
 508 /* Private options for printer support */
 509 #define NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE 0x0008
 510
 511 /* Responses when opening a file. */
 512 #define FILE_WAS_SUPERSEDED 0
 513 #define FILE_WAS_OPENED 1
 514 #define FILE_WAS_CREATED 2
 515 #define FILE_WAS_OVERWRITTEN 3
 516
 517 /* Flag for NT transact rename call. */
 518 #define RENAME_REPLACE_IF_EXISTS 1
 519
 520 /* flags for SMBntrename call (from Samba4) */
 521 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
 522 #define RENAME_FLAG_HARD_LINK                0x103
 523 #define RENAME_FLAG_RENAME                   0x104
 524 #define RENAME_FLAG_COPY                     0x105
 525
 526 /* Filesystem Attributes. */
 527 #define FILE_CASE_SENSITIVE_SEARCH      0x00000001
 528 #define FILE_CASE_PRESERVED_NAMES       0x00000002
 529 #define FILE_UNICODE_ON_DISK            0x00000004
 530 /* According to cifs9f, this is 4, not 8 */
 531 /* Acconding to testing, this actually sets the security attribute! */
 532 #define FILE_PERSISTENT_ACLS            0x00000008
 533 #define FILE_FILE_COMPRESSION           0x00000010
 534 #define FILE_VOLUME_QUOTAS              0x00000020
 535 #define FILE_SUPPORTS_SPARSE_FILES      0x00000040
 536 #define FILE_SUPPORTS_REPARSE_POINTS    0x00000080
 537 #define FILE_SUPPORTS_REMOTE_STORAGE    0x00000100
 538 #define FS_LFN_APIS                     0x00004000
 539 #define FILE_VOLUME_IS_COMPRESSED       0x00008000
 540 #define FILE_SUPPORTS_OBJECT_IDS        0x00010000
 541 #define FILE_SUPPORTS_ENCRYPTION        0x00020000
 542 #define FILE_NAMED_STREAMS              0x00040000
 543 #define FILE_READ_ONLY_VOLUME           0x00080000
 544
 545 /* ChangeNotify flags. */
 546 #define FILE_NOTIFY_CHANGE_FILE_NAME   0x001
 547 #define FILE_NOTIFY_CHANGE_DIR_NAME    0x002
 548 #define FILE_NOTIFY_CHANGE_ATTRIBUTES  0x004
 549 #define FILE_NOTIFY_CHANGE_SIZE        0x008
 550 #define FILE_NOTIFY_CHANGE_LAST_WRITE  0x010
 551 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
 552 #define FILE_NOTIFY_CHANGE_CREATION    0x040
 553 #define FILE_NOTIFY_CHANGE_EA          0x080
 554 #define FILE_NOTIFY_CHANGE_SECURITY    0x100
 555 #define FILE_NOTIFY_CHANGE_STREAM_NAME  0x00000200
 556 #define FILE_NOTIFY_CHANGE_STREAM_SIZE  0x00000400
 557 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
 558
 559 #define FILE_NOTIFY_CHANGE_NAME \
 560         (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
 561
 562 #define FILE_NOTIFY_CHANGE_ALL \
 563         (FILE_NOTIFY_CHANGE_FILE_NAME   | FILE_NOTIFY_CHANGE_DIR_NAME | \
 564          FILE_NOTIFY_CHANGE_ATTRIBUTES  | FILE_NOTIFY_CHANGE_SIZE | \
 565          FILE_NOTIFY_CHANGE_LAST_WRITE  | FILE_NOTIFY_CHANGE_LAST_ACCESS | \
 566          FILE_NOTIFY_CHANGE_CREATION    | FILE_NOTIFY_CHANGE_EA | \
 567          FILE_NOTIFY_CHANGE_SECURITY    | FILE_NOTIFY_CHANGE_STREAM_NAME | \
 568          FILE_NOTIFY_CHANGE_STREAM_SIZE | FILE_NOTIFY_CHANGE_STREAM_WRITE)
 569
 570 /* change notify action results */
 571 #define NOTIFY_ACTION_ADDED 1
 572 #define NOTIFY_ACTION_REMOVED 2
 573 #define NOTIFY_ACTION_MODIFIED 3
 574 #define NOTIFY_ACTION_OLD_NAME 4
 575 #define NOTIFY_ACTION_NEW_NAME 5
 576 #define NOTIFY_ACTION_ADDED_STREAM 6
 577 #define NOTIFY_ACTION_REMOVED_STREAM 7
 578 #define NOTIFY_ACTION_MODIFIED_STREAM 8
 579
 580
 581 /* where to find the base of the SMB packet proper */
 582 #define smb_base(buf) (((const char *)(buf))+4)
 583
 584 /* we don't allow server strings to be longer than 48 characters as
 585    otherwise NT will not honour the announce packets */
 586 #define MAX_SERVER_STRING_LENGTH 48
 587
 588
 589 #define SMB_SUCCESS 0  /* The request was successful. */
 590
 591 #ifdef WITH_DFS
 592 void dfs_unlogin(void);
 593 extern int dcelogin_atmost_once;
 594 #endif
 595
 596 #ifdef NOSTRDUP
 597 char *strdup(char *s);
 598 #endif
 599
 600 #ifndef SELECT_CAST
 601 #define SELECT_CAST
 602 #endif
 603
 604 /* This was set by JHT in liaison with Jeremy Allison early 1997
 605  * History:
 606  * Version 4.0 - never made public
 607  * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
 608  *              - Reappeared in 1.9.16p11 with fixed smbd services
 609  * Version 4.20 - To indicate that nmbd and browsing now works better
 610  * Version 4.50 - Set at release of samba-2.2.0 by JHT
 611  *
 612  *  Note: In the presence of NT4.X do not set above 4.9
 613  *        Setting this above 4.9 can have undesired side-effects.
 614  *        This may change again in Samba-3.0 after further testing. JHT
 615  */
 616
 617 #define SAMBA_MAJOR_NBT_ANNOUNCE_VERSION 0x04
 618 #define SAMBA_MINOR_NBT_ANNOUNCE_VERSION 0x09
 619
 620 /* Browser Election Values */
 621 #define BROWSER_ELECTION_VERSION        0x010f
 622 #define BROWSER_CONSTANT        0xaa55
 623
 624 /* TCONX Flag (smb_vwv2). */
 625 #define TCONX_FLAG_EXTENDED_RESPONSE    0x8
 626
 627 /* File Status Flags. See:
 628
 629 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
 630 */
 631
 632 #define NO_EAS                  0x1
 633 #define NO_SUBSTREAMS           0x2
 634 #define NO_REPARSETAG           0x4
 635
 636 /* Remote architectures we know about. */
 637 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
 638                         RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
 639                         RA_SAMBA, RA_CIFSFS, RA_WINXP64, RA_OSX};
 640
 641 /*
 642  * Global value meaning that the smb_uid field should be
 643  * ingored (in share level security and protocol level == CORE)
 644  */
 645
 646 #define UID_FIELD_INVALID 0
 647 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
 648
 649 #define TID_FIELD_INVALID 0
 650
 651 #define FNUM_FIELD_INVALID 0
 652
 653 /*
 654  * Size of buffer to use when moving files across filesystems.
 655  */
 656 #define COPYBUF_SIZE (8*1024)
 657
 658 /*
 659  * Map the Core and Extended Oplock requesst bits down
 660  * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
 661  */
 662
 663 /*
 664  * Core protocol.
 665  */
 666 #define CORE_OPLOCK_REQUEST(inbuf) \
 667     ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
 668
 669 /*
 670  * Extended protocol.
 671  */
 672 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
 673
 674 /*
 675  * Bits we test with.
 676  * Note these must fit into 16-bits.
 677  */
 678
 679 #define NO_OPLOCK                       OPLOCK_NONE
 680 #define EXCLUSIVE_OPLOCK                OPLOCK_EXCLUSIVE
 681 #define BATCH_OPLOCK                    OPLOCK_BATCH
 682 #define LEVEL_II_OPLOCK                 OPLOCK_LEVEL_II
 683
 684 /* The following are Samba-private. */
 685 #define INTERNAL_OPEN_ONLY              0x8
 686 #define FAKE_LEVEL_II_OPLOCK            0x10    /* Client requested no_oplock, but we have to
 687                                  * inform potential level2 holders on
 688                                  * write. */
 689 #define DEFERRED_OPEN_ENTRY             0x20
 690 /* #define UNUSED_SHARE_MODE_ENTRY      0x40 */   /* Not used anymore */
 691 #define FORCE_OPLOCK_BREAK_TO_NONE      0x80
 692
 693 /* None of the following should ever appear in fsp->oplock_request. */
 694 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY|DEFERRED_OPEN_ENTRY|FORCE_OPLOCK_BREAK_TO_NONE)
 695
 696 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
 697 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
 698 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)LEVEL_II_OPLOCK|(unsigned int)FAKE_LEVEL_II_OPLOCK))
 699
 700 /* kernel_oplock_message definition.
 701
 702 struct kernel_oplock_message {
 703         uint64_t dev;
 704         uint64_t inode;
 705         unit64_t extid;
 706         unsigned long file_id;
 707 };
 708
 709 Offset  Data                  length.
 710 0     uint64_t dev            8 bytes
 711 8     uint64_t inode          8 bytes
 712 16    uint64_t extid          8 bytes
 713 24    unsigned long file_id   4 bytes
 714 28
 715
 716 */
 717 #define MSG_SMB_KERNEL_BREAK_SIZE 28
 718
 719 /* file_renamed_message definition.
 720
 721 struct file_renamed_message {
 722         uint64_t dev;
 723         uint64_t inode;
 724         char names[1]; A variable area containing sharepath and filename.
 725 };
 726
 727 Offset  Data                    length.
 728 0       uint64_t dev            8 bytes
 729 8       uint64_t inode          8 bytes
 730 16      unit64_t extid          8 bytes
 731 24      char [] name            zero terminated namelen bytes
 732 minimum length == 24.
 733
 734 */
 735
 736 #define MSG_FILE_RENAMED_MIN_SIZE 24
 737
 738 /*
 739  * On the wire return values for oplock types.
 740  */
 741
 742 #define CORE_OPLOCK_GRANTED (1<<5)
 743 #define EXTENDED_OPLOCK_GRANTED (1<<15)
 744
 745 #define NO_OPLOCK_RETURN 0
 746 #define EXCLUSIVE_OPLOCK_RETURN 1
 747 #define BATCH_OPLOCK_RETURN 2
 748 #define LEVEL_II_OPLOCK_RETURN 3
 749
 750 /* Oplock levels */
 751 #define OPLOCKLEVEL_NONE 0
 752 #define OPLOCKLEVEL_II 1
 753
 754 /*
 755  * Capabilities abstracted for different systems.
 756  */
 757
 758 enum smbd_capability {
 759     KERNEL_OPLOCK_CAPABILITY,
 760     DMAPI_ACCESS_CAPABILITY,
 761     LEASE_CAPABILITY
 762 };
 763
 764 /*
 765  * Kernel oplocks capability flags.
 766  */
 767
 768 /* Level 2 oplocks are supported natively by kernel oplocks. */
 769 #define KOPLOCKS_LEVEL2_SUPPORTED               0x1
 770
 771 /* The kernel notifies deferred openers when they can retry the open. */
 772 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION     0x2
 773
 774 /* The kernel notifies smbds when an oplock break times out. */
 775 #define KOPLOCKS_TIMEOUT_NOTIFICATION           0x4
 776
 777 /* The kernel notifies smbds when an oplock is broken. */
 778 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION     0x8
 779
 780 struct kernel_oplocks_ops;
 781 struct kernel_oplocks {
 782         const struct kernel_oplocks_ops *ops;
 783         uint32_t flags;
 784         void *private_data;
 785 };
 786
 787 enum level2_contention_type {
 788         LEVEL2_CONTEND_ALLOC_SHRINK,
 789         LEVEL2_CONTEND_ALLOC_GROW,
 790         LEVEL2_CONTEND_SET_FILE_LEN,
 791         LEVEL2_CONTEND_FILL_SPARSE,
 792         LEVEL2_CONTEND_WRITE,
 793         LEVEL2_CONTEND_WINDOWS_BRL,
 794         LEVEL2_CONTEND_POSIX_BRL
 795 };
 796
 797 /* if a kernel does support oplocks then a structure of the following
 798    typee is used to describe how to interact with the kernel */
 799 struct kernel_oplocks_ops {
 800         bool (*set_oplock)(struct kernel_oplocks *ctx,
 801                            files_struct *fsp, int oplock_type);
 802         void (*release_oplock)(struct kernel_oplocks *ctx,
 803                                files_struct *fsp, int oplock_type);
 804         void (*contend_level2_oplocks_begin)(files_struct *fsp,
 805                                              enum level2_contention_type type);
 806         void (*contend_level2_oplocks_end)(files_struct *fsp,
 807                                            enum level2_contention_type type);
 808 };
 809
 810 #include "smb_macros.h"
 811
 812 #define MAX_NETBIOSNAME_LEN 16
 813 /* DOS character, NetBIOS namestring. Type used on the wire. */
 814 typedef char nstring[MAX_NETBIOSNAME_LEN];
 815 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
 816 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
 817
 818 /* A netbios name structure. */
 819 struct nmb_name {
 820         nstring      name;
 821         char         scope[64];
 822         unsigned int name_type;
 823 };
 824
 825 /* A netbios node status array element. */
 826 struct node_status {
 827         nstring name;
 828         unsigned char type;
 829         unsigned char flags;
 830 };
 831
 832 /* The extra info from a NetBIOS node status query */
 833 struct node_status_extra {
 834         unsigned char mac_addr[6];
 835         /* There really is more here ... */
 836 };
 837
 838 #define SAFE_NETBIOS_CHARS ". -_"
 839
 840 /* The maximum length of a trust account password.
 841    Used when we randomly create it, 15 char passwords
 842    exceed NT4's max password length */
 843
 844 #define DEFAULT_TRUST_ACCOUNT_PASSWORD_LENGTH 14
 845
 846 #define PORT_NONE       0
 847 #ifndef LDAP_PORT
 848 #define LDAP_PORT       389
 849 #endif
 850 #define LDAP_GC_PORT    3268
 851
 852 /* used by the IP comparison function */
 853 struct ip_service {
 854         struct sockaddr_storage ss;
 855         unsigned port;
 856 };
 857
 858 struct ea_struct {
 859         uint8 flags;
 860         char *name;
 861         DATA_BLOB value;
 862 };
 863
 864 struct ea_list {
 865         struct ea_list *next, *prev;
 866         struct ea_struct ea;
 867 };
 868
 869 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
 870 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
 871 /* EA to use for DOS attributes */
 872 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
 873 /* Prefix for DosStreams in the vfs_streams_xattr module */
 874 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
 875 /* Prefix for xattrs storing streams. */
 876 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
 877
 878 /* usershare error codes. */
 879 enum usershare_err {
 880                 USERSHARE_OK=0,
 881                 USERSHARE_MALFORMED_FILE,
 882                 USERSHARE_BAD_VERSION,
 883                 USERSHARE_MALFORMED_PATH,
 884                 USERSHARE_MALFORMED_COMMENT_DEF,
 885                 USERSHARE_MALFORMED_ACL_DEF,
 886                 USERSHARE_ACL_ERR,
 887                 USERSHARE_PATH_NOT_ABSOLUTE,
 888                 USERSHARE_PATH_IS_DENIED,
 889                 USERSHARE_PATH_NOT_ALLOWED,
 890                 USERSHARE_PATH_NOT_DIRECTORY,
 891                 USERSHARE_POSIX_ERR,
 892                 USERSHARE_MALFORMED_SHARENAME_DEF,
 893                 USERSHARE_BAD_SHARENAME
 894 };
 895
 896 /* Different reasons for closing a file. */
 897 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
 898
 899 /* Used in SMB_FS_OBJECTID_INFORMATION requests.  Must be exactly 48 bytes. */
 900 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
 901 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
 902 struct smb_extended_info {
 903         uint32 samba_magic;             /* Always SAMBA_EXTRA_INFO_MAGIC */
 904         uint32 samba_version;           /* Major/Minor/Release/Revision */
 905         uint32 samba_subversion;        /* Prerelease/RC/Vendor patch */
 906         NTTIME samba_gitcommitdate;
 907         char   samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
 908 };
 909
 910 /*
 911  * Reasons for cache flush.
 912  */
 913
 914 enum flush_reason_enum {
 915     SEEK_FLUSH,
 916     READ_FLUSH,
 917     WRITE_FLUSH,
 918     READRAW_FLUSH,
 919     OPLOCK_RELEASE_FLUSH,
 920     CLOSE_FLUSH,
 921     SYNC_FLUSH,
 922     SIZECHANGE_FLUSH,
 923     /* NUM_FLUSH_REASONS must remain the last value in the enumeration. */
 924     NUM_FLUSH_REASONS};
 925
 926 #endif /* _SMB_H */