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-2023"
  34
  35 #define LARGE_WRITEX_HDR_SIZE 65
  36 #define LARGE_WRITEX_BUFFER_SIZE (128*1024)
  37
  38 #define NMB_PORT 137
  39 #define DGRAM_PORT 138
  40 #define NBT_SMB_PORT  139   /* Port for SMB over NBT transport (IETF STD#19). */
  41 #define TCP_SMB_PORT  445   /* Port for SMB over naked TCP transport.         */
  42 #define SMB_PORTS "445 139"
  43
  44 #define Undefined (-1)
  45 #define False false
  46 #define True true
  47 #define Auto (2)
  48 #define Required (3)
  49
  50 #define SIZEOFWORD 2
  51
  52 /* how long to wait for secondary SMB packets (milli-seconds) */
  53 #define SMB_SECONDARY_WAIT (60*1000)
  54
  55 #define DIR_STRUCT_SIZE 43
  56
  57 /* deny modes */
  58 #define DENY_DOS 0
  59 #define DENY_ALL 1
  60 #define DENY_WRITE 2
  61 #define DENY_READ 3
  62 #define DENY_NONE 4
  63 #define DENY_FCB 7
  64
  65 /* open modes */
  66 #define DOS_OPEN_RDONLY 0
  67 #define DOS_OPEN_WRONLY 1
  68 #define DOS_OPEN_RDWR 2
  69 #define DOS_OPEN_EXEC 3
  70 #define DOS_OPEN_FCB 0xF
  71
  72 /* define shifts and masks for share and open modes. */
  73 #define OPENX_MODE_MASK 0xF
  74 #define DENY_MODE_SHIFT 4
  75 #define DENY_MODE_MASK 0x7
  76 #define GET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
  77 #define SET_OPENX_MODE(x) ((x) & OPENX_MODE_MASK)
  78 #define GET_DENY_MODE(x) (((x)>>DENY_MODE_SHIFT) & DENY_MODE_MASK)
  79 #define SET_DENY_MODE(x) (((x) & DENY_MODE_MASK) <<DENY_MODE_SHIFT)
  80
  81 /* Sync on open file (not sure if used anymore... ?) */
  82 #define FILE_SYNC_OPENMODE (1<<14)
  83 #define GET_FILE_SYNC_OPENMODE(x) (((x) & FILE_SYNC_OPENMODE) ? True : False)
  84
  85 /* open disposition values */
  86 #define OPENX_FILE_EXISTS_FAIL 0
  87 #define OPENX_FILE_EXISTS_OPEN 1
  88 #define OPENX_FILE_EXISTS_TRUNCATE 2
  89
  90 /* mask for open disposition. */
  91 #define OPENX_FILE_OPEN_MASK 0x3
  92
  93 #define GET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
  94 #define SET_FILE_OPENX_DISPOSITION(x) ((x) & FILE_OPEN_MASK)
  95
  96 /* The above can be OR'ed with... */
  97 #define OPENX_FILE_CREATE_IF_NOT_EXIST 0x10
  98 #define OPENX_FILE_FAIL_IF_NOT_EXIST 0
  99
 100 /* pipe string names */
 101
 102 #ifndef MAXSUBAUTHS
 103 #define MAXSUBAUTHS 15 /* max sub authorities in a SID */
 104 #endif
 105
 106 #define SID_MAX_SIZE ((size_t)(8+(MAXSUBAUTHS*4)))
 107
 108 #include "librpc/gen_ndr/security.h"
 109
 110 struct share_mode_entry;
 111 struct uuid;
 112 struct named_mutex;
 113 struct wb_context;
 114 struct rpc_cli_smbd_conn;
 115
 116 /* the basic packet size, assuming no words or bytes */
 117 #define smb_size 39
 118
 119 struct notify_change {
 120         uint32_t action;
 121         const char *name;
 122 };
 123
 124 struct notify_mid_map;
 125 struct notify_db_entry;
 126 struct notify_event;
 127 struct notify_change_request;
 128 struct sys_notify_context {
 129         struct tevent_context *ev;
 130         void *private_data;     /* For use by the system backend */
 131 };
 132
 133 #include "ntquotas.h"
 134 #include "sysquotas.h"
 135
 136 /* Include VFS stuff */
 137
 138 #include "smb_acls.h"
 139 #include "lib/readdir_attr.h"
 140 #include "vfs.h"
 141
 142 struct current_user {
 143         struct connection_struct *conn;
 144         uint64_t vuid; /* SMB2 compat */
 145         struct security_unix_token ut;
 146         struct security_token *nt_user_token;
 147 };
 148
 149 /* Defines for the sent_oplock_break field above. */
 150 #define NO_BREAK_SENT 0
 151 #define BREAK_TO_NONE_SENT 1
 152 #define LEVEL_II_BREAK_SENT 2
 153
 154 typedef struct {
 155         fstring smb_name; /* user name from the client */
 156         fstring unix_name; /* unix user name of a validated user */
 157         fstring domain; /* domain that the client specified */
 158 } userdom_struct;
 159
 160 /* used for network interfaces */
 161 struct interface {
 162         struct interface *next, *prev;
 163         char *name;
 164         int flags;
 165         struct sockaddr_storage ip;
 166         struct sockaddr_storage netmask;
 167         struct sockaddr_storage bcast;
 168         uint32_t if_index;
 169         uint64_t linkspeed;
 170         uint32_t capability;
 171 };
 172
 173 #define SHARE_MODE_FLAG_POSIX_OPEN      0x1
 174
 175 #include "librpc/gen_ndr/server_id.h"
 176
 177 /* oplock break message definition - linearization of share_mode_entry.
 178
 179 Offset  Data                    length.
 180 0       struct server_id pid    4
 181 4       uint16_t op_mid         8
 182 12      uint16_t op_type        2
 183 14      uint32_t access_mask    4
 184 18      uint32_t share_access   4
 185 22      uint32_t private_options        4
 186 26      uint32_t time sec               4
 187 30      uint32_t time usec      4
 188 34      uint64_t dev            8 bytes
 189 42      uint64_t inode          8 bytes
 190 50      uint64_t extid          8 bytes
 191 58      unsigned long file_id   4 bytes
 192 62      uint32_t uid            4 bytes
 193 66      uint16_t flags          2 bytes
 194 68      uint32_t name_hash      4 bytes
 195 72
 196
 197 */
 198
 199 #define OP_BREAK_MSG_PID_OFFSET 0
 200 #define OP_BREAK_MSG_MID_OFFSET 4
 201 #define OP_BREAK_MSG_OP_TYPE_OFFSET 12
 202 #define OP_BREAK_MSG_ACCESS_MASK_OFFSET 14
 203 #define OP_BREAK_MSG_SHARE_ACCESS_OFFSET 18
 204 #define OP_BREAK_MSG_PRIV_OFFSET 22
 205 #define OP_BREAK_MSG_TIME_SEC_OFFSET 26
 206 #define OP_BREAK_MSG_TIME_USEC_OFFSET 30
 207 #define OP_BREAK_MSG_DEV_OFFSET 34
 208 #define OP_BREAK_MSG_INO_OFFSET 42
 209 #define OP_BREAK_MSG_EXTID_OFFSET 50
 210 #define OP_BREAK_MSG_FILE_ID_OFFSET 58
 211 #define OP_BREAK_MSG_UID_OFFSET 62
 212 #define OP_BREAK_MSG_FLAGS_OFFSET 66
 213 #define OP_BREAK_MSG_NAME_HASH_OFFSET 68
 214
 215 #define OP_BREAK_MSG_VNN_OFFSET 72
 216 #define MSG_SMB_SHARE_MODE_ENTRY_SIZE 76
 217
 218 #define NT_HASH_LEN 16
 219 #define LM_HASH_LEN 16
 220
 221 /* offsets into message for common items */
 222 #define smb_com         (NBT_HDR_SIZE+HDR_COM)
 223 #define smb_rcls        (NBT_HDR_SIZE+HDR_RCLS)
 224 #define smb_reh         (NBT_HDR_SIZE+HDR_REH)
 225 #define smb_err         (NBT_HDR_SIZE+HDR_ERR)
 226 #define smb_flg         (NBT_HDR_SIZE+HDR_FLG)
 227 #define smb_flg2        (NBT_HDR_SIZE+HDR_FLG2)
 228 #define smb_pidhigh     (NBT_HDR_SIZE+HDR_PIDHIGH)
 229 #define smb_ss_field    (NBT_HDR_SIZE+HDR_SS_FIELD)
 230 #define smb_tid         (NBT_HDR_SIZE+HDR_TID)
 231 #define smb_pid         (NBT_HDR_SIZE+HDR_PID)
 232 #define smb_uid         (NBT_HDR_SIZE+HDR_UID)
 233 #define smb_mid         (NBT_HDR_SIZE+HDR_MID)
 234 #define smb_wct         (NBT_HDR_SIZE+HDR_WCT)
 235 #define smb_vwv         (NBT_HDR_SIZE+HDR_VWV)
 236 #define smb_vwv0        (smb_vwv+( 0*2))
 237 #define smb_vwv1        (smb_vwv+( 1*2))
 238 #define smb_vwv2        (smb_vwv+( 2*2))
 239 #define smb_vwv3        (smb_vwv+( 3*2))
 240 #define smb_vwv4        (smb_vwv+( 4*2))
 241 #define smb_vwv5        (smb_vwv+( 5*2))
 242 #define smb_vwv6        (smb_vwv+( 6*2))
 243 #define smb_vwv7        (smb_vwv+( 7*2))
 244 #define smb_vwv8        (smb_vwv+( 8*2))
 245 #define smb_vwv9        (smb_vwv+( 9*2))
 246 #define smb_vwv10       (smb_vwv+(10*2))
 247 #define smb_vwv11       (smb_vwv+(11*2))
 248 #define smb_vwv12       (smb_vwv+(12*2))
 249 #define smb_vwv13       (smb_vwv+(13*2))
 250 #define smb_vwv14       (smb_vwv+(14*2))
 251 #define smb_vwv15       (smb_vwv+(15*2))
 252 #define smb_vwv16       (smb_vwv+(16*2))
 253 #define smb_vwv17       (smb_vwv+(17*2))
 254
 255 /* These are the NT transact_get_user_quota sub commands */
 256 #define TRANSACT_GET_USER_QUOTA_LIST_CONTINUE   0x0000
 257 #define TRANSACT_GET_USER_QUOTA_LIST_START      0x0100
 258 #define TRANSACT_GET_USER_QUOTA_FOR_SID         0x0101
 259
 260 /* Relevant IOCTL codes */
 261 #define IOCTL_QUERY_JOB_INFO      0x530060
 262
 263 /* these are the trans2 sub fields for primary requests */
 264 #define smb_tpscnt smb_vwv0
 265 #define smb_tdscnt smb_vwv1
 266 #define smb_mprcnt smb_vwv2
 267 #define smb_mdrcnt smb_vwv3
 268 #define smb_msrcnt smb_vwv4
 269 #define smb_flags smb_vwv5
 270 #define smb_timeout smb_vwv6
 271 #define smb_pscnt smb_vwv9
 272 #define smb_psoff smb_vwv10
 273 #define smb_dscnt smb_vwv11
 274 #define smb_dsoff smb_vwv12
 275 #define smb_suwcnt smb_vwv13
 276 #define smb_setup smb_vwv14
 277 #define smb_setup0 smb_setup
 278 #define smb_setup1 (smb_setup+2)
 279 #define smb_setup2 (smb_setup+4)
 280
 281 /* these are for the secondary requests */
 282 #define smb_spscnt smb_vwv2
 283 #define smb_spsoff smb_vwv3
 284 #define smb_spsdisp smb_vwv4
 285 #define smb_sdscnt smb_vwv5
 286 #define smb_sdsoff smb_vwv6
 287 #define smb_sdsdisp smb_vwv7
 288 #define smb_sfid smb_vwv8
 289
 290 /* and these for responses */
 291 #define smb_tprcnt smb_vwv0
 292 #define smb_tdrcnt smb_vwv1
 293 #define smb_prcnt smb_vwv3
 294 #define smb_proff smb_vwv4
 295 #define smb_prdisp smb_vwv5
 296 #define smb_drcnt smb_vwv6
 297 #define smb_droff smb_vwv7
 298 #define smb_drdisp smb_vwv8
 299
 300 /* these are for the NT trans primary request. */
 301 #define smb_nt_MaxSetupCount smb_vwv0
 302 #define smb_nt_Flags (smb_vwv0 + 1)
 303 #define smb_nt_TotalParameterCount (smb_vwv0 + 3)
 304 #define smb_nt_TotalDataCount (smb_vwv0 + 7)
 305 #define smb_nt_MaxParameterCount (smb_vwv0 + 11)
 306 #define smb_nt_MaxDataCount (smb_vwv0 + 15)
 307 #define smb_nt_ParameterCount (smb_vwv0 + 19)
 308 #define smb_nt_ParameterOffset (smb_vwv0 + 23)
 309 #define smb_nt_DataCount (smb_vwv0 + 27)
 310 #define smb_nt_DataOffset (smb_vwv0 + 31)
 311 #define smb_nt_SetupCount (smb_vwv0 + 35)
 312 #define smb_nt_Function (smb_vwv0 + 36)
 313 #define smb_nt_SetupStart (smb_vwv0 + 38)
 314
 315 /* these are for the NT trans secondary request. */
 316 #define smb_nts_TotalParameterCount (smb_vwv0 + 3)
 317 #define smb_nts_TotalDataCount (smb_vwv0 + 7)
 318 #define smb_nts_ParameterCount (smb_vwv0 + 11)
 319 #define smb_nts_ParameterOffset (smb_vwv0 + 15)
 320 #define smb_nts_ParameterDisplacement (smb_vwv0 + 19)
 321 #define smb_nts_DataCount (smb_vwv0 + 23)
 322 #define smb_nts_DataOffset (smb_vwv0 + 27)
 323 #define smb_nts_DataDisplacement (smb_vwv0 + 31)
 324
 325 /* these are for the NT trans reply. */
 326 #define smb_ntr_TotalParameterCount (smb_vwv0 + 3)
 327 #define smb_ntr_TotalDataCount (smb_vwv0 + 7)
 328 #define smb_ntr_ParameterCount (smb_vwv0 + 11)
 329 #define smb_ntr_ParameterOffset (smb_vwv0 + 15)
 330 #define smb_ntr_ParameterDisplacement (smb_vwv0 + 19)
 331 #define smb_ntr_DataCount (smb_vwv0 + 23)
 332 #define smb_ntr_DataOffset (smb_vwv0 + 27)
 333 #define smb_ntr_DataDisplacement (smb_vwv0 + 31)
 334
 335 /* these are for the NT create_and_X */
 336 #define smb_ntcreate_NameLength (smb_vwv0 + 5)
 337 #define smb_ntcreate_Flags (smb_vwv0 + 7)
 338 #define smb_ntcreate_RootDirectoryFid (smb_vwv0 + 11)
 339 #define smb_ntcreate_DesiredAccess (smb_vwv0 + 15)
 340 #define smb_ntcreate_AllocationSize (smb_vwv0 + 19)
 341 #define smb_ntcreate_FileAttributes (smb_vwv0 + 27)
 342 #define smb_ntcreate_ShareAccess (smb_vwv0 + 31)
 343 #define smb_ntcreate_CreateDisposition (smb_vwv0 + 35)
 344 #define smb_ntcreate_CreateOptions (smb_vwv0 + 39)
 345 #define smb_ntcreate_ImpersonationLevel (smb_vwv0 + 43)
 346 #define smb_ntcreate_SecurityFlags (smb_vwv0 + 47)
 347
 348 /* Named pipe write mode flags. Used in writeX calls. */
 349 #define PIPE_RAW_MODE 0x4
 350 #define PIPE_START_MESSAGE 0x8
 351
 352 /* the desired access to use when opening a pipe */
 353 #define DESIRED_ACCESS_PIPE 0x2019f
 354
 355 /* Mapping of access rights to UNIX perms. */
 356 #define UNIX_ACCESS_RWX         FILE_GENERIC_ALL
 357 #define UNIX_ACCESS_R           FILE_GENERIC_READ
 358 #define UNIX_ACCESS_W           FILE_GENERIC_WRITE
 359 #define UNIX_ACCESS_X           FILE_GENERIC_EXECUTE
 360
 361 /* Mapping of access rights to UNIX perms. for a UNIX directory. */
 362 #define UNIX_DIRECTORY_ACCESS_RWX               FILE_GENERIC_ALL
 363 #define UNIX_DIRECTORY_ACCESS_R                 FILE_GENERIC_READ
 364 #define UNIX_DIRECTORY_ACCESS_W                 (FILE_GENERIC_WRITE|FILE_DELETE_CHILD)
 365 #define UNIX_DIRECTORY_ACCESS_X                 FILE_GENERIC_EXECUTE
 366
 367 #if 0
 368 /*
 369  * This is the old mapping we used to use. To get W2KSP2 profiles
 370  * working we need to map to the canonical file perms.
 371  */
 372 #define UNIX_ACCESS_RWX (UNIX_ACCESS_R|UNIX_ACCESS_W|UNIX_ACCESS_X)
 373 #define UNIX_ACCESS_R (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
 374                         FILE_READ_ATTRIBUTES|FILE_READ_EA|FILE_READ_DATA)
 375 #define UNIX_ACCESS_W (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
 376                         FILE_WRITE_ATTRIBUTES|FILE_WRITE_EA|\
 377                         FILE_APPEND_DATA|FILE_WRITE_DATA)
 378 #define UNIX_ACCESS_X (READ_CONTROL_ACCESS|SYNCHRONIZE_ACCESS|\
 379                         FILE_EXECUTE|FILE_READ_ATTRIBUTES)
 380 #endif
 381
 382 #define UNIX_ACCESS_NONE (WRITE_OWNER_ACCESS)
 383
 384 /* Flags field. */
 385 #define REQUEST_OPLOCK 2
 386 #define REQUEST_BATCH_OPLOCK 4
 387 #define OPEN_DIRECTORY 8
 388 #define EXTENDED_RESPONSE_REQUIRED 0x10
 389
 390 #define NTCREATEX_OPTIONS_MUST_IGNORE_MASK      (0x008F0480)
 391
 392 #define NTCREATEX_OPTIONS_INVALID_PARAM_MASK    (0xFF100030)
 393
 394 /*
 395  * Private flags used by the ntcreatex processing
 396  * code. Passed in the private_flags argument.
 397  */
 398 #define NTCREATEX_FLAG_DENY_DOS                 0x0001
 399 #define NTCREATEX_FLAG_DENY_FCB                 0x0002
 400
 401 /* Private flag for streams support */
 402 #define NTCREATEX_FLAG_STREAM_BASEOPEN          0x0010
 403
 404 /* Flag for NT transact rename call. */
 405 #define RENAME_REPLACE_IF_EXISTS 1
 406
 407 /* flags for SMBntrename call (from Samba4) */
 408 #define RENAME_FLAG_MOVE_CLUSTER_INFORMATION 0x102 /* ???? */
 409 #define RENAME_FLAG_HARD_LINK                0x103
 410 #define RENAME_FLAG_RENAME                   0x104
 411 #define RENAME_FLAG_COPY                     0x105
 412
 413 /* ChangeNotify flags. */
 414 #define FILE_NOTIFY_CHANGE_FILE_NAME   0x001
 415 #define FILE_NOTIFY_CHANGE_DIR_NAME    0x002
 416 #define FILE_NOTIFY_CHANGE_ATTRIBUTES  0x004
 417 #define FILE_NOTIFY_CHANGE_SIZE        0x008
 418 #define FILE_NOTIFY_CHANGE_LAST_WRITE  0x010
 419 #define FILE_NOTIFY_CHANGE_LAST_ACCESS 0x020
 420 #define FILE_NOTIFY_CHANGE_CREATION    0x040
 421 #define FILE_NOTIFY_CHANGE_EA          0x080
 422 #define FILE_NOTIFY_CHANGE_SECURITY    0x100
 423 #define FILE_NOTIFY_CHANGE_STREAM_NAME  0x00000200
 424 #define FILE_NOTIFY_CHANGE_STREAM_SIZE  0x00000400
 425 #define FILE_NOTIFY_CHANGE_STREAM_WRITE 0x00000800
 426
 427 #define FILE_NOTIFY_CHANGE_NAME \
 428         (FILE_NOTIFY_CHANGE_FILE_NAME|FILE_NOTIFY_CHANGE_DIR_NAME)
 429
 430 #define FILE_NOTIFY_CHANGE_ALL \
 431         (FILE_NOTIFY_CHANGE_FILE_NAME   | FILE_NOTIFY_CHANGE_DIR_NAME | \
 432          FILE_NOTIFY_CHANGE_ATTRIBUTES  | FILE_NOTIFY_CHANGE_SIZE | \
 433          FILE_NOTIFY_CHANGE_LAST_WRITE  | FILE_NOTIFY_CHANGE_LAST_ACCESS | \
 434          FILE_NOTIFY_CHANGE_CREATION    | FILE_NOTIFY_CHANGE_EA | \
 435          FILE_NOTIFY_CHANGE_SECURITY    | FILE_NOTIFY_CHANGE_STREAM_NAME | \
 436          FILE_NOTIFY_CHANGE_STREAM_SIZE | FILE_NOTIFY_CHANGE_STREAM_WRITE)
 437
 438 /* change notify action results */
 439 #define NOTIFY_ACTION_ADDED 1
 440 #define NOTIFY_ACTION_REMOVED 2
 441 #define NOTIFY_ACTION_MODIFIED 3
 442 #define NOTIFY_ACTION_OLD_NAME 4
 443 #define NOTIFY_ACTION_NEW_NAME 5
 444 #define NOTIFY_ACTION_ADDED_STREAM 6
 445 #define NOTIFY_ACTION_REMOVED_STREAM 7
 446 #define NOTIFY_ACTION_MODIFIED_STREAM 8
 447
 448 /* where to find the base of the SMB packet proper */
 449 #define smb_base(buf) (((const char *)(buf))+4)
 450
 451 /* we don't allow server strings to be longer than 48 characters as
 452    otherwise NT will not honour the announce packets */
 453 #define MAX_SERVER_STRING_LENGTH 48
 454
 455 #ifdef NOSTRDUP
 456 char *strdup(char *s);
 457 #endif
 458
 459 #ifndef SELECT_CAST
 460 #define SELECT_CAST
 461 #endif
 462
 463 /* This was set by JHT in liaison with Jeremy Allison early 1997
 464  * History:
 465  * Version 4.0 - never made public
 466  * Version 4.10 - New to 1.9.16p2, lost in space 1.9.16p3 to 1.9.16p9
 467  *              - Reappeared in 1.9.16p11 with fixed smbd services
 468  * Version 4.20 - To indicate that nmbd and browsing now works better
 469  * Version 4.50 - Set at release of samba-2.2.0 by JHT
 470  *
 471  *  Note: In the presence of NT4.X do not set above 4.9
 472  *        Setting this above 4.9 can have undesired side-effects.
 473  *        This may change again in Samba-3.0 after further testing. JHT
 474  *
 475  * Version 6.1 - For older smb server versions, MMC doesn't let offline
 476  *               settings to be configured during share creation. Changing
 477  *               it to 6.1 to mimic Win2K8R2.
 478  *
 479  */
 480
 481 #define SAMBA_MAJOR_NBT_ANNOUNCE_VERSION 0x06
 482 #define SAMBA_MINOR_NBT_ANNOUNCE_VERSION 0x01
 483
 484 /* Browser Election Values */
 485 #define BROWSER_ELECTION_VERSION        0x010f
 486 #define BROWSER_CONSTANT        0xaa55
 487
 488 /* File Status Flags. See:
 489
 490 http://msdn.microsoft.com/en-us/library/cc246334(PROT.13).aspx
 491 */
 492
 493 #define NO_EAS                  0x1
 494 #define NO_SUBSTREAMS           0x2
 495 #define NO_REPARSETAG           0x4
 496
 497 /* Remote architectures we know about, keep in sync with remote_arch_strings */
 498 enum remote_arch_types {RA_UNKNOWN, RA_WFWG, RA_OS2, RA_WIN95, RA_WINNT,
 499                         RA_WIN2K, RA_WINXP, RA_WIN2K3, RA_VISTA,
 500                         RA_SAMBA, RA_CIFSFS, RA_WINXP64, RA_OSX};
 501
 502 /*
 503  * Global value meaning that the smb_uid field should be
 504  * ignored (in share level security and protocol level == CORE)
 505  */
 506
 507 #define UID_FIELD_INVALID 0
 508 #define VUID_OFFSET 100 /* Amount to bias returned vuid numbers */
 509
 510 #define TID_FIELD_INVALID 0
 511
 512 #define FNUM_FIELD_INVALID 0
 513
 514 /*
 515  * Map the Core and Extended Oplock request bits down
 516  * to common bits (EXCLUSIVE_OPLOCK & BATCH_OPLOCK).
 517  */
 518
 519 /*
 520  * Core protocol.
 521  */
 522 #define CORE_OPLOCK_REQUEST(inbuf) \
 523     ((CVAL(inbuf,smb_flg)&(FLAG_REQUEST_OPLOCK|FLAG_REQUEST_BATCH_OPLOCK))>>5)
 524
 525 /*
 526  * Extended protocol.
 527  */
 528 #define EXTENDED_OPLOCK_REQUEST(inbuf) ((SVAL(inbuf,smb_vwv2)&((1<<1)|(1<<2)))>>1)
 529
 530 /*
 531  * Bits we test with.
 532  * Note these must fit into 16-bits.
 533  */
 534
 535 #define NO_OPLOCK                       OPLOCK_NONE
 536 #define EXCLUSIVE_OPLOCK                OPLOCK_EXCLUSIVE
 537 #define BATCH_OPLOCK                    OPLOCK_BATCH
 538 #define LEVEL_II_OPLOCK                 OPLOCK_LEVEL_II
 539 #define LEASE_OPLOCK                    0x100
 540
 541 /* The following are Samba-private. */
 542 #define INTERNAL_OPEN_ONLY              0x8
 543 /* #define FAKE_LEVEL_II_OPLOCK         0x10 */   /* Not used anymore */
 544                                 /* Client requested no_oplock, but we have to
 545                                  * inform potential level2 holders on
 546                                  * write. */
 547 /* #define DEFERRED_OPEN_ENTRY          0x20 */   /* Not used anymore */
 548 /* #define UNUSED_SHARE_MODE_ENTRY      0x40 */   /* Not used anymore */
 549 /* #define FORCE_OPLOCK_BREAK_TO_NONE   0x80 */   /* Not used anymore */
 550
 551 /* None of the following should ever appear in fsp->oplock_request. */
 552 #define SAMBA_PRIVATE_OPLOCK_MASK (INTERNAL_OPEN_ONLY)
 553
 554 #define EXCLUSIVE_OPLOCK_TYPE(lck) ((lck) & ((unsigned int)EXCLUSIVE_OPLOCK|(unsigned int)BATCH_OPLOCK))
 555 #define BATCH_OPLOCK_TYPE(lck) ((lck) & (unsigned int)BATCH_OPLOCK)
 556 #define LEVEL_II_OPLOCK_TYPE(lck) ((lck) & (unsigned int)LEVEL_II_OPLOCK)
 557
 558 /* kernel_oplock_message definition.
 559
 560 struct kernel_oplock_message {
 561         uint64_t dev;
 562         uint64_t inode;
 563         unit64_t extid;
 564         unsigned long file_id;
 565 };
 566
 567 Offset  Data                  length.
 568 0     uint64_t dev            8 bytes
 569 8     uint64_t inode          8 bytes
 570 16    uint64_t extid          8 bytes
 571 24    unsigned long file_id   4 bytes
 572 28
 573
 574 */
 575 #define MSG_SMB_KERNEL_BREAK_SIZE 28
 576
 577 /*
 578  * On the wire return values for oplock types.
 579  */
 580
 581 #define CORE_OPLOCK_GRANTED (1<<5)
 582 #define EXTENDED_OPLOCK_GRANTED (1<<15)
 583
 584 #define NO_OPLOCK_RETURN 0
 585 #define EXCLUSIVE_OPLOCK_RETURN 1
 586 #define BATCH_OPLOCK_RETURN 2
 587 #define LEVEL_II_OPLOCK_RETURN 3
 588
 589 /* Oplock levels */
 590 #define OPLOCKLEVEL_NONE 0
 591 #define OPLOCKLEVEL_II 1
 592
 593 /*
 594  * Capabilities abstracted for different systems.
 595  */
 596
 597 enum smbd_capability {
 598     KERNEL_OPLOCK_CAPABILITY,
 599     DMAPI_ACCESS_CAPABILITY,
 600     LEASE_CAPABILITY,
 601     DAC_OVERRIDE_CAPABILITY
 602 };
 603
 604 struct kernel_oplocks_ops;
 605 struct kernel_oplocks {
 606         const struct kernel_oplocks_ops *ops;
 607         void *private_data;
 608 };
 609
 610 enum level2_contention_type {
 611         LEVEL2_CONTEND_ALLOC_SHRINK,
 612         LEVEL2_CONTEND_ALLOC_GROW,
 613         LEVEL2_CONTEND_SET_FILE_LEN,
 614         LEVEL2_CONTEND_FILL_SPARSE,
 615         LEVEL2_CONTEND_WRITE,
 616         LEVEL2_CONTEND_WINDOWS_BRL,
 617         LEVEL2_CONTEND_POSIX_BRL
 618 };
 619
 620 /* if a kernel does support oplocks then a structure of the following
 621    typee is used to describe how to interact with the kernel */
 622 struct kernel_oplocks_ops {
 623         bool (*set_oplock)(struct kernel_oplocks *ctx,
 624                            files_struct *fsp, int oplock_type);
 625         void (*release_oplock)(struct kernel_oplocks *ctx,
 626                                files_struct *fsp, int oplock_type);
 627 };
 628
 629 #include "smb_macros.h"
 630
 631 #define MAX_NETBIOSNAME_LEN 16
 632 /* DOS character, NetBIOS namestring. Type used on the wire. */
 633 typedef char nstring[MAX_NETBIOSNAME_LEN];
 634 /* Unix character, NetBIOS namestring. Type used to manipulate name in nmbd. */
 635 typedef char unstring[MAX_NETBIOSNAME_LEN*4];
 636
 637 /* A netbios name structure. */
 638 struct nmb_name {
 639         nstring      name;
 640         char         scope[64];
 641         unsigned int name_type;
 642 };
 643
 644 /* A netbios node status array element. */
 645 struct node_status {
 646         nstring name;
 647         unsigned char type;
 648         unsigned char flags;
 649 };
 650
 651 /* The extra info from a NetBIOS node status query */
 652 struct node_status_extra {
 653         unsigned char mac_addr[6];
 654         /* There really is more here ... */
 655 };
 656
 657 #define SAFE_NETBIOS_CHARS ". -_"
 658
 659 #define PORT_NONE       0
 660 #ifndef LDAP_PORT
 661 #define LDAP_PORT       389
 662 #endif
 663 #define LDAP_GC_PORT    3268
 664
 665 struct ea_struct {
 666         uint8_t flags;
 667         char *name;
 668         DATA_BLOB value;
 669 };
 670
 671 struct ea_list {
 672         struct ea_list *next, *prev;
 673         struct ea_struct ea;
 674 };
 675
 676 /* EA names used internally in Samba. KEEP UP TO DATE with prohibited_ea_names in trans2.c !. */
 677 #define SAMBA_POSIX_INHERITANCE_EA_NAME "user.SAMBA_PAI"
 678 /* EA to use for DOS attributes */
 679 #define SAMBA_XATTR_DOS_ATTRIB "user.DOSATTRIB"
 680 /* Prefix for DosStreams in the vfs_streams_xattr module */
 681 #define SAMBA_XATTR_DOSSTREAM_PREFIX "user.DosStream."
 682 /* Prefix for xattrs storing streams. */
 683 #define SAMBA_XATTR_MARKER "user.SAMBA_STREAMS"
 684
 685 /* usershare error codes. */
 686 enum usershare_err {
 687                 USERSHARE_OK=0,
 688                 USERSHARE_MALFORMED_FILE,
 689                 USERSHARE_BAD_VERSION,
 690                 USERSHARE_MALFORMED_PATH,
 691                 USERSHARE_MALFORMED_COMMENT_DEF,
 692                 USERSHARE_MALFORMED_ACL_DEF,
 693                 USERSHARE_ACL_ERR,
 694                 USERSHARE_PATH_NOT_ABSOLUTE,
 695                 USERSHARE_PATH_IS_DENIED,
 696                 USERSHARE_PATH_NOT_ALLOWED,
 697                 USERSHARE_PATH_NOT_DIRECTORY,
 698                 USERSHARE_POSIX_ERR,
 699                 USERSHARE_MALFORMED_SHARENAME_DEF,
 700                 USERSHARE_BAD_SHARENAME
 701 };
 702
 703 /* Different reasons for closing a file. */
 704 enum file_close_type {NORMAL_CLOSE=0,SHUTDOWN_CLOSE,ERROR_CLOSE};
 705
 706 /* Used in SMB_FS_OBJECTID_INFORMATION requests.  Must be exactly 48 bytes. */
 707 #define SAMBA_EXTENDED_INFO_MAGIC 0x536d4261 /* "SmBa" */
 708 #define SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH 28
 709 struct smb_extended_info {
 710         uint32_t samba_magic;           /* Always SAMBA_EXTRA_INFO_MAGIC */
 711         uint32_t samba_version;         /* Major/Minor/Release/Revision */
 712         uint32_t samba_subversion;      /* Prerelease/RC/Vendor patch */
 713         NTTIME samba_gitcommitdate;
 714         char   samba_version_string[SAMBA_EXTENDED_INFO_VERSION_STRING_LENGTH];
 715 };
 716
 717 #endif /* _SMB_H */