Skip to content

A free open source IT asset/license management system

Fixed #15937 - added bearer token revoke endpoint

snipee8446f7f97be
diff --git a/app/Http/Controllers/Api/ProfileController.php b/app/Http/Controllers/Api/ProfileController.php
index cf54d32e93..6761113be3 100644
--- a/app/Http/Controllers/Api/ProfileController.php
+++ b/app/Http/Controllers/Api/ProfileController.php
@@ -17,6 +17,7 @@ use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Gate;
+use Laravel\Passport\RefreshTokenRepository;
use Laravel\Passport\TokenRepository;
class ProfileController extends Controller
@@ -159,6 +160,39 @@ class ProfileController extends Controller
}
+ /**
+ * Bearer-authenticated self-logout. Revokes the access token that
+ * authenticated THIS request and any refresh token that was issued
+ * alongside it, so a client cannot silently renew after logging
+ * out. Does not touch the user's other tokens (other devices,
+ * personal-access tokens, tokens under different OAuth clients) -
+ * scope is exactly the current session.
+ *
+ * Deliberately distinct from Passport's UI-shaped
+ * DELETE /oauth/tokens/{id} route, which is session-cookie
+ * authenticated for the Passport-Vue self-service page and can't
+ * answer a bearer-only client. Passport does not ship a
+ * bearer-self-revoke endpoint because RFC 7009 revocation uses
+ * client credentials rather than bearer auth, so this
+ * "log me out of this session" affordance is a Snipe-IT addition.
+ */
+ public function logout(RefreshTokenRepository $refreshTokens): Response
+ {
+ $token = auth()->user()?->token();
+
+ // auth:api on the route guarantees a bearer-authenticated user,
+ // but session-cookie / personal-access flows leave token() null.
+ // Return 401 for those instead of a 500 on a null property read.
+ if ($token === null) {
+ return new Response('', Response::HTTP_UNAUTHORIZED);
+ }
+
+ $this->tokenRepository->revokeAccessToken($token->id);
+ $refreshTokens->revokeRefreshTokensByAccessTokenId($token->id);
+
+ return new Response('', Response::HTTP_NO_CONTENT);
+ }
+
/**
* Show user's API tokens
*
diff --git a/routes/api.php b/routes/api.php
index 0eb4640cb6..b0b786389f 100644
--- a/routes/api.php
+++ b/routes/api.php
@@ -52,6 +52,18 @@ Route::group(['prefix' => 'v1', 'middleware' => ['api', 'api-throttle:api']], fu
[Api\OrderItemsController::class, 'index']
)->name('api.order-items.index');
+ /**
+ * Bearer-authenticated self-logout. Revokes the access token that
+ * authenticated this request and any refresh token issued with it,
+ * so a client (custom SPA / mobile app) can call this on logout
+ * and be sure the token cannot silently renew. See
+ * ProfileController::logout for the design rationale and why we
+ * ship this rather than pointing callers at Passport's session-
+ * cookie-shaped DELETE /oauth/tokens/{id} route.
+ */
+ Route::post('logout', [Api\ProfileController::class, 'logout'])
+ ->name('api.logout');
+
/**
* Account routes
*/
diff --git a/tests/Feature/Auth/ApiLogoutTest.php b/tests/Feature/Auth/ApiLogoutTest.php
new file mode 100644
index 0000000000..dd1d80ab87
--- /dev/null
+++ b/tests/Feature/Auth/ApiLogoutTest.php
@@ -0,0 +1,138 @@
+<?php
+
+namespace Tests\Feature\Auth;
+
+use App\Models\User;
+use Illuminate\Support\Facades\DB;
+use Laravel\Passport\Passport;
+use Laravel\Passport\Token;
+use Tests\TestCase;
+
+/**
+ * Coverage for POST /api/v1/logout, the bearer-authenticated
+ * self-revoke endpoint added because Passport does not ship one (its
+ * built-in DELETE /oauth/tokens/{id} is session-cookie authenticated
+ * for the Passport-Vue self-service UI, and RFC 7009 revocation
+ * expects client credentials rather than bearer auth). The endpoint
+ * revokes the access token that authenticated THIS request and any
+ * refresh token issued alongside it, but must leave the user's other
+ * tokens (other devices, personal-access tokens, tokens under other
+ * OAuth clients) untouched.
+ */
+class ApiLogoutTest extends TestCase
+{
+ private function seedOAuthClient(): int
+ {
+ return DB::table('oauth_clients')->insertGetId([
+ 'user_id' => null,
+ 'name' => 'Test OAuth Client',
+ 'secret' => 'secret',
+ 'redirect' => 'http://localhost/callback',
+ 'personal_access_client' => 0,
+ 'password_client' => 1,
+ 'revoked' => 0,
+ 'created_at' => now(),
+ 'updated_at' => now(),
+ ]);
+ }
+
+ private function seedAccessToken(string $id, User $user, int $clientId): void
+ {
+ DB::table('oauth_access_tokens')->insert([
+ 'id' => $id,
+ 'user_id' => $user->id,
+ 'client_id' => $clientId,
+ 'name' => $id,
+ 'scopes' => '[]',
+ 'revoked' => 0,
+ 'created_at' => now(),
+ 'updated_at' => now(),
+ 'expires_at' => now()->addDay(),
+ ]);
+ }
+
+ private function seedRefreshToken(string $id, string $accessTokenId): void
+ {
+ DB::table('oauth_refresh_tokens')->insert([
+ 'id' => $id,
+ 'access_token_id' => $accessTokenId,
+ 'revoked' => 0,
+ 'expires_at' => now()->addWeek(),
+ ]);
+ }
+
+ private function actAsUserWithAccessToken(User $user, string $accessTokenId): void
+ {
+ // Passport::actingAs stubs a fresh (unsaved) Token onto the
+ // user, which would leave $token->id null in the controller.
+ // Overwrite the stub with a real Token pointing at the row we
+ // just seeded so revocation targets an actual DB record.
+ Passport::actingAs($user);
+ $realToken = Token::find($accessTokenId);
+ auth('api')->user()->withAccessToken($realToken);
+ }
+
+ public function test_logout_revokes_the_bearer_access_token(): void
+ {
+ $user = User::factory()->create();
+ $clientId = $this->seedOAuthClient();
+ $this->seedAccessToken('logout-token-1', $user, $clientId);
+
+ $this->actAsUserWithAccessToken($user, 'logout-token-1');
+
+ $this->postJson(route('api.logout'))->assertNoContent();
+
+ $this->assertDatabaseHas('oauth_access_tokens', [
+ 'id' => 'logout-token-1',
+ 'revoked' => 1,
+ ]);
+ }
+
+ public function test_logout_also_revokes_the_paired_refresh_token(): void
+ {
+ $user = User::factory()->create();
+ $clientId = $this->seedOAuthClient();
+ $this->seedAccessToken('logout-token-2', $user, $clientId);
+ $this->seedRefreshToken('logout-refresh-2', 'logout-token-2');
+
+ $this->actAsUserWithAccessToken($user, 'logout-token-2');
+
+ $this->postJson(route('api.logout'))->assertNoContent();
+
+ $this->assertDatabaseHas('oauth_refresh_tokens', [
+ 'id' => 'logout-refresh-2',
+ 'revoked' => 1,
+ ]);
+ }
+
+ public function test_logout_does_not_touch_the_users_other_access_tokens(): void
+ {
+ // Scope guarantee: revoking one session must not log the user
+ // out of their other devices / personal-access tokens.
+ $user = User::factory()->create();
+ $clientId = $this->seedOAuthClient();
+ $this->seedAccessToken('current-session-token', $user, $clientId);
+ $this->seedAccessToken('other-device-token', $user, $clientId);
+
+ $this->actAsUserWithAccessToken($user, 'current-session-token');
+
+ $this->postJson(route('api.logout'))->assertNoContent();
+
+ $this->assertDatabaseHas('oauth_access_tokens', [
+ 'id' => 'other-device-token',
+ 'revoked' => 0,
+ ]);
+ }
+
+ public function test_unauthenticated_request_is_rejected(): void
+ {
+ // Route sits behind the api middleware group's auth:api guard;
+ // no bearer, no logout. Belt-and-braces coverage in case the
+ // route ever gets refactored out from under the guard. A user
+ // must exist so CheckForSetup does not intercept with a
+ // pre-auth 302 to /setup.
+ User::factory()->create();
+
+ $this->postJson(route('api.logout'))->assertUnauthorized();
+ }
+}