Nextcloud PHP API (master)

IOutgoingSignedRequest extends ISignedRequest
in

extends ISignedRequest to add info requested at the generation of the signature

This interface must not be implemented in your application but instead obtained from ISignatureManager::getIncomingSignedRequest.

$signedRequest = $this->signatureManager->getIncomingSignedRequest($mySignatoryManager);
Tags
see
ISignatureManager

for details on signature

since
33.0.0
Attributes
#[Consumable]
$since: '33.0.0'

Table of Contents

Methods

addHeader()  : self
add a key/value pair to the headers of the request
getAlgorithm()  : SignatureAlgorithm
returns the algorithm set to sign the signature
getBody()  : string
payload of the request
getDigest()  : string
checksum of the payload of the request
getDigestAlgorithm()  : DigestAlgorithm
get algorithm used to generate digest
getHeaderList()  : array<int, string>
returns ordered list of used headers in the Signature
getHeaders()  : array<string|int, mixed>
returns list of headers value that will be added to the base request
getHost()  : string
get the host of the recipient of the request.
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
setAlgorithm()  : self
set algorithm to be used to sign the signature
setHeaderList()  : self
set the ordered list of used headers in the Signature
setHost()  : self
set the host of the recipient of the request.
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
sign()  : self
sign outgoing request providing a certificate that it emanate from this instance

Methods

addHeader()

add a key/value pair to the headers of the request

public addHeader(string $key, string|int|float $value) : self
Parameters
$key : string
$value : string|int|float
Tags
since
33.0.0
Return values
self

getBody()

payload of the request

public getBody() : string
Tags
since
33.0.0
Return values
string

getDigest()

checksum of the payload of the request

public getDigest() : string
Tags
since
33.0.0
Return values
string

getHeaderList()

returns ordered list of used headers in the Signature

public getHeaderList() : array<int, string>
Tags
since
33.0.0
Return values
array<int, string>

getHeaders()

returns list of headers value that will be added to the base request

public getHeaders() : array<string|int, mixed>
Tags
since
33.0.0
Return values
array<string|int, mixed>

getHost()

get the host of the recipient of the request.

public getHost() : string
  • on incoming request, this is the local hostname of current instance.
  • on outgoing request, this is the remote instance.
Tags
since
33.0.0
Return values
string

getSignature()

get the signed version of the signature

public getSignature() : string
Tags
since
33.0.0
Return values
string

getSignatureData()

returns data used to generate signature

public getSignatureData() : array<string|int, mixed>
Tags
since
33.0.0
Return values
array<string|int, mixed>

getSigningElements()

get the list of elements in the Signature header of the request

public getSigningElements() : array<string|int, mixed>
Tags
since
33.0.0
Return values
array<string|int, mixed>

hasSignatory()

returns if a signatory related to this request have been found and defined

public hasSignatory() : bool
Tags
since
33.0.0
Return values
bool

setHeaderList()

set the ordered list of used headers in the Signature

public setHeaderList(array<int, string> $list) : self
Parameters
$list : array<int, string>
Tags
since
33.0.0
Return values
self

setHost()

set the host of the recipient of the request.

public setHost(string $host) : self
Parameters
$host : string
Tags
since
33.0.0
Return values
self

setSignatory()

set the signatory, containing keys and details, related to this request

public setSignatory(Signatory $signatory) : self
Parameters
$signatory : Signatory
Tags
since
33.0.0
Return values
self

setSigningElements()

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
since
33.0.0
Return values
self 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results