socialiteproviders/harid

HarID OAuth2 Provider for Laravel Socialite

4.0.0 2021-11-04 04:45 UTC

Requires

• php: ^7.2 || ^8.0
• ext-json: *
• socialiteproviders/manager: ~4.0

MIT

• Pjotr Savitski

• oauth
• provider
• laravel
• socialite
• harid

README

composer require socialiteproviders/harid

Installation & Basic Usage

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

Add configuration to config/services.php

'harid' => [
  'client_id' => env('HARID_CLIENT_ID'),
  'client_secret' => env('HARID_CLIENT_SECRET'),
  'redirect' => env('HARID_REDIRECT_URI'),
  'use_test_idp' => false,
],

Please note that use_test_idp could be omitted and would default to false.

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('harid', \SocialiteProviders\HarID\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\HarID\HarIDExtendSocialite::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('harid')->redirect();

Default scopes are set to openid profile email session_type. Additional scopes could be personal_code, roles and custodies. Please see the HarID documentation for specifications. If you really want to add some additional scopes or replace the default ones, then please read the documentation.

Returned User fields

• id
• nickname - will have the value of sub and should probably be kept secret
• name
• email
• avatar - will be set to an empty string because HarID does not provide any images

Additional HarID specific data

• given_name
• family_name
• email_verified
• strong_session
• ui_locales

Those are stored within the user parameter and could be checked for using offsetExists($name) and fetched using offsetGet($name).