Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

respectively custom session guard #540

Closed
wants to merge 1 commit into from
Closed

Conversation

taxusorg
Copy link

@taxusorg taxusorg commented Nov 1, 2024

When multiple guard users use the sanctum driver, there is a problem that session users are confused.

Example:

config/auth.php

'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],
        'api' => [
            'driver' => 'sanctum',
            'provider' => 'users',
        ],
        'admin' => [
            'driver' => 'session',
            'provider' => 'admins',
        ],
        'admin-api' => [
            'driver' => 'sanctum',
            'provider' => 'admins',
        ],
    ],

config/sanctum.php

'guard' => [
        'web',
        'admin',
    ],

Now login admin guard user, and print all guard user

routes/api.php

Route::get('user', function () {
    $webUser = auth('web')->user();
    $webApiUser = auth('api')->user();
    $adminUser = auth('admin')->user();
    $adminApiUser = auth('admin-api')->user();
    dd(
        'web: ' . ($webUser ? $webUser::class . "[{$webUser['id']}]" : null),
        'api: ' . ($webApiUser ? $webApiUser::class . "[{$webApiUser['id']}]" : null),
        'admin: ' . ($adminUser ? $adminUser::class . "[{$adminUser['id']}]" : null),
        'admin-api: ' . ($adminApiUser ? $adminApiUser::class . "[{$adminApiUser['id']}]" : null),
    );
});

result: api guard return admin user

"web: " // routes\api.php:10
"api: App\Models\Admin[1]" // routes\api.php:10
"admin: App\Models\Admin[1]" // routes\api.php:10
"admin-api: App\Models\Admin[1]" // routes\api.php:10

For this we need to check the type of user or add middleware to fix the problem, but this is not a good idea.

New auth config like:

'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],
        'api' => [
            'driver' => 'sanctum',
            'with_guard' => 'web',
            'provider' => 'users',
        ],
        'admin' => [
            'driver' => 'session',
            'provider' => 'admins',
        ],
        'admin-api' => [
            'driver' => 'sanctum',
            'with_guard' => ['admin'],
            'provider' => 'admins',
        ],
    ],

sanctum driver need to know which guard can be scanned, private, not global.

If there no with_guard field or with_guard is null, driver will use old rules.

@taylorotwell
Copy link
Member

Thanks for your pull request to Laravel!

Unfortunately, I'm going to delay merging this code for now. To preserve our ability to adequately maintain the framework, we need to be very careful regarding the amount of code we include.

If applicable, please consider releasing your code as a package so that the community can still take advantage of your contributions!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants