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