Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
12 / 12
100.00% covered (success)
100.00%
3 / 3
CRAP
100.00% covered (success)
100.00%
1 / 1
ClientRepository
100.00% covered (success)
100.00%
12 / 12
100.00% covered (success)
100.00%
3 / 3
8
100.00% covered (success)
100.00%
1 / 1
 __construct
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 getClientEntity
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
2
 validateClient
100.00% covered (success)
100.00%
7 / 7
100.00% covered (success)
100.00%
1 / 1
5
1<?php
2
3/**
4 * OAuth2 client repository implementation.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) The National Library of Finland 2022.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2,
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 *
23 * @category VuFind
24 * @package  OAuth2
25 * @author   Ere Maijala <ere.maijala@helsinki.fi>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org Main Site
28 */
29
30namespace VuFind\OAuth2\Repository;
31
32use League\OAuth2\Server\Repositories\ClientRepositoryInterface;
33use VuFind\OAuth2\Entity\ClientEntity;
34
35/**
36 * OAuth2 client repository implementation.
37 *
38 * @category VuFind
39 * @package  OAuth2
40 * @author   Ere Maijala <ere.maijala@helsinki.fi>
41 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
42 * @link     https://vufind.org Main Site
43 */
44class ClientRepository implements ClientRepositoryInterface
45{
46    /**
47     * OAuth2 server configuration
48     *
49     * @var array
50     */
51    protected $oauth2Config = [];
52
53    /**
54     * Constructor
55     *
56     * @param array $config OAuth2 configuration
57     */
58    public function __construct(array $config)
59    {
60        $this->oauth2Config = $config;
61    }
62
63    /**
64     * Get a client.
65     *
66     * @param string $clientIdentifier The client's identifier
67     *
68     * @return ClientEntityInterface|null
69     */
70    public function getClientEntity($clientIdentifier)
71    {
72        if (!($config = $this->oauth2Config['Clients'][$clientIdentifier] ?? null)) {
73            return null;
74        }
75        $config['identifier'] = $clientIdentifier;
76        return new ClientEntity($config);
77    }
78
79    /**
80     * Validate a client's secret.
81     *
82     * @param string      $clientIdentifier The client's identifier
83     * @param null|string $clientSecret     The client's secret (if sent)
84     * @param null|string $grantType        The type of grant the client is using (if
85     * sent)
86     *
87     * @return bool
88     */
89    public function validateClient($clientIdentifier, $clientSecret, $grantType)
90    {
91        if (!($config = $this->oauth2Config['Clients'][$clientIdentifier] ?? null)) {
92            return false;
93        }
94
95        if (
96            ($config['isConfidential'] ?? false)
97            && (empty($config['secret'])
98            || !password_verify($clientSecret ?? '', $config['secret']))
99        ) {
100            return false;
101        }
102
103        return true;
104    }
105}