Laravel에서 Socialite 인증 구현 및 테스트

Laravel Socialite는 개발자가 애플리케이션에서 OAuth 및 OAuth2 소셜 인증을 구현하는 데 도움이 되는 자사 Laravel 패키지입니다. Facebook, Twitter, Google, LinkedIn, GitHub, GitLab 및 Bitbucket을 기본적으로 지원합니다. Socialite는 커뮤니티 패키지를 통해 다른 제공업체를 지원할 수 있습니다.

이 게시물의 내용은 다음과 같습니다.

• 소셜라이트가 하는 일과 하지 않는 일을 설명하세요.
• Socialite를 통해 Google 인증을 새로운 Laravel 프로젝트에 통합하는 방법을 보여줍니다.
• 소셜라이트 테스트 예시를 보여주세요.

TLDR: 내 GitHub에서 완료된 프로젝트를 볼 수 있습니다. 완성된 코드를 읽고 싶다면 한 번 살펴보세요.

Laravel Socialite는 무엇을 하고 무엇을 하지 않습니까?

Socialite는 기본 API가 주로 두 가지 주요 메서드로 구성된 작은 패키지입니다.

• Socialite::driver($authProvider)->redirect()는 사용자를 지정된 인증 제공업체로 리디렉션하고 URL 매개변수를 통해 필요한 정보를 제공업체에 전달합니다.
• Socialite::driver($authProvider)->user()는 인증 공급자로부터 다시 전달된 사용자 데이터를 검색하여 엔드포인트에서 사용할 수 있도록 합니다.

설정 범위 및 선택적 매개변수에 대한 추가 지원 방법이 있습니다. 이에 대한 내용은 Socialite 문서에서 읽어보실 수 있습니다.

Socialite는 다음을 수행하지 않습니다 이러한 기능의 구현은 개발자에게 맡깁니다.

• ❌ 소셜 인증 데이터를 저장하는 데 필요한 데이터베이스 테이블이나 열을 만듭니다.
• ❌ 인증 과정에서 존재하지 않는 사용자를 생성합니다.
• ❌ OAuth 흐름이 성공한 후 사용자를 인증하세요.
• ❌ OAuth 토큰을 새로 고칩니다.

기본 요건: Google Cloud 프로젝트 만들기

사용자가 Google을 통해 인증할 수 있는 소규모 Socialite 프로젝트를 설정하겠습니다. 그러기 위해서는 구글 앱을 만들어야 합니다.

먼저 새 Google Cloud 프로젝트를 만든 다음 프로젝트에 대한 OAuth 동의 화면을 구성하세요. 사용자 유형을 외부로 설정한 후 다음 범위를 활성화하세요.

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

동의 화면을 구성한 후 Google Cloud 자격 증명 페이지를 방문하여 OAuth 2.0 클라이언트 ID를 생성하세요. 클라이언트 ID와 클라이언트 비밀번호를 보관하세요. 나중에 프로젝트에서 사용할 것입니다.

Socialite를 사용하여 최소 Laravel 프로젝트 설정

새 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

새 마이그레이션을 생성하세요.

 ┌ 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에 새로 생성된 마이그레이션 파일에 다음 코드를 배치하세요.

cd socialite-tests
composer require laravel/socialite

이 마이그레이션에는 사용자가 성공적으로 인증되면 Socialite에서 제공할 필드가 추가됩니다. 구현에서는 단순화를 위해 이러한 필드를 사용자 테이블에 직접 추가합니다. Google보다 더 많은 공급자를 지원하려면 사용자당 여러 공급자를 저장할 수 있는 별도의 테이블을 만드는 것이 좋습니다.

사용자는 Google을 통해서만 인증하는 경우 비밀번호를 설정하지 않으므로 비밀번호를 null 허용으로 설정합니다. 앱에서 소셜 인증및 비밀번호 인증을 허용하는 경우 사용자가 비밀번호를 통해 로그인을 시도할 때 비밀번호가 비어 있거나 null이 아닌지 반드시 확인해야 합니다.

마이그레이션을 실행합니다.

php artisan make:migration add_socialite_fields_to_users

config/services.php에서 서비스 배열 끝에 다음 코드 블록을 추가합니다. 구성 문서에서 유효한 Socialite 서비스 이름의 전체 목록을 찾을 수 있습니다.

<?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();
        });
    }
};

'전제 조건' 섹션에서 생성한 Google 앱의 자격 증명을 사용하여 .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',
],

이 파일의 새 코드는 다음 경로를 구현합니다.

• 적절한 정보를 사용하여 소셜 로그인을 위해 Google로 리디렉션합니다.
• Google의 콜백을 처리합니다. 이 경로는 로그인 시 사용자를 생성하거나 업데이트한 후 인증하고 홈페이지로 리디렉션합니다.
• 인증된 사용자를 로그아웃합니다.

마지막으로 resources/views/welcome.php의 내용을 다음 마크업으로 바꿉니다.

# .env

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

이 작업이 완료되면 개발 서버를 실행하여 앱을 수동으로 테스트할 수 있습니다.

<?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에서 새로 생성된 사용자에 대한 정보를 볼 수 있는 홈페이지로 리디렉션됩니다.

해충으로 사교계 명사 테스트하기

수동 테스트는 작동하지만 앞으로는 실수로 이 기능이 중단되지 않는지 확인하기 위해 자동화된 테스트를 원합니다.

다음 명령어로 새로운 테스트 파일을 생성할 수 있습니다.

<!-- 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>

새로 생성된 테스트/Feature/AuthRoutesTest.php의 내용을 다음으로 바꿉니다.

php artisan serve

테스트 작동 방식

리디렉션 경로를 테스트할 때 Socialite가 올바른 URL로 리디렉션되고 올바른 URL 매개변수를 전달하는지 테스트합니다.

콜백 경로를 테스트할 때 Socialite를 모의합니다. 조롱은 제가 가장 좋아하는 옵션이 아닙니다. 이상적인 세상에서는 Socialite를 다른 OAuth2 구현으로 교체할 수 있으며 테스트는 여전히 작동할 것입니다. 그러나 Socialite가 액세스 토큰을 장식하기 위해 보내는 인증 부여 요청에 연결하는 간단한 방법은 없습니다. 그렇기 때문에 모킹은 소셜라이트를 테스트하는 가장 실용적인 접근 방식입니다.

Fluent API는 Mockery를 통해 모의하기가 지루합니다. 최종 호출부터 시작하여 거꾸로 작업해야 합니다.

콜백 엔드포인트가 호출하는 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 상태 코드가 반환되는지 확인하는 테스트가 있습니다. try/catch 블록 내의 콜백 엔드포인트에서 Socialite::driver('google')->user()에 대한 호출을 래핑했습니다. Socialite 호출을 try/catch 블록으로 래핑하지 않았고 누군가 브라우저에 콜백 URL을 입력한 경우 엔드포인트는 HTTP 500 상태 코드와 함께 예외를 발생시킵니다. 팀에서 500개의 상태 코드에 대한 모니터링을 설정한 경우 누군가 한밤중에 호출을 받을 수 있습니다.

마무리

이것은 최소한의 통합이며 구현할 수 있는 것이 훨씬 더 많습니다. 사용자의 이메일이 변경될 수 있는 소셜 공급자와의 통합을 구현하는 경우 이 구현은 이메일 주소와 일치하므로 작동하지 않습니다. 사용자가 앱 내에서 이메일 주소를 변경할 수 있는 경우에도 같은 이유로 이 구현이 작동하지 않습니다. 그러나 이제 Socialite를 테스트하는 방법을 살펴보았으므로 이러한 시나리오에 대한 테스트를 작성하고 기본 구현을 수정하여 통과할 수 있습니다.

저는 Socialite에 대한 많은 블로그 기사와 포럼 게시물을 읽은 후에 자체 구현을 구축하는 방법, 테스트하는 방법, 생각해야 할 사항을 이해했습니다. 여기에서 그 중 일부를 인정하고 싶습니다.

• Stefan Zweifel의 Laravel Socialite 기반 앱에 대한 통합 테스트 작성 방법
• ServerSideUp 포럼: Socialite 모범 사례, 대화
• 스택 오버플로: Laravel Socialite 테스트 방법
• 스택 교환: 소셜 로그인을 일치하는 이메일과 연결하거나 연결하지 않으려면
• Stack Exchange: 연결된 소셜 계정 및 잠재적인 고아 처리

더 자세히 알아보고 싶다면 읽어보세요. 또한, 여러 소셜 공급자 처리, 사용자의 이메일 주소 변경 처리 또는 새로 고침 토큰 처리에 대해 자세히 알아보는 이 게시물의 2부에도 관심이 있으시면 알려주시기 바랍니다.

위 내용은 Laravel에서 Socialite 인증 구현 및 테스트의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!