Sanctum

简介

Laravel Sanctum 为 SPA（单页应用）、移动应用和简单的基于令牌的 API 提供轻量级认证系统。Sanctum 允许应用的每个用户为其账户生成多个 API 令牌。这些令牌可以被授予能力/作用域，用于指定令牌允许执行的操作。

典型应用场景：

• API 令牌管理 — 在账户设置页面为用户生成和管理个人访问令牌
• 令牌权限控制 — 通过 abilities 限制令牌可执行的操作范围
• SPA 认证 — 使用 Cookie 会话认证单页应用，无需 OAuth 复杂性
• 移动端认证 — 为移动应用颁发 API 令牌进行接口认证
• 路由保护 — 使用 sanctum 守卫保护 API 路由
• 令牌撤销与过期 — 管理令牌生命周期，撤销或过期无效令牌

工作原理

Laravel Sanctum 的存在是为了解决两个独立的问题。让我们在深入该库之前分别讨论它们。

API 令牌

首先，Sanctum 是一个简单的包，你可以用它向用户颁发 API 令牌，而无需 OAuth 的复杂性。此功能受 GitHub 和其他颁发"个人访问令牌"的应用启发。例如，想象你的应用的"账户设置"中有一个页面，用户可以在那里为其账户生成 API 令牌。你可以使用 Sanctum 来生成和管理这些令牌。这些令牌通常有很长的过期时间（数年），但用户可以随时手动撤销。

Laravel Sanctum 通过在单个数据库表中存储用户 API 令牌，并通过 Authorization 请求头（应包含有效的 API 令牌）认证传入的 HTTP 请求来提供此功能。

SPA 认证

其次，Sanctum 的存在是为了提供一种简单的方式来认证需要与 Laravel 驱动的 API 通信的单页应用（SPA）。这些 SPA 可能与你的 Laravel 应用在同一仓库中，也可能是一个完全独立的仓库，例如使用 Next.js 或 Nuxt 创建的 SPA。

对于此功能，Sanctum 不使用任何类型的令牌。相反，Sanctum 使用 Laravel 内置的基于 Cookie 的会话认证服务。通常，Sanctum 利用 Laravel 的 web 认证守卫来实现这一点。这提供了 CSRF 保护、会话认证的好处，同时防止认证凭据通过 XSS 泄露。

Sanctum 只会在传入请求来自你自己的 SPA 前端时尝试使用 Cookie 进行认证。当 Sanctum 检查传入的 HTTP 请求时，它会首先检查认证 Cookie，如果不存在，Sanctum 会检查 Authorization 请求头中的有效 API 令牌。

安装

你可以通过 install:api Artisan 命令安装 Laravel Sanctum：

php artisan install:api

接下来，如果你计划使用 Sanctum 来认证 SPA，请参阅本文档的 SPA 认证 部分。

配置

覆盖默认模型

虽然通常不需要，但你可以自由扩展 Sanctum 内部使用的 PersonalAccessToken 模型：

use Laravel\Sanctum\PersonalAccessToken as SanctumPersonalAccessToken;

class PersonalAccessToken extends SanctumPersonalAccessToken
{
    // ...
}

然后，你可以通过 Sanctum 提供的 usePersonalAccessTokenModel 方法指示 Sanctum 使用你的自定义模型。通常，你应该在应用的 AppServiceProvider 文件的 boot 方法中调用此方法：

use App\Models\Sanctum\PersonalAccessToken;
use Laravel\Sanctum\Sanctum;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    Sanctum::usePersonalAccessTokenModel(PersonalAccessToken::class);
}

API 令牌认证

颁发 API 令牌

Sanctum 允许你颁发可用于认证应用 API 请求的 API 令牌/个人访问令牌。使用 API 令牌发起请求时，令牌应作为 Bearer 令牌包含在 Authorization 请求头中。

要开始为用户颁发令牌，你的 User 模型应该使用 Laravel\Sanctum\HasApiTokens trait：

use Laravel\Sanctum\HasApiTokens;

class User extends Authenticatable
{
    use HasApiTokens, HasFactory, Notifiable;
}

要颁发令牌，你可以使用 createToken 方法。createToken 方法返回一个 Laravel\Sanctum\NewAccessToken 实例。API 令牌在存储到数据库之前使用 SHA-256 哈希进行散列，但你可以通过 NewAccessToken 实例的 plainTextToken 属性访问令牌的纯文本值。你应该在令牌创建后立即向用户显示此值：

use Illuminate\Http\Request;

Route::post('/tokens/create', function (Request $request) {
    $token = $request->user()->createToken($request->token_name);

    return ['token' => $token->plainTextToken];
});

你可以使用 HasApiTokens trait 提供的 tokens Eloquent 关系访问用户的所有令牌：

foreach ($user->tokens as $token) {
    // ...
}

令牌能力

Sanctum 允许你为令牌分配"能力"。能力的作用类似于 OAuth 的"作用域"。你可以将字符串能力数组作为第二个参数传递给 createToken 方法：

return $user->createToken('token-name', ['server:update'])->plainTextToken;

在处理由 Sanctum 认证的传入请求时，你可以使用 tokenCan 或 tokenCant 方法确定令牌是否具有给定能力：

if ($user->tokenCan('server:update')) {
    // ...
}

if ($user->tokenCant('server:update')) {
    // ...
}

令牌能力中间件

Sanctum 还包含两个中间件，可用于验证传入请求是否使用已被授予给定能力的令牌进行认证。要开始使用，请在应用的 bootstrap/app.php 文件中定义以下中间件别名：

use Laravel\Sanctum\Http\Middleware\CheckAbilities;
use Laravel\Sanctum\Http\Middleware\CheckForAnyAbility;

->withMiddleware(function (Middleware $middleware): void {
    $middleware->alias([
        'abilities' => CheckAbilities::class,
        'ability' => CheckForAnyAbility::class,
    ]);
})

abilities 中间件可以分配给路由，以验证传入请求的令牌是否具有所有列出的能力：

Route::get('/orders', function () {
    // Token has both "check-status" and "place-orders" abilities...
})->middleware(['auth:sanctum', 'abilities:check-status,place-orders']);

ability 中间件可以分配给路由，以验证传入请求的令牌是否具有列出的能力中的至少一个：

Route::get('/orders', function () {
    // Token has the "check-status" or "place-orders" ability...
})->middleware(['auth:sanctum', 'ability:check-status,place-orders']);

第一方 UI 发起的请求

为方便起见，如果传入的已认证请求来自你的第一方 SPA 并且你正在使用 Sanctum 内置的 SPA 认证，tokenCan 方法将始终返回 true。

然而，这并不一定意味着你的应用必须允许用户执行该操作。通常，你应用的授权策略将确定令牌是否已被授予执行能力的权限，并检查用户实例本身是否应该被允许执行该操作。

例如，如果我们想象一个管理服务器的应用，这可能意味着检查令牌是否被授权更新服务器并且该服务器属于该用户：

return $request->user()->id === $server->user_id &&
       $request->user()->tokenCan('server:update')

起初，允许 tokenCan 方法被调用并且对第一方 UI 发起的请求始终返回 true 可能看起来很奇怪；然而，能够始终假设 API 令牌可用并且可以通过 tokenCan 方法检查是很方便的。通过采用这种方法，你可以始终在应用的授权策略中调用 tokenCan 方法，而无需担心请求是从应用的 UI 触发的还是由 API 的第三方消费者发起的。

保护路由

要保护路由使所有传入请求都必须经过认证，你应该在 routes/web.php 和 routes/api.php 路由文件中将 sanctum 认证守卫附加到受保护的路由。此守卫将确保传入请求要么作为有状态的、Cookie 认证的请求进行认证，要么在请求来自第三方时包含有效的 API 令牌请求头。

你可能想知道为什么我们建议你使用 sanctum 守卫来认证应用 routes/web.php 文件中的路由。请记住，Sanctum 会首先尝试使用 Laravel 通常的会话认证 Cookie 来认证传入请求。如果该 Cookie 不存在，Sanctum 将尝试使用请求 Authorization 请求头中的令牌来认证请求。此外，使用 Sanctum 认证所有请求确保我们始终可以在当前已认证的用户实例上调用 tokenCan 方法：

use Illuminate\Http\Request;

Route::get('/user', function (Request $request) {
    return $request->user();
})->middleware('auth:sanctum');

撤销令牌

你可以通过使用 Laravel\Sanctum\HasApiTokens trait 提供的 tokens 关系从数据库中删除令牌来"撤销"它们：

// Revoke all tokens...
$user->tokens()->delete();

// Revoke the token that was used to authenticate the current request...
$request->user()->currentAccessToken()->delete();

// Revoke a specific token...
$user->tokens()->where('id', $tokenId)->delete();

令牌过期

默认情况下，Sanctum 令牌永不过期，只能通过撤销令牌来使其失效。但是，如果你想为应用的 API 令牌配置过期时间，可以通过应用 sanctum 配置文件中定义的 expiration 配置选项来实现。此配置选项定义了颁发的令牌被视为过期之前的分钟数：

'expiration' => 525600,

如果你想独立指定每个令牌的过期时间，可以通过将过期时间作为第三个参数传递给 createToken 方法来实现：

return $user->createToken(
    'token-name', ['*'], now()->plus(weeks: 1)
)->plainTextToken;

如果你已为应用配置了令牌过期时间，你可能还想计划任务来清理应用中已过期的令牌。值得庆幸的是，Sanctum 包含一个 sanctum:prune-expired Artisan 命令，你可以用它来完成此操作。例如，你可以配置一个计划任务来删除所有已过期至少 24 小时的令牌数据库记录：

use Illuminate\Support\Facades\Schedule;

Schedule::command('sanctum:prune-expired --hours=24')->daily();

SPA 认证

Sanctum 的存在也是为了提供一种简单的方法来认证需要与 Laravel 驱动的 API 通信的单页应用（SPA）。这些 SPA 可能与你的 Laravel 应用在同一仓库中，也可能是一个完全独立的仓库。

对于此功能，Sanctum 不使用任何类型的令牌。相反，Sanctum 使用 Laravel 内置的基于 Cookie 的会话认证服务。这种认证方法提供了 CSRF 保护、会话认证的好处，同时防止认证凭据通过 XSS 泄露。

配置

配置第一方域名

首先，你应该配置 SPA 将从哪些域发起请求。你可以使用 sanctum 配置文件中的 stateful 配置选项来配置这些域。此配置设置确定哪些域在向 API 发起请求时将使用 Laravel 会话 Cookie 维护"有状态"认证。

为了帮助你设置第一方有状态域名，Sanctum 提供了两个辅助函数，你可以将它们包含在配置中。首先，Sanctum::currentApplicationUrlWithPort() 将从 APP_URL 环境变量返回当前应用 URL，而 Sanctum::currentRequestHost() 将在有状态域名列表中注入一个占位符，在运行时该占位符将被当前请求的 host 替换，以便所有具有相同域的请求都被视为有状态的。

Sanctum 中间件

接下来，你应该指示 Laravel 来自 SPA 的传入请求可以使用 Laravel 的会话 Cookie 进行认证，同时仍然允许来自第三方或移动应用的请求使用 API 令牌进行认证。这可以通过在应用的 bootstrap/app.php 文件中调用 statefulApi 中间件方法轻松实现：

->withMiddleware(function (Middleware $middleware): void {
    $middleware->statefulApi();
})

CORS 和 Cookie

如果你在从执行在单独子域上的 SPA 认证应用时遇到问题，你可能错误配置了 CORS（跨域资源共享）或会话 Cookie 设置。

config/cors.php 配置文件默认不会发布。如果你需要自定义 Laravel 的 CORS 选项，你应该使用 config:publish Artisan 命令发布完整的 cors 配置文件：

php artisan config:publish cors

接下来，你应确保应用的 CORS 配置返回值为 True 的 Access-Control-Allow-Credentials 请求头。这可以通过将应用 config/cors.php 配置文件中的 supports_credentials 选项设置为 true 来实现。

此外，你应该在应用的全局 axios 实例上启用 withCredentials 和 withXSRFToken 选项。这可以在你的 resources/js/app.js 文件中执行。如果你不使用 Axios 从前端发起 HTTP 请求，你应该在自己的 HTTP 客户端上执行等效配置：

axios.defaults.withCredentials = true;
axios.defaults.withXSRFToken = true;

最后，你应确保应用的会话 Cookie 域配置支持根域的任何子域。你可以通过在应用 config/session.php 配置文件中的域名前添加前导 . 来实现：

'domain' => '.domain.com',

认证

CSRF 保护

要认证你的 SPA，SPA 的"登录"页面应首先向 /sanctum/csrf-cookie 端点发起请求以初始化应用的 CSRF 保护：

axios.get('/sanctum/csrf-cookie').then(response => {
    // Login...
});

在此请求期间，Laravel 将设置一个包含当前 CSRF 令牌的 XSRF-TOKEN Cookie。然后，此令牌应进行 URL 解码并在后续请求中通过 X-XSRF-TOKEN 请求头传递，某些 HTTP 客户端库（如 Axios 和 Angular HttpClient）会自动为你完成。如果你的 JavaScript HTTP 库没有为你设置该值，你需要手动将 X-XSRF-TOKEN 请求头设置为此路由设置的 XSRF-TOKEN Cookie 的 URL 解码值。

登录

CSRF 保护初始化后，你应该向 Laravel 应用的 /login 路由发起 POST 请求。此 /login 路由可以手动实现或使用无头认证包（如 Laravel Fortify）来实现。

如果登录请求成功，你将被认证，后续对应用路由的请求将通过 Laravel 应用颁发给客户端的会话 Cookie 自动认证。此外，由于你的应用已经向 /sanctum/csrf-cookie 路由发起了请求，只要你的 JavaScript HTTP 客户端在 X-XSRF-TOKEN 请求头中发送 XSRF-TOKEN Cookie 的值，后续请求就应该自动获得 CSRF 保护。

当然，如果用户的会话由于不活动而过期，后续对 Laravel 应用的请求可能会收到 401 或 419 HTTP 错误响应。在这种情况下，你应该将用户重定向到 SPA 的登录页面。

由于这种 SPA 认证方法是基于会话的，你可以使用 Laravel 的标准认证服务，包括"记住我"功能。

保护路由

要保护路由使所有传入请求都必须经过认证，你应该在 routes/api.php 文件中将 sanctum 认证守卫附加到 API 路由。此守卫将确保传入请求要么作为来自 SPA 的有状态认证请求进行认证，要么在请求来自第三方时包含有效的 API 令牌请求头：

use Illuminate\Http\Request;

Route::get('/user', function (Request $request) {
    return $request->user();
})->middleware('auth:sanctum');

授权私有广播频道

如果你的 SPA 需要认证私有/存在广播频道，你应该从应用 bootstrap/app.php 文件中的 withRouting 方法中移除 channels 条目。相反，你应该调用 withBroadcasting 方法，以便你可以为应用的广播路由指定正确的中间件：

return Application::configure(basePath: dirname(__DIR__))
    ->withRouting(
        web: __DIR__.'/../routes/web.php',
        // ...
    )
    ->withBroadcasting(
        __DIR__.'/../routes/channels.php',
        ['prefix' => 'api', 'middleware' => ['api', 'auth:sanctum']],
    )

接下来，为了使 Pusher 的授权请求成功，你需要在初始化 Laravel Echo 时提供自定义 Pusher authorizer。这允许你的应用配置 Pusher 使用正确配置了跨域请求的 axios 实例：

window.Echo = new Echo({
    broadcaster: "pusher",
    cluster: import.meta.env.VITE_PUSHER_APP_CLUSTER,
    encrypted: true,
    key: import.meta.env.VITE_PUSHER_APP_KEY,
    authorizer: (channel, options) => {
        return {
            authorize: (socketId, callback) => {
                axios.post('/api/broadcasting/auth', {
                    socket_id: socketId,
                    channel_name: channel.name
                })
                .then(response => {
                    callback(false, response.data);
                })
                .catch(error => {
                    callback(true, error);
                });
            }
        };
    },
})

移动应用认证

你也可以使用 Sanctum 令牌来认证移动应用对 API 的请求。认证移动应用请求的过程类似于认证第三方 API 请求；但是，在颁发 API 令牌的方式上有一些小的差异。

颁发 API 令牌

要开始使用，请创建一个接受用户邮箱/用户名、密码和设备名称的路由，然后将这些凭据交换为新的 Sanctum 令牌。给此端点的"设备名称"仅供参考，可以是你想要的任何值。通常，设备名称值应该是用户能识别的名称，例如"Nuno 的 iPhone 17"。

通常，你会从移动应用的"登录"屏幕向令牌端点发起请求。该端点将返回纯文本 API 令牌，然后可以将其存储在移动设备上并用于发起额外的 API 请求：

use App\Models\User;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Hash;
use Illuminate\Validation\ValidationException;

Route::post('/sanctum/token', function (Request $request) {
    $request->validate([
        'email' => 'required|email',
        'password' => 'required',
        'device_name' => 'required',
    ]);

    $user = User::where('email', $request->email)->first();

    if (! $user || ! Hash::check($request->password, $user->password)) {
        throw ValidationException::withMessages([
            'email' => ['The provided credentials are incorrect.'],
        ]);
    }

    return $user->createToken($request->device_name)->plainTextToken;
});

当移动应用使用令牌向你的应用发起 API 请求时，它应该将令牌作为 Bearer 令牌放在 Authorization 请求头中传递。

保护路由

如前所述，你可以通过将 sanctum 认证守卫附加到路由来保护路由，使所有传入请求都必须经过认证：

Route::get('/user', function (Request $request) {
    return $request->user();
})->middleware('auth:sanctum');

撤销令牌

为了允许用户撤销颁发给移动设备的 API 令牌，你可以在 Web 应用 UI 的"账户设置"部分按名称列出它们，并附上"撤销"按钮。当用户点击"撤销"按钮时，你可以从数据库中删除该令牌。请记住，你可以通过 Laravel\Sanctum\HasApiTokens trait 提供的 tokens 关系访问用户的 API 令牌：

// Revoke all tokens...
$user->tokens()->delete();

// Revoke a specific token...
$user->tokens()->where('id', $tokenId)->delete();

测试

在测试时，Sanctum::actingAs 方法可用于认证用户并指定应授予其令牌的能力：

use App\Models\User;
use Laravel\Sanctum\Sanctum;

test('task list can be retrieved', function () {
    Sanctum::actingAs(
        User::factory()->create(),
        ['view-tasks']
    );

    $response = $this->get('/api/task');

    $response->assertOk();
});

use App\Models\User;
use Laravel\Sanctum\Sanctum;

public function test_task_list_can_be_retrieved(): void
{
    Sanctum::actingAs(
        User::factory()->create(),
        ['view-tasks']
    );

    $response = $this->get('/api/task');

    $response->assertOk();
}

如果你想授予令牌所有能力，你应该在提供给 actingAs 方法的能力列表中包含 *：

Sanctum::actingAs(
    User::factory()->create(),
    ['*']
);