• 5.6.29
  • کامل شده
  • منقضی شده
این داکیومنت از طرف توسعه‌دهنده ساپورت نمی‌شود، جدیدترین ورژن داکیومنت بزودی ترجمه خواهد شد.

این صفحه Passport را از زاویه نصب و راه‌اندازی بسته در پروژه Laravel 5.6 بررسی می‌کند. Passport پیاده‌سازی OAuth2 را برای API فراهم می‌کند و زمانی کاربرد دارد که برنامه‌های موبایل، وب یا سرویس‌های ثالث باید با Token و Scope محدود به منابع دسترسی پیدا کنند.

نصب و آماده‌سازی

composer require laravel/passport
php artisan migrate
php artisan passport:install

ثبت مسیرها و مدل کاربر

در AuthServiceProvider متد Passport::routes() را در متد boot() فراخوانی کنید. مدل User باید Trait HasApiTokens را داشته باشد. کلیدهای خصوصی و عمومی تولیدشده را با مجوز فایل محدود نگه دارید.

use Laravel\Passport\Passport;

public function boot()
{
    $this->registerPolicies();
    Passport::routes();
}

// App\User.php
use Laravel\Passport\HasApiTokens;

class User extends Authenticatable
{
    use HasApiTokens, Notifiable;
}

ساخت Token و Scope

برای صدور Token شخصی از createToken() استفاده می‌شود. Scopeها مشخص می‌کنند Token اجازه چه عملیاتی را دارد. در Route می‌توانید Middleware مربوط به Scope را اعمال کنید و در زمان صدور Token فقط مجوزهای لازم را بدهید.

$token = $user->createToken('mobile-client', ['orders:read'])->accessToken;

نکته مهم

Passport را با سیستم Session معمولی یکی ندانید. Redirect URI و Client Secret باید دقیق و محرمانه باشند و Scopeها را بر اساس اصل حداقل دسترسی تعریف کنید.

مطالعه مرتبط

برای ادامه مطالعه، OAuth، API، احراز هویت را ببینید.

قابلیت‌های Passport

متد یا مفهومکاربرد
passport:installساخت کلیدها و Clientهای اولیه.
Passport::routes()ثبت Routeهای OAuth.
HasApiTokensافزودن قابلیت Token به مدل User.
createToken()صدور Personal Access Token.
scopes()تعریف محدوده دسترسی.
tokenCan()بررسی Scope در برنامه.

ملاحظات اجرایی در Laravel 5.6

این قابلیت را در لایه‌ای قرار دهید که مسئولیت آن را دارد. تنظیمات عمومی در فایل‌های config، ثبت وابستگی‌ها در Service Provider، کنترل دسترسی در Middleware یا Policy و منطق دامنه در Service یا Model قرار می‌گیرند. از قرار دادن همه عملیات در Controller خودداری کنید تا آزمون و نگهداری ساده‌تر شود.

پیش از انتشار، رفتار را در محیط تست بررسی کنید: حالت کاربر مهمان، کاربر مجاز، ورودی نامعتبر، وابستگی در دسترس نبودن و Exception. اگر عملیات زمان‌بر است، بررسی کنید آیا باید به Queue منتقل شود. اگر داده موقت تولید می‌شود، Cache Invalidation و زمان انقضا را هم طراحی کنید.

متدهای passport:install، Passport::routes()، HasApiTokens، createToken() را با API نسخه 5.6 اجرا و تست کنید. بعضی APIها در نسخه‌های بعدی Laravel تغییر کرده‌اند، بنابراین نمونه‌های نسخه جدید را بدون تطبیق به این پروژه منتقل نکنید.

سایر پست های داکیومنت