Class SimpleID\Protocols\Connect\JOSEResponse

`extends`	`ArrayWrapper`

A class representing a JWT response, which can be signed and/or encrypted.

The exact format of the response is determined by the configuration of the specified client.

This class is a subclass of ArrayWrapper . Token claims are stored in

ArrayWrapper->$container

and are accessed using array syntax. Token headers are set using the setHeaders() and setHeader() methods.

SimpleID\Util\ArrayWrapper implements ArrayAccess<string, mixed>, Countable, IteratorAggregate<string, mixed>
- SimpleID\Protocols\Connect\JOSEResponse

Located at core/Protocols/Connect/JOSEResponse.php

Methods


					
	public

__construct(
	string $issuer,
	OAuthClient $client,
	string $path_prefix,
	array<string, mixed> $data = [],
	string $default_signed_response_alg = null,
)

Creates a response.

$path_prefix is used to construct paths to the configuration variables, which are then accessed using ArrayWrapper::pathGet()

. For example, if $path_prefix is connect.userinfo, then this will configure the JOSE algorithms using the following paths:

connect.userinfo_signed_response_alg
connect.userinfo_encrypted_response_alg
connect.userinfo_encrypted_response_enc

Parameters

`$issuer`	the issuer ID
`$client`	the OAuth client to which the response will be sent
`$path_prefix`	the prefix from which paths will be formed and passed to ArrayWrapper::get() to get the client configuration
`$data`	the initial claims
`$default_signed_response_alg`	the default `_signed_response_alg` value if the client configuration is not found

Overrides

SimpleID\Util\ArrayWrapper::__construct()


					
	public

setHeaders(array<string, string> $headers): void

Sets the headers for the JWT, overwriting all existing headers.

Parameters

$headers

the headers to set


					
	public

setHeader(string $header, string $value): void

Sets a specified header for the JWT.

Parameters

`$header`	the header to set
`$value`	the header value


					
	public

setShortHashClaim(string $claim, string $value): void

Sets a claim to be the short hash of a particular value.

The OpenID Connect specification requires, in certain circumstances, the short hash of OAuth response parameters to be included in an ID token. This function calculates the short hash of the OAuth response parameter (specified in $value) and places it as a claim with a name specified by $claim. Normally $claim will be c_hash or at_hash and $value will be the authorisation code or access token respectively.

The short hash is the left-most half of the hash, with the hash algorithm being the one underlying the signature algorithm. For instance, if the signature algorithm is RS256, the underlying hash algorithm is SHA-256, and this function will return the encoded value of the left-most 128 bits of the SHA-256 hash.

Parameters

`$claim`	the name of the claim
`$value`	the value over which the short hash to be calculated


					
	public

render(KeySet $set = null): void

Renders the response.

This function calls the buildJOSE() method to get the response body, then renders it with the appropriate HTTP headers.

Parameters

$set

the key set to be passed to the buildJOSE() method.


					
	public

buildJOSE(KeySet $set = null): string|null

Builds the JOSE response. This will return one of the following:

A JSON encoded string, if $signed_response_alg and $encrypted_response_alg are both null
A signed JWT (JWS), if $signed_response_alg is set
A JWE containing a nested JWT, if both $signed_response_alg and $encrypted_response_alg are set

Parameters

$set

the key set used to sign and/or encrypt the token. If set to null, the default set of keys configured for the client and the server are loaded

Returns

the response body


					
	protected

getType(): string

Determines the type of response body. This type can be appended to application/ to form a proper MIME media type.

Returns

the type

Methods inherited from SimpleID\Util\ArrayWrapper
`loadData(), toArray(), offsetSet(), offsetExists(), offsetUnset(), offsetGet(), __set(), count(), getIterator(), get(), exists(), set(), append(), unset(), ref(), refLimit(), splitPath()`

Properties
`protected`	`string`	`$issuer`	#
`protected`	`OAuthClient`	`$client`	#
`protected`	`string`	`$signed_response_alg = null`	#
`protected`	`string`	`$encrypted_response_alg = null`	#
`protected`	`string`	`$encrypted_response_enc = null`	#
`protected`	`array<string, string>`	`$headers = []`	#

Properties inherited from SimpleID\Util\ArrayWrapper
`$container`

Namespaces

Classes

Class SimpleID\Protocols\Connect\JOSEResponse

Parameters

Overrides

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Returns