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-2018"
  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 share_mode_entry;
 124 struct uuid;
 125 struct named_mutex;
 126 struct wb_context;
 127 struct rpc_cli_smbd_conn;
 128
 129 /* the basic packet size, assuming no words or bytes */
 130 #define smb_size 39
 131
 132 struct notify_change {
 133         uint32_t action;
 134         const char *name;
 135 };
 136
 137 struct notify_mid_map;
 138 struct notify_db_entry;
 139 struct notify_event;
 140 struct notify_change_request;
 141 struct sys_notify_backend;
 142 struct sys_notify_context {
 143         struct tevent_context *ev;
 144         void *private_data;     /* For use by the system backend */
 145 };
 146
 147 #include "ntquotas.h"
 148 #include "sysquotas.h"
 149
 150 /* Include VFS stuff */
 151
 152 #include "smb_acls.h"
 153 #include "lib/readdir_attr.h"
 154 #include "vfs.h"
 155
 156 struct current_user {
 157         struct connection_struct *conn;
 158         uint64_t vuid; /* SMB2 compat */
 159         struct security_unix_token ut;
 160         struct security_token *nt_user_token;
 161 };
 162
 163 /* Defines for the sent_oplock_break field above. */
 164 #define NO_BREAK_SENT 0
 165 #define BREAK_TO_NONE_SENT 1
 166 #define LEVEL_II_BREAK_SENT 2
 167
 168 typedef struct {
 169         fstring smb_name; /* user name from the client */
 170         fstring unix_name; /* unix user name of a validated user */
 171         fstring domain; /* domain that the client specified */
 172 } userdom_struct;
 173
 174 /* used for network interfaces */
 175 struct interface {
 176         struct interface *next, *prev;
 177         char *name;
 178         int flags;
 179         struct sockaddr_storage ip;
 180         struct sockaddr_storage netmask;
 181         struct sockaddr_storage bcast;
 182         uint32_t if_index;
 183         uint64_t linkspeed;
 184         uint32_t capability;
 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_t op_mid         8
 196 12      uint16_t op_type        2
 197 14      uint32_t access_mask    4
 198 18      uint32_t share_access   4
 199 22      uint32_t private_options        4
 200 26      uint32_t time sec               4
 201 30      uint32_t time usec      4
 202 34      uint64_t dev            8 bytes
 203 42      uint64_t inode          8 bytes
 204 50      uint64_t extid          8 bytes
 205 58      unsigned long file_id   4 bytes
 206 62      uint32_t uid            4 bytes
 207 66      uint16_t flags          2 bytes
 208 68      uint32_t 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 NT transact_get_user_quota sub commands */
 270 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE   0x0000
 271 #define TRANSACT_GET_USER_QUOTA_LIST_START      0x0100
 272 #define TRANSACT_GET_USER_QUOTA_FOR_SID         0x0101
 273
 274 /* Relevant IOCTL codes */
 275 #define IOCTL_QUERY_JOB_INFO      0x530060
 276
 277 /* these are the trans2 sub fields for primary requests */
 278 #define smb_tpscnt smb_vwv0
 279 #define smb_tdscnt smb_vwv1
 280 #define smb_mprcnt smb_vwv2
 281 #define smb_mdrcnt smb_vwv3
 282 #define smb_msrcnt smb_vwv4
 283 #define smb_flags smb_vwv5
 284 #define smb_timeout smb_vwv6
 285 #define smb_pscnt smb_vwv9
 286 #define smb_psoff smb_vwv10
 287 #define smb_dscnt smb_vwv11
 288 #define smb_dsoff smb_vwv12
 289 #define smb_suwcnt smb_vwv13
 290 #define smb_setup smb_vwv14
 291 #define smb_setup0 smb_setup
 292 #define smb_setup1 (smb_setup+2)
 293 #define smb_setup2 (smb_setup+4)
 294
 295 /* these are for the secondary requests */
 296 #define smb_spscnt smb_vwv2
 297 #define smb_spsoff smb_vwv3
 298 #define smb_spsdisp smb_vwv4
 299 #define smb_sdscnt smb_vwv5
 300 #define smb_sdsoff smb_vwv6
 301 #define smb_sdsdisp smb_vwv7
 302 #define smb_sfid smb_vwv8
 303
 304 /* and these for responses */
 305 #define smb_tprcnt smb_vwv0
 306 #define smb_tdrcnt smb_vwv1
 307 #define smb_prcnt smb_vwv3
 308 #define smb_proff smb_vwv4
 309 #define smb_prdisp smb_vwv5
 310 #define smb_drcnt smb_vwv6
 311 #define smb_droff smb_vwv7
 312 #define smb_drdisp smb_vwv8
 313
 314 /* these are for the NT trans primary request. */
 315 #define smb_nt_MaxSetupCount smb_vwv0
 316 #define smb_nt_Flags (smb_vwv0 + 1)
 317 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
 318 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
 319 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
 320 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
 321 #define smb_nt_ParameterCount (smb_vwv0 + 19)
 322 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
 323 #define smb_nt_DataCount (smb_vwv0 + 27)
 324 #define smb_nt_DataOffset (smb_vwv0 + 31)
 325 #define smb_nt_SetupCount (smb_vwv0 + 35)
 326 #define smb_nt_Function (smb_vwv0 + 36)
 327 #define smb_nt_SetupStart (smb_vwv0 + 38)
 328
 329 /* these are for the NT trans secondary request. */
 330 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
 331 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
 332 #define smb_nts_ParameterCount (smb_vwv0 + 11)
 333 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
 334 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
 335 #define smb_nts_DataCount (smb_vwv0 + 23)
 336 #define smb_nts_DataOffset (smb_vwv0 + 27)
 337 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
 338
 339 /* these are for the NT trans reply. */
 340 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
 341 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
 342 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
 343 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
 344 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
 345 #define smb_ntr_DataCount (smb_vwv0 + 23)
 346 #define smb_ntr_DataOffset (smb_vwv0 + 27)
 347 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
 348
 349 /* these are for the NT create_and_X */
 350 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
 351 #define smb_ntcreate_Flags (smb_vwv0 + 7)
 352 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
 353 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
 354 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
 355 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
 356 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
 357 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
 358 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
 359 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
 360 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
 361
 362 /* Named pipe write mode flags. Used in writeX calls. */
 363 #define PIPE_RAW_MODE 0x4
 364 #define PIPE_START_MESSAGE 0x8
 365
 366 /* the desired access to use when opening a pipe */
 367 #define DESIRED_ACCESS_PIPE 0x2019f
 368
 369 /* Mapping of access rights to UNIX perms. */
 370 #define UNIX_ACCESS_RWX         FILE_GENERIC_ALL
 371 #define UNIX_ACCESS_R           FILE_GENERIC_READ
 372 #define UNIX_ACCESS_W           FILE_GENERIC_WRITE
 373 #define UNIX_ACCESS_X           FILE_GENERIC_EXECUTE
 374
 375 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
 376 #define UNIX_DIRECTORY_ACCESS_RWX               FILE_GENERIC_ALL
 377 #define UNIX_DIRECTORY_ACCESS_R                 FILE_GENERIC_READ
 378 #define UNIX_DIRECTORY_ACCESS_W                 (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
 379 #define UNIX_DIRECTORY_ACCESS_X                 FILE_GENERIC_EXECUTE
 380
 381 #if 0
 382 /*
 383  * This is the old mapping we used to use. To get W2KSP2 profiles
 384  * working we need to map to the canonical file perms.
 385  */
 386 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
 387 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
 388                         FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
 389 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
 390                         FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
 391                         FILE_APPEND_DATA|FILE_WRITE_DATA)
 392 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
 393                         FILE_EXECUTE|FILE_READ_ATTRIBUTES)
 394 #endif
 395
 396 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
 397
 398 /* Flags field. */
 399 #define REQUEST_OPLOCK 2
 400 #define REQUEST_BATCH_OPLOCK 4
 401 #define OPEN_DIRECTORY 8
 402 #define EXTENDED_RESPONSE_REQUIRED 0x10
 403
 404 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK      (0x008F0480)
 405
 406 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK    (0xFF100030)
 407
 408 /*
 409  * Private create options used by the ntcreatex processing code. From Samba4.
 410  * We reuse some ignored flags for private use. Passed in the private_flags
 411  * argument.
 412  */
 413 #define NTCREATEX_OPTIONS_PRIVATE_DENY_DOS     0x0001
 414 #define NTCREATEX_OPTIONS_PRIVATE_DENY_FCB     0x0002
 415
 416 /* Private options for streams support */
 417 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_DELETE 0x0004
 418
 419 /* Private options for printer support */
 420 #define NTCREATEX_OPTIONS_PRIVATE_DELETE_ON_CLOSE 0x0008
 421
 422 /* Private option for streams support */
 423 #define NTCREATEX_OPTIONS_PRIVATE_STREAM_BASEOPEN 0x0010
 424
 425 /* Flag for NT transact rename call. */
 426 #define RENAME_REPLACE_IF_EXISTS 1
 427
 428 /* flags for SMBntrename call (from Samba4) */
 429 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
 430 #define RENAME_FLAG_HARD_LINK                0x103
 431 #define RENAME_FLAG_RENAME                   0x104
 432 #define RENAME_FLAG_COPY                     0x105
 433
 434 /* ChangeNotify flags. */
 435 #define FILE_NOTIFY_CHANGE_FILE_NAME   0x001
 436 #define FILE_NOTIFY_CHANGE_DIR_NAME    0x002
 437 #define FILE_NOTIFY_CHANGE_ATTRIBUTES  0x004
 438 #define FILE_NOTIFY_CHANGE_SIZE        0x008
 439 #define FILE_NOTIFY_CHANGE_LAST_WRITE  0x010
 440 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
 441 #define FILE_NOTIFY_CHANGE_CREATION    0x040
 442 #define FILE_NOTIFY_CHANGE_EA          0x080
 443 #define FILE_NOTIFY_CHANGE_SECURITY    0x100
 444 #define FILE_NOTIFY_CHANGE_STREAM_NAME  0x00000200
 445 #define FILE_NOTIFY_CHANGE_STREAM_SIZE  0x00000400
 446 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
 447
 448 #define FILE_NOTIFY_CHANGE_NAME \
 449         (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
 450
 451 #define FILE_NOTIFY_CHANGE_ALL \
 452         (FILE_NOTIFY_CHANGE_FILE_NAME   | FILE_NOTIFY_CHANGE_DIR_NAME | \
 453          FILE_NOTIFY_CHANGE_ATTRIBUTES  | FILE_NOTIFY_CHANGE_SIZE | \
 454          FILE_NOTIFY_CHANGE_LAST_WRITE  | FILE_NOTIFY_CHANGE_LAST_ACCESS | \
 455          FILE_NOTIFY_CHANGE_CREATION    | FILE_NOTIFY_CHANGE_EA | \
 456          FILE_NOTIFY_CHANGE_SECURITY    | FILE_NOTIFY_CHANGE_STREAM_NAME | \
 457          FILE_NOTIFY_CHANGE_STREAM_SIZE | FILE_NOTIFY_CHANGE_STREAM_WRITE)
 458
 459 /* change notify action results */
 460 #define NOTIFY_ACTION_ADDED 1
 461 #define NOTIFY_ACTION_REMOVED 2
 462 #define NOTIFY_ACTION_MODIFIED 3
 463 #define NOTIFY_ACTION_OLD_NAME 4
 464 #define NOTIFY_ACTION_NEW_NAME 5
 465 #define NOTIFY_ACTION_ADDED_STREAM 6
 466 #define NOTIFY_ACTION_REMOVED_STREAM 7
 467 #define NOTIFY_ACTION_MODIFIED_STREAM 8
 468
 469 /*
 470  * Timestamp format used in "previous versions":
 471  * This is the windows-level format of the @GMT- token.
 472  * It is a fixed format not to be confused with the
 473  * format for the POSIX-Level token of the shadow_copy2
 474  * VFS module that can be configured via the "shadow:format"
 475  * configuration option but defaults to the same format.
 476  * See the shadow_copy2 module.
 477  */
 478 #define GMT_NAME_LEN 24 /* length of a @GMT- name */
 479 #define GMT_FORMAT "@GMT-%Y.%m.%d-%H.%M.%S"
 480
 481 /* where to find the base of the SMB packet proper */
 482 #define smb_base(buf) (((const char *)(buf))+4)
 483
 484 /* we don't allow server strings to be longer than 48 characters as
 485    otherwise NT will not honour the announce packets */
 486 #define MAX_SERVER_STRING_LENGTH 48
 487
 488 #ifdef NOSTRDUP
 489 char *strdup(char *s);
 490 #endif
 491
 492 #ifndef SELECT_CAST
 493 #define SELECT_CAST
 494 #endif
 495
 496 /* This was set by JHT in liaison with Jeremy Allison early 1997
 497  * History:
 498  * Version 4.0 - never made public
 499  * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
 500  *              - Reappeared in 1.9.16p11 with fixed smbd services
 501  * Version 4.20 - To indicate that nmbd and browsing now works better
 502  * Version 4.50 - Set at release of samba-2.2.0 by JHT
 503  *
 504  *  Note: In the presence of NT4.X do not set above 4.9
 505  *        Setting this above 4.9 can have undesired side-effects.
 506  *        This may change again in Samba-3.0 after further testing. JHT
 507  *
 508  * Version 6.1 - For older smb server versions, MMC doesn't let offline
 509  *               settings to be configured during share creation. Changing
 510  *               it to 6.1 to mimic Win2K8R2.
 511  *
 512  */
 513
 514 #define SAMBA_MAJOR_NBT_ANNOUNCE_VERSION 0x06
 515 #define SAMBA_MINOR_NBT_ANNOUNCE_VERSION 0x01
 516
 517 /* Browser Election Values */
 518 #define BROWSER_ELECTION_VERSION        0x010f
 519 #define BROWSER_CONSTANT        0xaa55
 520
 521 /* File Status Flags. See:
 522
 523 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
 524 */
 525
 526 #define NO_EAS                  0x1
 527 #define NO_SUBSTREAMS           0x2
 528 #define NO_REPARSETAG           0x4
 529
 530 /* Remote architectures we know about, keep in sync with remote_arch_strings */
 531 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
 532                         RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
 533                         RA_SAMBA, RA_CIFSFS, RA_WINXP64, RA_OSX};
 534
 535 /*
 536  * Global value meaning that the smb_uid field should be
 537  * ingored (in share level security and protocol level == CORE)
 538  */
 539
 540 #define UID_FIELD_INVALID 0
 541 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
 542
 543 #define TID_FIELD_INVALID 0
 544
 545 #define FNUM_FIELD_INVALID 0
 546
 547 /*
 548  * Size of buffer to use when moving files across filesystems.
 549  */
 550 #define COPYBUF_SIZE (8*1024)
 551
 552 /*
 553  * Map the Core and Extended Oplock requesst bits down
 554  * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
 555  */
 556
 557 /*
 558  * Core protocol.
 559  */
 560 #define CORE_OPLOCK_REQUEST(inbuf) \
 561     ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
 562
 563 /*
 564  * Extended protocol.
 565  */
 566 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
 567
 568 /*
 569  * Bits we test with.
 570  * Note these must fit into 16-bits.
 571  */
 572
 573 #define NO_OPLOCK                       OPLOCK_NONE
 574 #define EXCLUSIVE_OPLOCK                OPLOCK_EXCLUSIVE
 575 #define BATCH_OPLOCK                    OPLOCK_BATCH
 576 #define LEVEL_II_OPLOCK                 OPLOCK_LEVEL_II
 577 #define LEASE_OPLOCK                    0x100
 578
 579 /* The following are Samba-private. */
 580 #define INTERNAL_OPEN_ONLY              0x8
 581 /* #define FAKE_LEVEL_II_OPLOCK         0x10 */   /* Not used anymore */
 582                                 /* Client requested no_oplock, but we have to
 583                                  * inform potential level2 holders on
 584                                  * write. */
 585 /* #define DEFERRED_OPEN_ENTRY          0x20 */   /* Not used anymore */
 586 /* #define UNUSED_SHARE_MODE_ENTRY      0x40 */   /* Not used anymore */
 587 /* #define FORCE_OPLOCK_BREAK_TO_NONE   0x80 */   /* Not used anymore */
 588
 589 /* None of the following should ever appear in fsp->oplock_request. */
 590 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY)
 591
 592 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
 593 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
 594 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & (unsigned int)LEVEL_II_OPLOCK)
 595
 596 /* kernel_oplock_message definition.
 597
 598 struct kernel_oplock_message {
 599         uint64_t dev;
 600         uint64_t inode;
 601         unit64_t extid;
 602         unsigned long file_id;
 603 };
 604
 605 Offset  Data                  length.
 606 0     uint64_t dev            8 bytes
 607 8     uint64_t inode          8 bytes
 608 16    uint64_t extid          8 bytes
 609 24    unsigned long file_id   4 bytes
 610 28
 611
 612 */
 613 #define MSG_SMB_KERNEL_BREAK_SIZE 28
 614
 615 /* file_renamed_message definition.
 616
 617 struct file_renamed_message {
 618         uint64_t dev;
 619         uint64_t inode;
 620         char names[1]; A variable area containing sharepath and filename.
 621 };
 622
 623 Offset  Data                    length.
 624 0       uint64_t dev            8 bytes
 625 8       uint64_t inode          8 bytes
 626 16      unit64_t extid          8 bytes
 627 24      char [] name            zero terminated namelen bytes
 628 minimum length == 24.
 629
 630 */
 631
 632 #define MSG_FILE_RENAMED_MIN_SIZE 24
 633
 634 /*
 635  * On the wire return values for oplock types.
 636  */
 637
 638 #define CORE_OPLOCK_GRANTED (1<<5)
 639 #define EXTENDED_OPLOCK_GRANTED (1<<15)
 640
 641 #define NO_OPLOCK_RETURN 0
 642 #define EXCLUSIVE_OPLOCK_RETURN 1
 643 #define BATCH_OPLOCK_RETURN 2
 644 #define LEVEL_II_OPLOCK_RETURN 3
 645
 646 /* Oplock levels */
 647 #define OPLOCKLEVEL_NONE 0
 648 #define OPLOCKLEVEL_II 1
 649
 650 /*
 651  * Capabilities abstracted for different systems.
 652  */
 653
 654 enum smbd_capability {
 655     KERNEL_OPLOCK_CAPABILITY,
 656     DMAPI_ACCESS_CAPABILITY,
 657     LEASE_CAPABILITY,
 658     DAC_OVERRIDE_CAPABILITY
 659 };
 660
 661 /*
 662  * Kernel oplocks capability flags.
 663  */
 664
 665 /* Level 2 oplocks are supported natively by kernel oplocks. */
 666 #define KOPLOCKS_LEVEL2_SUPPORTED               0x1
 667
 668 /* The kernel notifies deferred openers when they can retry the open. */
 669 #define KOPLOCKS_DEFERRED_OPEN_NOTIFICATION     0x2
 670
 671 /* The kernel notifies smbds when an oplock break times out. */
 672 #define KOPLOCKS_TIMEOUT_NOTIFICATION           0x4
 673
 674 /* The kernel notifies smbds when an oplock is broken. */
 675 #define KOPLOCKS_OPLOCK_BROKEN_NOTIFICATION     0x8
 676
 677 struct kernel_oplocks_ops;
 678 struct kernel_oplocks {
 679         const struct kernel_oplocks_ops *ops;
 680         uint32_t flags;
 681         void *private_data;
 682 };
 683
 684 enum level2_contention_type {
 685         LEVEL2_CONTEND_ALLOC_SHRINK,
 686         LEVEL2_CONTEND_ALLOC_GROW,
 687         LEVEL2_CONTEND_SET_FILE_LEN,
 688         LEVEL2_CONTEND_FILL_SPARSE,
 689         LEVEL2_CONTEND_WRITE,
 690         LEVEL2_CONTEND_WINDOWS_BRL,
 691         LEVEL2_CONTEND_POSIX_BRL
 692 };
 693
 694 /* if a kernel does support oplocks then a structure of the following
 695    typee is used to describe how to interact with the kernel */
 696 struct kernel_oplocks_ops {
 697         bool (*set_oplock)(struct kernel_oplocks *ctx,
 698                            files_struct *fsp, int oplock_type);
 699         void (*release_oplock)(struct kernel_oplocks *ctx,
 700                                files_struct *fsp, int oplock_type);
 701         void (*contend_level2_oplocks_begin)(files_struct *fsp,
 702                                              enum level2_contention_type type);
 703         void (*contend_level2_oplocks_end)(files_struct *fsp,
 704                                            enum level2_contention_type type);
 705 };
 706
 707 #include "smb_macros.h"
 708
 709 #define MAX_NETBIOSNAME_LEN 16
 710 /* DOS character, NetBIOS namestring. Type used on the wire. */
 711 typedef char nstring[MAX_NETBIOSNAME_LEN];
 712 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
 713 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
 714
 715 /* A netbios name structure. */
 716 struct nmb_name {
 717         nstring      name;
 718         char         scope[64];
 719         unsigned int name_type;
 720 };
 721
 722 /* A netbios node status array element. */
 723 struct node_status {
 724         nstring name;
 725         unsigned char type;
 726         unsigned char flags;
 727 };
 728
 729 /* The extra info from a NetBIOS node status query */
 730 struct node_status_extra {
 731         unsigned char mac_addr[6];
 732         /* There really is more here ... */
 733 };
 734
 735 #define SAFE_NETBIOS_CHARS ". -_"
 736
 737 #define PORT_NONE       0
 738 #ifndef LDAP_PORT
 739 #define LDAP_PORT       389
 740 #endif
 741 #define LDAP_GC_PORT    3268
 742
 743 /* used by the IP comparison function */
 744 struct ip_service {
 745         struct sockaddr_storage ss;
 746         unsigned port;
 747 };
 748
 749 struct ea_struct {
 750         uint8_t flags;
 751         char *name;
 752         DATA_BLOB value;
 753 };
 754
 755 struct ea_list {
 756         struct ea_list *next, *prev;
 757         struct ea_struct ea;
 758 };
 759
 760 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
 761 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
 762 /* EA to use for DOS attributes */
 763 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
 764 /* Prefix for DosStreams in the vfs_streams_xattr module */
 765 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
 766 /* Prefix for xattrs storing streams. */
 767 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
 768
 769 /* usershare error codes. */
 770 enum usershare_err {
 771                 USERSHARE_OK=0,
 772                 USERSHARE_MALFORMED_FILE,
 773                 USERSHARE_BAD_VERSION,
 774                 USERSHARE_MALFORMED_PATH,
 775                 USERSHARE_MALFORMED_COMMENT_DEF,
 776                 USERSHARE_MALFORMED_ACL_DEF,
 777                 USERSHARE_ACL_ERR,
 778                 USERSHARE_PATH_NOT_ABSOLUTE,
 779                 USERSHARE_PATH_IS_DENIED,
 780                 USERSHARE_PATH_NOT_ALLOWED,
 781                 USERSHARE_PATH_NOT_DIRECTORY,
 782                 USERSHARE_POSIX_ERR,
 783                 USERSHARE_MALFORMED_SHARENAME_DEF,
 784                 USERSHARE_BAD_SHARENAME
 785 };
 786
 787 /* Different reasons for closing a file. */
 788 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
 789
 790 /* Used in SMB_FS_OBJECTID_INFORMATION requests.  Must be exactly 48 bytes. */
 791 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
 792 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
 793 struct smb_extended_info {
 794         uint32_t samba_magic;           /* Always SAMBA_EXTRA_INFO_MAGIC */
 795         uint32_t samba_version;         /* Major/Minor/Release/Revision */
 796         uint32_t samba_subversion;      /* Prerelease/RC/Vendor patch */
 797         NTTIME samba_gitcommitdate;
 798         char   samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
 799 };
 800
 801 /*
 802  * Reasons for cache flush.
 803  */
 804
 805 enum flush_reason_enum {
 806     SAMBA_SEEK_FLUSH,
 807     SAMBA_READ_FLUSH,
 808     SAMBA_WRITE_FLUSH,
 809     SAMBA_READRAW_FLUSH,
 810     SAMBA_OPLOCK_RELEASE_FLUSH,
 811     SAMBA_CLOSE_FLUSH,
 812     SAMBA_SYNC_FLUSH,
 813     SAMBA_SIZECHANGE_FLUSH,
 814 };
 815
 816 #endif /* _SMB_H */