PHP Interface Jose\Object\JWEInterface

Inheritance: extends Jose\Object\JWTInterface

Afficher le fichier Open project: spomky-labs/jose Interface Usage Examples

Méthodes publiques

Méthode	Description
addRecipientInformation ( Jose\Object\JWKInterface $recipient_key, array $recipient_headers = [] ) : Jose\Object\JWEInterface
addRecipientWithEncryptedKey ( string \| null $encrypted_key, array $recipient_headers ) : Jose\Object\JWEInterface
countRecipients ( ) : integer	Returns the number of recipients associated with the JWS.
getAAD ( ) : string \| null
getCiphertext ( ) : string \| null
getEncodedSharedProtectedHeaders ( ) : string \| null
getIV ( ) : string \| null
getRecipient ( integer $id ) : Jose\Object\RecipientInterface
getRecipients ( ) : Jose\Object\RecipientInterface[]	Returns the recipients associated with the JWS.
getSharedHeader ( string $key ) : mixed \| null
getSharedHeaders ( ) : array
getSharedProtectedHeader ( string $key ) : mixed \| null
getSharedProtectedHeaders ( ) : array
getTag ( ) : string \| null
hasSharedHeader ( string $key ) : boolean
hasSharedProtectedHeader ( string $key ) : boolean
isEncrypted ( ) : boolean
toCompactJSON ( integer $recipient ) : string
toFlattenedJSON ( integer $recipient ) : string
toJSON ( ) : string
withAAD ( string $aad ) : Jose\Object\JWEInterface
withCiphertext ( string $ciphertext ) : Jose\Object\JWEInterface
withEncodedSharedProtectedHeaders ( string $encoded_shared_protected_headers ) : Jose\Object\JWEInterface
withIV ( string $iv ) : Jose\Object\JWEInterface
withSharedHeader ( string $key, mixed \| null $value ) : Jose\Object\JWEInterface
withSharedHeaders ( array $shared_headers ) : Jose\Object\JWEInterface
withSharedProtectedHeader ( string $key, mixed \| null $value ) : Jose\Object\JWEInterface
withSharedProtectedHeaders ( array $shared_protected_headers ) : Jose\Object\JWEInterface
withTag ( string $tag ) : Jose\Object\JWEInterface

Method Details

addRecipientInformation() public méthode

public addRecipientInformation ( Jose\Object\JWKInterface $recipient_key, array $recipient_headers = [] ) : Jose\Object\JWEInterface
$recipient_key	Jose\Object\JWKInterface
$recipient_headers	array
Résultat	Jose\Object\JWEInterface

addRecipientWithEncryptedKey() public méthode

public addRecipientWithEncryptedKey ( string \| null $encrypted_key, array $recipient_headers ) : Jose\Object\JWEInterface
$encrypted_key	string \| null
$recipient_headers	array
Résultat	Jose\Object\JWEInterface

countRecipients() public méthode

Returns the number of recipients associated with the JWS.

public countRecipients ( ) : integer
Résultat	integer

getAAD() public méthode

public getAAD ( ) : string \| null
Résultat	string \| null

getCiphertext() public méthode

public getCiphertext ( ) : string \| null
Résultat	string \| null	The cyphertext

getEncodedSharedProtectedHeaders() public méthode

public getEncodedSharedProtectedHeaders ( ) : string \| null
Résultat	string \| null

getIV() public méthode

public getIV ( ) : string \| null
Résultat	string \| null

getRecipient() public méthode

public getRecipient ( integer $id ) : Jose\Object\RecipientInterface
$id	integer
Résultat	Jose\Object\RecipientInterface

getRecipients() public méthode

Returns the recipients associated with the JWS.

public getRecipients ( ) : Jose\Object\RecipientInterface[]
Résultat	Jose\Object\RecipientInterface[]

getSharedHeader() public méthode

public getSharedHeader ( string $key ) : mixed \| null
$key	string	The key
Résultat	mixed \| null	Header value

getSharedHeaders() public méthode

public getSharedHeaders ( ) : array
Résultat	array

getSharedProtectedHeader() public méthode

public getSharedProtectedHeader ( string $key ) : mixed \| null
$key	string	The key
Résultat	mixed \| null	Header value

getSharedProtectedHeaders() public méthode

public getSharedProtectedHeaders ( ) : array
Résultat	array

getTag() public méthode

public getTag ( ) : string \| null
Résultat	string \| null

hasSharedHeader() public méthode

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

hasSharedProtectedHeader() public méthode

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

isEncrypted() public méthode

public isEncrypted ( ) : boolean
Résultat	boolean

toCompactJSON() public méthode

public toCompactJSON ( integer $recipient ) : string
$recipient	integer
Résultat	string

toFlattenedJSON() public méthode

public toFlattenedJSON ( integer $recipient ) : string
$recipient	integer
Résultat	string

toJSON() public méthode

public toJSON ( ) : string
Résultat	string

withAAD() public méthode

public withAAD ( string $aad ) : Jose\Object\JWEInterface
$aad	string
Résultat	Jose\Object\JWEInterface

withCiphertext() public méthode

public withCiphertext ( string $ciphertext ) : Jose\Object\JWEInterface
$ciphertext	string
Résultat	Jose\Object\JWEInterface

withEncodedSharedProtectedHeaders() public méthode

public withEncodedSharedProtectedHeaders ( string $encoded_shared_protected_headers ) : Jose\Object\JWEInterface
$encoded_shared_protected_headers	string
Résultat	Jose\Object\JWEInterface

withIV() public méthode

public withIV ( string $iv ) : Jose\Object\JWEInterface
$iv	string
Résultat	Jose\Object\JWEInterface

withSharedHeader() public méthode

public withSharedHeader ( string $key, mixed \| null $value ) : Jose\Object\JWEInterface
$key	string
$value	mixed \| null
Résultat	Jose\Object\JWEInterface

withSharedHeaders() public méthode

public withSharedHeaders ( array $shared_headers ) : Jose\Object\JWEInterface
$shared_headers	array
Résultat	Jose\Object\JWEInterface

withSharedProtectedHeader() public méthode

public withSharedProtectedHeader ( string $key, mixed \| null $value ) : Jose\Object\JWEInterface
$key	string
$value	mixed \| null
Résultat	Jose\Object\JWEInterface

withSharedProtectedHeaders() public méthode

public withSharedProtectedHeaders ( array $shared_protected_headers ) : Jose\Object\JWEInterface
$shared_protected_headers	array
Résultat	Jose\Object\JWEInterface

withTag() public méthode

public withTag ( string $tag ) : Jose\Object\JWEInterface
$tag	string
Résultat	Jose\Object\JWEInterface