1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
declare(strict_types=1); |
4
|
|
|
|
5
|
|
|
namespace SimpleSAML\XMLSecurity\XML; |
6
|
|
|
|
7
|
|
|
use DOMElement; |
8
|
|
|
use SimpleSAML\Assert\Assert; |
9
|
|
|
use SimpleSAML\XML\DOMDocumentFactory; |
10
|
|
|
use SimpleSAML\XMLSchema\Type\AnyURIValue; |
11
|
|
|
use SimpleSAML\XMLSchema\Type\Base64BinaryValue; |
12
|
|
|
use SimpleSAML\XMLSchema\Type\IDValue; |
13
|
|
|
use SimpleSAML\XMLSecurity\Alg\Signature\SignatureAlgorithmInterface; |
14
|
|
|
use SimpleSAML\XMLSecurity\Constants as C; |
15
|
|
|
use SimpleSAML\XMLSecurity\Exception\RuntimeException; |
16
|
|
|
use SimpleSAML\XMLSecurity\Exception\UnsupportedAlgorithmException; |
17
|
|
|
use SimpleSAML\XMLSecurity\Type\DigestValue as DigestValueType; |
18
|
|
|
use SimpleSAML\XMLSecurity\Utils\XML; |
19
|
|
|
use SimpleSAML\XMLSecurity\XML\ds\CanonicalizationMethod; |
20
|
|
|
use SimpleSAML\XMLSecurity\XML\ds\DigestMethod; |
21
|
|
|
use SimpleSAML\XMLSecurity\XML\ds\DigestValue; |
22
|
|
|
use SimpleSAML\XMLSecurity\XML\ds\KeyInfo; |
23
|
|
|
use SimpleSAML\XMLSecurity\XML\ds\Reference; |
24
|
|
|
use SimpleSAML\XMLSecurity\XML\ds\Signature; |
25
|
|
|
use SimpleSAML\XMLSecurity\XML\ds\SignatureMethod; |
26
|
|
|
use SimpleSAML\XMLSecurity\XML\ds\SignatureValue; |
27
|
|
|
use SimpleSAML\XMLSecurity\XML\ds\SignedInfo; |
28
|
|
|
use SimpleSAML\XMLSecurity\XML\ds\Transform; |
29
|
|
|
use SimpleSAML\XMLSecurity\XML\ds\Transforms; |
30
|
|
|
|
31
|
|
|
use function base64_encode; |
32
|
|
|
use function hash; |
33
|
|
|
use function in_array; |
34
|
|
|
|
35
|
|
|
/** |
36
|
|
|
* Trait SignableElementTrait |
37
|
|
|
* |
38
|
|
|
* @package simplesamlphp/xml-security |
39
|
|
|
* @phpstan-ignore trait.unused |
40
|
|
|
*/ |
41
|
|
|
trait SignableElementTrait |
42
|
|
|
{ |
43
|
|
|
use CanonicalizableElementTrait; |
44
|
|
|
|
45
|
|
|
|
46
|
|
|
/** @var \SimpleSAML\XMLSecurity\XML\ds\Signature|null */ |
47
|
|
|
protected ?Signature $signature = null; |
48
|
|
|
|
49
|
|
|
/** @var string */ |
50
|
|
|
private string $c14nAlg = C::C14N_EXCLUSIVE_WITHOUT_COMMENTS; |
51
|
|
|
|
52
|
|
|
/** @var \SimpleSAML\XMLSecurity\XML\ds\KeyInfo|null */ |
53
|
|
|
private ?KeyInfo $keyInfo = null; |
54
|
|
|
|
55
|
|
|
/** @var \SimpleSAML\XMLSecurity\Alg\Signature\SignatureAlgorithmInterface|null */ |
56
|
|
|
protected ?SignatureAlgorithmInterface $signer = null; |
57
|
|
|
|
58
|
|
|
|
59
|
|
|
/** |
60
|
|
|
* Get the ID of this element. |
61
|
|
|
* |
62
|
|
|
* When this method returns null, the signature created for this object will reference the entire document. |
63
|
|
|
* |
64
|
|
|
* @return \SimpleSAML\XML\Type\IDValue|null The ID of this element, or null if we don't have one. |
65
|
|
|
*/ |
66
|
|
|
abstract public function getId(): ?IDValue; |
67
|
|
|
|
68
|
|
|
|
69
|
|
|
/** |
70
|
|
|
* Sign the current element. |
71
|
|
|
* |
72
|
|
|
* The signature will not be applied until toXML() is called. |
73
|
|
|
* |
74
|
|
|
* @param \SimpleSAML\XMLSecurity\Alg\Signature\SignatureAlgorithmInterface $signer The actual signer implementation |
75
|
|
|
* to use. |
76
|
|
|
* @param string $canonicalizationAlg The identifier of the canonicalization algorithm to use. |
77
|
|
|
* @param \SimpleSAML\XMLSecurity\XML\ds\KeyInfo|null $keyInfo A KeyInfo object to add to the signature. |
78
|
|
|
*/ |
79
|
|
|
public function sign( |
80
|
|
|
SignatureAlgorithmInterface $signer, |
81
|
|
|
string $canonicalizationAlg = C::C14N_EXCLUSIVE_WITHOUT_COMMENTS, |
82
|
|
|
?KeyInfo $keyInfo = null, |
83
|
|
|
): void { |
84
|
|
|
$this->signer = $signer; |
85
|
|
|
$this->keyInfo = $keyInfo; |
86
|
|
|
Assert::oneOf( |
87
|
|
|
$canonicalizationAlg, |
88
|
|
|
[ |
89
|
|
|
C::C14N_INCLUSIVE_WITH_COMMENTS, |
90
|
|
|
C::C14N_INCLUSIVE_WITHOUT_COMMENTS, |
91
|
|
|
C::C14N_EXCLUSIVE_WITH_COMMENTS, |
92
|
|
|
C::C14N_EXCLUSIVE_WITHOUT_COMMENTS, |
93
|
|
|
], |
94
|
|
|
'Unsupported canonicalization algorithm: %s', |
95
|
|
|
UnsupportedAlgorithmException::class, |
96
|
|
|
); |
97
|
|
|
$this->c14nAlg = $canonicalizationAlg; |
98
|
|
|
} |
99
|
|
|
|
100
|
|
|
|
101
|
|
|
/** |
102
|
|
|
* Get a ds:Reference pointing to this object. |
103
|
|
|
* |
104
|
|
|
* @param string $digestAlg The digest algorithm to use. |
105
|
|
|
* @param \SimpleSAML\XMLSecurity\XML\ds\Transforms $transforms The transforms to apply to the object. |
106
|
|
|
*/ |
107
|
|
|
private function getReference( |
108
|
|
|
string $digestAlg, |
109
|
|
|
Transforms $transforms, |
110
|
|
|
DOMElement $xml, |
111
|
|
|
string $canonicalDocument, |
112
|
|
|
): Reference { |
113
|
|
|
$id = $this->getId(); |
114
|
|
|
$uri = null; |
115
|
|
|
if (empty($id)) { // document reference |
116
|
|
|
Assert::notNull( |
117
|
|
|
$xml->ownerDocument->documentElement, |
118
|
|
|
'Cannot create a document reference without a root element in the document.', |
119
|
|
|
RuntimeException::class, |
120
|
|
|
); |
121
|
|
|
Assert::true( |
122
|
|
|
$xml->isSameNode($xml->ownerDocument->documentElement), |
123
|
|
|
'Cannot create a document reference when signing an object that is not the root of the document. ' . |
124
|
|
|
'Please give your object an identifier.', |
125
|
|
|
RuntimeException::class, |
126
|
|
|
); |
127
|
|
|
if (in_array($this->c14nAlg, [C::C14N_INCLUSIVE_WITH_COMMENTS, C::C14N_EXCLUSIVE_WITH_COMMENTS])) { |
128
|
|
|
$uri = '#xpointer(/)'; |
129
|
|
|
} |
130
|
|
|
} elseif (in_array($this->c14nAlg, [C::C14N_INCLUSIVE_WITH_COMMENTS, C::C14N_EXCLUSIVE_WITH_COMMENTS])) { |
131
|
|
|
// regular reference, but must retain comments |
132
|
|
|
$uri = '#xpointer(id(' . $id . '))'; |
133
|
|
|
} else { // regular reference, can ignore comments |
134
|
|
|
$uri = '#' . $id; |
135
|
|
|
} |
136
|
|
|
|
137
|
|
|
return new Reference( |
138
|
|
|
new DigestMethod( |
139
|
|
|
AnyURIValue::fromString($digestAlg), |
140
|
|
|
), |
141
|
|
|
new DigestValue( |
142
|
|
|
DigestValueType::fromString( |
143
|
|
|
base64_encode(hash(C::$DIGEST_ALGORITHMS[$digestAlg], $canonicalDocument, true)), |
144
|
|
|
), |
145
|
|
|
), |
146
|
|
|
$transforms, |
147
|
|
|
null, |
148
|
|
|
null, |
149
|
|
|
($uri !== null) ? AnyURIValue::fromString($uri) : null, |
150
|
|
|
); |
151
|
|
|
} |
152
|
|
|
|
153
|
|
|
|
154
|
|
|
/** |
155
|
|
|
* Do the actual signing of the document. |
156
|
|
|
* |
157
|
|
|
* Note that this method does not insert the signature in the returned \DOMElement. The signature will be available |
158
|
|
|
* in $this->signature as a \SimpleSAML\XMLSecurity\XML\ds\Signature object, which can then be converted to XML |
159
|
|
|
* calling toXML() on it, passing the \DOMElement value returned here as a parameter. The resulting \DOMElement |
160
|
|
|
* can then be inserted in the position desired. |
161
|
|
|
* |
162
|
|
|
* E.g.: |
163
|
|
|
* $xml = // our XML to sign |
164
|
|
|
* $signedXML = $this->doSign($xml); |
165
|
|
|
* $signedXML->appendChild($this->signature->toXML($signedXML)); |
166
|
|
|
* |
167
|
|
|
* @param \DOMElement $xml The element to sign. |
168
|
|
|
* @return \DOMElement The signed element, without the signature attached to it just yet. |
169
|
|
|
*/ |
170
|
|
|
protected function doSign(DOMElement $xml): DOMElement |
171
|
|
|
{ |
172
|
|
|
Assert::notNull( |
173
|
|
|
$this->signer, |
174
|
|
|
'Cannot call toSignedXML() without calling sign() first.', |
175
|
|
|
RuntimeException::class, |
176
|
|
|
); |
177
|
|
|
|
178
|
|
|
$algorithm = $this->signer->getAlgorithmId(); |
|
|
|
|
179
|
|
|
$digest = $this->signer->getDigest(); |
180
|
|
|
|
181
|
|
|
$transforms = new Transforms([ |
182
|
|
|
new Transform( |
183
|
|
|
AnyURIValue::fromString(C::XMLDSIG_ENVELOPED), |
184
|
|
|
), |
185
|
|
|
new Transform( |
186
|
|
|
AnyURIValue::fromString($this->c14nAlg), |
187
|
|
|
), |
188
|
|
|
]); |
189
|
|
|
|
190
|
|
|
$canonicalDocument = XML::processTransforms($transforms, $xml); |
191
|
|
|
|
192
|
|
|
$signedInfo = new SignedInfo( |
193
|
|
|
new CanonicalizationMethod( |
194
|
|
|
AnyURIValue::fromString($this->c14nAlg), |
195
|
|
|
), |
196
|
|
|
new SignatureMethod( |
197
|
|
|
AnyURIValue::fromString($algorithm), |
198
|
|
|
), |
199
|
|
|
[$this->getReference($digest, $transforms, $xml, $canonicalDocument)], |
200
|
|
|
); |
201
|
|
|
|
202
|
|
|
$signingData = $signedInfo->canonicalize($this->c14nAlg); |
203
|
|
|
$signedData = base64_encode($this->signer->sign($signingData)); |
|
|
|
|
204
|
|
|
|
205
|
|
|
$this->setSignature( |
|
|
|
|
206
|
|
|
new Signature( |
207
|
|
|
$signedInfo, |
208
|
|
|
new SignatureValue( |
209
|
|
|
Base64BinaryValue::fromString($signedData), |
210
|
|
|
), |
211
|
|
|
$this->keyInfo, |
212
|
|
|
), |
213
|
|
|
); |
214
|
|
|
return DOMDocumentFactory::fromString($canonicalDocument)->documentElement; |
215
|
|
|
} |
216
|
|
|
|
217
|
|
|
|
218
|
|
|
/** |
219
|
|
|
* Get the list of algorithms that are blacklisted for any signing operation. |
220
|
|
|
* |
221
|
|
|
* @return string[]|null An array with all algorithm identifiers that are blacklisted, or null to use this |
222
|
|
|
* libraries default. |
223
|
|
|
*/ |
224
|
|
|
abstract public function getBlacklistedAlgorithms(): ?array; |
225
|
|
|
} |
226
|
|
|
|
This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.
This is most likely a typographical error or the method has been renamed.