|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
namespace SimpleSAML\SAML2\XML\md; |
|
6
|
|
|
|
|
7
|
|
|
use DateTimeImmutable; |
|
8
|
|
|
use DOMElement; |
|
9
|
|
|
use SimpleSAML\SAML2\Assert\Assert; |
|
10
|
|
|
use SimpleSAML\SAML2\Constants as C; |
|
11
|
|
|
use SimpleSAML\SAML2\XML\ExtendableElementTrait; |
|
12
|
|
|
use SimpleSAML\XML\Exception\SchemaViolationException; |
|
13
|
|
|
|
|
14
|
|
|
/** |
|
15
|
|
|
* Class to represent a metadata document |
|
16
|
|
|
* |
|
17
|
|
|
* @package simplesamlphp/saml2 |
|
18
|
|
|
*/ |
|
19
|
|
|
abstract class AbstractMetadataDocument extends AbstractSignedMdElement |
|
20
|
|
|
{ |
|
21
|
|
|
use ExtendableElementTrait; |
|
22
|
|
|
|
|
23
|
|
|
|
|
24
|
|
|
/** |
|
25
|
|
|
* Generic constructor for SAML metadata documents. |
|
26
|
|
|
* |
|
27
|
|
|
* @param string|null $id The ID for this document. Defaults to null. |
|
28
|
|
|
* @param \DateTimeImmutable|null $validUntil Unix time of validity for this document. Defaults to null. |
|
29
|
|
|
* @param string|null $cacheDuration Maximum time this document can be cached. Defaults to null. |
|
30
|
|
|
* @param \SimpleSAML\SAML2\XML\md\Extensions|null $extensions An array of extensions. Defaults to null. |
|
31
|
|
|
*/ |
|
32
|
|
|
public function __construct( |
|
33
|
|
|
protected ?string $id = null, |
|
34
|
|
|
protected ?DateTimeImmutable $validUntil = null, |
|
35
|
|
|
protected ?string $cacheDuration = null, |
|
36
|
|
|
?Extensions $extensions = null, |
|
37
|
|
|
) { |
|
38
|
|
|
Assert::nullOrValidNCName($id, SchemaViolationException::class); |
|
39
|
|
|
Assert::nullOrSame($validUntil?->getTimeZone()->getName(), 'Z'); |
|
40
|
|
|
Assert::nullOrValidDuration($cacheDuration, SchemaViolationException::class); |
|
41
|
|
|
|
|
42
|
|
|
$this->setExtensions($extensions); |
|
43
|
|
|
} |
|
44
|
|
|
|
|
45
|
|
|
|
|
46
|
|
|
/** |
|
47
|
|
|
* Collect the value of the id property. |
|
48
|
|
|
* |
|
49
|
|
|
* @return string|null |
|
50
|
|
|
*/ |
|
51
|
|
|
public function getId(): ?string |
|
52
|
|
|
{ |
|
53
|
|
|
return $this->id; |
|
54
|
|
|
} |
|
55
|
|
|
|
|
56
|
|
|
|
|
57
|
|
|
/** |
|
58
|
|
|
* Collect the value of the validUntil property. |
|
59
|
|
|
* |
|
60
|
|
|
* @return \DateTimeImmutable|null |
|
61
|
|
|
*/ |
|
62
|
|
|
public function getValidUntil(): ?DateTimeImmutable |
|
63
|
|
|
{ |
|
64
|
|
|
return $this->validUntil; |
|
65
|
|
|
} |
|
66
|
|
|
|
|
67
|
|
|
|
|
68
|
|
|
/** |
|
69
|
|
|
* Collect the value of the cacheDuration property. |
|
70
|
|
|
* |
|
71
|
|
|
* @return string|null |
|
72
|
|
|
*/ |
|
73
|
|
|
public function getCacheDuration(): ?string |
|
74
|
|
|
{ |
|
75
|
|
|
return $this->cacheDuration; |
|
76
|
|
|
} |
|
77
|
|
|
|
|
78
|
|
|
|
|
79
|
|
|
/** |
|
80
|
|
|
* @return \DOMElement |
|
81
|
|
|
*/ |
|
82
|
|
|
protected function getOriginalXML(): DOMElement |
|
83
|
|
|
{ |
|
84
|
|
|
return $this->isSigned() ? $this->getXML() : $this->toUnsignedXML(); |
|
85
|
|
|
} |
|
86
|
|
|
|
|
87
|
|
|
|
|
88
|
|
|
/** |
|
89
|
|
|
* @param \DOMElement|null $parent |
|
90
|
|
|
* |
|
91
|
|
|
* @return \DOMElement |
|
92
|
|
|
*/ |
|
93
|
|
|
public function toUnsignedXML(?DOMElement $parent = null): DOMElement |
|
94
|
|
|
{ |
|
95
|
|
|
$e = $this->instantiateParentElement($parent); |
|
96
|
|
|
|
|
97
|
|
|
if ($this->getId() !== null) { |
|
98
|
|
|
$e->setAttribute('ID', $this->getId()); |
|
99
|
|
|
} |
|
100
|
|
|
|
|
101
|
|
|
if ($this->getValidUntil() !== null) { |
|
102
|
|
|
$e->setAttribute('validUntil', $this->getValidUntil()->format(C::DATETIME_FORMAT)); |
|
103
|
|
|
} |
|
104
|
|
|
|
|
105
|
|
|
if ($this->getCacheDuration() !== null) { |
|
106
|
|
|
$e->setAttribute('cacheDuration', $this->getCacheDuration()); |
|
107
|
|
|
} |
|
108
|
|
|
|
|
109
|
|
|
$extensions = $this->getExtensions(); |
|
110
|
|
|
if ($extensions !== null && !$extensions->isEmptyElement()) { |
|
111
|
|
|
$extensions->toXML($e); |
|
112
|
|
|
} |
|
113
|
|
|
|
|
114
|
|
|
return $e; |
|
115
|
|
|
} |
|
116
|
|
|
} |
|
117
|
|
|
|
simplesamlphp /
saml2
