Download the PHP package javaabu/efaas-socialite without Composer

eFaas Laravel Socialite

Laravel Socialite Provider for eFaas.

Note: Current version of this package is based on eFaas Documentation version 2.2

• eFaas Laravel Socialite
  • Requirements
  • Installation
  • Add configuration to your .env file
  • Publishing the config file
  • Publishing migrations
  • Usage
    • Enabling PKCE
    • Logging out the eFaas User
    • Using eFaas One-tap Login
    • Implementing Front Channel Single Sign Out
    • Implementing Back Channel Single Sign Out
    • Authenticating from mobile apps
    • Changing the eFaas login prompt behaviour
    • Available Methods for eFaas Provider
    • Available Methods and Public Properties for eFaas User
    • Changing the eFaas request scopes
    • Getting eFaas data from eFaas User object
    • Available eFaas data fields
    • Scope: efaas.openid
    • Scope: efaas.profile
    • Scope: efaas.email
    • Scope: efaas.mobile
    • Scope: efaas.birthdate
    • Scope: efaas.photo
    • Scope: efaas.work_permit_status
    • Scope: efaas.passport_number
    • Scope: efaas.country
    • Scope: efaas.permanent_address
  • Testing
  • Changelog
  • Contributing
  • Security
  • Credits
  • License

Requirements

This package requires the following:

• Laravel 6.0 or higher
• PHP 7.4 or higher
• ext-openssl PHP extension

Installation

For Laravel 6.0+, you can install the package via composer:

For Laravel 5.6, use version 1.x

Add configuration to your .env file

Add the following config to your .env file

Publishing the config file

Optionally you can also publish the config file to config/efaas.php:

This is the default content of the config file:

Publishing migrations

This package ships with the migrations for an efaas_sessions table which can be used to implement back channel logout. You can publish these migrations using the following Artisan command:

After publishing the migrations, you can run them:

Usage

Note: A demo implementation of this package is available here.

You should now be able to use the provider like you would regularly use Socialite (assuming you have the facade installed): Refer to the Official Social Docs for more info.

Warning: If you get 403 Forbidden error when your Laravel app makes requests to the eFaas authorization endpoints, request NCIT to whitelist your server IP.

and in your callback handler, you can access the user data like so. Remember to save the user's id_token and sid (session id).

Enabling PKCE

By default, this package has PKCE disabled. To enable PKCE, use the enablePKCE() method in both your redirect call and the callback handler.

Logging out the eFaas User

In your Laravel logout redirect, redirect with the provider logOut() method using the id token saved during login

Note: Since the id_token can be very long, you might run into nginx errors when redirecting. To fix this you can add the following to your nginx config. More info here.

Using eFaas One-tap Login

This package will automatically add an /efaas-one-tap-login endpoint to your web routes which will redirect to eFaas with the eFaas login code.

Sometimes you may wish to customize the routes defined by the Efaas Provider. To achieve this, you first need to ignore the routes registered by Efaas Provider by adding EfaasProvider::ignoreRoutes to the register method of your application's AppServiceProvider:

Then, you may copy the routes defined by Efaas Provider in its routes file to your application's routes/web.php file and modify them to your liking:

Implementing Front Channel Single Sign Out

First, during login, in your efaas callback handler method, save the users sid (session ID) to your session.

Then, in your single sign out controller handler method, first retrieve the logout token's sid using the eFaas provider's getLogoutSid() method. The method will return null if the provided logout token is invalid. You can then compare the saved sid in your current session with the retrieved sid and logout the user if they match.

Implementing Back Channel Single Sign Out

For Back Channel Logout, you will need to use Laravel's database session driver and the provided efaas_sessions migration.

During login, save the user's sid (session ID) using the eFaas provider's sessionHandler():

Then, in your single sign out controller handler method, first retrieve the logout token's sid using the eFaas provider's getLogoutSid() method. The method will return null if the provided logout token is invalid. You can then use the eFaas provider's sessionHandler() to logout all laravel sessions that match the sid.

Authenticating from mobile apps

To authenticate users from mobile apps, redirect to the eFaas login screen through a Web View on the mobile app. Then intercept the code (authorization code) from eFaas after they redirect you back to your website after logging in to eFaas.

Once your mobile app receives the auth code, send the code to your API endpoint. You can then get the eFaas user details from your server side using the auth code as follows. Remember to use the stateless() option as the redirect had originated outside of your server:

After you receive the eFaas user, you can then issue your own access token or API key according to whatever authentication scheme you use for your API.

Changing the eFaas login prompt behaviour

The eFaas login prompt behaviour can be customized by modifying the prompt option on your redirect request

The available prompt options are:

Available Methods for eFaas Provider

Available Methods and Public Properties for eFaas User

Changing the eFaas request scopes

By default, this package adds all available scopes to the eFaas redirect. You can modify the default scopes by publishing the package config file and changing the scopes. To customize the scopes on a per request basis, you can override the scopes during the redirect.

Getting eFaas data from eFaas User object

Available eFaas data fields

Different data is associated with different scopes. By default, all scopes are included, so you should be able to get all the data fields.

Scope: efaas.openid

Scope: efaas.profile

Scope: efaas.email

Scope: efaas.mobile

Scope: efaas.birthdate

Scope: efaas.photo

Scope: efaas.work_permit_status

Scope: efaas.passport_number

Scope: efaas.country

Scope: efaas.permanent_address

Here are the fields of the EfaasAddress object:

The EfaasAddress class also has the following methods:

Testing

You can run the tests with

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Javaabu Pvt. Ltd.
• Arushad Ahmed (@dash8x)
• Mohamed Jailam
• All Contributors

License

The MIT License (MIT). Please see License File for more information.