xref: /freebsd/share/man/man4/smbfs.4 (revision 95eb4b873b6a8b527c5bd78d7191975dfca38998)
1.\"-
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2020 Gordon Bergling
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.Dd April 6, 2022
28.Dt SMBFS 4
29.Os
30.Sh NAME
31.Nm smbfs
32.Nd server message block (SMB1/CIFS) file system
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following lines in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "option NETSMB"
39.Ed
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45smbfs_load="YES"
46.Ed
47.Sh DESCRIPTION
48The SMB driver is an implementation of the CIFS (Common Internet Filesystem)
49network protocol.
50.Pp
51.Bf -symbolic
52The
53.Nm
54filesystem driver supports only the obsolete SMBv1 protocol.
55.Nm
56has known bugs and likely has security vulnerabilities.
57.Nm
58and userspace counterparts
59.Xr smbutil 1
60and
61.Xr mount_smbfs 8
62may be removed from a future version of
63.Fx .
64Users are advised to evaluate the
65.Pa sysutils/fusefs-smbnetfs
66port instead.
67.Ef
68.Sh SEE ALSO
69.Xr smbutil 1 ,
70.Xr mount_smbfs 8
71.Sh STANDARDS
72.Rs
73.%U https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-cifs/
74.%T Common Internet File System (CIFS) Protocol
75.%R MS-CIFS
76.%D December 2018
77.Re
78.Pp
79.Rs
80.%U https://tools.ietf.org/html/draft-heizer-cifs-v1-spec-00
81.%T Common Internet File System Protocol (CIFS/1.0)
82.%D June 13, 1996
83.%A I. Heizer
84.%A P. Leach
85.%A D. Perry
86.Re
87.Sh HISTORY
88The
89.Nm
90device driver first appeared in
91.Fx 4.4 .
92.Sh AUTHORS
93.An -nosplit
94The
95.Nm
96device driver was written by
97.An Boris Popov Aq Mt bp@FreeBSD.org .
98The manual page was contributed by
99.An Gordon Bergling Aq Mt gbe@FreeBSD.org .
100