Question: Laravel - force logout of specific user by user id

Question

Laravel - force logout of specific user by user id

Answers 1
Added at 2017-01-03 10:01
Tags
Question

I use Laravel 5.2.

I want to know how can I force a user to logout by id?

I'm building an admin panel with the option to dis-active specific user that are currently logged in to the web application.

Laravel gives you the this option for current user:

Auth::logout()

But I don't want to logout the current user, as I am that Auth user. I need to force logout a specific user by its id. Just like when we login a user with specific id:

Auth::loginUsingId($id);

Is there something like this:

Auth::logoutUsingId($id);
Answers to

Laravel - force logout of specific user by user id

nr: #1 dodano: 2017-01-03 11:01

Currently, there's no straightforward way to do this; As the StatefulGuard contract and its SessionGuard implementation don't offer a logoutUsingId() as they do for login.

You need to add a new field to your users table and set it to true when you want a specific user to be logged out. Then use a middleware to check if the current user needs a force logout.

Here's a quick implementation.

1. Add a new field

Let's add a new field to users table migration class:

<?php

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class CreateUsersTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('users', function (Blueprint $table) {
            // ...
            $table->boolean('logout')->default(false);
            // other fields...
        });
    }

    // ...
}

Make sure you run php artisan migrate:refresh [--seed] after changing the migration.

2. Force logout middleware

Let's create a new middleware:

php artisan make:middleware LogoutUsers

Here's the logic to check if a user needs to be kicked out:

<?php

namespace App\Http\Middleware;

use Auth;
use Closure;

class LogoutUsers
{
    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        $user = Auth::user();

        // You might want to create a method on your model to
        // prevent direct access to the `logout` property. Something
        // like `markedForLogout()` maybe.
        if (! empty($user->logout)) {
            // Not for the next time!
            // Maybe a `unmarkForLogout()` method is appropriate here.
            $user->logout = false;
            $user->save();

            // Log her out
            Auth::logout();

            return redirect()->route('login');
        }

        return $next($request);
    }
}

3. Register the middleware in HTTP kernel

Open up the app/Http/Kernel.php and add your middleware's FQN:

/**
 * The application's route middleware groups.
 *
 * @var array
 */
protected $middlewareGroups = [
    'web' => [
        \App\Http\Middleware\EncryptCookies::class,
        \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
        \Illuminate\Session\Middleware\StartSession::class,
        \Illuminate\View\Middleware\ShareErrorsFromSession::class,
        \App\Http\Middleware\VerifyCsrfToken::class,
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
        \App\Http\Middleware\LogoutUsers::class, // <= Here
    ],

    'api' => [
        'throttle:60,1',
        'bindings',
    ],
];

It's untested code, but it should give you the idea. It'd be a good practice to add a couple of API methods to your User model to accompany with this functionality:

  • markedForLogout() : Checks user's logout flag.
  • markForLogout() : Sets user's logout flag to true.
  • unmarkForLogout() : Sets user's logout flag to false.

Then on the administration side (I suppose it's your case), you just need to call markForLogout() on the specific user model to kick him out on the next request. Or you can utilize the query builder to set the flag, if the model object is not available:

User::where('id', $userId)
    ->update(['logout' => true]);

It can be a markForLogoutById($id) method.

Related discussions
[Proposal] Log out users by ID
Multiple statements when logged users are deleted

Source Show
◀ Wstecz