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