updating docs for new 'map to guest' option and missing 'enable asu support' option
[Samba.git] / docs / smbdotconf / security / maptoguest.xml
blobfaf30a992a97d3427afaf7783facc640efdffb28
1 <samba:parameter name="map to guest"
2                                  type="enum"
3                  context="G"
4                  advanced="1" developer="1"
5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6 <description>
7     <para>This parameter is only useful in <link linkend="SECURITY">
8     security</link> modes other than <parameter moreinfo="none">security = share</parameter> 
9     - i.e. <constant>user</constant>, <constant>server</constant>, 
10     and <constant>domain</constant>.</para>
12     <para>This parameter can take three different values, which tell
13     <citerefentry><refentrytitle>smbd</refentrytitle>
14     <manvolnum>8</manvolnum></citerefentry> what to do with user 
15     login requests that don't match a valid UNIX user in some way.</para>
17     <para>The three settings are :</para>
19     <itemizedlist>
20         <listitem>
21             <para><constant>Never</constant> - Means user login 
22             requests with an invalid password are rejected. This is the 
23             default.</para>
24         </listitem>
25                         
26         <listitem>
27             <para><constant>Bad User</constant> - Means user
28             logins with an invalid password are rejected, unless the username 
29             does not exist, in which case it is treated as a guest login and 
30             mapped into the <link linkend="GUESTACCOUNT"><parameter moreinfo="none">
31             guest account</parameter></link>.</para>
32         </listitem>
34         <listitem>
35             <para><constant>Bad Password</constant> - Means user logins 
36             with an invalid password are treated as a guest login and mapped 
37             into the <link linkend="GUESTACCOUNT">guest account</link>. Note that 
38             this can cause problems as it means that any user incorrectly typing 
39             their password will be silently logged on as &quot;guest&quot; - and 
40             will not know the reason they cannot access files they think
41             they should - there will have been no message given to them
42             that they got their password wrong. Helpdesk services will
43             <emphasis>hate</emphasis> you if you set the <parameter moreinfo="none">map to 
44             guest</parameter> parameter this way :-).</para>
45         </listitem>
46         <listitem>
47             <para><constant>Bad Uid</constant> - Is only applicable when Samba is configured
48             in some type of domain mode security (security = {domain|ads}) and means that
49             user logins which are successfully authenticated but which have no valid 
50             user account (and smbd is unable to create one) should be mapped to the defined
51             guest account.  This was the default behavior of Samba 2.x releases.</para>
52         </listitem>
53     </itemizedlist>
55     <para>Note that this parameter is needed to set up &quot;Guest&quot; 
56     share services when using <parameter moreinfo="none">security</parameter> modes other than 
57     share. This is because in these modes the name of the resource being
58     requested is <emphasis>not</emphasis> sent to the server until after 
59     the server has successfully authenticated the client so the server 
60     cannot make authentication decisions at the correct time (connection 
61     to the share) for &quot;Guest&quot; shares.</para>
63     <para>For people familiar with the older Samba releases, this 
64     parameter maps to the old compile-time setting of the <constant>
65                 GUEST_SESSSETUP</constant> value in local.h.</para>
66 </description>
68 <value type="default">Never</value>
69 <value type="example">Bad User</value>
70 </samba:parameter>