ISignatoryManager
in
ISignatoryManager contains a group of method that will help - signing outgoing request - confirm the authenticity of incoming signed request.
This interface must be implemented to generate a SignatoryManager to
be used with ISignatureManager
Tags
Attributes
- #[Consumable]
- $since: '33.0.0'
Table of Contents
Methods
- getLocalSignatory() : Signatory
- generate and returns local signatory including private and public key pair.
- getOptions() : array<string|int, mixed>
- options that might affect the way the whole process is handled: [ 'bodyMaxSize' => 10000, 'ttl' => 300, 'ttlSignatory' => 86400*3, 'extraSignatureHeaders' => [], 'algorithm' => 'sha256', 'dateHeader' => "D, d M Y H:i:s T", ]
- getProviderId() : string
- id of the signatory manager.
- getRemoteSignatory() : Signatory|null
- retrieve details and generate signatory from remote instance.
Methods
getLocalSignatory()
generate and returns local signatory including private and public key pair.
public
getLocalSignatory() : Signatory
Used to sign outgoing request
Tags
Return values
SignatorygetOptions()
options that might affect the way the whole process is handled: [ 'bodyMaxSize' => 10000, 'ttl' => 300, 'ttlSignatory' => 86400*3, 'extraSignatureHeaders' => [], 'algorithm' => 'sha256', 'dateHeader' => "D, d M Y H:i:s T", ]
public
getOptions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getProviderId()
id of the signatory manager.
public
getProviderId() : string
This is used to store, confirm uniqueness and avoid conflict of the remote key pairs.
Must be unique.
Tags
Return values
stringgetRemoteSignatory()
retrieve details and generate signatory from remote instance.
public
getRemoteSignatory(string $remote) : Signatory|null
If signatory cannot be found, returns NULL.
Used to confirm authenticity of incoming request.
Parameters
- $remote : string
Tags
Return values
Signatory|null —must be NULL if no signatory is found