Laravel Passport OAuth & OpenID connect Single Sign-On (SSO) | Laravel Passport SSO Login

Laravel Passport OAuth & OpenID connect Single Sign-On (SSO) | Laravel Passport SSO Login


WordPress OAuth & OpenID Connect Single Sign-On (SSO) plugin enables secure login into WordPress using Laravel Passport as OAuth and OpenID Connect provider. You can also configure plugin using different custom providers and standard IDPs. It supports advanced Single Sign-On (SSO) features such as user profile Attribute mapping, Role mapping, etc. Here we will go through a guide to configure SSO between WordPress and Laravel Passport. By the end of this guide, users should be able to login to WordPress from Laravel Passport. To know more about other features we provide in WP OAuth Single Sign-On ( OAuth & OpenID Connect Client ) plugin, you can click here.

Pre-requisites : Download And Installation


  • Log into your WordPress instance as an admin.
  • Go to the WordPress Dashboard -> Plugins and click on Add New.
  • Search for a WordPress OAuth Single Sign-On (SSO) plugin and click on Install Now.
  • Once installed click on Activate.

Steps to configure Laravel Passport Single Sign-On (SSO) Login into WordPress

1. Setup Laravel Passport as OAuth Provider

  • Create a laravel project on your local machine using command and set it up:
  • composer create-project --prefer-dist laravel/laravel blog

  • Change the directory to blog using cd blog command. Install laravel passport
  • composer require laravel/passport

  • Go to config/app.php and add below provider
  • Laravel\Passport\PassportServiceProvider::class

  • Run php artisan migrate command
  • Run php artisan passport:install command
  • Go to app/User.php model class, add HasApiTokens trait to the code:
  • 
         
        namespace App;
        use Laravel\Passport\HasApiTokens;
        use Illuminate\Contracts\Auth\MustVerifyEmail;
        use Illuminate\Foundation\Auth\User as Authenticatable;
        use Illuminate\Notifications\Notifiable;
         
        class User extends Authenticatable
        {
          use HasApiTokens, Notifiable;
         
          
            /**
             * The attributes that are mass assignable.
             *
             * @var array
            */
            protected $fillable = [
                'name', 'email', 'password',
            ];
         
            /**
             * The attributes that should be hidden for arrays.
             *
             * @var array
             */
            protected $hidden = [
                'password', 'remember_token',
            ];
         
            /**
             * The attributes that should be cast to native types.
             *
             * @var array
             */
           
            protected $casts = [
                'email_verified_at' => 'datetime',
            ];
        }
        
        
        
  • Go to app/Providers/AuthServiceProvider.php, add use Laravel\Passport\Passport; , Passport::routes(); routes to the service code is given below:
  •     
        namespace App\Providers;
        use Laravel\Passport\Passport;
        use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
        use Illuminate\Support\Facades\Gate;
         
        class AuthServiceProvider extends ServiceProvider
        {
        
            /**
             * The policy mappings for the application.
             *
             * @var array
             */
            protected $policies = [
                // 'App\Model' => 'App\Policies\ModelPolicy',
            ];
         
            /**
             * Register any authentication / authorization services.
             *
             * @return void
             */
            public function boot()
            {
                $this->registerPolicies();
                Passport::routes();
                //
            }
        }
        
  • Go to config/auth.php change the api driver token to passport as we are going to use Passport library.
  • 
        'guards' => [
                'web' => [
                    'driver' => 'session',
                    'provider' => 'users',
                ],
                'api' => [
                    'driver' => 'passport',
                    'provider' => 'users',
                    'hash' => false,
                ],
            ],
        
  • To get Client ID and Client Secret run following commands: php artisan passport:client It will ask you the following questions:
  • 
         Which user ID should the client be assigned to?:
         > 1
         
         What should we name the client?
         > Demo OAuth2 Client Account
         
         Where should we redirect the request after authorization?
         [http://localhost/auth/callback]
         
        > Click Here to copy the Redirect URL.
          
        New client created successfully.
        
        Client ID: 1
        Client secret: zMm0tQ9Cp7LbjK3QTgPy1pssoT1X0u7sg0YWUW01
        

  • To create a UserInfo endpoint manually, in the app/Http/Controllers, create a file UserController.php:
  • 
        <?php
        namespace App\Http\Controllers;
        use App\Http\Controllers\Controller;
        use Illuminate\Http\Request;
        use App\Models\User;
        use Auth;
        class UserController extends Controller
        {
            public function get(Request $request)
            {
              $user_id = Auth::id();
              $user = User::find($user_id);
              return $user;
            }
        }
        
  • Also, register the API route by adding the below line in routes/api.php file:
  • 
        //For Laravel below 8 and migrated to the 8 version:
        Route::middleware('auth:api')->get('/user/get', 'UserController@get');
         

    OR

    
        //For Laravel 8 new users:
        use App\Http\Controllers\UserController;                                                                       
         Route::middleware('auth:api')->get('/user/get', 'App\Http\Controllers\UserController@get');
        

You have successfully configured Laravel Passport as OAuth Provider for achieving Laravel Passport login into your WordPress Site.


2. Setup WordPress as OAuth Client

  • Go to Configure OAuth tab and configure App Name, Client ID, Client Secret from provided Endpoints.
  • Please refer the below table for configuring the scope & endpoints for Laravel Passport in the plugin.


    Client ID : from the step 3 above
    Client Secret : from the step 3 above
    Scope: auto
    Authorize Endpoint: http://your-laravel-site-url/oauth/authorize
    Access Token Endpoint: http://your-laravel-site-url/oauth/token
    Get User Info Endpoint: http://your-laravel-site-url/api/user/get
  • Click on Save Settings to save the configuration.
  • Laravel Passport Single Sign-On (SSO) OAuth/OpenID WordPress configure-endpoints

You have successfully configured WordPress as OAuth Client for achieving Laravel Passport login into your WordPress Site.


3. User Attribute Mapping

  • User Attribute Mapping is mandatory for enabling users to successfully login into WordPress. We will be setting up user profile attributes for WordPress using below settings.
  • Finding user attributes

    • Go to Configure OAuth tab. Scroll down and click on Test Configuration.
    • Laravel Passport Single Sign-On (SSO) OAuth/OpenID WordPress test congifuration
    • You will see all the values returned by your OAuth Provider to WordPress in a table. If you don't see value for First Name, Last Name, Email or Username, make the required settings in your OAuth Provider to return this information.
    • Laravel Passport Single Sign-On (SSO) OAuth/OpenID WordPress test congifuration result
    • Once you see all the values in Test Configuration, go to Attribute / Role Mapping tab, you will get the list of attributes in a Username dropdown.
    • Laravel Passport Single Sign-On (SSO) OAuth/OpenID WordPress attribute/role mapping

4: Role Mapping [Premium]

  • Click on “Test Configuration” and you will get the list of Attribute Names and Attribute Values that are sent by your OAuth provider.
  • From the Test Configuration window, map the Attribute Names in the Attribute Mapping section of the plugin. Refer to the screenshot for more details.
  • Laravel Passport Single Sign-On (SSO) - attribute mapping
  • Enable Role Mapping: To enable Role Mapping, you need to map Group Name Attribute. Select the attribute name from the list of attributes which returns the roles from your provider application.
    Eg: Role

  • Laravel Passport Single Sign-On (SSO) - test configuration - role mapping
  • Assign WordPress role to the Provider role: Based on your provider application, you can allocate the WordPress role to your provider roles. It can be a student, teacher, administrator or any other depending on your application. Add the provider roles under Group Attribute Value and assign the required WordPress role in front of it under WordPress Role.

    For example, in the below image. Teacher has been assigned the role of Administrator & Student is assigned the role of Subscriber.
  • Laravel Passport Single Sign-On (SSO) - test configuration - role mapping
  • Once you save the mapping, the provider role will be assigned the WordPress administrator role after SSO.
    Example: As per the given example, Users with role ‘teacher’ will be added as Administrator in WordPress and ‘student’ will be added as Subscriber.

5: Login Settings / Sign In Settings

  • The settings in Single Sign-On (SSO) Settings tab define the user experience for Single Sign-On (SSO). To add a Laravel Passport login widget on your WordPress page, you need to follow the below steps.
  • 1. Sign in settings for wordpress 5.7 and before :

    • Go to WordPress Left Panel > Appearances > Widgets.
    • Select miniOrange OAuth. Drag and drop to your favourite location and save.
    • Laravel Passport Single Sign-On (SSO) OAuth/OpenID WordPress create-newclient login button setting

    2. Sign in settings for wordpress 5.8 :

    • Go to WordPress Left Panel > Appearances > Widgets.
    • Select miniOrange OAuth. Drag and drop to your favourite location and save.
    • Laravel Passport Single Sign-On (SSO) OAuth/OpenID WordPress create-newclient login button setting
    • Open your WordPress page and you can see the Laravel Passport SSO login button there. You can test the Laravel Passport Single Sign-On (SSO) now.
In this Guide, you have successfully configured Laravel Passport Single Sign-On (SSO) by configuring Laravel Passport as OAuth Provider and WordPress as OAuth Client using our WP OAuth Single Sign-On ( OAuth & OpenID Connect Client ) plugin. This solution ensures that you are ready to roll out secure access to your WordPress site using Laravel Passport login credentials within minutes.


Additional Resources


Mail us on oauthsupport@xecurify.com for quick guidance(via email/meeting) on your requirement and our team will help you to select the best suitable solution/plan as per your requirement.

Hello there!

Need Help? We are right here!

support
Contact miniOrange Support
success

Thanks for your inquiry.

If you dont hear from us within 24 hours, please feel free to send a follow up email to info@xecurify.com