fs/cifs/README

   1 The CIFS VFS support for Linux supports many advanced network filesystem
   2 features such as heirarchical 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
   8 For questions or bug reports please contact:
   9     sfrench@samba.org (sfrench@us.ibm.com)
  10
  11 Build instructions:
  12 ==================
  13 For Linux 2.4:
  14 1) Get the kernel source (e.g.from http://www.kernel.org)
  15 and download the cifs vfs source (see the project page
  16 at http://us1.samba.org/samba/Linux_CIFS_client.html)
  17 and change directory into the top of the kernel directory
  18 then patch the kernel (e.g. "patch -p1 < cifs_24.patch")
  19 to add the cifs vfs to your kernel configure options if
  20 it has not already been added (e.g. current SuSE and UL
  21 users do not need to apply the cifs_24.patch since the cifs vfs is
  22 already in the kernel configure menu) and then
  23 mkdir linux/fs/cifs and then copy the current cifs vfs files from
  24 the cifs download to your kernel build directory e.g.
  25
  26         cp <cifs_download_dir>/fs/cifs/* to <kernel_download_dir>/fs/cifs
  27
  28 2) make menuconfig (or make xconfig)
  29 3) select cifs from within the network filesystem choices
  30 4) save and exit
  31 5) make dep
  32 6) make modules (or "make" if CIFS VFS not to be built as a module)
  33
  34 For Linux 2.5:
  35 1) Download the kernel (e.g. from http://www.kernel.org or from bitkeeper
  36 at bk://linux.bkbits.net/linux-2.5) and change directory into the top
  37 of the kernel directory tree (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
  43
  44 Installation instructions:
  45 =========================
  46 If you have built the CIFS vfs as module (successfully) simply
  47 type "make modules_install" (or if you prefer, manually copy the file to
  48 the modules directory e.g. /lib/modules/2.4.10-4GB/kernel/fs/cifs/cifs.o).
  49
  50 If you have built the CIFS vfs into the kernel itself, follow the instructions
  51 for your distribution on how to install a new kernel (usually you
  52 would simply type "make install").
  53
  54 If you do not have the utility mount.cifs (in the Samba 3.0 source tree and on
  55 the CIFS VFS web site) copy it to the same directory in which mount.smbfs and
  56 similar files reside (usually /sbin).  Although the helper software is not
  57 required, mount.cifs is recommended.  Eventually the Samba 3.0 utility program
  58 "net" may also be helpful since it may someday provide easier mount syntax for
  59 users who are used to Windows e.g.  net use <mount point> <UNC name or cifs URL>
  60 Note that running the Winbind pam/nss module (logon service) on all of your
  61 Linux clients is useful in mapping Uids and Gids consistently across the
  62 domain to the proper network user.  The mount.cifs mount helper can be
  63 trivially built from Samba 3.0 or later source e.g. by executing:
  64
  65         gcc samba/source/client/mount.cifs.c -o mount.cifs
  66
  67 Note that when the mount.cifs utility is run suid (allowing user mounts),
  68 in order to reduce risks, the "nosuid" mount flag is passed in on mount to
  69 disallow execution of an suid program mounted on the remote target.
  70 When mount is executed as root, nosuid is not passed in by default,
  71 and execution of suid programs on the remote target would be enabled
  72 by default. This can be changed, as with nfs and other filesystems,
  73 by simply specifying "nosuid" among the mount options. For user mounts
  74 though to be able to pass the suid flag to mount requires rebuilding
  75 mount.cifs with the following flag:
  76
  77         gcc samba/source/client/mount.cifs.c -DCIFS_ALLOW_USR_SUID -o mount.cifs
  78
  79 There is a corresponding manual page for cifs mounting in the Samba 3.0 and
  80 later source tree in docs/manpages/mount.cifs.8
  81
  82 Samba Considerations
  83 ====================
  84 To get the maximum benefit from the CIFS VFS, we recommend using a server that
  85 supports the SNIA CIFS Unix Extensions standard (e.g.  Samba 2.2.5 or later or
  86 Samba 3.0) but the CIFS vfs works fine with a wide variety of CIFS servers.
  87 Note that uid, gid and file permissions will display default values if you do
  88 not have a server that supports the Unix extensions for CIFS (such as Samba
  89 2.2.5 or later).  To enable the Unix CIFS Extensions in the Samba server, add
  90 the line:
  91
  92         unix extensions = yes
  93
  94 to your smb.conf file on the server.  Note that the following smb.conf settings
  95 are also useful (on the Samba server) when the majority of clients are Unix or
  96 Linux:
  97
  98         case sensitive = yes
  99         delete readonly = yes
 100
 101 Some administrators also change the "map archive" and the "create mask"
 102 parameters from their default values.  Creating special devices (mknod) remotely
 103 may require specifying a mkdev function to Samba.  For more information on these
 104 see the manual pages ("man smb.conf") on the Samba server system.  Note that the
 105 cifs vfs, unlike the smbfs vfs, does not read the smb.conf on the client system
 106 (the few optional settings are passed in on mount via -o parameters instead).
 107 Note that Samba 2.2.7 or later includes a fix that allows the CIFS VFS to delete
 108 open files (required for strict POSIX compliance).  Windows Servers already
 109 supported this feature. Samba server does not allow symlinks that refer to files
 110 outside of the share, so in Samba versions prior to 3.0.5, most symlinks to
 111 files with absolute paths (ie beginning with slash) such as:
 112          ln -s /mnt/foo bar
 113 would be forbidden. Samba 3.0.5 server or later includes the ability to create
 114 such symlinks safely by converting unsafe symlinks (ie symlinks to server
 115 files that are outside of the share) to a samba specific format on the server
 116 that is ignored by local server applications and non-cifs clients and that will
 117 not be traversed by the Samba server).  This is opaque to the Linux client
 118 application using the cifs vfs. Absolute symlinks will work to Samba 3.0.5 or
 119 later, but only for remote clients using the CIFS Unix extensions, and will
 120 be invisbile to Windows clients and typically will not affect local
 121 applications running on the same server as Samba.
 122
 123 Use instructions:
 124 ================
 125 Once the CIFS VFS support is built into the kernel or installed as a module
 126 (cifs.o), you can use mount syntax like the following to access Samba or Windows
 127 servers:
 128
 129   mount -t cifs //9.53.216.11/e$ /mnt -o user=myname,pass=mypassword
 130
 131 Before -o the option -v may be specified to make the mount.cifs
 132 mount helper display the mount steps more verbosely.
 133 After -o the following commonly used cifs vfs specific options
 134 are supported:
 135
 136   user=<username>
 137   pass=<password>
 138   domain=<domain name>
 139
 140 Other cifs mount options are described below.  Use of TCP names (in addition to
 141 ip addresses) is available if the mount helper (mount.cifs) is installed. If
 142 you do not trust the server to which are mounted, or if you do not have
 143 cifs signing enabled (and the physical network is insecure), consider use
 144 of the standard mount options "noexec" and "nosuid" to reduce the risk of
 145 running an altered binary on your local system (downloaded from a hostile server
 146 or altered by a hostile router).
 147
 148 When using the mount helper mount.cifs, passwords may be specified via alternate
 149 mechanisms, instead of specifying it after -o using the normal "pass=" syntax
 150 on the command line:
 151 1) By including it in a credential file. Specify credentials=filename as one
 152 of the mount options. Credential files contain two lines
 153         username=someuser
 154         password=your_password
 155 2) By specifying the password in the PASSWD environment variable (similarly
 156 the user name can be taken from the USER environment variable).
 157 3) By specifying the password in a file by name via PASSWD_FILE
 158 4) By specifying the password in a file by file descriptor via PASSWD_FD
 159
 160 If no password is provided, mount.cifs will prompt for password entry
 161
 162 Restrictions
 163 ============
 164 Servers must support the NTLM SMB dialect (which is the most recent, supported
 165 by Samba and Windows NT version 4, 2000 and XP and many other SMB/CIFS servers)
 166 Servers must support either "pure-TCP" (port 445 TCP/IP CIFS connections) or RFC
 167 1001/1002 support for "Netbios-Over-TCP/IP." Neither of these is likely to be a
 168 problem as most servers support this.  IPv6 support is planned for the future.
 169
 170 CIFS VFS Mount Options
 171 ======================
 172 A partial list of the supported mount options follows:
 173   user          The user name to use when trying to establish
 174                 the CIFS session.
 175   password      The user password.  If the mount helper is
 176                 installed, the user will be prompted for password
 177                 if it is not supplied.
 178   ip            The ip address of the target server
 179   unc           The target server Universal Network Name (export) to
 180                 mount.
 181   domain        Set the SMB/CIFS workgroup name prepended to the
 182                 username during CIFS session establishment
 183   uid           If CIFS Unix extensions are not supported by the server
 184                 this overrides the default uid for inodes. For mounts to
 185                 servers which do support the CIFS Unix extensions, such
 186                 as a properly configured Samba server, the server provides
 187                 the uid, gid and mode.  For servers which do not support
 188                 the Unix extensions, the default uid (and gid) returned on
 189                 lookup of existing files is the uid (gid) of the person
 190                 who executed the mount (root, except when mount.cifs
 191                 is configured setuid for user mounts) unless the "uid="
 192                 (gid) mount option is specified.  For the uid (gid) of newly
 193                 created files and directories, ie files created since
 194                 the last mount of the server share, the expected uid
 195                 (gid) is cached as as long as the inode remains in
 196                 memory on the client.   Also note that permission
 197                 checks (authorization checks) on accesses to a file occur
 198                 at the server, but there are cases in which an administrator
 199                 may want to restrict at the client as well.  For those
 200                 servers which do not report a uid/gid owner
 201                 (such as Windows), permissions can also be checked at the
 202                 client, and a crude form of client side permission checking
 203                 can be enabled by specifying file_mode and dir_mode on
 204                 the client
 205   gid           If CIFS Unix extensions are not supported by the server
 206                 this overrides the default gid for inodes.
 207   file_mode     If CIFS Unix extensions are not supported by the server
 208                 this overrides the default mode for file inodes.
 209   dir_mode      If CIFS Unix extensions are not supported by the server
 210                 this overrides the default mode for directory inodes.
 211   port          attempt to contact the server on this tcp port, before
 212                 trying the usual ports (port 445, then 139).
 213   iocharset     Codepage used to convert local path names to and from
 214                 Unicode. Unicode is used by default for network path
 215                 names if the server supports it.  If iocharset is
 216                 not specified then the nls_default specified
 217                 during the local client kernel build will be used.
 218                 If server does not support Unicode, this parameter is
 219                 unused.
 220   rsize         default read size
 221   wsize         default write size
 222   rw            mount the network share read-write (note that the
 223                 server may still consider the share read-only)
 224   ro            mount network share read-only
 225   version       used to distinguish different versions of the
 226                 mount helper utility (not typically needed)
 227   sep           if first mount option (after the -o), overrides
 228                 the comma as the separator between the mount
 229                 parms. e.g.
 230                         -o user=myname,password=mypassword,domain=mydom
 231                 could be passed instead with period as the separator by
 232                         -o sep=.user=myname.password=mypassword.domain=mydom
 233                 this might be useful when comma is contained within username
 234                 or password or domain. This option is less important
 235                 when the cifs mount helper cifs.mount (version 1.1 or later)
 236                 is used.
 237   nosuid        Do not allow remote executables with the suid bit
 238                 program to be executed.  This is only meaningful for mounts
 239                 to servers such as Samba which support the CIFS Unix Extensions.
 240                 If you do not trust the servers in your network (your mount
 241                 targets) it is recommended that you specify this option for
 242                 greater security.
 243   suid          Allow remote files on this mountpoint with suid enabled to
 244                 be executed (default for mounts when executed as root,
 245                 nosuid is default for user mounts).
 246   credentials   Although ignored by the cifs kernel component, it is used by
 247                 the mount helper, mount.cifs. When mount.cifs is installed it
 248                 opens and reads the credential file specified in order
 249                 to obtain the userid and password arguments which are passed to
 250                 the cifs vfs.
 251   guest         Although ignored by the kernel component, the mount.cifs
 252                 mount helper will not prompt the user for a password
 253                 if guest is specified on the mount options.  If no
 254                 password is specified a null password will be used.
 255
 256 The mount.cifs mount helper also accepts a few mount options before -o
 257 including:
 258
 259         -S      take password from stdin (equivalent to setting the environment
 260                 variable "PASSWD_FD=0"
 261         -V      print mount.cifs version
 262         -?      display simple usage information
 263
 264 With recent 2.6 kernel versions of modutils, the version of the cifs kernel
 265 module can be displayed via modinfo.
 266
 267 Misc /proc/fs/cifs Flags and Debug Info
 268 =======================================
 269 Informational pseudo-files:
 270 DebugData               Displays information about active CIFS sessions
 271                         as well as per share statistics (if CONFIG_CIFS_STATS
 272                         is enabled in the kernel configuration).
 273 SimultaneousOps         Counter which holds maximum number of
 274                         simultaneous outstanding SMB/CIFS requests.
 275 Stats                   Lists summary resource usage information
 276
 277 Configuration pseudo-files:
 278 MultiuserMount          If set to one, more than one CIFS session to
 279                         the same server ip address can be established
 280                         if more than one uid accesses the same mount
 281                         point and if the uids user/password mapping
 282                         information is available. (default is 0)
 283 PacketSigningEnabled    If set to one, cifs packet signing is enabled
 284                         and will be used if the server requires
 285                         it.  If set to two, cifs packet signing is
 286                         required even if the server considers packet
 287                         signing optional. (default 1)
 288 cifsFYI                 If set to one, additional debug information is
 289                         logged to the system error log. (default 0)
 290 ExtendedSecurity        If set to one, SPNEGO session establishment
 291                         is allowed which enables more advanced
 292                         secure CIFS session establishment (default 0)
 293 NTLMV2Enabled           If set to one, more secure password hashes
 294                         are used when the server supports them and
 295                         when kerberos is not negotiated (default 0)
 296 traceSMB                If set to one, debug information is logged to the
 297                         system error log with the start of smb requests
 298                         and responses (default 0)
 299 LookupCacheEnable       If set to one, inode information is kept cached
 300                         for one second improving performance of lookups
 301                         (default 1)
 302 OplockEnabled           If set to one, safe distributed caching enabled.
 303                         (default 1)
 304 LinuxExtensionsEnabled  If set to one then the client will attempt to
 305                         use the CIFS "UNIX" extensions which are optional
 306                         protocol enhancements that allow CIFS servers
 307                         to return accurate UID/GID information as well
 308                         as support symbolic links. If you use servers
 309                         such as Samba that support the CIFS Unix
 310                         extensions but do not want to use symbolic link
 311                         support and want to map the uid and gid fields
 312                         to values supplied at mount (rather than the
 313                         actual values, then set this to zero. (default 1)
 314
 315 These experimental features and tracing can be enabled by changing flags in
 316 /proc/fs/cifs (after the cifs module has been installed or built into the
 317 kernel, e.g.  insmod cifs).  To enable a feature set it to 1 e.g.  to enable
 318 tracing to the kernel message log type:
 319
 320         echo 1 > /proc/fs/cifs/cifsFYI
 321
 322 and for more extensive tracing including the start of smb requests and responses
 323
 324         echo 1 > /proc/fs/cifs/traceSMB
 325
 326 Three other experimental features are under development and to test
 327 require enabling an ifdef (e.g. by  adding "#define CIFS_FCNTL" in cifsglob.h)
 328
 329         CONFIG_CIFS_QUOTA
 330
 331         CONFIG_CIFS_XATTR
 332
 333         CONFIG_CIFS_FCNTL  (fcntl needed for support of directory change
 334                             notification and perhaps later for file leases)
 335
 336 Per share (per client mount) statistics are available in /proc/fs/cifs/DebugData
 337 if the kernel was configured with cifs statistics enabled.  The statistics
 338 represent the number of successful (ie non-zero return code from the server)
 339 SMB responses to some of the more common commands (open, delete, mkdir etc.).
 340 Also recorded is the total bytes read and bytes written to the server for
 341 that share.  Note that due to client caching effects this can be less than the
 342 number of bytes read and written by the application running on the client.
 343 The statistics for the number of total SMBs and oplock breaks are different in
 344 that they represent all for that share, not just those for which the server
 345 returned success.
 346
 347 Also note that "cat /proc/fs/cifs/DebugData" will display information about
 348 the active sessions and the shares that are mounted.  Note: NTLMv2 enablement
 349 will not work since they its implementation is not quite complete yet.
 350 Do not alter these configuration values unless you are doing specific testing.
 351 Enabling extended security works to Windows 2000 Workstations and XP but not to
 352 Windows 2000 server or Samba since it does not usually send "raw NTLMSSP"
 353 (instead it sends NTLMSSP encapsulated in SPNEGO/GSSAPI, which support is not
 354 complete in the CIFS VFS yet).