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

Step 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]:
     
      > http://localhost/oauth2_client/callback.php
      
    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');
    

• Now you can connect OAuth client with Laravel Passport (OAuth Provider) and the following endpoints are:

Authorization endpoint:	http://your-laravel-site-url/oauth/authorize
Token endpoint:	http://your-laravel-site-url/oauth/token
User info endpoint:	http://your-laravel-site-url/api/user/get

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

Step 2: Setup WordPress as OAuth Client

• Go to Configure OAuth tab and configure App Name, Client ID, Client Secret from provided Endpoints.
• Click on Save Settings to save the configuration.

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

Step 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.

• You will see all the values returned by OAuth Provider to WordPress in a test configuration table. If you don't see a value for First Name, Last Name, Email, or Username, make the required settings in your OAuth Provider to return this information.

• Once you see all the values in Test Configuration, go to Attribute / Role Mapping tab, select attributes from Username dropdown and click on Save.

Step 4: Login Settings / Sign In Settings.

• The settings in SSO Settings tab define the user experience for Single Sign On. To add a login widget on your WordPress page, you need to follow below steps.

Sign In Settings

• Go to WordPress Left Panel > Appearances > Widgets.
• Select miniOrange OAuth. Drag and drop to your favourite location and save.

• Open your WordPress page and you can see the login button there. You can test the SSO now.

Additional Resources

• What is OAuth 2.0?
• Laravel Passport as OAuth Provider / OpenID Connect
• Frequently Asked Questions (FAQs)