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