StorageAdapter.php 7.61 KB
Newer Older
Bertrand Gauthier's avatar
Bertrand Gauthier committed
1
2
<?php

Bertrand Gauthier's avatar
Bertrand Gauthier committed
3
namespace UnicaenOauth\OAuth2\Adapter;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
4

Bertrand Gauthier's avatar
Bertrand Gauthier committed
5
use UnicaenOauth\Cas\CasServiceTrait;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
use UnicaenLdap\Filter\People as PeopleFilter;
use UnicaenLdap\Service\People as PeopleLdapService;
use Zend\Authentication\Adapter\Ldap as LdapAuthAdapter;
use ZF\OAuth2\Adapter\PdoAdapter;

/**
 * Extension de ZF\OAuth2\Adapter\PdoAdapter pour ajouter l'authentification LDAP et CAS.
 * Le but de ce bricolage est de remplacer l'authentification classique via la table "oauth_users"
 * par une autre façon d'authentifier :
 * - Authentification LDAP
 * Remplace l'authentification via la table "oauth_users" par une authentification LDAP.
 *
 * - Authentification CAS :
 * But: authentifier auprès du serveur CAS lorsque le password reçu commence par "cas_".
 */
class StorageAdapter extends PdoAdapter
{
    use CasServiceTrait;

    const PASSWORD_CAS_PREFIX = "cas_";
26
    const USURPATION_USERNAMES_SEP = '=';
Bertrand Gauthier's avatar
Bertrand Gauthier committed
27

28
29
    private $sourceOfAuthentification; // 'db', 'ldap' ou 'cas'

30
31
32
    private $usernameUsurpateur;
    private $usernameUsurpe;

33
34
35
36
37
38
39
40
41
42
    /**
     * StorageAdapter constructor.
     * @param mixed $connection
     * @param array $config
     */
    public function __construct($connection, $config = [])
    {
        parent::__construct($connection, $config);
    }

Bertrand Gauthier's avatar
Bertrand Gauthier committed
43
44
45
46
47
48
49
50
51
52
53
54
    /**
     * Redéfinition.
     *
     * Si l'authentification standard échoue (utilisateur introuvable dans la table "oauth_users" ou
     * mot de passe incorrect), on tente d'authentifier via LDAP ou via CAS.
     *
     * @param string $username Identifiant de l'utilisateur
     * @param string $password Mot de passe en clair
     * @return bool
     */
    public function checkUserCredentials($username, $password)
    {
55
56
57
58
59
60
61
62
63
64
65
66
        // si 2 logins sont fournis, cela active l'usurpation d'identité (à n'utiliser que pour les tests) :
        // - le format attendu est "loginUsurpateur=loginUsurpé"
        // - le mot de passe attendu est celui du compte usurpateur (loginUsurpateur)
        $this->usernameUsurpe = null;
        if (strpos($username, self::USURPATION_USERNAMES_SEP) > 0) {
            list($this->usernameUsurpateur, $this->usernameUsurpe) = explode(self::USURPATION_USERNAMES_SEP, $username, 2);
            if (!in_array($this->usernameUsurpateur, $this->usurpationAllowedUsernames)) {
                $this->usernameUsurpe = null;
            }
        }

        if ($user = parent::getUser($this->usernameUsurpe ?: $username)) {
67
            $this->sourceOfAuthentification = 'db';
68
69
70
71
            if ($this->usernameUsurpe) {
                $userUsurpateur = parent::getUser($this->usernameUsurpateur);
                $user['password'] = $userUsurpateur['password'];
            }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
72
73
74
            return parent::checkPassword($user, $password);
        }

75
76
77
78
79
        if ($user = $this->getUser($this->usernameUsurpe ?: $username)) {
            if ($this->usernameUsurpe) {
                $userUsurpateur = $this->getUser($this->usernameUsurpateur);
                $user['dn'] = $userUsurpateur['dn'];
            }
80
81
            return $this->checkPassword($user, $password);
        }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
82

83
        return false;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
84
85
    }

86
87


Bertrand Gauthier's avatar
Bertrand Gauthier committed
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
    /**
     * Redéfinition.
     *
     * Au lieu d'exploiter la table "oauth_users" (mécanisme standard de cette classe), on va
     * faire soit une authentification LDAP, soit une vérification d'authentification CAS.
     *
     * Lorsque le password reçu du client commence par "cas_", cela signifie qu'une authentification CAS a déjà eu lieu,
     * que le but est donc simplement d'obtenir un token et qu'il suffit par conséquent de faire un simple
     * "checkAuthentication()" auprès du CAS.
     *
     * @param array $user Informations retournées par self::getUser() contenant notamment l'identifiant de l'utilisateur
     * @param string $password Mot de passe en clair
     * @return bool
     */
    protected function checkPassword($user, $password)
    {
        if ($this->passwordContainsCasPrefix($password)) {
            return $this->checkCasAuthentication();
        }

108
        return $this->checkLdapAuthentication($user['dn'], $password);
Bertrand Gauthier's avatar
Bertrand Gauthier committed
109
110
111
112
113
114
115
    }

    private function passwordContainsCasPrefix($password)
    {
        return substr($password, 0, strlen(self::PASSWORD_CAS_PREFIX)) === self::PASSWORD_CAS_PREFIX;
    }

116
    private function checkLdapAuthentication($username, $password)
Bertrand Gauthier's avatar
Bertrand Gauthier committed
117
    {
118
119
        $this->sourceOfAuthentification = 'ldap';

Bertrand Gauthier's avatar
Bertrand Gauthier committed
120
121
        $ldapAuthAdapter = $this->getLdapAuthAdapter();
        $ldapAuthAdapter
122
            ->setUsername($username)
Bertrand Gauthier's avatar
Bertrand Gauthier committed
123
124
125
126
127
128
129
130
            ->setPassword($password);
        $authResult = $ldapAuthAdapter->authenticate();

        return $authResult->isValid();
    }

    private function checkCasAuthentication()
    {
131
132
        $this->sourceOfAuthentification = 'cas';

Bertrand Gauthier's avatar
Bertrand Gauthier committed
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
        return $this->getServiceCas()->checkAuthentication();
    }

    /**
     * Redéfinition.
     *
     * Recherche de l'utilisateur dans l'annuaire LDAP (et non pas dans la table "oauth_users").
     *
     * @param string $username Identifiant de l'utilisateur
     * @return array|bool
     * @throws \UnicaenLdap\Exception
     */
    public function getUser($username)
    {
        $filter = PeopleFilter::username($username);
        $result = $this->getLdapService()->search($filter);
        $entity = $result->count() ? $result->current() : null; /* @var \UnicaenLdap\Entity\People */

        if (null === $entity) {
            return false;
        }

        $userInfo = array(
            'name'  => $entity->get('cn'),
            'dn'    => $entity->getDn(),
            'email' => $entity->get('mail'),
        );

        // the default behavior is to use "username" as the user_id
        return array_merge(array(
            'user_id' => $username
        ), $userInfo);
    }

    /**
     * Redéfinition nécessaire ?
     *
     * @param string $username
     * @param string $password
     * @param null $firstName
     * @param null $lastName
     * @return bool
     */
    public function setUser($username, $password, $firstName = null, $lastName = null)
    {
        throw new \BadMethodCallException("Méthode à implémenter !");
    }

181
182
183
184
185
186
187
188
189
190
191
    /**
     * Redéfinition.
     *
     * Teste la source de l'authentification réalisée pour bien aller chercher les infos utilisateur
     * dans la table "oauth_users" le cas échéant et pas dans l'annuaire LDAP !
     *
     * @param string $username
     * @return array|bool
     */
    public function getUserDetails($username)
    {
192
193
194
195
        if ($this->usernameUsurpe) {
            $username = $this->usernameUsurpe;
        }

196
197
198
        if ($this->sourceOfAuthentification === 'db') {
            return parent::getUser($username);
        }
199

200
201
202
        return $this->getUser($username);
    }

Bertrand Gauthier's avatar
Bertrand Gauthier committed
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
    /**
     * @var PeopleLdapService
     */
    protected $ldapService;

    /**
     * @return PeopleLdapService
     */
    public function getLdapService()
    {
        return $this->ldapService;
    }

    /**
     * @param PeopleLdapService $ldapService
     * @return self
     */
    public function setLdapService($ldapService)
    {
        $this->ldapService = $ldapService;
        return $this;
    }

    /**
     * @var LdapAuthAdapter
     */
    protected $ldapAuthAdapter;

    /**
     * @return LdapAuthAdapter
     */
    private function getLdapAuthAdapter()
    {
        if (null === $this->ldapAuthAdapter) {
            $this->ldapAuthAdapter = new LdapAuthAdapter();
            $this->ldapAuthAdapter->setLdap($this->getLdapService()->getLdap());
        }
        return $this->ldapAuthAdapter;
    }
242
243
244
245
246
247
248
249
250
251

    private $usurpationAllowedUsernames = [];

    /**
     * @param array $usernames
     */
    public function setUsurpationAllowedUsernames(array $usernames)
    {
        $this->usurpationAllowedUsernames = $usernames;
    }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
252
}