Drupal Apple SSO Login with OAuth Client Setup guide

Overview

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. This module is compatible with Drupal 7, Drupal 8, Drupal 9, Drupal 10, and Drupal 11. Here we will go through the steps to configure the module with the Apple. Once this configuration is done, users will be able to log in to the Drupal site using their Apple credentials.

Playground Schedule a Meeting

Installation Steps

Configuration Steps

Setup Drupal as OAuth Client:

• After installing the module, navigate to the Configuration -> miniOrange OAuth Client Configuration -> Configure OAuth tab and select Custom OAuth 2.0 Provider 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 name in the Custom App Name text field. For example, Apple.

Setup Apple as an OAuth Provider:

• Login to your Apple Developer account.

• Click on Certificates, Identifiers & Profiles tab.

• In the left menu Click on Identifiers and after that click on the Plus Icon(blue color) . Click on Continue for the next 2 pages.

• Enter Description and Bundle ID for the App ID. (The Bundle ID should be in reverse-dns style string.)

• In the Capabilities section scroll down and select sign In with apple and Click on Edit link.

• Select Enable as a primary App Id and click on Save. Click on Continue and then click on Register.

• In the right corner click on Continue and after that Register button.
• Again click the Plus icon( blue color). Select Service IDs and click on Continue.

• Enter Description and Identifier( Identifier would be your client id). and click on the Continue and after that Register button.

• Click on Keys tab from the left menu.Click on the Plus icon to register a new key.

• Give your Key a name, and select Sign In with Apple and click on Configure button.

• Select your Primary Id and click on the Save button and after that at the right corner click on Continue and Register button.

• Click on the Download button once the key is downloaded click on the Done button.

• In the left menu click on Identifiers and the right top click on App IDs.

• Click on Service IDs from the drop down menu.

• Select your Service Id from the List.

• Select Sign In with Apple and click on Configure button.

• Select the Primary App Id from the drop down, and Enter the Domain and Redirect URL in Domains and Subdomains and Return URLs respectively and click on the Next button (You will get the Domain name and Redirect URL from Drupal module).

• Verify the details and click on the Done button. After that at the right corner click on the Continue button.
• Copy the Identifier value and click on the Save button.

Generating Secret Key

• Download the Ruby installer from the following link https://rubyinstaller.org/downloads/ and then install it.
• Search for the Start command prompt with ruby open the ruby command prompt andinstall the JWT gem by running the following command on the command line:gem install JWT.
• Copy the below code in a file and save the file with the .rb extension. Keep this .rb fileand downloaded .p8 file in the same folder.
• Enter the name of downloaded file example= "key.P8", key_id , client_id, team_id in the code
• Open Ruby command prompt and run the above code using the following command ruby filename.rb

require 'jwt'key_file = 'key.P8'

    team_id = ''

    client_id = ''
key_id = ''
ecdsa_key = OpenSSL::PKey::EC.new IO.read key_file
headers = {
'kid' => key_id
}
claims = {
'iss' => team_id,
'iat' => Time.now.to_i,
'exp' => Time.now.to_i + 86400*180,
'aud' => 'https://appleid.apple.com',
'sub' => client_id,
}
token = JWT.encode claims, ecdsa_key, 'ES256', headers
puts token

• You will get your secret key. Copy the secret key.

Integrating Drupal with Apple:

• Go to miniOrange OAuth Client module.
• In Configure OAuth tab, paste the copied Client ID and Client Secret in the Client ID and Client Secret text-field.

• You have successfully completed your Apple App OAuth Server side configurations.

Client ID :	from the step 2 above
Client Secret :	from the step 3 above
Scope:	email
Authorize Endpoint:	https://appleid.apple.com/auth/authorize
Access Token Endpoint:	https://appleid.apple.com/auth/token

Test Connection between Drupal and Apple:

• After successfully saving the configurations, please click on the Test Configuration button to test the connection between Drupal and Apple.

• This Test Configuration window will provide you with a list of the attributes that are coming from the Apple.
• Select the Email Attribute from the dropdown menu in which the user's email ID is obtained and click on the Done button.

• Now, in the Attribute & Role Mapping tab, you can also choose the Username Attribute from the dropdown and click on the Save Configuration button.

Note: Mapping the Email Attribute is mandatory for your login to work.

• Now log out and go to your Drupal site’s login page. You will automatically find a Login with Apple link there. 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:

More FAQs ➔

Getting error: 'Username not received. Check your Attribute Mapping configuration.' OR Getting Error: 'Email not received. Check your Attribute Mapping configuration.'

Follow the steps mentioned HERE

I am getting "Client Credentials were not found in the headers or body"
when I try to perform test configuration

Follow the steps mentioned HERE

After I click on the logout in Drupal, it sends me back to the Drupal homepage. However, when I try to login with other user, it doesn't ask me to login but automatically logs me in with same user

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]

I purchased the paid Drupal module and replaced it with the free module, but still I am not able to use paid features.

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]

24/7 Support

The Drupal developers at miniOrange offer quick and active support for your queries. We can assist you from choosing the best solution for your use case.

 Contact us

Case Studies

miniOrange has successfully catered to the use cases of 400+ trusted customers with its highly flexible/customizable Drupal solutions.

 Read more

Other Solutions

Feel free to explore other Drupal solutions that we offer the popular solutions used by our trusted customers include 2FA, User Provisioning, Website Security.

 Know More

[MO_CONTACT_US]