OAuth2 Services: Difference between revisions
Damyon Wiese (talk | contribs) |
Damyon Wiese (talk | contribs) |
||
Line 33: | Line 33: | ||
* [[OAuth2_Services_Setup_Project_In_Microsoft|Setup Project In Microsoft]] | * [[OAuth2_Services_Setup_Project_In_Microsoft|Setup Project In Microsoft]] | ||
* [[OAuth2_Services_Setup_Project_In_Facebook|Setup Project In Facebook]] | * [[OAuth2_Services_Setup_Project_In_Facebook|Setup Project In Facebook]] | ||
=== Setup App in Facebook === | === Setup App in Facebook === |
Revision as of 02:58, 31 March 2017
Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.
OAuth 2 Services
Moodle 3.3
Moodle 3.3 adds support for OAuth 2 services in core which can be used by any plugins 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 "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.
Login
The steps required to enable login using an OAuth 2 service are:
1. Create the OAuth 2 Service using the administration page at "Site administration -> Server -> OAuth 2 Services". There are templates available to create a pre-configured OAuth 2 service for Google, Office 365 and Facebook or you can manually enter all the required details for a custom OAuth 2 service.
2. Register a new application with the OAuth 2 Service provider. Instructions for how to do this with Google, Office 365 and Facebook are listed below.
3. Enter the Client ID and Secret into the configuration page for the OAuth 2 service in Moodle.
4. Enable the OAuth 2 Authentication module.
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.
How do I get a clientid and secret?
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.
Setup App in Facebook
To setup an OAuth 2 client with Facebook, first we need to login to the [Facebook for Developers Apps page] and create a new app.
Enter the name for the new App and choose a category (Education?).
Go to the app basic settings and set the app icon, and the URLs to your privacy policy and terms of service.
Add the "Facebook Login" product to the app.
Configure the OAuth settings. Set the callback URL to "your site url + /admin/oauth2callback.php". If your moodle site is available at https://lemon.edu/ then the callback URL should be set to "https://lemon.edu/admin/oauth2callback.php". Enable the Web OAuth Login but for best security disable all other types of login.
Go to App Review and make your App public.
Finally go to the basic settings and get the App ID and App secret and enter them in Moodle as the Client ID and Client Secret.