Step 2x: Setup Apple

December 14, 2022 · View on GitHub

First you will have to register your application on Apple Developers website. Check out the documentation for more information: https://developer.apple.com/documentation/sign_in_with_apple/configuring_your_environment_for_sign_in_with_apple

Next configure a resource owner of type apple with appropriate client_id, client_secret and scope. Example scope values include:

name
email

# config/packages/hwi_oauth.yaml

hwi_oauth:
    resource_owners:
        any_name:
            type:                apple
            client_id:           <client_id>
            client_secret:       <client_secret>
            scope:               "name email"

Apple doesn't provide a ready-to-use client_secret, it has to be generated manually using a private key downloadable on Apple Developer. The generated client_secret has an expiration date, so it has to be regenerated continually. See Documentation

To overcome this inconvenience, you can configure an automatic client_secret generation as following. This requires PHP-JWT to work. (composer require firebase/php-jwt)

# config/packages/hwi_oauth.yaml

hwi_oauth:
    resource_owners:
        any_name:
            type:                apple
            client_id:           <client_id>
            client_secret:       auto
            scope:               "name email"
            options:
                auth_key:        <auth_key>
                key_id:          <key_id>
                team_id:         <team_id>

The auth key can be loaded using an environment variable processor:%env(file:resolve:APPLE_AUTH_KEY_PATH)% with APPLE_AUTH_KEY_PATH=%kernel.project_dir%/path/to/AuthKey_XXXXXXXXXX.p8 set to your .env.

When you're done. Continue by configuring the security layer or go back to setup more resource owners.