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