feat: Implement refresh token system for client authentication, including token creation, rotation, and revocation.
This commit is contained in:
@@ -8,6 +8,7 @@ use App\Http\Requests\Api\Client\ClientRegisterRequest;
|
|||||||
use App\Http\Requests\Api\Client\ClientUpdateRequest;
|
use App\Http\Requests\Api\Client\ClientUpdateRequest;
|
||||||
use App\Http\Resources\Api\Client\ClientResource;
|
use App\Http\Resources\Api\Client\ClientResource;
|
||||||
use App\Services\Api\Client\ClientAuthService;
|
use App\Services\Api\Client\ClientAuthService;
|
||||||
|
use Illuminate\Http\Request;
|
||||||
use Tymon\JWTAuth\Facades\JWTAuth;
|
use Tymon\JWTAuth\Facades\JWTAuth;
|
||||||
use Tymon\JWTAuth\Exceptions\JWTException;
|
use Tymon\JWTAuth\Exceptions\JWTException;
|
||||||
|
|
||||||
@@ -97,7 +98,7 @@ class ClientController extends Controller
|
|||||||
* operationId="clientLogin",
|
* operationId="clientLogin",
|
||||||
* tags={"Client Authentication"},
|
* tags={"Client Authentication"},
|
||||||
* summary="Client login",
|
* summary="Client login",
|
||||||
* description="Authenticate a client and return access token",
|
* description="Authenticate a client and return access token + refresh token",
|
||||||
* @OA\RequestBody(
|
* @OA\RequestBody(
|
||||||
* required=true,
|
* required=true,
|
||||||
* @OA\JsonContent(
|
* @OA\JsonContent(
|
||||||
@@ -113,7 +114,9 @@ class ClientController extends Controller
|
|||||||
* @OA\Property(property="error", type="boolean", example=false),
|
* @OA\Property(property="error", type="boolean", example=false),
|
||||||
* @OA\Property(property="data", type="object",
|
* @OA\Property(property="data", type="object",
|
||||||
* @OA\Property(property="client", type="object"),
|
* @OA\Property(property="client", type="object"),
|
||||||
* @OA\Property(property="token", type="string", example="1|laravel_sanctum_token...")
|
* @OA\Property(property="token", type="string", example="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."),
|
||||||
|
* @OA\Property(property="refresh_token", type="string", example="random64charstring..."),
|
||||||
|
* @OA\Property(property="expires_in", type="integer", example=900)
|
||||||
* )
|
* )
|
||||||
* )
|
* )
|
||||||
* ),
|
* ),
|
||||||
@@ -130,8 +133,10 @@ class ClientController extends Controller
|
|||||||
return response()->json([
|
return response()->json([
|
||||||
'error' => false,
|
'error' => false,
|
||||||
'data' => [
|
'data' => [
|
||||||
'client' => new ClientResource($result['client']),
|
'client' => new ClientResource($result['client']),
|
||||||
'token' => $result['token'],
|
'token' => $result['token'],
|
||||||
|
'refresh_token' => $result['refresh_token'],
|
||||||
|
'expires_in' => config('jwt.ttl', 60) * 60, // seconds
|
||||||
],
|
],
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
@@ -161,7 +166,9 @@ class ClientController extends Controller
|
|||||||
* @OA\Property(property="error", type="boolean", example=false),
|
* @OA\Property(property="error", type="boolean", example=false),
|
||||||
* @OA\Property(property="data", type="object",
|
* @OA\Property(property="data", type="object",
|
||||||
* @OA\Property(property="client", type="object"),
|
* @OA\Property(property="client", type="object"),
|
||||||
* @OA\Property(property="token", type="string", example="1|laravel_sanctum_token...")
|
* @OA\Property(property="token", type="string", example="eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."),
|
||||||
|
* @OA\Property(property="refresh_token", type="string", example="random64charstring..."),
|
||||||
|
* @OA\Property(property="expires_in", type="integer", example=900)
|
||||||
* )
|
* )
|
||||||
* )
|
* )
|
||||||
* ),
|
* ),
|
||||||
@@ -178,8 +185,10 @@ class ClientController extends Controller
|
|||||||
return response()->json([
|
return response()->json([
|
||||||
'error' => false,
|
'error' => false,
|
||||||
'data' => [
|
'data' => [
|
||||||
'client' => new ClientResource($result['client']),
|
'client' => new ClientResource($result['client']),
|
||||||
'token' => $result['token'],
|
'token' => $result['token'],
|
||||||
|
'refresh_token' => $result['refresh_token'],
|
||||||
|
'expires_in' => config('jwt.ttl', 60) * 60,
|
||||||
],
|
],
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
@@ -190,8 +199,13 @@ class ClientController extends Controller
|
|||||||
* operationId="clientLogout",
|
* operationId="clientLogout",
|
||||||
* tags={"Client Authentication"},
|
* tags={"Client Authentication"},
|
||||||
* summary="Client logout",
|
* summary="Client logout",
|
||||||
* description="Logout the currently authenticated client",
|
* description="Logout the currently authenticated client and revoke refresh token",
|
||||||
* security={{"bearerAuth":{}}},
|
* security={{"bearerAuth":{}}},
|
||||||
|
* @OA\RequestBody(
|
||||||
|
* @OA\JsonContent(
|
||||||
|
* @OA\Property(property="refresh_token", type="string", example="random64charstring...")
|
||||||
|
* )
|
||||||
|
* ),
|
||||||
* @OA\Response(
|
* @OA\Response(
|
||||||
* response=200,
|
* response=200,
|
||||||
* description="Logout successful",
|
* description="Logout successful",
|
||||||
@@ -206,50 +220,92 @@ class ClientController extends Controller
|
|||||||
* )
|
* )
|
||||||
* )
|
* )
|
||||||
*/
|
*/
|
||||||
public function logout()
|
public function logout(Request $request)
|
||||||
{
|
{
|
||||||
|
if ($rawToken = $request->input('refresh_token')) {
|
||||||
|
$this->authService->revokeRefreshToken($rawToken);
|
||||||
|
}
|
||||||
|
|
||||||
auth('client')->logout();
|
auth('client')->logout();
|
||||||
|
|
||||||
return response()->json([
|
return response()->json([
|
||||||
'error' => false,
|
'error' => false,
|
||||||
'message' => 'Đã đăng xuất thành công.',
|
'message' => 'Đã đăng xuất thành công.',
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @OA\Post(
|
||||||
|
* path="/client/refresh",
|
||||||
|
* operationId="clientRefresh",
|
||||||
|
* tags={"Client Authentication"},
|
||||||
|
* summary="Refresh access token",
|
||||||
|
* description="Exchange a valid refresh token for a new access token + rotated refresh token",
|
||||||
|
* @OA\RequestBody(
|
||||||
|
* required=true,
|
||||||
|
* @OA\JsonContent(
|
||||||
|
* required={"refresh_token"},
|
||||||
|
* @OA\Property(property="refresh_token", type="string", example="random64charstring...")
|
||||||
|
* )
|
||||||
|
* ),
|
||||||
|
* @OA\Response(
|
||||||
|
* response=200,
|
||||||
|
* description="Token refreshed",
|
||||||
|
* @OA\JsonContent(
|
||||||
|
* @OA\Property(property="error", type="boolean", example=false),
|
||||||
|
* @OA\Property(property="data", type="object",
|
||||||
|
* @OA\Property(property="token", type="string"),
|
||||||
|
* @OA\Property(property="refresh_token", type="string"),
|
||||||
|
* @OA\Property(property="expires_in", type="integer", example=900),
|
||||||
|
* @OA\Property(property="client", type="object")
|
||||||
|
* )
|
||||||
|
* )
|
||||||
|
* ),
|
||||||
|
* @OA\Response(
|
||||||
|
* response=401,
|
||||||
|
* description="Invalid or expired refresh token"
|
||||||
|
* )
|
||||||
|
* )
|
||||||
|
*/
|
||||||
|
public function refresh(Request $request)
|
||||||
|
{
|
||||||
|
$request->validate([
|
||||||
|
'refresh_token' => ['required', 'string'],
|
||||||
|
]);
|
||||||
|
|
||||||
|
try {
|
||||||
|
$result = $this->authService->rotateRefreshToken($request->input('refresh_token'));
|
||||||
|
|
||||||
|
return response()->json([
|
||||||
|
'error' => false,
|
||||||
|
'data' => [
|
||||||
|
'token' => $result['token'],
|
||||||
|
'refresh_token' => $result['refresh_token'],
|
||||||
|
'expires_in' => config('jwt.ttl', 60) * 60,
|
||||||
|
'client' => new ClientResource($result['client']),
|
||||||
|
],
|
||||||
|
]);
|
||||||
|
} catch (\Illuminate\Validation\ValidationException $e) {
|
||||||
|
return response()->json([
|
||||||
|
'error' => true,
|
||||||
|
'message' => collect($e->errors())->flatten()->first(),
|
||||||
|
], 401);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
public function update(ClientUpdateRequest $request)
|
public function update(ClientUpdateRequest $request)
|
||||||
{
|
{
|
||||||
$user = auth('client')->user();
|
$user = auth('client')->user();
|
||||||
|
|
||||||
$user->fill($request->validated());
|
$user->fill($request->validated());
|
||||||
$user->save();
|
$user->save();
|
||||||
|
|
||||||
return response()->json([
|
return response()->json([
|
||||||
'error' => false,
|
'error' => false,
|
||||||
'message' => 'Cập nhật thông tin thành công',
|
'message' => 'Cập nhật thông tin thành công',
|
||||||
'data' => [
|
'data' => [
|
||||||
'client' => new ClientResource($user),
|
'client' => new ClientResource($user),
|
||||||
],
|
],
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
public function refresh()
|
|
||||||
{
|
|
||||||
try {
|
|
||||||
$newToken = JWTAuth::parseToken()->refresh();
|
|
||||||
$user = JWTAuth::setToken($newToken)->toUser();
|
|
||||||
|
|
||||||
return response()->json([
|
|
||||||
'error' => false,
|
|
||||||
'data' => [
|
|
||||||
'token' => $newToken,
|
|
||||||
'client' => new ClientResource($user),
|
|
||||||
],
|
|
||||||
]);
|
|
||||||
} catch (JWTException $e) {
|
|
||||||
return response()->json([
|
|
||||||
'error' => true,
|
|
||||||
'message' => 'Không thể làm mới phiên đăng nhập. Vui lòng đăng nhập lại.',
|
|
||||||
], 401);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,28 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace App\Models;
|
||||||
|
|
||||||
|
use Illuminate\Database\Eloquent\Model;
|
||||||
|
|
||||||
|
class RefreshToken extends Model
|
||||||
|
{
|
||||||
|
protected $fillable = [
|
||||||
|
'customer_id',
|
||||||
|
'token',
|
||||||
|
'expires_at',
|
||||||
|
];
|
||||||
|
|
||||||
|
protected $casts = [
|
||||||
|
'expires_at' => 'datetime',
|
||||||
|
];
|
||||||
|
|
||||||
|
public function customer()
|
||||||
|
{
|
||||||
|
return $this->belongsTo(Customer::class);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function isExpired(): bool
|
||||||
|
{
|
||||||
|
return $this->expires_at->isPast();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,13 +2,18 @@
|
|||||||
|
|
||||||
namespace App\Services\Api\Client;
|
namespace App\Services\Api\Client;
|
||||||
|
|
||||||
|
use App\Models\RefreshToken;
|
||||||
use App\Repositories\Api\Client\ClientRepositoryInterface;
|
use App\Repositories\Api\Client\ClientRepositoryInterface;
|
||||||
use Illuminate\Support\Facades\Auth;
|
use Illuminate\Support\Facades\Auth;
|
||||||
|
use Illuminate\Support\Str;
|
||||||
use Illuminate\Validation\ValidationException;
|
use Illuminate\Validation\ValidationException;
|
||||||
use Tymon\JWTAuth\Facades\JWTAuth;
|
use Tymon\JWTAuth\Facades\JWTAuth;
|
||||||
|
|
||||||
class ClientAuthService
|
class ClientAuthService
|
||||||
{
|
{
|
||||||
|
// Refresh token lifetime in days
|
||||||
|
const REFRESH_TOKEN_TTL_DAYS = 30;
|
||||||
|
|
||||||
protected $clientRepository;
|
protected $clientRepository;
|
||||||
|
|
||||||
public function __construct(ClientRepositoryInterface $clientRepository)
|
public function __construct(ClientRepositoryInterface $clientRepository)
|
||||||
@@ -17,7 +22,7 @@ class ClientAuthService
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Xác thực khách hàng và tạo token
|
* Xác thực khách hàng và tạo access + refresh token
|
||||||
*/
|
*/
|
||||||
public function authenticateClient(array $credentials): array
|
public function authenticateClient(array $credentials): array
|
||||||
{
|
{
|
||||||
@@ -36,20 +41,23 @@ class ClientAuthService
|
|||||||
3 => 'bị khoá',
|
3 => 'bị khoá',
|
||||||
default => 'vô hiệu hoá',
|
default => 'vô hiệu hoá',
|
||||||
};
|
};
|
||||||
|
|
||||||
throw ValidationException::withMessages([
|
throw ValidationException::withMessages([
|
||||||
'email' => ["Tài khoản của bạn đã {$statusLabel}, vui lòng liên hệ hotline."],
|
'email' => ["Tài khoản của bạn đã {$statusLabel}, vui lòng liên hệ hotline."],
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$refreshToken = $this->createRefreshToken($client->id);
|
||||||
|
|
||||||
return [
|
return [
|
||||||
'client' => $client,
|
'client' => $client,
|
||||||
'token' => $token,
|
'token' => $token,
|
||||||
|
'refresh_token' => $refreshToken,
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Đăng ký khách hàng mới và tạo token
|
* Đăng ký khách hàng mới và tạo access + refresh token
|
||||||
*/
|
*/
|
||||||
public function registerClient(array $data): array
|
public function registerClient(array $data): array
|
||||||
{
|
{
|
||||||
@@ -61,10 +69,82 @@ class ClientAuthService
|
|||||||
]);
|
]);
|
||||||
|
|
||||||
$token = JWTAuth::fromUser($client);
|
$token = JWTAuth::fromUser($client);
|
||||||
|
$refreshToken = $this->createRefreshToken($client->id);
|
||||||
|
|
||||||
return [
|
return [
|
||||||
'client' => $client,
|
'client' => $client,
|
||||||
'token' => $token,
|
'token' => $token,
|
||||||
|
'refresh_token' => $refreshToken,
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Tạo refresh token mới, lưu hash vào DB, trả về raw token.
|
||||||
|
*/
|
||||||
|
public function createRefreshToken(int $customerId): string
|
||||||
|
{
|
||||||
|
$raw = Str::random(64);
|
||||||
|
$hash = hash('sha256', $raw);
|
||||||
|
|
||||||
|
RefreshToken::create([
|
||||||
|
'customer_id' => $customerId,
|
||||||
|
'token' => $hash,
|
||||||
|
'expires_at' => now()->addDays(self::REFRESH_TOKEN_TTL_DAYS),
|
||||||
|
]);
|
||||||
|
|
||||||
|
return $raw;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Xác minh refresh token, xoay vòng (rotation), trả về access token mới + refresh token mới.
|
||||||
|
* Ném ValidationException nếu token không hợp lệ hoặc đã hết hạn.
|
||||||
|
*/
|
||||||
|
public function rotateRefreshToken(string $rawToken): array
|
||||||
|
{
|
||||||
|
$hash = hash('sha256', $rawToken);
|
||||||
|
|
||||||
|
$record = RefreshToken::where('token', $hash)->first();
|
||||||
|
|
||||||
|
if (!$record || $record->isExpired()) {
|
||||||
|
// Xoá token cũ nếu tồn tại nhưng hết hạn
|
||||||
|
$record?->delete();
|
||||||
|
|
||||||
|
throw ValidationException::withMessages([
|
||||||
|
'refresh_token' => ['Refresh token không hợp lệ hoặc đã hết hạn.'],
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
$customer = $record->customer;
|
||||||
|
|
||||||
|
if (!$customer || (int)$customer->status !== 1) {
|
||||||
|
$record->delete();
|
||||||
|
throw ValidationException::withMessages([
|
||||||
|
'refresh_token' => ['Tài khoản không hợp lệ.'],
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Rotation: xoá token cũ
|
||||||
|
$record->delete();
|
||||||
|
|
||||||
|
// Tạo access token mới
|
||||||
|
$newAccessToken = JWTAuth::fromUser($customer);
|
||||||
|
|
||||||
|
// Tạo refresh token mới
|
||||||
|
$newRefreshToken = $this->createRefreshToken($customer->id);
|
||||||
|
|
||||||
|
return [
|
||||||
|
'client' => $customer,
|
||||||
|
'token' => $newAccessToken,
|
||||||
|
'refresh_token' => $newRefreshToken,
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Huỷ refresh token khi đăng xuất.
|
||||||
|
*/
|
||||||
|
public function revokeRefreshToken(string $rawToken): void
|
||||||
|
{
|
||||||
|
$hash = hash('sha256', $rawToken);
|
||||||
|
RefreshToken::where('token', $hash)->delete();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,27 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
use Illuminate\Database\Migrations\Migration;
|
||||||
|
use Illuminate\Database\Schema\Blueprint;
|
||||||
|
use Illuminate\Support\Facades\Schema;
|
||||||
|
|
||||||
|
return new class extends Migration
|
||||||
|
{
|
||||||
|
public function up(): void
|
||||||
|
{
|
||||||
|
Schema::create('refresh_tokens', function (Blueprint $table) {
|
||||||
|
$table->id();
|
||||||
|
$table->unsignedBigInteger('customer_id');
|
||||||
|
$table->string('token', 64)->unique(); // sha256 hex hash
|
||||||
|
$table->timestamp('expires_at');
|
||||||
|
$table->timestamps();
|
||||||
|
|
||||||
|
$table->foreign('customer_id')->references('id')->on('customers')->onDelete('cascade');
|
||||||
|
$table->index('customer_id');
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
public function down(): void
|
||||||
|
{
|
||||||
|
Schema::dropIfExists('refresh_tokens');
|
||||||
|
}
|
||||||
|
};
|
||||||
Reference in New Issue
Block a user