Класс yii\authclient\OpenIdConnect

OpenIdConnect служит клиентом для потока OpenIdConnect.

Пример конфигурации приложения:

'components' => [
    'authClientCollection' => [
        'class' => 'yii\authclient\Collection',
        'clients' => [
            'google' => [
                'class' => 'yii\authclient\OpenIdConnect',
                'issuerUrl' => 'https://accounts.google.com',
                'clientId' => 'google_client_id',
                'clientSecret' => 'google_client_secret',
                'name' => 'google',
                'title' => 'Google OpenID Connect',
            ],
        ],
    ]
    // ...
]

Для проверки JWS этому классу требуется библиотека spomky-labs/jose. Ее можно установить через Composer:

composer require --prefer-dist "spomky-labs/jose:~5.0.6"

Примечание: если вы используете надежного поставщика OpenIdConnect, вы можете отключить $validateJws, сделав установку библиотеки spomky-labs/jose излишней, однако это не рекомендуется, так как нарушает спецификацию протокола.

См. также:

• http://openid.net/connect/
• yii\authclient\OAuth2

Публичные свойства

Публичные методы

Защищенные методы

Подробное описание свойств

$allowedJwsAlgorithms общественное свойство

JWS алгоритмы, которые разрешено использовать. Они используются библиотекой spomky-labs/jose для валидации/расшифровки JWS. Убедитесь, что spomky-labs/jose поддерживает конкретный алгоритм перед добавлением его сюда.

public array $allowedJwsAlgorithms = ['HS256', 'HS384', 'HS512', 'ES256', 'ES384', 'ES512', 'RS256', 'RS384', 'RS512', 'PS256', 'PS384', 'PS512']

$cache общественное свойство

Объект кэширования, null - если не включен.

public yii\caching\Cache|null getCache ( )
public void setCache ( $cache )

$configParams общественное только для чтения свойство

Параметры конфигурации поставщика OpenID.

public array getConfigParams ( )

$configParamsCacheKeyPrefix общественное свойство

Префикс для ключа, используемого для хранения данных $configParams в кэше. Фактический ключ кэша будет сформирован путем добавления значения $id к нему.

См. также $cache.

public string $configParamsCacheKeyPrefix = 'config-params-'

$issuerUrl общественное свойство

Базовый URL OpenID-эмитента (поставщика), например, https://example.com.

public string $issuerUrl = null

$scope общественное свойство

Область действия запроса аутентификации.

public string $scope = 'openid'

$validateAuthNonce общее свойство

Использовать и проверять параметр аутентификации 'nonce' в процессе аутентификации.

public boolean getValidateAuthNonce ( )
public void setValidateAuthNonce ( $validateAuthNonce )

$validateJws общее свойство

Проверять/расшифровывать JWS, полученный с маркером аутентификации. Примечание: эта функциональность требует spomky-labs/jose пакета composer для установки. Вы можете отключить этот параметр в случае использования доверенного поставщика OpenIDConnect, однако это нарушает правила протокола, поэтому вы делаете это на свой страх и риск.

public boolean $validateJws = true

Подробное описание методов