OAuth 2 authentication: Difference between revisions

From MoodleDocs
Main page ► Managing a Moodle site ► Authentication ► OAuth 2 authentication
Authentication
m (removing new features template)
m (clean up, typos fixed: ’s → 's (2))
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Authentication}}
{{Authentication}}
[[File:oauth 2 auth.png|thumb|Login page with options to log in with an OAuth 2 service]]
== Overview ==
==Log in using your account on another site==
OAuth 2.0 is the de facto industry standard protocol for user authorisation. OAuth 2 authentication enables users to access Moodle via buttons on the login page using their credentials from popular service providers, such as Google, Microsoft, Facebook, and LinkedIn.
[[File:OAuth Login.png|border|center|frameless|600x600px]]
The following high-level interaction process illustrates how OAuth 2 authentication works in a Moodle context:
[[File:OAuth - Service Provider Authentication.png|border|center|frameless|600x600px]]


The OAuth 2 authentication plugin enables users to log in using their Google, Microsoft and/or Facebook account via buttons on the login page.


If account creation is enabled, when a user first logs in, a new account will be created. Otherwise, they will be prompted to [[Linked logins|link it to their existing account]] with the same email address.
An OAuth service provider is an external system (“in the cloud”) that provides identity (via the authorisation server) and API access (via the resource server) by issuing OAuth access tokens to a client (Moodle). Let's go through the interactions from top to bottom:
# A user sends an authorisation request; that is, a user logs in to the service provider via the client. This step is initiated via the service provider buttons on the Moodle login screen.
# The authorisation server issues an authorisation code if the entered credentials are valid. Once this has taken place, the user is authenticated with Moodle. If account creation is enabled (the Prevent account creation when authenticating setting), a new account will be created. Otherwise, the user will be prompted to link the authorisation to an existing account with the same email address. An entry can be found in the [[Linked logins]] section in the user's preferences.
# An access token will be issued when the user logs in using the stored authorisation code. A scheduled task exists to regularly update the OAuth 2 tokens (\core\oauth2\refresh_ system_tokens_task).
# Moodle uses this access token for any internal services that require a resource from the service provider, for instance, a link to files in a repository. Some internal services require a system account to be connected.
==Setting up OAuth 2 authentication==
To use OAuth 2 authentication, an administrator must follow the following steps:
# Configure OAuth 2 services: Go to '''Site administration > Server > OAuth 2 services''', and following the instructions on the [[OAuth 2 services]] page.
# Enable OAuth 2: Go to '''Site administration > Plugins > Authentication''', enable '''OAuth 2'''.
# Configure OAuth 2 lock user fields: To control if and how certain user data fields are being populated, click on the '''Settings''' link and configure your '''Lock user fields'''.
# Prevent account creation: By default, account creation is enabled. If you wish to prevent account creation, go to '''Site administration > Plugins > Authentication''' and enable the setting "authpreventaccountcreation".
# Testing, testing, testing: To verify that your OAuth 2 configuration is working, go to '''Site administration > Plugins > Authentication''' and click on the '''Test settings''' link in the '''OAuth 2''' row. Here, you can select a service and test its connection.


==Enabling OAuth 2 authentication==
The following Moodle features require an OAuth2 service:


To use OAuth 2 authentication, an administrator must first create the required OAuth 2 services.
* Repositories: [[Dropbox repository]], [[Google Drive repository]], Microsoft [[OneDrive repository]], and [[Nextcloud repository]]
 
* Portfolios: [[Google Drive portfolio]]
# Go to 'OAuth 2 services' in Site administration > Server and click the button to create a new service.
* Badges: [[Backpacks|Open Badges 2.1]]
# Follow the instructions in [[OAuth 2 Google service]], [[OAuth 2 Microsoft service]] or [[OAuth 2 Facebook service]] and obtain a client ID and secret.
* Mail: Incoming and outgoing [[mail configuration]]
# Enter the client ID and secret, make sure 'Show on login page' is ticked, then save changes.
* Document converters: [[Google Drive converter]]
 
Repeat for additional services as desired. For OAuth 2 authentication, there is no need to connect to a system account.
 
Next:
 
# Go to 'Manage authentication' in Site administration and enable the OAuth 2 authentication plugin.
# Optional: In the OAuth 2 settings, lock selected user data fields and save changes.
 
==Preventing new account creation==
 
If you don't want new accounts to be created when users log in with an OAuth 2 service:
 
# Go to 'Manage authentication' in Site administration and tick the box 'Prevent account creation when authenticating' (authpreventaccountcreation).
# Click the 'Save changes' button.
 
==Troubleshooting==
 
===On the 'OAuth 2 services' page, there is a red cross for 'Allow login'===
 
To get a green tick for Allow login, edit the OAuth 2 service and make sure that the setting 'Show on login page' is ticked.
 
===I obtain a coding error after enabling OAuth 2 authentication===
 
Have you any OAuth 2 plugins for earlier versions installed on your site? If so, you will need to [[Installing plugins|uninstall them]] in order to use the standard OAuth 2 authentication.
 
===I obtain an error message when attempting to log in using Facebook===
 
The error message 'The user information returned did not contain a username and email address. The OAuth 2 service may be configured incorrectly.' is most likely because the user's Facebook account was created using a mobile number.
 
The solution is for the user to first log in to Facebook and add a username and email address there.
 
=== I see a "required paramenter (code) was missing" error after logging into the OAuth 2 service ===
 
The error message 'A required parameter (code) was missing' can be caused by a mis-configured webserver. OAuth 2 relies on long tokens passed as url parameters, and some webserver configurations will prevent this from working. See http://www.php.net/manual/en/reserved.variables.get.php#101469 for one possible solution.


==See also==
* [[OAuth 2 Troubleshooting|OAuth 2 troubleshooting]]
[[Category:OAuth 2]]
[[Category:OAuth 2]]
[[es:Autenticación OAuth 2]]
[[es:Autenticación OAuth 2]]
[[de:OAuth2 Authentifizierung]]
[[de:OAuth2 Authentifizierung]]
[[ja: OAuth 2認証]]

Latest revision as of 14:45, 25 April 2024

Overview

OAuth 2.0 is the de facto industry standard protocol for user authorisation. OAuth 2 authentication enables users to access Moodle via buttons on the login page using their credentials from popular service providers, such as Google, Microsoft, Facebook, and LinkedIn.

OAuth Login.png

The following high-level interaction process illustrates how OAuth 2 authentication works in a Moodle context:

OAuth - Service Provider Authentication.png


An OAuth service provider is an external system (“in the cloud”) that provides identity (via the authorisation server) and API access (via the resource server) by issuing OAuth access tokens to a client (Moodle). Let's go through the interactions from top to bottom:

  1. A user sends an authorisation request; that is, a user logs in to the service provider via the client. This step is initiated via the service provider buttons on the Moodle login screen.
  2. The authorisation server issues an authorisation code if the entered credentials are valid. Once this has taken place, the user is authenticated with Moodle. If account creation is enabled (the Prevent account creation when authenticating setting), a new account will be created. Otherwise, the user will be prompted to link the authorisation to an existing account with the same email address. An entry can be found in the Linked logins section in the user's preferences.
  3. An access token will be issued when the user logs in using the stored authorisation code. A scheduled task exists to regularly update the OAuth 2 tokens (\core\oauth2\refresh_ system_tokens_task).
  4. Moodle uses this access token for any internal services that require a resource from the service provider, for instance, a link to files in a repository. Some internal services require a system account to be connected.

Setting up OAuth 2 authentication

To use OAuth 2 authentication, an administrator must follow the following steps:

  1. Configure OAuth 2 services: Go to Site administration > Server > OAuth 2 services, and following the instructions on the OAuth 2 services page.
  2. Enable OAuth 2: Go to Site administration > Plugins > Authentication, enable OAuth 2.
  3. Configure OAuth 2 lock user fields: To control if and how certain user data fields are being populated, click on the Settings link and configure your Lock user fields.
  4. Prevent account creation: By default, account creation is enabled. If you wish to prevent account creation, go to Site administration > Plugins > Authentication and enable the setting "authpreventaccountcreation".
  5. Testing, testing, testing: To verify that your OAuth 2 configuration is working, go to Site administration > Plugins > Authentication and click on the Test settings link in the OAuth 2 row. Here, you can select a service and test its connection.

The following Moodle features require an OAuth2 service:

See also

Retrieved from "https://docs.moodle.org/405/en/index.php?title=OAuth_2_authentication&oldid=148450"
Powered by MediaWiki