Class yii\authclient\OpenIdConnect

OpenIdConnect serves as a client for the OpenIdConnect flow.

Application configuration example:

'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',
            ],
        ],
    ]
    // ...
]

This class requires spomky-labs/jose library to be installed for JWS verification. This can be done via composer:

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

Note: if you are using well-trusted OpenIdConnect provider, you may disable $validateJws, making installation of spomky-labs/jose library redundant, however it is not recommended as it violates the protocol specification.

See also:

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

Public Properties

Public Methods

Protected Methods

Property Details

$allowedJwsAlgorithms public property

JWS algorithms, which are allowed to be used. These are used by spomky-labs/jose library for JWS validation/decryption. Make sure spomky-labs/jose supports the particular algorithm before adding it here.

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

$cache public property

The cache object, null - if not enabled.

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

$configParams public read-only property

OpenID provider configuration parameters.

public array getConfigParams ( )

$configParamsCacheKeyPrefix public property

The prefix for the key used to store $configParams data in cache. Actual cache key will be formed addition $id value to it.

See also $cache.

public string $configParamsCacheKeyPrefix = 'config-params-'

$issuerUrl public property

OpenID Issuer (provider) base URL, e.g. https://example.com.

public string $issuerUrl = null

$scope public property

Auth request scope.

public string $scope = 'openid'

$validateAuthNonce public property

Whether to use and validate auth 'nonce' parameter in authentication flow.

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

$validateJws public property

Whether to validate/decrypt JWS received with Auth token. Note: this functionality requires spomky-labs/jose composer package to be installed. You can disable this option in case of usage of trusted OpenIDConnect provider, however this violates the protocol rules, so you are doing it on your own risk.

public boolean $validateJws = true

Method Details