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><ul>
6             <li><a href="#Partial Authentication"> Partial Authentication</a></li>
7           </ul>
8         </li>
9         <li><a href="#TWiki Username vs. Login Usernam"> TWiki Username vs. Login Username</a></li>
10         <li><a href="#Changing Passwords"> Changing Passwords</a></li>
11       </ul>
12     </li>
13   </ul>
14 </div>
15
16 # <a name="TWiki User Authentication"></a> TWiki User Authentication
17
18 _TWiki site access control and user activity tracking_
19
20 ## <a name="Overview"></a> Overview
21
22 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).
23
24 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.
25
26 ## <a name="Authentication Options"></a> Authentication Options
27
28 No special installation steps need to be performed if the server is already authenticated. If not, you have three standard options for controlling user access:
29
30 1. **Forget about authentication** to make your site completely public - anyone can browse and edit freely, in classic Wiki mode. All visitors are assigned the [[TWikiGuest]] default identity, so you can't track individual user activity. <br />
31 2. **Use SSL** (Secure Sockets Layer; HTTPS) to authenticate and secure the whole server. <br />
32 3. **Use Basic Authentication (HTAccess)** to control access by protecting key scripts: `attach`, `edit=`, `installpasswd`, `password`, `preview`, `rename`, `save`, `upload`, `view`, `viewfile` using .htaccess files. The [[TWiki Installation Guide|Main/TWikiDocumentation#TWiki_Installation_Notes]] has step-by-step instructions.
33
34 ### <a name="Partial Authentication"></a> Partial Authentication
35
36 **Tracking by IP address** is an experimental feature, enabled in `lib/TWiki.cfg`. It lets you combine open access to some functions, with authentication on others, with full user activity tracking:
37
38 - Normally, the <code>**REMOTE\_USER**</code> environment variable is 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.
39
40 - 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 [[TWikiGuest]].
41
42 - Enable this feature by setting the <code>**$doRememberRemoteUser**</code> flag in `TWiki.cfg`. TWiki then persistently stores the IP address/username pairs in the file, `$remoteUserFilename`, which is `"$dataDir/remoteusers.txt"` by default.
43
44 - **_NOTE:_** This approach can fail if the IP address changes due to dynamically assigned IP addresses or proxy servers.
45
46 **Quick Authentication Test** - Use the %WIKIUSERNAME% variable to return your current identity:
47
48 - You are Main.admin
49
50 ## <a name="TWiki Username vs. Login Usernam"></a> TWiki Username vs. Login Username
51
52 This section applies only if your %WIKITOOLNAME% is installed on a server that is both **authenticated** and on an **intranet**.
53
54 %WIKITOOLNAME% internally manages two usernames: Login username and TWiki username.
55
56 - **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.
57
58 - **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.
59
60 %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.
61
62 > **_NOTE:_**
63 >
64 > **To correctly enter a [[WikiName]]**
65 >
66 > - 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:
67 >
68 > <div>
69 >   <center><code><b>Main.WikiUsername</b></code> or <code><b>%MAINWEB%.WikiUsername</b></code></center>
70 > </div>
71 >
72 > This points
73 >
74 > <code>**WikiUser**</code>
75 >
76 > 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
77 >
78 > [[NewTopic]]
79 >
80 > everywhere but in the Main web.
81
82 <a name="ChangingPasswords"></a>
83
84 ## <a name="Changing Passwords"></a> Changing Passwords
85
86 Change and reset passwords using forms on regular pages. Use [[TWikiAccessControl]] to restrict use as required.
87
88 - The [[ChangePassword]] form ( <code>**TWiki/ChangePassword**</code> ):
89
90 >
91
92 - The [[ResetPassword]] form ( <code>**TWiki/ResetPassword**</code> ):
93
94 >
95
96 -- [[MikeMannix]] - 29 Aug 2001