Extension:Lockdown

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual
Crystal Clear action run.png
Lockdown

Release status: beta

Implementation User rights
Description Implements per-namespace group permissions
Author(s) Daniel Kinzler (Duesentriebtalk)
MediaWiki 1.19+
Database changes No
License GPLv2+
Download
README
Parameters
  • $wgNamespacePermissionLockdown
  • $wgSpecialPageLockdown
  • $wgActionLockdown
Hooks used
getUserPermissionsErrors

MediaWikiPerformAction
SearchableNamespaces
SearchGetNearMatchComplete
SearchEngineReplacePrefixesComplete

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

Check usage and version matrix; code metrics

Issues:

Open tasks · Report a bug

The Lockdown extension implements a way to restrict access to specific namespaces and special pages to a given set of user groups. This provides a more finely grained security model than the one provided by the default $wgGroupPermissions and $wgNamespaceProtection settings.

The following pages about the security model used by MediaWiki per default may be helpful to understand the instructions below:

Installing[edit | edit source]

  • Download and extract the file(s) in a directory called Lockdown in your extensions/ folder. If you're a developer and this extension is in a Git repository, then instead you should clone the repository.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/Lockdown/Lockdown.php";
  • Configure as required below calling the extension with require_once.
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Example[edit | edit source]

To use Lockdown to prevent access to Special:Export and restrict editing of the project namespace to logged in users (registered users), you can then use the following:

$wgSpecialPageLockdown['Export'] = array('user');
 
$wgNamespacePermissionLockdown[NS_PROJECT]['edit'] = array('user');

See below for an explanation and more examples.

Configuration[edit | edit source]

Note that the Lockdown extension can only be used to *restrict* access, not to *grant* it. If access is denied by some built-in setting of MediaWiki, it cannot be allowed using the Lockdown extension.

$wgSpecialPageLockdown[edit | edit source]

$wgSpecialPageLockdown allows you to specify for each special page which user groups have access to it. For example, to limit the use of Special:Export to logged in users, use this in LocalSettings.php:

$wgSpecialPageLockdown['Export'] = array('user');

Note that some special pages "natively" require a specific permission. For example, Special:Userrights, which can be used to assign user groups, requires the "userrights" permission (granted only to the "bureaucrat" group per default). This restriction can not be overridden using the Lockdown extension.

Some special page titles not capitalized the way they appear on-wiki. For instance, Special:RecentChanges is Recentchanges internally, so to restrict it you need:

$wgSpecialPageLockdown['Recentchanges'] = array('user');

A full list of special page titles is available in /includes/specials/.

$wgActionLockdown[edit | edit source]

Since r45703 $wgActionLockdown allows you to specify for each action which user groups have access to it. For example, to limit the use of the history page to logged in users, use this in LocalSettings.php:

$wgActionLockdown['history'] = array('user');

Note that some actions can not be locked down this way. In particular, it will not work for the ajax action.

$wgNamespacePermissionLockdown[edit | edit source]

$wgNamespacePermissionLockdown lets you restrict which user groups have which permissions on which namespace. For example, to grant only members of the sysop group write access to the project namespace, use this:

$wgNamespacePermissionLockdown[NS_PROJECT]['edit'] = array('sysop');

Wildcards for either the namespace or the permission (but not both at once) are supported. More specific definitions take precedence:

$wgNamespacePermissionLockdown[NS_PROJECT]['*'] = array('sysop');
$wgNamespacePermissionLockdown[NS_PROJECT]['read'] = array('*');
 
$wgNamespacePermissionLockdown['*']['move'] = array('autoconfirmed');

The first two lines restrict all permissions in the project namespace to members of the sysop group, but still allow reading to anyone. The third line limits page moves in all namespaces to members of the autoconfirmed group.

Note that this way, you cannot *grant* permissions that have not been allowed by the build-in $wgGroupPermissions setting. The following does *not* allow regular users to patrol edits in the main namespace:

$wgNamespacePermissionLockdown[NS_MAIN]['patrol'] = array('user');

Instead, you would have to grant this right in $wgGroupPermissions first, and then restrict it again using $wgNamespacePermissionLockdown:

$wgGroupPermissions['user']['patrol'] = true;
 
$wgNamespacePermissionLockdown['*']['patrol'] = array('sysop');
$wgNamespacePermissionLockdown[NS_MAIN]['patrol'] = array('user');

Note that when restricting read-access to a namespace, the restriction can easily be circumvented if the user has write access to any other namespace: by including a read-protected page as a template, it can be made visible. To avoid this, you would have to forbid the use of pages from that namespace as templates, by adding the namespace's ID to $wgNonincludableNamespaces (this feature was introduced in MediaWiki 1.10, revision 19934, and is also available as an extension for earlier versions):

$wgNamespacePermissionLockdown[NS_PROJECT]['read'] = array('user');
$wgNonincludableNamespaces[] = NS_PROJECT;

You can of course also use Lockdown with custom namespaces defined using $wgExtraNamespaces:

#define custom namespaces
$wgExtraNamespaces[100] = 'Private';
$wgExtraNamespaces[101] = 'Private_talk';
 
#restrict "read" permission to logged in users
$wgNamespacePermissionLockdown[100]['read'] = array('user');
$wgNamespacePermissionLockdown[101]['read'] = array('user');
 
#prevent inclusion of pages from that namespace
$wgNonincludableNamespaces[] = 100;
$wgNonincludableNamespaces[] = 101;

Note that custom namespaces should always be defined in pairs, the namespace proper (with an even id), and the associated talk namespace (with an odd id).

If you want to use constants to refer to your namespaces, you need to define them:

#define constants for your custom namespaces, for a more readable configuration
define('NS_PRIVATE', 100);
define('NS_PRIVATE_TALK', 101);
 
#define custom namespaces
$wgExtraNamespaces[NS_PRIVATE] = 'Private';
$wgExtraNamespaces[NS_PRIVATE_TALK] = 'Private_talk';
 
#restrict "read" permission to logged in users
$wgNamespacePermissionLockdown[NS_PRIVATE]['read'] = array('user');
$wgNamespacePermissionLockdown[NS_PRIVATE_TALK]['read'] = array('user');
 
#prevent inclusion of pages from that namespace
$wgNonincludableNamespaces[] = NS_PRIVATE;
$wgNonincludableNamespaces[] = NS_PRIVATE_TALK;

You could also use array_fill() to restrict multiple namespaces at once, e.g. if you wanted to restrict namespaces 0 to 2009 to editing by sysops only:

$wgNamespacePermissionLockdown = array_fill( 0, 2010, array( 'edit' => array( 'sysop' ) ) );

Managing groups[edit | edit source]

You can control which user belongs to which groups with the page Special:Userrights. Only existing groups will be proposed, but you can "create" a new group by creating an entry for it in Manual:$wgGroupPermissions (even if you don't actually need to set a permission there, but it has to appear on the left hand side of the array). For example:

$wgGroupPermissions['somegroupname']['read'] = true;

For more information, see Help:User rights, Manual:User rights, and Manual:User rights management.

Additional measures[edit | edit source]

Hiding pages[edit | edit source]

The Lockdown extension may prevent page content from being shown, but it does not remove inaccessible pages from listings. To hide such pages, several patches must be applied to MediaWiki. See Extension:Lockdown/hiding_pages for some (unofficial) suggestions. See also mailarchive:mediawiki-l/2009-June/031231.html.

Images and other uploaded files[edit | edit source]

Images and other uploaded files still can be seen and included on any page. Protections on the Image namespace do not prevent that. See Manual:Image Authorisation for information on how to prevent unauthorized access to images. See also:

See also[edit | edit source]

Language: English  • 日本語 • русский