README 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743
  1. This module supports the SMB3 family of advanced network protocols (as well
  2. as older dialects, originally called "CIFS" or SMB1).
  3. The CIFS VFS module for Linux supports many advanced network filesystem
  4. features such as hierarchical DFS like namespace, hardlinks, locking and more.
  5. It was designed to comply with the SNIA CIFS Technical Reference (which
  6. supersedes the 1992 X/Open SMB Standard) as well as to perform best practice
  7. practical interoperability with Windows 2000, Windows XP, Samba and equivalent
  8. servers. This code was developed in participation with the Protocol Freedom
  9. Information Foundation. CIFS and now SMB3 has now become a defacto
  10. standard for interoperating between Macs and Windows and major NAS appliances.
  11. Please see
  12. MS-SMB2 (for detailed SMB2/SMB3/SMB3.1.1 protocol specification)
  13. http://protocolfreedom.org/ and
  14. http://samba.org/samba/PFIF/
  15. for more details.
  16. For questions or bug reports please contact:
  17. smfrench@gmail.com
  18. See the project page at: https://wiki.samba.org/index.php/LinuxCIFS_utils
  19. Build instructions:
  20. ==================
  21. For Linux:
  22. 1) Download the kernel (e.g. from http://www.kernel.org)
  23. and change directory into the top of the kernel directory tree
  24. (e.g. /usr/src/linux-2.5.73)
  25. 2) make menuconfig (or make xconfig)
  26. 3) select cifs from within the network filesystem choices
  27. 4) save and exit
  28. 5) make
  29. Installation instructions:
  30. =========================
  31. If you have built the CIFS vfs as module (successfully) simply
  32. type "make modules_install" (or if you prefer, manually copy the file to
  33. the modules directory e.g. /lib/modules/2.4.10-4GB/kernel/fs/cifs/cifs.ko).
  34. If you have built the CIFS vfs into the kernel itself, follow the instructions
  35. for your distribution on how to install a new kernel (usually you
  36. would simply type "make install").
  37. If you do not have the utility mount.cifs (in the Samba 4.x source tree and on
  38. the CIFS VFS web site) copy it to the same directory in which mount helpers
  39. reside (usually /sbin). Although the helper software is not
  40. required, mount.cifs is recommended. Most distros include a "cifs-utils"
  41. package that includes this utility so it is recommended to install this.
  42. Note that running the Winbind pam/nss module (logon service) on all of your
  43. Linux clients is useful in mapping Uids and Gids consistently across the
  44. domain to the proper network user. The mount.cifs mount helper can be
  45. found at cifs-utils.git on git.samba.org
  46. If cifs is built as a module, then the size and number of network buffers
  47. and maximum number of simultaneous requests to one server can be configured.
  48. Changing these from their defaults is not recommended. By executing modinfo
  49. modinfo kernel/fs/cifs/cifs.ko
  50. on kernel/fs/cifs/cifs.ko the list of configuration changes that can be made
  51. at module initialization time (by running insmod cifs.ko) can be seen.
  52. Recommendations
  53. ===============
  54. To improve security the SMB2.1 dialect or later (usually will get SMB3) is now
  55. the new default. To use old dialects (e.g. to mount Windows XP) use "vers=1.0"
  56. on mount (or vers=2.0 for Windows Vista). Note that the CIFS (vers=1.0) is
  57. much older and less secure than the default dialect SMB3 which includes
  58. many advanced security features such as downgrade attack detection
  59. and encrypted shares and stronger signing and authentication algorithms.
  60. There are additional mount options that may be helpful for SMB3 to get
  61. improved POSIX behavior (NB: can use vers=3.0 to force only SMB3, never 2.1):
  62. "mfsymlinks" and "cifsacl" and "idsfromsid"
  63. Allowing User Mounts
  64. ====================
  65. To permit users to mount and unmount over directories they own is possible
  66. with the cifs vfs. A way to enable such mounting is to mark the mount.cifs
  67. utility as suid (e.g. "chmod +s /sbin/mount.cifs). To enable users to
  68. umount shares they mount requires
  69. 1) mount.cifs version 1.4 or later
  70. 2) an entry for the share in /etc/fstab indicating that a user may
  71. unmount it e.g.
  72. //server/usersharename /mnt/username cifs user 0 0
  73. Note that when the mount.cifs utility is run suid (allowing user mounts),
  74. in order to reduce risks, the "nosuid" mount flag is passed in on mount to
  75. disallow execution of an suid program mounted on the remote target.
  76. When mount is executed as root, nosuid is not passed in by default,
  77. and execution of suid programs on the remote target would be enabled
  78. by default. This can be changed, as with nfs and other filesystems,
  79. by simply specifying "nosuid" among the mount options. For user mounts
  80. though to be able to pass the suid flag to mount requires rebuilding
  81. mount.cifs with the following flag: CIFS_ALLOW_USR_SUID
  82. There is a corresponding manual page for cifs mounting in the Samba 3.0 and
  83. later source tree in docs/manpages/mount.cifs.8
  84. Allowing User Unmounts
  85. ======================
  86. To permit users to ummount directories that they have user mounted (see above),
  87. the utility umount.cifs may be used. It may be invoked directly, or if
  88. umount.cifs is placed in /sbin, umount can invoke the cifs umount helper
  89. (at least for most versions of the umount utility) for umount of cifs
  90. mounts, unless umount is invoked with -i (which will avoid invoking a umount
  91. helper). As with mount.cifs, to enable user unmounts umount.cifs must be marked
  92. as suid (e.g. "chmod +s /sbin/umount.cifs") or equivalent (some distributions
  93. allow adding entries to a file to the /etc/permissions file to achieve the
  94. equivalent suid effect). For this utility to succeed the target path
  95. must be a cifs mount, and the uid of the current user must match the uid
  96. of the user who mounted the resource.
  97. Also note that the customary way of allowing user mounts and unmounts is
  98. (instead of using mount.cifs and unmount.cifs as suid) to add a line
  99. to the file /etc/fstab for each //server/share you wish to mount, but
  100. this can become unwieldy when potential mount targets include many
  101. or unpredictable UNC names.
  102. Samba Considerations
  103. ====================
  104. Most current servers support SMB2.1 and SMB3 which are more secure,
  105. but there are useful protocol extensions for the older less secure CIFS
  106. dialect, so to get the maximum benefit if mounting using the older dialect
  107. (CIFS/SMB1), we recommend using a server that supports the SNIA CIFS
  108. Unix Extensions standard (e.g. almost any version of Samba ie version
  109. 2.2.5 or later) but the CIFS vfs works fine with a wide variety of CIFS servers.
  110. Note that uid, gid and file permissions will display default values if you do
  111. not have a server that supports the Unix extensions for CIFS (such as Samba
  112. 2.2.5 or later). To enable the Unix CIFS Extensions in the Samba server, add
  113. the line:
  114. unix extensions = yes
  115. to your smb.conf file on the server. Note that the following smb.conf settings
  116. are also useful (on the Samba server) when the majority of clients are Unix or
  117. Linux:
  118. case sensitive = yes
  119. delete readonly = yes
  120. ea support = yes
  121. Note that server ea support is required for supporting xattrs from the Linux
  122. cifs client, and that EA support is present in later versions of Samba (e.g.
  123. 3.0.6 and later (also EA support works in all versions of Windows, at least to
  124. shares on NTFS filesystems). Extended Attribute (xattr) support is an optional
  125. feature of most Linux filesystems which may require enabling via
  126. make menuconfig. Client support for extended attributes (user xattr) can be
  127. disabled on a per-mount basis by specifying "nouser_xattr" on mount.
  128. The CIFS client can get and set POSIX ACLs (getfacl, setfacl) to Samba servers
  129. version 3.10 and later. Setting POSIX ACLs requires enabling both XATTR and
  130. then POSIX support in the CIFS configuration options when building the cifs
  131. module. POSIX ACL support can be disabled on a per mount basic by specifying
  132. "noacl" on mount.
  133. Some administrators may want to change Samba's smb.conf "map archive" and
  134. "create mask" parameters from the default. Unless the create mask is changed
  135. newly created files can end up with an unnecessarily restrictive default mode,
  136. which may not be what you want, although if the CIFS Unix extensions are
  137. enabled on the server and client, subsequent setattr calls (e.g. chmod) can
  138. fix the mode. Note that creating special devices (mknod) remotely
  139. may require specifying a mkdev function to Samba if you are not using
  140. Samba 3.0.6 or later. For more information on these see the manual pages
  141. ("man smb.conf") on the Samba server system. Note that the cifs vfs,
  142. unlike the smbfs vfs, does not read the smb.conf on the client system
  143. (the few optional settings are passed in on mount via -o parameters instead).
  144. Note that Samba 2.2.7 or later includes a fix that allows the CIFS VFS to delete
  145. open files (required for strict POSIX compliance). Windows Servers already
  146. supported this feature. Samba server does not allow symlinks that refer to files
  147. outside of the share, so in Samba versions prior to 3.0.6, most symlinks to
  148. files with absolute paths (ie beginning with slash) such as:
  149. ln -s /mnt/foo bar
  150. would be forbidden. Samba 3.0.6 server or later includes the ability to create
  151. such symlinks safely by converting unsafe symlinks (ie symlinks to server
  152. files that are outside of the share) to a samba specific format on the server
  153. that is ignored by local server applications and non-cifs clients and that will
  154. not be traversed by the Samba server). This is opaque to the Linux client
  155. application using the cifs vfs. Absolute symlinks will work to Samba 3.0.5 or
  156. later, but only for remote clients using the CIFS Unix extensions, and will
  157. be invisbile to Windows clients and typically will not affect local
  158. applications running on the same server as Samba.
  159. Use instructions:
  160. ================
  161. Once the CIFS VFS support is built into the kernel or installed as a module
  162. (cifs.ko), you can use mount syntax like the following to access Samba or
  163. Mac or Windows servers:
  164. mount -t cifs //9.53.216.11/e$ /mnt -o username=myname,password=mypassword
  165. Before -o the option -v may be specified to make the mount.cifs
  166. mount helper display the mount steps more verbosely.
  167. After -o the following commonly used cifs vfs specific options
  168. are supported:
  169. username=<username>
  170. password=<password>
  171. domain=<domain name>
  172. Other cifs mount options are described below. Use of TCP names (in addition to
  173. ip addresses) is available if the mount helper (mount.cifs) is installed. If
  174. you do not trust the server to which are mounted, or if you do not have
  175. cifs signing enabled (and the physical network is insecure), consider use
  176. of the standard mount options "noexec" and "nosuid" to reduce the risk of
  177. running an altered binary on your local system (downloaded from a hostile server
  178. or altered by a hostile router).
  179. Although mounting using format corresponding to the CIFS URL specification is
  180. not possible in mount.cifs yet, it is possible to use an alternate format
  181. for the server and sharename (which is somewhat similar to NFS style mount
  182. syntax) instead of the more widely used UNC format (i.e. \\server\share):
  183. mount -t cifs tcp_name_of_server:share_name /mnt -o user=myname,pass=mypasswd
  184. When using the mount helper mount.cifs, passwords may be specified via alternate
  185. mechanisms, instead of specifying it after -o using the normal "pass=" syntax
  186. on the command line:
  187. 1) By including it in a credential file. Specify credentials=filename as one
  188. of the mount options. Credential files contain two lines
  189. username=someuser
  190. password=your_password
  191. 2) By specifying the password in the PASSWD environment variable (similarly
  192. the user name can be taken from the USER environment variable).
  193. 3) By specifying the password in a file by name via PASSWD_FILE
  194. 4) By specifying the password in a file by file descriptor via PASSWD_FD
  195. If no password is provided, mount.cifs will prompt for password entry
  196. Restrictions
  197. ============
  198. Servers must support either "pure-TCP" (port 445 TCP/IP CIFS connections) or RFC
  199. 1001/1002 support for "Netbios-Over-TCP/IP." This is not likely to be a
  200. problem as most servers support this.
  201. Valid filenames differ between Windows and Linux. Windows typically restricts
  202. filenames which contain certain reserved characters (e.g.the character :
  203. which is used to delimit the beginning of a stream name by Windows), while
  204. Linux allows a slightly wider set of valid characters in filenames. Windows
  205. servers can remap such characters when an explicit mapping is specified in
  206. the Server's registry. Samba starting with version 3.10 will allow such
  207. filenames (ie those which contain valid Linux characters, which normally
  208. would be forbidden for Windows/CIFS semantics) as long as the server is
  209. configured for Unix Extensions (and the client has not disabled
  210. /proc/fs/cifs/LinuxExtensionsEnabled). In addition the mount option
  211. "mapposix" can be used on CIFS (vers=1.0) to force the mapping of
  212. illegal Windows/NTFS/SMB characters to a remap range (this mount parm
  213. is the default for SMB3). This remap ("mapposix") range is also
  214. compatible with Mac (and "Services for Mac" on some older Windows).
  215. CIFS VFS Mount Options
  216. ======================
  217. A partial list of the supported mount options follows:
  218. username The user name to use when trying to establish
  219. the CIFS session.
  220. password The user password. If the mount helper is
  221. installed, the user will be prompted for password
  222. if not supplied.
  223. ip The ip address of the target server
  224. unc The target server Universal Network Name (export) to
  225. mount.
  226. domain Set the SMB/CIFS workgroup name prepended to the
  227. username during CIFS session establishment
  228. forceuid Set the default uid for inodes to the uid
  229. passed in on mount. For mounts to servers
  230. which do support the CIFS Unix extensions, such as a
  231. properly configured Samba server, the server provides
  232. the uid, gid and mode so this parameter should not be
  233. specified unless the server and clients uid and gid
  234. numbering differ. If the server and client are in the
  235. same domain (e.g. running winbind or nss_ldap) and
  236. the server supports the Unix Extensions then the uid
  237. and gid can be retrieved from the server (and uid
  238. and gid would not have to be specified on the mount.
  239. For servers which do not support the CIFS Unix
  240. extensions, the default uid (and gid) returned on lookup
  241. of existing files will be the uid (gid) of the person
  242. who executed the mount (root, except when mount.cifs
  243. is configured setuid for user mounts) unless the "uid="
  244. (gid) mount option is specified. Also note that permission
  245. checks (authorization checks) on accesses to a file occur
  246. at the server, but there are cases in which an administrator
  247. may want to restrict at the client as well. For those
  248. servers which do not report a uid/gid owner
  249. (such as Windows), permissions can also be checked at the
  250. client, and a crude form of client side permission checking
  251. can be enabled by specifying file_mode and dir_mode on
  252. the client. (default)
  253. forcegid (similar to above but for the groupid instead of uid) (default)
  254. noforceuid Fill in file owner information (uid) by requesting it from
  255. the server if possible. With this option, the value given in
  256. the uid= option (on mount) will only be used if the server
  257. can not support returning uids on inodes.
  258. noforcegid (similar to above but for the group owner, gid, instead of uid)
  259. uid Set the default uid for inodes, and indicate to the
  260. cifs kernel driver which local user mounted. If the server
  261. supports the unix extensions the default uid is
  262. not used to fill in the owner fields of inodes (files)
  263. unless the "forceuid" parameter is specified.
  264. gid Set the default gid for inodes (similar to above).
  265. file_mode If CIFS Unix extensions are not supported by the server
  266. this overrides the default mode for file inodes.
  267. fsc Enable local disk caching using FS-Cache (off by default). This
  268. option could be useful to improve performance on a slow link,
  269. heavily loaded server and/or network where reading from the
  270. disk is faster than reading from the server (over the network).
  271. This could also impact scalability positively as the
  272. number of calls to the server are reduced. However, local
  273. caching is not suitable for all workloads for e.g. read-once
  274. type workloads. So, you need to consider carefully your
  275. workload/scenario before using this option. Currently, local
  276. disk caching is functional for CIFS files opened as read-only.
  277. dir_mode If CIFS Unix extensions are not supported by the server
  278. this overrides the default mode for directory inodes.
  279. port attempt to contact the server on this tcp port, before
  280. trying the usual ports (port 445, then 139).
  281. iocharset Codepage used to convert local path names to and from
  282. Unicode. Unicode is used by default for network path
  283. names if the server supports it. If iocharset is
  284. not specified then the nls_default specified
  285. during the local client kernel build will be used.
  286. If server does not support Unicode, this parameter is
  287. unused.
  288. rsize default read size (usually 16K). The client currently
  289. can not use rsize larger than CIFSMaxBufSize. CIFSMaxBufSize
  290. defaults to 16K and may be changed (from 8K to the maximum
  291. kmalloc size allowed by your kernel) at module install time
  292. for cifs.ko. Setting CIFSMaxBufSize to a very large value
  293. will cause cifs to use more memory and may reduce performance
  294. in some cases. To use rsize greater than 127K (the original
  295. cifs protocol maximum) also requires that the server support
  296. a new Unix Capability flag (for very large read) which some
  297. newer servers (e.g. Samba 3.0.26 or later) do. rsize can be
  298. set from a minimum of 2048 to a maximum of 130048 (127K or
  299. CIFSMaxBufSize, whichever is smaller)
  300. wsize default write size (default 57344)
  301. maximum wsize currently allowed by CIFS is 57344 (fourteen
  302. 4096 byte pages)
  303. actimeo=n attribute cache timeout in seconds (default 1 second).
  304. After this timeout, the cifs client requests fresh attribute
  305. information from the server. This option allows to tune the
  306. attribute cache timeout to suit the workload needs. Shorter
  307. timeouts mean better the cache coherency, but increased number
  308. of calls to the server. Longer timeouts mean reduced number
  309. of calls to the server at the expense of less stricter cache
  310. coherency checks (i.e. incorrect attribute cache for a short
  311. period of time).
  312. rw mount the network share read-write (note that the
  313. server may still consider the share read-only)
  314. ro mount network share read-only
  315. version used to distinguish different versions of the
  316. mount helper utility (not typically needed)
  317. sep if first mount option (after the -o), overrides
  318. the comma as the separator between the mount
  319. parms. e.g.
  320. -o user=myname,password=mypassword,domain=mydom
  321. could be passed instead with period as the separator by
  322. -o sep=.user=myname.password=mypassword.domain=mydom
  323. this might be useful when comma is contained within username
  324. or password or domain. This option is less important
  325. when the cifs mount helper cifs.mount (version 1.1 or later)
  326. is used.
  327. nosuid Do not allow remote executables with the suid bit
  328. program to be executed. This is only meaningful for mounts
  329. to servers such as Samba which support the CIFS Unix Extensions.
  330. If you do not trust the servers in your network (your mount
  331. targets) it is recommended that you specify this option for
  332. greater security.
  333. exec Permit execution of binaries on the mount.
  334. noexec Do not permit execution of binaries on the mount.
  335. dev Recognize block devices on the remote mount.
  336. nodev Do not recognize devices on the remote mount.
  337. suid Allow remote files on this mountpoint with suid enabled to
  338. be executed (default for mounts when executed as root,
  339. nosuid is default for user mounts).
  340. credentials Although ignored by the cifs kernel component, it is used by
  341. the mount helper, mount.cifs. When mount.cifs is installed it
  342. opens and reads the credential file specified in order
  343. to obtain the userid and password arguments which are passed to
  344. the cifs vfs.
  345. guest Although ignored by the kernel component, the mount.cifs
  346. mount helper will not prompt the user for a password
  347. if guest is specified on the mount options. If no
  348. password is specified a null password will be used.
  349. perm Client does permission checks (vfs_permission check of uid
  350. and gid of the file against the mode and desired operation),
  351. Note that this is in addition to the normal ACL check on the
  352. target machine done by the server software.
  353. Client permission checking is enabled by default.
  354. noperm Client does not do permission checks. This can expose
  355. files on this mount to access by other users on the local
  356. client system. It is typically only needed when the server
  357. supports the CIFS Unix Extensions but the UIDs/GIDs on the
  358. client and server system do not match closely enough to allow
  359. access by the user doing the mount, but it may be useful with
  360. non CIFS Unix Extension mounts for cases in which the default
  361. mode is specified on the mount but is not to be enforced on the
  362. client (e.g. perhaps when MultiUserMount is enabled)
  363. Note that this does not affect the normal ACL check on the
  364. target machine done by the server software (of the server
  365. ACL against the user name provided at mount time).
  366. serverino Use server's inode numbers instead of generating automatically
  367. incrementing inode numbers on the client. Although this will
  368. make it easier to spot hardlinked files (as they will have
  369. the same inode numbers) and inode numbers may be persistent,
  370. note that the server does not guarantee that the inode numbers
  371. are unique if multiple server side mounts are exported under a
  372. single share (since inode numbers on the servers might not
  373. be unique if multiple filesystems are mounted under the same
  374. shared higher level directory). Note that some older
  375. (e.g. pre-Windows 2000) do not support returning UniqueIDs
  376. or the CIFS Unix Extensions equivalent and for those
  377. this mount option will have no effect. Exporting cifs mounts
  378. under nfsd requires this mount option on the cifs mount.
  379. This is now the default if server supports the
  380. required network operation.
  381. noserverino Client generates inode numbers (rather than using the actual one
  382. from the server). These inode numbers will vary after
  383. unmount or reboot which can confuse some applications,
  384. but not all server filesystems support unique inode
  385. numbers.
  386. setuids If the CIFS Unix extensions are negotiated with the server
  387. the client will attempt to set the effective uid and gid of
  388. the local process on newly created files, directories, and
  389. devices (create, mkdir, mknod). If the CIFS Unix Extensions
  390. are not negotiated, for newly created files and directories
  391. instead of using the default uid and gid specified on
  392. the mount, cache the new file's uid and gid locally which means
  393. that the uid for the file can change when the inode is
  394. reloaded (or the user remounts the share).
  395. nosetuids The client will not attempt to set the uid and gid on
  396. on newly created files, directories, and devices (create,
  397. mkdir, mknod) which will result in the server setting the
  398. uid and gid to the default (usually the server uid of the
  399. user who mounted the share). Letting the server (rather than
  400. the client) set the uid and gid is the default. If the CIFS
  401. Unix Extensions are not negotiated then the uid and gid for
  402. new files will appear to be the uid (gid) of the mounter or the
  403. uid (gid) parameter specified on the mount.
  404. netbiosname When mounting to servers via port 139, specifies the RFC1001
  405. source name to use to represent the client netbios machine
  406. name when doing the RFC1001 netbios session initialize.
  407. direct Do not do inode data caching on files opened on this mount.
  408. This precludes mmapping files on this mount. In some cases
  409. with fast networks and little or no caching benefits on the
  410. client (e.g. when the application is doing large sequential
  411. reads bigger than page size without rereading the same data)
  412. this can provide better performance than the default
  413. behavior which caches reads (readahead) and writes
  414. (writebehind) through the local Linux client pagecache
  415. if oplock (caching token) is granted and held. Note that
  416. direct allows write operations larger than page size
  417. to be sent to the server.
  418. strictcache Use for switching on strict cache mode. In this mode the
  419. client read from the cache all the time it has Oplock Level II,
  420. otherwise - read from the server. All written data are stored
  421. in the cache, but if the client doesn't have Exclusive Oplock,
  422. it writes the data to the server.
  423. rwpidforward Forward pid of a process who opened a file to any read or write
  424. operation on that file. This prevent applications like WINE
  425. from failing on read and write if we use mandatory brlock style.
  426. acl Allow setfacl and getfacl to manage posix ACLs if server
  427. supports them. (default)
  428. noacl Do not allow setfacl and getfacl calls on this mount
  429. user_xattr Allow getting and setting user xattrs (those attributes whose
  430. name begins with "user." or "os2.") as OS/2 EAs (extended
  431. attributes) to the server. This allows support of the
  432. setfattr and getfattr utilities. (default)
  433. nouser_xattr Do not allow getfattr/setfattr to get/set/list xattrs
  434. mapchars Translate six of the seven reserved characters (not backslash)
  435. *?<>|:
  436. to the remap range (above 0xF000), which also
  437. allows the CIFS client to recognize files created with
  438. such characters by Windows's POSIX emulation. This can
  439. also be useful when mounting to most versions of Samba
  440. (which also forbids creating and opening files
  441. whose names contain any of these seven characters).
  442. This has no effect if the server does not support
  443. Unicode on the wire.
  444. nomapchars Do not translate any of these seven characters (default).
  445. nocase Request case insensitive path name matching (case
  446. sensitive is the default if the server supports it).
  447. (mount option "ignorecase" is identical to "nocase")
  448. posixpaths If CIFS Unix extensions are supported, attempt to
  449. negotiate posix path name support which allows certain
  450. characters forbidden in typical CIFS filenames, without
  451. requiring remapping. (default)
  452. noposixpaths If CIFS Unix extensions are supported, do not request
  453. posix path name support (this may cause servers to
  454. reject creatingfile with certain reserved characters).
  455. nounix Disable the CIFS Unix Extensions for this mount (tree
  456. connection). This is rarely needed, but it may be useful
  457. in order to turn off multiple settings all at once (ie
  458. posix acls, posix locks, posix paths, symlink support
  459. and retrieving uids/gids/mode from the server) or to
  460. work around a bug in server which implement the Unix
  461. Extensions.
  462. nobrl Do not send byte range lock requests to the server.
  463. This is necessary for certain applications that break
  464. with cifs style mandatory byte range locks (and most
  465. cifs servers do not yet support requesting advisory
  466. byte range locks).
  467. forcemandatorylock Even if the server supports posix (advisory) byte range
  468. locking, send only mandatory lock requests. For some
  469. (presumably rare) applications, originally coded for
  470. DOS/Windows, which require Windows style mandatory byte range
  471. locking, they may be able to take advantage of this option,
  472. forcing the cifs client to only send mandatory locks
  473. even if the cifs server would support posix advisory locks.
  474. "forcemand" is accepted as a shorter form of this mount
  475. option.
  476. nostrictsync If this mount option is set, when an application does an
  477. fsync call then the cifs client does not send an SMB Flush
  478. to the server (to force the server to write all dirty data
  479. for this file immediately to disk), although cifs still sends
  480. all dirty (cached) file data to the server and waits for the
  481. server to respond to the write. Since SMB Flush can be
  482. very slow, and some servers may be reliable enough (to risk
  483. delaying slightly flushing the data to disk on the server),
  484. turning on this option may be useful to improve performance for
  485. applications that fsync too much, at a small risk of server
  486. crash. If this mount option is not set, by default cifs will
  487. send an SMB flush request (and wait for a response) on every
  488. fsync call.
  489. nodfs Disable DFS (global name space support) even if the
  490. server claims to support it. This can help work around
  491. a problem with parsing of DFS paths with Samba server
  492. versions 3.0.24 and 3.0.25.
  493. remount remount the share (often used to change from ro to rw mounts
  494. or vice versa)
  495. cifsacl Report mode bits (e.g. on stat) based on the Windows ACL for
  496. the file. (EXPERIMENTAL)
  497. servern Specify the server 's netbios name (RFC1001 name) to use
  498. when attempting to setup a session to the server.
  499. This is needed for mounting to some older servers (such
  500. as OS/2 or Windows 98 and Windows ME) since they do not
  501. support a default server name. A server name can be up
  502. to 15 characters long and is usually uppercased.
  503. sfu When the CIFS Unix Extensions are not negotiated, attempt to
  504. create device files and fifos in a format compatible with
  505. Services for Unix (SFU). In addition retrieve bits 10-12
  506. of the mode via the SETFILEBITS extended attribute (as
  507. SFU does). In the future the bottom 9 bits of the
  508. mode also will be emulated using queries of the security
  509. descriptor (ACL).
  510. mfsymlinks Enable support for Minshall+French symlinks
  511. (see http://wiki.samba.org/index.php/UNIX_Extensions#Minshall.2BFrench_symlinks)
  512. This option is ignored when specified together with the
  513. 'sfu' option. Minshall+French symlinks are used even if
  514. the server supports the CIFS Unix Extensions.
  515. sign Must use packet signing (helps avoid unwanted data modification
  516. by intermediate systems in the route). Note that signing
  517. does not work with lanman or plaintext authentication.
  518. seal Must seal (encrypt) all data on this mounted share before
  519. sending on the network. Requires support for Unix Extensions.
  520. Note that this differs from the sign mount option in that it
  521. causes encryption of data sent over this mounted share but other
  522. shares mounted to the same server are unaffected.
  523. locallease This option is rarely needed. Fcntl F_SETLEASE is
  524. used by some applications such as Samba and NFSv4 server to
  525. check to see whether a file is cacheable. CIFS has no way
  526. to explicitly request a lease, but can check whether a file
  527. is cacheable (oplocked). Unfortunately, even if a file
  528. is not oplocked, it could still be cacheable (ie cifs client
  529. could grant fcntl leases if no other local processes are using
  530. the file) for cases for example such as when the server does not
  531. support oplocks and the user is sure that the only updates to
  532. the file will be from this client. Specifying this mount option
  533. will allow the cifs client to check for leases (only) locally
  534. for files which are not oplocked instead of denying leases
  535. in that case. (EXPERIMENTAL)
  536. sec Security mode. Allowed values are:
  537. none attempt to connection as a null user (no name)
  538. krb5 Use Kerberos version 5 authentication
  539. krb5i Use Kerberos authentication and packet signing
  540. ntlm Use NTLM password hashing (default)
  541. ntlmi Use NTLM password hashing with signing (if
  542. /proc/fs/cifs/PacketSigningEnabled on or if
  543. server requires signing also can be the default)
  544. ntlmv2 Use NTLMv2 password hashing
  545. ntlmv2i Use NTLMv2 password hashing with packet signing
  546. lanman (if configured in kernel config) use older
  547. lanman hash
  548. hard Retry file operations if server is not responding
  549. soft Limit retries to unresponsive servers (usually only
  550. one retry) before returning an error. (default)
  551. The mount.cifs mount helper also accepts a few mount options before -o
  552. including:
  553. -S take password from stdin (equivalent to setting the environment
  554. variable "PASSWD_FD=0"
  555. -V print mount.cifs version
  556. -? display simple usage information
  557. With most 2.6 kernel versions of modutils, the version of the cifs kernel
  558. module can be displayed via modinfo.
  559. Misc /proc/fs/cifs Flags and Debug Info
  560. =======================================
  561. Informational pseudo-files:
  562. DebugData Displays information about active CIFS sessions and
  563. shares, features enabled as well as the cifs.ko
  564. version.
  565. Stats Lists summary resource usage information as well as per
  566. share statistics.
  567. Configuration pseudo-files:
  568. SecurityFlags Flags which control security negotiation and
  569. also packet signing. Authentication (may/must)
  570. flags (e.g. for NTLM and/or NTLMv2) may be combined with
  571. the signing flags. Specifying two different password
  572. hashing mechanisms (as "must use") on the other hand
  573. does not make much sense. Default flags are
  574. 0x07007
  575. (NTLM, NTLMv2 and packet signing allowed). The maximum
  576. allowable flags if you want to allow mounts to servers
  577. using weaker password hashes is 0x37037 (lanman,
  578. plaintext, ntlm, ntlmv2, signing allowed). Some
  579. SecurityFlags require the corresponding menuconfig
  580. options to be enabled (lanman and plaintext require
  581. CONFIG_CIFS_WEAK_PW_HASH for example). Enabling
  582. plaintext authentication currently requires also
  583. enabling lanman authentication in the security flags
  584. because the cifs module only supports sending
  585. laintext passwords using the older lanman dialect
  586. form of the session setup SMB. (e.g. for authentication
  587. using plain text passwords, set the SecurityFlags
  588. to 0x30030):
  589. may use packet signing 0x00001
  590. must use packet signing 0x01001
  591. may use NTLM (most common password hash) 0x00002
  592. must use NTLM 0x02002
  593. may use NTLMv2 0x00004
  594. must use NTLMv2 0x04004
  595. may use Kerberos security 0x00008
  596. must use Kerberos 0x08008
  597. may use lanman (weak) password hash 0x00010
  598. must use lanman password hash 0x10010
  599. may use plaintext passwords 0x00020
  600. must use plaintext passwords 0x20020
  601. (reserved for future packet encryption) 0x00040
  602. cifsFYI If set to non-zero value, additional debug information
  603. will be logged to the system error log. This field
  604. contains three flags controlling different classes of
  605. debugging entries. The maximum value it can be set
  606. to is 7 which enables all debugging points (default 0).
  607. Some debugging statements are not compiled into the
  608. cifs kernel unless CONFIG_CIFS_DEBUG2 is enabled in the
  609. kernel configuration. cifsFYI may be set to one or
  610. nore of the following flags (7 sets them all):
  611. log cifs informational messages 0x01
  612. log return codes from cifs entry points 0x02
  613. log slow responses (ie which take longer than 1 second)
  614. CONFIG_CIFS_STATS2 must be enabled in .config 0x04
  615. traceSMB If set to one, debug information is logged to the
  616. system error log with the start of smb requests
  617. and responses (default 0)
  618. LookupCacheEnable If set to one, inode information is kept cached
  619. for one second improving performance of lookups
  620. (default 1)
  621. LinuxExtensionsEnabled If set to one then the client will attempt to
  622. use the CIFS "UNIX" extensions which are optional
  623. protocol enhancements that allow CIFS servers
  624. to return accurate UID/GID information as well
  625. as support symbolic links. If you use servers
  626. such as Samba that support the CIFS Unix
  627. extensions but do not want to use symbolic link
  628. support and want to map the uid and gid fields
  629. to values supplied at mount (rather than the
  630. actual values, then set this to zero. (default 1)
  631. These experimental features and tracing can be enabled by changing flags in
  632. /proc/fs/cifs (after the cifs module has been installed or built into the
  633. kernel, e.g. insmod cifs). To enable a feature set it to 1 e.g. to enable
  634. tracing to the kernel message log type:
  635. echo 7 > /proc/fs/cifs/cifsFYI
  636. cifsFYI functions as a bit mask. Setting it to 1 enables additional kernel
  637. logging of various informational messages. 2 enables logging of non-zero
  638. SMB return codes while 4 enables logging of requests that take longer
  639. than one second to complete (except for byte range lock requests).
  640. Setting it to 4 requires CONFIG_CIFS_STATS2 to be set in kernel configuration
  641. (.config). Setting it to seven enables all three. Finally, tracing
  642. the start of smb requests and responses can be enabled via:
  643. echo 1 > /proc/fs/cifs/traceSMB
  644. Per share (per client mount) statistics are available in /proc/fs/cifs/Stats.
  645. Additional information is available if CONFIG_CIFS_STATS2 is enabled in the
  646. kernel configuration (.config). The statistics returned include counters which
  647. represent the number of attempted and failed (ie non-zero return code from the
  648. server) SMB3 (or cifs) requests grouped by request type (read, write, close etc.).
  649. Also recorded is the total bytes read and bytes written to the server for
  650. that share. Note that due to client caching effects this can be less than the
  651. number of bytes read and written by the application running on the client.
  652. Statistics can be reset to zero by "echo 0 > /proc/fs/cifs/Stats" which may be
  653. useful if comparing performance of two different scenarios.
  654. Also note that "cat /proc/fs/cifs/DebugData" will display information about
  655. the active sessions and the shares that are mounted.
  656. Enabling Kerberos (extended security) works but requires version 1.2 or later
  657. of the helper program cifs.upcall to be present and to be configured in the
  658. /etc/request-key.conf file. The cifs.upcall helper program is from the Samba
  659. project(http://www.samba.org). NTLM and NTLMv2 and LANMAN support do not
  660. require this helper. Note that NTLMv2 security (which does not require the
  661. cifs.upcall helper program), instead of using Kerberos, is sufficient for
  662. some use cases.
  663. DFS support allows transparent redirection to shares in an MS-DFS name space.
  664. In addition, DFS support for target shares which are specified as UNC
  665. names which begin with host names (rather than IP addresses) requires
  666. a user space helper (such as cifs.upcall) to be present in order to
  667. translate host names to ip address, and the user space helper must also
  668. be configured in the file /etc/request-key.conf. Samba, Windows servers and
  669. many NAS appliances support DFS as a way of constructing a global name
  670. space to ease network configuration and improve reliability.
  671. To use cifs Kerberos and DFS support, the Linux keyutils package should be
  672. installed and something like the following lines should be added to the
  673. /etc/request-key.conf file:
  674. create cifs.spnego * * /usr/local/sbin/cifs.upcall %k
  675. create dns_resolver * * /usr/local/sbin/cifs.upcall %k
  676. CIFS kernel module parameters
  677. =============================
  678. These module parameters can be specified or modified either during the time of
  679. module loading or during the runtime by using the interface
  680. /proc/module/cifs/parameters/<param>
  681. i.e. echo "value" > /sys/module/cifs/parameters/<param>
  682. 1. enable_oplocks - Enable or disable oplocks. Oplocks are enabled by default.
  683. [Y/y/1]. To disable use any of [N/n/0].