Difference between revisions of "OAuth 2 services"

Jump to: navigation, search
(How do I get a client ID and secret?)
m (Login domains: small rewordings)
 
(18 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Server settings}}{{New features}}
+
{{Server settings}}
 
==OAuth2 services==
 
==OAuth2 services==
  
Moodle 3.3 adds support for OAuth 2 services, which can be used by any plugin to provide authenticated access to external services either as the current user, or using a system account.
+
* Moodle 3.3 adds support for OAuth 2 services (or "Issuers"), which can be used by any plugin to provide authenticated access to external services either as the current user, or using a system account.
 
+
* OAuth 2 services are used for example, to provide a "Log in using Google/Microsoft/Facebook" feature on the login page, and then to share that authenticated session with repositories like [[Google Drive repository|Google Drive]] and [[OneDrive repository|OneDrive]] without having to re-authenticate.
OAuth 2 services are used for example, to provide a "Login using Google/Microsoft/Facebook" feature on the login page, and then to share that authenticated session with repositories like Google Drive and Office 365 without having to re-authenticate.
+
* OAuth 2 services can be used by plugins even if they do not use them on the login page, and it's possible to login to multiple services at the same time.
 
 
OAuth 2 services can be used by plugins even if they do not use them on the login page, and it's possible to login to multiple services at the same time.  
 
  
 
== Login ==
 
== Login ==
Line 16: Line 14:
 
Open ID Connect is a standard for OAuth 2 login services that makes it easier to setup a working login system. If the service you are setting up is Open ID Connect compliant, you will only have to enter the base url for the service, and Moodle will discover all the other information required by requesting the "discovery document" which is expected to exist at <issuer base url>/.well-known/openid-configuration.  
 
Open ID Connect is a standard for OAuth 2 login services that makes it easier to setup a working login system. If the service you are setting up is Open ID Connect compliant, you will only have to enter the base url for the service, and Moodle will discover all the other information required by requesting the "discovery document" which is expected to exist at <issuer base url>/.well-known/openid-configuration.  
  
== How do I get a client ID and secret? ==
+
== Issuer Configuration ==
 +
 
 +
First some terminology: In these scenarios, Moodle is the "client" and the remote service (Google, Facebook, ...) is the "issuer" or "provider".
  
The client ID and secret are created outside of Moodle when setting up the OAuth provider. Instructions for prominent OAuth 2 providers are linked here.
+
=== How do I get a client ID and secret? ===
 +
 
 +
The client ID and secret are provided by the issuer, so you need to set it up outside of Moodle, at the issuer. Instructions for prominent OAuth 2 providers are linked here.
  
 
* [[OAuth 2 Google service]]
 
* [[OAuth 2 Google service]]
Line 24: Line 26:
 
* [[OAuth 2 Facebook service]]
 
* [[OAuth 2 Facebook service]]
 
* [[OAuth 2 LinkedIn service]]
 
* [[OAuth 2 LinkedIn service]]
 +
* [[OAuth 2 Nextcloud service]]
 +
* [[OAuth 2 Twitter service]]
 +
 +
For custom services you will need to find out how to obtain the client ID and secret. The issuer will need configuring with the corresponding redirect URL for Moodle which is '''<wwwroot>/admin/oauth2callback.php''', e.g. if your Moodle site is https://moodle.example.com, then the redirect URL is https://moodle.example.com/admin/oauth2callback.php.
 +
 +
=== Adding an issuer ===
 +
 +
If possible, use one of the preconfigured services if yours is among it. You can still configure individual details later on. You can choose from this list:
 +
 +
[[Image:OAuth2-predefined-issuers.png|frame|center|Preconfigured issuers]]
 +
 +
Then, the following settings appear:
 +
 +
[[Image:OAuth2-issuer-settings.png|frame|center|Issuer settings]]
 +
 +
As a general rule, don't change any settings, except for '''Name''', '''Client ID''', '''Client Secret''', and '''Service Base URL''', unless installation instructions advise you to. Apart from that the defaults are usually fine, especially if you use one of the preconfigured services.
 +
See [[#Advanced_issuer_settings|Advanced issuer settings (below)]] for explanations of some of the settings.
 +
 +
====Login domains====
 +
 +
This setting only applies if "Show on login page" is checked. If specified, only users with matching emails will be able to sign-up and log in using this service.
 +
 +
This restriction will apply on top of the allowed and denied email domains settings in [[Managing_authentication|Manage authentication]], however the latter are only checked when a user is created and are not checked again when the user logs in.
 +
 +
====Further configuration options====
 +
 +
After an issuer has been created, further configuration options are shown to the right of the service. Usually no change is required for preconfigured services.
 +
 +
[[Image:OAuth2-issuer-other-settings.png|frame|center|Further configuration options for OAuth 2 issuers]]
 +
 +
; Edit : Go to the settings screen again.
 +
; Configure endpoints : Define the issuer's endpoints, i.e. the URLs that Moodle will connect to. The following endpoints are mandatory for user authentication: '''authorization_endpoint''', '''token_endpoint''' and '''userinfo_endpoint'''. (Example image below).
 +
; Configure user field mappings : If you use the issuer as an identity provider, you can configure how the provider's response (from the '''userinfo_endpoint''') should be mapped to Moodle user fields. You should set up mappings for internal field names '''firstname''', '''lastname''' and '''email''' so that the user is fully set up when they log in as these fields are mandatory in Moodle. If any of these are not mapped the user will be redirected to their [[Edit profile]] page and prompted for the missing information. (Example image below).
 +
; Delete : Delete the issuer configuration.
 +
; Disable : Mark the issuer as disabled; plugins may not use them.
 +
; Move up / down : Change the order of appearance in the issuer table.
 +
 +
[[File:endpoints.png|frame|center|Example endpoints for a custom service]][[File:user_field_mappings.png|frame|center|Example user field mappings]]
 +
 +
=== Connecting a system account ===
 +
 +
* A system account may be connected. It may be needed by plugins in order to provide advanced functionality, such as access controlled links from the [[Google Drive repository]] or [[OneDrive repository]].
 +
* The system account should be a dedicated account for this purpose only. The system account doesn't require an email address to be associated with it (Moodle 3.3.2 onwards).
 +
* A system account is not needed for login functionality.
 +
 +
[[File:errorsNotification.png|thumb|right|Notification preferences page]]
 +
==== Refreshing Access Token ====
 +
 +
There is a scheduled task to regularly update the OAuth token for service accounts, ''Refresh OAuth tokens for service accounts'' (''\core\oauth2\refresh_system_tokens_task''). If for any reason the token cannot be refreshed, e.g. if the authorization expires, all Moodle administrators will be notified.
 +
 +
If an admin user does not wish to receive these notifications, it can be set up on the [[Notifications|Notification preferences]] page. The notification option to deactivate is ''Important errors with the site''.
 +
 +
'''Caution''': A user who turns off the ''Important errors with the site'' notification may not receive other important information related to site errors. For example, the user will not receive e-mails about the results of the antivirus scan or any notification sent from a third-party plugin that uses the core message provider ''errors''.
 +
Currently there are not many notifications sent using this message provider; unfortunately, there is no way to list them, so it is recommended to check the notifications that were received before and those that are received after deactivating the notification.
 +
 +
=== Advanced issuer settings ===
 +
 +
; Authenticate token requests via HTTP headers : This should be the norm according to the OAuth 2 standard. However, most providers don't support this and require authentication details in the body instead. For most configurations, leave this checkbox disabled, unless instructions advise you to check it.
  
 
==See also==
 
==See also==
  
 
* [[:Category:OAuth 2]]
 
* [[:Category:OAuth 2]]
 +
* [https://moodle.org/mod/forum/discuss.php?d=351727 Oauth2 problems in Moodle 3.3] forum discussion
 +
* [https://moodle.org/mod/forum/discuss.php?d=362593 Problem to configure Oauth2 with Microsoft Office365] forum discussion
  
 
[[Category:OAuth 2]]
 
[[Category:OAuth 2]]

Latest revision as of 13:43, 20 October 2020

OAuth2 services

  • Moodle 3.3 adds support for OAuth 2 services (or "Issuers"), which can be used by any plugin to provide authenticated access to external services either as the current user, or using a system account.
  • OAuth 2 services are used for example, to provide a "Log in using Google/Microsoft/Facebook" feature on the login page, and then to share that authenticated session with repositories like Google Drive and OneDrive without having to re-authenticate.
  • OAuth 2 services can be used by plugins even if they do not use them on the login page, and it's possible to login to multiple services at the same time.

Login

See OAuth 2 authentication for details of how to enable the feature.

Open ID Connect

Open ID Connect is a standard for OAuth 2 login services that makes it easier to setup a working login system. If the service you are setting up is Open ID Connect compliant, you will only have to enter the base url for the service, and Moodle will discover all the other information required by requesting the "discovery document" which is expected to exist at <issuer base url>/.well-known/openid-configuration.

Issuer Configuration

First some terminology: In these scenarios, Moodle is the "client" and the remote service (Google, Facebook, ...) is the "issuer" or "provider".

How do I get a client ID and secret?

The client ID and secret are provided by the issuer, so you need to set it up outside of Moodle, at the issuer. Instructions for prominent OAuth 2 providers are linked here.

For custom services you will need to find out how to obtain the client ID and secret. The issuer will need configuring with the corresponding redirect URL for Moodle which is <wwwroot>/admin/oauth2callback.php, e.g. if your Moodle site is https://moodle.example.com, then the redirect URL is https://moodle.example.com/admin/oauth2callback.php.

Adding an issuer

If possible, use one of the preconfigured services if yours is among it. You can still configure individual details later on. You can choose from this list:

Preconfigured issuers

Then, the following settings appear:

Issuer settings

As a general rule, don't change any settings, except for Name, Client ID, Client Secret, and Service Base URL, unless installation instructions advise you to. Apart from that the defaults are usually fine, especially if you use one of the preconfigured services. See Advanced issuer settings (below) for explanations of some of the settings.

Login domains

This setting only applies if "Show on login page" is checked. If specified, only users with matching emails will be able to sign-up and log in using this service.

This restriction will apply on top of the allowed and denied email domains settings in Manage authentication, however the latter are only checked when a user is created and are not checked again when the user logs in.

Further configuration options

After an issuer has been created, further configuration options are shown to the right of the service. Usually no change is required for preconfigured services.

Further configuration options for OAuth 2 issuers
Edit 
Go to the settings screen again.
Configure endpoints 
Define the issuer's endpoints, i.e. the URLs that Moodle will connect to. The following endpoints are mandatory for user authentication: authorization_endpoint, token_endpoint and userinfo_endpoint. (Example image below).
Configure user field mappings 
If you use the issuer as an identity provider, you can configure how the provider's response (from the userinfo_endpoint) should be mapped to Moodle user fields. You should set up mappings for internal field names firstname, lastname and email so that the user is fully set up when they log in as these fields are mandatory in Moodle. If any of these are not mapped the user will be redirected to their Edit profile page and prompted for the missing information. (Example image below).
Delete 
Delete the issuer configuration.
Disable 
Mark the issuer as disabled; plugins may not use them.
Move up / down 
Change the order of appearance in the issuer table.
Example endpoints for a custom service
Example user field mappings

Connecting a system account

  • A system account may be connected. It may be needed by plugins in order to provide advanced functionality, such as access controlled links from the Google Drive repository or OneDrive repository.
  • The system account should be a dedicated account for this purpose only. The system account doesn't require an email address to be associated with it (Moodle 3.3.2 onwards).
  • A system account is not needed for login functionality.
Notification preferences page

Refreshing Access Token

There is a scheduled task to regularly update the OAuth token for service accounts, Refresh OAuth tokens for service accounts (\core\oauth2\refresh_system_tokens_task). If for any reason the token cannot be refreshed, e.g. if the authorization expires, all Moodle administrators will be notified.

If an admin user does not wish to receive these notifications, it can be set up on the Notification preferences page. The notification option to deactivate is Important errors with the site.

Caution: A user who turns off the Important errors with the site notification may not receive other important information related to site errors. For example, the user will not receive e-mails about the results of the antivirus scan or any notification sent from a third-party plugin that uses the core message provider errors. Currently there are not many notifications sent using this message provider; unfortunately, there is no way to list them, so it is recommended to check the notifications that were received before and those that are received after deactivating the notification.

Advanced issuer settings

Authenticate token requests via HTTP headers 
This should be the norm according to the OAuth 2 standard. However, most providers don't support this and require authentication details in the body instead. For most configurations, leave this checkbox disabled, unless instructions advise you to check it.

See also