Describe implication of upstream ICU-22610
[Samba.git] / docs-xml / smbdotconf / base / bindinterfacesonly.xml
blob9a148f3535b10bbe92bdb6a88e3dd3bae35e5890
1 <samba:parameter name="bind interfaces only"
2                  type="boolean"
3                  context="G"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6         <para>This global parameter allows the Samba admin 
7         to limit what interfaces on a machine will serve SMB requests. It 
8         affects file service <citerefentry><refentrytitle>smbd</refentrytitle>
9         <manvolnum>8</manvolnum></citerefentry> and name service <citerefentry><refentrytitle>nmbd</refentrytitle>
10         <manvolnum>8</manvolnum></citerefentry> in a slightly different ways.</para>
12         <para>
13         For name service it causes <command moreinfo="none">nmbd</command> to bind to ports 137 and 138 on the
14         interfaces listed in the <smbconfoption name="interfaces"/> parameter. <command moreinfo="none">nmbd</command>
15         also binds to the &quot;all addresses&quot; interface (0.0.0.0) on ports 137 and 138 for the purposes of
16         reading broadcast messages.  If this option is not set then <command moreinfo="none">nmbd</command> will
17         service name requests on all of these sockets. If <smbconfoption name="bind interfaces only"/> is set then
18          <command moreinfo="none">nmbd</command> will check the source address of any packets coming in on the
19         broadcast sockets and discard any that don't match the broadcast addresses of the interfaces in the
20         <smbconfoption name="interfaces"/> parameter list.  As unicast packets are received on the other sockets it
21         allows <command moreinfo="none">nmbd</command> to refuse to serve names to machines that send packets that
22         arrive through any interfaces not listed in the <smbconfoption name="interfaces"/> list.  IP Source address
23         spoofing does defeat this simple check, however, so it must not be used seriously as a security feature for
24          <command moreinfo="none">nmbd</command>.
25         </para>
27         <para>
28         For file service it causes <citerefentry><refentrytitle>smbd</refentrytitle>
29         <manvolnum>8</manvolnum></citerefentry> to bind only to the interface list given in the <smbconfoption
30         name="interfaces"/> parameter. This restricts the networks that <command moreinfo="none">smbd</command> will
31         serve, to packets coming in on those interfaces.  Note that you should not use this parameter for machines that
32         are serving PPP or other intermittent or non-broadcast network interfaces as it will not cope with
33         non-permanent interfaces.
34         </para>
36         <para>
37         If <smbconfoption name="bind interfaces only"/> is set and the network address
38          <emphasis>127.0.0.1</emphasis> is not added to the <smbconfoption name="interfaces"/> parameter list
39          <citerefentry><refentrytitle>smbpasswd</refentrytitle> <manvolnum>8</manvolnum></citerefentry> may not
40          work as expected due to the reasons covered below.
41         </para>
43         <para>
44         To change a users SMB password, the <command moreinfo="none">smbpasswd</command> by default connects to the
45          <emphasis>localhost - 127.0.0.1</emphasis> address as an SMB client to issue the password change request. If
46         <smbconfoption name="bind interfaces only"/> is set then unless the network address
47          <emphasis>127.0.0.1</emphasis> is added to the <smbconfoption name="interfaces"/> parameter list then <command
48         moreinfo="none"> smbpasswd</command> will fail to connect in it's default mode.  <command
49         moreinfo="none">smbpasswd</command> can be forced to use the primary IP interface of the local host by using
50         its <citerefentry><refentrytitle>smbpasswd</refentrytitle> <manvolnum>8</manvolnum></citerefentry>      <parameter
51         moreinfo="none">-r <replaceable>remote machine</replaceable></parameter> parameter, with <replaceable>remote
52         machine</replaceable> set to the IP name of the primary interface of the local host.
53         </para>
55 </description>
56 <value type="default">no</value>
57 </samba:parameter>