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