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