Jump to content

Розширення:CentralAuth

Issue tracker: #MediaWiki-extensions-CentralAuth
From mediawiki.org
This page is a translated version of the page Extension:CentralAuth and the translation is 24% complete.
Outdated translations are marked like this.
Languages:
Довідка про розширення MediaWiki
CentralAuth
Статус релізу: стабільний
Реалізація Ідентифікація користувача , База даних , Спеціальна сторінка , API
Опис Дозволяє зливати облікові записи у глобальні облікові записи
Автор(и) Brooke Vibberобговорення
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki >= 1.43
Зміни в БД Так
Віртуальний домен virtual-centralauth
Таблиці globalnames
localnames
globaluser
localuser
global_user_groups
global_group_permissions
wikiset
global_group_restrictions
renameuser_status
renameuser_queue
users_to_rename
global_edit_count
global_user_autocreate_serial
Ліцензія GNU General Public License 2.0 or later
Завантажити
Download extension
Git [?]:
Параметри
  • $wgCentralAuthAutoLoginWikis
  • $wgCentralAuthCookiePath
  • $wgCentralAuthEnableSul3
  • $wgCentralAuthAutomaticVanishPerformer
  • $wgCentralAuthReadOnly
  • $wgCentralAuthIpoidRequestTimeoutSeconds
  • $wgCentralAuthAutoMigrate
  • $wgCentralAuthFallbackAppealUrl
  • $wgCentralAuthBlockAppealWikidataIds
  • $wgCentralAuthSharedDomainPrefix
  • $wgCentralAuthEnableGlobalRenameRequest
  • $wgCentralAuthRestrictSharedDomain
  • $wgCentralAuthIpoidCheckAtAccountCreation
  • $wgCentralAuthGlobalPasswordPolicies
  • $wgCentralAuthCookieDomain
  • $wgCentralAuthWikisPerSuppressJob
  • $wgCentralAuthFallbackAppealTitle
  • $wgCentralAuthCookies
  • $wgCentralAuthIpoidCheckAtAccountCreationLogOnly
  • $wgCentralAuthRC
  • $wgCentralAuthGlobalBlockInterwikiPrefix
  • $wgCentralAuthAutoMigrateNonGlobalAccounts
  • $wgCentralAuthDatabase
  • $wgCentralAuthDryRun
  • $wgCentralAuthIpoidUrl
  • $wgCentralAuthWikidataApiUrl
  • $wgCentralAuthPrefsForUIReload
  • $wgCentralAuthIpoidDenyAccountCreationTunnelTypes
  • $wgCentralAuthLoginIcon
  • $wgCentralAuthStrict
  • $wgCentralAuthTokenSessionTimeout
  • $wgCentralAuthLoginWiki
  • $wgCentralAuthIpoidDenyAccountCreationRiskTypes
  • $wgCentralAuthSessionCacheType
  • $wgGlobalRenameDenylist
  • $wgCentralAuthOldNameAntiSpoofWiki
  • $wgCentralAuthRejectVanishUserNotification
  • $wgCentralAuthAutoCreateWikis
  • $wgCentralAuthCookiePrefix
Нові права користувачів
  • centralauth-createlocal
  • centralauth-merge
  • centralauth-unmerge
  • centralauth-lock
  • centralauth-suppress
  • globalgrouppermissions
  • globalgroupmembership
  • centralauth-rename
Використані hook'и
Hooks provided
Quarterly downloads 47 (Ranked 93rd)
Translate the CentralAuth extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

CentralAuth allows merging several existing separate account systems into one global account system.

Увага Увага: CentralAuth проєктувався специфічно для проєктів Вікімедіа, які вже мали мільйони облікових записів і потребували їх злиття у глобальну таблицю.

Якщо ви починаєте нову вікі-ферму з нуля та не маєте потреби зливати наявні облікові записи у глобальну таблицю, то набагато простіше встановити глобальні облікові записи за допомогою $wgSharedDB , а не CentralAuth.[1][2]

Однак, $wgSharedDB корисний тільки для запобігання конфліктам створень облікових записів, і не має справу з будь-чим на кшталт входу в систему (натомість, від користувачів вимагається входити в кожну вікі) чи міжкластерних прав облікових записів й управління ними. Це розширення забезпечує згадану функціональність за рахунок складності.

If you end up using this extension on a third-party wiki, it is likely that you will end up having to troubleshoot complex issues that potentially require diving into the source code to resolve.

You have been warned.

Встановлення

Передумови використання CentralAuth див. у розділі встановлення нижче. Тоді слідуйте цими інструкціями, коли будете готові активувати CentralAuth:

  1. Install Extension:AntiSpoof , since it is a required dependency.
  2. # Завантажте останній зняток і розпакуйте його у свою директорію extensions.
  3. # Оберіть базу даних і створіть таблиці CentralAuth. Можна використати наявну базу даних або створити нову; розширення за замовчуванням використовує базу даних на ім'я $1 (див. нижче $2). (The extension by default uses the wiki's local database, which is convenient for automated testing but doesn't really make sense on a real wiki farm (as it will be different for every wiki, but the point of CentralAuth is sharing data between wikis) so you'll need to reconfigure that; see $wgVirtualDomainsMapping['virtual-centralauth'] below.) Використайте цю базу даних, потім виконайте tables-generated.sql.
    • Якщо ви використовуєте Extension:AntiSpoof , то вам потрібно створити глобальну таблицю spoofuser (для блокування нових імен користувачів, схожих на наявні в будь-якій вікі). Один зі способів зробити це — вивантажити таблицю spoofuser з бази даних локальної вікі й імпортувати її у нову $wgVirtualDomainsMapping['virtual-centralauth'].
  4. Додайте wfLoadExtension( 'CentralAuth' ); до LocalSettings.php для кожної своєї вікі, чи в інший файл PHP, який включено до LocalSettings.php кожної з ваших вікі.
  5. Тепер розширення повинно бути активним.

Create a new database

Тут приклад команд оболонки й SQL для створення бази даних centralauth, копіювання таблиці spoofuser і міграції наявних користувачів до неї. Замініть $wgDBname і $wgDBuser значеннями для інсталяції вашої власної вікі.

Створіть нову базу даних (пам'ятайте, що цей крок необов'язковий, можна натомість використати одну з наявних баз даних, у цьому випадку пропустіть до кроку створення таблиць): 

$ cd extensions/CentralAuth
$ mysql -u root -p
(enter password for root SQL user)

CREATE DATABASE centralauth;
USE centralauth;
GRANT all on centralauth.* to '$wgDBuser'@'localhost';
quit

Run maintenance scripts

Наступне припускає, що ваша теперішня робоча директорія є інсталяцією вашого MediaWiki (а не директорією CentralAuth). Створіть таблиці центральної авторизації (бажано з використанням sql.php . 

php maintenance/run.php sql --wikidb centralauth extensions/CentralAuth/schema/<db_type>/tables-generated.sql

Якщо інстальований AntiSpoof, то створіть таблицю через (Альтернативно, можете скопіювати наявну таблицю AntiSpoof, якщо бажаєте зберегти попередні записи): 

php maintenance/run.php sql --wikidb centralauth extensions/AntiSpoof/sql/<db_type>/tables-generated.sql

Виконайте сценарії міграції користувачів 

$ php maintenance/run.php CentralAuth:migratePass0.php
$ php maintenance/run.php CentralAuth:migratePass1.php

Upgrading

CentralAuth is designed for large wiki farms who run database updates manually in order to enable zero-downtime upgrades. For that reason, the CentralAuth database will not be updated with the usual upgrade process. Third-party users are expected to follow CentralAuth development and apply database migrations manually instead.

Встановлення

Увага Увага: Вимагається вікі центрального входу, якщо ви хочете універсальний вхід крізь різні первинні домени (тобто, якщо ваші вікі не під різними піддоменами того самого домену). Детальніше див. нижче.

Спершу, вам потрібно сконфігурувати свою вікі-родину, використовуючи $wgConf , або CentralAuth не зможе використовуватися для вашої вікі-родини. Це включає встановлення $wgLocalDatabases і присвоєння її $wgConf->wikis, та $wgConf->settings (мінімально $wgCanonicalServer , $wgServer і $wgArticlePath ). Обережно слідуйте прикладам. Якщо ви створюєте нову вікі-родину, то майте на увазі, що може бути легше, якщо бази даних для вікі в кожній групі матимуть той самий суфікс (наприклад, гіпотетичні бази даних enwiki, dewiki, frwiki тощо, що належать одній і тій самій групі, всі мають суфікс «wiki»).

Після інсталяції розширення, ви маєте зібрати деякі дані у базу даних CentralAuth. Задля ретроактивного встановлення глобальних облікових записів, ви матимете виконати сценарії migratePass0.php та migratePass1.php. Перший зберігає інформацію про ваші вікі у базі даних CentralAuth, а другий — використовує автоматичну евристику міграції для генерації глобальних облікових записів. Користувач може злити свої облікові записи вручну через Special:MergeAccount. Сухі запуски можуть бути використані з метою тестування.

Для увімкнення глобальних груп, ви матимете зробити запис у таблицю global_group_permissions своєї бази даних CentralAuth, з ggp_group='steward' та (для доступу до інтерфейсу керування групами) ggp_permission=globalgrouppermissions. Рекомендований до використання зразок запиту: 

INSERT INTO global_group_permissions (ggp_group,ggp_permission) VALUES ('steward','globalgrouppermissions'), ('steward','globalgroupmembership');

Then, promote some users into stewards: 

INSERT IGNORE INTO global_user_groups (gug_user, gug_group) VALUES ((SELECT gu_id FROM globaluser WHERE gu_name='Admin'), 'steward');

Є різні налаштування, які ви можете захотіти змінити (наприклад, чи забезпечувати єдиний вхід крізь увесь домен), перелічені на CentralAuth.php. Зокрема, ви можете захотіти перевизначити значення $wgVirtualDomainsMapping['virtual-centralauth'] за замовчування, що ваша база даних CentralAuth називається інакше, ніж $2. Переконайтеся, що ви помістили такі налаштування після рядка wfLoadExtension у LocalSettings.php, наприклад: 

wfLoadExtension( 'CentralAuth' );
$wgVirtualDomainsMapping['virtual-centralauth'] = [ 'db' => 'centralauth' ];

Поведінка «SUL2»

Увага Увага: As all logged in users will have a session in the central login wiki, you are recommended to set up a new wiki with as few extensions installed as possible (not using an existing wiki for this purpose). This will reduce the risk for XSS vulnerabilities.
Увага Увага: Universal sign-on may be broken in newer Google Chrome versions due to SameSite cookie policy. To fix it, you need to add: 
$wgCookieSameSite = "None";
$wgUseSameSiteLegacyCookies = true;

In addition, you must run your site under HTTPS.


In July 2013 WMF changed its approach to logging users into multiple wikis. When configured for this new approach, after successful login and account creation CentralAuth redirects to Special:CentralLogin/start?token=somevalue on a "central login wiki", which sets cookies on that wiki and then redirects back to the logged-into wiki. It omits the "login/account creation success" page, instead redirecting back to the "returnto" page that the user was originally on. It places 1x1 pixel images in the footer of that page, in place of the icons formerly used on the "login/account creation success" page.

The settings for this are, roughly, 

# General CentralAuth configuration
$wgCentralAuthCookies = true;
// default is to use the local wiki database
$wgVirtualDomainsMapping['virtual-centralauth'] = [ 'db' => 'centralauthDatabaseName' ];
$wgCentralAuthAutoMigrate = true;
$wgCentralAuthAutoLoginWikis = [
    # Mapping from domain name to wiki id for other wikis to automatically login into
    'enwiki.mediawiki.mwdd.localhost' => 'enwiki',
];

# Activates the redirect to the "central login wiki"
$wgCentralAuthLoginWiki = 'WikiIdOfLoginWiki';

$wgCentralAuthLoginWiki is the ID (usually the database-name) of the wiki to which CentralAuth will redirect on login and create account actions.

Проблеми кешування

For best results, it is recommended to use memcached or a more persistent cache. If you have only a single server, accelerator caches (CACHE_ACCEL) like APCu can also work, but do not use them if you have multiple servers. If you have no cache set up (i.e. CACHE_NONE) for $wgMainCacheType, or are using CACHE_DB, then you need to make sure all your wikis use the same caching table.

By default, each wiki in your wiki farm will use the objectcache table in its own database (with its own db prefix) when $wgMainCacheType is set to CACHE_NONE or CACHE_DB. To make this work with CentralAuth, we need to tell the wikis to use a central cache table.

If you want to make a central caching table in the centralauth database (and assuming one of your existing wikis has a database name of enwiki), run code like the following to copy the table to your other database (assuming you have an installed wiki with database called "enwiki" and another database called "centralauth"): 

CREATE TABLE centralauth.objectcache LIKE enwiki.objectcache

Then add the following config to all wikis to tell them to use the central table instead of their own table: 

$wgSharedDB = 'centralauth'; // or whatever database you use for central data
$wgSharedTables = [ 'objectcache' ]; // remember to copy the table structure's to the central database first
$wgCentralAuthSessionCacheType = CACHE_DB; // Tell mediawiki to use objectcache database for central auth.

When running PHPUnit tests locally with your wiki farm and do not want them to fail due to an attempt to clone database tables with the shared tables config above, use: 

if ( defined( 'MW_PHPUNIT_TEST' ) ) {
	$wgSharedTables = [];
} else {
	$wgSharedTables = [ 'objectcache' ];
}

HTTP and HTTPS

Since 2023, CentralAuth does not support mixed-protocol HTTP/HTTPS wikis, only pure-HTTPS wikis (with $wgForceHTTPS set to true) and pure-HTTP wikis (primarily for local testing). See issue T348852.

Конфігурація

Database Virtual Domains Mapping

Since MediaWiki 1.41, you can configure database virtual domains mapping for CentralAuth, and this replaced $wgCentralAuthDatabase. To setup virtual domains mapping with CentralAuth, use: 

// 'centralauth' is the name of the your CentralAuth database.
$wgVirtualDomainsMapping['virtual-centralauth'] = [ 'db' => 'centralauth' ];
Налаштування конфігурації в Extension.json Config section
параметр за замовчуванням коментар
(deprecated) $wgCentralAuthDatabase null Database name you keep central auth data in.

If this is not on the primary database connection, don't forget to also set up $wgDBservers to have an entry with a groupLoads setting for the 'CentralAuth' group. Alternatively you can use $wgLBFactoryConf to set up an LBFactoryMulti object.

To use a database with a table prefix, set this variable to "{$database}-{$prefix}".

NOTE: This setting has been deprecated, use virtual domains mapping as described above.

$wgCentralAuthAutoMigrate false If true, existing unattached accounts will be automatically migrated if possible at first login.

Any new account creations will be required to attach.

If false, unattached accounts will not be harassed unless the individual account has opted in to migration.

$wgCentralAuthAutoMigrateNonGlobalAccounts false If true, existing unattached accounts where no global account exists will be compared to see if a merge can be made based on passwords and emails with no clashes (all accounts merge).

This was formerly controlled by $wgCentralAuthAutoMigrate

$wgCentralAuthStrict false If true, remaining accounts which have not been attached will be forbidden from logging in until they are resolved.
$wgCentralAuthDryRun false If true, merging won't actually be possible through the Special:MergeAccount interface.
$wgCentralAuthCookies false If true, global session and token cookies will be set alongside the per-wiki session and login tokens when users log in with a global account.

This allows other wikis on the same domain to transparently log them in.

$wgCentralAuthLoginWiki false Database name of a central login wiki. This is an alternative to directly setting cross-domain cookies for each wiki in $wgCentralAuthAutoLoginWikis. If set, a single login wiki will use a session/cookie to handle unified login sessions across wikis.

On login, users will be redirected to the login wiki's Special:CentralLogin/login page and then redirected to Special:CentralLogin back on the originating wiki. In the process, the central login wiki cookie and session will be set. As the user accesses other wikis, the login wiki will be checked via JavaScript to check login status and set the local session and cookies.

This requires $wgCentralAuthCookies.

$wgCentralAuthCookieDomain '' Domain to set global cookies for.

For instance, '.wikipedia.org' to work on all wikipedia.org subdomains instead of just the current one. Leave blank to set the cookie for the current domain only, such as if all your wikis are hosted on the same subdomain.

$wgCentralAuthCookiePrefix 'centralauth_' Prefix for CentralAuth global authentication cookies.
$wgCentralAuthCookiePath '/' Path for CentralAuth global authentication cookies. Set this variable if you want to restrict cookies to a certain path within the domain specified by $wgCentralAuthCookieDomain.
$wgCentralAuthAutoLoginWikis [] List of wiki IDs which should be called on login to try to set third-party cookies for the global session state.

The wiki ID is typically the database name, except when table prefixes are used, in which case it is the database name, a hyphen separator, and then the table prefix.

This allows a farm with multiple second-level domains to set up a global session on all of them by hitting one wiki from each domain (en.wikipedia.org, en.wikinews.org, etc.).

Done by accessing Special:CentralAutoLogin/start on each wiki.

If empty, no other wikis will be hit.

The key should be set to the cookie domain name.

$wgCentralAuthAutoCreateWikis [] List of wiki IDs on which an attached local account should be created automatically when the global account is created.

The wiki ID is typically the database name, except when table prefixes are used, in which case it is the database name, a hyphen separator, and then the table prefix.

$wgCentralAuthLoginIcon false Local filesystem path to the icon returned by Special:CentralAutoLogin should be a 20x20px PNG.
$wgCentralAuthPrefsForUIReload [ 'skin', 'language', 'thumbsize', 'underline', 'stubthreshold', 'showhiddencats', 'justify', 'numberheadings', 'editondblclick', 'editsection', 'editsectiononrightclick', 'usenewrc', 'extendwatchlist' ] User preferences for which we should recommend reloading the page after a successful central login query.

If you need to do something more complicated than just $userOptionsLookup->getOption( $user, $pref ) !== $userOptionsLookup->getDefaultOption( $pref ), use the hook CentralAuthIsUIReloadRecommended.

$wgCentralAuthRC [] Array of settings for sending the CentralAuth events to the RC Feeds.

@example $wgRCFeeds['example'] = [ 'uri' => "udp://localhost:1336" ];

$wgCentralAuthWikisPerSuppressJob 10 Size of wikis handled in one suppress user job. Keep in mind that one wiki requires ~10 queries.
$wgCentralAuthReadOnly false Like $wgReadOnly, used to set extension to database read only mode.

@var bool

$wgCentralAuthEnableGlobalRenameRequest false Feature flag for Special:GlobalRenameRequest.

@var bool

$wgCentralAuthGlobalPasswordPolicies [] Global password policies. These are applied like local password policies, the strongest policy applicable to a user is used. Policies can apply to either a local group (if the user is a member of that group on any wiki, the policy will apply to that user) or global group.

@var array

$wgGlobalRenameDenylist null A list of users who won't be allowed to create new global rename requests through Special:GlobalRenameRequest.

There are two ways to set it:

  • Using a wiki-page: use a Title object to have a wiki-page (MediaWiki:GlobalRenameDenylist for example) as the banned-list. The wiki-page must be a list with one item per line, and must exist otherwise Special:GlobalRenameRequest will throw a MWException.
    Example: $wgGlobalRenameDenylist = Title::makeTitle( NS_MEDIAWIKI, 'GlobalRenameDenylist' );.
  • Using a URL: put a complete URL which must return, using HTTP, a plain-text list of the banned users (and nothing else).
    For example, with a URL pointing to a wiki page: $wgGlobalRenameDenylist = "https://yourwiki/yourpath/index.php?title=MediaWiki:GlobalRenameDenylist&action=raw";

You can use the exact names or regular expressions.

@var Title|string|null

$wgCentralAuthGlobalBlockInterwikiPrefix "global" When globally suppressing a user, a block against this user is inserted in all wikis. CentralAuth will set the author of theses blocks as $wgCentralAuthGlobalBlockInterwikiPrefix>(user-who-made-the-suppression's nickname). For example, if $wgCentralAuthGlobalBlockInterwikiPrefix = "Admins";, and Joe suppresses John, all wikis will show in BlockList a block against John made by Admins>Joe.

@var string

Використання

Allows for a single-user login (SUL) system using MediaWiki's AuthPlugin system. User creation and login is done globally using one central user table across all wikis. Note that local user accounts are automatically created on account creation/login however.

This extension also implements global user groups, to which global accounts can belong to.

Права користувачів

CentralAuth defines several new user rights:

User right Abilities Default group Status
centralauth-createlocal Forcibly create a local account for a global account Stewards and sysops Active in MW 1.36+
centralauth-lock Prevent users from logging in on any wiki Stewards Active
centralauth-suppress Suppress or unhide global accounts Stewards Active
centralauth-rename Rename global accounts Stewards Active
centralauth-unmerge Unmerge global accounts from a local account Stewards Active
centralauth-merge Merge all CentralAuth accounts globally All users Active; usually automatic
globalgrouppermissions Manage permissions of global groups Global Stewards Active; not assigned to local stewards by default
globalgroupmembership Edit membership to global groups Global Stewards Active; not assigned to local stewards by default

Функції

Single-user login (SUL)

A user with an account on more than one wiki may use Special:MergeAccount to create their global user account, which can then be used on any wiki. Users with the centralauth-unmerge permission (given to stewards by default) can undo a merging of a global account, where the passwords are all reset back to the pre-merge setting. User accounts can now also be renamed globally.

Блокування та приховання глобальних користувачів

Screenshot of Special:CentralAuth interface on Meta-Wiki, showing lock/hide interface.

A global account can be locked or hidden by a user with the centralauth-lock and centralauth-suppress permissions, respectively, given to the local group 'stewards' by default. A locked global account will be immediately logged out of any session on any wiki it is currently logged in to. A hidden global account's username is not visible in any logs except the global account log.

Налаштування вікі

A wiki set is a group of wikis specified by a user with the globalgrouppermissions right. Sets can be opt-in (wikis are not in it by default) or opt-out (wikis are in it unless opted out).

Глобальні групи користувачів

Once you have enabled global user groups as described in the installation section, a migrated steward can use the Special:GlobalGroupPermissions interface to configure global user groups, and their rights. A global user group is active on all wikis (the users in it have its rights on all the wikis) by default, unless the group has been specified to only be active on a specific wiki set (the users in the group only have the rights if they are on a wiki in the set). Global group permissions are not listed at Special:ListUsers, but instead Special:GlobalUsers. They are assigned by a user with the globalgroupmembership permission (by default the global group stewards), and give the specified rights to the user even if the local rights defined by $wgGroupPermissions do not do so.

Ліцензування та завантаження

The extension is available under the GNU General Public License 2.0 or later, and can be downloaded from Git, or accessed via the web-based viewer.

The software is provided as-is. Updates will be made according to the needs of Wikimedia wikis; or where critical vulnerabilities are discovered.

API

Див. Extension:CentralAuth/API .

Посилання

  1. ↑ [Mediawiki-l] CentralAuth problems: Help required
  2. ↑ [Mediawiki-l] Need help with CentralAuth

Див. також

Retrieved from "https://www.mediawiki.org/w/index.php?title=Extension:CentralAuth/uk&oldid=6769360"