Hướng dẫn php artisan jwt:secret

Question

Nội dung chính Show

Với sự hoành tráng của mô hình client server -- WEB API thì khái niệm api không còn lạ với chúng ta nữa. Với sự hoành tráng của mô hình client server -- WEB API thì khái niệm api không còn lạ với chúng ta nữa.
1. cài package
2. config provider và alias
3. tạo file config để jwt hoạt động
4. Tạo secret key
5. sửa lại model user để tiêm cái id user vào claim
6. lưu ý thông tin file config
Tạo một token đơn giản
Tạo một token dự trên user
Tạo token dự trên một đối tượng .
claims - ghi thêm dữ liệu vào token
Tạo token từ 1 object bất kì
Xác thực
exception global

Với sự hoành tráng của mô hình client server -- WEB API thì khái niệm api không còn lạ với chúng ta nữa. Với sự hoành tráng của mô hình client server -- WEB API thì khái niệm api không còn lạ với chúng ta nữa.

2021-07-06 2838 lượt xem

Trang Chủ
laravel
Hướng dẫn sử dụng jwt token với laravel php sử dụng thư viện tymon auth

hùng đẹp trai

ahihi đồ ngốc trương thanh hùng nè

hùng đẹp trai

ahihi đồ ngốc trương thanh hùng nè

hùng thông minh lắm

tôi thích vậy đó

Và JWT token cũng thế, ở khuôn khổ bài này mình không nói về jwt là gì. Mình chỉ hướng dẫn cho các bạn cách nhúng jwt vào laravel cho api.

tôi thích vậy đó

ahihi đồ ngốc trương thanh hùng nè

ahihi đồ ngốc trương thanh hùng nè

đọc dữ liệu hộ bố

1. cài package

hùng ebudezain

hùng ebudezain

hùng thông minh lắm

ahihi đồ ngốc trương thanh hùng nè

đọc dữ liệu hộ bố

ahihi đồ ngốc trương thanh hùng nè

ahihi đồ ngốc trương thanh hùng nè

hùng ebudezain

Chạy lệnh thông qua composer :

hùng ebudezain

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

composer require tymon/jwt-auth

hùng ebudezain

2. config provider và alias

hùng ebudezain

tôi thích vậy đó

đọc dữ liệu hộ bố

tôi thích vậy đó

đọc dữ liệu hộ bố

hùng ebudezain

hùng đẹp trai

đọc dữ liệu hộ bố

Sau khi install package hoàn tất, bạn cần thêm service provider vào mảng provider trong file config app.php :

hùng đẹp trai

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

Tymon\JWTAuth\Providers\JWTAuthServiceProvider::class,

tôi thích vậy đó

hùng thông minh lắm

tôi thích vậy đó

cũng tại file app.config đó bạn thêm aliases cho 2 lớp thường dùng:

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

đọc dữ liệu hộ bố

'JWTAuth' => Tymon\JWTAuth\Facades\JWTAuth::class,
'JWTFactory' => 'Tymon\JWTAuth\Facades\JWTFactory'::class,

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

hùng thông minh lắm

hùng đẹp trai

3. tạo file config để jwt hoạt động

tôi thích vậy đó

hùng đẹp trai

hùng ebudezain

ahihi đồ ngốc trương thanh hùng nè

Sau cùng bạn cần publish config của jwt ( kiểu như nó tạo cái file config vào hệ thống laravel )

tôi thích vậy đó

hùng đẹp trai

ahihi đồ ngốc trương thanh hùng nè

hùng ebudezain

php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\JWTAuthServiceProvider"

ahihi đồ ngốc trương thanh hùng nè

4. Tạo secret key

đọc dữ liệu hộ bố

hùng ebudezain

đọc dữ liệu hộ bố

tôi thích vậy đó

hùng đẹp trai

đọc dữ liệu hộ bố

hùng ebudezain

hùng đẹp trai

hùng thông minh lắm

hùng ebudezain

Theo lý thuyết jwt dĩ nhiên muốn tạo ra 1 token bạn cần cung cấp 1 secret key
tạo secret key trong laravel khá dễ :

hùng đẹp trai

Nếu bạn sử dụng jwt để thực hiện xác thực cho việc trao đổi thông tin giữa 2 server
thì 2 key của 2 server phải giống nhau thì mới có thể giải mã được ...
Vì vậy, bạn có thể tạo 1 key bất kỳ bên server này và copy cho server kia.

hùng đẹp trai

đọc dữ liệu hộ bố

hùng đẹp trai

tôi thích vậy đó

hùng ebudezain

đọc dữ liệu hộ bố

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

bài hướng dẫn giải mã jwt của php laravel trong nodejs

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

ahihi đồ ngốc trương thanh hùng nè

5. sửa lại model user để tiêm cái id user vào claim

hùng thông minh lắm

hùng đẹp trai

bạn cần implements cái interface tên JWTSubject và thực thi 2 phương thức getJWTIdentifier, getJWTCustomClaims mục tiêu là để khi tạo token thì jwt của bạn được gắn chặt với 1 vái value là id của user. Sau đó khi giải mã thì ta được 1 object user tương ứng

tôi thích vậy đó

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

ahihi đồ ngốc trương thanh hùng nè

namespace App\Models;

/// ... 
use Tymon\JWTAuth\Contracts\JWTSubject;

class User extends Authenticatable implements JWTSubject
{
    use HasFactory, Notifiable;

     /**
     * @return int
     */
    public function getJWTIdentifier() {
        
        return $this->getKey();
    }
    
    /**
     * @return array
     */
    public function getJWTCustomClaims() {
        return [
            "iss" => "http://localhost",
            "ahihi" => "đồ ngốc CustomClaims"
        ];
    }
    //// ..... 
}

hùng đẹp trai

hùng ebudezain

hùng ebudezain

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

tôi thích vậy đó

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

6. lưu ý thông tin file config

hùng ebudezain

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

Secret Key - secret

hùng thông minh lắm

ahihi đồ ngốc trương thanh hùng nè

Cái tên nói lên tất cả 😄 Mục 4 mình vừa trình bày là cái key này, khi bạn muốn 2 server giải mã qua lại thì 2 server phải có key giống nhau.
Mặc định load trong env cái biến JWT_SECRET không thì nó lấy đại

hùng ebudezain

hùng đẹp trai

hùng thông minh lắm

đọc dữ liệu hộ bố

hùng đẹp trai

hùng ebudezain

'secret' => env('JWT_SECRET', 'hung-dep-trai'),

hùng thông minh lắm

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

hùng thông minh lắm

JWT time to live - ttl

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

ahihi đồ ngốc trương thanh hùng nè

hùng đẹp trai

hùng thông minh lắm

1 token tạo ra phải có thười gian sống (tính bằng phút). Khuyến nghị ngắn thôi.

hùng ebudezain

Refresh time to live - refresh_ttl

đọc dữ liệu hộ bố

tôi thích vậy đó

đọc dữ liệu hộ bố

hùng thông minh lắm

đọc dữ liệu hộ bố

ahihi đồ ngốc trương thanh hùng nè

đọc dữ liệu hộ bố

hùng đẹp trai

Đây là thời gian (tính bằng phút) bạn có thể tạo mới một token khác từ token cũ mà ko cần xác thực lại...

hùng ebudezain

hùng đẹp trai

hùng ebudezain

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

hùng đẹp trai

tôi thích vậy đó

hùng đẹp trai

hùng đẹp trai

'refresh_ttl' => 20160, //2 week

đọc dữ liệu hộ bố

hùng ebudezain

Tạo một token đơn giản

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

ahihi đồ ngốc trương thanh hùng nè

đọc dữ liệu hộ bố

Tạo một token dự trên user

hùng đẹp trai

hùng ebudezain

only('email', 'password');

        try {
            // xác nhận thông tin người dùng gửi lên có hợp lệ hay không
            if (! $token = JWTAuth::attempt($credentials)) {
                return response()
                    ->error(
                        'có lỗi validate trong controller', 
                        ['error' => 'invalid_credentials'],
                        Response::HTTP_UNAUTHORIZED
                    )
                    ->setStatusCode(Response::HTTP_UNAUTHORIZED);
            }
        } catch (JWTException $e) {
            // Xử lý ngoại lệ 
            return response()
                    ->error(
                        'có lỗi validate trong controller', 
                        ['error' => 'could_not_create_token'],
                        Response::HTTP_INTERNAL_SERVER_ERROR
                    )
                    ->setStatusCode(Response::HTTP_INTERNAL_SERVER_ERROR);
        }

        return response()
                    ->success('Your custom login', $token)
                    ->setStatusCode(Response::HTTP_OK);
    }

    /**
     * Nếu bạn sử dụng function login ở trên nhìn thấy phức tạp hay thấy gớm, khó hiểu quá thì dùng function dưới này nhìn dễ hiểu hơn 1 tí :D
     */
    public function simpleLogin(Request $request){
        // lấy thông tin từ các request gửi lên
        $credentials = $request->only('email', 'password');

        try {
            // xác nhận thông tin người dùng gửi lên có hợp lệ hay không
            if (! $token = JWTAuth::attempt($credentials)) {
                return response()->json(['error' => 'invalid_credentials'], 401);
            }
        } catch (JWTException $e) {
            // Xử lý ngoại lệ 
            return response()->json(['error' => 'could_not_create_token'], 500);
        }

        // xác nhận thành công thì trả về 1 token hợp lệ
        return response()->json(compact('token'));
    }
}

tôi thích vậy đó

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

hùng thông minh lắm

ahihi đồ ngốc trương thanh hùng nè

đọc dữ liệu hộ bố

Tạo token dự trên một đối tượng .

hùng ebudezain

hùng đẹp trai

hùng ebudezain

Ngoài phương pháp thông thường,
chúng ta còn có thể tạo một mã Token dựa trên một user instance như sau :

hùng thông minh lắm

đọc dữ liệu hộ bố

ahihi đồ ngốc trương thanh hùng nè

$user = User::where('email', '')->first();
if(!$user){
    return response()->json(['error' => 'user_not_found'], 500);
}

$token = JWTAuth::fromUser($user);

ahihi đồ ngốc trương thanh hùng nè

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

claims - ghi thêm dữ liệu vào token

hùng ebudezain

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

$customClaims = ['foo' => 'bar', 'baz' => 'bob'];

// JWTAuth::attempt($credentials, $customClaims); -> phương thức để login
// or
JWTAuth::fromUser($user, $customClaims);

hùng ebudezain

hùng thông minh lắm

Và đương nhiên, những dữ liệu bạn ghi thêm vào sẽ có mặt cùng với những dữ liệu khác khi giải mã token.

hùng đẹp trai

đọc dữ liệu hộ bố

hùng thông minh lắm

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

Lưu ý: Hết sức chú ý những dữ liệu bạn ghi thêm vào token vì chúng sẽ làm tăng độ dài cũng như dung lượng của token

tôi thích vậy đó

hùng thông minh lắm

hùng ebudezain

Tạo token từ 1 object bất kì

hùng thông minh lắm

hùng đẹp trai

tôi thích vậy đó

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

$customClaims = ['foo' => 'bar', 'baz' => 'bob'];

$payload = JWTFactory::make($customClaims);

$token = JWTAuth::encode($payload);

hùng ebudezain

đọc dữ liệu hộ bố

hùng thông minh lắm

tôi thích vậy đó

Xác thực

hùng đẹp trai

hùng ebudezain

Có token rồi thì khi người dùng gọi api phải gửi lên kèm header hoặc query params
Với token này thì server có thể check token đó đúng không ? nếu đúng thì lấy được thông tin đăng nhập .

hùng đẹp trai

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

đọc dữ liệu hộ bố

hùng đẹp trai

ahihi đồ ngốc trương thanh hùng nè

Đoạn mã đó có dạng như sau :

đọc dữ liệu hộ bố

tôi thích vậy đó

hùng thông minh lắm

hùng đẹp trai

tôi thích vậy đó

đọc dữ liệu hộ bố

ahihi đồ ngốc trương thanh hùng nè

ahihi đồ ngốc trương thanh hùng nè

Authorization: Bearer {your_token_here}

ahihi đồ ngốc trương thanh hùng nè

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

đọc dữ liệu hộ bố

tôi thích vậy đó

ahihi đồ ngốc trương thanh hùng nè

hùng thông minh lắm

ví dụ cụ thể:

tôi thích vậy đó

hùng thông minh lắm

hùng đẹp trai

GET /api/v1/users HTTP/1.1
Host: localhost:80
User-Agent: rest-client
Accept-Language: en-GB,en-US;q=0.8,en;q=0.6,zh-CN;q=0.4
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb2NhbGhvc3RcL2FwaVwvdjFcL2xvZ2luIiwiaWF0IjoxNjI1NTMwNDY2LCJleHAiOjE2MjU1MzQwNjYsIm5iZiI6MTYyNTUzMDQ2NiwianRpIjoibFhCZUlmMFFOMk9rTGlOZSIsInN1YiI6MiwicHJ2IjoiMjNiZDVjODk0OWY2MDBhZGIzOWU3MDFjNDAwODcyZGI3YTU5NzZmNyJ9.nAGhQWgLSPd-yX_xMRvNn82NZpXjMBKY61G0FHiIxV0
content-type: application/json
################################

ahihi đồ ngốc trương thanh hùng nè

tôi thích vậy đó

đọc dữ liệu hộ bố

hùng đẹp trai

Hoặc nếu bạn không muốn sử dụng header thì có thể sử dụng query string . Ví dụ

đọc dữ liệu hộ bố

tôi thích vậy đó

http://domain.xyz/users?token={your_token_here}

ahihi đồ ngốc trương thanh hùng nè

hùng ebudezain

hùng ebudezain

hùng đẹp trai

hùng ebudezain

hùng đẹp trai

Để lấy token từ đoạn mã gửi lên thì bạn có thể làm như sau:

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

hùng ebudezain

JWTAuth::parseToken();
$user = JWTAuth::parseToken()->authenticate();

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

Để lấy giá trị token thì có thể làm như sau :

tôi thích vậy đó

đọc dữ liệu hộ bố

ahihi đồ ngốc trương thanh hùng nè

$token = JWTAuth::getToken();

đọc dữ liệu hộ bố

hùng ebudezain

đọc dữ liệu hộ bố

hùng thông minh lắm

public function getAuthenticatedUser()
{
    try {

        if (! $user = JWTAuth::parseToken()->authenticate()) {
            return response()->json(['user_not_found'], 404);
        }

    } catch (Tymon\JWTAuth\Exceptions\TokenExpiredException $e) {

        return response()->json(['token_expired'], $e->getStatusCode());

    } catch (Tymon\JWTAuth\Exceptions\TokenInvalidException $e) {

        return response()->json(['token_invalid'], $e->getStatusCode());

    } catch (Tymon\JWTAuth\Exceptions\JWTException $e) {

        return response()->json(['token_absent'], $e->getStatusCode());

    }

    return response()->json(compact('user'));
}

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

exception global

hùng đẹp trai

tôi thích vậy đó

ahihi đồ ngốc trương thanh hùng nè

đọc dữ liệu hộ bố

hùng ebudezain

hùng thông minh lắm

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

hùng thông minh lắm

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

Mình sẽ viết 1 bài nói về cách dùng exception trong laravel trông có vẻ xịn hơn khi viết api hay xử lý các vấn đề về error để code clean hơn. Riêng phần này mình nói ngắn gọn để bắt lỗi exception global là bạn vào file app/Exceptions/Handler.php: bnaj thêm khúc này vào để xuất json:

đọc dữ liệu hộ bố

bài viết được viết bởi trương thanh hùng https://ebudezain.com/

hùng đẹp trai

public function render($request, Exception $e)
{
    if ($e instanceof Tymon\JWTAuth\Exceptions\TokenExpiredException) {
        return response()->json(['token_expired'], $e->getStatusCode());
    } else if ($e instanceof Tymon\JWTAuth\Exceptions\TokenInvalidException) {
        return response()->json(['token_invalid'], $e->getStatusCode());
    }

    return parent::render($request, $e);
}

programming php Jwt Laravel 9 JWT trong PHP jwt-auth laravel 8 tymon/jwt-auth laravel 8

Hướng dẫn php artisan jwt:secret

Với sự hoành tráng của mô hình client server -- WEB API thì khái niệm api không còn lạ với chúng ta nữa. Với sự hoành tráng của mô hình client server -- WEB API thì khái niệm api không còn lạ với chúng ta nữa.

1. cài package

2. config provider và alias

3. tạo file config để jwt hoạt động

4. Tạo secret key

5. sửa lại model user để tiêm cái id user vào claim

6. lưu ý thông tin file config

Secret Key - secret

JWT time to live - ttl

Refresh time to live - refresh_ttl

Tạo một token đơn giản

Tạo một token dự trên user

Tạo token dự trên một đối tượng .

claims - ghi thêm dữ liệu vào token

Tạo token từ 1 object bất kì

Xác thực

exception global

Bài Viết Liên Quan

Quảng Cáo

Có thể bạn quan tâm

Toplist được quan tâm

Quảng cáo

Xem Nhiều

Quảng cáo

Chúng tôi

Điều khoản

Trợ giúp

Mạng xã hội