Référence de la classe JWKSet

Graphe d'héritage de JWKSet:

Fonctions membres publiques
	__construct (array $keys)
	all ()
	with (JWK $jwk)
	without ($key)
	has ($index)
	get ($index)
	jsonSerialize ()
	count ($mode=COUNT_NORMAL)
	selectKey (string $type, ?Algorithm $algorithm=null, array $restrictions=[])
	getIterator ()

Fonctions membres publiques statiques
static	createFromKeyData (array $data)
static	createFromJson (string $json)
static	sortKeys (array $a, array $b)

Fonctions membres privées
	canKeyBeUsedFor (string $type, JWK $key)
	canKeyBeUsedWithAlgorithm (?Algorithm $algorithm, JWK $key)
	doesKeySatisfyRestrictions (array $restrictions, JWK $key)

Fonctions membres privées statiques
static	convertKeyOpsToKeyUse (array $key_ops)

Attributs privés
	$keys = []

Documentation des constructeurs et destructeur

__construct()

__construct

(

array

$keys

)

Paramètres

JWK[]

$keys

Exceptions

InvalidArgumentException

if the list is invalid

Références $key, et JWKSet\$keys.

Documentation des fonctions membres

all()

all

(

)

Returns an array of keys stored in the key set.

Renvoie

JWK[]

Références JWKSet\$keys.

Référencé par JWSVerifier\verifySignature().

canKeyBeUsedFor()

canKeyBeUsedFor ( string  $type, JWK  $key  )

private

Exceptions

InvalidArgumentException

if the key does not fulfill with the "key_ops" constraint

Renvoie

bool|int

Références $key, et $type.

Référencé par JWKSet\selectKey().

canKeyBeUsedWithAlgorithm()

canKeyBeUsedWithAlgorithm ( ?Algorithm  $algorithm, JWK  $key  )

private

Renvoie

bool|int

Références $key, Algorithm\allowedKeyTypes(), Algorithm\name(), et null.

Référencé par JWKSet\selectKey().

convertKeyOpsToKeyUse()

static convertKeyOpsToKeyUse ( array  $key_ops )

staticprivate

Exceptions

InvalidArgumentException

if the key operation is not supported

count()

count

(

$mode = COUNT_NORMAL

)

Returns the number of keys in the key set.

Paramètres

int

$mode

Références $mode.

Référencé par JWKSet\selectKey(), et JWSVerifier\verifyWithKeySet().

createFromJson()

static createFromJson ( string  $json )

static

Creates a JWKSet object using the given Json string.

Exceptions

InvalidArgumentException

if the data is not valid

Renvoie

JWKSet

Références $data.

createFromKeyData()

static createFromKeyData ( array  $data )

static

Creates a JWKSet object using the given values.

Exceptions

InvalidArgumentException

if the keyset is not valid

Renvoie

JWKSet

Références $data, et $key.

doesKeySatisfyRestrictions()

doesKeySatisfyRestrictions ( array  $restrictions, JWK  $key  )

private

Références $key.

Référencé par JWKSet\selectKey().

get()

get

(

$index

)

Returns the key with the given index. Throws an exception if the index is not present in the key store.

Paramètres

int | string

$index

Exceptions

InvalidArgumentException

if the index is not defined

Références JWKSet\has().

getIterator()

getIterator

(

)

Internal method only. Should not be used.

has()

has

(

$index

)

Returns true if the key set contains a key with the given index.

Paramètres

int | string

$index

Référencé par JWKSet\get(), et JWKSet\without().

jsonSerialize()

jsonSerialize

(

)

Returns the values to be serialized.

selectKey()

selectKey	(	string	$type,
		?Algorithm	$algorithm = null,
		array	$restrictions = []
	)

Try to find a key that fits on the selected requirements. Returns null if not found.

Paramètres

string	$type	Must be 'sig' (signature) or 'enc' (encryption)
null | Algorithm	$algorithm	Specifies the algorithm to be used
array	$restrictions	More restrictions such as 'kid' or 'kty'

Exceptions

InvalidArgumentException

if the key type is not valid (must be "sig" or "enc")

Références $key, $result, $this, $type, JWKSet\canKeyBeUsedFor(), JWKSet\canKeyBeUsedWithAlgorithm(), JWKSet\count(), JWKSet\doesKeySatisfyRestrictions(), et null.

sortKeys()

static sortKeys ( array  $a, array  $b  )

static

Internal method only. Should not be used.

Références $b.

with()

with

(

JWK

$jwk

)

Add key to store in the key set. This method is immutable and will return a new object.

Renvoie

JWKSet

Références $this, JWK\get(), et JWK\has().

without()

without

(

$key

)

Remove key from the key set. This method is immutable and will return a new object.

Paramètres

int | string

$key

Key to remove from the key set

Renvoie

JWKSet

Références $key, $this, et JWKSet\has().

Documentation des champs

$keys

$keys = []

private

Référencé par JWKSet\__construct(), et JWKSet\all().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• JWKSet.php