Jump to content

Extension:OAuth/pl

Issue tracker: #MediaWiki-extensions-OAuth
From mediawiki.org
This page is a translated version of the page Extension:OAuth and the translation is 15% complete.
Languages:
Nie mylić z: Extension:OATHAuth, Extension:WSOAuth.
Podręcznik rozszerzeń MediaWiki
OAuth
Status wydania: stabilne
Realizacja Tożsamość użytkownika , Uprawnienia użytkownika , API
Opis Allow users to safely authorize another application ("consumer") to use the MediaWiki API on their behalf.
Autor(zy) Aaron Schulz, Chris Steipp, Brad Jorsch, Robert Vogel, Dejan Savuljesku
Ostatnia wersja 1.1.0 (continuous updates)
Polityka zgodności Snapshots releases along with MediaWiki. Master nie jest kompatybilny wstecznie.
Zmiany w bazie danych Tak
Domena wirtualna virtual-oauth
Tabele
Parametry
  • $wgOAuth2PublicKey
  • $wgOAuth2RequireCodeChallengeForPublicClients
  • $wgMWOAuthCentralWiki
  • $wgOAuth2Passphrase
  • $wgMWOAuthSecureTokenTransfer
  • $wgMWOAuthSharedUserSource
  • $wgOAuth2GrantExpirationInterval
  • $wgOAuthAutoApprove
  • $wgMWOauthDisabledApiModules
  • $wgOAuth2EnabledGrantTypes
  • $wgMWOAuthNonceCacheType
  • $wgOAuthGroupsToNotify
  • $wgMWOAuthRequestExpirationAge
  • $wgOAuthUseJwtCookie
  • $wgOAuth2RefreshTokenTTL
  • $wgMWOAuthSessionCacheType
  • $wgMWOAuthReadOnly
  • $wgOAuth2PrivateKey
  • $wgMWOAuthSharedUserIDs
  • $wgOAuthSecretKey
Dodawane uprawnienia

  • mwoauthproposeconsumer
  • mwoauthupdateownconsumer
  • mwoauthmanageconsumer
  • mwoauthsuppress
  • mwoauthviewsuppressed
  • mwoauthviewprivate
  • mwoauthmanagemygrants
Użyte haki
Dostarczane haki
Licence Licencja GNU General Public License 2.0 lub nowsza
Pobieranie
Pobierz rozszerzenie
Git [?]:
Pomoc Help:OAuth
Przetłumacz rozszerzenie OAuth jeżeli jest dostępne na translatewiki.net
Rola Vagrant oauth
Problemy Otwarte zadania · Zgłoś błąd

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 .

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.

Instalacja


Instalacja Vagranta:

  • Jeżeli korzystasz z Vagrant a, zainstaluj poprzez 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>' ];

Konfiguracja

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 (przestarzałe) 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 Proponowanie nowych konsumentów OAuth
mwoauthupdateownconsumer Aktualizowanie kontrolowanych konsumentów OAuth
mwoauthmanageconsumer Zarządzanie konsumentami OAuth
mwoauthsuppress Utajnianie konsumentów OAuth
mwoauthviewsuppressed Podgląd utajnionych konsumentów OAuth
mwoauthviewprivate Podgląd prywatnych danych OAuth
mwoauthmanagemygrants Zarządzanie uprawnieniami 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
Nazwa Wymagane? Opis
response_type Tak
client_id Tak
redirect_uri Nie if present, must match the URI that was set when client was registered exactly
scope Nie
state Nie
code_challenge Nie required if $wgOAuth2RequireCodeChallengeForPublicClients is true
code_challenge_method Nie required if $wgOAuth2RequireCodeChallengeForPublicClients is true

Get access token

Used for requesting access tokens

Path
/oauth2/access_token
Allowed method
POST
Allowed parameters
Nazwa Wymagane? Opis
grant_type Tak type of grant used
client_id Nie
client_secret Nie required if client is confidential
redirect_uri Nie if present, must match the URI that was set when client was registered exactly
scope Nie
code Nie required if authorization_code grant is used
refresh_token Nie required if refresh_token grant is used
code_verifier Nie

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
  • oauth_version (opcjonalne) – either 1 (to return only OAuth 1.0a clients) or 2 (to return only OAuth 2.0 clients). Domyślnie: 2
  • Pagination parameters
    • limit (opcjonalne) – maximum number of clients to return. Domyślnie: 25
    • offset (opcjonalne) – number of clients to skip before returning the first result. Domyślnie: 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
Nazwa Wymagane? Opis Domyślne
client_key Tak client identifier
reason Nie 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
Nazwa Wymagane? Opis Domyślne
name Tak nazwa klienta
description Tak opis klienta
email Tak e-mail kontaktowy
is_confidential Tak set to true if the client is confidential; set to false for public clients like mobile and desktop apps
grant_types Tak OAuth 2.0 grant types used by the client, one or more of the following: authorization_code, refresh_token, client_credentials
scopes Tak OAuth 2.0 scopes, either mwoauth-authonly, mwoauth-authonlyprivate or the set of applicable grants
version Nie client version. 1.0
wiki Nie applicable project. * for all wikis
owner_only ? set to true for a client used only by the creating user
callback_url Nie Return URL for authorizing users. ''
callback_is_prefix Nie 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.

Zobacz też

  • Rozszerzenie: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.
Retrieved from "https://www.mediawiki.org/w/index.php?title=Extension:OAuth/pl&oldid=8440160"