none
[openafs-wiki.git] / TWiki / TWikiUserAuthentication.mdwn
1 <div>
2   <ul>
3     <li><a href="#TWiki User Authentication"> TWiki User Authentication</a><ul>
4         <li><a href="#Overview"> Overview</a></li>
5         <li><a href="#Authentication Options"> Authentication Options</a></li>
6         <li><a href="#Tracking by IP Address"> Tracking by IP Address</a></li>
7         <li><a href="#TWiki Username vs. Login Usernam"> TWiki Username vs. Login Username</a></li>
8         <li><a href="#Changing Passwords"> Changing Passwords</a></li>
9       </ul>
10     </li>
11   </ul>
12 </div>
13
14 ## <a name="TWiki User Authentication"></a> TWiki User Authentication
15
16 _TWiki site access control and user activity tracking_
17
18 ### <a name="Overview"></a> Overview
19
20 TWiki does not authenticate users internally, it depends on the <code>**REMOTE\_USER**</code> environment variable. This variable is set when you enable Basic Authentication (.htaccess) or SSL "secure server" authentication (https protocol).
21
22 TWiki uses visitor identification to keep track of who made changes to topics at what time and to manage a wide range of personal site settings. This gives a complete audit trail of changes and activity.
23
24 ### <a name="Authentication Options"></a> Authentication Options
25
26 No special installation steps need to be performed if the server is already authenticated. If not, you have three remaining options to controlling user access:
27
28 1. **Forget about authentication.** All changes are registered to [[TWikiGuest]] user, so you can't tell who made changes. Your site is completely open and public - anyone can browse and edit freely, in classic Wiki mode.<br />
29 2. **Use Basic Authentication** for the <code>**edit**</code> and <code>**attach**</code> scripts. This uses .htaccess and generates the familiar grey log-in window. The [[TWiki Installation Guide|Main/TWikiDocumentation#TWiki_Installation_Notes]] has step-by-step instructions.<br />
30 3. **Use SSL** to authenticate and secure the whole server.
31
32 ### <a name="Tracking by IP Address"></a> Tracking by IP Address
33
34 The <code>**REMOTE\_USER**</code> environment variable is only set for the scripts that are under authentication. If, for example, the <code>**edit**</code>, <code>**save**</code> and <code>**preview**</code> scripts are authenticated, but not <code>**view**</code>, you would get your [[WikiName]] in <code>**preview**</code> for the <code>**%WIKIUSERNAME%**</code> variable, but <code>**view**</code> will show <code>**TWikiGuest**</code> instead of your WikiName.
35
36 There is a way to tell TWiki to remember the user for the scripts that are not authenticated, ex: in case the <code>**REMOTE\_USER**</code> environment variable is not set. TWiki can be configured to remember the IP address/username pair whenever an authentication happens (edit topic, attach file). Once remembered, the non-authenticated scripts like <code>**view**</code> will show the correct username instead of <code>**TWikiGuest**</code>. You can enable this by setting the <code>**$doRememberRemoteUser**</code> flag in <code>**TWiki.cfg**</code>. TWiki persistently stores the IP address/username pairs in the file <code>**$remoteUserFilename**</code>, which is <code>**"$dataDir/remoteusers.txt"**</code> by default. Please note that this can fail if the IP address changes due to dynamically assigned IP addresses or proxy servers.
37
38 **Authentication Test:** You are Main.admin (%WIKIUSERNAME%)
39
40 ### <a name="TWiki Username vs. Login Usernam"></a> TWiki Username vs. Login Username
41
42 This section applies only if your %WIKITOOLNAME% is installed on a server that is both **authenticated** and on an **intranet**.
43
44 %WIKITOOLNAME% internally manages two usernames: Login username and TWiki username.
45
46 - **Login username:** When you login to the intranet, you use your existing login username, ex: <code>**pthoeny**</code>. This name is normally passed to %WIKITOOLNAME% by the <code>**REMOTE\_USER**</code> environment variable, and used by internally by %WIKITOOLNAME%. Login usernames are maintained by your system administrator.
47 - **TWiki username:** Your name in [[WikiNotation]], ex: <code>**PeterThoeny**</code>, is recorded when you register using [[TWikiRegistration]]; doing so also generates a personal home page in the Main web.
48
49 %WIKITOOLNAME% can automatically map an intranet username to a TWiki username, provided that the username pair exists in the [[TWikiUsers]] topic. This is also handled automatically when you register.
50
51 > **NOTE:**
52 >
53 > **To correctly enter a [[WikiName]]**
54 >
55 > - your own or someone else's - be sure to include the Main web name in front of the Wiki username, followed by a period, and no spaces. Ex:
56 >
57 > <div>
58 >   <center><code><b>Main.WikiUsername</b></code> or <code><b>%MAINWEB%.WikiUsername</b></code></center>
59 > </div>
60 >
61 > This points
62 >
63 > <code>**WikiUser**</code>
64 >
65 > to the %WIKITOOLNAME%.Main web, where user registration pages are stored, no matter which web it's entered in. Without the web prefix, the name appears as a
66 >
67 > [[NewTopic]]
68 >
69 > everywhere but in the Main web.
70
71 <a name="ChangingPasswords"></a>
72
73 ### <a name="Changing Passwords"></a> Changing Passwords
74
75 Change and reset passwords using forms on regular pages. Use topic-level [[TWikiAccessControl]] to restrict use as required.
76
77 - The [[ChangePassword]] form, <code>**TWiki/ChangePassword**</code>:
78
79 >
80
81 - The [[ResetPassword]] form <code>**TWiki/ResetPassword**</code>:
82
83 >
84
85 -- [[PeterThoeny]] - 16 Mar 2001 <br /> -- [[MikeMannix]] - 29 Aug 2001