Расширение:OAuth
OAuth Статус релиза: стабильно |
|
---|---|
Реализация | Идентификация пользователя , Права пользователя , API |
Описание | Позволяет пользователям безопасно разрешать другому приложению («потребителю») использовать API действий MediaWiki от их имени. |
Автор(ы) | Aaron Schulz, Chris Steipp, Brad Jorsch, Robert Vogel, Dejan Savuljesku |
Последняя версия | 1.1.0 (continuous updates) |
Политика совместимости | Снэпшоты выходят вместе с MediaWiki. Мастер не имеет обратной совместимости. |
MediaWiki | >= 1.43 |
Изменения в БД | Да |
Таблицы | oauth_accepted_consumer oauth_registered_consumer |
Лицензия | GNU General Public License 2.0 или позднее |
Скачать | |
Помощь | Справка:OAuth |
|
|
|
|
|
|
Ежеквартальные загрузки | 86 (Ranked 61st) |
Использование общедоступными вики | 982 (Ranked 246th) |
Переведите расширение OAuth, если оно доступно на translatewiki.net | |
Роль Vagrant | oauth |
Проблемы | Открытые задачи · Сообщить об ошибке |
Расширение OAuth реализует сервер OAuth в MediaWiki, который поддерживает версии протокола OAuth 1.0a и OAuth 2.0. Это позволяет сторонним разработчикам безопасно разрабатывать приложения («потребителей»), которым пользователи могут предоставлять ограниченный набор разрешений («гранты»), чтобы приложение могло использовать API действий MediaWiki от имени пользователя.
Требования
- OAuth использует кеш объектов для временных токенов и сеансов. Это должно работать до тех пор, пока параметры конфигурации кэша в порядке. (Older versions required Memcached explicitly.)
- В настоящее время поддерживаются только серверные части баз данных MySQL и SQLite.
- Если установка MediaWiki является закрытой (т. е. пользователям необходимо войти в систему, чтобы получить доступ для чтения), Special:OAuth нужно будет добавить в белый список.
Установка
- Скачайте и распакуйте файл(ы) в папку с названием
OAuth
в вашей папкеextensions/
.
Вместо этого разработчикам и соавторам кода следует установить расширение из Git, используя:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/OAuth - Если и только если устанавливаете из git, запустите Composer для установки зависимостей PHP, запустив
composer install --no-dev
в каталоге расширений. (Смотрите задача T173141 о возможных осложнениях.) - Добавьте следующий код в конце вашего файла LocalSettings.php :
wfLoadExtension( 'OAuth' );
- Выполните скрипт обновления, который автоматически создаст необходимые таблицы, используемые расширением.
- При необходимости настройте общие параметры.
- Настройте права пользователя, поместив их в соответствующие группы в
$wgGroupPermissions
. - Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.
Установка Vagrant:
- Если вы используете Vagrant , установите с помощью
vagrant roles enable oauth --provision
Чтобы назначить разрешение какой-либо группе, например системным операторам, вы добавляете следующую строку в LocalSettings.php
:
$wgGroupPermissions['sysop']['mwoauthproposeconsumer'] = true;
Настройка
Parameters
Название переменной | Значение по умолчанию | Описание |
---|---|---|
$wgMWOAuthCentralWiki
|
false
|
Wiki ID для управления вики через OAuth. Имеет смысл установить это значение для вики, которая действует как сайт-портал, предназначенный для управления или просто обрабатывает вход/аутентификацию. Тем не менее, его можно установить для любой вики в отдельности. Для сайтов с одной вики или группы, где каждая вики управляет "потребителями" отдельно, следует оставить значение false .
|
$wgMWOAuthSharedUserIDs
|
false
|
(устарело) Используйте $wgMWOAuthSharedUserSource вместо этого
Который сохраняет общие глобальные идентификаторы пользователей в таблицах OAuth.
На вики кластерах с центральной системой аутентификации (с целочисленными идентификаторами пользователей), которые совместно используют одну вики управления OAuth, для этого параметра должно быть установлено значение true.
Если у вики есть центральная система аутентификации, но собственное управление OAuth, то этот параметр может быть либо |
$wgMWOAuthSharedUserSource
|
null
|
Поставщик центральной идентификации при совместном использовании учетных данных OAuth через вики-кластер
Источник общих идентификаторов пользователей, если он включен. Если доступен CentralIdLookup, это $providerId для CentralIdLookup::factory(). Как правило, нуль/null, если вы хотите, чтобы использовать поставщика услуг индентификации по умолчанию. Если этот класс недоступен или именованный провайдер не найден, то передается в OAuthGetUserNamesFromCentralIds, OAuthGetLocalUserFromCentralId, OAuthGetCentralIdFromLocalUser, OAuthGetCentralIdFromUserName. Это не действует, если для $wgMWOAuthSharedUserIDs установлено значение false. |
$wgMWOAuthRequestExpirationAge
|
2 592 000 (30 days)
|
Секунды, после которых бездействующий запрос нового потребителя помечается как «истекший». |
$wgMWOAuthSecureTokenTransfer
|
true
|
Требовать SSL/TLS для возврата потребительских и пользовательских секретны кодов. Это требуется для RFC 5849, однако, если вики хочет использовать OAuth, но не поддерживает SSL, эта опция делает эту настройку возможной. This should be set to true for most production settings. |
$wgOAuthSecretKey
|
$wgSecretKey
|
A secret configuration string (random 32-bit string generated using "base64_encode(random_bytes(32))") used to hmac the database-stored secret to produce the shared secrets for Consumers. This provides some protection against an attacker reading the values out of the consumer table (the attacker would also need $wgOAuthSecretKey to generate valid secrets), and some protection against potential weaknesses in the secret generation. If this string is compromised, the site should generate a new $wgOAuthSecretKey, which will invalidate Consumer authorizations that use HMAC/shared secret signatures instead of public/private keys. Consumers can regenerate their new shared secret by using the "Reset the secret key to a new value" option under Special:MWOAuthConsumerRegistration/update. If null, the value is set to $wgSecretKey. |
$wgOAuthGroupsToNotify
|
[]
|
The list of user groups which should be notified about new consumer proposals. Setting this will only have an effect when Echo is installed. |
$wgMWOauthDisabledApiModules
|
[]
|
List of API module classes to disable when OAuth is used for the request |
$wgMWOAuthReadOnly
|
false
|
Prevent write activity to the database. When this is set, consumers cannot be added or updated, and new authorizations are prohibited. Authorization headers for existing authorizations will continue to work. Useful for migrating database tables |
$wgMWOAuthSessionCacheType
|
$wgSessionCacheType
|
The storage mechanism for session data. If null, it defaults to $wgSessionCacheType. |
$wgOAuthAutoApprove
|
[]
|
Allows automatic immediate approval of low-risk apps. In the form of [ 'grants' => [ 'grant1', 'grant2', ... ] ]
|
$wgOAuth2EnabledGrantTypes
|
[
"authorization_code",
"refresh_token",
"client_credentials"
]
|
List of OAuth2 grants that client applications can be allowed to use. Actual grants client application will be allowed to use can be any subset of grants listed here. Grants, other than the ones listed here, are considered legacy grants, and are not supported by this extension |
$wgOAuth2PrivateKey
|
""
|
Private key or a path to the private key used to sign OAuth2 JWT being transmitted. See the OAuth 2.0 Server documentation for how to generate the keys. |
$wgOAuth2PublicKey
|
""
|
Public key or a path to the public key used to verify OAuth2 resource requests. |
$wgOAuth2RequireCodeChallengeForPublicClients
|
true
|
Controls whether clients are required to send code challenges with OAuth2 requests. This only applies to non-confidential clients. |
$wgOAuth2GrantExpirationInterval
|
"PT1H" (1 hour)
|
Controls validity period for access tokens (stored in the cache configured in MWOAuthSessionCacheType). Does not apply to owner-only clients, whose access tokens are always non-expiring. Accepts ISO 8601 durations or can be set to "infinity" or false for non-expiring tokens. |
$wgOAuth2RefreshTokenTTL
|
"P1M" (1 month)
|
Controls validity period for refresh tokens (stored in the cache configured in MWOAuthSessionCacheType). Accepts ISO 8601 durations or can be set to "infinity" or false for non-expiring tokens. |
Права участников
Право | Описание |
---|---|
mwoauthproposeconsumer |
Предложение новых клиентов OAuth |
mwoauthupdateownconsumer |
Обновление контролируемых клиентов OAuth |
mwoauthmanageconsumer |
Управление клиентами OAuth |
mwoauthsuppress |
Сокрытие клиентов OAuth |
mwoauthviewsuppressed |
Просмотр скрытых клиентов OAuth |
mwoauthviewprivate |
Просмотр персональных данных OAuth |
mwoauthmanagemygrants |
Управление разрешениями OAuth |
Endpoints
OAuth 2.0 REST endpoints
The following REST endpoints are provided for OAuth 2.0 interaction
Path | Описание | Допустимые параметры | Допустимый метод | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
/oauth2/authorize | Used for retrieving authorization code when using authorization_code grant. |
|
GET | ||||||||||||||||||||||||||||||||||||||||||||||||||
/oauth2/access_token | Used for requesting access tokens |
|
POST | ||||||||||||||||||||||||||||||||||||||||||||||||||
/oauth2/resource/{{type}} | Used for retrieving protected resources using the access token issued previously.
Currently, two resource types can be retrieved using this endpoint, by replacing
|
No parameters are allowed, apart from the {{type}} parameter that is included in the path
|
GET/POST | ||||||||||||||||||||||||||||||||||||||||||||||||||
/oauth2/client | Lists OAuth 1.0a or 2.0 clients for the logged-in user. Authentication can be achieved over CentralAuth or by including an access token in the authorization header.
|
|
GET | ||||||||||||||||||||||||||||||||||||||||||||||||||
/oauth2/client/{client_key}/reset_secret | Resets a client secret. For owner-only clients, this endpoint also resets the access token.
|
|
POST | ||||||||||||||||||||||||||||||||||||||||||||||||||
/oauth2/client | Creates an OAuth 2.0 client.
|
|
POST |
См. также
- Расширение:OATHAuth - A similarly named extension which implements a second authentication factor using OATH-based one-time passwords.
- Extension:WSOAuth – A MediaWiki extension that lets your wiki delegate authentication to any OAuth provider using PluggableAuth, including a wiki that is running Extension:OAuth.
- oauthclient-php – A client library for OAuth consumers.
Это расширение используется в одном или нескольких проектах Викимедиа. Вероятно, это означает, что расширение стабильно и работает достаточно хорошо, чтобы использоваться такими сайтами с высоким трафиком. Найдите название этого расширения в файлах конфигурации Викимедиа CommonSettings.php и InitialiseSettings.php, чтобы узнать, где оно установлено. Полный список расширений, установленных на конкретной вики, можно увидеть на странице Special:Version wiki. |
Это расширение включено в следующие вики-фермы/хостинги и/или пакеты: Это не исчерпывающий список. Некоторые вики-фермы/хостинги и/или пакеты могут содержать это расширение, даже если они не перечислены здесь. Всегда сверяйтесь со своими вики-фермами/хостингами или комплектами/бандлами для подтверждения. |