sys/man/4/cifs

   1 .TH CIFS 4
   2 .SH NAME
   3 cifs - Microsoft™ Windows network filesystem client
   4 .SH SYNOPSIS
   5 .B cifs
   6 [
   7 .B -bDiv
   8 ] [
   9 .B -d
  10 .I debug
  11 ] [
  12 .B -a
  13 .I auth-method
  14 ] [
  15 .B -s
  16 .I srvname
  17 ] [
  18 .B -n
  19 .I called-name
  20 ] [
  21 .B -k
  22 .I keyparam
  23 ] [
  24 .B -m
  25 .I mntpnt
  26 ] [
  27 .B -t
  28 .I dfs-timeout
  29 ]
  30 .I host
  31 [
  32 .I share ...
  33 ]
  34 .SH DESCRIPTION
  35 .I Cifs
  36 translates between Microsoft's file-sharing protocol
  37 (a.k.a. CIFS or SMB) and 9P, allowing Plan9 clients to mount file systems
  38 (shares or trees in MS terminology) published by such servers.
  39 .PP
  40 The root of the mounted directory contains one subdirectory per share,
  41 and a few virtual files give additional information.
  42 The arguments are:
  43 .TF "-a\fI auth-method"
  44 .PD
  45 .TP
  46 .BI -a " auth-method"
  47 .I Cifs
  48 authenticates using
  49 .B ntlmv2
  50 by default, but alternative strategies may be
  51 selected using this option.
  52 .I Cifs
  53 eschews cleartext authentication, however
  54 it may be enabled with the
  55 .L plain
  56 auth method.
  57 The list of currently-supported methods is printed
  58 if no method name is supplied.
  59 .IP
  60 .I "Windows server 2003"
  61 requires the
  62 .B ntlmv2
  63 method by default, though it can be configured to be more flexible.
  64 .TP
  65 .B -b
  66 Enable file ownership resolution in
  67 .IR stat (2)
  68 calls.
  69 This requires an open and close per file and thus will slow
  70 .I cifs
  71 considerably; its use is not recommended.
  72 .TP
  73 .BI -d " debug"
  74 followed by non-whitespace separated list of debug options
  75 .I debug
  76 writes specific debug output to file descriptor 2. See source
  77 for more information.
  78 .TP
  79 .B -D
  80 9P request debug.
  81 .TP
  82 .B -i
  83 By default
  84 .I cifs
  85 attempts to enforce case significance file and directory names, though objects
  86 which differ only in their case still cannot co-exist in the same directory. The
  87 .B -i
  88 option disables this behaveiour.
  89 .TP
  90 .BI -k " keyparam"
  91 lists extra parameters which will be passed to
  92 .IR factotum (4)
  93 to select a specific key.
  94 The remote servers's domain is always included in the keyspec,
  95 under the assumption
  96 that all servers in a Windows domain share an authentication domain;
  97 thus
  98 .I cifs
  99 expects keys in
 100 .I factotum
 101 of the form:
 102 .RS
 103 .IP
 104 .EX
 105 key proto=pass dom=THEIR-DOMAIN service=cifs
 106         user=MY-USERNAME !password=XYZZY
 107 .EE
 108 .RE
 109 .TP
 110 .BI -m " mntpnt"
 111 set the mount point for the remote filesystem;
 112 the default is
 113 .BI /n/ host.
 114 .TP
 115 .BI -n " called-name"
 116 The CIFS protocol requires clients to know the NetBios name of the
 117 server they are attaching to, the
 118 .IR Icalled-name .
 119 If this is not specified on the command line,
 120 .I cifs
 121 attempts to discover this name from the remote server.
 122 If this fails it will then try
 123 .IR host ,
 124 and finally it will try the name
 125 .LR *SMBSERVER .
 126 .TP
 127 .BI -s " srvname"
 128 post the service as
 129 .BI /srv/ srvname.
 130 .TP
 131 .BI -t " dfs-timeout"
 132 sets the timeout in for DFS redirections - it defaults to 100ms.
 133 This is a reasonable minimum, it should have a value just greater than
 134 the RTT to the most distant server being accessed.
 135 .TP
 136 .I host
 137 The address of the remote server to connect to.
 138 .TP
 139 .I share
 140 A list of share names to attach on the remote server; if none is given,
 141 .I cifs
 142 will attempt to attach all shares published by the remote host.
 143 .SS "Synthetic Files"
 144 Several synthetic files appear in the root of the mounted filesystem:
 145 .TF Workstations
 146 .PD
 147 .TP
 148 .B Shares
 149 Contains a list of the currently attached shares,
 150 with fields giving the share name, the share type, disk free space / capacity,
 151 and a descriptive comment from the server.
 152 .TP
 153 .B Connection
 154 Contains the username used for authentication,
 155 server's called name, server's domain,
 156 server's OS, the time slip between the local host and the server,
 157 the Maximum Transfer Unit (MTU) the server requested, and optionally a flag
 158 indicating only guest access has been granted.
 159 The second line contains a list of capabilities offered by the server which is
 160 mainly of use for debugging
 161 .IR cifs .
 162 .TP
 163 .B Users
 164 Each line contains a user's name, the user's full name,
 165 and a descriptive comment.
 166 .TP
 167 .B Groups
 168 Each line gives a group's name, and a list of the names of the users who
 169 are members of that group.
 170 .TP
 171 .B Sessions
 172 Lists the users authenticated, the client machine's NetBios name or IP address,
 173 the time since the connection was established,
 174 and the time for which the connection has been idle.
 175 .TP
 176 .B Domains
 177 One line per domain giving the domain name and a descriptive comment.
 178 .TP
 179 .B Workstations
 180 One line per domain giving the domain name and a descriptive comment,
 181 the version number of the OS it is running, and comma-separated list of flags
 182 giving the features of that OS.
 183 .TP
 184 .B Dfsroot
 185 Lists the top level DFS domains and the servers that
 186 provision them.
 187 .TP
 188 .B Dfscache
 189 Contents of the DFS referal cache, giving the path prefix,
 190 the expiry time (or -1 for never), the measured RTT to the server
 191 in milliseconds, the server proximity (0 is local), the server name,
 192 and the share name on that server.
 193 .SH COMPATIBILITY
 194 .I Cifs
 195 has been tested against aquarela,
 196 .IR cifsd (8),
 197 Windows 95, NT4.0sp6,
 198 Windows server 2003, Windows server 2003, WinXP pro,
 199 Samba 2.0 (Pluto VideoSpace), and Samba 3.0.
 200 .LP
 201 Windows Vista require a hotfix (registry change)
 202 to support NTLMv2 without GSSAPI, see http://support.microsoft.com/kb/957441.
 203 Alternatively the
 204 .B -a
 205 option can be used to force
 206 .I cifs
 207 to use one of the less secure authentication mechnisms.
 208 .LP
 209 Windows 7 has dropped support for RAP, which is used to generate
 210 the synthetic files offered by
 211 .IR cifs .
 212 RAP is also used to enumerate the shares offered by the remote host so
 213 remote share names must always be specified on the command line.
 214 .LP
 215 The NetApp Filer was supported by earlier releases, however recent
 216 attempts to mount one have failed. Should a server be available it is
 217 likely that this could be easily fixed.
 218 .PP
 219 .SH SOURCE
 220 .B /sys/src/cmd/cifs
 221 .SH SEE ALSO
 222 .IR factotum (4),
 223 .IR cifsd (8)
 224 .SH BUGS
 225 DFS support is unfinished, it will not follow referals that span servers.
 226 .PP
 227 Kerberos authentication is not supported.
 228 .PP
 229 NetBios name resolution is not supported, though it is now rarely used.
 230 .SH HISTORY
 231 .I Cifs
 232 first appeared in Plan 9 from Bell Labs. It was updated to the author's
 233 latest revision for 9front (January, 2012).