Référence de la classe JWSVerifier

Fonctions membres publiques
	__construct (AlgorithmManager $signatureAlgorithmManager)
	getSignatureAlgorithmManager ()
	verifyWithKey (JWS $jws, JWK $jwk, int $signature, ?string $detachedPayload=null)
	verifyWithKeySet (JWS $jws, JWKSet $jwkset, int $signatureIndex, ?string $detachedPayload=null, JWK &$jwk=null)

Fonctions membres privées
	verifySignature (JWS $jws, JWKSet $jwkset, Signature $signature, ?string $detachedPayload=null, JWK &$successJwk=null)
	getInputToVerify (JWS $jws, Signature $signature, ?string $detachedPayload)
	checkPayload (JWS $jws, ?string $detachedPayload=null)
	getAlgorithm (Signature $signature)
	isPayloadEmpty (?string $payload)

Attributs privés
	$signatureAlgorithmManager

Documentation des constructeurs et destructeur

__construct()

__construct

(

AlgorithmManager

$signatureAlgorithmManager

)

JWSVerifier constructor.

Références JWSVerifier\$signatureAlgorithmManager.

Documentation des fonctions membres

checkPayload()

checkPayload ( JWS  $jws, ?string  $detachedPayload = null  )

private

Exceptions

InvalidArgumentException

if the payload is set when a detached payload is provided or no payload is defined

Références JWS\getPayload(), JWSVerifier\isPayloadEmpty(), et null.

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

getAlgorithm()

getAlgorithm ( Signature  $signature )

private

Exceptions

InvalidArgumentException

if the header parameter "alg" is missing or invalid

Renvoie

MacAlgorithm|SignatureAlgorithm

Références Signature\getHeader(), et Signature\getProtectedHeader().

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

getInputToVerify()

getInputToVerify ( JWS  $jws, Signature  $signature, ?string  $detachedPayload  )

private

Références Base64Url\encode(), JWS\getEncodedPayload(), Signature\getEncodedProtectedHeader(), JWS\getPayload(), Signature\getProtectedHeaderParameter(), Signature\hasProtectedHeaderParameter(), JWSVerifier\isPayloadEmpty(), et null.

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

getSignatureAlgorithmManager()

getSignatureAlgorithmManager

(

)

Returns the algorithm manager associated to the JWSVerifier.

Références JWSVerifier\$signatureAlgorithmManager.

isPayloadEmpty()

isPayloadEmpty ( ?string  $payload )

private

Références null.

Référencé par JWSVerifier\checkPayload(), et JWSVerifier\getInputToVerify().

verifySignature()

verifySignature ( JWS  $jws, JWKSet  $jwkset, Signature  $signature, ?string  $detachedPayload = null, JWK &  $successJwk = null  )

private

Références $input, JWKSet\all(), KeyChecker\checkKeyAlgorithm(), KeyChecker\checkKeyUsage(), JWSVerifier\getAlgorithm(), JWSVerifier\getInputToVerify(), et Signature\getSignature().

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

verifyWithKey()

verifyWithKey	(	JWS	$jws,
		JWK	$jwk,
		int	$signature,
		?string	$detachedPayload = null
	)

This method will try to verify the JWS object using the given key and for the given signature. It returns true if the signature is verified, otherwise false.

Renvoie

bool true if the verification of the signature succeeded, else false

Références JWSVerifier\verifyWithKeySet().

verifyWithKeySet()

verifyWithKeySet	(	JWS	$jws,
		JWKSet	$jwkset,
		int	$signatureIndex,
		?string	$detachedPayload = null,
		JWK &	$jwk = null
	)

This method will try to verify the JWS object using the given key set and for the given signature. It returns true if the signature is verified, otherwise false.

Paramètres

JWS	$jws	A JWS object
JWKSet	$jwkset	The signature will be verified using keys in the key set
JWK	$jwk	The key used to verify the signature in case of success
null | string	$detachedPayload	If not null, the value must be the detached payload encoded in Base64 URL safe. If the input contains a payload, throws an exception.

Exceptions

InvalidArgumentException	if there is no key in the keyset
InvalidArgumentException	if the token does not contain any signature

Renvoie

bool true if the verification of the signature succeeded, else false

Références JWSVerifier\checkPayload(), JWKSet\count(), JWS\countSignatures(), JWS\getSignature(), et JWSVerifier\verifySignature().

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

Documentation des champs

$signatureAlgorithmManager

$signatureAlgorithmManager

private

Référencé par JWSVerifier\__construct(), et JWSVerifier\getSignatureAlgorithmManager().

---

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

• JWSVerifier.php