socialiteproviders/apple

Apple OAuth2 Provider for Laravel Socialite

5.6.1 2023-12-06 14:43 UTC

Requires

• php: ^8.0
• ext-json: *
• ext-openssl: *
• firebase/php-jwt: ^6.8
• lcobucci/clock: ^2.0 || ^3.0
• lcobucci/jwt: ^4.1.5 || ^5.0.0
• socialiteproviders/manager: ^4.4

Suggests

• ahilmurugesan/socialite-apple-helper: Automatic Apple client key generation and management.

MIT

• Ahilan
• Vamsi Krishna V

• oauth
• provider
• apple
• laravel
• socialite
• laravel socialite
• sign in with apple
• socialite apple
• client key generator
• client key refresh
• apple client key
• apple sign in
• laravel apple

README

composer require socialiteproviders/apple

Installation & Basic Usage

Please see the Base Installation Guide, then follow the provider specific instructions below.

Add configuration to config/services.php

'apple' => [
  'client_id' => env('APPLE_CLIENT_ID'),
  'client_secret' => env('APPLE_CLIENT_SECRET'),
  'redirect' => env('APPLE_REDIRECT_URI')
],

See Configure Apple ID Authentication

Note: the client secret used for "Sign In with Apple" is a JWT token that can have a maximum lifetime of 6 months. The article above explains how to generate the client secret on demand and you'll need to update this every 6 months. To generate the client secret for each request, see Generating A Client Secret For Sign In With Apple On Each Request

Add provider event listener

Laravel 11+

In Laravel 11, the default EventServiceProvider provider was removed. Instead, add the listener using the listen method on the Event facade, in your AppServiceProvider boot method.

• Note: You do not need to add anything for the built-in socialite providers unless you override them with your own providers.

Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
    $event->extendSocialite('apple', \SocialiteProviders\Apple\Provider::class);
});

Laravel 10 or below

Configure the package's listener to listen for `SocialiteWasCalled` events.

Add the event to your listen[] array in app/Providers/EventServiceProvider. See the Base Installation Guide for detailed instructions.

protected $listen = [
    \SocialiteProviders\Manager\SocialiteWasCalled::class => [
        // ... other providers
        \SocialiteProviders\Apple\AppleExtendSocialite::class.'@handle',
    ],
];

Usage

You should now be able to use the provider like you would regularly use Socialite (assuming you have the facade installed):

return Socialite::driver('apple')->redirect();

Returned User fields

• id
• name
• email

Reference

• Apple API Reference