libcli/smb/smb_unix_ext.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB transaction2 handling
   4
   5    Copyright (C) James Peach 2007
   6    Copyright (C) Jeremy Allison 1994-2002.
   7
   8    Extensively modified by Andrew Tridgell, 1995
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22 */
  23
  24 #ifndef __SMB_UNIX_EXT_H__
  25 #define __SMB_UNIX_EXT_H__
  26
  27 /* UNIX CIFS Extensions - created by HP */
  28 /*
  29  * UNIX CIFS Extensions have the range 0x200 - 0x2FF reserved.
  30  * Supposedly Microsoft have agreed to this.
  31  */
  32
  33 #define MIN_UNIX_INFO_LEVEL 0x200
  34 #define MAX_UNIX_INFO_LEVEL 0x2FF
  35
  36 #define SMB_QUERY_FILE_UNIX_BASIC      0x200   /* UNIX File Info*/
  37 #define SMB_SET_FILE_UNIX_BASIC        0x200
  38 #define SMB_SET_FILE_UNIX_INFO2        0x20B   /* UNIX File Info2 */
  39
  40 #define SMB_MODE_NO_CHANGE                 0xFFFFFFFF     /* file mode value which */
  41                                               /* means "don't change it" */
  42 #define SMB_UID_NO_CHANGE                  0xFFFFFFFF
  43 #define SMB_GID_NO_CHANGE                  0xFFFFFFFF
  44
  45 #define SMB_SIZE_NO_CHANGE_LO              0xFFFFFFFF
  46 #define SMB_SIZE_NO_CHANGE_HI              0xFFFFFFFF
  47
  48 #define SMB_TIME_NO_CHANGE_LO              0xFFFFFFFF
  49 #define SMB_TIME_NO_CHANGE_HI              0xFFFFFFFF
  50
  51 /*
  52 Offset Size         Name
  53 0      LARGE_INTEGER EndOfFile                File size
  54 8      LARGE_INTEGER Blocks                   Number of bytes used on disk (st_blocks).
  55 16     LARGE_INTEGER CreationTime             Creation time
  56 24     LARGE_INTEGER LastAccessTime           Last access time
  57 32     LARGE_INTEGER LastModificationTime     Last modification time
  58 40     LARGE_INTEGER Uid                      Numeric user id for the owner
  59 48     LARGE_INTEGER Gid                      Numeric group id of owner
  60 56     ULONG Type                             Enumeration specifying the pathname type:
  61                                               0 -- File
  62                                               1 -- Directory
  63                                               2 -- Symbolic link
  64                                               3 -- Character device
  65                                               4 -- Block device
  66                                               5 -- FIFO (named pipe)
  67                                               6 -- Unix domain socket
  68
  69 60     LARGE_INTEGER devmajor                 Major device number if type is device
  70 68     LARGE_INTEGER devminor                 Minor device number if type is device
  71 76     LARGE_INTEGER uniqueid                 This is a server-assigned unique id for the file. The client
  72                                               will typically map this onto an inode number. The scope of
  73                                               uniqueness is the share.
  74 84     LARGE_INTEGER permissions              Standard UNIX file permissions  - see below.
  75 92     LARGE_INTEGER nlinks                   The number of directory entries that map to this entry
  76                                               (number of hard links)
  77
  78 100 - end.
  79 */
  80
  81 #define SMB_FILE_UNIX_BASIC_SIZE 100
  82
  83 /* UNIX filetype mappings. */
  84
  85 #define UNIX_TYPE_FILE 0
  86 #define UNIX_TYPE_DIR 1
  87 #define UNIX_TYPE_SYMLINK 2
  88 #define UNIX_TYPE_CHARDEV 3
  89 #define UNIX_TYPE_BLKDEV 4
  90 #define UNIX_TYPE_FIFO 5
  91 #define UNIX_TYPE_SOCKET 6
  92 #define UNIX_TYPE_UNKNOWN 0xFFFFFFFF
  93
  94 /*
  95  * Oh this is fun. "Standard UNIX permissions" has no
  96  * meaning in POSIX. We need to define the mapping onto
  97  * and off the wire as this was not done in the original HP
  98  * spec. JRA.
  99  */
 100
 101 #define UNIX_X_OTH                      0000001
 102 #define UNIX_W_OTH                      0000002
 103 #define UNIX_R_OTH                      0000004
 104 #define UNIX_X_GRP                      0000010
 105 #define UNIX_W_GRP                      0000020
 106 #define UNIX_R_GRP                      0000040
 107 #define UNIX_X_USR                      0000100
 108 #define UNIX_W_USR                      0000200
 109 #define UNIX_R_USR                      0000400
 110 #define UNIX_STICKY                     0001000
 111 #define UNIX_SET_GID                    0002000
 112 #define UNIX_SET_UID                    0004000
 113
 114 /* Masks for the above */
 115 #define UNIX_OTH_MASK                   0000007
 116 #define UNIX_GRP_MASK                   0000070
 117 #define UNIX_USR_MASK                   0000700
 118 #define UNIX_PERM_MASK                  0000777
 119 #define UNIX_EXTRA_MASK                 0007000
 120 #define UNIX_ALL_MASK                   0007777
 121
 122 /* Flags for chflags (CIFS_UNIX_EXTATTR_CAP capability) and
 123  * SMB_QUERY_FILE_UNIX_INFO2.
 124  */
 125 #define EXT_SECURE_DELETE               0x00000001
 126 #define EXT_ENABLE_UNDELETE             0x00000002
 127 #define EXT_SYNCHRONOUS                 0x00000004
 128 #define EXT_IMMUTABLE                   0x00000008
 129 #define EXT_OPEN_APPEND_ONLY            0x00000010
 130 #define EXT_DO_NOT_BACKUP               0x00000020
 131 #define EXT_NO_UPDATE_ATIME             0x00000040
 132 #define EXT_HIDDEN                      0x00000080
 133
 134 #define SMB_QUERY_FILE_UNIX_LINK       0x201
 135 #define SMB_SET_FILE_UNIX_LINK         0x201
 136 #define SMB_SET_FILE_UNIX_HLINK        0x203
 137 /* SMB_QUERY_POSIX_ACL 0x204 see below */
 138 #define SMB_QUERY_XATTR                0x205 /* need for non-user XATTRs */
 139 #define SMB_QUERY_ATTR_FLAGS           0x206 /* chflags, chattr */
 140 #define SMB_SET_ATTR_FLAGS             0x206
 141 #define SMB_QUERY_POSIX_PERMISSION     0x207
 142 /* Only valid for qfileinfo */
 143 #define SMB_QUERY_POSIX_LOCK           0x208
 144 /* Only valid for setfileinfo */
 145 #define SMB_SET_POSIX_LOCK             0x208
 146
 147 /* The set info levels for POSIX path operations. */
 148 #define SMB_POSIX_PATH_OPEN            0x209
 149 #define SMB_POSIX_PATH_UNLINK          0x20A
 150
 151 #define SMB_QUERY_FILE_UNIX_INFO2      0x20B   /* UNIX File Info2 */
 152 #define SMB_SET_FILE_UNIX_INFO2        0x20B
 153
 154 /*
 155 SMB_QUERY_FILE_UNIX_INFO2 is SMB_QUERY_FILE_UNIX_BASIC with create
 156 time and file flags appended. The corresponding info level for
 157 findfirst/findnext is SMB_FIND_FILE_UNIX_INFO2.
 158     Size    Offset  Value
 159     ---------------------
 160     0      LARGE_INTEGER EndOfFile  File size
 161     8      LARGE_INTEGER Blocks     Number of blocks used on disk
 162     16     LARGE_INTEGER ChangeTime Attribute change time
 163     24     LARGE_INTEGER LastAccessTime           Last access time
 164     32     LARGE_INTEGER LastModificationTime     Last modification time
 165     40     LARGE_INTEGER Uid        Numeric user id for the owner
 166     48     LARGE_INTEGER Gid        Numeric group id of owner
 167     56     ULONG Type               Enumeration specifying the file type
 168     60     LARGE_INTEGER devmajor   Major device number if type is device
 169     68     LARGE_INTEGER devminor   Minor device number if type is device
 170     76     LARGE_INTEGER uniqueid   This is a server-assigned unique id
 171     84     LARGE_INTEGER permissions            Standard UNIX permissions
 172     92     LARGE_INTEGER nlinks                 Number of hard links
 173     100    LARGE_INTEGER CreationTime           Create/birth time
 174     108    ULONG FileFlags          File flags enumeration
 175     112    ULONG FileFlagsMask      Mask of valid flags
 176 */
 177
 178 /* Transact 2 Find First levels */
 179 #define SMB_FIND_FILE_UNIX             0x202
 180 #define SMB_FIND_FILE_UNIX_INFO2       0x20B /* UNIX File Info2 */
 181
 182 #define SMB_FILE_UNIX_INFO2_SIZE 116
 183
 184 /*
 185  Info level for TRANS2_QFSINFO - returns version of CIFS UNIX extensions, plus
 186  64-bits worth of capability fun :-).
 187  Use the same info level for TRANS2_SETFSINFO
 188 */
 189
 190 #define SMB_QUERY_CIFS_UNIX_INFO      0x200
 191 #define SMB_SET_CIFS_UNIX_INFO        0x200
 192
 193 /* Returns or sets the following.
 194
 195   UINT16             major version number
 196   UINT16             minor version number
 197   LARGE_INTEGER      capability bitfield
 198
 199 */
 200
 201 #define CIFS_UNIX_MAJOR_VERSION 1
 202 #define CIFS_UNIX_MINOR_VERSION 0
 203
 204 #define CIFS_UNIX_FCNTL_LOCKS_CAP           0x1
 205 #define CIFS_UNIX_POSIX_ACLS_CAP            0x2
 206 #define CIFS_UNIX_XATTTR_CAP                0x4 /* for support of other xattr
 207                                                 namespaces such as system,
 208                                                 security and trusted */
 209 #define CIFS_UNIX_EXTATTR_CAP               0x8 /* for support of chattr
 210                                                 (chflags) and lsattr */
 211 #define CIFS_UNIX_POSIX_PATHNAMES_CAP      0x10 /* Use POSIX pathnames on the wire. */
 212 #define CIFS_UNIX_POSIX_PATH_OPERATIONS_CAP        0x20 /* We can cope with POSIX open/mkdir/unlink etc. */
 213 #define CIFS_UNIX_LARGE_READ_CAP           0x40 /* We can cope with 24 bit reads in readX. */
 214 #define CIFS_UNIX_LARGE_WRITE_CAP          0x80 /* We can cope with 24 bit writes in writeX. */
 215 #define CIFS_UNIX_TRANSPORT_ENCRYPTION_CAP      0x100 /* We can do SPNEGO negotiations for encryption. */
 216 #define CIFS_UNIX_TRANSPORT_ENCRYPTION_MANDATORY_CAP    0x200 /* We *must* SPNEGO negotiations for encryption. */
 217
 218 #define SMB_QUERY_POSIX_FS_INFO     0x201
 219
 220 /* Returns FILE_SYSTEM_POSIX_INFO struct as follows
 221       (NB   For undefined values return -1 in that field)
 222    le32 OptimalTransferSize;    bsize on some os, iosize on other os, This
 223                                 is a hint to the client about best size. Server
 224                                 can return -1 if no preference, ie if SMB
 225                                 negotiated size is adequate for optimal
 226                                 read/write performance
 227    le32 BlockSize; (often 512 bytes) NB: BlockSize * TotalBlocks = disk space
 228    le64 TotalBlocks;  redundant with other infolevels but easy to ret here
 229    le64 BlocksAvail;  although redundant, easy to return
 230    le64 UserBlocksAvail;      bavail
 231    le64 TotalFileNodes;
 232    le64 FreeFileNodes;
 233    le64 FileSysIdentifier;    fsid
 234    (NB statfs field Namelen comes from FILE_SYSTEM_ATTRIBUTE_INFO call)
 235    (NB statfs field flags can come from FILE_SYSTEM_DEVICE_INFO call)
 236 */
 237
 238 #define SMB_QUERY_POSIX_WHO_AM_I  0x202 /* QFS Info */
 239 /* returns:
 240         __u32 flags;  0 = Authenticated user 1 = GUEST
 241         __u32 mask;  which flags bits server understands ie 0x0001
 242         __u64 unix_user_id;
 243         __u64 unix_user_gid;
 244         __u32 number_of_supplementary_gids;  may be zero
 245         __u32 number_of_sids;  may be zero
 246         __u32 length_of_sid_array;  in bytes - may be zero
 247         __u32 pad;  reserved - MBZ
 248         __u64 gid_array[0];  may be empty
 249         __u8 * psid_list  may be empty
 250 */
 251
 252 /* ... more as we think of them :-). */
 253
 254 /* SMB POSIX ACL definitions. */
 255 /* Wire format is (all little endian) :
 256
 257 [2 bytes]              -     Version number.
 258 [2 bytes]              -     Number of ACE entries to follow.
 259 [2 bytes]              -     Number of default ACE entries to follow.
 260 -------------------------------------
 261 ^
 262 |
 263 ACE entries
 264 |
 265 v
 266 -------------------------------------
 267 ^
 268 |
 269 Default ACE entries
 270 |
 271 v
 272 -------------------------------------
 273
 274 Where an ACE entry looks like :
 275
 276 [1 byte]           - Entry type.
 277
 278 Entry types are :
 279
 280 ACL_USER_OBJ            0x01
 281 ACL_USER                0x02
 282 ACL_GROUP_OBJ           0x04
 283 ACL_GROUP               0x08
 284 ACL_MASK                0x10
 285 ACL_OTHER               0x20
 286
 287 [1 byte]          - permissions (perm_t)
 288
 289 perm_t types are :
 290
 291 ACL_READ                0x04
 292 ACL_WRITE               0x02
 293 ACL_EXECUTE             0x01
 294
 295 [8 bytes]         - uid/gid to apply this permission to.
 296
 297 In the same format as the uid/gid fields in the other
 298 UNIX extensions definitions. Use 0xFFFFFFFFFFFFFFFF for
 299 the MASK and OTHER entry types.
 300
 301 If the Number of ACE entries for either file or default ACE's
 302 is set to 0xFFFF this means ignore this kind of ACE (and the
 303 number of entries sent will be zero.
 304
 305 */
 306
 307 #define SMB_QUERY_POSIX_WHOAMI     0x202
 308
 309 enum smb_whoami_flags {
 310     SMB_WHOAMI_GUEST = 0x1 /* Logged in as (or squashed to) guest */
 311 };
 312
 313 /* Mask of which WHOAMI bits are valid. This should make it easier for clients
 314  * to cope with servers that have different sets of WHOAMI flags (as more get
 315  * added).
 316  */
 317 #define SMB_WHOAMI_MASK 0x00000001
 318
 319 /*
 320    SMBWhoami - Query the user mapping performed by the server for the
 321    connected tree. This is a subcommand of the TRANS2_QFSINFO.
 322
 323    Returns:
 324         4 bytes unsigned -      mapping flags (smb_whoami_flags)
 325         4 bytes unsigned -      flags mask
 326
 327         8 bytes unsigned -      primary UID
 328         8 bytes unsigned -      primary GID
 329         4 bytes unsigned -      number of supplementary GIDs
 330         4 bytes unsigned -      number of SIDs
 331         4 bytes unsigned -      SID list byte count
 332         4 bytes -               pad / reserved (must be zero)
 333
 334         8 bytes unsigned[] -    list of GIDs (may be empty)
 335         struct dom_sid[] -              list of SIDs (may be empty)
 336 */
 337
 338 /*
 339  * The following trans2 is done between client and server
 340  * as a FSINFO call to set up the encryption state for transport
 341  * encryption.
 342  * This is a subcommand of the TRANS2_QFSINFO.
 343  *
 344  * The request looks like :
 345  *
 346  * [data block] -> SPNEGO framed GSSAPI request.
 347  *
 348  * The reply looks like :
 349  *
 350  * [data block] -> SPNEGO framed GSSAPI reply - if error
 351  *                 is NT_STATUS_OK then we're done, if it's
 352  *                 NT_STATUS_MORE_PROCESSING_REQUIRED then the
 353  *                 client needs to keep going. If it's an
 354  *                 error it can be any NT_STATUS error.
 355  *
 356  */
 357
 358 #define SMB_REQUEST_TRANSPORT_ENCRYPTION     0x203 /* QFSINFO */
 359 #define SMB_ENCRYPTION_GSSAPI                0x8000
 360
 361 /* The query/set info levels for POSIX ACLs. */
 362 #define SMB_QUERY_POSIX_ACL  0x204
 363 #define SMB_SET_POSIX_ACL  0x204
 364
 365 /* Current on the wire ACL version. */
 366 #define SMB_POSIX_ACL_VERSION 1
 367
 368 /* ACE entry type. */
 369 #define SMB_POSIX_ACL_USER_OBJ            0x01
 370 #define SMB_POSIX_ACL_USER                0x02
 371 #define SMB_POSIX_ACL_GROUP_OBJ           0x04
 372 #define SMB_POSIX_ACL_GROUP               0x08
 373 #define SMB_POSIX_ACL_MASK                0x10
 374 #define SMB_POSIX_ACL_OTHER               0x20
 375
 376 /* perm_t types. */
 377 #define SMB_POSIX_ACL_READ                0x04
 378 #define SMB_POSIX_ACL_WRITE               0x02
 379 #define SMB_POSIX_ACL_EXECUTE             0x01
 380
 381 #define SMB_POSIX_ACL_HEADER_SIZE         6
 382 #define SMB_POSIX_ACL_ENTRY_SIZE         10
 383
 384 #define SMB_POSIX_IGNORE_ACE_ENTRIES    0xFFFF
 385
 386 /* Definition of data block of SMB_SET_POSIX_LOCK */
 387 /*
 388   [2 bytes] lock_type - 0 = Read, 1 = Write, 2 = Unlock
 389   [2 bytes] lock_flags - 1 = Wait (only valid for setlock)
 390   [4 bytes] pid = locking context.
 391   [8 bytes] start = unsigned 64 bits.
 392   [8 bytes] length = unsigned 64 bits.
 393 */
 394
 395 #define POSIX_LOCK_TYPE_OFFSET 0
 396 #define POSIX_LOCK_FLAGS_OFFSET 2
 397 #define POSIX_LOCK_PID_OFFSET 4
 398 #define POSIX_LOCK_START_OFFSET 8
 399 #define POSIX_LOCK_LEN_OFFSET 16
 400 #define POSIX_LOCK_DATA_SIZE 24
 401
 402 #define POSIX_LOCK_FLAG_NOWAIT 0
 403 #define POSIX_LOCK_FLAG_WAIT 1
 404
 405 #define POSIX_LOCK_TYPE_READ 0
 406 #define POSIX_LOCK_TYPE_WRITE 1
 407 #define POSIX_LOCK_TYPE_UNLOCK 2
 408
 409 /* SMB_POSIX_PATH_OPEN "open_mode" definitions. */
 410 #define SMB_O_RDONLY                      0x1
 411 #define SMB_O_WRONLY                      0x2
 412 #define SMB_O_RDWR                        0x4
 413
 414 #define SMB_ACCMODE                       0x7
 415
 416 #define SMB_O_CREAT                      0x10
 417 #define SMB_O_EXCL                       0x20
 418 #define SMB_O_TRUNC                      0x40
 419 #define SMB_O_APPEND                     0x80
 420 #define SMB_O_SYNC                      0x100
 421 #define SMB_O_DIRECTORY                 0x200
 422 #define SMB_O_NOFOLLOW                  0x400
 423 #define SMB_O_DIRECT                    0x800
 424
 425 /* Definition of request data block for SMB_POSIX_PATH_OPEN */
 426 /*
 427   [4 bytes] flags (as smb_ntcreate_Flags).
 428   [4 bytes] open_mode                   - SMB_O_xxx flags above.
 429   [8 bytes] mode_t (permissions)        - same encoding as "Standard UNIX permissions" above in SMB_SET_FILE_UNIX_BASIC.
 430   [2 bytes] ret_info_level      - optimization. Info level to be returned.
 431 */
 432
 433 /* Definition of reply data block for SMB_POSIX_PATH_OPEN */
 434
 435 #define SMB_NO_INFO_LEVEL_RETURNED 0xFFFF
 436
 437 /*
 438   [2 bytes] - flags field. Identical to flags reply for oplock response field in SMBNTCreateX)
 439   [2 bytes] - FID returned.
 440   [4 bytes] - CreateAction (same as in NTCreateX response).
 441   [2 bytes] - reply info level    - as requested or 0xFFFF if not available.
 442   [2 bytes] - padding (must be zero)
 443   [n bytes] - info level reply  - if available.
 444 */
 445
 446 /* Definition of request data block for SMB_POSIX_UNLINK */
 447 /*
 448   [2 bytes] flags (defined below).
 449 */
 450
 451 #define SMB_POSIX_UNLINK_FILE_TARGET 0
 452 #define SMB_POSIX_UNLINK_DIRECTORY_TARGET 1
 453
 454 #define INFO_LEVEL_IS_UNIX(level) ((((level) >= MIN_UNIX_INFO_LEVEL) && \
 455                         ((level) <= MAX_UNIX_INFO_LEVEL)) || \
 456                         ((level) == SMB2_FILE_POSIX_INFORMATION_INTERNAL))
 457
 458 #endif /* __SMB_UNIX_EXT_H__ */