Точка входу: допомога користувачам з початком аутентифікації

Дата оновлення перекладу 2022-11-26

Точка входу: допомога користувачам з початком аутентифікації

Коли неаутентифікований користувач намагається отримати доступ до захищеної сторінки, Symfony надає йому належну відповідь, щоб дозволити йому почати аутентифікацію (наприклад, перенаправдяє на форму входу у систему або відображає відповідь HTTP 401 Неавторизовано, для API).

Однак, інодні, один брандмауер має багато способів аутентифікації (наприклад, і форму входу у систему, і соціальний вхід у систему). У таких випадках необхідно сконфігурувати точку входу аутентифікації.

Ви можете сконфігурувати її, використовуючи налаштування entry_point:

YAML
XML
PHP

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        # config/packages/security.yaml
security:
    enable_authenticator_manager: true

    # ...
    firewalls:
        main:
            # дозволити аутентифікацію, використовуючи форму або користувацький аутентифікатор
            form_login: ~
            custom_authenticators:
                - App\Security\SocialConnectAuthenticator

            # сконфігурувати форму аутентифікації як точку входу для неаутентифікованих користувачів
            entry_point: form_login
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
        <!-- config/packages/security.xml -->
<?xml version="1.0" encoding="UTF-8"?>
<srv:container xmlns="http://symfony.com/schema/dic/security"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:srv="http://symfony.com/schema/dic/services"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/security
        https://symfony.com/schema/dic/security/security-1.0.xsd">

    <config enable-authenticator-manager="true">
        <!-- ... -->

        <!-- entry-point: сконфігурувати форму аутентифікації як точку входу
                          для неаутентифицированных пользователей -->
        <firewall name="main"
            entry-point="form_login"
        >
            <!-- дозволити аутентифікацію, використовуючи форму або користувацький аутентифікатор -->
            <form-login/>
            <custom-authenticator>App\Security\SocialConnectAuthenticator</custom-authenticator>
        </firewall>
    </config>
</srv:container>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
        // config/packages/security.php
use Symfony\Config\SecurityConfig;
use App\Security\SocialConnectAuthenticator;

return static function (SecurityConfig $security) {
    $security->enableAuthenticatorManager(true);
    // ....


    // дозволити аутентифікацію, використовуючи форму або базовий HTTP
    $mainFirewall = $security->firewall('main');
    $mainFirewall
        ->formLogin()
        ->customAuthenticators([SocialConnectAuthenticator::class])

        // сконфігурувати форму аутентифікації як точку входу для неаутентифікованих користувачів
        ->entryPoint('form_login');
    ;
};
    

Note

Ви також можете створити власну точку входу аутентифікації, створивши клас, що реалізує AuthenticationEntryPointInterface. Потім, ви можете встановити entry_point у сервіс-id (наприклад, entry_point: App\Security\CustomEntryPoint)

Багато аутентифікаторів з різними точками входу

Однак, існують випадки застосування, де у вас є аутентифікатори, які захищають різні частини вашого додатку. Наприклад, у вас є форма входу у систему, що захищає основний веб-сайт та кінцеві точки API, використовувані зовнішніми сторонами, захищені ключами API.

Так як ви можете сконфігурувати лише по одній точці входу для одного брандмауера, рішенням буде розділити конфігурацію на два окремих брандмауери:

YAML
XML
PHP

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
        # config/packages/security.yaml
security:
    # ...
    firewalls:
        api:
            pattern: ^/api/
            custom_authenticators:
                - App\Security\ApiTokenAuthenticator
        main:
            lazy: true
            form_login: ~

    access_control:
        - { path: '^/login', roles: PUBLIC_ACCESS }
        - { path: '^/api', roles: ROLE_API_USER }
        - { path: '^/', roles: ROLE_USER }
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
        <!-- config/packages/security.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<srv:container xmlns="http://symfony.com/schema/dic/security"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:srv="http://symfony.com/schema/dic/services"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd
        http://symfony.com/schema/dic/security
        https://symfony.com/schema/dic/security/security-1.0.xsd">

    <config>
        <!-- ... -->
        <firewall name="api" pattern="^/api/">
            <custom-authenticator>App\Security\ApiTokenAuthenticator</custom-authenticator>
        </firewall>

        <firewall name="main" anonymous="true" lazy="true">
            <form-login/>
        </firewall>

        <rule path="^/login" role="PUBLIC_ACCESS"/>
        <rule path="^/api" role="ROLE_API_USER"/>
        <rule path="^/" role="ROLE_USER"/>
    </config>
</srv:container>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
        // config/packages/security.php
use App\Security\ApiTokenAuthenticator;
use App\Security\LoginFormAuthenticator;
use Symfony\Config\SecurityConfig;

return static function (SecurityConfig $security) {
    $apiFirewall = $security->firewall('api');
    $apiFirewall
        ->pattern('^/api')
        ->customAuthenticators([ApiTokenAuthenticator::class])
    ;

    $mainFirewall = $security->firewall('main');
    $mainFirewall
        ->lazy(true)
        ->formLogin();

    $accessControl = $security->accessControl();
    $accessControl->path('^/login')->roles(['IS_AUTHENTICATED_ANONYMOUSLY']);
    $accessControl->path('^/api')->roles(['ROLE_API_USER']);
    $accessControl->path('^/')->roles(['ROLE_USER']);
};
    