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