free性中国熟女hd,成人乱码一卡二卡3卡,www.久久

首頁

后端開發(fā)

php教程

在 Laravel 中實現(xiàn)和測試社交名流身份驗證

DDD

Jan 03, 2025 am 11:17 AM

Implementing & testing Socialite authentication in Laravel

Laravel Socialite 是一個第一方 Laravel 包，可幫助開發(fā)人員在其應用程序中實現(xiàn) OAuth 和 OAuth2 社交身份驗證。它內置了對 Facebook、Twitter、Google、LinkedIn、GitHub、GitLab 和 Bitbucket 的支持。社交名流可以通過社區(qū)包支持其他提供商。

這篇文章將：

解釋社交名流做什么和不做什么。
展示如何通過 Socialite 將 Google 身份驗證集成到新的 Laravel 項目中。
展示測試社交名流的示例。

TLDR：您可以在我的 GitHub 上查看已完成的項目。如果您只想閱讀完整的代碼，請看一下它。

Laravel Socialite 做什么和不做什么？

Socialite 是一個小包，其主要 API 主要由兩個主要方法組成：

Socialite::driver($authProvider)->redirect() 將把用戶重定向到指定的身份驗證提供者，通過 URL 參數(shù)將任何必要的信息傳遞給提供者。
Socialite::driver($authProvider)->user() 檢索從身份驗證提供者傳回的用戶數(shù)據(jù)并將其提供給端點。

還有針對設置范圍和可選參數(shù)的附加支持方法。您可以在社交名流文檔中閱讀有關它們的信息。

社交名流不會執(zhí)行以下操作：它將這些功能的實現(xiàn)留給開發(fā)人員：

? 創(chuàng)建存儲社交身份驗證數(shù)據(jù)所需的數(shù)據(jù)庫表或列。
? 創(chuàng)建身份驗證過程中不存在的用戶。
? 在 OAuth 流程成功后對用戶進行身份驗證。
? 刷新 OAuth 令牌。

先決條件：創(chuàng)建 Google Cloud 項目

我們將建立一個小型社交項目，允許用戶通過 Google 進行身份驗證。為此，您必須創(chuàng)建一個 Google 應用。

首先創(chuàng)建一個新的 Google Cloud 項目，然后為該項目配置 OAuth 同意屏幕。將用戶類型設置為外部，然后啟用以下范圍：

.../auth/userinfo.email
.../auth/userinfo.profile

配置同意屏幕后，通過訪問 Google Cloud 憑據(jù)頁面創(chuàng)建 OAuth 2.0 客戶端 ID。保留客戶端ID和客戶端密鑰：我們稍后將在項目中使用它們。

使用 Socialite 設置一個最小的 Laravel 項目

創(chuàng)建一個新的 Laravel 項目：

laravel new socialite-tests

從安裝程序中選擇以下選項：

 ┌ Would you like to install a starter kit? ────────────────────┐
 │ No starter kit                                               │
 └──────────────────────────────────────────────────────────────┘

 ┌ Which testing framework do you prefer? ──────────────────────┐
 │ Pest                                                         │
 └──────────────────────────────────────────────────────────────┘

 ┌ Which database will your application use? ───────────────────┐
 │ SQLite                                                       │
 └──────────────────────────────────────────────────────────────┘

 ┌ Would you like to run the default database migrations? ──────┐
 │ Yes                                                          │
 └──────────────────────────────────────────────────────────────┘

切換到項目目錄并安裝Socialite。

laravel new socialite-tests

創(chuàng)建新的遷移。

 ┌ Would you like to install a starter kit? ────────────────────┐
 │ No starter kit                                               │
 └──────────────────────────────────────────────────────────────┘

 ┌ Which testing framework do you prefer? ──────────────────────┐
 │ Pest                                                         │
 └──────────────────────────────────────────────────────────────┘

 ┌ Which database will your application use? ───────────────────┐
 │ SQLite                                                       │
 └──────────────────────────────────────────────────────────────┘

 ┌ Would you like to run the default database migrations? ──────┐
 │ Yes                                                          │
 └──────────────────────────────────────────────────────────────┘

將以下代碼放入database/migrations中新創(chuàng)建的遷移文件中：

cd socialite-tests
composer require laravel/socialite

此遷移添加了當用戶成功進行身份驗證時由社交名流提供的字段。在我們的實現(xiàn)中，為了簡單起見，我們將這些字段直接添加到用戶表中。如果您想支持比 Google 更多的提供商，您可能需要創(chuàng)建一個單獨的表來存儲每個用戶的多個提供商。

我們將密碼設置為可為空，因為如果用戶僅通過 Google 進行身份驗證，則永遠不會設置密碼。如果您的應用允許社交身份驗證和密碼身份驗證，則當用戶嘗試通過密碼登錄時，您必須驗證密碼不為空或為空。

運行遷移。

php artisan make:migration add_socialite_fields_to_users

在 config/services.php 中，將以下代碼塊添加到 services 數(shù)組的末尾。您可以在配置文檔中找到有效社交名流服務名稱的完整列表。

<?php
// database/migrations/2024_12_31_075619_add_socialite_fields_to_users.php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::table('users', function (Blueprint $table) {
            $table->string('google_id')->default('');
            $table->string('google_token')->default('');
            $table->string('google_refresh_token')->default('');

            // If your app allows both password and social logins, you
            // MUST validate that the password is not blank during login.
            // If you do not, an attacker could gain access to an account
            // that uses social login by only knowing the email.
            $table->string('password')->nullable()->change();
        });
    }

    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::table('users', function (Blueprint $table) {
            $table->dropColumn('google_id');
            $table->dropColumn('google_token');
            $table->dropColumn('google_refresh_token');
            $table->string('password')->nullable(false)->change();
        });
    }
};

使用您在“先決條件”部分中創(chuàng)建的 Google 應用中的憑據(jù)，將以下內容添加到 .env。

php artisan migrate

將routes/web.php的內容替換為以下代碼。

// config/services.php

'google' => [
    'client_id' => env('GOOGLE_CLIENT_ID'),
    'client_secret' => env('GOOGLE_CLIENT_SECRET'),
    'redirect' => '/auth/google/callback',
],

此文件中的新代碼實現(xiàn)了以下路由：

重定向到 Google 以使用適當?shù)男畔⑦M行社交登錄。
處理來自 Google 的回調。此路由在登錄時創(chuàng)建或更新用戶，然后對他們進行身份驗證，并將他們重定向到主頁。
注銷經(jīng)過身份驗證的用戶。

最后，將 resources/views/welcome.php 的內容替換為以下標記。

# .env

GOOGLE_CLIENT_ID="your-google-client-id"
GOOGLE_CLIENT_SECRET="your-google-client-secret"

完成后，我們可以通過運行開發(fā)服務器來手動測試應用程序。

<?php
// routes/web.php

use App\Models\User;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Route;
use Laravel\Socialite\Facades\Socialite;
use Laravel\Socialite\Two\InvalidStateException;
use Laravel\Socialite\Two\User as OAuth2User;

Route::get('/', function () {
    return view('welcome');
});

Route::get('/auth/google/redirect', function () {
    return Socialite::driver('google')->redirect();
});

Route::get('/auth/google/callback', function () {
    try {
        /** @var OAuth2User $google_user */
        $google_user = Socialite::driver('google')->user();
    } catch (InvalidStateException $exception) {
        abort(400, $exception->getMessage());
    }

    $user = User::updateOrCreate([
        'email' => $google_user->email,
    ], [
        'google_id' => $google_user->id,
        'name' => $google_user->name,
        'google_token' => $google_user->token,
        'google_refresh_token' => $google_user->refreshToken,
    ]);

    Auth::login($user);
    return redirect('/');
});

Route::get('/auth/logout', function () {
    Auth::logout();
    return redirect('/');
});

當您點擊使用 Google 登錄鏈接時，您應該完成 OAuth2 流程并被重定向到主頁，您可以在其中查看有關來自 Google 的新創(chuàng)建用戶的信息。

用害蟲測試社交名流

我們的手動測試有效，但我們希望通過自動化測試來驗證我們將來不會意外破壞此功能。

我們可以使用以下命令創(chuàng)建一個新的測試文件。

<!-- resources/views/welcome.php -->
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Laravel Socialite Testing Example</title>
</head>
<body>
    <h1>Laravel Socialite Testing Example</h1>
    @if (auth()->check())
        <p>User is authenticated.</p>
        <p>Name: {{ auth()->user()->name }}</p>
        <p>Email: {{ auth()->user()->email }}</p>
        <p><a href="/auth/logout">Logout</a></p>
    @else
        <p>User is not authenticated.</p>
        <p>
            <a href="/auth/google/redirect">Login with Google</a>
        </p>
    @endif
</body>
</html>

將新創(chuàng)建的tests/Feature/AuthRoutesTest.php 的內容替換為以下內容。

php artisan serve

測試如何進行

在測試重定向路由時，我們測試Socialite是否重定向到正確的URL并傳遞正確的URL參數(shù)。

在測試回調路由時，我們模擬了 Socialite。模擬不是我最喜歡的選擇：在理想的世界中，我們可以將 Socialite 替換為另一個 OAuth2 實現(xiàn)，并且我們的測試仍然有效。但是，沒有直接的方法來連接社交名流發(fā)送的授權授予請求以裝飾訪問令牌。正因為如此，模擬是測試社交名流的最實用的方法。

通過 Mockery 模擬流暢的 API 非常乏味：您必須從最終調用開始并向后進行。

這是我們的回調端點調用的 Socialite 方法。

laravel new socialite-tests

以下是如何通過 Mockery 來嘲笑它：

 ┌ Would you like to install a starter kit? ────────────────────┐
 │ No starter kit                                               │
 └──────────────────────────────────────────────────────────────┘

 ┌ Which testing framework do you prefer? ──────────────────────┐
 │ Pest                                                         │
 └──────────────────────────────────────────────────────────────┘

 ┌ Which database will your application use? ───────────────────┐
 │ SQLite                                                       │
 └──────────────────────────────────────────────────────────────┘

 ┌ Would you like to run the default database migrations? ──────┐
 │ Yes                                                          │
 └──────────────────────────────────────────────────────────────┘

最后，我們進行了一項測試，以確保直接導航到 OAuth 流程之外的回調 URL 會返回 400 狀態(tài)代碼。我們將對 Socialite::driver('google')->user() 的調用包裝在 try/catch 塊內的回調端點中。如果我們沒有將 Socialite 調用包裝在 try/catch 塊中，并且有人在瀏覽器中輸入了回調 URL，則端點將引發(fā)帶有 HTTP 500 狀態(tài)代碼的異常。如果您的團隊設置了 500 個狀態(tài)代碼的監(jiān)控，則可能會導致某人在半夜收到尋呼。

總結

這是一個最小的集成，還有很多可以實現(xiàn)的功能。如果我們要實現(xiàn)與社交提供商的集成，其中用戶的電子郵件可能會更改，則此實現(xiàn)將不起作用，因為它與電子郵件地址匹配。如果用戶可以在我們的應用程序中更改他們的電子郵件地址，那么由于同樣的原因，此實現(xiàn)也將不起作用。但是，現(xiàn)在您已經(jīng)了解了如何測試 Socialite，您可以為這些場景編寫測試并修改底層實現(xiàn)，以便它們通過。

在我了解如何構建自己的實現(xiàn)、如何測試它以及我應該考慮什么之前，我閱讀了很多有關 Socialite 的博客文章和論壇帖子。我想對其中的一些人表示感謝。