CredentialRepository::reset() - Code Metrics - silverstripe/silverstripe-webauthn-authenticator - Measure and Improve Code Quality continuously with Scrutinizer

CredentialRepository::reset() A
last analyzed 2020-03-19 02:21 UTC

↳ Parent: CredentialRepository

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10

<?php

declare(strict_types=1);

namespace SilverStripe\WebAuthn;

use InvalidArgumentException;
use Serializable;
use Webauthn\AttestedCredentialData;
use Webauthn\PublicKeyCredentialSource;
use Webauthn\PublicKeyCredentialSourceRepository;
use Webauthn\PublicKeyCredentialUserEntity;

/**
 * Implements the required interface from the WebAuthn library - but it does not implement the repository pattern in the
 * usual way. This is expected to be stored on a DataObject for persistence. Use the
 * @see CredentialRepository::hasChanged() API for determining whether a DataObject this is stored upon should be
 * persisted.
 */
class CredentialRepository implements PublicKeyCredentialSourceRepository, Serializable
{
    /**
     * @var string
     */
    private $memberID;

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

    /**
     * @var bool
     */
    private $hasChanged = false;

    /**
     * @param string $memberID
     */
    public function __construct(string $memberID)
    {
        $this->memberID = $memberID;
    }

    public function has(string $credentialId): bool
    {
        return $this->findOneByCredentialId($credentialId) !== null;
    }

    public function get(string $credentialId): AttestedCredentialData
    {
        $this->assertCredentialID($credentialId);

        return $this->findOneByCredentialId($credentialId)->getAttestedCredentialData();
    }

    public function getUserHandleFor(string $credentialId): string
    {
        $this->assertCredentialID($credentialId);

        return $this->memberID;
    }

    public function getCounterFor(string $credentialId): int
    {
        $this->assertCredentialID($credentialId);

        return (int) $this->credentials[$this->getCredentialIDRef($credentialId)]['counter'];
    }

    public function updateCounterFor(string $credentialId, int $newCounter): void
    {
        $this->assertCredentialID($credentialId);

        $this->credentials[$this->getCredentialIDRef($credentialId)]['counter'] = $newCounter;
        $this->hasChanged = true;
    }

    /**
     * Assert that the given credential ID matches a stored credential
     *
     * @param string $credentialId
     */
    protected function assertCredentialID(string $credentialId): void
    {
        if (!$this->has($credentialId)) {
            throw new InvalidArgumentException('Given credential ID does not match any stored credentials');
        }
    }

    public function findOneByCredentialId(string $publicKeyCredentialId): ?PublicKeyCredentialSource
    {
        $ref = $this->getCredentialIDRef($publicKeyCredentialId);
        if (!isset($this->credentials[$ref])) {
            return null;
        }

        return $this->credentials[$ref]['source'];
    }

    /**
     * @return PublicKeyCredentialSource[]
     */
    public function findAllForUserEntity(PublicKeyCredentialUserEntity $publicKeyCredentialUserEntity): array
    {
        // Only return credentials if the user entity shares the same ID.
        if ($publicKeyCredentialUserEntity->getId() !== $this->memberID) {
            return [];
        }

        return array_map(function ($credentialComposite) {
            return $credentialComposite['source'];
        }, $this->credentials);
    }

    public function saveCredentialSource(PublicKeyCredentialSource $publicKeyCredentialSource): void
    {
        $ref = $this->getCredentialIDRef($publicKeyCredentialSource->getPublicKeyCredentialId());

        if (!isset($this->credentials[$ref])) {
            $this->credentials[$ref] = [
                'counter' => 0,
            ];
        }

        $this->credentials[$ref]['source'] = $publicKeyCredentialSource;
        $this->hasChanged = true;
    }

    /**
     * Empty the store deleting all stored credentials
     */
    public function reset(): void
    {
        $this->credentials = [];
    }

    /**
     * Indicates the repository has changed and should be persisted (as this doesn't follow the actual repository
     * pattern and is expected to be stored on a dataobject for persistence)
     *
     * @return bool
     */
    public function hasChanged(): bool
    {
        return $this->hasChanged;
    }

    /**
     * Set the credentials in bulk (for internal use) ensuring that credential objects are initialised correctly
     *
     * @param array $credentials
     */
    protected function setCredentials(array $credentials): void
    {
        $this->credentials = array_map(function ($data) {
            $data['source'] = PublicKeyCredentialSource::createFromArray($data['source']);
            return $data;
        }, $credentials);
    }

    /**
     * Create a reference to be used as a key for the credentials in the array
     *
     * @param string $credentialID
     * @return string
     */
    protected function getCredentialIDRef(string $credentialID): string
    {
        return base64_encode($credentialID);
    }

    /**
     * Provide the credentials stored in this repository as an array
     *
     * @return array
     */
    public function toArray(): array
    {
        return $this->credentials;
    }

    /**
     * Create an instance of a repository from the given credentials
     *
     * @param array $credentials
     * @param string $memberID
     * @return CredentialRepository
     */
    public static function fromArray(array $credentials, string $memberID): self
    {
        $new = new static($memberID);
        $new->setCredentials($credentials);

        return $new;
    }

    public function serialize()
    {
        return json_encode(['credentials' => $this->toArray(), 'memberID' => $this->memberID]);
    }

    public function unserialize($serialized)
    {
        $raw = json_decode($serialized, true);

        $this->memberID = $raw['memberID'];
        $this->setCredentials($raw['credentials']);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SilverStripe\WebAuthn;
6
7			use InvalidArgumentException;
8			use Serializable;
9			use Webauthn\AttestedCredentialData;
10			use Webauthn\PublicKeyCredentialSource;
11			use Webauthn\PublicKeyCredentialSourceRepository;
12			use Webauthn\PublicKeyCredentialUserEntity;
13
14			/**
15			* Implements the required interface from the WebAuthn library - but it does not implement the repository pattern in the
16			* usual way. This is expected to be stored on a DataObject for persistence. Use the
17			* @see CredentialRepository::hasChanged() API for determining whether a DataObject this is stored upon should be
18			* persisted.
19			*/
20			class CredentialRepository implements PublicKeyCredentialSourceRepository, Serializable
21			{
22			/**
23			* @var string
24			*/
25			private $memberID;
26
27			/**
28			* @var array
29			*/
30			private $credentials = [];
31
32			/**
33			* @var bool
34			*/
35			private $hasChanged = false;
36
37			/**
38			* @param string $memberID
39			*/
40			public function __construct(string $memberID)
41			{
42			$this->memberID = $memberID;
43			}
44
45			public function has(string $credentialId): bool
46			{
47			return $this->findOneByCredentialId($credentialId) !== null;
48			}
49
50			public function get(string $credentialId): AttestedCredentialData
51			{
52			$this->assertCredentialID($credentialId);
53
54			return $this->findOneByCredentialId($credentialId)->getAttestedCredentialData();
55			}
56
57			public function getUserHandleFor(string $credentialId): string
58			{
59			$this->assertCredentialID($credentialId);
60
61			return $this->memberID;
62			}
63
64			public function getCounterFor(string $credentialId): int
65			{
66			$this->assertCredentialID($credentialId);
67
68			return (int) $this->credentials[$this->getCredentialIDRef($credentialId)]['counter'];
69			}
70
71			public function updateCounterFor(string $credentialId, int $newCounter): void
72			{
73			$this->assertCredentialID($credentialId);
74
75			$this->credentials[$this->getCredentialIDRef($credentialId)]['counter'] = $newCounter;
76			$this->hasChanged = true;
77			}
78
79			/**
80			* Assert that the given credential ID matches a stored credential
81			*
82			* @param string $credentialId
83			*/
84			protected function assertCredentialID(string $credentialId): void
85			{
86			if (!$this->has($credentialId)) {
87			throw new InvalidArgumentException('Given credential ID does not match any stored credentials');
88			}
89			}
90
91			public function findOneByCredentialId(string $publicKeyCredentialId): ?PublicKeyCredentialSource
92			{
93			$ref = $this->getCredentialIDRef($publicKeyCredentialId);
94			if (!isset($this->credentials[$ref])) {
95			return null;
96			}
97
98			return $this->credentials[$ref]['source'];
99			}
100
101			/**
102			* @return PublicKeyCredentialSource[]
103			*/
104			public function findAllForUserEntity(PublicKeyCredentialUserEntity $publicKeyCredentialUserEntity): array
105			{
106			// Only return credentials if the user entity shares the same ID.
107			if ($publicKeyCredentialUserEntity->getId() !== $this->memberID) {
108			return [];
109			}
110
111			return array_map(function ($credentialComposite) {
112			return $credentialComposite['source'];
113			}, $this->credentials);
114			}
115
116			public function saveCredentialSource(PublicKeyCredentialSource $publicKeyCredentialSource): void
117			{
118			$ref = $this->getCredentialIDRef($publicKeyCredentialSource->getPublicKeyCredentialId());
119
120			if (!isset($this->credentials[$ref])) {
121			$this->credentials[$ref] = [
122			'counter' => 0,
123			];
124			}
125
126			$this->credentials[$ref]['source'] = $publicKeyCredentialSource;
127			$this->hasChanged = true;
128			}
129
130			/**
131			* Empty the store deleting all stored credentials
132			*/
133			public function reset(): void
134			{
135			$this->credentials = [];
136			}
137
138			/**
139			* Indicates the repository has changed and should be persisted (as this doesn't follow the actual repository
140			* pattern and is expected to be stored on a dataobject for persistence)
141			*
142			* @return bool
143			*/
144			public function hasChanged(): bool
145			{
146			return $this->hasChanged;
147			}
148
149			/**
150			* Set the credentials in bulk (for internal use) ensuring that credential objects are initialised correctly
151			*
152			* @param array $credentials
153			*/
154			protected function setCredentials(array $credentials): void
155			{
156			$this->credentials = array_map(function ($data) {
157			$data['source'] = PublicKeyCredentialSource::createFromArray($data['source']);
158			return $data;
159			}, $credentials);
160			}
161
162			/**
163			* Create a reference to be used as a key for the credentials in the array
164			*
165			* @param string $credentialID
166			* @return string
167			*/
168			protected function getCredentialIDRef(string $credentialID): string
169			{
170			return base64_encode($credentialID);
171			}
172
173			/**
174			* Provide the credentials stored in this repository as an array
175			*
176			* @return array
177			*/
178			public function toArray(): array
179			{
180			return $this->credentials;
181			}
182
183			/**
184			* Create an instance of a repository from the given credentials
185			*
186			* @param array $credentials
187			* @param string $memberID
188			* @return CredentialRepository
189			*/
190			public static function fromArray(array $credentials, string $memberID): self
191			{
192			$new = new static($memberID);
193			$new->setCredentials($credentials);
194
195			return $new;
196			}
197
198			public function serialize()
199			{
200			return json_encode(['credentials' => $this->toArray(), 'memberID' => $this->memberID]);
201			}
202
203			public function unserialize($serialized)
204			{
205			$raw = json_decode($serialized, true);
206
207			$this->memberID = $raw['memberID'];
208			$this->setCredentials($raw['credentials']);
209			}
210			}
211

silverstripe / silverstripe-webauthn-authenticator

CredentialRepository::reset() A last analyzed 2020-03-19 02:21 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

CredentialRepository::reset() A
last analyzed 2020-03-19 02:21 UTC