README 37 KB

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