EncryptedElementTrait::__construct()   A
last analyzed

Complexity

Conditions 4
Paths 4

Size

Total Lines 21
Code Lines 9

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 4
eloc 9
nc 4
nop 2
dl 0
loc 21
rs 9.9666
c 0
b 0
f 0
1
<?php
2
3
declare(strict_types=1);
4
5
namespace SimpleSAML\SAML2\XML;
6
7
use DOMElement;
8
use SimpleSAML\SAML2\Assert\Assert;
9
use SimpleSAML\SAML2\Compat\ContainerSingleton;
10
use SimpleSAML\SAML2\Exception\ProtocolViolationException;
11
use SimpleSAML\XML\AbstractElement;
12
use SimpleSAML\XMLSchema\Exception\InvalidDOMElementException;
13
use SimpleSAML\XMLSchema\Exception\TooManyElementsException;
14
use SimpleSAML\XMLSecurity\Backend\EncryptionBackend;
15
use SimpleSAML\XMLSecurity\Constants as C;
0 ignored issues
show
Bug introduced by
The type SimpleSAML\XMLSecurity\Constants was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
16
use SimpleSAML\XMLSecurity\XML\EncryptedElementTrait as ParentEncryptedElementTrait;
17
use SimpleSAML\XMLSecurity\XML\xenc\EncryptedData;
18
use SimpleSAML\XMLSecurity\XML\xenc\EncryptedKey;
19
20
/**
21
 * Trait aggregating functionality for elements that are encrypted.
22
 *
23
 * @package simplesamlphp/saml2
24
 */
25
trait EncryptedElementTrait
26
{
27
    use ParentEncryptedElementTrait;
28
29
30
    /**
31
     * Constructor for encrypted elements.
32
     *
33
     * @param \SimpleSAML\XMLSecurity\XML\xenc\EncryptedData $encryptedData The EncryptedData object.
34
     * @param \SimpleSAML\XMLSecurity\XML\xenc\EncryptedKey[] $decryptionKeys The EncryptedKey objects.
35
     */
36
    final public function __construct(
37
        protected EncryptedData $encryptedData,
38
        protected array $decryptionKeys = [],
39
    ) {
40
        Assert::allIsInstanceOf($decryptionKeys, EncryptedKey::class, ProtocolViolationException::class);
41
42
        /**
43
         * 6.2: The <EncryptedData> element's Type attribute SHOULD be used and, if it is
44
         * present, MUST have the value http://www.w3.org/2001/04/xmlenc#Element.
45
         */
46
        Assert::nullOrSame($encryptedData->getType()->getValue(), C::XMLENC_ELEMENT);
47
48
        $keyInfo = $this->encryptedData->getKeyInfo();
49
        if ($keyInfo === null) {
50
            return;
51
        }
52
53
        foreach ($keyInfo->getInfo() as $info) {
54
            if ($info instanceof EncryptedKey) {
55
                $this->encryptedKey = [$info];
56
                break;
57
            }
58
        }
59
    }
60
61
62
    /**
63
     * @return array|null
64
     */
65
    public function getBlacklistedAlgorithms(): ?array
66
    {
67
        $container = ContainerSingleton::getInstance();
68
        return $container->getBlacklistedEncryptionAlgorithms();
69
    }
70
71
72
    /**
73
     * @return \SimpleSAML\XMLSecurity\Backend\EncryptionBackend|null
74
     */
75
    public function getEncryptionBackend(): ?EncryptionBackend
76
    {
77
        // return the encryption backend you want to use,
78
        // or null if you are fine with the default
79
        return null;
80
    }
81
82
83
    public function getDecryptionKeys(): array
84
    {
85
        return $this->decryptionKeys;
86
    }
87
88
89
    /**
90
     * @inheritDoc
91
     *
92
     * @throws \SimpleSAML\XMLSchema\Exception\InvalidDOMElementException
93
     *   If the qualified name of the supplied element is wrong
94
     */
95
    public static function fromXML(DOMElement $xml): static
96
    {
97
        Assert::same(
98
            $xml->localName,
99
            AbstractElement::getClassName(static::class),
100
            InvalidDOMElementException::class,
101
        );
102
        Assert::same($xml->namespaceURI, static::NS, InvalidDOMElementException::class);
0 ignored issues
show
Bug introduced by
The constant SimpleSAML\SAML2\XML\EncryptedElementTrait::NS was not found. Maybe you did not declare it correctly or list all dependencies?
Loading history...
103
104
        $ed = EncryptedData::getChildrenOfClass($xml);
105
        Assert::count(
106
            $ed,
107
            1,
108
            sprintf(
109
                'No more or less than one EncryptedData element allowed in %s.',
110
                AbstractElement::getClassName(static::class),
111
            ),
112
            TooManyElementsException::class,
113
        );
114
115
        $ek = EncryptedKey::getChildrenOfClass($xml);
116
        return new static($ed[0], $ek);
117
    }
118
119
120
    /**
121
     * @inheritDoc
122
     */
123
    public function toXML(?DOMElement $parent = null): DOMElement
124
    {
125
        $e = $this->instantiateParentElement($parent);
126
127
        $this->encryptedData->toXML($e);
128
129
        foreach ($this->getDecryptionKeys() as $key) {
130
            $key->toXML($e);
131
        }
132
133
        return $e;
134
    }
135
}
136