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