Аутентификация

Средства Laravel для аутентификации состоят из «защитников» и «провайдеров». Защитники определяют то, как аутентифицируются пользователи для каждого запроса. Например, Laravel поставляется с защитником «session», который поддерживает состояние с помощью хранилища сессий и cookies.

Провайдеры определяют то, как пользователи извлекаются из вашего постоянного хранилища. Laravel поставляется с поддержкой извлечения пользователей с помощью Eloquent и конструктора запросов БД. Но при необходимости вы можете определить для своего приложения дополнительные провайдеры.

Не переживайте, если сейчас это звучит запутанно! Для многих приложений никогда не потребуется изменять стандартные настройки аутентификации.

RegisterController обрабатывает регистрацию нового пользователя, LoginController обрабатывает аутентификацию, ForgotPasswordController обрабатывает отправку по почте ссылок для сброса паролей, ResetPasswordController содержит логику для сброса паролей.

AuthController обрабатывает регистрацию и аутентификацию нового пользователя, а PasswordController содержит логику для помощи существующим пользователям при сбросе забытых паролей.

Laravel обеспечивает быстрый способ создания заготовок всех необходимых для аутентификации маршрутов и представлений с помощью одной команды:

shphp artisan make:auth

Эту команду надо использовать на свежем приложении, она установит представление макета, представления для регистрации и входа, а также маршруты для всех конечных точек аутентификации. Также будет сгенерирован HomeController для обслуживания запросов к панели настроек вашего приложения после входа.

По умолчанию в Laravel нет маршрутов для запросов к контроллерам аутентификации. Вы можете добавить их вручную в файле app/Http/routes.php:

// Маршруты аутентификации...
Route::get('auth/login', 'Auth\AuthController@getLogin');
Route::post('auth/login', 'Auth\AuthController@postLogin');
Route::get('auth/logout', 'Auth\AuthController@getLogout');

// Маршруты регистрации...
Route::get('auth/register', 'Auth\AuthController@getRegister');
Route::post('auth/register', 'Auth\AuthController@postRegister');

Как было сказано в предыдущем разделе, команда shphp artisan make:auth создаст все необходимые вам представления для аутентификации и поместит их в папку resources/views/auth` directory.

Также команда shmake:auth создаст папку resources/views/layouts, содержащую основной макет для вашего приложения. Все эти представления используют CSS-фреймворк Bootstrap, но вы можете изменять их как угодно.

Не смотря на то, что контроллеры аутентификации включены в фреймворк, вам необходимо предоставить представления, которые эти контроллеры смогут отрисовать. Представления необходимо расположить в каталоге resources/views/auth. Вы вольны настроить эти представления так, как сами желаете. Представление для входа в систему должно быть в resources/views/auth/login.blade.php, а представление для регистрации — в resources/views/auth/register.blade.php.

Пример формы аутентификации

<!-- resources/views/auth/login.blade.php -->

<form method="POST" action="/auth/login">
  {!! csrf_field() !!}

  <div>
    Email
    <input type="email" name="email" value="{{ old('email') }}">
  </div>

  <div>
    Password
    <input type="password" name="password" id="password">
  </div>

  <div>
    <input type="checkbox" name="remember"> Remember Me
  </div>

  <div>
    <button type="submit">Login</button>
  </div>
</form>

Пример формы регистрации

<!-- resources/views/auth/register.blade.php -->

<form method="POST" action="/auth/register">
  {!! csrf_field() !!}

  <div>
    Name
    <input type="text" name="name" value="{{ old('name') }}">
  </div>

  <div>
    Email
    <input type="email" name="email" value="{{ old('email') }}">
  </div>

  <div>
    Password
        <input type="password" name="password">
  </div>

  <div>
    Confirm Password
    <input type="password" name="password_confirmation">
  </div>

  <div>
    <button type="submit">Register</button>
  </div>
</form>

Когда пользователь успешно аутентифицируется, он будет перенаправлен на URI /home (для версии 5.2 — URI /). Вы можете изменить место для перенаправления после входа, задав свойство redirectTo контроллеров LoginController, RegisterController и ResetPasswordController (для версии 5.2 — контроллера AuthController):

protected $redirectTo = '/';

Когда пользователь успешно аутентифицируется, он будет перенаправлен на URI /. Вы можете изменить место для перенаправления после входа, задав свойство redirectTo контроллера AuthController:

protected $redirectTo = '/home';

Если для генерирования пути для переадресации необходима дополнительная логика, вы можете определить метод PHPredirectTo() вместо свойства redirectTo:

protected function redirectTo()
{
  //
}

У метода PHPredirectTo() приоритет выше, чем у атрибута redirectTo.

Изменение пользователя

По умолчанию Laravel использует для аутентификации поле email. Чтобы изменить это, определите метод PHPusername() в своём LoginController:

public function username()
{
  return 'username';
}

Когда аутентификация пользователя не успешна, он автоматически будет перенаправлен обратно на форму входа.

Чтобы изменить место для перенаправления после выхода из приложения, вы можете задать свойство redirectAfterLogout контроллера AuthController:

protected $redirectAfterLogout = '/login';

Если это свойство не задано, пользователь будет перенаправлен на URI /.

Вы также можете изменить «защитника», используемого для аутентификации и регистрации пользователей. Для начала определите метод PHPguard() в контроллерах LoginController, RegisterController и ResetPasswordController. Метод должен возвращать экземпляр защитника:

use Illuminate\Support\Facades\Auth;

protected function guard()
{
  return Auth::guard('guard-name');
}

Вы также можете изменить «защитника», используемого для аутентификации пользователей. Для начала задайте свойство guard контроллера AuthController. Значение этого свойства должно соответствовать одному из защитников, настроенных в вашем файле настроек auth.php:

protected $guard = 'admin';

Когда пользователь успешно аутентифицирован, он будет переадресован к URI /home, для обработки которой вам необходимо будет зарегистрировать маршрут. Вы можете настроить место для переадресации после аутентификации, задав свойство redirectPath в AuthController:

protected $redirectPath = '/dashboard';

Когда аутентификация пользователя не успешна, он будет переадресован на URI /auth/login. Вы можете настроить место для переадресации после неудачной аутентификации, задав свойство loginPath в AuthController:

protected $loginPath = '/login';

Свойство loginPath не влияет на то, куда будут переходить пользователи при попытке доступа к защищённому маршруту. Это контролируется методом PHPhandle() посредника App\Http\Middleware\Authenticate.

Также вы можете указать тип контракта Illuminate\Contracts\Auth\Authenticatable. Это указание типа может быть добавлено к конструктору контроллера, методу контроллера или любому другому конструктору класса, реализуемому в сервис-контейнере:

<?php namespace App\Http\Controllers;

use Illuminate\Routing\Controller;
use Illuminate\Contracts\Auth\Authenticatable;

class ProfileController extends Controller {

  /**
   * Обновление профиля пользователя.
   *
   * @return Response
   */
  public function updateProfile(Authenticatable $user)
  {
    // $user  - это экземпляр аутентифицированного пользователя...
  }

}

Laravel поставляется с посредником auth, который определён в Illuminate\Auth\Middleware\Authenticate. Поскольку посредник уже зарегистрирован в вашем HTTP-ядре, вам остаётся только присоединить его к определению маршрута:

Route::get('profile', function () {
  // Только аутентифицированные пользователи могут зайти...
})->middleware('auth');

Laravel поставляется с посредником auth, который определён в app\Http\Middleware\Authenticate.php. Всё, что вам надо сделать — это присоединить его к определению маршрута:

// С помощью замыкания маршрута...

Route::get('profile', ['middleware' => 'auth', function() {
  // Только аутентифицированные пользователи могут зайти...
}]);

// С помощью контроллера...

Route::get('profile', [
  'middleware' => 'auth',
  'uses' => 'ProfileController@show'
]);

Во время прикрепления посредника auth к маршруту, вы можете также указать, какой защитник должен быть использован для аутентификации пользователя. Указанный защитник должен соответствовать одному из ключей в массиве guards вашего файла auth.php:

public function __construct()
{
  $this->middleware('auth:api');
}

Во время прикрепления посредника auth к маршруту, вы можете также указать, какой защитник должен быть использован для выполнения аутентификации:

Route::get('profile', [
  'middleware' => 'auth:api',
  'uses' => 'ProfileController@show'
]);

Указанный защитник должен соответствовать одному из ключей в массиве guards конфигурационного файла PHPauth.php.

Блокировка входа

Если вы используете встроенный в Laravel класс LoginController, то типаж Illuminate\Foundation\Auth\ThrottlesLogins уже включён в ваш контроллер. По умолчанию пользователь не сможет войти в приложение в течение одной минуты, если он несколько раз указал неправильные данные для входа. Блокировка происходит отдельно для имени пользователя/адреса e-mail и его IP-адреса.

Блокировка аутентификации

Если вы используете встроенный в Laravel класс AuthController, то вы можете использовать типаж Illuminate\Foundation\Auth\ThrottlesLogins для блокировки попыток входа в ваше приложение. По умолчанию пользователь не сможет войти в приложение в течение одной минуты, если он несколько раз указал неправильные данные для входа. Блокировка происходит отдельно для имени пользователя/адреса e-mail и его IP-адреса:

<?php

namespace App\Http\Controllers\Auth;

use App\User;
use Validator;
use App\Http\Controllers\Controller;
use Illuminate\Foundation\Auth\ThrottlesLogins;
use Illuminate\Foundation\Auth\AuthenticatesAndRegistersUsers;

class AuthController extends Controller
{
    use AuthenticatesAndRegistersUsers, ThrottlesLogins;

    // Остальное содержимое класса...
}

Обращение к конкретным экземплярам защитника

С помощью метода PHPguard() фасада Auth вы можете указать, какой экземпляр защитника необходимо использовать. Это позволяет управлять аутентификацией для отдельных частей вашего приложения, используя полностью отдельные модели для аутентификации или таблицы пользователей.

Передаваемое в метод PHPguard() имя защитника должно соответствовать одному из защитников, настроенных в файле auth.php:

if (Auth::guard('admin')->attempt($credentials)) {
  //
}

Если вы используете встроенный в Laravel LoginController, необходимая логика для «запоминания» пользователей уже реализована типажами, используемыми контроллером.

// Войти и "запомнить" данного пользователя...
Auth::login($user, true);

Конечно, вы можете указать, какой экземпляр защитника надо использовать:

Auth::guard('admin')->login($user);

Проверка данных пользователя без входа в систему

Метод PHPvalidate() позволяет проверять учётные данные пользователя без фактического входа в приложение:

if (Auth::validate($credentials)) {
  //
}

Все необходимые для сброса пароля маршруты можно сгенерировать с помощью Artisan-команды shmake:auth:

shphp artisan make:auth

Но вам надо определить маршруты для запросов к этому контроллеру:

// Маршруты запроса ссылки для сброса пароля...
Route::get('password/email', 'Auth\PasswordController@getEmail');
Route::post('password/email', 'Auth\PasswordController@postEmail');

// Маршруты сброса пароля...
Route::get('password/reset/{token}', 'Auth\PasswordController@getReset');
Route::post('password/reset', 'Auth\PasswordController@postReset');

И снова, Laravel создаст все необходимые представления для сброса пароля по команде shmake:auth. Эти представления будут помещены в resources/views/auth/passwords. Вы можете свободно изменять их для вашего приложения.

Кроме определения маршрутов для PasswordController, вам надо предоставить представления, которые могут быть возвращены этим контроллером. Не волнуйтесь, мы предоставили примеры представлений, чтобы вам было легче начать. Вы можете изменить эти шаблоны под дизайн своего приложения.

Пример формы запроса ссылки для сброса пароля

Вам надо сделать HTML-представление для формы запроса сброса пароля. Это представление должно быть помещено в resources/views/auth/password.blade.php. Эта форма предоставляет единственное поле для ввода адреса e-mail, позволяя запросить ссылку для сброса пароля:

<!-- resources/views/auth/password.blade.php -->

<form method="POST" action="/password/email">
  {!! csrf_field() !!}

  @if (count($errors) > 0)
    <ul>
      @foreach ($errors->all() as $error)
        <li>{{ $error }}</li>
      @endforeach
    </ul>
  @endif

  <div>
    Email
    <input type="email" name="email" value="{{ old('email') }}">
  </div>

  <div>
    <button type="submit">
      Send Password Reset Link
    </button>
  </div>
</form>

Когда пользователь подтвердит запрос на сброс пароля, он получит электронное письмо со ссылкой, которая указывает на метод PHPgetReset() (обычно расположенный по маршруту /password/reset) контроллера PasswordController. Вам надо создать представление для этого письма в resources/views/emails/password.blade.php. Представление получит переменную PHP$token, которая содержит ключ для сброса пароля, по которому происходит сопоставление пользователя с запросом сброса пароля. Вот пример представления для e-mail:

<!-- resources/views/emails/password.blade.php -->

Нажмите здесь для сброса пароля: {{ url('password/reset/'.$token) }}

Пример формы сброса пароля

Когда пользователь переходит по ссылке из письма для сброса пароля, ему автоматически будет выведена форма сброса пароля. Это представление необходимо поместить в resources/views/auth/reset.blade.php.

Вот пример формы сброса пароля:

<!-- resources/views/auth/reset.blade.php -->

<form method="POST" action="/password/reset">
  {!! csrf_field() !!}
  <input type="hidden" name="token" value="{{ $token }}">

  @if (count($errors) > 0)
    <ul>
      @foreach ($errors->all() as $error)
        <li>{{ $error }}</li>
      @endforeach
    </ul>
  @endif

  <div>
    Email
    <input type="email" name="email" value="{{ old('email') }}">
  </div>

  <div>
    Password
    <input type="password" name="password">
  </div>

  <div>
    Confirm Password
    <input type="password" name="password_confirmation">
  </div>

  <div>
    <button type="submit">
      Reset Password
    </button>
  </div>
</form>

Настройка защитника аутентификации

В файле настроек auth.php вы можете настроить несколько «защитников», которых можно использовать для задания логики аутентификации для нескольких таблиц пользователей. Вы можете изменить встроенный PasswordController, чтобы он использовал необходимого вам защитника, добавив в контроллер свойство $guard:

/**
 * Будет использоваться указанный защитник аутентификации.
 *
 * @var string
 */
protected $guard = 'admins';

Настройка брокера паролей

Вы можете настроить несколько «брокеров» паролей в файле настроек auth.php, их можно использовать для сброса паролей в нескольких таблицах пользователей. Вы можете изменить встроенный PasswordController, чтобы он использовал необходимого вам брокера, добавив в контроллер свойство $broker:

/**
 * Будет использоваться указанный брокер паролей.
 *
 * @var string
 */
protected $broker = 'admins';

Добавление собственных защитников

Вы можете определить своих собственных защитников аутентификации с помощью метода PHPextend() фасада Auth. Вам нужно разместить этот вызов «провайдера» в сервис-провайдере. Поскольку в Laravel уже есть AuthServiceProvider, мы можем поместить код в этот провайдер:

Как видите, в этом примере переданная в метод PHPextend() функция обратного вызова должна вернуть реализацию Illuminate\Contracts\Auth\Guard. Этот интерфейс содержит несколько методов, которые вам надо реализовать, для определения собственного защитника. Когда вы определили своего защитника, вы можете использовать его в настройке guards в вашем файле auth.php:

conf'guards' => [
  'api' => [
    'driver' => 'jwt',
    'provider' => 'users',
  ],
],

Социальная аутентификация

Для версии 5.2 и выше данный раздел перенесён на GitHub — прим. пер.

В дополнение к обычной аутентификации на основе формы, Laravel также предоставляет простой и удобный способ аутентификации с помощью провайдеров OAuth, используя Laravel Socialite. Socialite в настоящее время поддерживает аутентификацию через Facebook, Twitter, LinkedIn, Google, GitHub и Bitbucket.

Чтобы начать работать с Socialite, добавьте зависимость в свой файл composer.json:

confcomposer require laravel/socialite

Настройка

После установки библиотеки Socialite зарегистрируйте Laravel\Socialite\SocialiteServiceProvider в своем конфигурационном файле config/app.php.

conf'providers' => [
  // Другие сервис-провайдеры...

  Laravel\Socialite\SocialiteServiceProvider::class,
],

Также добавьте фасад Socialite в массив aliases в файле app:

conf'Socialite' => Laravel\Socialite\Facades\Socialite::class,

Вам будет необходимо добавить учётные данные для сервисов OAuth, которые использует ваше приложение. Эти учётные данные должны быть помещены в ваш конфигурационный файл config/services.php и должны использовать ключ facebook, twitter, linkedin, google, github или bitbucket, в зависимости от провайдеров, которые необходимы вашему приложению. Например:

conf'github' => [
  'client_id' => 'your-github-app-id',
  'client_secret' => 'your-github-app-secret',
  'redirect' => 'http://your-callback-url',
],

Основы использования

Теперь можно аутентифицировать пользователей! Вам будут нужны два маршрута: один для перенаправления пользователя на провайдер OAuth, и второй для получения обратного вызова от провайдера после аутентификации. Мы обратимся к Socialite через фасад Socialite:

<?php

namespace App\Http\Controllers;

use Socialite;
use Illuminate\Routing\Controller;

class AuthController extends Controller
{
  /**
   * Переадресация пользователя на страницу аутентификации GitHub.
   *
   * @return Response
   */
  public function redirectToProvider()
  {
    return Socialite::driver('github')->redirect();
  }

  /**
   * Получение информации о пользователе от GitHub.
   *
   * @return Response
   */
  public function handleProviderCallback()
  {
    $user = Socialite::driver('github')->user();

    // $user->token;
  }
}

Метод PHPredirect() отвечает за отправку пользователя провайдеру OAuth, а метод PHPuser() читает входящий запрос и получает информацию пользователя от провайдера. Прежде чем перенаправить пользователя, вы можете также установить «области видимости» для запроса с помощью метода PHPscope(). Этот метод переопределит все существующие области видимости:

return Socialite::driver('github')
            ->scopes(['scope1', 'scope2'])->redirect();

Само собой, вам необходимо определить маршруты для ваших методов контроллера:

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

Некоторые из провайдеров OAuth поддерживают необязательные параметры в запросе переадресации. Чтобы включить какие-либо необязательные параметры в запрос, вызовите метод PHPwith() с ассоциативным массивом:

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

Получение пользовательских данных

Когда у вас есть экземпляр пользователя, вы можете получить более подробную информацию о пользователе:

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

// Два провайдера OAuth
$token = $user->token;

// Один провайдер OAuth
$token = $user->token;
$tokenSecret = $user->tokenSecret;

// Все провайдеры
$user->getId();
$user->getNickname();
$user->getName();
$user->getEmail();
$user->getAvatar();

Добавление собственных провайдеров пользователей

Если вы не используете традиционную реляционную базу данных для хранения ваших пользователей, вам необходимо добавить в Laravel свой собственный провайдер аутентификации пользователей. Мы используем метод PHPprovider() фасада Auth для определения своего драйвера:

После регистрации провайдера методом PHPprovider(), вы можете переключиться на новый провайдер в файле настроек auth.php. Сначала определите «провайдера», который использует ваш новый драйвер:

conf'providers' => [
  'users' => [
    'driver' => 'riak',
  ],
],

И наконец, вы можете использовать этот провайдер в вашей настройке 'guards':

conf'guards' => [
  'web' => [
    'driver' => 'session',
    'provider' => 'users',
  ],
],

Добавление драйверов аутентификации

Данный раздел статьи добавлен в документацию для версии 5.1.
Для версий 5.2 и выше и 5.0 и ниже он неактуален.

Если вы не используете традиционную реляционную базу данных для хранения ваших пользователей, вам необходимо добавить в Laravel свой собственный драйвер аутентификации. Мы используем метод PHPextend() фасада Auth для определения своего драйвера. Вам надо поместить этот вызов метода PHPextend() в сервис-провайдер:

<?php

namespace App\Providers;

use Auth;
use App\Extensions\RiakUserProvider;
use Illuminate\Support\ServiceProvider;

class AuthServiceProvider extends ServiceProvider
{
  /**
   * Выполнение пост-регистрационной загрузки служб.
   *
   * @return void
   */
  public function boot()
  {
    Auth::extend('riak', function($app) {
      // Возврат экземпляра Illuminate\Contracts\Auth\UserProvider...
      return new RiakUserProvider($app['riak.connection']);
    });
  }

  /**
   * Регистрация привязок в контейнере.
   *
   * @return void
   */
  public function register()
  {
    //
  }
}

После регистрации драйвера методом PHPextend(), вы можете переключиться на новый драйвер в файле настроек config/auth.php.