JWE::addRecipient() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/v2.0.x' into..." - Spomky-Labs/jose - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — v2.0.x ( 45cd5b...255948 )

by Florent

created 2016-01-27 11:09 UTC

JWE::addRecipient() A

↳ Parent: JWE

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	7
rs	9.4285
cc	1
eloc	4
nc	1
nop	1

<?php

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2016 Spomky-Labs
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 */

namespace Jose\Object;

use Base64Url\Base64Url;

/**
 * Class JWE.
 */
final class JWE implements JWEInterface
{
    use JWT;

    /**
     * @var \Jose\Object\RecipientInterface[]
     */
    private $recipients = [];

    /**
     * @var string|null
     */
    private $ciphertext = null;

    /**
     * @var string|null
     */
    private $iv = null;

    /**
     * @var string|null
     */
    private $aad = null;

    /**
     * @var string|null
     */
    private $tag = null;

    /**
     * @var array
     */
    private $shared_headers = [];

    /**
     * @var array
     */
    private $shared_protected_headers = [];

    /**
     * @var string|null
     */
    private $encoded_shared_protected_headers = null;

    /**
     * @var string|null
     */
    private $content_encryption_key = null;

    /**
     * {@inheritdoc}
     */
    public function countRecipients()
    {
        return count($this->recipients);
    }

    /**
     * {@inheritdoc}
     */
    public function addRecipient(RecipientInterface $recipient)
    {
        $jwe = clone $this;
        $jwe->recipients[] = $recipient;

        return $jwe;
    }

    /**
     * {@inheritdoc}
     */
    public function getRecipients()
    {
        return $this->recipients;
    }

    /**
     * {@inheritdoc}
     */
    public function getRecipient($id)
    {
        if (!isset($this->recipients[$id])) {
            throw new \InvalidArgumentException('The recipient does not exist.');
        }
        return $this->recipients[$id];
    }

    /**
     * {@inheritdoc}
     */
    public function getCiphertext()
    {
        return $this->ciphertext;
    }

    /**
     * {@inheritdoc}
     */
    public function withCiphertext($ciphertext)
    {
        $jwe = clone $this;
        $jwe->ciphertext = $ciphertext;

        return $jwe;
    }

    /**
     * {@inheritdoc}
     */
    public function getAAD()
    {
        return $this->aad;
    }

    /**
     * {@inheritdoc}
     */
    public function withAAD($aad)
    {
        $jwe = clone $this;
        $jwe->aad = $aad;

        return $jwe;
    }

    /**
     * {@inheritdoc}
     */
    public function getIV()
    {
        return $this->iv;
    }

    /**
     * {@inheritdoc}
     */
    public function withIV($iv)
    {
        $jwe = clone $this;
        $jwe->iv = $iv;

        return $jwe;
    }

    /**
     * {@inheritdoc}
     */
    public function getTag()
    {
        return $this->tag;
    }

    /**
     * {@inheritdoc}
     */
    public function withTag($tag)
    {
        $jwe = clone $this;
        $jwe->tag = $tag;

        return $jwe;
    }

    /**
     * {@inheritdoc}
     */
    public function getEncodedSharedProtectedHeaders()
    {
        return $this->encoded_shared_protected_headers;
    }

    /**
     * {@inheritdoc}
     */
    public function withEncodedSharedProtectedHeaders($encoded_shared_protected_headers)
    {
        $jwe = clone $this;
        $jwe->encoded_shared_protected_headers = $encoded_shared_protected_headers;

        return $jwe;
    }

    /**
     * {@inheritdoc}
     */
    public function getSharedProtectedHeaders()
    {
        return $this->shared_protected_headers;
    }

    /**
     * {@inheritdoc}
     */
    public function withSharedProtectedHeaders(array $shared_protected_headers)
    {
        $jwe = clone $this;
        $jwe->shared_protected_headers = $shared_protected_headers;

        return $jwe;
    }

    /**
     * {@inheritdoc}
     */
    public function withSharedProtectedHeader($key, $value)
    {
        $jwe = clone $this;
        $jwe->shared_protected_headers[$key] = $value;

        return $jwe;
    }

    /**
     * {@inheritdoc}
     */
    public function getSharedProtectedHeader($key)
    {
        if ($this->hasSharedProtectedHeader($key)) {
            return $this->shared_protected_headers[$key];
        }
        throw new \InvalidArgumentException(sprintf('The shared protected header "%s" does not exist', $key));
    }

    /**
     * {@inheritdoc}
     */
    public function hasSharedProtectedHeader($key)
    {
        return array_key_exists($key, $this->shared_protected_headers);
    }

    /**
     * {@inheritdoc}
     */
    public function withSharedHeaders(array $shared_headers)
    {
        $jwe = clone $this;
        $jwe->shared_headers = $shared_headers;

        return $jwe;
    }

    /**
     * {@inheritdoc}
     */
    public function withSharedHeader($key, $value)
    {
        $jwe = clone $this;
        $jwe->shared_headers[$key] = $value;

        return $jwe;
    }

    /**
     * {@inheritdoc}
     */
    public function getSharedHeaders()
    {
        return $this->shared_headers;
    }

    /**
     * {@inheritdoc}
     */
    public function getSharedHeader($key)
    {
        if ($this->hasSharedHeader($key)) {
            return $this->shared_headers[$key];
        }
        throw new \InvalidArgumentException(sprintf('The shared header "%s" does not exist', $key));
    }

    /**
     * {@inheritdoc}
     */
    public function hasSharedHeader($key)
    {
        return array_key_exists($key, $this->shared_headers);
    }

    /**
     * {@inheritdoc}
     */
    public function toCompactJSON($id)
    {
        $recipient = $this->getRecipient($id);

        if (empty($this->getSharedProtectedHeaders())) {
            throw new \InvalidArgumentException('This JWE does not have shared protected headers and cannot be converted into Compact JSON.');
        }

        return sprintf(
            '%s.%s.%s.%s.%s',
            $this->getEncodedSharedProtectedHeaders(),
            Base64Url::encode(null === $recipient->getEncryptedKey() ? '' : $recipient->getEncryptedKey()),
            Base64Url::encode(null === $this->getIV() ? '' : $this->getIV()),
            Base64Url::encode($this->getCiphertext()),
            Base64Url::encode(null === $this->getTag() ? '' : $this->getTag())
        );
    }

    /**
     * {@inheritdoc}
     */
    public function toFlattenedJSON($id)
    {
        $recipient = $this->getRecipient($id);

        $json = [
            'ciphertext' => Base64Url::encode($this->getCiphertext()),
        ];
        if (null !== $this->getIV()) {
            $json['iv'] = Base64Url::encode($this->getIV());
        }
        if (null !== $this->getTag()) {
            $json['tag'] = Base64Url::encode($this->getTag());
        }
        if (null !== $this->getAAD()) {
            $json['aad'] = Base64Url::encode($this->getAAD());
        }
        if (!empty($this->getSharedProtectedHeaders())) {
            $json['protected'] = $this->getEncodedSharedProtectedHeaders();
        }
        if (!empty($this->getSharedHeaders())) {
            $json['unprotected'] = $this->getSharedHeaders();
        }
        if (!empty($recipient->getHeaders())) {
            $json['header'] = $recipient->getHeaders();
        }
        if (!empty($recipient->getEncryptedKey())) {
            $json['encrypted_key'] = Base64Url::encode($recipient->getEncryptedKey());
        }

        return json_encode($json);
    }

    /**
     * {@inheritdoc}
     */
    public function toJSON()
    {
        $json = [
            'ciphertext' => Base64Url::encode($this->getCiphertext()),
        ];
        if (null !== $this->getIV()) {
            $json['iv'] = Base64Url::encode($this->getIV());
        }
        if (null !== $this->getTag()) {
            $json['tag'] = Base64Url::encode($this->getTag());
        }
        if (null !== $this->getAAD()) {
            $json['aad'] = Base64Url::encode($this->getAAD());
        }
        if (!empty($this->getSharedProtectedHeaders())) {
            $json['protected'] = $this->getEncodedSharedProtectedHeaders();
        }
        if (!empty($this->getSharedHeaders())) {
            $json['unprotected'] = $this->getSharedHeaders();
        }
        $json['recipients'] = [];
        foreach ($this->getRecipients() as $recipient) {
            $temp = [];
            if (!empty($recipient->getHeaders())) {
                $temp['header'] = $recipient->getHeaders();
            }
            if (!empty($recipient->getEncryptedKey())) {
                $temp['encrypted_key'] = Base64Url::encode($recipient->getEncryptedKey());
            }
            $json['recipients'][] = $temp;
        }

        return json_encode($json);
    }

    /**
     * {@inheritdoc}
     */
    public function getContentEncryptionKey()
    {
        return $this->content_encryption_key;
    }

    /**
     * {@inheritdoc}
     */
    public function withContentEncryptionKey($content_encryption_key)
    {
        $jwe = clone $this;
        $jwe->content_encryption_key = $content_encryption_key;

        return $jwe;
    }
}


1			<?php
2
3			/*
4			* The MIT License (MIT)
5			*
6			* Copyright (c) 2014-2016 Spomky-Labs
7			*
8			* This software may be modified and distributed under the terms
9			* of the MIT license. See the LICENSE file for details.
10			*/
11
12			namespace Jose\Object;
13
14			use Base64Url\Base64Url;
15
16			/**
17			* Class JWE.
18			*/
19			final class JWE implements JWEInterface
20			{
21			use JWT;
22
23			/**
24			* @var \Jose\Object\RecipientInterface[]
25			*/
26			private $recipients = [];
27
28			/**
29			* @var string\|null
30			*/
31			private $ciphertext = null;
32
33			/**
34			* @var string\|null
35			*/
36			private $iv = null;
37
38			/**
39			* @var string\|null
40			*/
41			private $aad = null;
42
43			/**
44			* @var string\|null
45			*/
46			private $tag = null;
47
48			/**
49			* @var array
50			*/
51			private $shared_headers = [];
52
53			/**
54			* @var array
55			*/
56			private $shared_protected_headers = [];
57
58			/**
59			* @var string\|null
60			*/
61			private $encoded_shared_protected_headers = null;
62
63			/**
64			* @var string\|null
65			*/
66			private $content_encryption_key = null;
67
68			/**
69			* {@inheritdoc}
70			*/
71			public function countRecipients()
72			{
73			return count($this->recipients);
74			}
75
76			/**
77			* {@inheritdoc}
78			*/
79			public function addRecipient(RecipientInterface $recipient)
80			{
81			$jwe = clone $this;
82			$jwe->recipients[] = $recipient;
83
84			return $jwe;
85			}
86
87			/**
88			* {@inheritdoc}
89			*/
90			public function getRecipients()
91			{
92			return $this->recipients;
93			}
94
95			/**
96			* {@inheritdoc}
97			*/
98			public function getRecipient($id)
99			{
100			if (!isset($this->recipients[$id])) {
101			throw new \InvalidArgumentException('The recipient does not exist.');
102			}
103			return $this->recipients[$id];
104			}
105
106			/**
107			* {@inheritdoc}
108			*/
109			public function getCiphertext()
110			{
111			return $this->ciphertext;
112			}
113
114			/**
115			* {@inheritdoc}
116			*/
117			public function withCiphertext($ciphertext)
118			{
119			$jwe = clone $this;
120			$jwe->ciphertext = $ciphertext;
121
122			return $jwe;
123			}
124
125			/**
126			* {@inheritdoc}
127			*/
128			public function getAAD()
129			{
130			return $this->aad;
131			}
132
133			/**
134			* {@inheritdoc}
135			*/
136			public function withAAD($aad)
137			{
138			$jwe = clone $this;
139			$jwe->aad = $aad;
140
141			return $jwe;
142			}
143
144			/**
145			* {@inheritdoc}
146			*/
147			public function getIV()
148			{
149			return $this->iv;
150			}
151
152			/**
153			* {@inheritdoc}
154			*/
155			public function withIV($iv)
156			{
157			$jwe = clone $this;
158			$jwe->iv = $iv;
159
160			return $jwe;
161			}
162
163			/**
164			* {@inheritdoc}
165			*/
166			public function getTag()
167			{
168			return $this->tag;
169			}
170
171			/**
172			* {@inheritdoc}
173			*/
174			public function withTag($tag)
175			{
176			$jwe = clone $this;
177			$jwe->tag = $tag;
178
179			return $jwe;
180			}
181
182			/**
183			* {@inheritdoc}
184			*/
185			public function getEncodedSharedProtectedHeaders()
186			{
187			return $this->encoded_shared_protected_headers;
188			}
189
190			/**
191			* {@inheritdoc}
192			*/
193			public function withEncodedSharedProtectedHeaders($encoded_shared_protected_headers)
194			{
195			$jwe = clone $this;
196			$jwe->encoded_shared_protected_headers = $encoded_shared_protected_headers;
197
198			return $jwe;
199			}
200
201			/**
202			* {@inheritdoc}
203			*/
204			public function getSharedProtectedHeaders()
205			{
206			return $this->shared_protected_headers;
207			}
208
209			/**
210			* {@inheritdoc}
211			*/
212			public function withSharedProtectedHeaders(array $shared_protected_headers)
213			{
214			$jwe = clone $this;
215			$jwe->shared_protected_headers = $shared_protected_headers;
216
217			return $jwe;
218			}
219
220			/**
221			* {@inheritdoc}
222			*/
223			public function withSharedProtectedHeader($key, $value)
224			{
225			$jwe = clone $this;
226			$jwe->shared_protected_headers[$key] = $value;
227
228			return $jwe;
229			}
230
231			/**
232			* {@inheritdoc}
233			*/
234			public function getSharedProtectedHeader($key)
235			{
236			if ($this->hasSharedProtectedHeader($key)) {
237			return $this->shared_protected_headers[$key];
238			}
239			throw new \InvalidArgumentException(sprintf('The shared protected header "%s" does not exist', $key));
240			}
241
242			/**
243			* {@inheritdoc}
244			*/
245			public function hasSharedProtectedHeader($key)
246			{
247			return array_key_exists($key, $this->shared_protected_headers);
248			}
249
250			/**
251			* {@inheritdoc}
252			*/
253			public function withSharedHeaders(array $shared_headers)
254			{
255			$jwe = clone $this;
256			$jwe->shared_headers = $shared_headers;
257
258			return $jwe;
259			}
260
261			/**
262			* {@inheritdoc}
263			*/
264			public function withSharedHeader($key, $value)
265			{
266			$jwe = clone $this;
267			$jwe->shared_headers[$key] = $value;
268
269			return $jwe;
270			}
271
272			/**
273			* {@inheritdoc}
274			*/
275			public function getSharedHeaders()
276			{
277			return $this->shared_headers;
278			}
279
280			/**
281			* {@inheritdoc}
282			*/
283			public function getSharedHeader($key)
284			{
285			if ($this->hasSharedHeader($key)) {
286			return $this->shared_headers[$key];
287			}
288			throw new \InvalidArgumentException(sprintf('The shared header "%s" does not exist', $key));
289			}
290
291			/**
292			* {@inheritdoc}
293			*/
294			public function hasSharedHeader($key)
295			{
296			return array_key_exists($key, $this->shared_headers);
297			}
298
299			/**
300			* {@inheritdoc}
301			*/
302			public function toCompactJSON($id)
303			{
304			$recipient = $this->getRecipient($id);
305
306			if (empty($this->getSharedProtectedHeaders())) {
307			throw new \InvalidArgumentException('This JWE does not have shared protected headers and cannot be converted into Compact JSON.');
308			}
309
310			return sprintf(
311			'%s.%s.%s.%s.%s',
312			$this->getEncodedSharedProtectedHeaders(),
313			Base64Url::encode(null === $recipient->getEncryptedKey() ? '' : $recipient->getEncryptedKey()),
314			Base64Url::encode(null === $this->getIV() ? '' : $this->getIV()),
315			Base64Url::encode($this->getCiphertext()),
316			Base64Url::encode(null === $this->getTag() ? '' : $this->getTag())
317			);
318			}
319
320			/**
321			* {@inheritdoc}
322			*/
323			public function toFlattenedJSON($id)
324			{
325			$recipient = $this->getRecipient($id);
326
327			$json = [
328			'ciphertext' => Base64Url::encode($this->getCiphertext()),
329			];
330			if (null !== $this->getIV()) {
331			$json['iv'] = Base64Url::encode($this->getIV());
332			}
333			if (null !== $this->getTag()) {
334			$json['tag'] = Base64Url::encode($this->getTag());
335			}
336			if (null !== $this->getAAD()) {
337			$json['aad'] = Base64Url::encode($this->getAAD());
338			}
339			if (!empty($this->getSharedProtectedHeaders())) {
340			$json['protected'] = $this->getEncodedSharedProtectedHeaders();
341			}
342			if (!empty($this->getSharedHeaders())) {
343			$json['unprotected'] = $this->getSharedHeaders();
344			}
345			if (!empty($recipient->getHeaders())) {
346			$json['header'] = $recipient->getHeaders();
347			}
348			if (!empty($recipient->getEncryptedKey())) {
349			$json['encrypted_key'] = Base64Url::encode($recipient->getEncryptedKey());
350			}
351
352			return json_encode($json);
353			}
354
355			/**
356			* {@inheritdoc}
357			*/
358			public function toJSON()
359			{
360			$json = [
361			'ciphertext' => Base64Url::encode($this->getCiphertext()),
362			];
363			if (null !== $this->getIV()) {
364			$json['iv'] = Base64Url::encode($this->getIV());
365			}
366			if (null !== $this->getTag()) {
367			$json['tag'] = Base64Url::encode($this->getTag());
368			}
369			if (null !== $this->getAAD()) {
370			$json['aad'] = Base64Url::encode($this->getAAD());
371			}
372			if (!empty($this->getSharedProtectedHeaders())) {
373			$json['protected'] = $this->getEncodedSharedProtectedHeaders();
374			}
375			if (!empty($this->getSharedHeaders())) {
376			$json['unprotected'] = $this->getSharedHeaders();
377			}
378			$json['recipients'] = [];
379			foreach ($this->getRecipients() as $recipient) {
380			$temp = [];
381			if (!empty($recipient->getHeaders())) {
382			$temp['header'] = $recipient->getHeaders();
383			}
384			if (!empty($recipient->getEncryptedKey())) {
385			$temp['encrypted_key'] = Base64Url::encode($recipient->getEncryptedKey());
386			}
387			$json['recipients'][] = $temp;
388			}
389
390			return json_encode($json);
391			}
392
393			/**
394			* {@inheritdoc}
395			*/
396			public function getContentEncryptionKey()
397			{
398			return $this->content_encryption_key;
399			}
400
401			/**
402			* {@inheritdoc}
403			*/
404			public function withContentEncryptionKey($content_encryption_key)
405			{
406			$jwe = clone $this;
407			$jwe->content_encryption_key = $content_encryption_key;
408
409			return $jwe;
410			}
411			}
412

Spomky-Labs / jose

Push — v2.0.x ( 45cd5b...255948 )

JWE::addRecipient() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like