확장기능:OAuth

**미디어위키 확장 기능 설명서**
OAuth; 출시 상태: 안정
구현	사용자 식별, 사용자 권한, API
설명	사용자들은 미디어위키 API를 사용하는 다른 프로그램(이하 사용자)에서 안전하게 인증할 수 있습니다.
만든 이	Aaron Schulz, Chris Steipp, Brad Jorsch, Robert Vogel, Dejan Savuljesku
최신 버전	1.1.0 (continuous updates)
호환성 정책	스냅샷은 미디어위키와 함께 릴리스됩니다. Master is not backward compatible.
데이터베이스 변경	예
가상 도메인	virtual-oauth
	테이블 oauth_accepted_consumer; ; oauth_registered_consumer; ; oauth2_access_tokens;
	변수 $wgOAuth2PublicKey; $wgMWOAuthCentralWiki; $wgOAuth2Passphrase; $wgMWOAuthSecureTokenTransfer; $wgMWOAuthSharedUserSource; $wgOAuth2GrantExpirationInterval; $wgOAuthStaticApps; $wgOAuthAutoApprove; $wgMWOauthDisabledApiModules; $wgOAuth2EnabledGrantTypes; $wgOAuthAllowInsecurePlaintextSignature; $wgMWOAuthNonceCacheType; $wgOAuthGroupsToNotify; $wgMWOAuthRequestExpirationAge; $wgOAuthUseJwtCookie; $wgOAuth2RefreshTokenGracePeriod; $wgOAuth2RefreshTokenTTL; $wgMWOAuthSessionCacheType; $wgMWOAuthReadOnly; $wgOAuth2PrivateKey; $wgMWOAuthSharedUserIDs; $wgOAuthSecretKey;
	추가되는 권한 mwoauthproposeconsumer; mwoauthupdateownconsumer; mwoauthmanageconsumer; mwoauthsuppress; mwoauthviewsuppressed; mwoauthviewprivate; mwoauthmanagemygrants;
	사용된 훅 AbuseFilter-builder; AbuseFilter-computeVariable; AbuseFilter-generateUserVars; ApiRsdServiceApis; BeforeCreateEchoEvent; ChangeTagCanCreate; ChangeTagsListActive; GetPreferences; ListDefinedTags; LoadExtensionSchemaUpdates; LoginFormValidErrorMessages; MediaWikiServices; MergeAccountFromTo; MessagesPreLoad; SetupAfterCache; SpecialPageAfterExecute; SpecialPageBeforeFormDisplay; TestCanonicalRedirect;
	훅 제공 OAuthClaimStoreGetClaims; OAuthReplaceMessage;
Licence	GNU General Public License 2.0 or later
다운로드	확장 기능 다운로드 ; Git [?]: 저장소 보기 (Phabricator · GitHub); Gerrit 코드 리뷰; Git 커밋 기록; Download source tarball;
도움말	도움말:OAuth
	OAuth 확장 기능 번역 (translatewiki.net에서 가능한 경우)
Vagrant 역할	oauth
이슈	미해결 작업 · 버그 보고

This page is a translated version of the page Extension:OAuth and the translation is 1% complete.

The OAuth extension implements an OAuth server in MediaWiki that supports both the OAuth 1.0a and OAuth 2.0 protocol versions. It allows third party developers to securely develop applications ("consumers"), to which users can give a limited set of permissions ("grants"), so that the application can use the MediaWiki API on the user's behalf.

If you're attempting to develop an application that uses OAuth on a wiki, see OAuth for Developers. If you are trying to use an OAuth-enabled tool on a wiki which has this extension installed, see OAuth.

Supported specifications
Area	RFC
OAuth 1.0a	RFC 5849
OAuth 2.0 framework	RFC 6749
OAuth 2.0 Authorization Code grant	RFC 6749 section 4.1
OAuth 2.0 Refresh Token grant	RFC 6749 section 6
OAuth 2.0 Client Credentials grant	RFC 6749 section 4.4
PKCE for auth-code flow	RFC 7636

Requirements

OAuth relies on the object cache for temporary tokens and sessions. This should work as long as cache configuration settings are sane. (Older versions required Memcached explicitly.)
Currently, only MySQL and SQLite database backends are supported
If the MediaWiki installation is private (i.e. users need to log in to have read access), Special:OAuth will need to be added to the white list.

Installation

파일을 다운로드하고 OAuth 폴더를 extensions/ 디렉토리에 넣어 주세요.
개발자와 코딩 기여자는 Git을 이용해 확장기능을 다운받는 것이 좋습니다.
```
cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/OAuth
```
Git에서 설치할 경우, PHP 의존 기능을 설치하려면 Composer를 실행하여 확장 기능 디렉터리에 composer install --no-dev를 발행하십시오. (잠재적인 문제에 대해서는 T173141 을 참고하십시오.)
아래의 코드를 LocalSettings.php 코드의 마지막에 추가합니다.
```
wfLoadExtension( 'OAuth' );
```
갱신 스크립트를 실행합니다. 이 스크립트는 이 확장기능을 필요로 하는 데이터 베이스 테이블을 자동적으로 작성합니다.
Configure the general parameters as required.
- OAuth2 will not be enabled if you leave all settings at their defaults.
Configure the user rights by putting them into the relevant groups in $wgGroupPermissions.
완료 – 위키의 ‘Special:Version’에 이동해서, 확장기능이 올바르게 설치된 것을 확인합니다.

Vagrant 설치:

Vagrant 를 사용하고 있는 경우에는, vagrant roles enable oauth --provision로 설치해주세요

To assign a permission to some group, for example to sysops, you add following line to LocalSettings.php:

$wgGroupPermissions['sysop']['mwoauthproposeconsumer'] = true;

Database virtual domains mapping

Since MediaWiki 1.45, it's recommended to configure database virtual domains mapping for OAuth, see this patch. $wgMWOAuthCentralWiki and virtual domains are separate settings.

To set up virtual domains mapping with OAuth, use:

$wgMWOAuthCentralWiki = '<central-wiki>';
$wgVirtualDomainsMapping['virtual-oauth'] = [ 'db' => '<oauth-db>' ];

Configuration

Parameters

Variable name	Default value	Description
`$wgMWOAuthCentralWiki`	`false`	Wiki ID of OAuth management wiki. On wiki farms, it makes sense to set this to a wiki that acts as a portal site, is dedicated to management, or just handles login/authentication. It can, however, be set to any wiki in the farm. For single-wiki sites or farms where each wiki manages consumers separately, it should be left as `false`.
`$wgMWOAuthSharedUserIDs`	`false`	(구식화됨) Use `$wgMWOAuthSharedUserSource` instead Whether shared global user IDs are stored in the oauth tables. On wiki farms with a central authentication system (with integer user IDs) that share a single OAuth management wiki, this must be set to `true`. If wikis have a central authentication system but have their own OAuth management, then this can be either `true` or `false`. Otherwise it should always be set to `false`. Setting this to `true` requires CentralIdLookup or an MWOAuth aware authentication extension. This value should not be changed after the fact to avoid ambigious IDs. Proper user ID migration should be done before any such changes.
`$wgMWOAuthSharedUserSource`	`null`	Central ID provider when sharing OAuth credentials over a wiki farm Source of shared user IDs, if enabled. If CentralIdLookup is available, this is the `$providerId` for `CentralIdLookup::factory()`. Generally null would be what you want, to use the default provider. If that class is not available or the named provider is not found, this is passed to the `OAuthGetUserNamesFromCentralIds`, `OAuthGetLocalUserFromCentralId`, `OAuthGetCentralIdFromLocalUser`, `OAuthGetCentralIdFromUserName` hooks. This has no effect if `$wgMWOAuthSharedUserIDs` is set to `false`.
`$wgMWOAuthRequestExpirationAge`	`2,592,000` (30 days)	Seconds after which an idle request for a new Consumer is marked as "expired"
`$wgMWOAuthSecureTokenTransfer`	`true`	Require SSL/TLS for returning Consumer and user secrets. This is required by RFC 5849, however if a wiki wants to use OAuth, but doesn't support SSL, this option makes this configuration possible. 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 various temporary data (although not actual session data). One of the cache types defined via `$wgObjectCaches` . If `null`, it defaults to `$wgSessionCacheType` .
`$wgMWOAuthNonceCacheType`	`$wgMWOAuthSessionCacheType`	The storage mechanism for OAuth 1.0 nonces.
`$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.
`$wgOAuth2Passphrase`	`""`	Passphrase to use, when the private key is encrypted.
`$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 `$wgMWOAuthSessionCacheType`). 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 `$wgMWOAuthSessionCacheType`). Accepts ISO 8601 durations or can be set to `infinity` or `false` for non-expiring tokens.

User rights

Right	Description
`mwoauthproposeconsumer`	새 OAuth 컨슈머 제안
`mwoauthupdateownconsumer`	내가 제어할 수 있는 OAuth 컨슈머 업데이트
`mwoauthmanageconsumer`	OAuth 컨슈머 관리
`mwoauthsuppress`	OAuth 컨슈머 비표시
`mwoauthviewsuppressed`	표시하지 않은 OAuth 컨슈머 보기
`mwoauthviewprivate`	비공개 OAuth 데이터 보기
`mwoauthmanagemygrants`	OAuth 부여 관리

Endpoints

The following REST endpoints are provided for OAuth 2.0 interaction

Get authorization code

Used for retrieving authorization code when using authorization_code grant.

Path: /oauth2/authorize
Allowed method: GET
Allowed parameters

Name	Required?	Description
response_type	예
client_id	예
redirect_uri	아니요	if present, must match the URI that was set when client was registered exactly
scope	아니요
state	아니요
code_challenge	아니요	required if `$wgOAuth2RequireCodeChallengeForPublicClients` is `true`
code_challenge_method	아니요	required if `$wgOAuth2RequireCodeChallengeForPublicClients` is `true`

Get access token

Used for requesting access tokens

Path: /oauth2/access_token
Allowed method: POST
Allowed parameters

Name	Required?	Description
grant_type	예	type of grant used
client_id	아니요
client_secret	아니요	required if client is `confidential`
redirect_uri	아니요	if present, must match the URI that was set when client was registered exactly
scope	아니요
code	아니요	required if `authorization_code` grant is used
refresh_token	아니요	required if `refresh_token` grant is used
code_verifier	아니요

Get user or client information

Used for retrieving protected resources using the access token issued previously.

Currently, two resource types can be retrieved using this endpoint, by replacing {{type}} placeholder with the type key:

profile - retrieve the user profile of the user that is represented by the access token used to make the request - usually used for logging users in on 3rd party websites using MediaWiki
scopes - retrieve all scopes client (application) is allowed to use with the current access token

Path: /oauth2/resource/{{type}}
Allowed method: GET; POST
Allowed parameters: No parameters are allowed, apart from the {{type}} parameter that is included in the path

List clients

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.

Path: /oauth2/client
Allowed method: GET
Allowed parameters

Name	Required?	Description	Default
`oauth_version`	Optional	either 1 (to return only OAuth 1.0a clients) or 2 (to return only OAuth 2.0 clients).	2

Pagination parameters

Name	Required?	Description	Default
`limit`	Optional	maximum number of clients to return.	25
`offset`	Optional	number of clients to skip before returning the first result.	0

Response example

{
  "clients": [
    {
      "client_key": "xxxxxxxxxxxxxx",
      "name": "TestFromCurl1807",
      "version": "2.0",
      "email": "admin@example.com",
      "callback_url": "http://example.com",
      "scopes": [
        "authonly"
      ],
      "registration": "20200818230806",
      "stage": 0,
      "oauth_version": 2,
      "description": "foo",
      "allowed_grants": [
        "authorization_code"
      ],
      "registration_formatted": "23:08, 18 August 2020"
    }
  ],
  "total": 1
}

Reset client secret

Resets a client secret. For owner-only clients, this endpoint also resets the access token.

Path: /oauth2/client/{client_key}/reset_secret
Allowed method: POST
Allowed parameters

Name	Required?	Description	Default
`client_key`	Required		client identifier
`reason`	Optional	string containing the reason for resetting the secret.	`''`

Response example
{ "name": "Example", "client_key": "xxxxxxxxxx", "secret": "xxxxxxxxxx", "access_token": "xxxxxxxxxx" }

Create OAuth 2.0 client

Creates an OAuth 2.0 client.

Path: /oauth2/client
Allowed method: POST
Allowed parameters

Name	Required?	Description	Default
`name`	Required	client name
`description`	Required	client description
`email`	Required	contact email
`is_confidential`	Required	set to `true` if the client is confidential; set to `false` for public clients like mobile and desktop apps
`grant_types`	Required	OAuth 2.0 grant types used by the client, one or more of the following: `authorization_code`, `refresh_token`, `client_credentials`
`scopes`	Required	OAuth 2.0 scopes, either `mwoauth-authonly`, `mwoauth-authonlyprivate` or the set of applicable grants
`version`	Optional	client version.	1.0
`wiki`	Optional	applicable project.	* for all wikis
`owner_only`	?	set to `true` for a client used only by the creating user
`callback_url`	Optional	Return URL for authorizing users.	`''`
`callback_is_prefix`	Optional	set to `true` to allow the client to specify a callback in requests and use the callback URL as a required prefix.	`false`

Response example
{ "name": "Example", "client_key": "xxxxxxxxxx", "secret": "xxxxxxxxxx", "access_token": "xxxxxxxxxx" }

If OAuth credentials are shared over a wiki farm, make sure that real names are used/hidden consistently across all wikis (using $wgHiddenPrefs). On wikis where real names are hidden, the OAuth permission request message that tells the user which information is shared does not mention the real name, so in that case there should not be any other wiki where the OAuth consumer may still get that information from.