none
[openafs-wiki.git] / TWiki / TWikiAccessControl.mdwn
1 %WIKITOOLNAME% allows to define some restrictions of who is allowed to make changes and attach files to topics.
2
3 **IMPORTANT NOTE:** Is is recommended to use the access control feature only if absolutely necessary because it goes against the free [[WikiCulture]], where everybody is invited to contribute to any topic.
4
5 **_Users and Groups_**
6
7 Access control is based on users and groups.
8
9 **_Users_** are defined by the user topics in the Main web, i.e. [[TWikiGuest]]
10
11 - Users can be authenticated using basic authentication or SSL. [Installation Notes](TWikiDocumentation#installation) has more.
12
13 **_Groups_** are defined by group topics in the Main web, i.e. [[TWikiAdminGroup]]
14
15 - A group topic name must end in **...Group**
16 - The group topic should define these two variables:
17   - Set GROUP = < list of users and groups >
18   - Set ALLOWTOPICCHANGE = < list of users and groups >
19 - GROUP defines the members of the group; it is a comma delimited list of users and other groups. Example: <br />`    * Set GROUP = Main.SomeUser, Main.OtherUser, Main.SomeOtherGroup`
20 - 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, i.e. <br />`    * Set ALLOWTOPICCHANGE = Main.TWikiAdminGroup`<br /> for the TWikiAdminGroup topic. (This is to prevent users not in the group from editing the topic and gaining unauthorized membership to the group.)
21
22 **_Access Control for Individual Topics_**
23
24 You can define some restrictions of who is allowed to make changes and attach files to a topic.
25
26 Define one or both of these variables in a topic, preferably at the end of the topic:
27
28 - Set DENYTOPICCHANGE = &lt; list of users and groups &gt;
29 - Set ALLOWTOPICCHANGE = &lt; list of users and groups &gt;
30
31 DENYTOPICCHANGE defines users or groups that **are not** allowed to make changes to the topic. It is a comma delimited list of users and groups. Example: <br />`    * Set DENYTOPICCHANGE = Main.SomeBadBoy, Main.SomeBadGirl, Main.SomeHackerGroup`
32
33 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: <br />`    * Set ALLOWTOPICCHANGE = Main.SomeGoodGuy, Main.SomeGoodGirl, Main.TWikiAdminGroup`
34
35 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.
36
37 **_Access Control per %WIKITOOLNAME% Web_**
38
39 You can define some restrictions of who is allowed to make changes and attach files to topics or create new topics in a %WIKITOOLNAME% web.
40
41 Define one or both of these variable in the [[WebPreferences]] topic:
42
43 - Set DENYWEBCHANGE = &lt; list of users and groups &gt;
44 - Set ALLOWWEBCHANGE = &lt; list of users and groups &gt;
45
46 The same rules apply like the one for Access Control for Individual Topics; with these additions:
47
48 - DENYTOPICCHANGE (in topic) overrides DENYWEBCHANGE (in WebPreferences)
49 - ALLOWTOPICCHANGE (in topic) overrides ALLOWWEBCHANGE (in WebPreferences)
50
51 **_Related topics:_** [[TWikiPreferences]], [[WebPreferences]] (in every web), [[TWikiAdminGroup]]
52
53 -- [[PeterThoeny]] - 28 Oct 2000 <br />