GitHub Single Sign-On (SSO) Integration with Drupal OAuth / OpenID Connect Client
Drupal OAuth Client
module enables Single Sign-On i.e. SSO for a Drupal site with any Identity Provider using OAuth or OpenID
connect protocol. Here we will go through the steps to configure the module with the GitHub. Once this
configuration is done, users will be able to log in to the Drupal site using their GitHub credentials.
The integration of Drupal with GitHub simplifies and secures the login process, completely removing the need to
store, remember, and reset multiple passwords.
Installation Steps:
- Download the module:
composer require 'drupal/miniorange_oauth_client'
- Navigate to Extend menu on your Drupal admin console and search for miniOrange OAuth Client Configuration using the search box.
- Enable the module by checking the checkbox and click on the Install button.
- You can configure the module at:
{BaseURL}/admin/config/people/miniorange_oauth_client/config_clc
- Install the module:
drush en drupal/miniorange_oauth_client
- Clear the cache:
drush cr
- You can configure the module at:
{BaseURL}/admin/config/people/miniorange_oauth_client/config_clc
- Navigate to Extend menu on your Drupal admin console and click on Install new module.
- Install the Drupal OAuth & OpenID Connect Login - OAuth2 Client SSO Login module either by downloading the zip or from the URL of the package (tar/zip).
- Click on Enable newly added modules.
- Enable this module by checking the checkbox and click on install button.
- You can configure the module at:
{BaseURL}/admin/config/people/miniorange_oauth_client/config_clc
Setup Drupal as OAuth Client:
- After installing the module, navigate to the Configuration -> miniOrange OAuth Client Configuration -> Configure OAuth tab and select GitHub from the Select Application dropdown list.
- Copy the Callback/Redirect URL and keep it handy.
Note: If your provider only supports HTTPS Callback/Redirect URLs and you have an HTTP site, please make sure to enable the 'Enforce HTTPS Callback URL' checkbox at the bottom of the tab.
- Enter the application name in the Display Name text field. For example, Github
Create SSO Application in GitHub:
- Go to https://github.com/settings/developers and Login/Sign up to your GitHub account.
- You will be presented with the following screen. Click on Register a new application.
- Enter the Application name and Homepage URL (from your Drupal site). Paste the previously copied Callback/Redirect URL into the Authorization callback URL text field. Click on Register application button.
Integrating Drupal with GitHub:
- After successfully registering your app on GitHub, you will be given Client ID and Client Secret, copy them. You’ll need them in the next step.
- In Drupal’s Configure OAuth tab paste the copied Client ID and Client Secret in the Client ID and Client Secret text fields.
Please confirm the Scope and Endpoints from the table below and click on the Save Configuration button.
| Scope | user repo |
|---|---|
| Authorize EndPoint | https://github.com/login/oauth/authorize |
| Access Token Endpoint | https://github.com/login/oauth/access_token |
| Get User Info Endpoint | https://api.github.com/user |
Test Connection between Drupal and GitHub:
- Click on the Perform Test Configuration button to test the connection between Drupal and Github.
- On a Test Configuration popup, if you don't have any active sessions on the same browser, you will be requested to login into the GitHub. After successfully logging into the GitHub, you will be provided a list of attributes received from the GitHub.
- Select the Email Attribute from the dropdown menu in which the user's email ID is obtained and click on the Done button.
- On the Attribute & Role Mapping tab, please select the Username Attribute from the dropdown list and click on the Save Configuration button.
Please note: Mapping the Email Attribute is mandatory for Single Sign-On.
Congratulations! You have successfully configured GitHub as OAuth/OpenID Provider and Drupal as an OAuth Client.
How to perform the SSO?
- Now, open a new browser/private window and go to your Drupal site login page.
- Click on the Login using the GitHub link to initiate the SSO from Drupal.
- If you want to add the SSO link to other pages as well, please follow the steps given in the image below:
Need Assistance?
If you face any issues during the configuration or if you want some additional features, please contact us at drupalsupport@xecurify.com.
Additional Features:
- Attribute Mapping - map user’s attributes received from OAuth Provider with Drupal fields
- Role mapping - assign a Drupal Role to users on the basis of their role/attribute on the OAuth provider
- Enable single logout - Logout user from the OAuth Provider (i.e. AWS Cognito, Azure AD B2C, Keycloak, Okta) when they logs out form Drupal
- Restrict anonymous access to the complete site or a particular section of the site
- Add Multiple OAuth Provides
- Explore All the features offered by the OAuth Client
Troubleshooting:
Follow the steps mentioned HERE
Follow the steps mentioned HERE
The logout functionality you’ve mentioned here is the default behavior of a module. It’s logging you out of Drupal but not from your Application/Provider. To allow the module to logout from your provider/application account (what you are looking for), you need to make the below configurations: [know more]
As you have upgraded to one of our paid versions of the Drupal module and replaced the free module with the paid one, you must first activate the paid module. Please refer to the below steps. [Know more]
Need Help? We are right here!
