Auth::requireOne() - Code Metrics - Inspection of "Merge branch 'master' of https://github.com/gyselr..." - gyselroth/micro-auth - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6c5006...195e0d )

by Raffael

created 2019-02-28 11:26 UTC

Auth::requireOne() A

↳ Parent: Project

Complexity

Conditions	4
Paths	7

Size

Total Lines	33
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	18
dl	0
loc	33
c	0
b	0
f	0
rs	9.6666
cc	4
nc	7
nop	0

<?php

declare(strict_types=1);

/**
 * Micro
 *
 * @copyright   Copryright (c) 2015-2018 gyselroth GmbH (https://gyselroth.com)
 * @license     MIT https://opensource.org/licenses/MIT
 */

namespace Micro\Auth;

use InvalidArgumentException;
use Micro\Auth\Adapter\AdapterInterface;
use Psr\Log\LoggerInterface;

class Auth
{
    /**
     * Adapter.
     *
     * @var array
     */
    protected $adapter = [];

    /**
     * Identity.
     *
     * @var IdentityInterface
     */
    protected $identity;

    /**
     * Logger.
     *
     * @var LoggerInterface
     */
    protected $logger;

    /**
     * Identity class.
     *
     * @var string
     */
    protected $identity_class = Identity::class;

    /**
     * Attribute map class.
     *
     * @var string
     */
    protected $attribute_map_class = AttributeMap::class;

    /**
     * Initialize.
     *
     * @param LoggerInterface $logger
     * @param iterable        $config
     */
    public function __construct(LoggerInterface $logger, ? Iterable $config = null)
    {
        $this->logger = $logger;
        $this->setOptions($config);
    }

    /**
     * Set options.
     *
     * @param iterable $config
     *
     * @return Auth
     */
    public function setOptions(? Iterable $config = null): self
    {
        if (null === $config) {
            return $this;
        }

        foreach ($config as $option => $value) {
            switch ($option) {
                case 'identity_class':
                case 'attribute_map_class':
                    $this->{$option} = (string) $value;

                break;
                default:
                    throw new InvalidArgumentException('invalid option '.$option.' given');
            }
        }

        return $this;
    }

    /**
     * Check if adapter is injected.
     *
     * @param string $name
     *
     * @return bool
     */
    public function hasAdapter(string $name): bool
    {
        return isset($this->adapter[$name]);
    }

    /**
     * Inject auth adapter.
     *
     * @param AdapterInterface $adapter
     * @param string           $name
     */
    public function injectAdapter(AdapterInterface $adapter, ?string $name = null): self
    {
        if (null === $name) {
            $name = get_class($adapter);
        }

        $this->logger->debug('inject auth adapter ['.$name.'] of type ['.get_class($adapter).']', [
            'category' => get_class($this),
        ]);

        if ($this->hasAdapter($name)) {
            throw new Exception\AdapterNotUnique('auth adapter '.$name.' is already registered');
        }

        $this->adapter[$name] = $adapter;

        return $this;
    }

    /**
     * Get adapter.
     *
     * @param string $name
     *
     * @return AdapterInterface
     */
    public function getAdapter(string $name): AdapterInterface
    {
        if (!$this->hasAdapter($name)) {
            throw new Exception\AdapterNotFound('auth adapter '.$name.' is not registered');
        }

        return $this->adapter[$name];
    }

    /**
     * Get adapters.
     *
     * @return AdapterInterface[]
     */
    public function getAdapters(array $adapters = []): array
    {
        if (empty($adapter)) {
            return $this->adapter;
        }
        $list = [];
        foreach ($adapter as $name) {
            if (!$this->hasAdapter($name)) {
                throw new Exception\AdapterNotFound('auth adapter '.$name.' is not registered');
            }
            $list[$name] = $this->adapter[$name];
        }

        return $list;
    }

    /**
     * Authenticate.
     *
     * @return bool
     */
    public function requireOne(): bool
    {
        $result = false;

        foreach ($this->adapter as $name => $adapter) {
            try {
                if ($adapter->authenticate()) {
                    $this->createIdentity($adapter);

                    $this->logger->info("identity [{$this->identity->getIdentifier()}] authenticated over adapter [{$name}]", [
                        'category' => get_class($this),
                    ]);
                    $_SERVER['REMOTE_USER'] = $this->identity->getIdentifier();

                    return true;
                }
            } catch (\Exception $e) {
                $this->logger->error('failed authenticate user, unexcepted exception was thrown', [
                    'category' => get_class($this),
                    'exception' => $e,
                ]);
            }

            $this->logger->debug("auth adapter [{$name}] failed", [
                'category' => get_class($this),
            ]);
        }

        $this->logger->warning('all authentication adapter have failed', [
            'category' => get_class($this),
        ]);

        return false;
    }

    /**
     * Get identity.
     *
     * @return IdentityInterface
     */
    public function getIdentity(): IdentityInterface
    {
        if (!$this->isAuthenticated()) {
            throw new Exception\NotAuthenticated('no valid authentication yet');
        }

        return $this->identity;
    }

    /**
     * Check if valid identity exists.
     *
     * @return bool
     */
    public function isAuthenticated(): bool
    {
        return $this->identity instanceof Identity;
    }

    /**
     * Create identity.
     *
     * @param AdapterInterface $adapter
     *
     * @return IdentityInterface
     */
    publicc function createIdentity(AdapterInterface $adapter): IdentityInterface

    {
        $map = new $this->attribute_map_class($adapter->getAttributeMap(), $this->logger);
        $this->identity = new $this->identity_class($adapter, $map, $this->logger);

        return $this->identity;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* Micro
7			*
8			* @copyright Copryright (c) 2015-2018 gyselroth GmbH (https://gyselroth.com)
9			* @license MIT https://opensource.org/licenses/MIT
10			*/
11
12			namespace Micro\Auth;
13
14			use InvalidArgumentException;
15			use Micro\Auth\Adapter\AdapterInterface;
16			use Psr\Log\LoggerInterface;
17
18			class Auth
19			{
20			/**
21			* Adapter.
22			*
23			* @var array
24			*/
25			protected $adapter = [];
26
27			/**
28			* Identity.
29			*
30			* @var IdentityInterface
31			*/
32			protected $identity;
33
34			/**
35			* Logger.
36			*
37			* @var LoggerInterface
38			*/
39			protected $logger;
40
41			/**
42			* Identity class.
43			*
44			* @var string
45			*/
46			protected $identity_class = Identity::class;
47
48			/**
49			* Attribute map class.
50			*
51			* @var string
52			*/
53			protected $attribute_map_class = AttributeMap::class;
54
55			/**
56			* Initialize.
57			*
58			* @param LoggerInterface $logger
59			* @param iterable $config
60			*/
61			public function __construct(LoggerInterface $logger, ? Iterable $config = null)
62			{
63			$this->logger = $logger;
64			$this->setOptions($config);
65			}
66
67			/**
68			* Set options.
69			*
70			* @param iterable $config
71			*
72			* @return Auth
73			*/
74			public function setOptions(? Iterable $config = null): self
75			{
76			if (null === $config) {
77			return $this;
78			}
79
80			foreach ($config as $option => $value) {
81			switch ($option) {
82			case 'identity_class':
83			case 'attribute_map_class':
84			$this->{$option} = (string) $value;
85
86			break;
87			default:
88			throw new InvalidArgumentException('invalid option '.$option.' given');
89			}
90			}
91
92			return $this;
93			}
94
95			/**
96			* Check if adapter is injected.
97			*
98			* @param string $name
99			*
100			* @return bool
101			*/
102			public function hasAdapter(string $name): bool
103			{
104			return isset($this->adapter[$name]);
105			}
106
107			/**
108			* Inject auth adapter.
109			*
110			* @param AdapterInterface $adapter
111			* @param string $name
112			*/
113			public function injectAdapter(AdapterInterface $adapter, ?string $name = null): self
114			{
115			if (null === $name) {
116			$name = get_class($adapter);
117			}
118
119			$this->logger->debug('inject auth adapter ['.$name.'] of type ['.get_class($adapter).']', [
120			'category' => get_class($this),
121			]);
122
123			if ($this->hasAdapter($name)) {
124			throw new Exception\AdapterNotUnique('auth adapter '.$name.' is already registered');
125			}
126
127			$this->adapter[$name] = $adapter;
128
129			return $this;
130			}
131
132			/**
133			* Get adapter.
134			*
135			* @param string $name
136			*
137			* @return AdapterInterface
138			*/
139			public function getAdapter(string $name): AdapterInterface
140			{
141			if (!$this->hasAdapter($name)) {
142			throw new Exception\AdapterNotFound('auth adapter '.$name.' is not registered');
143			}
144
145			return $this->adapter[$name];
146			}
147
148			/**
149			* Get adapters.
150			*
151			* @return AdapterInterface[]
152			*/
153			public function getAdapters(array $adapters = []): array
154			{
155			if (empty($adapter)) {
156			return $this->adapter;
157			}
158			$list = [];
159			foreach ($adapter as $name) {
160			if (!$this->hasAdapter($name)) {
161			throw new Exception\AdapterNotFound('auth adapter '.$name.' is not registered');
162			}
163			$list[$name] = $this->adapter[$name];
164			}
165
166			return $list;
167			}
168
169			/**
170			* Authenticate.
171			*
172			* @return bool
173			*/
174			public function requireOne(): bool
175			{
176			$result = false;
177
178			foreach ($this->adapter as $name => $adapter) {
179			try {
180			if ($adapter->authenticate()) {
181			$this->createIdentity($adapter);
182
183			$this->logger->info("identity [{$this->identity->getIdentifier()}] authenticated over adapter [{$name}]", [
184			'category' => get_class($this),
185			]);
186			$_SERVER['REMOTE_USER'] = $this->identity->getIdentifier();
187
188			return true;
189			}
190			} catch (\Exception $e) {
191			$this->logger->error('failed authenticate user, unexcepted exception was thrown', [
192			'category' => get_class($this),
193			'exception' => $e,
194			]);
195			}
196
197			$this->logger->debug("auth adapter [{$name}] failed", [
198			'category' => get_class($this),
199			]);
200			}
201
202			$this->logger->warning('all authentication adapter have failed', [
203			'category' => get_class($this),
204			]);
205
206			return false;
207			}
208
209			/**
210			* Get identity.
211			*
212			* @return IdentityInterface
213			*/
214			public function getIdentity(): IdentityInterface
215			{
216			if (!$this->isAuthenticated()) {
217			throw new Exception\NotAuthenticated('no valid authentication yet');
218			}
219
220			return $this->identity;
221			}
222
223			/**
224			* Check if valid identity exists.
225			*
226			* @return bool
227			*/
228			public function isAuthenticated(): bool
229			{
230			return $this->identity instanceof Identity;
231			}
232
233			/**
234			* Create identity.
235			*
236			* @param AdapterInterface $adapter
237			*
238			* @return IdentityInterface
239			*/
240			publicc function createIdentity(AdapterInterface $adapter): IdentityInterface
			0 ignored issues – show Bug introduced 2019-02-28 11:29 UTC by Report Bug Copy Issue Report A parse error occurred: Syntax error, unexpected T_STRING, expecting T_FUNCTION or T_CONST on line 240 at column 4 Loading history...
241			{
242			$map = new $this->attribute_map_class($adapter->getAttributeMap(), $this->logger);
243			$this->identity = new $this->identity_class($adapter, $map, $this->logger);
244
245			return $this->identity;
246			}
247			}
248

gyselroth / micro-auth

Push — master ( 6c5006...195e0d )

Auth::requireOne() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like