PHP Interface Jose\VerifierInterface

Mostra file Open project: spomky-labs/jose Interface Usage Examples

Public Methods

Method Description
createVerifier ( array $signature_algorithms ) : Jose\VerifierInterface Signer constructor.
getSupportedSignatureAlgorithms ( ) : string[]
verifyWithKey ( Jose\Object\JWSInterface $input, Jose\Object\JWKInterface $jwk, null | string $detached_payload = null, null | integer &$signature_index = null ) Verify the signature of the input.
verifyWithKeySet ( Jose\Object\JWSInterface $jws, Jose\Object\JWKSetInterface $jwk_set, null | string $detached_payload = null, null | integer &$signature_index = null ) Verify the signature of the input.

Method Details

createVerifier() public static method

Signer constructor.
public static createVerifier ( array $signature_algorithms ) : Jose\VerifierInterface
$signature_algorithms array
return Jose\VerifierInterface

getSupportedSignatureAlgorithms() public method

public getSupportedSignatureAlgorithms ( ) : string[]
return string[]

verifyWithKey() public method

The input must be a valid JWS. This method is usually called after the "load" method.
public verifyWithKey ( Jose\Object\JWSInterface $input, Jose\Object\JWKInterface $jwk, null | string $detached_payload = null, null | integer &$signature_index = null )
$input Jose\Object\JWSInterface A JWS object.
$jwk Jose\Object\JWKInterface The signature will be verified using keys in the key set
$detached_payload null | string If not null, the value must be the detached payload encoded in Base64 URL safe. If the input contains a payload, throws an exception.
$signature_index null | integer If the JWS has been verified, an integer that represents the ID of the signature is set

verifyWithKeySet() public method

The input must be a valid JWS. This method is usually called after the "load" method.
public verifyWithKeySet ( Jose\Object\JWSInterface $jws, Jose\Object\JWKSetInterface $jwk_set, null | string $detached_payload = null, null | integer &$signature_index = null )
$jws Jose\Object\JWSInterface A JWS object.
$jwk_set Jose\Object\JWKSetInterface The signature will be verified using keys in the key set
$detached_payload null | string If not null, the value must be the detached payload encoded in Base64 URL safe. If the input contains a payload, throws an exception.
$signature_index null | integer If the JWS has been verified, an integer that represents the ID of the signature is set