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