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