Login O Auth2 Apple Plugin

This README.md file should be modified to describe the features, installation, configuration, and general usage of this plugin.

The Login O Auth2 Apple Plugin is for Grav CMS. OAuth2 Provider for Apple

Installation

Installing the Login O Auth2 Apple plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.

GPM Installation (Preferred)

The simplest way to install this plugin is via the Grav Package Manager (GPM) through your system's terminal (also called the command line). From the root of your Grav install type:

bin/gpm install login-oauth2-apple

This will install the Login O Auth2 Apple plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/login-oauth2-apple.

Manual Installation

To install this plugin, just download the zip version of this repository and unzip it under /your/site/grav/user/plugins. Then, rename the folder to login-oauth2-apple. You can find these files on GitHub or via GetGrav.org.

You should now have all the plugin files under

/your/site/grav/user/plugins/login-oauth2-apple

NOTE: This plugin is a modular component for Grav which requires Grav and the Error and Problems to operate.

Admin Plugin

If you use the admin plugin, you can install directly through the admin plugin by browsing the Plugins tab and clicking on the Add button.

Configuration

Before configuring this plugin, you should copy the user/plugins/login-oauth2-apple/login-oauth2-apple.yaml to user/config/plugins/login-oauth2-apple.yaml and only edit that copy.

Here is the default configuration and an explanation of available options:

enabled: true

Note that if you use the admin plugin, a file with your configuration, and named login-oauth2-apple.yaml will be saved in the user/config/plugins/ folder once the configuration is saved in the admin.

Obtain Certificates / IDs / Keys

There is a good guide here about how to obtain step-by-step the necessary ids/keys for the Apple Login.

Below a quick summary of all the steps necessary:

1. Log into https://developer.apple.com
2. head to Account -> Certificates, IDs & Profiles
3. From the Identifiers sidebar item, click the + button to Register a new identifier:
   1. Select App IDs (if it's not already set), then Continue
   2. Click App and Continue
   3. Add a Description: e.g. Grav OAuth 2
   4. Set Bundle ID: e.g. org.getgrav.oauth2 (Explicit)
   5. Check Sign In with Apple from the list below
   6. Configure and pick Enable as a primary App ID (if not already set)
   7. Click Continue and then Register
4. Still in the Identifier tab, switch to Services IDs from the top right dropdown
   1. Click Register a Service ID
   2. Select the Services IDs radio button (if not already set), then Continue
   3. Add a Description: e.g.:My Grav Site
   4. Pick an Identifier: this will be your Client ID, e.g.: org.getgrav.oauth2.client
   5. Click Continue then Register
   6. Open this Service ID again, then Enable Sign In With Apple
   7. Click Configure
      1. Add your domain site by following instructions for verification. You will be required to download a certificate to prove you are the owner of the site (e.g.: yourdomain.com)
      2. Add the callback URL (ie, http://yourdomain.com/task:callback.oauth2)
   8. Click Continue and then Register
5. Click Keys in the main sidebar
   1. Click the + button to Create a Key
   2. Key Name: Grav OAuth 2
   3. Select Sign in with Apple
   4. Click on Configure on the far right and select the App ID previously created: org.getgrav.oauth2
   5. Click Continue and then Register
   6. Follow the directions. Make sure you download the key and place it under user/data/oauth2/apple/
   7. NOTE: Make sure you save this key, you will not be able to download it again
   8. NOTE: Do not rename the key, place it in the grav user/data location as-is

Fullname Support

To be able to use the user's fullname, you must enable save_grav_user in the Login OAauth2 plugin. This is because Apple only sends the username information when first logging in. You will need to navigate to the users' Apple account then click on Sign in with Apple and then click the Stop using Sign in with Apple button. This will force a 'first-time' login and will resend the full name when next logging in.

Credits

This plugin is made possible thanks to the oauth2-apple integration by patrickbussmann/oauth2-apple