blob: 76724efc831cf2f6c1707d0ab23c5aa7dc2cc07c [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
Stefan Metzmacher58901842018-09-07 18:24:17 +02009 select CRYPTO_SHA512
Benjamin Gilbert5b454a62017-10-19 13:09:29 -070010 select CRYPTO_CMAC
Steve French362d3122010-11-14 03:34:30 +000011 select CRYPTO_HMAC
Shirish Pargaonkard2b91522010-10-21 14:25:08 -050012 select CRYPTO_ARC4
Benjamin Gilbert5b454a62017-10-19 13:09:29 -070013 select CRYPTO_AEAD2
14 select CRYPTO_CCM
Suresh Jayaraman5f0b23e2011-06-03 14:19:01 +053015 select CRYPTO_ECB
Benjamin Gilbert5b454a62017-10-19 13:09:29 -070016 select CRYPTO_AES
Steve French43988d72011-04-19 18:23:31 +000017 select CRYPTO_DES
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070018 help
Steve French2a38e122017-07-08 18:48:15 -050019 This is the client VFS module for the SMB3 family of NAS protocols,
Steve French0fdfef92018-06-28 19:30:23 -050020 (including support for the most recent, most secure dialect SMB3.1.1)
21 as well as for earlier dialects such as SMB2.1, SMB2 and the older
Steve French2a38e122017-07-08 18:48:15 -050022 Common Internet File System (CIFS) protocol. CIFS was the successor
23 to the original dialect, the Server Message Block (SMB) protocol, the
24 native file sharing mechanism for most early PC operating systems.
25
Steve French0fdfef92018-06-28 19:30:23 -050026 The SMB3 protocol is supported by most modern operating systems
27 and NAS appliances (e.g. Samba, Windows 10, Windows Server 2016,
28 MacOS) and even in the cloud (e.g. Microsoft Azure).
Steve French2a38e122017-07-08 18:48:15 -050029 The older CIFS protocol was included in Windows NT4, 2000 and XP (and
30 later) as well by Samba (which provides excellent CIFS and SMB3
Steve French0fdfef92018-06-28 19:30:23 -050031 server support for Linux and many other operating systems). Use of
32 dialects older than SMB2.1 is often discouraged on public networks.
33 This module also provides limited support for OS/2 and Windows ME
34 and similar very old servers.
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070035
Steve French0fdfef92018-06-28 19:30:23 -050036 This module provides an advanced network file system client
Steve French2a38e122017-07-08 18:48:15 -050037 for mounting to SMB3 (and CIFS) compliant servers. It includes
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070038 support for DFS (hierarchical name space), secure per-user
Steve French0fdfef92018-06-28 19:30:23 -050039 session establishment via Kerberos or NTLM or NTLMv2, RDMA
40 (smbdirect), advanced security features, per-share encryption,
41 directory leases, safe distributed caching (oplock), optional packet
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070042 signing, Unicode and other internationalization improvements.
Steve French2a38e122017-07-08 18:48:15 -050043
44 In general, the default dialects, SMB3 and later, enable better
45 performance, security and features, than would be possible with CIFS.
46 Note that when mounting to Samba, due to the CIFS POSIX extensions,
47 CIFS mounts can provide slightly better POSIX compatibility
48 than SMB3 mounts. SMB2/SMB3 mount options are also
49 slightly simpler (compared to CIFS) due to protocol improvements.
50
Steve French0fdfef92018-06-28 19:30:23 -050051 If you need to mount to Samba, Azure, Macs or Windows from this machine, say Y.
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070052
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070053config CIFS_STATS2
54 bool "Extended statistics"
Steve Frenchfcabb892018-07-31 01:21:37 -050055 depends on CIFS
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070056 help
57 Enabling this option will allow more detailed statistics on SMB
58 request timing to be displayed in /proc/fs/cifs/DebugData and also
59 allow optional logging of slow responses to dmesg (depending on the
60 value of /proc/fs/cifs/cifsFYI, see fs/cifs/README for more details).
61 These additional statistics may have a minor effect on performance
62 and memory utilization.
63
64 Unless you are a developer or are doing network performance analysis
65 or tuning, say N.
66
Steve French74204512018-06-19 14:34:08 -050067config CIFS_ALLOW_INSECURE_LEGACY
68 bool "Support legacy servers which use less secure dialects"
69 depends on CIFS
70 default y
71 help
72 Modern dialects, SMB2.1 and later (including SMB3 and 3.1.1), have
73 additional security features, including protection against
74 man-in-the-middle attacks and stronger crypto hashes, so the use
75 of legacy dialects (SMB1/CIFS and SMB2.0) is discouraged.
76
77 Disabling this option prevents users from using vers=1.0 or vers=2.0
78 on mounts with cifs.ko
79
80 If unsure, say Y.
81
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070082config CIFS_WEAK_PW_HASH
83 bool "Support legacy servers which use weaker LANMAN security"
Steve French74204512018-06-19 14:34:08 -050084 depends on CIFS && CIFS_ALLOW_INSECURE_LEGACY
Alexey Dobriyanbb26b962008-10-18 20:28:49 -070085 help
86 Modern CIFS servers including Samba and most Windows versions
87 (since 1997) support stronger NTLM (and even NTLMv2 and Kerberos)
88 security mechanisms. These hash the password more securely
89 than the mechanisms used in the older LANMAN version of the
90 SMB protocol but LANMAN based authentication is needed to
91 establish sessions with some old SMB servers.
92
93 Enabling this option allows the cifs module to mount to older
94 LANMAN based servers such as OS/2 and Windows 95, but such
95 mounts may be less secure than mounts using NTLM or more recent
96 security mechanisms if you are on a public network. Unless you
97 have a need to access old SMB servers (and are on a private
98 network) you probably want to say N. Even if this support
99 is enabled in the kernel build, LANMAN authentication will not be
100 used automatically. At runtime LANMAN mounts are disabled but
101 can be set to required (or optional) either in
102 /proc/fs/cifs (see fs/cifs/README for more detail) or via an
103 option on the mount command. This support is disabled by
104 default in order to reduce the possibility of a downgrade
105 attack.
106
107 If unsure, say N.
108
109config CIFS_UPCALL
Wang Lei1a4240f2010-08-04 15:16:33 +0100110 bool "Kerberos/SPNEGO advanced session setup"
111 depends on CIFS && KEYS
112 select DNS_RESOLVER
113 help
114 Enables an upcall mechanism for CIFS which accesses userspace helper
115 utilities to provide SPNEGO packaged (RFC 4178) Kerberos tickets
116 which are needed to mount to certain secure servers (for which more
Steve French2a38e122017-07-08 18:48:15 -0500117 secure Kerberos authentication is required). If unsure, say Y.
Alexey Dobriyanbb26b962008-10-18 20:28:49 -0700118
119config CIFS_XATTR
Enrico Weigelt, metux IT consult50cfad72019-03-06 23:22:59 +0100120 bool "CIFS extended attributes"
121 depends on CIFS
122 help
123 Extended attributes are name:value pairs associated with inodes by
124 the kernel or by users (see the attr(5) manual page for details).
125 CIFS maps the name of extended attributes beginning with the user
126 namespace prefix to SMB/CIFS EAs. EAs are stored on Windows
127 servers without the user namespace prefix, but their names are
128 seen by Linux cifs clients prefaced by the user namespace prefix.
129 The system namespace (used by some filesystems to store ACLs) is
130 not supported at this time.
Alexey Dobriyanbb26b962008-10-18 20:28:49 -0700131
Enrico Weigelt, metux IT consult50cfad72019-03-06 23:22:59 +0100132 If unsure, say Y.
Alexey Dobriyanbb26b962008-10-18 20:28:49 -0700133
134config CIFS_POSIX
Enrico Weigelt, metux IT consult50cfad72019-03-06 23:22:59 +0100135 bool "CIFS POSIX Extensions"
136 depends on CIFS && CIFS_ALLOW_INSECURE_LEGACY && CIFS_XATTR
137 help
138 Enabling this option will cause the cifs client to attempt to
Alexey Dobriyanbb26b962008-10-18 20:28:49 -0700139 negotiate a newer dialect with servers, such as Samba 3.0.5
140 or later, that optionally can handle more POSIX like (rather
141 than Windows like) file behavior. It also enables
142 support for POSIX ACLs (getfacl and setfacl) to servers
143 (such as Samba 3.10 and later) which can negotiate
144 CIFS POSIX ACL support. If unsure, say N.
145
Steve French1d4ab902012-10-01 12:48:03 -0500146config CIFS_ACL
Enrico Weigelt, metux IT consult50cfad72019-03-06 23:22:59 +0100147 bool "Provide CIFS ACL support"
148 depends on CIFS_XATTR && KEYS
149 help
150 Allows fetching CIFS/NTFS ACL from the server. The DACL blob
151 is handed over to the application/caller. See the man
152 page for getcifsacl for more information. If unsure, say Y.
Steve French1d4ab902012-10-01 12:48:03 -0500153
Joe Perches471b1f92012-12-05 12:42:58 -0800154config CIFS_DEBUG
155 bool "Enable CIFS debugging routines"
156 default y
157 depends on CIFS
158 help
Enrico Weigelt, metux IT consult50cfad72019-03-06 23:22:59 +0100159 Enabling this option adds helpful debugging messages to
160 the cifs code which increases the size of the cifs module.
161 If unsure, say Y.
162
Alexey Dobriyanbb26b962008-10-18 20:28:49 -0700163config CIFS_DEBUG2
164 bool "Enable additional CIFS debugging routines"
Joe Perches471b1f92012-12-05 12:42:58 -0800165 depends on CIFS_DEBUG
Alexey Dobriyanbb26b962008-10-18 20:28:49 -0700166 help
Enrico Weigelt, metux IT consult50cfad72019-03-06 23:22:59 +0100167 Enabling this option adds a few more debugging routines
168 to the cifs code which slightly increases the size of
169 the cifs module and can cause additional logging of debug
170 messages in some error paths, slowing performance. This
171 option can be turned off unless you are debugging
172 cifs problems. If unsure, say N.
Alexey Dobriyanbb26b962008-10-18 20:28:49 -0700173
Aurélien Apteld38de3c62017-05-24 16:13:25 +0200174config CIFS_DEBUG_DUMP_KEYS
175 bool "Dump encryption keys for offline decryption (Unsafe)"
Steve French2a38e122017-07-08 18:48:15 -0500176 depends on CIFS_DEBUG
Aurélien Apteld38de3c62017-05-24 16:13:25 +0200177 help
Enrico Weigelt, metux IT consult50cfad72019-03-06 23:22:59 +0100178 Enabling this will dump the encryption and decryption keys
179 used to communicate on an encrypted share connection on the
180 console. This allows Wireshark to decrypt and dissect
181 encrypted network captures. Enable this carefully.
182 If unsure, say N.
Aurélien Apteld38de3c62017-05-24 16:13:25 +0200183
Steve French10e70af2009-02-22 01:33:07 +0000184config CIFS_DFS_UPCALL
Enrico Weigelt, metux IT consult50cfad72019-03-06 23:22:59 +0100185 bool "DFS feature support"
186 depends on CIFS && KEYS
187 select DNS_RESOLVER
188 help
189 Distributed File System (DFS) support is used to access shares
190 transparently in an enterprise name space, even if the share
191 moves to a different server. This feature also enables
192 an upcall mechanism for CIFS which contacts userspace helper
193 utilities to provide server name resolution (host names to
194 IP addresses) which is needed in order to reconnect to
195 servers if their addresses change or for implicit mounts of
196 DFS junction points. If unsure, say Y.
Steve French10e70af2009-02-22 01:33:07 +0000197
Shirish Pargaonkar25720872011-02-25 10:48:55 -0600198config CIFS_NFSD_EXPORT
Enrico Weigelt, metux IT consult50cfad72019-03-06 23:22:59 +0100199 bool "Allow nfsd to export CIFS file system"
200 depends on CIFS && BROKEN
201 help
202 Allows NFS server to export a CIFS mounted share (nfsd over cifs)
Steve French675f36f2011-02-24 17:58:00 +0000203
Long Li2b6ed882017-11-07 01:54:54 -0700204config CIFS_SMB_DIRECT
205 bool "SMB Direct support (Experimental)"
Arnd Bergmann533d1da2018-05-25 23:29:59 +0200206 depends on CIFS=m && INFINIBAND && INFINIBAND_ADDR_TRANS || CIFS=y && INFINIBAND=y && INFINIBAND_ADDR_TRANS=y
Long Li2b6ed882017-11-07 01:54:54 -0700207 help
208 Enables SMB Direct experimental support for SMB 3.0, 3.02 and 3.1.1.
209 SMB Direct allows transferring SMB packets over RDMA. If unsure,
210 say N.
211
Steve French1d4ab902012-10-01 12:48:03 -0500212config CIFS_FSCACHE
Enrico Weigelt, metux IT consult50cfad72019-03-06 23:22:59 +0100213 bool "Provide CIFS client caching support"
214 depends on CIFS=m && FSCACHE || CIFS=y && FSCACHE=y
215 help
216 Makes CIFS FS-Cache capable. Say Y here if you want your CIFS data
217 to be cached locally on disk through the general filesystem cache
218 manager. If unsure, say N.