blob: 35c83fe7dba0115007a344821d0a4d5dfcbbd23d [file] [log] [blame]
Alexey Dobriyanbb26b962008-10-18 20:28:49 -07001config CIFS
Steve French2a38e122017-07-08 18:48:15 -05002 tristate "SMB3 and CIFS support (advanced network filesystem)"
Alexey Dobriyanbb26b962008-10-18 20:28:49 -07003 depends on INET
4 select NLS
Shirish Pargaonkard2b91522010-10-21 14:25:08 -05005 select CRYPTO
Jeff Laytonf855f6c2011-01-31 08:41:36 -05006 select CRYPTO_MD4
Shirish Pargaonkard2b91522010-10-21 14:25:08 -05007 select CRYPTO_MD5
Benjamin Gilbert5b454a62017-10-19 13:09:29 -07008 select CRYPTO_SHA256
9 select CRYPTO_CMAC
Steve French362d3122010-11-14 03:34:30 +000010 select CRYPTO_HMAC
Shirish Pargaonkard2b91522010-10-21 14:25:08 -050011 select CRYPTO_ARC4
Benjamin Gilbert5b454a62017-10-19 13:09:29 -070012 select CRYPTO_AEAD2
13 select CRYPTO_CCM
Suresh Jayaraman5f0b23e2011-06-03 14:19:01 +053014 select CRYPTO_ECB
Benjamin Gilbert5b454a62017-10-19 13:09:29 -070015 select CRYPTO_AES
Steve French43988d72011-04-19 18:23:31 +000016 select CRYPTO_DES
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070017 help
Steve French2a38e122017-07-08 18:48:15 -050018 This is the client VFS module for the SMB3 family of NAS protocols,
Steve French0fdfef92018-06-28 19:30:23 -050019 (including support for the most recent, most secure dialect SMB3.1.1)
20 as well as for earlier dialects such as SMB2.1, SMB2 and the older
Steve French2a38e122017-07-08 18:48:15 -050021 Common Internet File System (CIFS) protocol. CIFS was the successor
22 to the original dialect, the Server Message Block (SMB) protocol, the
23 native file sharing mechanism for most early PC operating systems.
24
Steve French0fdfef92018-06-28 19:30:23 -050025 The SMB3 protocol is supported by most modern operating systems
26 and NAS appliances (e.g. Samba, Windows 10, Windows Server 2016,
27 MacOS) and even in the cloud (e.g. Microsoft Azure).
Steve French2a38e122017-07-08 18:48:15 -050028 The older CIFS protocol was included in Windows NT4, 2000 and XP (and
29 later) as well by Samba (which provides excellent CIFS and SMB3
Steve French0fdfef92018-06-28 19:30:23 -050030 server support for Linux and many other operating systems). Use of
31 dialects older than SMB2.1 is often discouraged on public networks.
32 This module also provides limited support for OS/2 and Windows ME
33 and similar very old servers.
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070034
Steve French0fdfef92018-06-28 19:30:23 -050035 This module provides an advanced network file system client
Steve French2a38e122017-07-08 18:48:15 -050036 for mounting to SMB3 (and CIFS) compliant servers. It includes
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070037 support for DFS (hierarchical name space), secure per-user
Steve French0fdfef92018-06-28 19:30:23 -050038 session establishment via Kerberos or NTLM or NTLMv2, RDMA
39 (smbdirect), advanced security features, per-share encryption,
40 directory leases, safe distributed caching (oplock), optional packet
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070041 signing, Unicode and other internationalization improvements.
Steve French2a38e122017-07-08 18:48:15 -050042
43 In general, the default dialects, SMB3 and later, enable better
44 performance, security and features, than would be possible with CIFS.
45 Note that when mounting to Samba, due to the CIFS POSIX extensions,
46 CIFS mounts can provide slightly better POSIX compatibility
47 than SMB3 mounts. SMB2/SMB3 mount options are also
48 slightly simpler (compared to CIFS) due to protocol improvements.
49
Steve French0fdfef92018-06-28 19:30:23 -050050 If you need to mount to Samba, Azure, Macs or Windows from this machine, say Y.
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070051
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070052config CIFS_STATS2
53 bool "Extended statistics"
Steve Frenchfcabb892018-07-31 01:21:37 -050054 depends on CIFS
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070055 help
56 Enabling this option will allow more detailed statistics on SMB
57 request timing to be displayed in /proc/fs/cifs/DebugData and also
58 allow optional logging of slow responses to dmesg (depending on the
59 value of /proc/fs/cifs/cifsFYI, see fs/cifs/README for more details).
60 These additional statistics may have a minor effect on performance
61 and memory utilization.
62
63 Unless you are a developer or are doing network performance analysis
64 or tuning, say N.
65
Steve French74204512018-06-19 14:34:08 -050066config CIFS_ALLOW_INSECURE_LEGACY
67 bool "Support legacy servers which use less secure dialects"
68 depends on CIFS
69 default y
70 help
71 Modern dialects, SMB2.1 and later (including SMB3 and 3.1.1), have
72 additional security features, including protection against
73 man-in-the-middle attacks and stronger crypto hashes, so the use
74 of legacy dialects (SMB1/CIFS and SMB2.0) is discouraged.
75
76 Disabling this option prevents users from using vers=1.0 or vers=2.0
77 on mounts with cifs.ko
78
79 If unsure, say Y.
80
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070081config CIFS_WEAK_PW_HASH
82 bool "Support legacy servers which use weaker LANMAN security"
Steve French74204512018-06-19 14:34:08 -050083 depends on CIFS && CIFS_ALLOW_INSECURE_LEGACY
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070084 help
85 Modern CIFS servers including Samba and most Windows versions
86 (since 1997) support stronger NTLM (and even NTLMv2 and Kerberos)
87 security mechanisms. These hash the password more securely
88 than the mechanisms used in the older LANMAN version of the
89 SMB protocol but LANMAN based authentication is needed to
90 establish sessions with some old SMB servers.
91
92 Enabling this option allows the cifs module to mount to older
93 LANMAN based servers such as OS/2 and Windows 95, but such
94 mounts may be less secure than mounts using NTLM or more recent
95 security mechanisms if you are on a public network. Unless you
96 have a need to access old SMB servers (and are on a private
97 network) you probably want to say N. Even if this support
98 is enabled in the kernel build, LANMAN authentication will not be
99 used automatically. At runtime LANMAN mounts are disabled but
100 can be set to required (or optional) either in
101 /proc/fs/cifs (see fs/cifs/README for more detail) or via an
102 option on the mount command. This support is disabled by
103 default in order to reduce the possibility of a downgrade
104 attack.
105
106 If unsure, say N.
107
108config CIFS_UPCALL
Wang Lei1a4240f2010-08-04 15:16:33 +0100109 bool "Kerberos/SPNEGO advanced session setup"
110 depends on CIFS && KEYS
111 select DNS_RESOLVER
112 help
113 Enables an upcall mechanism for CIFS which accesses userspace helper
114 utilities to provide SPNEGO packaged (RFC 4178) Kerberos tickets
115 which are needed to mount to certain secure servers (for which more
Steve French2a38e122017-07-08 18:48:15 -0500116 secure Kerberos authentication is required). If unsure, say Y.
Alexey Dobriyanbb26b962008-10-18 20:28:49 -0700117
118config CIFS_XATTR
119 bool "CIFS extended attributes"
120 depends on CIFS
121 help
122 Extended attributes are name:value pairs associated with inodes by
Adam Borowski91581e42017-12-20 14:58:52 +0100123 the kernel or by users (see the attr(5) manual page for details).
124 CIFS maps the name of extended attributes beginning with the user
125 namespace prefix to SMB/CIFS EAs. EAs are stored on Windows
126 servers without the user namespace prefix, but their names are
127 seen by Linux cifs clients prefaced by the user namespace prefix.
128 The system namespace (used by some filesystems to store ACLs) is
129 not supported at this time.
Alexey Dobriyanbb26b962008-10-18 20:28:49 -0700130
Steve French2a38e122017-07-08 18:48:15 -0500131 If unsure, say Y.
Alexey Dobriyanbb26b962008-10-18 20:28:49 -0700132
133config CIFS_POSIX
134 bool "CIFS POSIX Extensions"
135 depends on CIFS_XATTR
136 help
137 Enabling this option will cause the cifs client to attempt to
138 negotiate a newer dialect with servers, such as Samba 3.0.5
139 or later, that optionally can handle more POSIX like (rather
140 than Windows like) file behavior. It also enables
141 support for POSIX ACLs (getfacl and setfacl) to servers
142 (such as Samba 3.10 and later) which can negotiate
143 CIFS POSIX ACL support. If unsure, say N.
144
Steve French1d4ab902012-10-01 12:48:03 -0500145config CIFS_ACL
146 bool "Provide CIFS ACL support"
147 depends on CIFS_XATTR && KEYS
148 help
149 Allows fetching CIFS/NTFS ACL from the server. The DACL blob
Steve Frenchca5d13f2014-08-22 04:40:46 -0500150 is handed over to the application/caller. See the man
Steve French2a38e122017-07-08 18:48:15 -0500151 page for getcifsacl for more information. If unsure, say Y.
Steve French1d4ab902012-10-01 12:48:03 -0500152
Joe Perches471b1f92012-12-05 12:42:58 -0800153config CIFS_DEBUG
154 bool "Enable CIFS debugging routines"
155 default y
156 depends on CIFS
157 help
158 Enabling this option adds helpful debugging messages to
159 the cifs code which increases the size of the cifs module.
160 If unsure, say Y.
Alexey Dobriyanbb26b962008-10-18 20:28:49 -0700161config CIFS_DEBUG2
162 bool "Enable additional CIFS debugging routines"
Joe Perches471b1f92012-12-05 12:42:58 -0800163 depends on CIFS_DEBUG
Alexey Dobriyanbb26b962008-10-18 20:28:49 -0700164 help
165 Enabling this option adds a few more debugging routines
166 to the cifs code which slightly increases the size of
167 the cifs module and can cause additional logging of debug
168 messages in some error paths, slowing performance. This
169 option can be turned off unless you are debugging
170 cifs problems. If unsure, say N.
171
Aurélien Apteld38de3c62017-05-24 16:13:25 +0200172config CIFS_DEBUG_DUMP_KEYS
173 bool "Dump encryption keys for offline decryption (Unsafe)"
Steve French2a38e122017-07-08 18:48:15 -0500174 depends on CIFS_DEBUG
Aurélien Apteld38de3c62017-05-24 16:13:25 +0200175 help
176 Enabling this will dump the encryption and decryption keys
177 used to communicate on an encrypted share connection on the
178 console. This allows Wireshark to decrypt and dissect
179 encrypted network captures. Enable this carefully.
Steve French2a38e122017-07-08 18:48:15 -0500180 If unsure, say N.
Aurélien Apteld38de3c62017-05-24 16:13:25 +0200181
Steve French10e70af2009-02-22 01:33:07 +0000182config CIFS_DFS_UPCALL
183 bool "DFS feature support"
184 depends on CIFS && KEYS
Wang Lei1a4240f2010-08-04 15:16:33 +0100185 select DNS_RESOLVER
Steve French10e70af2009-02-22 01:33:07 +0000186 help
187 Distributed File System (DFS) support is used to access shares
188 transparently in an enterprise name space, even if the share
189 moves to a different server. This feature also enables
190 an upcall mechanism for CIFS which contacts userspace helper
191 utilities to provide server name resolution (host names to
192 IP addresses) which is needed for implicit mounts of DFS junction
Steve French2a38e122017-07-08 18:48:15 -0500193 points. If unsure, say Y.
Steve French10e70af2009-02-22 01:33:07 +0000194
Shirish Pargaonkar25720872011-02-25 10:48:55 -0600195config CIFS_NFSD_EXPORT
Kees Cook00f36162013-01-16 18:54:09 -0800196 bool "Allow nfsd to export CIFS file system"
197 depends on CIFS && BROKEN
Alexey Dobriyanbb26b962008-10-18 20:28:49 -0700198 help
Shirish Pargaonkar25720872011-02-25 10:48:55 -0600199 Allows NFS server to export a CIFS mounted share (nfsd over cifs)
Steve French675f36f2011-02-24 17:58:00 +0000200
Long Li2b6ed882017-11-07 01:54:54 -0700201config CIFS_SMB_DIRECT
202 bool "SMB Direct support (Experimental)"
Arnd Bergmann533d1da2018-05-25 23:29:59 +0200203 depends on CIFS=m && INFINIBAND && INFINIBAND_ADDR_TRANS || CIFS=y && INFINIBAND=y && INFINIBAND_ADDR_TRANS=y
Long Li2b6ed882017-11-07 01:54:54 -0700204 help
205 Enables SMB Direct experimental support for SMB 3.0, 3.02 and 3.1.1.
206 SMB Direct allows transferring SMB packets over RDMA. If unsure,
207 say N.
208
Steve French1d4ab902012-10-01 12:48:03 -0500209config CIFS_FSCACHE
210 bool "Provide CIFS client caching support"
211 depends on CIFS=m && FSCACHE || CIFS=y && FSCACHE=y
212 help
213 Makes CIFS FS-Cache capable. Say Y here if you want your CIFS data
214 to be cached locally on disk through the general filesystem cache
215 manager. If unsure, say N.
216