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

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

/**
 * CAS authentication adpater
 *
 * @author Bertrand GAUTHIER <bertrand.gauthier@unicaen.fr>
 */
Bertrand Gauthier's avatar
Bertrand Gauthier committed
24
class Cas extends AbstractAdapter implements ServiceManagerAwareInterface, EventManagerAwareInterface
Bertrand Gauthier's avatar
Bertrand Gauthier committed
25
{
Bertrand Gauthier's avatar
Bertrand Gauthier committed
26
27
28
29
30
31
32
33
34
    /**
     * @var ServiceManager
     */
    protected $serviceManager;

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

Bertrand Gauthier's avatar
Bertrand Gauthier committed
36
37
38
39
    /**
     * @var ModuleOptions
     */
    protected $options;
40
41
42
43
44
45
46
47
48
49

    /**
     * @var array
     */
    protected $casOptions;

    /**
     * @var phpCAS
     */
    protected $casClient;
50

Bertrand Gauthier's avatar
Bertrand Gauthier committed
51
    /**
52
     * Réalise l'authentification.
53
     *
Bertrand Gauthier's avatar
Bertrand Gauthier committed
54
55
56
57
58
59
60
     * @param AuthEvent $e
     * @return boolean
     * @throws UnexpectedValueException
     * @see ChainableAdapter
     */
    public function authenticate(AuthEvent $e)
    {
61
62
63
64
65
66
67
68
//        if ($e->getIdentity()) {
//            return;
//        }
	/* DS : modification liée à une boucle infinie lors de l'authentification CAS */
	if ($this->isSatisfied()) {
            $storage = $this->getStorage()->read();
            $e->setIdentity($storage['identity'])
                    ->setCode(AuthenticationResult::SUCCESS)
69
                    ->setMessages(['Authentication successful.']);
70
71
            return;
        }
72

Bertrand Gauthier's avatar
Bertrand Gauthier committed
73
74
75
76
        $config = $this->getOptions()->getCas();
        if (!$config) {
            return; // NB: l'authentification CAS est désactivée ssi le tableau des options est vide
        }
77

Bertrand Gauthier's avatar
Bertrand Gauthier committed
78
79
        error_reporting($oldErrorReporting = error_reporting() & ~E_NOTICE);

80
        $this->getCasClient()->forceAuthentication();
Bertrand Gauthier's avatar
Bertrand Gauthier committed
81
82
83
84

        // at this step, the user has been authenticated by the CAS server
        // and the user's login name can be read with phpCAS::getUser().

85
        $identity = $this->getCasClient(false)->getUser();
86

Bertrand Gauthier's avatar
Bertrand Gauthier committed
87
        error_reporting($oldErrorReporting);
88

Bertrand Gauthier's avatar
Bertrand Gauthier committed
89
90
91
92
93
94
        $e->setIdentity($identity);
        $this->setSatisfied(true);
        $storage = $this->getStorage()->read();
        $storage['identity'] = $e->getIdentity();
        $this->getStorage()->write($storage);
        $e->setCode(AuthenticationResult::SUCCESS)
95
96
          ->setMessages(['Authentication successful.']);

Bertrand Gauthier's avatar
Bertrand Gauthier committed
97
98
        $this->getEventManager()->trigger('userAuthenticated', $e);
    }
99

100
    /**
101
     *
102
103
104
105
106
107
108
109
     * @param AuthEvent $e
     * @see ChainableAdapter
     */
    public function logout(AuthEvent $e)
    {
        if (!$this->getOptions()->getCas()) {
            return; // NB: l'authentification CAS est désactivée ssi le tableau des options est vide
        }
110

111
112
113
114
        if ($this->getCasClient()->isAuthenticated()) {
            $router = $this->getServiceManager()->get('router'); /* @var $router TreeRouteStack */
            $returnUrl = $router->getRequestUri()->setPath($router->getBaseUrl())->toString();
            $this->getCasClient(false)->logoutWithRedirectService($returnUrl);
115
116
        }
    }
117

118
    /**
119
     * Retourne le client CAS.
120
     *
121
122
123
     * @param boolean $initClient
     * @return phpCAS
     * @throws Exception
124
     */
125
    public function getCasClient($initClient = true)
126
    {
127
128
        if (null === $this->casClient) {
            $this->casClient = new phpCAS();
129
        }
130

131
132
133
        if (!$initClient) {
            return $this->casClient;
        }
134

135
136
137
138
139
140
141
        if (null === $this->casOptions) {
            $config = $this->getOptions()->getCas();
            if (!isset($config['connection']['default']['params']) || !$config['connection']['default']['params']) {
                throw new Exception("Les paramètres de connexion au serveur CAS sont invalides.");
            }
            $this->casOptions = $config['connection']['default']['params'];
        }
142

143
        $options = $this->casOptions;
144

145
        if (array_key_exists('debug', $options) && (bool) $options['debug']) {
146
            $this->casClient->setDebug();
147
        }
148

149
        // initialize phpCAS
150
        $this->casClient->client($options['version'], $options['hostname'], $options['port'], $options['uri'], true);
151
        // no SSL validation for the CAS server
152
        $this->casClient->setNoCasServerValidation();
153

154
155
        return $this->casClient;
    }
156

157
158
    /**
     * Spécifie le client CAS.
159
     *
160
161
162
163
164
165
166
     * @param phpCAS $casClient
     * @return self
     */
    public function setCasClient(phpCAS $casClient)
    {
        $this->casClient = $casClient;
        return $this;
167
    }
168

Bertrand Gauthier's avatar
Bertrand Gauthier committed
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
    /**
     * @param ModuleOptions $options
     */
    public function setOptions(ModuleOptions $options)
    {
        $this->options = $options;
    }

    /**
     * @return ModuleOptions
     */
    public function getOptions()
    {
        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;
    }

    /**
     * Get service manager
     *
     * @return ServiceManager
     */
    public function getServiceManager()
    {
        return $this->serviceManager;
    }

    /**
     * Set service manager
     *
     * @param ServiceManager $serviceManager
205
     * @return self
Bertrand Gauthier's avatar
Bertrand Gauthier committed
206
207
208
209
210
211
     */
    public function setServiceManager(ServiceManager $serviceManager)
    {
        $this->serviceManager = $serviceManager;
        return $this;
    }
212

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

Bertrand Gauthier's avatar
Bertrand Gauthier committed
223
224
225
226
    /**
     * Inject an EventManager instance
     *
     * @param  EventManagerInterface $eventManager
227
     * @return self
Bertrand Gauthier's avatar
Bertrand Gauthier committed
228
229
230
231
232
233
     */
    public function setEventManager(EventManagerInterface $eventManager)
    {
        $this->eventManager = $eventManager;
        return $this;
    }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277

    /**
     * @param TreeRouteStack $router
     */
    public function reconfigureRoutesForCasAuth(TreeRouteStack $router)
    {
        $router->addRoutes([
            // remplace les routes existantes (cf. config du module)
            'zfcuser' => [
                'type'          => 'Literal',
                'priority'      => 1000,
                'options'       => [
                    'route'    => '/auth',
                    'defaults' => [
                        'controller' => 'zfcuser',
                        'action'     => 'index',
                    ],
                ],
                'may_terminate' => true,
                'child_routes'  => [
                    'login'  => [
                        'type'    => 'Literal',
                        'options' => [
                            'route'    => '/connexion',
                            'defaults' => [
                                'controller' => 'zfcuser',
                                'action'     => 'authenticate', // zappe l'action 'login'
                            ],
                        ],
                    ],
                    'logout' => [
                        'type'    => 'Literal',
                        'options' => [
                            'route'    => '/deconnexion',
                            'defaults' => [
                                'controller' => 'zfcuser',
                                'action'     => 'logout',
                            ],
                        ],
                    ],
                ],
            ],
        ]);
    }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
278
}