Extension:AccessControl

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
AccessControl

Release status:Extension status stable

ImplementationTemplate:Extension#type User rights, Tag
DescriptionTemplate:Extension#description Allows restricting access to specific pages based on internal groups or group lists from userspace
Author(s)Template:Extension#username Aleš Kapica (Wanttalk)
Latest versionTemplate:Extension#version 2.6 (6 June 2016(2016-06-06))
MediaWikiTemplate:Extension#mediawiki MW 1.23+ ≥ AC 2.6 (recommended),
MW 1.21.x + 1.22.x ≥ AC 2.5 (obsolete),
MW 1.18.x - 1.20.x = AC 2.1 (obsolete),
MW 1.16 ≤ AC 1.3 (obsolete)
PHPTemplate:Extension#php 5.4+
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download
ExampleTemplate:Extension#example DCEwiki or Thewoodcraft.org
TagsTemplate:Extension#tags
<accesscontrol>
Hooks usedTemplate:Extension#hook
ParserFirstCallInitManual:Hooks/ParserFirstCallInit
userCanManual:Hooks/userCan
UnknownActionManual:Hooks/UnknownAction

Translate the AccessControl extension if it is available at translatewiki.net

Check usage and version matrix.

IssuesPhabricator

Open tasks · Report a bug

The AccessControl extension allows restricting access to specific pages based on internal groups or group lists from user space.

Rationale[edit]

MediaWiki in its default state is not designed as a Content Management System (CMS), but when used as a corporate or school intranet it is required to protect sensitive data. AccessControl has been developed for this purpose.

The first version of this extension (1.x) was based on Group Based Access Control, but without bugs the original had.[1]

How this extension meets the requirements for site security[edit]

Warning Warning: It is recommended to use last stable version of MediaWiki because older versions of MediaWiki can be bypassed by different methods!
Atom/RSS feeds, diff, & revision links 
Page content is protected, but when opening a page from history a piece of raw content will appear. If the <accesscontrol> tag was placed at the beginning, a potential attacker may be able to see the names of contributing users!
Listings & search 
Unless otherwise noted, if there is any page with protected content in search results, the user is redirected away. Since extension version 2.5, searching may be allowed too. But it should be borne in mind that the displayed search results can compromise sensitive data. Therefore, do not write in your wiki sensitive information, such as passwords, that could be obtained through a fulltext search if searching through the contents of pages protected through an access control is allowed!
Inclusion/transclusion, related rights, & other extensions
Pages containing the <accesscontrol> tag, or including another page protected by the <accesscontrol> tag, are secure. The <accesscontrol> tag is processed in raw wikitext before HTML conversion.
Warning Warning: When using DynamicPageList (third-party), you must know that this extension selects from content pages before the parser analyzes wikitext. Protection of generated pages by an <accesscontrol> tag depends on the tag being included in the content of new page.
Redirects
The problem with redirection was repaired in version 1.1
API & action links
For each anonymous user the action class is automatically set to false, besides the view attribute for unprotected pages. Allowed actions for authorized users depend on the permissions settings of MediaWiki and the username listed in the access list pages use.
Edit Section & watching pages
Options are available only to registered users if they are logged in and are on the security access list.
Files & images 
Warning: The extension AccessControl does not protect files against direct access via URL! If files cannot be publicly available, they must be protected at the server level!
XML export (Special
Export) : Warning: AccessControl version < 2.0, was based on a hook unprotected from MediaWiki's side before exporting pages to raw code. Therefore, if you use AccessControl version < 2.0, you must prohibit the special page to prohibit exporting the pages from MediaWiki.
Author backdoor 
Extension AccessControl does not have a backdoor!
Caching 
I recommend turning off caching. See the previous paragraphs.

More info about potential problems regarding security is on the page Security issues with authorization extensions.

Features[edit]

Since version 2.1 the extension examines the embedded page or template as well.
  • Easy to set up and simple to use.
  • No patches to MediaWiki core.
  • Unlimited groups.
  • Dual mode access control:
    • View control.
    • Edit control, including restrictions on manual edit access when using action=edit in the URL.
  • User groups may use any namespace.
    • Namespaces with group lists may be protected by another extension.
  • MediaWiki sysop group may view and edit the protected pages.
    • Controlled by extension variable $wgAdminCanReadAll
  • Access may be granted to multiple groups
  • Read-only access may be granted to both groups and individual users.
  • Unauthorized users can use the search feature only if is it allowed. See how this extension meets the requirements for site security.

Documentation[edit]

From 11 May 2012(2012-05-11) this extension is in MediaWiki's extensions git repository - Browse the Git Tree.
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/AccessControl.git

Installation[edit]

Step 1: Local Settings File[edit]

  • Add the following lines to the bottom of your LocalSettings.php:
require_once "extensions/AccessControl/AccessControl.php";
  • Check the settings in AccessControl.php. These can be set in LocalSettings.php:
$wgAdminCanReadAll = true;			// sysop users can read all restricted pages
$wgAccessControlRedirect = false;	// don't redirect from page with search results for denied and
									// anonymous users, if searching pattern is validate on any
									// protected page.

Step 2: Create User Groups[edit]

User groups are simply standard wiki pages that are part of a namespace other than the default namespace. For ease of use, it is suggested that a specific custom namespace is created for the explicit purpose of managing access control list pages.

  • Create a wiki page with a users list in any namespace[2]
    • It is not sufficient to simply create a page with a colon (:) in the name, this extension requires the use of a namespace and one or more pages within namespaces
    • Page Name Example: My:Group
      • The namespace is My
      • The group page is Group
        • This is the name of user group
        • Users are added to the group in a bulleted list
    • Page Content Example
      • Presume that the namespace IT exists
      • Create a page in the namespace titled "Department"
      • Create users "John Doe" and "Jane Doe" in the group. The group information is contained on the page "Department".
      • Each username appears as a list item.
* John Doe
* Jane Doe (ro)
Usernames listed with "(ro)" at the end can only read the protected article, not edit it. For other groups of users, you can create another member list with the name Department in another namespace.
Tips
To protect the IT namespace you can use the Lockdown extension, but you can also use the <accesscontrol> tag to protect it.

Step 3: Additional Access Control[edit]

  • Depending on localization, your wiki needs pages created to which anonymous or unauthorized users will be redirected. You have to create them in advance because some of them can't access pages from another page.
  • The safety of the page is provided by the <accesscontrol> tag. If there isn't a tag or the page is empty, it's freely accessible to logged-in users that can read and edit the page. No user, logged in or anonymous, will have read-only access.
  • Members from groups listed in the <accesscontrol> tag can edit the page only if the group title isn't listed with "(ro)" and if they don't have read only access set in the group member list.
  • By default the variable $wgAdminCanReadAll is set to true so that members of 'sysop' can edit user group pages in any namespace.
Warning Warning: When set to false, members of sysop can't read and edit pages protected with the <accesscontrol> tag, which may lead to big trouble. This can only be remedied on the code level.
Example tag code 
<accesscontrol>Administrators,IT:Department,Sales(ro)</accesscontrol>

In this example, all users from the groups "Administrators", "IT:Department" and "Sales" can read the page but only the users from "Administrators" group (if exists) and John Doe from "IT:Department" user group can edit it.

Usage on Pages to Control Access[edit]

That is for the installation. To restrict access to a page for specific user groups, just include the names of the allowed user groups (separated by commas) as the content of the <accesscontrol> tag in the top of the content page.

Attention[edit]

MediaWiki version: 1.21

Version 2.5.1 is strongly recommended to be used.

For version < 2.3[edit]

  • There was a problem in function fromTemplate() causing AccessControl to ignore tags from included pages or templates. Actualization is recommended!

For version ≥ 2.0[edit]

MediaWiki versions: 1.18 – 1.20
Warning Warning: From version 2.0 the extension does not use wiki user groups (except sysop), only groups created by user access lists!
  • Pages can have only one <accesscontrol> element.
  • If the user is a member of multiple groups, the group that gives them more access is assumed.
  • This extension uses a MediaWiki hook that is called whenever a search result is displayed. This means that a page that has an ACL will trigger an "Access Denied" message for end users who happen to search for text contained in a protected page. A simple solution is to put pages that require AccessControl into another namespace and then disable searching for that namespace. Although this isn't really a bug, it is undesirable behavior. Click here for an example showing a work around.
Warning Warning: Mediawiki >= 1.21 contains new a framework ContentHandler and extension version 2.1 is unusable. Use AccessControl version 2.2 which is updated for MediaWiki 1.21 and above.

For version ≤ 1.3[edit]

MediaWiki version: 1.17
  • Groups from MediaWiki must not be in localized form! 'sysop' cannot be 'Správce' , etc.
  • A page may have multiple <accesscontrol> elements, with access accepted from groups in any tag.
  • Anonymous users do not have access to pages protected by <accesscontrol> elements.
  • If variable $wgAdminCanReadAll is true, sysops always have edit access.

MediaWiki Version Testing[edit]

  • Version 2.6 was tested on MediaWiki version 1.27.0-rc.0 (57f722a)
  • Version 2.5 was tested on MediaWiki version 1.27.0 (from git repository)
  • Version 2.5 was tested on MediaWiki version 1.22.9 (from git repository)
  • Version 2.3 was tested on MediaWiki version 1.22.0 (from git repository)
  • Version 2.2 was tested on MediaWiki version 1.22.0 (from git repository)
  • Version 2.0 was tested on MediaWiki version 1.19-alpha (from svn repository)
  • Version 1.2 was tested on MediaWiki version 1.15.5-1 (from Debian repository)
  • Version 1.1 was tested on MediaWiki version 1.16.0(b3). Works fine, except that it needed a minor change to line 358 of AccessControl.php (remove '&' from parameter to function controlEditAccess() ). When viewing a page on a Linux server, the <accesscontrol> tags show. But on a Windows server, the tags don't show and it is fine! Still haven't figured that one out, but it is ok for my application.
  • Version 1.1 was tested on MediaWiki version 1.15
  • Version 1.0 of this extension has been tested and works fine on MediaWiki versions > 1.12.x.
  • Version 1.1 tested on MediaWiki version 1.16.1 with new patch from http://git.felk.cvut.cz/pub/git?p=accesscontrol.git;a=commitdiff;h=2f678deed0e4e4f77620e391c94559c7b50102a9

See also[edit]

Notes[edit]

  1. Unlike Group Based Access Control, double commas aren't used to split the content of an <accesscontrol> tag when more access lists are used. Only one comma is required. And is not necessary to use the ',,' separator at the end of the element content.
  2. As of version 2.0, it only works with ACLs stored in the main namespace. It also can only protect pages that are in the main namespace. Changes need to be made to $getUsersFromPages and $getContentPage to correct this behavior. Click here to see a patched version of the extension that is compatible with namespaces.