blob: ebb0e1c5b5856dced845ac6fc581b20fc0966172 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace NCU\Security\Signature\Model;
use NCU\Security\Signature\Exceptions\SignatoryNotFoundException;
/**
* model that store data related to a possible signature.
* those details will be used:
* - to confirm authenticity of a signed incoming request
* - to sign an outgoing request
*
* @experimental 31.0.0
* @since 31.0.0
*/
interface ISignedRequest {
/**
* payload of the request
*
* @return string
* @since 31.0.0
*/
public function getBody(): string;
/**
* checksum of the payload of the request
*
* @return string
* @since 31.0.0
*/
public function getDigest(): string;
/**
* set the list of headers related to the signature of the request
*
* @param array $signatureHeader
* @return ISignedRequest
* @since 31.0.0
*/
public function setSignatureHeader(array $signatureHeader): ISignedRequest;
/**
* get the list of headers related to the signature of the request
*
* @return array
* @since 31.0.0
*/
public function getSignatureHeader(): array;
/**
* set the signed version of the signature
*
* @param string $signedSignature
* @return ISignedRequest
* @since 31.0.0
*/
public function setSignedSignature(string $signedSignature): ISignedRequest;
/**
* get the signed version of the signature
*
* @return string
* @since 31.0.0
*/
public function getSignedSignature(): string;
/**
* set the signatory, containing keys and details, related to this request
*
* @param ISignatory $signatory
* @return ISignedRequest
* @since 31.0.0
*/
public function setSignatory(ISignatory $signatory): ISignedRequest;
/**
* get the signatory, containing keys and details, related to this request
*
* @return ISignatory
* @throws SignatoryNotFoundException
* @since 31.0.0
*/
public function getSignatory(): ISignatory;
/**
* returns if a signatory related to this request have been found and defined
*
* @return bool
* @since 31.0.0
*/
public function hasSignatory(): bool;
}
|
