IIncomingSignedRequest
extends
ISignedRequest
in
model wrapping an actual incoming request, adding details about the signature and the authenticity of the origin of the request.
This interface must not be implemented in your application but instead obtained from ISignatureManager::getIncomingSignedRequest.
$signedRequest = $this->signatureManager->getIncomingSignedRequest($mySignatoryManager);
Tags
Attributes
- #[Consumable]
- $since: '33.0.0'
Table of Contents
Methods
- getBody() : string
- payload of the request
- getDigest() : string
- checksum of the payload of the request
- getDigestAlgorithm() : DigestAlgorithm
- get algorithm used to generate digest
- getKeyId() : string
- returns the keyId extracted from the signature headers.
- getOrigin() : string
- get the hostname at the source of the base request.
- getRequest() : IRequest
- returns the base IRequest
- getSignatory() : Signatory
- get the signatory, containing keys and details, related to this request
- getSignature() : string
- get the signed version of the signature
- getSignatureData() : array<string|int, mixed>
- returns data used to generate signature
- getSigningElement() : string
- getSigningElements() : array<string|int, mixed>
- get the list of elements in the Signature header of the request
- hasSignatory() : bool
- returns if a signatory related to this request have been found and defined
- setSignatory() : self
- set the signatory, containing keys and details, related to this request
- setSigningElements() : self
- set the list of headers related to the signature of the request
- verify() : void
- confirm the current signed request's identity is correct
Methods
getBody()
payload of the request
public
getBody() : string
Tags
Return values
stringgetDigest()
checksum of the payload of the request
public
getDigest() : string
Tags
Return values
stringgetDigestAlgorithm()
get algorithm used to generate digest
public
getDigestAlgorithm() : DigestAlgorithm
Tags
Return values
DigestAlgorithmgetKeyId()
returns the keyId extracted from the signature headers.
public
getKeyId() : string
keyId is a mandatory entry in the headers of a signed request.
Tags
Return values
stringgetOrigin()
get the hostname at the source of the base request.
public
getOrigin() : string
based on the keyId defined in the signature header.
Tags
Return values
stringgetRequest()
returns the base IRequest
public
getRequest() : IRequest
Tags
Return values
IRequestgetSignatory()
get the signatory, containing keys and details, related to this request
public
getSignatory() : Signatory
Tags
Return values
SignatorygetSignature()
get the signed version of the signature
public
getSignature() : string
Tags
Return values
stringgetSignatureData()
returns data used to generate signature
public
getSignatureData() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getSigningElement()
public
getSigningElement(string $key) : string
Parameters
- $key : string
Tags
Return values
stringgetSigningElements()
get the list of elements in the Signature header of the request
public
getSigningElements() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>hasSignatory()
returns if a signatory related to this request have been found and defined
public
hasSignatory() : bool
Tags
Return values
boolsetSignatory()
set the signatory, containing keys and details, related to this request
public
setSignatory(Signatory $signatory) : self
Parameters
- $signatory : Signatory
Tags
Return values
selfsetSigningElements()
set the list of headers related to the signature of the request
public
setSigningElements(array<string|int, mixed> $elements) : self
Parameters
- $elements : array<string|int, mixed>
Tags
Return values
selfverify()
confirm the current signed request's identity is correct
public
verify() : void