xref: /illumos-gate/usr/src/man/man4fs/smbfs.4fs (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
1*bbf21555SRichard Lowe.\"
2*bbf21555SRichard Lowe.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
3*bbf21555SRichard Lowe.\" Copyright 2021 Oxide Computer Company
4*bbf21555SRichard Lowe.\"
5*bbf21555SRichard Lowe.\" The contents of this file are subject to the terms of the
6*bbf21555SRichard Lowe.\" Common Development and Distribution License (the "License").
7*bbf21555SRichard Lowe.\" You may not use this file except in compliance with the License.
8*bbf21555SRichard Lowe.\"
9*bbf21555SRichard Lowe.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*bbf21555SRichard Lowe.\" or http://www.opensolaris.org/os/licensing.
11*bbf21555SRichard Lowe.\" See the License for the specific language governing permissions
12*bbf21555SRichard Lowe.\" and limitations under the License.
13*bbf21555SRichard Lowe.\"
14*bbf21555SRichard Lowe.\" When distributing Covered Code, include this CDDL HEADER in each
15*bbf21555SRichard Lowe.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*bbf21555SRichard Lowe.\" If applicable, add the following below this CDDL HEADER, with the
17*bbf21555SRichard Lowe.\" fields enclosed by brackets "[]" replaced with your own identifying
18*bbf21555SRichard Lowe.\" information: Portions Copyright [yyyy] [name of copyright owner]
19*bbf21555SRichard Lowe.\"
20*bbf21555SRichard Lowe.Dd September 9, 2009
21*bbf21555SRichard Lowe.Dt SMBFS 4FS
22*bbf21555SRichard Lowe.Os
23*bbf21555SRichard Lowe.Sh NAME
24*bbf21555SRichard Lowe.Nm smbfs
25*bbf21555SRichard Lowe.Nd CIFS/SMB file system
26*bbf21555SRichard Lowe.Sh DESCRIPTION
27*bbf21555SRichard LoweThe
28*bbf21555SRichard Lowe.Nm
29*bbf21555SRichard Lowefile system allows you to mount CIFS shares that are exported from Windows or
30*bbf21555SRichard Lowecompatible systems.
31*bbf21555SRichard LoweSMB is the historical name for the CIFS protocol, which stands for Server
32*bbf21555SRichard LoweMessage Block and is more commonly used in technical contexts.
33*bbf21555SRichard Lowe.Pp
34*bbf21555SRichard LoweThe
35*bbf21555SRichard Lowe.Nm
36*bbf21555SRichard Lowefile system permits ordinary UNIX applications to change directory into an
37*bbf21555SRichard Lowe.Nm
38*bbf21555SRichard Lowemount and perform simple file and directory operations.
39*bbf21555SRichard LoweSupported operations include
40*bbf21555SRichard Lowe.Xr open 2 ,
41*bbf21555SRichard Lowe.Xr close 2 ,
42*bbf21555SRichard Lowe.Xr read 2 ,
43*bbf21555SRichard Lowe.Xr write 2 ,
44*bbf21555SRichard Lowe.Xr rename 2 ,
45*bbf21555SRichard Lowe.Xr rm 1 ,
46*bbf21555SRichard Lowe.Xr mkdir 1 ,
47*bbf21555SRichard Lowe.Xr rmdir 1 ,
48*bbf21555SRichard Loweand
49*bbf21555SRichard Lowe.Xr ls 1 .
50*bbf21555SRichard Lowe.Ss Limitations
51*bbf21555SRichard LoweSome local UNIX file systems
52*bbf21555SRichard Lowe.Pq for example UFS
53*bbf21555SRichard Lowehave features that are not supported by
54*bbf21555SRichard Lowe.Nm .
55*bbf21555SRichard LoweThese include:
56*bbf21555SRichard Lowe.Bl -bullet -offset indent
57*bbf21555SRichard Lowe.It
58*bbf21555SRichard LoweNo mapped-file access because
59*bbf21555SRichard Lowe.Xr mmap 2
60*bbf21555SRichard Lowereturns
61*bbf21555SRichard Lowe.Er ENOSYS .
62*bbf21555SRichard Lowe.It
63*bbf21555SRichard LoweLocking is
64*bbf21555SRichard Lowe.Sy local only
65*bbf21555SRichard Loweand is not sent to the server.
66*bbf21555SRichard Lowe.El
67*bbf21555SRichard Lowe.Pp
68*bbf21555SRichard LoweThe following are limitations in the CIFS protocol:
69*bbf21555SRichard Lowe.Bl -bullet -offset indent
70*bbf21555SRichard Lowe.It
71*bbf21555SRichard Lowe.Xr unlink 2
72*bbf21555SRichard Loweor
73*bbf21555SRichard Lowe.Xr rename 2
74*bbf21555SRichard Loweof open files returns
75*bbf21555SRichard LoweEr EBUSY .
76*bbf21555SRichard Lowe.It
77*bbf21555SRichard Lowe.Xr rename 2
78*bbf21555SRichard Loweof extended attribute files returns
79*bbf21555SRichard Lowe.Er EINVAL .
80*bbf21555SRichard Lowe.It
81*bbf21555SRichard LoweCreation of files with any of the following illegal characters returns
82*bbf21555SRichard Lowe.Er EINVAL :
83*bbf21555SRichard Lowecolon
84*bbf21555SRichard Lowe.Pq \&: ,
85*bbf21555SRichard Lowebackslash
86*bbf21555SRichard Lowe.Pq \e ,
87*bbf21555SRichard Loweslash
88*bbf21555SRichard Lowe.Pq / ,
89*bbf21555SRichard Loweasterisk
90*bbf21555SRichard Lowe.Pq * ,
91*bbf21555SRichard Lowequestion mark
92*bbf21555SRichard Lowe.Pq \&? ,
93*bbf21555SRichard Lowedouble quote
94*bbf21555SRichard Lowe.Pq \(dq ,
95*bbf21555SRichard Loweless than
96*bbf21555SRichard Lowe.Pq \(la ,
97*bbf21555SRichard Lowegreater than
98*bbf21555SRichard Lowe.Pq \(ra ,
99*bbf21555SRichard Loweand vertical bar
100*bbf21555SRichard Lowe.Pq | .
101*bbf21555SRichard Lowe.It
102*bbf21555SRichard Lowe.Xr chmod 2
103*bbf21555SRichard Loweand
104*bbf21555SRichard Lowe.Xr chown 2
105*bbf21555SRichard Lowesettings are silently discarded.
106*bbf21555SRichard Lowe.It
107*bbf21555SRichard LoweLinks are not supported.
108*bbf21555SRichard Lowe.It
109*bbf21555SRichard LoweSymbolic links are not supported.
110*bbf21555SRichard Lowe.It
111*bbf21555SRichard Lowe.Xr mknod 2
112*bbf21555SRichard Loweis not supported.
113*bbf21555SRichard Lowe.Pq Only file and directory objects are supported.
114*bbf21555SRichard Lowe.El
115*bbf21555SRichard Lowe.Pp
116*bbf21555SRichard LoweThe current
117*bbf21555SRichard Lowe.Nm
118*bbf21555SRichard Loweimplementation does not support multi-user mounts.
119*bbf21555SRichard LoweInstead, each Unix user needs to make their own private mount points.
120*bbf21555SRichard Lowe.Pp
121*bbf21555SRichard LoweCurrently, all access through an
122*bbf21555SRichard Lowe.Nm
123*bbf21555SRichard Lowemount point uses the Windows credentials established by the user that ran the
124*bbf21555SRichard Lowe.Xr mount 8
125*bbf21555SRichard Lowecommand.
126*bbf21555SRichard LoweNormally, permissions on
127*bbf21555SRichard Lowe.Nm
128*bbf21555SRichard Lowemount points should be
129*bbf21555SRichard Lowe.Sy 0700
130*bbf21555SRichard Loweto prevent Unix users from using each others' Windows credentials.
131*bbf21555SRichard LoweSee the
132*bbf21555SRichard Lowe.Ar dirperms
133*bbf21555SRichard Loweoption to
134*bbf21555SRichard Lowe.Xr mount_smbfs 8
135*bbf21555SRichard Lowefor details regarding how to control
136*bbf21555SRichard Lowe.Nm
137*bbf21555SRichard Lowemount point permissions.
138*bbf21555SRichard Lowe.Pp
139*bbf21555SRichard LoweAn important implication of this limitation is that system-wide mounts, such as
140*bbf21555SRichard Lowethose made using
141*bbf21555SRichard Lowe.Pa /etc/vfstab
142*bbf21555SRichard Loweor automount maps are only useful in cases where access control is not a
143*bbf21555SRichard Loweconcern, such as for public read-only resources.
144*bbf21555SRichard Lowe.Sh INTERFACE STABILITY
145*bbf21555SRichard Lowe.Sy Uncommitted
146*bbf21555SRichard Lowe.Sh SEE ALSO
147*bbf21555SRichard Lowe.Xr smbutil 1 ,
148*bbf21555SRichard Lowe.Xr nsmbrc 5 ,
149*bbf21555SRichard Lowe.Xr attributes 7 ,
150*bbf21555SRichard Lowe.Xr mount 8 ,
151*bbf21555SRichard Lowe.Xr mount_smbfs 8
152