SMB3-Linux

From SambaWiki
Revision as of 09:35, 25 May 2018 by Aaptel (talk | contribs) (Info level)

Jump to: navigation, search

There are various requirements for full POSIX compatibility, and other requirements which although not strictly POSIX (such as support for symlinks and the fallocate system call) are common in Linux and various Unix variants and useful to applications. The goal is to implement emulation strategies and extensions to the SMB3 protocol which are as small as reasonably possible but implement the most important of these missing features, allowing the network file system to appear nearly identical to a local file system to users and the applications they run, without creating unacceptable performance or configuration problems.

The general requirements for SMB3 POSIX extensions include the following:

  1. POSIX mode bits (the primitive 0777 bits used to control who can access a file)
  2. POSIX file ownership (UID and GID owners. Windows typically only has one or the other, and expresses them as global "SIDs" with longer UUIDs rather than locally defined UIDs)
  3. symlinks
  4. case sensitivity
  5. mapping 7 reserved characters (not allowed in SMB3/CIFS/NTFS/Windows but allowed in POSIX). They include: * ? < > : | \
  6. mkfifo and mknod
  7. POSIX unlink and rename behavior:
    1. unlink: deleting an open file, removing it from the namespace, occurs in POSIX but not Windows
    2. rename: renaming a directories that has open files, perfectly legal in POSIX but not in Windows (even recursivley)
  8. POSIX "advisory" byte range locks (SMB3 allows Windows style "mandatory" byte range locks). POSIX locks are also merged when they overlap, and all locks are released on file close making them both confusing to use (locally on Linux file systems, and even more so over network file systems) and more difficult to emulate. Although many dislike the POSIX byte range lock behavior, their implementation in SMB3 would help some applications.
  9. Slight differences in "stat" system call (and the mode/ownership information noted above)
  10. Additional information returned on the statfs" system call: f_files; /* total file nodes in file system */ and f_ffree; /* free file nodes in fs */
  11. "POSIX ACL" support. Linux implements an ACL model for local file systems which is less complex than the more common "RichACLs" (ie NFSv4 or NTFS/SMB/SMB3 ACLs) but easier to understand.
  12. fallocate: many fallocate options are available, most but not all are mappable to various existing SMB3 ioctls.


Current status:

  1. POSIX mode bits: emulatable via the "cifsacl" (cifs.ko mount option for cifs which pulls them from the server's "RichACL" (NTFS/SMB3/NFSv4). Using an approach similar to the "NFSv4 mode ACE" may be helpful as well. Prototype not complete. SMB3_SetACL and SMB3_GetACL worker functions for Linux's cifs.ko have been prototyped but not reviewed yet.

smbd status: can be set on create via a create context (POSIX extension).

  1. POSIX file ownership (see above).

smbd status: can be set on create via a create context (POSIX extension).

  1. symlinks: use the "mfsymlinks" approach used by Apple among others. Implemented in cifs.ko. Will be in kernel 3.18 and later. Should be backportable to earlier kernels.

smbd status: looks like this hasn't changed.

  1. case sensitivity: Not available yet, requires extension to SMB3 OpenCreate call - a new "POSIX Create Context" has been proposed.

smbd status: looks like this hasn't changed.

  1. mapping 7 reserved characters: There are three ways to do this: "POSIX Create Context" and Microsoft's "SFU" (SUA) mapping and Apple's "SFM" mapping. The SFU mapping is available in CIFS (and SMB3 in 3.18) with the "mapchars" mount option but we plan to use the Apple ("SFM") mapping approach by default in 3.18 kernel and later (Samba requires the "vfs_fruit" module to implement the Apple mapping of the seven reserved characters).

smbd status: looks like this hasn't changed.

  1. mkfifo and mknod: are emulated using the same approach that Microsoft SFU and others did. Uses the "sfu" mount option (available in 3.18 kernel or later).

smbd status: device nodes can be retrieved via POSIX info level (POSIX Extension).

  1. POSIX unlink and rename behavior. Emulatable over SMB3 for most cases (using "delete on close" and using an approach like "nfs silly rename"). 3.18 kernel will better handle these but "POSIX Create Context" are still likely to be required for a few use cases.

smbd status: looks like this hasn't changed.

  1. POSIX Advisory byte range locks: emulated via mandatory locks today, and can also be "local only" (with a cifs.ko mount option "nobrl"). Requires "POSIX Create Context"
  2. stat (see above)
  3. statfs: For the two fields which are not retrievable other ways (minor issue). "POSIX Create Context" can be used.

smbd status: looks like this done.

  1. POSIX ACLs: Could be mapped to SMB3/NTFS RichACLs which are a superset of POSIX ACLs. Also could be handled via "POSIX Create Context".

smbd status: looks like this done.

  1. fallocate (partially implemented already) and also a few other new Linux syscalls which are not broadly implemented: more research needed.

smbd status: looks like this hasn't changed.

samba POSIX extension status

As of 25-05-2018 from JRA's master-smb2 branch. Note that all integers are in Little-Endian.

Negotiate Context

SMB2_POSIX_EXTENSIONS 0x100

Actual length/fields not decided yet, use the context data length field.

Create Context

For client requests

New create context.

  • Context tag: SMB2_CREATE_TAG_POSIX "\x93\xAD\x25\x50\x9C\xB4\x11\xE7\xB4\x23\x83\xDE\x96\x8B\xCD\x7C"
  • Context payload size: 4 bytes

Unix perm mode to be used for the new file/dir. The bits used are as follow (note the values are in octal):

#define UNIX_X_OTH			0000001
#define UNIX_W_OTH			0000002
#define UNIX_R_OTH			0000004
#define UNIX_X_GRP			0000010
#define UNIX_W_GRP                      0000020
#define UNIX_R_GRP                      0000040
#define UNIX_X_USR                      0000100
#define UNIX_W_USR                      0000200
#define UNIX_R_USR                      0000400
#define UNIX_STICKY                     0001000
#define UNIX_SET_GID                    0002000
#define UNIX_SET_UID                    0004000

For server responses

The server can respond to CREATE request with this POSIX context too (same context tag).

  • Context payload size: Variable.
    • 12 + 2*(8 + 4*sid->num_auths) bytes
    • Maximum of 15 sub_auth => max length = 12 + 2*68 = 148 bytes
u32  SMB_STRUCT_STAT->st_ex_nlink // number of hardlinks
u32  FILE_FLAG_REPARSE            // "reparse_tag"
u32  unix_perms_to_wire(SMB_STRUCT_STAT->st_ex_mode & ~S_IFMT)
sid  sid_owner
sid  sid_group


A sid is encoded as follow:

u8  sid_rev_num
u8  num_auths (range 0-15)
[u32 sub_uath] * num_auths

Info level

New info level requestable via GETINFO or QUERY_DIR. The payload contains a POSIX Create Context response at the end.

  • Level value: SMB2_FIND_POSIX_INFORMATION 0x64
  • Payload length: Variable.
    • 68 + POSIXCreateContextResponse (see above)
    • Max = 68 + 148 = 216
u64 put_long_date_timespec(SMB_STRUCT_STAT->st_ex_btime) // birth
u64 put_long_date_timespec(SMB_STRUCT_STAT->st_ex_atime) // access
u64 put_long_date_timespec(SMB_STRUCT_STAT->st_ex_mtime) // last write
u64 put_long_date_timespec(SMB_STRUCT_STAT->st_ex_ctime) // change
u64 # bytes used on disk
u64 file size
u32 dos attributes
u64 inode
u64 SMB_STRUCT_STAT->st_ex_dev // device ID
u64 zero
POSIXCreateContextResponse (size=up to 148 bytes)

POSIX extensions codepaths

SMB2_OP_QUERY_DIRECTORY:
 smbd_smb2_request_process_query_directory
 smbd_smb2_query_directory_send
 smbd_dirptr_lanman2_entry
 smbd_marshall_dir_entry
  store_smb2_posix_info <--- sends info + posix cc rsp
    smb2_posix_cc_info
SMB2_OP_GETINFO:
smbd_smb2_getinfo_send
smbd_do_qfilepathinfo
  store_smb2_posix_info <--- sends info + posix cc rsp
    smb2_posix_cc_info
SMB2_OP_CREATE:
smbd_smb2_create_send
smbd_smb2_create_after_exec
    smb2_posix_cc_info  <--- sends POSIX create context resp