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