Download the PHP package mikebronner/laravel-sign-in-with-apple without Composer

Sign In With Apple for Laravel

Supporting This Package

This is an MIT-licensed open source project with its ongoing development made possible by the support of the community. If you'd like to support this, and our other packages, please consider sponsoring us via the button above.

We thank the following sponsors for their generosity, please take a moment to check them out:

• LIX

Table of Contents

• Requirements
• Installation
• Configuration
• Implementation
  • Button
  • Controller
• Testing

Requirements

• PHP 8.2+
• Laravel 10.0+
• Socialite 5.0+
• Apple Developer Subscription

Version Support

Installation

1. Install the composer package:

   We also recommend using geneaLabs/laravel-socialiter to automatically manage user resolution and persistence:

Configuration

1. Create an App ID for your website (https://developer.apple.com/account/resources/identifiers/list/bundleId) with the following details:
   • Platform: iOS, tvOS, watchOS (I'm unsure if either choice has an effect for web apps)
   • Description: (something like "example.com app id")
   • Bundle ID (Explicit): com.example.id (or something similar)
   • Check "Sign In With Apple"
2. Create a Service ID for your website (https://developer.apple.com/account/resources/identifiers/list/serviceId) with the following details:
   • Description: (something like "example.com service id")
   • Identifier: com.example.service (or something similar)
   • Check "Sign In With Apple"
   • Configure "Sign In With Apple":
     • Primary App Id: (select the primary app id created in step 1)
     • Web Domain: example.com (the domain of your web site)
     • Return URLs: https://example.com/apple-signin (the route pointing to the callback method in your controller)
     • Click "Save".
     • Click the "Edit" button to edit the details of the "Sign In With Apple" configuration we just created.
     • If you haven't verified the domain yet, download the verification file, upload it to https://example.com/.well-known/apple-developer-domain-association.txt, and then click the "Verify" button.
3. Create a Private Key for your website (https://developer.apple.com/account/resources/authkeys/list) with the following details:
   • Key Name:
   • Check "Sign In With Apple"
   • Configure "Sign In With Apple":
     • Primary App ID: (select the primary app id created in step 1)
     • Click "Save"
   • Click "Continue"
   • Click "Register"
   • Click "Download"
   • Rename the downloaded file to key.txt

4. Create your app's client secret:

   • Install the JWT Gem:

   • Create a file called client_secret.rb to process the private key:

   • Fill in the following fields:
     • team_id: This can be found on the top-right corner when logged into your Apple Developer account, right under your name.
     • client_id: This is the identifier from the Service Id created in step 2 above, for example com.example.service
     • key_id: This is the identifier of the private key created in step 3 above.
   • Save the file and run it from the terminal. It will spit out a JWT which is your client secret, which you will need to add to your .env file in the next step.

Alternative: Generate client_secret in PHP

Instead of using the Ruby script above, you can generate the client secret JWT directly in PHP using this package's built-in helper:

You can use an Artisan command or scheduled task to auto-rotate the secret before it expires:

Required env vars for fromConfig():

5. Set the necessary environment variables in your .env file:

   Note: The APPLE_LOGIN environment variable has been removed (previously SIGN_IN_WITH_APPLE_LOGIN). Login routes should be defined in your application's route files instead. See the Migration Guide below if upgrading from an older version.

Redirect URL Requirements

Apple has strict requirements for the redirect (callback) URL:

• Must use HTTPS — HTTP is rejected in production. Only http://localhost is allowed for local development.
• Must exactly match the Return URL registered in your Apple Developer account under Services ID configuration.
• No query parameters — Apple will reject URLs with query strings.
• No fragments — Hash fragments are not supported.

The package validates your redirect URL at auth initiation and throws an InvalidRedirectUrlException with a clear error message if it doesn't meet these requirements.

Common mistakes:

• Using http:// instead of https:// in production
• Having a trailing slash mismatch between config and Apple Developer Console
• Forgetting to add the URL to your Services ID in the Apple Developer portal

Implementation

Button

Add the following blade directive to your login page:

CSRF Exclusion

Apple sends the authorization response as a POST request to your callback URL. This would normally trigger a 419 | Page Expired (CSRF token mismatch) error. This package automatically excludes the configured callback route from CSRF verification, so no additional configuration is required.

This is safe because Apple callbacks are validated via the OAuth state parameter, not CSRF tokens. If you need to manually exclude the route for any reason, you can use one of these approaches:

Option A: Exclude the route in your VerifyCsrfToken middleware (Laravel 10 and earlier):

Option B: Use withoutMiddleware on the route (Laravel 11+):

Controller

This implementation uses Socialite to get the login credentials. The following is an example implementation of the controller:

Note that when processing the returned $user object, it is critical to know that the sub element is the unique identifier for the user, NOT the email address. For more details, visit https://developer.apple.com/documentation/signinwithapplerestapi/authenticating_users_with_sign_in_with_apple.

Missing Authorization Code

If you receive an error about a missing authorization code in the callback, check:

1. Your callback route must accept POST requests — Apple uses response_mode=form_post, which means the authorization code is sent as a POST form parameter, not a URL query parameter. Use Route::post(), not Route::get().

2. CSRF protection must be disabled for the callback — Since Apple's POST doesn't include a CSRF token, Laravel will return a 419 error and the code will never reach your controller. See the CSRF Exclusion section above.

3. The redirect URL must exactly match — The URL in your .env (APPLE_REDIRECT) must exactly match the Return URL configured in your Apple Developer account, including the protocol, domain, and path.

Handling Revoked Access

When a user revokes your app's access via Apple ID settings, Apple sends a server-to-server notification. This package provides an AppleNotificationController and AppleAccessRevoked event to handle this.

1. Register the notification route:

2. Listen for the revocation event:

3. Configure the endpoint in Apple Developer:

Add your notification URL (https://example.com/apple/notifications) in the Apple Developer portal under your Services ID configuration.

Important: Apple only provides the user's name and email on the first authorization. If a user revokes access and re-authenticates, Apple treats it as a new sign-in but may not provide the name again. Always store the user's name on first sign-in.

Handling re-authentication after revocation:

When a user revokes and re-authenticates, Apple may assign a new sub value. The Socialite user object includes an is_returning_user flag to help you detect this:

Security: The notification endpoint verifies Apple's JWT signatures against Apple's public keys (fetched from https://appleid.apple.com/auth/keys). Keys are cached for 1 hour. Unsigned or forged notifications are rejected.

Testing

This package includes unit, feature, and browser tests. Unit and feature tests run without any additional dependencies:

Browser Tests

Browser tests use Laravel Dusk via orchestra/testbench-dusk and require a Chrome-based browser installed on your machine.

Install Chrome or Chromium:

• Google Chrome (recommended):

• Chromium (lighter alternative):

  On macOS, Chromium may be blocked by Gatekeeper. Remove the quarantine flag after installing:

Install Chromedriver:

The package uses orchestra/dusk-updater (included as a dev dependency) to manage the Chromedriver binary. Run this to auto-detect your Chrome version and install the matching Chromedriver:

Run browser tests:

Run all tests:

Migration Guide

Upgrading from versions prior to the config update

The configuration has been simplified. The following changes were made:

Steps to upgrade:

1. Remove SIGN_IN_WITH_APPLE_LOGIN from your .env file.
2. Rename env vars: SIGN_IN_WITH_APPLE_REDIRECT → APPLE_REDIRECT, SIGN_IN_WITH_APPLE_CLIENT_ID → APPLE_CLIENT_ID, SIGN_IN_WITH_APPLE_CLIENT_SECRET → APPLE_CLIENT_SECRET. The old names continue to work as fallbacks.
3. If you relied on the login config key for the @signInWithApple Blade directive button URL, define the route in your application's routes file and update the directive or link accordingly.
4. The package will emit a E_USER_DEPRECATED notice if the old login key is still present, giving you time to migrate before it is fully removed.

Credits

1. https://developer.okta.com/blog/2019/06/04/what-the-heck-is-sign-in-with-apple
2. https://developer.apple.com/sign-in-with-apple/get-started

Commitment to Quality

During package development I try as best as possible to embrace good design and development practices, to help ensure that this package is as good as it can be. My checklist for package development includes:

• ✅ Achieve as close to 100% code coverage as possible using unit tests.
• ✅ Eliminate any issues identified by SensioLabs Insight and Scrutinizer.
• ✅ Be fully PSR1, PSR2, and PSR4 compliant.
• ✅ Include comprehensive documentation in README.md.
• ✅ Provide an up-to-date CHANGELOG.md which adheres to the format outlined at http://keepachangelog.com.
• ✅ Have no PHPMD or PHPCS warnings throughout all code.

Troubleshooting

invalid_client Error

This means Apple rejected your credentials. Common causes:

• Wrong Client ID: APPLE_CLIENT_ID must be your Services ID (not your App ID or Team ID).
• Wrong Client Secret: The JWT must be signed with the correct private key, team ID, and key ID.
• Key revoked: Check that your key is still active in your Apple Developer account under Keys.

invalid_grant Error

This means the authorization code was rejected. Common causes:

• Code already used: Apple authorization codes are single-use. If you refresh the callback page, the code will be invalid.
• Code expired: Codes are valid for a short time (approximately 5 minutes).
• Redirect URI mismatch: The APPLE_REDIRECT must exactly match the URL registered in your Apple Developer account.
• Client secret expired: Apple client secret JWTs are valid for up to 6 months. Regenerate if expired.

Missing Configuration

If you see Sign In With Apple is missing required config, ensure you have set the following in your .env:

Contributing

Please observe and respect all aspects of the included Code of Conduct.

Reporting Issues

When reporting issues, please fill out the included template as completely as possible. Incomplete issues may be ignored or closed if there is not enough information included to be actionable.

Submitting Pull Requests

Please review the Contribution Guidelines. Only PRs that meet all criterium will be accepted.

If you ❤️ open-source software, give the repos you use a ⭐️.

We have included the awesome symfony/thanks composer package as a dev dependency. Let your OS package maintainers know you appreciate them by starring the packages you use. Simply run composer thanks after installing this package. (And not to worry, since it's a dev-dependency it won't be installed in your live environment.)