none
[openafs-wiki.git] / TWiki / TWikiAccessControl.mdwn
1 <div>
2   <ul>
3     <li><a href="#TWiki Access Control"> TWiki Access Control</a><ul>
4         <li><a href="#An Important Control Considerati"> An Important Control Consideration</a></li>
5         <li><a href="#Users and Groups"> Users and Groups</a><ul>
6             <li><a href="#Managing Users"> Managing Users</a></li>
7             <li><a href="#Managing Groups"> Managing Groups</a></li>
8           </ul>
9         </li>
10         <li><a href="#Restricting Write Access"> Restricting Write Access</a><ul>
11             <li><a href="#Deny Editing by Topic"> Deny Editing by Topic</a></li>
12             <li><a href="#Deny Editing by Web"> Deny Editing by Web</a></li>
13           </ul>
14         </li>
15         <li><a href="#Restricting Rename Access"> Restricting Rename Access</a><ul>
16             <li><a href="#Deny Renaming by Topic"> Deny Renaming by Topic</a></li>
17             <li><a href="#Deny Renaming by Web"> Deny Renaming by Web</a></li>
18           </ul>
19         </li>
20         <li><a href="#Restricting Web Access"> Restricting Web Access</a><ul>
21             <li><a href="#Create Hidden Webs"> Create Hidden Webs</a></li>
22             <li><a href="#Create Authenticated Access By W"> Create Authenticated Access By Web</a></li>
23           </ul>
24         </li>
25         <li><a href="#Hiding Control Settings"> Hiding Control Settings</a></li>
26         <li><a href="#The _SuperAdminGroup"> The SuperAdminGroup</a></li>
27       </ul>
28     </li>
29   </ul>
30 </div>
31
32 # <a name="TWiki Access Control"></a> TWiki Access Control
33
34 _Restricting read and write access to topics and webs, by Users and groups_
35
36 [[TWikiAccessControl]] allows you restrict access to single topics and entire webs, by individual user and by user Groups, in three areas: view; edit &amp; attach; and rename/move/delete. Access control, combined with [[TWikiUserAuthentication]], lets you easily create and manage an extremely flexible, fine-grained privilege system.
37
38 ## <a name="An Important Control Considerati"></a> An Important Control Consideration
39
40 Open, freeform editing is the essence of [[WikiCulture]] - what makes TWiki different and often more effective than other collaboration tools. For that reason, it is strongly recommended that decisions to restrict read or write access to a web or a topic are made with care - the more restrictions, the less Wiki in the mix. Experience shows that _unrestricted write access_ works very well because:
41
42 - **Peer influence** is enough to ensure that only relevant content is posted.
43
44 - **Peer editing** - the ability for anyone to rearrange all content on a page - keeps topics focussed.
45
46 - In TWiki, content is transparently preserved under **revision control**:
47   - Edits can be undone by the [[TWikiAdminGroup]] (the default administrators group; see [[#ManagingGroups|Main/WebHome#ManagingGroups]]).
48   - Users are encouraged to edit and refactor (condense a long topic), since there's a safety net.
49
50 As a **collaboration guideline**:
51
52 - Create broad-based Groups (for more and varied input), and...
53 - Avoid creating view-only Users (if you can read it, you should be able to contribute to it).
54
55 ## <a name="Users and Groups"></a> Users and Groups
56
57 Access control is based on the familiar concept of Users and Groups. Users are defined by their [[WikiNames]]. They can then be organized in unlimited combinations by inclusion in one or more user Groups. For convenience, Groups can also be included in other Groups.
58
59 ### <a name="Managing Users"></a> Managing Users
60
61 A user is created with the [[TWikiRegistration]] form. The process generates a topic in the Main web in the new user's [[WikiName]]. The default visitor name is [[TWikiGuest]].
62
63 - Users can be authenticated using Basic Authentication (htaccess) or SSL (secure server). In either case, [[TWikiUserAuthentication]] is required in order to track user identities, and use User and Group access control.
64
65 <a name="ManagingGroups"></a>
66
67 ### <a name="Managing Groups"></a> Managing Groups
68
69 Groups are defined by group topics created in the <code>**Main**</code> web, like the [[TWikiAdminGroup]]. To create a new group:
70
71 1. <code>**Edit**</code> [[TWikiGroups]] by entering a new topic with a name that ends in <code>**Group**</code>. Example:
72   - <code>**SomeGroup**</code>
73 2. **Set Preferences** for two Variables in the new group topic:
74   - <code>**Set GROUP = &lt; list of Users and/or Groups &gt;**</code>
75   - <code>**Set ALLOWTOPICCHANGE = &lt; list of Users and/or Groups &gt;**</code>
76   - The GROUP variable is a comma-separated list of Users and/or other Groups. Example:
77     - <code>**Set GROUP = Main.SomeUser, Main.OtherUser, Main.SomeGroup**</code>
78   - ALLOWTOPICCHANGE defines who is allowed to change the group topic; it is a comma delimited list of Users and Groups. You typically want to restrict that to the members of the group itself, so it should contain the name of the topic. (This prevents Users not in the Group from editing the topic to give themselves or others access. For example, for the TWikiAdminGroup topic write:
79   - <code>**Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup**</code>
80
81 ## <a name="Restricting Write Access"></a> Restricting Write Access
82
83 You can define who is allowed to make changes to a web or a topic.
84
85 ### <a name="Deny Editing by Topic"></a> Deny Editing by Topic
86
87 Denying editing of a topic also restricts file attachment; both privileges are assigned together.
88
89 - Define one or both of these variables in a topic, preferably at the end of the page:
90   - <code>**Set DENYTOPICCHANGE = &lt; list of Users and Groups &gt;**</code>
91   - <code>**Set ALLOWTOPICCHANGE = &lt; list of Users and Groups &gt;**</code>
92
93 - DENYTOPICCHANGE defines Users or Groups that **are not** allowed to make changes to the topic, with a comma-delimited list. Example:
94   - <code>**Set DENYTOPICCHANGE = Main.SomeBadBoy, Main.SomeBadGirl, Main.SomeHackerGroup**</code>
95
96 - ALLOWTOPICCHANGE defines Users or Groups that **are** allowed to make changes to the topic. It is a comma delimited list of Users and Groups. Example:
97   - <code>**Set ALLOWTOPICCHANGE = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.TWikiAdminGroup**</code>
98
99 - DENYTOPICCHANGE is evaluated before ALLOWTOPICCHANGE. Access is denied if the authenticated person is in the DENYTOPICCHANGE list, or not in the ALLOWTOPICCHANGE list. Access is granted in case DENYTOPICCHANGE and ALLOWTOPICCHANGE is not defined.
100
101 ### <a name="Deny Editing by Web"></a> Deny Editing by Web
102
103 Restricting web-level editing blocks creating new topics, changing topics or attaching files.
104
105 - Define one or both of these variable in the [[WebPreferences]] topic:
106   - <code>**Set DENYWEBCHANGE = &lt; list of Users and Groups &gt;**</code>
107   - <code>**Set ALLOWWEBCHANGE = &lt; list of Users and Groups &gt;**</code>
108
109 The same rules apply as for restricting topics, with these additions:
110
111 - DENYTOPICCHANGE (in topic) overrides DENYWEBCHANGE (in WebPreferences)
112 - ALLOWTOPICCHANGE (in topic) overrides ALLOWWEBCHANGE (in WebPreferences)
113
114 ## <a name="Restricting Rename Access"></a> Restricting Rename Access
115
116 You can define who is allowed to rename, move or delete a topic, or rename a web.
117
118 ### <a name="Deny Renaming by Topic"></a> Deny Renaming by Topic
119
120 To allow a user to rename, move or delete a topic, they also need write (editing) permission. They also need write access to change references in referring topics.
121
122 - Define one or both of these variables in a topic, preferably at the end of the topic:
123   - <code>**Set DENYTOPICRENAME = &lt; list of Users and Groups &gt;**</code>
124   - <code>**Set ALLOWTOPICRENAME = &lt; list of Users and Groups &gt;**</code>
125
126 - DENYTOPICCRENAME defines Users or Groups that **are not** allowed to rename the topic. It is a comma delimited list of Users and Groups. Example:
127   - <code>**Set DENYTOPICRENAME = Main.SomeBadBoy, Main.SomeBadGirl, Main.SomeHackerGroup**</code>
128
129 - ALLOWTOPICRENAME defines Users or Groups that **are** allowed to rename the topic. It is a comma delimited list of Users and Groups. Example:
130   - <code>**Set ALLOWTOPICRENAME = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.TWikiAdminGroup**</code>
131
132 - DENYTOPICRENAME is evaluated before ALLOWTOPICRENAME. Access is denied if the authenticated person is in the DENYTOPICRENAME list, or not in the ALLOWTOPICRENAME list. Access is granted in case DENYTOPICRENAME and ALLOWTOPICRENAME is not defined.
133
134 ### <a name="Deny Renaming by Web"></a> Deny Renaming by Web
135
136 You can define restrictions of who is allowed to rename a %WIKITOOLNAME% web.
137
138 - Define one or both of these variable in the [[WebPreferences]] topic:
139   - <code>**Set DENYWEBRENAME = &lt; list of Users and Groups &gt;**</code>
140   - <code>**Set ALLOWWEBRENAME = &lt; list of Users and Groups &gt;**</code>
141
142 The same rules apply as for topics, with these additions:
143
144 - DENYTOPICRENAME (in topic) overrides DENYWEBRENAME (in WebPreferences)
145 - ALLOWTOPICRENAME (in topic) overrides ALLOWWEBRENAME (in WebPreferences)
146
147 ## <a name="Restricting Web Access"></a> Restricting Web Access
148
149 You can prevent selected Users and Groups from accessing certain webs, by hiding them using restricting read access, or by requiring login. There are two basic methods, one simple, using standard preferences variables to hide a web, but offering low security, and a secure log-in approach that is currently a workaround, involving some minor script and filesystem modification.
150
151 ### <a name="Create Hidden Webs"></a> Create Hidden Webs
152
153 You can prevent selected Users and Groups from viewing certain %WIKITOOLNAME% webs by setting one or both of these variables in each web's [[WebPreferences]] topic:
154
155 - <code>**Set DENYWEBVIEW = &lt; list of Users and Groups &gt;**</code>
156 - <code>**Set ALLOWWEBVIEW = &lt; list of Users and Groups &gt;**</code>
157
158 %T% If keeping a hidden web out of general use is a consideration, you can prevent the <code>**all webs**</code> search option from accessing hidden webs, by enabling the <code>**NOSEARCHALL**</code> variable in [[WebPreferences]]:
159
160 - <code>**Set NOSEARCHALL = on**</code>
161   - It is not recommended to restrict view access to individual topics since all content is searchable _within_ a web.
162   - %H%This method only works if the <code>**view**</code> script is authenticated, which means that all Users have to login, even for read-only access. (An open guest account, like [[TWikiGuest]], can get around this, allowing anyone to login to a common account with, for example, view-only access for public webs.) [[TWikiInstallationGuide]] has more on Basic Authentication, using the <code>**.htaccess**</code> file.
163
164 %X% **Hiding webs is not very secure**, as there is a way to circumvent the read access restriction. It can be useful in certain situations - for example, to simplify site organization and clutter, by hiding low traffic webs - but is not recommended for securing sensitive content. _(See the next section for a more secure approach.)_
165
166 ### <a name="Create Authenticated Access By W"></a> Create Authenticated Access By Web
167
168 Use the following setup to provide unrestricted viewing access to open webs, with authentication only on selected webs:
169
170 1. **Omit** the <code>**view**</code> script from the `.htaccess` file.
171 2. **Enable** the <code>**$doRememberRemoteUser**</code> flag in <code>**lib/TWiki.cfg**</code> as described in [[TWikiUserAuthentication]]. %WIKITOOLNAME% will now remember the IP address of an authenticated user.
172 3. **Copy** the <code>**view**</code> script to <code>**viewauth**</code> (or better, create a symbolic link)
173 4. **Add** <code>**viewauth**</code> to the list of authenticated scripts in the .htaccess file.
174
175 - When a user accesses a web where you enabled view restriction, %WIKITOOLNAME% will redirect from the `view` script to the `viewauth` script once (this happens only if the user has never edited a topic). Doing so will ask for authentication. The `viewauth` script shows the requested topic if the user could log on and if the user is authorized to see that web.
176 - If you enable view restriction for a web, it is recommended to restrict search "all webs" from searching this web. Enable this restriction with the <code>**NOSEARCHALL**</code> variable in its [[WebPreferences]], like:
177   - <code>**Set NOSEARCHALL = on**</code>
178 - It is not recommended to restrict view access to individual topics since all content is searchable within a web - a search will turn up the "hidden" topic.
179
180 ## <a name="Hiding Control Settings"></a> Hiding Control Settings
181
182 - %T% To hide access control settings from normal browser viewing, place them in comment markers.
183
184 > &lt;!--
185 >
186 > <br />
187 >
188 > - Set DENYTOPICCHANGE = Main.SomeGroup<br /> --&gt;
189
190 <a name="SuperAdminGroup"></a>
191
192 ## <a name="The _SuperAdminGroup"></a> The SuperAdminGroup
193
194 By mistyping a user or group name in the ALLOWTOPICCHANGE setting, it's possible to lock a topic so that no-one can edit it from a browser. To avoid this, you can create Web-based **superusers**:
195
196 - Set the <code>**$superAdminGroup**</code> variable in <code>**lib/TWiki.cfg**</code> to the name of a group of Users who are always allowed to edit/view topics.
197
198 > $superAdminGroup = "TWikiAdminGroup";
199
200 - The default setting is not to have superusers.
201
202 -- [[PeterThoeny]] - 04 May 2002<br /> -- [[MikeMannix]] - 12 May 2002