| Next revision | Previous revision |
| en:2.0:single_sign_on:oidc_mediawiki [2025/05/06 19:14] – created kainhofer | en:2.0:single_sign_on:oidc_mediawiki [2026/09/08 17:58] (current) – [Caveats and Things to Consider] kainhofer |
|---|
| |
| Throughout the document we will assume you have both Admidio and MediaWiki already set up properly at https://admidio.local/ and https://mediawiki.local/. Please modify these URLs to your actual installation. | Throughout the document we will assume you have both Admidio and MediaWiki already set up properly at https://admidio.local/ and https://mediawiki.local/. Please modify these URLs to your actual installation. |
| | |
| As a first step, one needs to **configure Admidio to act as an OpenID Provider** (OP). This has to be done once and is not specific to MediaWiki. Please follow this guide: [[en:2.0:single_sign_on|#a_basic_setup_for_admidio_as_an_oidc_id_provider]] | As a first step, one needs to **configure Admidio to act as an OpenID Provider** (OP). This has to be done once and is not specific to any particular client. Please [[en:2.0:single_sign_on#a_basic_setup_for_admidio_as_an_oidc_id_provider|folow this guide]]: |
| {{ :en:2.0:sso:sso_oidc_01-05_setup_admidio_preferences.png?direct&600 |}} | {{ :en:2.0:sso:sso_oidc_01-05_setup_admidio_preferences.png?direct&600 |}} |
| |
| Basically, one (1) needs to **create a cryptographic key** to sign message and **choose a unique EntityID**. | |
| The page https://admidio.local/adm_program/modules/preferences.php?panel=sso also provides the link to the metadata xml, and the individual settings in case a client does not support auto-configuration via metadata. | |
| |
| ===== TL;DR; - Quick Overview ===== | Basically, one needs to enable OpenID Connect (OIDC). The Issuer URL should in most cases be left blank, which means Admidio's public URL will be used as issuer URL. |
| | |
| | The page https://admidio.local/adm_program/modules/preferences.php?panel=sso also provides the link to the automatic discovery URL, and the individual settings for clients that do not support auto-configuration via metadata. |
| | |
| | ===== Quick Overview ===== |
| |
| Setting up a client (OpenID "Relying Party" - short RP) to use Admidio's user accounts for logging in consists of two steps: (1) The client (RP, MediaWiki in our case) needs to be set up with the data about the OpenID Provider (OP). Typically this is done via the metadata provided in the discovery URL of the provider. Otherwise one has to manually paste the endpoint URLs of the OpenID provider. Since Admidio provides those URLs with copy buttons in the preferences screen, even the manual configuration is rather straigtforward. (2) Admidio needs to be told about the client. In particular, the entity ID and the redirect URL must be given, and a custom-generated (random) secret must be copied to the client configuration. | Setting up a client (OpenID "Relying Party" = "RP") to use Admidio's user accounts for log-in consists of two steps: |
| | - The client (RP, DokuWiki in our case) needs to be set up with the data about the OpenID Provider (OP). Typically this is done via the metadata provided in the discovery URL of the provider. Otherwise one has to manually paste the endpoint URLs of the OpenID provider. Since Admidio provides those URLs with copy buttons in the preferences screen, even the manual configuration is rather straightforward. |
| | - Admidio needs to be told about the client. In particular, the entity ID and the redirect URL must be given, and a custom-generated (random) secret must be copied to the client configuration. |
| |
| The concrete steps are: | The concrete steps are: |
| * At the **Relying Party (RP)** - MediaWiki in our case - **install the extension** to support OpenID login. | * At the **Relying Party (RP)** - MediaWiki in our case - **install the extension** to support OpenID login. |
| * Configure it either with Admidio's **discovery URL** (if supported), or enter the EntityID and the URL endpoints for authentication, token and userinfo. | * MediaWiki needs to be configured in the ''LocalSettings.php''config file. |
| * Also, choose which scopes (groups of profile fields) should be requested from Admidio ("openid" is required; If Admidio's groups/roles should be mapped to the client's groups, the "groups" scope is also required). | * Copy the discovery URL into the 'providerURL' setting |
| | * Choose which scopes (groups of profile fields) should be requested from Admidio ("openid" is required; If Admidio's groups/roles should be mapped to the client's groups, the "groups" scope is also required). |
| * In **Admidio**, **create a new OpenID client**. | * In **Admidio**, **create a new OpenID client**. |
| * Choose an easily understood **label for the client** (only used in Admidio's list of clients, but has no technical use) | * Choose an easily understood **label for the client** (only used in Admidio's list of clients, but has no technical use) |
| * Enter the **ClientID from the RP**, Copy the created Client Secret (you will later need to paste it indo MediaWiki's configuration), and enter the **Redirect URI** for the RP. Typically the latter can be found either on the RP's configuration page or in the documentation. | * Choose a good **ClientID** to uniquely identify the MediaWiki client (typically, use the base URL of your installation). |
| | * Copy both the ClientID and the Client Secret from Admidios client config to the MediaWiki config file. |
| | * Enter the redirect URL of Mediawiki in Admidio: 'https://[[YOUR_MEDIAWIKI]]/index.php/Special:PluggableAuthLogin'. |
| * Optionally select (both in Admidio and the RP) which **profile fields should be mapped** to OpenID claims (attributes) and sent to the client, and configure which **group memberships** should be transmitted. | * Optionally select (both in Admidio and the RP) which **profile fields should be mapped** to OpenID claims (attributes) and sent to the client, and configure which **group memberships** should be transmitted. |
| |
| ==== Configuring the Service Provider (MediaWiki) ==== | ==== Configuring the Service Provider (MediaWiki) ==== |
| |
| OpenID Connect login in MediaWiki is provided by the [[https://www.mediawiki.org/plugin:oauth|"oauth plugin"]] and the connected [[https://www.mediawiki.org/plugin:oauthgeneric|"oauth generic Service"]] extension. | OpenID Connect login in MediaWiki is provided by the OpenID Connect extension. To install it, the following steps are required: |
| {{ :en:2.0:sso:sso_oidc_04-01_dw_plugin_install.png?direct&600 |}} | * Install the [[https://www.mediawiki.org/wiki/Extension:PluggableAuth|PluggableAuth]] extension by downloading or git-cloning the code to the ''extensions/'' directory. |
| | * Install the [[https://www.mediawiki.org/wiki/Extension:OpenID_Connect|OpenID Connect]] extension by downloading or git-cloning the code to the ''extensions/'' directory. |
| | * If installation is done via git, one must add "extensions/OpenIDConnect/composer.json" in the composer.local.json as described in the [[https://www.mediawiki.org/wiki/Extension:OpenID_Connect|OpenID Connect]] extension page, and then run ''composer update'' |
| | * Run the maintenance script (''php maintenance/run.php update'') to create the required database tables. |
| |
| After installation it can be configured in MediaWiki's Configuration Settings, near the bottom in the "Oauth" and "Oauthgeneric" sections. | On a linux server, these would be the corresponding commands: |
| | <code bash> |
| | cd /var/www/html/extensions |
| | git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PluggableAuth |
| | git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/OpenIDConnect |
| | # Add the "extensions/OpenIDConnect/composer.json" include to composer.local.json |
| | # as described on the OpenID Connect extension documentation. |
| | composer update |
| | php maintenance/run.php update |
| | </code> |
| |
| First, one has to copy over the OpenID endpoint URLs from Admidio's OpenID preferences (each URL has a copy button). You can find them here: | |
| {{ :en:2.0:sso:sso_oidc_01-01_setup_admidio_endpoints.png?direct&600 |}} | After installing the extensions, its configuration is done entirely in the ''LocalSettings.php'' config file in the root directory of the MediaWiki installation. |
| | |
| | |
| | |
| | |
| | * Open the ''LocalSettings.php'' configuration file of MediaWiki and append the following lines to the end of the file: |
| | * One has to copy over the OpenID endpoint URLs from Admidio's OpenID preferences (each URL has a copy button). You can find them here: {{ :en:2.0:sso:sso_oidc_01-01_setup_admidio_endpoints.png?direct&600 |}} |
| | * The 'providerURL' is the base URL of your admidio installation, i.e. the path to any of the endpoints shown in Admidio without the final ''authorize'', ''token'' or ''userinfo'' |
| | * The **Client ID** and **Client Secret** will later come from Admidio's client configuration. |
| | * The default authMethod is 'client_secret_basic', which uses basic HTTP authentication headers. This prevents special characters in the authentication name (the client ID). So if one wants to the use installation URL as client ID, one must switch to the 'client_secret_post' authMethod. |
| | <code php> |
| | wfLoadExtension( 'PluggableAuth' ); |
| | wfLoadExtension( 'OpenIDConnect' ); |
| | |
| | # https://www.mediawiki.org/wiki/Extension:PluggableAuth |
| | # "The createaccount or autocreateaccount user rights must be granted to all users. " |
| | $wgGroupPermissions['*']['autocreateaccount'] = true; |
| | $wgGroupPermissions['*']['createaccount'] = true; |
| | |
| | $wgPluggableAuth_EnableLocalLogin = true; |
| | // $wgPluggableAuth_EnableAutoCreate = true; |
| | $wgPluggableAuth_EnableAutoLogin = false; |
| | |
| | |
| | $wgPluggableAuth_Config["OpenID with Admidio"] = [ |
| | 'plugin' => 'OpenIDConnect', |
| | 'data' => [ |
| | 'providerURL' => 'https://admidio.local/modules/sso/index.php/oidc', |
| | 'clientID' => 'https://mediawiki.local', |
| | 'clientsecret' => 'RkMS+6tlpQQ5yow5PlQQTFRcOMC0XCU/', |
| | 'scope' => ['openid', 'email', 'profile', 'address', 'phone', 'groups', 'custom'], |
| | 'authMethods' => ['client_secret_post'], |
| | 'codeChallengeMethod' => 'S256' |
| | ], |
| | 'groupsyncs' => [ |
| | [ |
| | // There is also the 'mapped' type, but I have not been able to configure it! |
| | 'type' => 'syncall', |
| | // 'locallyManaged' => ['sysop'], |
| | 'locallyManaged' => [], // Default includes 'sysop' -> would never sync from OpenID -> need to clear it explicitly! |
| | 'groupAttributeName' => 'groups', |
| | ] |
| | ] |
| | ]; |
| | $wgOpenIDConnect_SingleLogout = true; |
| | $wgOpenIDConnect_MigrateUsersByUserName = true; |
| | </code> |
| |
| ==== Setting up the Client (SP) in Admidio ==== | ==== Setting up the Client (SP) in Admidio ==== |
| |
| - The **Client Name** is the label of the client in Admidio's client list, it can be anything you like. | - The **Client Name** is the label of the client in Admidio's client list, it can be anything you like. |
| - The **"Client ID"** and **"Client Secret"** in Admidio have to match exactly the **"Application UID"** and **"Application Secret"** in MediaWiki's configuration. The ID is typically the client's URL, although some clients allow any unique identifier, while others (most notably MediaWiki) require it to be the base of the OpenID endpoint (up until the 'index.php/oidc/'). The Client Secret should a random string and will serve like a password. Admidio will create one and allow it to be copied to the client. Afterwards it is only stored as a hash in the database and not be recovered any more. However, one can create a new Client Secret in Admidio and copy that to the client's configuration. | - The **"Client ID"** and **"Client Secret"** in Admidio have to match exactly the **"clientID"** and **"clientsecret"** entries in MediaWiki's configuration. The ID is typically the client's URL. The client secret is randomly generated and must be copied exactly to the MediaWiki configuration. The Client Secret should be a random string and will serve like a password. Admidio will create one and allow it to be copied to the client. Afterwards it is only stored as a hash in the database and can not be recovered any more. However, one can create a new Client Secret in Admidio and copy that to the client's configuration. |
| - MediaWiki will display its **Redirect URL**, which needs to be copied to Admidio. | - MediaWiki's redirect URL is the Special:PluggableAuthLogin page, i.e. ''https://[YOUR_INSTALLATION]/index.php/Special:PluggableAuthLogin''. Enter that URL in Admidio's client config. |
| - Enter the **scopes** you desire in MediaWiki's config and make sure that Admidio's config matches it. At least **openid must be included** (Admidio will implicitly add it). If groups/roles are supposed to be used for access permissions, the **"groups" scope** also must be included in both MediaWiki's and Admidio's scope setting and the roles included as an OpenID claim. (The groups mapping that Admidio offers is optional, one can also send all groups verbatim without mapping. This can be achieved by checking the checkbox below the mapping table in Admidio). | - Enter the **scopes** you used in MediaWiki's config and make sure that Admidio's config matches it. At least **openid must be included** (Admidio will implicitly add it). If groups/roles are supposed to be used for access permissions, the **"groups" scope** also must be included in both MediaWiki's and Admidio's scope setting and the roles included as an OpenID claim. (The groups mapping that Admidio offers is optional, one can also send all groups verbatim without mapping. This can be achieved by checking the checkbox below the mapping table in Admidio). |
| |
| This is a typical configuration of the MediaWiki Oauth extensions for Admidio as an OpenID provider: | |
| {{ :en:2.0:sso:sso_oidc_04-04_dw_settings.png?direct&800 |}} | |
| |
| | This is a typical configuration of the MediaWiki OpenID client in Admidio: |
| | {{ :en:2.0:sso:sso_oidc_mediawiki_02_client.png?direct&600 |}} |
| | {{ :en:2.0:sso:sso_oidc_mediawiki_02_client2.png?direct&600 |}} |
| |
| To use Admidio's group memberships as MediaWiki groups, make sure to include the "Roles" field and provide the correct field name in MediaWiki. MediaWiki even provides a setting to overwrite all groups with the groups received from Admidio. | The clientID and the client secret in the Admidio client page and MediaWiki's ''LocalSettings.php'' have to match exactly. Similarly, the scopes should coincide, otherwise not all desired profile fields will be transmitted. To make use of the group mapping in MediaWiki, make sure to include the 'groups' scope in Admidio and Mediawiki, and map the 'Roles - roles' Profile Field to an OIDC claim. |
| |
| Make sure to use the same OpenID claim names as the ones mapped in MediaWiki's OpenID configuration (circled red in the configuration screenshot above). | |
| |
| Once all settings are done, it is time to enable the saml plugin for login to MediaWiki in the "Configuration Settings": | To assign admin (sysop) rights to an OpenID account, the group 'sysop' should be assigned in Admidio's client config and MediaWiki's groupsyncs must exclude 'sysop' from the locally managed groups. |
| {{ :en:2.0:sso:sso_oidc_04-07_dw_enable.png?direct&400 |}} | |
| |
| ==== MediaWiki configuration as text ==== | ==== Setup completed, test Single-Sign-On ==== |
| |
| The settings done above in the graphical interface could also be done in the ''conf/local.php'' config file of MediaWiki. The corresponding settings would look like this: | Admidio and MediaWiki should now be set up to use Admidio for logging in to MediaWiki. If you log out of MediaWiki (or open a new incognito browser window) and try to log in again, you will be shown the Admidio login screen and then redirected back to MediaWiki after successful login. If groups are properly set up and mapped, MediaWiki groups will also be assigned, even admin rights through the OIDC group 'sysop'. |
| |
| <code php> | {{:en:2.0:sso:sso_oidc_mediawiki_03_loginform.png?direct&200|}} {{:en:2.0:sso:sso_oidc_mediawiki_04_admidio_loginform.png?direct&400|}} {{:en:2.0:sso:sso_oidc_mediawiki_05_loginsuccess.png?direct&300|}} {{:en:2.0:sso:sso_oidc_mediawiki_06_loginsuccess_profile.png?direct&600|}} |
| $conf['authtype'] = 'oauth'; | |
| $conf['superuser'] = '@admin'; | |
| $conf['plugin']['oauth']['register-on-auth'] = 1; | |
| $conf['plugin']['oauth']['overwrite-groups'] = 1; | |
| $conf['plugin']['oauthgeneric']['key'] = 'https://mediawiki.local/'; | |
| $conf['plugin']['oauthgeneric']['secret'] = 'lWDQ......gU'; | |
| $conf['plugin']['oauthgeneric']['authurl'] = 'https://admidio.local/modules/sso/index.php/oidc/authorize'; | |
| $conf['plugin']['oauthgeneric']['tokenurl'] = 'https://admidio.local/modules/sso/index.php/oidc/token'; | |
| $conf['plugin']['oauthgeneric']['userurl'] = 'https://admidio.local/modules/sso/index.php/oidc/userinfo'; | |
| $conf['plugin']['oauthgeneric']['scopes'] = array('openid', 'profile', 'address', 'phone', 'email', 'custom', 'groups', 'roles'); | |
| $conf['plugin']['oauthgeneric']['json-user'] = 'username'; | |
| $conf['plugin']['oauthgeneric']['json-name'] = 'fullname'; | |
| $conf['plugin']['oauthgeneric']['json-mail'] = 'email'; | |
| $conf['plugin']['oauthgeneric']['json-grps'] = 'roles'; | |
| $conf['plugin']['oauthgeneric']['label'] = 'OIDC Login with Admidio'; | |
| </code> | |
| |
| ==== Setup completed, test Single-Sign-On ==== | |
| |
| Admidio and MediaWiki should now be set up to use Admidio for logging in to MediaWiki. If you log out of MediaWiki and try to log in again, you will be shown the Admidio login screen and then redirected back to MediaWiki. | |
| |
| {{ :en:2.0:sso:sso_oidc_04-08_dw_login.png?direct&400 |}} | ==== Caveats and Things to Consider ==== |
| {{ :en:2.0:sso:sso_oidc_04-09_dw_admidio_login.png?direct&400 |}} | |
| {{ :en:2.0:sso:sso_oidc_04-10_dw_login_success.png?direct&400 |}} | |
| |
| | * MediaWiki allows **admin login** through OpenID by assigning the **group 'sysop'** in the group mapping. The 'groups' scope must be included in both Admidio's as well as MediaWiki's config, and Admidio's role must be included as an OIDC claim.<code php>[..., |
| | 'groupsyncs' => [ |
| | [ |
| | 'type' => 'syncall', |
| | // List of locally managed groups by default contain 'sysop', |
| | // so administrators would never sync from Admidio -> clear it! |
| | 'locallyManaged' => [], |
| | 'groupAttributeName' => 'groups', |
| | ]] |
| | </code>{{ :en:2.0:sso:sso_oidc_mediawiki_02_client3_sysop.png?400 |}} |
| |
| ==== Caveats and Things to Consider ==== | * By default, MediaWiki will use basic http authentication for its calls to the authorization and token endpoints, which means that no special characters (in particular colons) are allowed. Unfortunately, the client ID will be used as username, which typically contains a colon in 'https://...'. The OpenID specification states that the colon is the separator between username and passphrase (client secret), so Admidio will incorrectly assume 'https' to be the username and everything else is the client secret... The two possible solutions are to (1) either not use the full URL, but any other unique identifier without a colon as clientID, or (2) switch MediaWiki to the 'client_secret_post' authMethod in the MediaWiki's ''LocalSettings.php'' configuration file (see the example above, which already contains this fix). |
| |
| * MediaWiki allows **admin login** through OpenID by assigning the **group 'admin'** in the group mapping. | |
| * MediaWiki will convert all group names to lowercase. This is a general restriction in MediaWiki and not specific to OpenID. | |
| * MediaWiki will match its accounts using the email provided in the OpenID token, even when a different user id field is selected. E.g. if a local user 'dale' with email 'dale@example.com' already exists, and a new OpenID login from user 'dale' with email 'dale.baade@example.com' occurs, MediaWiki will treat these as two separate users (and modify the username of the newly created user to 'dale1')! | |
| * MediaWiki controls **login permissions for OpenID** with a **group 'generic' assigned to a user**. If local accounts already exist, one needs to add them to the 'generic' group, otherwise login with OpenID is not possible and the following error message will be shown:{{ :en:2.0:sso:sso_oidc_04-10_dw_error_group.png?direct |}} To fix this, add the user to the 'generic' group: {{ :en:2.0:sso:sso_oidc_04-11_dw_generic_group.png?direct&600 |}} | |
