| Methods |
public
static
|
init($f3)
|
#
|
public
|
__construct()
|
#
|
protected
|
checkConfig(): void
|
#
|
public
|
onOauthAuthResolve(OAuthEvent $event): void
Resolves an OpenID Connect authorisation request by decoding any
request and request_uri parameters.
Resolves an OpenID Connect authorisation request by decoding any
request and request_uri parameters.
|
#
|
public
|
onOAuthAuthRequestEvent(OAuthAuthRequestEvent $event): void
Processes an OpenID Connect authorisation request.
Processes an OpenID Connect authorisation request.
This hook is called as part of the OAuth authorisation process. This
function performs additional checks required by the OpenID Connect
protocol, including processing the prompt, max_age and
acr paramters.
|
#
|
public
|
onOAuthAuthGrantEvent(OAuthAuthGrantEvent $event): void
Builds the OpenID Connect authentication response on a successful
authentication.
Builds the OpenID Connect authentication response on a successful
authentication.
The OpenID Connect authentication response is built on top of the OAuth
authorisation response and token responses. It may include an ID token
containing the claims requested by the OpenID Connect client.
This function prepares the OpenID Connect claims to be returned by calling
the buildClaims()
function with an id_token parameter. This
function will then:
- encode the claims in an ID token and return it as part of the authorisation
response; and/or
- save the claims to be returned as part of the token response.
|
#
|
public
|
onOAuthTokenGrantEvent(OAuthTokenGrantEvent $event): void
Processes an OpenID Connect token response. An OpenID Connect token
response may contain an ID token containing the claims that the
OpenID Connect client requested earlier.
Processes an OpenID Connect token response. An OpenID Connect token
response may contain an ID token containing the claims that the
OpenID Connect client requested earlier.
|
#
|
public
|
onOauthResponseTypes(BaseDataCollectionEvent $event): void
|
#
|
public
|
userinfo(): void
The UserInfo endpoint. The UserInfo endpoint returns a set
of claims requested by the OpenID Connect client.
The UserInfo endpoint. The UserInfo endpoint returns a set
of claims requested by the OpenID Connect client.
|
#
|
public
static
|
getSubject(User $user, Client $client): string|null
Obtains a sub (subject) claim for a user and client.
Obtains a sub (subject) claim for a user and client.
The subject type can be public (which reflect the user's ID)
or pairwise. The type chosen is dependent on the client's
registration settings.
Parameters
| $user |
the user about which the ID
token is created
|
| $client |
the client to which the
ID token will be sent
|
Returns
|
#
|
public
|
onScopeInfoCollectionEvent(ScopeInfoCollectionEvent $event): void
Returns the OpenID Connect scopes supported by this server.
Returns the OpenID Connect scopes supported by this server.
|
#
|
public
|
onOauthMetadata(BaseDataCollectionEvent $event): void
Add the OpenID Connect configuration data to the OAuth metadata endpoint.
Add the OpenID Connect configuration data to the OAuth metadata endpoint.
|
#
|
public
|
jwks(): void
Displays the JSON web key for this installation.
Displays the JSON web key for this installation.
|
#
|