README 32 KB

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