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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\Security\Signature\Model;
use JsonSerializable;
use NCU\Security\Signature\Enum\DigestAlgorithm;
use NCU\Security\Signature\Exceptions\SignatoryNotFoundException;
use NCU\Security\Signature\Exceptions\SignatureElementNotFoundException;
use NCU\Security\Signature\ISignedRequest;
use NCU\Security\Signature\Model\Signatory;
/**
* @inheritDoc
*
* @since 31.0.0
*/
class SignedRequest implements ISignedRequest, JsonSerializable {
private string $digest = '';
private DigestAlgorithm $digestAlgorithm = DigestAlgorithm::SHA256;
private array $signingElements = [];
private array $signatureData = [];
private string $signature = '';
private ?Signatory $signatory = null;
public function __construct(
private readonly string $body,
) {
}
/**
* @inheritDoc
*
* @return string
* @since 31.0.0
*/
public function getBody(): string {
return $this->body;
}
/**
* set algorithm used to generate digest
*
* @param DigestAlgorithm $algorithm
*
* @return self
* @since 31.0.0
*/
protected function setDigestAlgorithm(DigestAlgorithm $algorithm): self {
$this->digestAlgorithm = $algorithm;
return $this;
}
/**
* @inheritDoc
*
* @return DigestAlgorithm
* @since 31.0.0
*/
public function getDigestAlgorithm(): DigestAlgorithm {
return $this->digestAlgorithm;
}
/**
* @inheritDoc
*
* @return string
* @since 31.0.0
*/
public function getDigest(): string {
if ($this->digest === '') {
$this->digest = $this->digestAlgorithm->value . '=' .
base64_encode(hash($this->digestAlgorithm->getHashingAlgorithm(), $this->body, true));
}
return $this->digest;
}
/**
* @inheritDoc
*
* @param array $elements
*
* @return self
* @since 31.0.0
*/
public function setSigningElements(array $elements): self {
$this->signingElements = $elements;
return $this;
}
/**
* @inheritDoc
*
* @return array
* @since 31.0.0
*/
public function getSigningElements(): array {
return $this->signingElements;
}
/**
* @param string $key
*
* @return string
* @throws SignatureElementNotFoundException
* @since 31.0.0
*
*/
public function getSigningElement(string $key): string { // getSignatureDetail / getSignatureEntry() ?
if (!array_key_exists($key, $this->signingElements)) {
throw new SignatureElementNotFoundException('missing element ' . $key . ' in Signature header');
}
return $this->signingElements[$key];
}
/**
* store data used to generate signature
*
* @param array $data
*
* @return self
* @since 31.0.0
*/
protected function setSignatureData(array $data): self {
$this->signatureData = $data;
return $this;
}
/**
* @inheritDoc
*
* @return array
* @since 31.0.0
*/
public function getSignatureData(): array {
return $this->signatureData;
}
/**
* set the signed version of the signature
*
* @param string $signature
*
* @return self
* @since 31.0.0
*/
protected function setSignature(string $signature): self {
$this->signature = $signature;
return $this;
}
/**
* @inheritDoc
*
* @return string
* @since 31.0.0
*/
public function getSignature(): string {
return $this->signature;
}
/**
* @inheritDoc
*
* @param Signatory $signatory
* @return self
* @since 31.0.0
*/
public function setSignatory(Signatory $signatory): self {
$this->signatory = $signatory;
return $this;
}
/**
* @inheritDoc
*
* @return Signatory
* @throws SignatoryNotFoundException
* @since 31.0.0
*/
public function getSignatory(): Signatory {
if ($this->signatory === null) {
throw new SignatoryNotFoundException();
}
return $this->signatory;
}
/**
* @inheritDoc
*
* @return bool
* @since 31.0.0
*/
public function hasSignatory(): bool {
return ($this->signatory !== null);
}
public function jsonSerialize(): array {
return [
'body' => $this->body,
'digest' => $this->getDigest(),
'digestAlgorithm' => $this->getDigestAlgorithm()->value,
'signingElements' => $this->signingElements,
'signatureData' => $this->signatureData,
'signature' => $this->signature,
'signatory' => $this->signatory ?? false,
];
}
}
|
