Giới thiệu

Ngoài những cách authentication thông thường dựa trên form, Laravel cũng cung cấp thêm một số cách đơn giản, thuận tiện để authentication với các provider OAuth khác bằng cách sử dụng Laravel Socialite. Socialite hiện hỗ trợ authentication với Facebook, Twitter, LinkedIn, Google, GitHub, GitLab và Bitbucket.

{tip} Bộ chuyển đổi cho các nền tảng này được liệt kê trong trang web Socialite Providers do cộng đồng phát triển.

Cập nhật Socialite

Khi nâng cấp lên phiên bản mới của Socialite, điều quan trọng là bạn phải xem kỹ hướng dẫn nâng cấp.

Cài đặt

Để bắt đầu với Socialite, hãy sử dụng Composer để thêm package của nó vào library project của bạn:

composer require laravel/socialite:4.4.1

{note} Phiên bản mới nhất của Socialite không hỗ trợ Laravel 5.7. Phiên bản cuối cùng hỗ trợ Laravel 5.7 là Socialite 4.4.1.

Cấu hình

Trước khi sử dụng Socialite, bạn cũng sẽ cần phải thêm thông tin các dịch vụ OAuth mà application của bạn đang muốn sử dụng. Các thông tin này phải được set trong file cấu hình config/services.php của bạn và sử dụng các key facebook, twitter, linkedin, google, github, gitlab hoặc bitbucket, tùy thuộc vào provider application của bạn yêu cầu. Ví dụ:

'github' => [
    'client_id' => env('GITHUB_CLIENT_ID'),
    'client_secret' => env('GITHUB_CLIENT_SECRET'),
    'redirect' => 'http://your-callback-url',
],

{tip} Nếu tùy chọn redirect chứa một relative path, nó sẽ tự động được resolve thành một absolute path.

Routing

Tiếp theo, bạn đã sẵn sàng để authenticate người dùng! Bạn sẽ cần hai route: một là để chuyển hướng người dùng đến provider OAuth và một route khác để nhận các callback từ provider sau khi authenticate thành công. Chúng ta sẽ truy cập vào Socialite bằng cách sử dụng facade Socialite:

<?php

namespace App\Http\Controllers\Auth;

use Socialite;

class LoginController extends Controller
{
    /**
     * Redirect the user to the GitHub authentication page.
     *
     * @return \Illuminate\Http\Response
     */
    public function redirectToProvider()
    {
        return Socialite::driver('github')->redirect();
    }

    /**
     * Obtain the user information from GitHub.
     *
     * @return \Illuminate\Http\Response
     */
    public function handleProviderCallback()
    {
        $user = Socialite::driver('github')->user();

        // $user->token;
    }
}

Phương thức redirect đảm nhiệm việc gửi người dùng đến provider OAuth, trong khi phương thức user sẽ đọc request gửi về và lấy ra thông tin của người dùng từ provider.

Bạn sẽ cần phải định nghĩa các route đến các phương thức của controller của bạn:

Route::get('login/github', 'Auth\LoginController@redirectToProvider');
Route::get('login/github/callback', 'Auth\LoginController@handleProviderCallback');

Các tham số tuỳ chọn

Một số các provider OAuth hỗ trợ các tham số tùy chọn trong request chuyển hướng. Để thêm bất kỳ tham số tùy chọn nào vào trong request, hãy gọi phương thức with với một mảng:

return Socialite::driver('google')
    ->with(['hd' => 'example.com'])
    ->redirect();

{note} Khi sử dụng phương thức with, hãy cẩn thận đừng truyền qua bất kỳ keyword bí mật nào như state hoặc answer_type.

Truy cập đến Scope

Trước khi chuyển hướng người dùng, bạn cũng có thể thêm các "scopes" vào request bằng phương thức scopes. Phương pháp này sẽ merge tất cả các scope hiện tại với scope mà bạn cung cấp:

return Socialite::driver('github')
    ->scopes(['read:user', 'public_repo'])
    ->redirect();

Bạn có thể ghi đè tất cả các scope hiện tại bằng phương thức setScopes:

return Socialite::driver('github')
    ->setScopes(['read:user', 'public_repo'])
    ->redirect();

Không lưu thông tin Authentication

Phương thức stateless có thể được sử dụng để vô hiệu hóa trạng thái xác minh của session. Điều này có thể hữu ích khi thêm các social authentication vào API:

return Socialite::driver('google')->stateless()->user();

Lấy ra thông tin User

Khi bạn đã có một instance người dùng, bạn có thể lấy ra một số thông tin về người dùng:

$user = Socialite::driver('github')->user();

// OAuth Two Providers
$token = $user->token;
$refreshToken = $user->refreshToken; // not always provided
$expiresIn = $user->expiresIn;

// OAuth One Providers
$token = $user->token;
$tokenSecret = $user->tokenSecret;

// All Providers
$user->getId();
$user->getNickname();
$user->getName();
$user->getEmail();
$user->getAvatar();

Retrieving User Details From A Token (OAuth2)

Nếu bạn đã có một access token hợp lệ của một người dùng, bạn có thể lấy ra thông tin chi tiết của họ bằng phương thức userFromToken:

$user = Socialite::driver('github')->userFromToken($token);

Retrieving User Details From A Token And Secret (OAuth1)

Nếu bạn đã có một token / secret hợp lệ của người dùng, bạn có thể truy xuất thông tin chi tiết của người dùng đó bằng phương thức userFromTokenAndSecret:

$user = Socialite::driver('twitter')->userFromTokenAndSecret($token, $secret);