fs/cifs/Kconfig

   1 # SPDX-License-Identifier: GPL-2.0-only
   2 config CIFS
   3         tristate "SMB3 and CIFS support (advanced network filesystem)"
   4         depends on INET
   5         select NLS
   6         select CRYPTO
   7         select CRYPTO_MD4
   8         select CRYPTO_MD5
   9         select CRYPTO_SHA256
  10         select CRYPTO_SHA512
  11         select CRYPTO_CMAC
  12         select CRYPTO_HMAC
  13         select CRYPTO_ARC4
  14         select CRYPTO_AEAD2
  15         select CRYPTO_CCM
  16         select CRYPTO_GCM
  17         select CRYPTO_ECB
  18         select CRYPTO_AES
  19         select CRYPTO_DES
  20         help
  21           This is the client VFS module for the SMB3 family of NAS protocols,
  22           (including support for the most recent, most secure dialect SMB3.1.1)
  23           as well as for earlier dialects such as SMB2.1, SMB2 and the older
  24           Common Internet File System (CIFS) protocol.  CIFS was the successor
  25           to the original dialect, the Server Message Block (SMB) protocol, the
  26           native file sharing mechanism for most early PC operating systems.
  27
  28           The SMB3 protocol is supported by most modern operating systems
  29           and NAS appliances (e.g. Samba, Windows 10, Windows Server 2016,
  30           MacOS) and even in the cloud (e.g. Microsoft Azure).
  31           The older CIFS protocol was included in Windows NT4, 2000 and XP (and
  32           later) as well by Samba (which provides excellent CIFS and SMB3
  33           server support for Linux and many other operating systems). Use of
  34           dialects older than SMB2.1 is often discouraged on public networks.
  35           This module also provides limited support for OS/2 and Windows ME
  36           and similar very old servers.
  37
  38           This module provides an advanced network file system client
  39           for mounting to SMB3 (and CIFS) compliant servers.  It includes
  40           support for DFS (hierarchical name space), secure per-user
  41           session establishment via Kerberos or NTLM or NTLMv2, RDMA
  42           (smbdirect), advanced security features, per-share encryption,
  43           directory leases, safe distributed caching (oplock), optional packet
  44           signing, Unicode and other internationalization improvements.
  45
  46           In general, the default dialects, SMB3 and later, enable better
  47           performance, security and features, than would be possible with CIFS.
  48           Note that when mounting to Samba, due to the CIFS POSIX extensions,
  49           CIFS mounts can provide slightly better POSIX compatibility
  50           than SMB3 mounts. SMB2/SMB3 mount options are also
  51           slightly simpler (compared to CIFS) due to protocol improvements.
  52
  53           If you need to mount to Samba, Azure, Macs or Windows from this machine, say Y.
  54
  55 config CIFS_STATS2
  56         bool "Extended statistics"
  57         depends on CIFS
  58         help
  59           Enabling this option will allow more detailed statistics on SMB
  60           request timing to be displayed in /proc/fs/cifs/DebugData and also
  61           allow optional logging of slow responses to dmesg (depending on the
  62           value of /proc/fs/cifs/cifsFYI, see fs/cifs/README for more details).
  63           These additional statistics may have a minor effect on performance
  64           and memory utilization.
  65
  66           Unless you are a developer or are doing network performance analysis
  67           or tuning, say N.
  68
  69 config CIFS_ALLOW_INSECURE_LEGACY
  70         bool "Support legacy servers which use less secure dialects"
  71         depends on CIFS
  72         default y
  73         help
  74           Modern dialects, SMB2.1 and later (including SMB3 and 3.1.1), have
  75           additional security features, including protection against
  76           man-in-the-middle attacks and stronger crypto hashes, so the use
  77           of legacy dialects (SMB1/CIFS and SMB2.0) is discouraged.
  78
  79           Disabling this option prevents users from using vers=1.0 or vers=2.0
  80           on mounts with cifs.ko
  81
  82           If unsure, say Y.
  83
  84 config CIFS_WEAK_PW_HASH
  85         bool "Support legacy servers which use weaker LANMAN security"
  86         depends on CIFS && CIFS_ALLOW_INSECURE_LEGACY
  87         help
  88           Modern CIFS servers including Samba and most Windows versions
  89           (since 1997) support stronger NTLM (and even NTLMv2 and Kerberos)
  90           security mechanisms. These hash the password more securely
  91           than the mechanisms used in the older LANMAN version of the
  92           SMB protocol but LANMAN based authentication is needed to
  93           establish sessions with some old SMB servers.
  94
  95           Enabling this option allows the cifs module to mount to older
  96           LANMAN based servers such as OS/2 and Windows 95, but such
  97           mounts may be less secure than mounts using NTLM or more recent
  98           security mechanisms if you are on a public network.  Unless you
  99           have a need to access old SMB servers (and are on a private
 100           network) you probably want to say N.  Even if this support
 101           is enabled in the kernel build, LANMAN authentication will not be
 102           used automatically. At runtime LANMAN mounts are disabled but
 103           can be set to required (or optional) either in
 104           /proc/fs/cifs (see fs/cifs/README for more detail) or via an
 105           option on the mount command. This support is disabled by
 106           default in order to reduce the possibility of a downgrade
 107           attack.
 108
 109           If unsure, say N.
 110
 111 config CIFS_UPCALL
 112         bool "Kerberos/SPNEGO advanced session setup"
 113         depends on CIFS && KEYS
 114         select DNS_RESOLVER
 115         help
 116           Enables an upcall mechanism for CIFS which accesses userspace helper
 117           utilities to provide SPNEGO packaged (RFC 4178) Kerberos tickets
 118           which are needed to mount to certain secure servers (for which more
 119           secure Kerberos authentication is required). If unsure, say Y.
 120
 121 config CIFS_XATTR
 122         bool "CIFS extended attributes"
 123         depends on CIFS
 124         help
 125           Extended attributes are name:value pairs associated with inodes by
 126           the kernel or by users (see the attr(5) manual page for details).
 127           CIFS maps the name of extended attributes beginning with the user
 128           namespace prefix to SMB/CIFS EAs.  EAs are stored on Windows
 129           servers without the user namespace prefix, but their names are
 130           seen by Linux cifs clients prefaced by the user namespace prefix.
 131           The system namespace (used by some filesystems to store ACLs) is
 132           not supported at this time.
 133
 134           If unsure, say Y.
 135
 136 config CIFS_POSIX
 137         bool "CIFS POSIX Extensions"
 138         depends on CIFS && CIFS_ALLOW_INSECURE_LEGACY && CIFS_XATTR
 139         help
 140           Enabling this option will cause the cifs client to attempt to
 141           negotiate a newer dialect with servers, such as Samba 3.0.5
 142           or later, that optionally can handle more POSIX like (rather
 143           than Windows like) file behavior.  It also enables
 144           support for POSIX ACLs (getfacl and setfacl) to servers
 145           (such as Samba 3.10 and later) which can negotiate
 146           CIFS POSIX ACL support.  If unsure, say N.
 147
 148 config CIFS_ACL
 149         bool "Provide CIFS ACL support"
 150         depends on CIFS_XATTR && KEYS
 151         help
 152           Allows fetching CIFS/NTFS ACL from the server.  The DACL blob
 153           is handed over to the application/caller.  See the man
 154           page for getcifsacl for more information.  If unsure, say Y.
 155
 156 config CIFS_DEBUG
 157         bool "Enable CIFS debugging routines"
 158         default y
 159         depends on CIFS
 160         help
 161           Enabling this option adds helpful debugging messages to
 162           the cifs code which increases the size of the cifs module.
 163           If unsure, say Y.
 164
 165 config CIFS_DEBUG2
 166         bool "Enable additional CIFS debugging routines"
 167         depends on CIFS_DEBUG
 168         help
 169           Enabling this option adds a few more debugging routines
 170           to the cifs code which slightly increases the size of
 171           the cifs module and can cause additional logging of debug
 172           messages in some error paths, slowing performance. This
 173           option can be turned off unless you are debugging
 174           cifs problems.  If unsure, say N.
 175
 176 config CIFS_DEBUG_DUMP_KEYS
 177         bool "Dump encryption keys for offline decryption (Unsafe)"
 178         depends on CIFS_DEBUG
 179         help
 180           Enabling this will dump the encryption and decryption keys
 181           used to communicate on an encrypted share connection on the
 182           console. This allows Wireshark to decrypt and dissect
 183           encrypted network captures. Enable this carefully.
 184           If unsure, say N.
 185
 186 config CIFS_DFS_UPCALL
 187         bool "DFS feature support"
 188         depends on CIFS && KEYS
 189         select DNS_RESOLVER
 190         help
 191           Distributed File System (DFS) support is used to access shares
 192           transparently in an enterprise name space, even if the share
 193           moves to a different server.  This feature also enables
 194           an upcall mechanism for CIFS which contacts userspace helper
 195           utilities to provide server name resolution (host names to
 196           IP addresses) which is needed in order to reconnect to
 197           servers if their addresses change or for implicit mounts of
 198           DFS junction points. If unsure, say Y.
 199
 200 config CIFS_NFSD_EXPORT
 201         bool "Allow nfsd to export CIFS file system"
 202         depends on CIFS && BROKEN
 203         help
 204           Allows NFS server to export a CIFS mounted share (nfsd over cifs)
 205
 206 config CIFS_SMB_DIRECT
 207         bool "SMB Direct support (Experimental)"
 208         depends on CIFS=m && INFINIBAND && INFINIBAND_ADDR_TRANS || CIFS=y && INFINIBAND=y && INFINIBAND_ADDR_TRANS=y
 209         help
 210           Enables SMB Direct experimental support for SMB 3.0, 3.02 and 3.1.1.
 211           SMB Direct allows transferring SMB packets over RDMA. If unsure,
 212           say N.
 213
 214 config CIFS_FSCACHE
 215         bool "Provide CIFS client caching support"
 216         depends on CIFS=m && FSCACHE || CIFS=y && FSCACHE=y
 217         help
 218           Makes CIFS FS-Cache capable. Say Y here if you want your CIFS data
 219           to be cached locally on disk through the general filesystem cache
 220           manager. If unsure, say N.