Ldap.php 6.58 KB
Newer Older
Bertrand Gauthier's avatar
Bertrand Gauthier committed
1
2
3
<?php
namespace UnicaenAuth\Authentication\Adapter;

Bertrand Gauthier's avatar
Bertrand Gauthier committed
4
use UnicaenAuth\Options\ModuleOptions;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
5
6
use Zend\Authentication\Exception\UnexpectedValueException;
use Zend\Authentication\Result as AuthenticationResult;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
7
8
9
10
use Zend\Authentication\Adapter\Ldap as LdapAuthAdapter;
use Zend\EventManager\EventManager;
use Zend\EventManager\EventManagerAwareInterface;
use Zend\EventManager\EventManagerInterface;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
11
12
use Zend\ServiceManager\ServiceManager;
use Zend\ServiceManager\ServiceManagerAwareInterface;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
13
14
15
use ZfcUser\Authentication\Adapter\AbstractAdapter;
use ZfcUser\Authentication\Adapter\AdapterChainEvent as AuthEvent;
use ZfcUser\Authentication\Adapter\ChainableAdapter;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
16
17
18
19
20
21
22
23

/**
 * LDAP authentication adpater
 *
 * @author Bertrand GAUTHIER <bertrand.gauthier@unicaen.fr>
 */
class Ldap extends AbstractAdapter implements ServiceManagerAwareInterface, EventManagerAwareInterface
{
24
    const USURPATION_USERNAMES_SEP = '=';
25

Bertrand Gauthier's avatar
Bertrand Gauthier committed
26
27
28
29
30
31
    /**
     * @var ServiceManager
     */
    protected $serviceManager;

    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
32
     * @var EventManager
Bertrand Gauthier's avatar
Bertrand Gauthier committed
33
34
     */
    protected $eventManager;
35

Bertrand Gauthier's avatar
Bertrand Gauthier committed
36
    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
37
     * @var LdapAuthAdapter
Bertrand Gauthier's avatar
Bertrand Gauthier committed
38
     */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
39
    protected $ldapAuthAdapter;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
40
41

    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
42
     * @var ModuleOptions
Bertrand Gauthier's avatar
Bertrand Gauthier committed
43
     */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
44
    protected $options;
45

46
    /**
47
     * @var string
48
49
     */
    protected $usernameUsurpe;
50

Bertrand Gauthier's avatar
Bertrand Gauthier committed
51
    /**
52
     *
Bertrand Gauthier's avatar
Bertrand Gauthier committed
53
54
55
56
57
58
59
60
61
62
63
     * @param AuthEvent $e
     * @return boolean
     * @throws UnexpectedValueException
     * @see ChainableAdapter
     */
    public function authenticate(AuthEvent $e)
    {
        if ($this->isSatisfied()) {
            $storage = $this->getStorage()->read();
            $e->setIdentity($storage['identity'])
                    ->setCode(AuthenticationResult::SUCCESS)
64
                    ->setMessages(['Authentication successful.']);
Bertrand Gauthier's avatar
Bertrand Gauthier committed
65
66
67
            return;
        }

Bertrand Gauthier's avatar
Bertrand Gauthier committed
68
        $username   = $e->getRequest()->getPost()->get('identity');
Bertrand Gauthier's avatar
Bertrand Gauthier committed
69
70
        $credential = $e->getRequest()->getPost()->get('credential');

71
        $success = $this->authenticateUsername($username, $credential);
72

Bertrand Gauthier's avatar
Bertrand Gauthier committed
73
        // Failure!
74
        if (! $success) {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
75
            $e->setCode(AuthenticationResult::FAILURE)
76
              ->setMessages(['LDAP bind failed.']);
Bertrand Gauthier's avatar
Bertrand Gauthier committed
77
78
79
            $this->setSatisfied(false);
            return false;
        }
80

81
        $e->setIdentity($this->usernameUsurpe ?: $username);
Bertrand Gauthier's avatar
Bertrand Gauthier committed
82
83
84
85
86
        $this->setSatisfied(true);
        $storage = $this->getStorage()->read();
        $storage['identity'] = $e->getIdentity();
        $this->getStorage()->write($storage);
        $e->setCode(AuthenticationResult::SUCCESS)
87
88
          ->setMessages(['Authentication successful.']);

Bertrand Gauthier's avatar
Bertrand Gauthier committed
89
90
91
        $this->getEventManager()->trigger('userAuthenticated', $e);
    }

92
93
    /**
     * Authentifie l'identifiant et le mot de passe spécifiés.
94
     *
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
     * @param string $username Identifiant de connexion
     * @param string $credential Mot de passe
     * @return boolean
     */
    public function authenticateUsername($username, $credential)
    {
        // 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($username, $this->usernameUsurpe) = explode(self::USURPATION_USERNAMES_SEP, $username, 2);
            if (!in_array($username, $this->getOptions()->getUsurpationAllowedUsernames())) {
                $this->usernameUsurpe = null;
            }
        }

        // LDAP auth
        $result  = $this->getLdapAuthAdapter()->setUsername($username)->setPassword($credential)->authenticate();
        $success = $result->isValid();
115

116
117
        // verif existence du login usurpé
        if ($this->usernameUsurpe) {
118
            // s'il nexiste pas, échec de l'authentification
119
120
            if (!$this->getLdapAuthAdapter()->getLdap()->searchEntries("(supannAliasLogin=$this->usernameUsurpe)")) {
                $this->usernameUsurpe = null;
121
                $success              = false;
122
123
            }
        }
124

125
126
        return $success;
    }
127

Bertrand Gauthier's avatar
Bertrand Gauthier committed
128
    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
129
     * @param ModuleOptions $options
Bertrand Gauthier's avatar
Bertrand Gauthier committed
130
     */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
131
    public function setOptions(ModuleOptions $options)
Bertrand Gauthier's avatar
Bertrand Gauthier committed
132
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
133
        $this->options = $options;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
134
135
136
    }

    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
137
     * @return ModuleOptions
Bertrand Gauthier's avatar
Bertrand Gauthier committed
138
     */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
139
    public function getOptions()
Bertrand Gauthier's avatar
Bertrand Gauthier committed
140
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
141
142
143
144
145
146
147
        if (!$this->options instanceof ModuleOptions) {
            $options = array_merge(
                    $this->getServiceManager()->get('zfcuser_module_options')->toArray(),
                    $this->getServiceManager()->get('unicaen-auth_module_options')->toArray());
            $this->setOptions(new ModuleOptions($options));
        }
        return $this->options;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
148
    }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
149

Bertrand Gauthier's avatar
Bertrand Gauthier committed
150
    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
151
     * @return \UnicaenApp\Options\ModuleOptions
Bertrand Gauthier's avatar
Bertrand Gauthier committed
152
     */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
153
    public function getAppModuleOptions()
Bertrand Gauthier's avatar
Bertrand Gauthier committed
154
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
155
        return $this->getServiceManager()->get('unicaen-app_module_options');
Bertrand Gauthier's avatar
Bertrand Gauthier committed
156
157
158
159
    }

    /**
     * get ldap connection adapter
160
     *
Bertrand Gauthier's avatar
Bertrand Gauthier committed
161
     * @return LdapAuthAdapter
Bertrand Gauthier's avatar
Bertrand Gauthier committed
162
     */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
163
    public function getLdapAuthAdapter()
Bertrand Gauthier's avatar
Bertrand Gauthier committed
164
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
165
        if (null === $this->ldapAuthAdapter) {
166
            $options = [];
Bertrand Gauthier's avatar
Bertrand Gauthier committed
167
168
169
170
171
172
            if (($config = $this->getAppModuleOptions()->getLdap())) {
                foreach ($config['connection'] as $name => $connection) {
                    $options[$name] = $connection['params'];
                }
            }
            $this->ldapAuthAdapter = new LdapAuthAdapter($options); // NB: array(array)
Bertrand Gauthier's avatar
Bertrand Gauthier committed
173
        }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
174
        return $this->ldapAuthAdapter;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
175
176
177
178
    }

    /**
     * set ldap connection adapter
179
     *
Bertrand Gauthier's avatar
Bertrand Gauthier committed
180
     * @param LdapAuthAdapter $authAdapter
Bertrand Gauthier's avatar
Bertrand Gauthier committed
181
182
     * @return Ldap
     */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
183
    public function setLdapAuthAdapter(LdapAuthAdapter $authAdapter)
Bertrand Gauthier's avatar
Bertrand Gauthier committed
184
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
185
        $this->ldapAuthAdapter = $authAdapter;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
186
187
188
189
        return $this;
    }

    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
190
191
192
     * Get service manager
     *
     * @return ServiceManager
Bertrand Gauthier's avatar
Bertrand Gauthier committed
193
     */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
194
    public function getServiceManager()
Bertrand Gauthier's avatar
Bertrand Gauthier committed
195
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
196
        return $this->serviceManager;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
197
198
199
    }

    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
200
201
202
203
     * Set service manager
     *
     * @param ServiceManager $serviceManager
     * @return Ldap
Bertrand Gauthier's avatar
Bertrand Gauthier committed
204
     */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
205
    public function setServiceManager(ServiceManager $serviceManager)
Bertrand Gauthier's avatar
Bertrand Gauthier committed
206
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
207
208
        $this->serviceManager = $serviceManager;
        return $this;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
209
    }
210

Bertrand Gauthier's avatar
Bertrand Gauthier committed
211
    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
212
213
214
     * Retrieve EventManager instance
     *
     * @return EventManagerInterface
Bertrand Gauthier's avatar
Bertrand Gauthier committed
215
     */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
216
    public function getEventManager()
Bertrand Gauthier's avatar
Bertrand Gauthier committed
217
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
218
        return $this->eventManager;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
219
    }
220

Bertrand Gauthier's avatar
Bertrand Gauthier committed
221
    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
222
223
224
225
     * Inject an EventManager instance
     *
     * @param  EventManagerInterface $eventManager
     * @return Ldap
Bertrand Gauthier's avatar
Bertrand Gauthier committed
226
     */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
227
    public function setEventManager(EventManagerInterface $eventManager)
Bertrand Gauthier's avatar
Bertrand Gauthier committed
228
    {
Bertrand Gauthier's avatar
Bertrand Gauthier committed
229
230
        $this->eventManager = $eventManager;
        return $this;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
231
232
    }
}