docs:smbdotconf: remove swat-specific flags.
[Samba.git] / docs-xml / smbdotconf / security / maptoguest.xml
blob2e4c6340c2a780c0b63d4b91c3da3c5059afe3d7
1 <samba:parameter name="map to guest"
2                                  type="enum"
3                  context="G"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6     <para>This parameter can take four different values, which tell
7     <citerefentry><refentrytitle>smbd</refentrytitle>
8     <manvolnum>8</manvolnum></citerefentry> what to do with user 
9     login requests that don't match a valid UNIX user in some way.</para>
11     <para>The four settings are :</para>
13     <itemizedlist>
14         <listitem>
15             <para><constant>Never</constant> - Means user login 
16             requests with an invalid password are rejected. This is the 
17             default.</para>
18         </listitem>
19                         
20         <listitem>
21             <para><constant>Bad User</constant> - Means user
22             logins with an invalid password are rejected, unless the username 
23             does not exist, in which case it is treated as a guest login and 
24             mapped into the <smbconfoption name="guest account"/>.</para>
25         </listitem>
27         <listitem>
28             <para><constant>Bad Password</constant> - Means user logins 
29             with an invalid password are treated as a guest login and mapped 
30             into the <smbconfoption name="guest account"/>. Note that 
31             this can cause problems as it means that any user incorrectly typing 
32             their password will be silently logged on as &quot;guest&quot; - and 
33             will not know the reason they cannot access files they think
34             they should - there will have been no message given to them
35             that they got their password wrong. Helpdesk services will
36             <emphasis>hate</emphasis> you if you set the <parameter moreinfo="none">map to 
37             guest</parameter> parameter this way :-).</para>
38         </listitem>
39         <listitem>
40             <para><constant>Bad Uid</constant> - Is only applicable when Samba is configured
41             in some type of domain mode security (security = {domain|ads}) and means that
42             user logins which are successfully authenticated but which have no valid Unix
43             user account (and smbd is unable to create one) should be mapped to the defined
44             guest account. This was the default behavior of Samba 2.x releases.  Note that 
45             if a member server is running winbindd,  this option should never be required
46             because the nss_winbind library will export the Windows domain users and groups
47             to the underlying OS via the Name Service Switch interface.</para>
48         </listitem>
49     </itemizedlist>
51     <para>Note that this parameter is needed to set up &quot;Guest&quot; 
52     share services. This is because in these modes the name of the resource being
53     requested is <emphasis>not</emphasis> sent to the server until after 
54     the server has successfully authenticated the client so the server 
55     cannot make authentication decisions at the correct time (connection 
56     to the share) for &quot;Guest&quot; shares. </para>
57 </description>
59 <value type="default">Never</value>
60 <value type="example">Bad User</value>
61 </samba:parameter>