PHP Interface Jose\Object\SignatureInterface

This interface is required by the SignerInterface to signed payloads and create a JWS.
Afficher le fichier Open project: spomky-labs/jose Interface Usage Examples

Méthodes publiques

Méthode Description
createSignature ( Jose\Object\JWKInterface $signature_key, array $protected_headers, array $headers ) : Jose\Object\Signature
createSignatureFromLoadedData ( string $signature, string | null $encoded_protected_headers, array $headers ) : Jose\Object\Signature
getAllHeaders ( ) : array The protected and unprotected header associated with the signature.
getEncodedProtectedHeaders ( ) : null | string The protected header associated with the signature.
getHeader ( string $key ) : mixed | null Returns the value of the unprotected header of the specified key.
getHeaders ( ) : array The unprotected header associated with the signature.
getProtectedHeader ( string $key ) : mixed | null Returns the value of the protected header of the specified key.
getProtectedHeaders ( ) : array The protected header associated with the signature.
getSignature ( ) : string Returns the value of the signature.
getSignatureKey ( ) : Jose\Object\JWKInterface
hasHeader ( string $key ) : boolean
hasProtectedHeader ( string $key ) : boolean

Method Details

createSignature() public static méthode

public static createSignature ( Jose\Object\JWKInterface $signature_key, array $protected_headers, array $headers ) : Jose\Object\Signature
$signature_key Jose\Object\JWKInterface
$protected_headers array
$headers array
Résultat Jose\Object\Signature

createSignatureFromLoadedData() public static méthode

public static createSignatureFromLoadedData ( string $signature, string | null $encoded_protected_headers, array $headers ) : Jose\Object\Signature
$signature string
$encoded_protected_headers string | null
$headers array
Résultat Jose\Object\Signature

getAllHeaders() public méthode

The protected and unprotected header associated with the signature.
public getAllHeaders ( ) : array
Résultat array

getEncodedProtectedHeaders() public méthode

The protected header associated with the signature.
public getEncodedProtectedHeaders ( ) : null | string
Résultat null | string

getHeader() public méthode

Returns the value of the unprotected header of the specified key.
public getHeader ( string $key ) : mixed | null
$key string The key
Résultat mixed | null Header value

getHeaders() public méthode

The unprotected header associated with the signature.
public getHeaders ( ) : array
Résultat array

getProtectedHeader() public méthode

Returns the value of the protected header of the specified key.
public getProtectedHeader ( string $key ) : mixed | null
$key string The key
Résultat mixed | null Header value

getProtectedHeaders() public méthode

The protected header associated with the signature.
public getProtectedHeaders ( ) : array
Résultat array

getSignature() public méthode

Returns the value of the signature.
public getSignature ( ) : string
Résultat string

getSignatureKey() public méthode

public getSignatureKey ( ) : Jose\Object\JWKInterface
Résultat Jose\Object\JWKInterface

hasHeader() public méthode

public hasHeader ( string $key ) : boolean
$key string The key
Résultat boolean

hasProtectedHeader() public méthode

public hasProtectedHeader ( string $key ) : boolean
$key string The key
Résultat boolean