Erweiterung:Lockdown

MediaWiki extensions manual

Lockdown Release status: stable
Implementation	User rights
Description	Implementiert Gruppenberechtigungen für Namensräume
Author(s)	Daniel Kinzler (DuesentriebDiskussion)
MediaWiki	1.31+
PHP	5.5+
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (Phabricator · GitHub) commit history repository contributors (GitHub) code review README
Parameters $wgActionLockdown $wgNamespacePermissionLockdown $wgSpecialPageLockdown
Hooks used MediaWikiPerformAction SearchGetNearMatchComplete SearchableNamespaces getUserPermissionsErrors
Quarterly downloads	353 (Ranked 9th)
Translate the Lockdown extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

Die Lockdown-Erweiterung implementiert eine Möglichkeit, den Zugriff auf bestimmte Namensräume und spezielle Seiten auf eine bestimmte Gruppe von Benutzern zu beschränken. Dies bietet ein feiner abgestuftes Sicherheitsmodell als das der Standardeinstellungen $wgGroupPermissions und $wgNamespaceProtection .

Die folgenden Seiten über das Sicherheitsmodell, das von MediaWiki standardmäßig verwendet wird, können hilfreich sein, um die folgenden Anweisungen zu verstehen:

• Manual:User rights
• Manual:$wgGroupPermissions

Installation

• Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens Lockdown im Ordner extensions/ ablegen.
  Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Lockdown
• Folgenden Code am Ende Ihrer LocalSettings.php -Datei hinzufügen:

  wfLoadExtension( 'Lockdown' );
  

• Nach Bedarf konfigurieren
•  Done – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.

Beispiel

Um Lockdown zu verwenden:

• Zugriff auf Special:Export für angemeldete Benutzer verhindern (registrierter Benutzer)
• Beschränken Sie die Bearbeitung des Projektnamensraums auf eingeloggte Benutzer (registrierte Benutzer)

Sie können dann Folgendes verwenden:

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

Siehe unten für eine Erklärung und weitere Beispiele.

Konfiguration

Beachten Sie, dass die Lockdown-Erweiterung nur verwendet werden kann, um den Zugriff zu beschränken, nicht um ihn zu gewähren. Wenn der Zugriff durch eine integrierte Einstellung von MediaWiki verweigert wird, kann er mit der Lockdown-Erweiterung nicht zugelassen werden.

$wgSpecialPageLockdown

$wgSpecialPageLockdown ermöglicht es Ihnen, für jede spezielle Seite festzulegen, welche Benutzergruppen Zugriff darauf haben. Wenn Sie zum Beispiel die Verwendung von Special:Export auf angemeldete Benutzer beschränken möchten, verwenden Sie dies in LocalSettings.php:

$wgSpecialPageLockdown['Export'] = [ 'user' ];

Beachten Sie, dass einige spezielle Seiten "von Haus aus" eine bestimmte Berechtigung erfordern. Für Special:MovePage, mit dem Sie Seiten verschieben können, benötigen Sie beispielsweise die Berechtigung "move" (die standardmäßig nur angemeldeten Benutzern gewährt wird). Diese Einschränkung kann mit der Lockdown-Erweiterung nicht außer Kraft gesetzt werden.

Einige spezielle Seitentitel werden nicht so groß geschrieben, wie sie im Wiki erscheinen. Zum Beispiel ist Special:RecentChanges intern Recentchanges. Um dies einzuschränken, brauchen Sie also:

$wgSpecialPageLockdown['Recentchanges'] = [ 'user' ];

Eine vollständige Liste der speziellen Seitentitel finden Sie in der Datei "MessagesEn.php" (Array $specialPageAliases) oder verwenden Sie alternativ das API-Modul "siteinfo" wie z.B. /api.php?action=query&meta=siteinfo&siprop=specialpagealiases in Ihrem Wiki.

$wgActionLockdown

Mit $wgActionLockdown können Sie für jede Aktion angeben, welche Benutzergruppen Zugriff darauf haben. Um zum Beispiel die Nutzung der Verlaufsseite auf angemeldete Benutzer zu beschränken, verwenden Sie dies in LocalSettings.php:

$wgActionLockdown['history'] = [ 'user' ];

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

$wgNamespacePermissionLockdown

$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'] = [ 'sysop' ];

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

$wgNamespacePermissionLockdown[NS_PROJECT]['*'] = [ 'sysop' ];
$wgNamespacePermissionLockdown[NS_PROJECT]['read'] = [ '*' ];

$wgNamespacePermissionLockdown['*']['move'] = [ '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'] = [ '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'] = [ 'sysop' ];
$wgNamespacePermissionLockdown[NS_MAIN]['patrol'] = [ 'user' ];

Note that when restricting read-access to a namespace, the restriction can easily be circumvented if the user has read 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 :

$wgNamespacePermissionLockdown[NS_PROJECT]['read'] = [ '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'] = [ 'user' ];
$wgNamespacePermissionLockdown[101]['read'] = [ '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'] = [ 'user' ];
$wgNamespacePermissionLockdown[NS_PRIVATE_TALK]['read'] = [ '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, [  'edit' => [ 'sysop'  ] ] );

$wgNamespacePermissionLockdown vs $wgActionLockdown

$wgActionLockdownis checked considerably sooner (in the MediaWikiPerformAction hook) in the request-handling process than $wgNamespacePermissionLockdown (which is checked in the getUserPermissionsErrors hook).

If an action that $wgActionLockdown does not permit is attempted, a permission error is displayed. Likewise, $wgNamespacePermissionLockdown lets the end user know which groups are allowed to perform the action.

Gruppen verwalten

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 $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.

Zusätzliche Maßnahmen

Images and other uploaded files

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:

• NSFileRepo
• AccessControl

Bekannte Probleme

Lockdown is known to be broken for MW 1.27.x to 1.30.x [1]. Possible side-effects of using it include:

• Incomplete list of namespaces showing under the Advanced tab of Special:Search and on the special page for ReplaceText
• Searchbox no longer offering autocompletion for certain namespaces

A workaround may be to list all namespaces under $wgContentNamespaces , but success is not guaranteed. Another temporary solution is to use a version before the breaking commits, as detailed in Topic:Tr4xxpln3fnpz3eu.

Siehe auch

• Category:User rights extensions
• GroupManager (BlueSpice) - for adding, editing and deleting user groups
• PermissionManager (BlueSpice) - for administering user rights to user groups
• UserProtect - Allows per-user per-right per-page protection
• PageOwnership - Multi-layered permission manager, whole wiki or specific pages, with friendly interface
• AccessControl - Allows restricting access to specific pages and files
• CategoryLockdown - Allows restricting access by category and group