ShibService.php 12.1 KB
Newer Older
1
2
3
4
<?php

namespace UnicaenAuth\Service;

5
6
7
use Assert\Assertion;
use Assert\AssertionFailedException;
use UnicaenApp\Exception\LogicException;
8
9
10
use UnicaenApp\Exception\RuntimeException;
use UnicaenAuth\Entity\Shibboleth\ShibUser;
use UnicaenAuth\Options\ModuleOptions;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
11
use Zend\Mvc\Router\Http\TreeRouteStack;
12
use Zend\Session\Container;
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

/**
 * Shibboleth service
 *
 * @author Unicaen
 */
class ShibService
{
    /**
     * @var ModuleOptions
     */
    protected $options;

    /**
     * @var \UnicaenAuth\Entity\Shibboleth\ShibUser
     */
    protected $authenticatedUser;

    /**
     * @return string
     */
    static public function apacheConfigSnippet()
    {
        $text = <<<EOS
<Location "/">
    AuthType Shibboleth
    ShibRequestSetting requireSession false
    Require shibboleth
</Location>
<Location "/auth/shibboleth">
        AuthType Shibboleth
        ShibRequestSetting requireSession true
        Require shibboleth
</Location>
EOS;
        return $text;
    }

51
52
53
54
55
56
57
58
59
60
61
62
    /**
     * @return ShibUser|null
     */
    public function getAuthenticatedUser()
    {
        if (! $this->isShibbolethEnabled()) {
            return null;
        }

        if ($this->authenticatedUser === null) {
            // gestion de l'usurpation éventuelle
            $this->handleUsurpation();
63
            if (! $this->getServerArrayVariable('eppn')) {
64
65
66
67
68
69
70
71
72
                return null;
            }

            $this->authenticatedUser = $this->createShibUserFromServerArrayData();
        }

        return $this->authenticatedUser;
    }

73
74
75
    /**
     * @return boolean
     */
76
    public function isShibbolethEnabled()
77
78
79
80
81
82
    {
        $options = $this->options->getShibboleth();

        return array_key_exists('enable', $options) && (bool) $options['enable'];
    }

83
84
85
86
87
88
89
90
91
92
93
94
95
96
    /**
     * @return array
     */
    public function getShibbolethSimulate()
    {
        $options = $this->options->getShibboleth();

        if (! array_key_exists('simulate', $options) || ! is_array($options['simulate'])) {
            return [];
        }

        return $options['simulate'];
    }

97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
    /**
     * @param string $attributeName
     * @return string
     */
    public function getShibbolethAliasFor($attributeName)
    {
        $options = $this->options->getShibboleth();

        if (! array_key_exists('aliases', $options) || ! is_array($options['aliases']) || ! isset($options['aliases'][$attributeName])) {
            return null;
        }

        return $options['aliases'][$attributeName];
    }

112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
    /**
     * Retourne true si la simulation d'un utilisateur authentifié via Shibboleth est en cours.
     *
     * @return bool
     */
    public function isSimulationActive()
    {
        $options = $this->options->getShibboleth();

        if (array_key_exists('simulate', $options) && is_array($options['simulate']) && ! empty($options['simulate'])) {
            return true;
        }

        return false;
    }

128
    /**
Bertrand Gauthier's avatar
Bertrand Gauthier committed
129
     * @return ShibUser|null
130
     */
131
    public function handleSimulation()
132
    {
133
134
        if (! $this->isSimulationActive()) {
            return null;
135
136
        }

137
138
139
140
141
142
143
144
        // si nécessaire
        $this->handleUsurpation();

        $simulate = $this->getShibbolethSimulate();

        try {
            Assertion::keyIsset($simulate, 'eppn',
                "Clé 'eppn' introuvable ou sans valeur dans l'option 'unicaen-auth.shibboleth.simulate'");
145
146
            Assertion::contains($simulate['eppn'], '@',
                "L'eppn '" . $simulate['eppn'] . "' n'est pas de la forme 'id@domaine' attendue (ex: 'tartempion@unicaen.fr')");
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
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
242
243
244
245
246
247
248
249
250
251
252
253
            Assertion::eq(count(array_intersect($keys = ['supannEmpId', 'supannEtuId'], array_keys($simulate))), 1,
                "L'une ou l'autre de ces clés doit être présente dans l'option 'unicaen-auth.shibboleth.simulate': " .
                implode(', ', $keys));
        } catch (AssertionFailedException $e) {
            throw new LogicException("Configuration erronée", null, $e);
        }

        $eppn = $simulate['eppn'];
        $supannId = $simulate['supannEmpId'] ?: $simulate['supannEtuId'];
        $email = isset($simulate['email']) ? $simulate['email'] : null;

        $shibUser = new ShibUser();
        $shibUser->setEppn($eppn);
        $shibUser->setId($supannId);
        $shibUser->setDisplayName("$eppn ($supannId)");
        $shibUser->setEmail($email);
        $shibUser->setNom('Shibboleth');
        $shibUser->setPrenom('Simulation');

        $this->simulateAuthenticatedUser($shibUser);

        return $shibUser;
    }

    /**
     * Retourne true si les données stockées en session indiquent qu'une usurpation d'identité Shibboleth est en cours.
     *
     * @return bool
     */
    private function isUsurpationActive()
    {
        return $this->getSessionContainer()->offsetExists('fromShibUser');
    }

    /**
     * @param ShibUser $fromShibUser
     * @param ShibUser $toShibUser
     * @return self
     */
    public function activateUsurpation(ShibUser $fromShibUser, ShibUser $toShibUser)
    {
        // le login doit faire partie des usurpateurs autorisés
        if (! in_array($fromShibUser->getUsername(), $this->options->getUsurpationAllowedUsernames())) {
            throw new RuntimeException("Usurpation non autorisée");
        }

        $session = $this->getSessionContainer();
        $session->offsetSet('fromShibUser', $fromShibUser);
        $session->offsetSet('toShibUser', $toShibUser);

        return $this;
    }

    /**
     * Suppression des données stockées en session concernant l'usurpation d'identité Shibboleth.
     *
     * @return self
     */
    public function deactivateUsurpation()
    {
        $session = $this->getSessionContainer();
        $session->offsetUnset('fromShibUser');
        $session->offsetUnset('toShibUser');

        return $this;
    }

    /**
     * @return $this
     */
    public function handleUsurpation()
    {
        if (! $this->isUsurpationActive()) {
            return $this;
        }

        $session = $this->getSessionContainer();

        /** @var ShibUser|null $toShibUser */
        $toShibUser = $session->offsetGet('toShibUser');
        if ($toShibUser === null) {
            throw new RuntimeException("Anomalie: 'toShibUser' introuvable");
        }

        $this->simulateAuthenticatedUser($toShibUser, 'supannEmpId');

        return $this;
    }

    /**
     * @return Container
     */
    private function getSessionContainer()
    {
        return new Container(ShibService::class);
    }

    /**
     * Inscrit dans le tableau $_SERVER le nécessaire pour usurper l'identité d'un utilisateur
     * qui ce serait authentifié via Shibboleth.
     *
     * @param ShibUser $shibUser Utilisateur dont on veut usurper l'identité.
     * @param string $keyForId Clé du tableau $_SERVER dans laquelle mettre l'id de l'utilsateur spécifié.
     *                         Ex: 'supannEmpId', 'supannEtuId'.
     */
    public function simulateAuthenticatedUser(ShibUser $shibUser, $keyForId = 'supannEmpId')
    {
254
255
256
257
258
259
        $this->setServerArrayVariable('eppn', $shibUser->getEppn());
        $this->setServerArrayVariable($keyForId, $shibUser->getId());
        $this->setServerArrayVariable('displayName', $shibUser->getDisplayName());
        $this->setServerArrayVariable('mail', $shibUser->getEmail());
        $this->setServerArrayVariable('sn', $shibUser->getNom());
        $this->setServerArrayVariable('givenName', $shibUser->getPrenom());
260
261
262
263
264
    }

    /**
     * @return ShibUser
     */
265
    private function createShibUserFromServerArrayData()
266
    {
267
        $eppn = $this->getServerArrayVariable('eppn');
268

269
270
271
272
        if ($value = $this->getServerArrayVariable('supannEtuId')) {
            $id = $value;
        } elseif ($value = $this->getServerArrayVariable('supannEmpId')) {
            $id = $value;
273
        } else {
274
            throw new RuntimeException('Un au moins des attributs Shibboleth suivants doit exister dans $_SERVER : supannEtuId, supannEmpId.');
275
276
277
        }

        $mail = null;
278
279
        if ($value = $this->getServerArrayVariable('mail')) {
            $mail = $value;
280
281
282
        }

        $displayName = null;
283
284
        if ($value = $this->getServerArrayVariable('displayName')) {
            $displayName = $value;
285
286
        }

287
        $surname = null;
288
289
290
291
        if ($value = $this->getServerArrayVariable('sn')) {
            $surname = $value;
        } elseif ($value = $this->getServerArrayVariable('surname')) {
            $surname = $value;
292
293
294
        }

        $givenName = null;
295
296
        if ($value = $this->getServerArrayVariable('givenName')) {
            $givenName = $value;
297
298
299
        }

        $civilite = null;
300
301
        if ($value = $this->getServerArrayVariable('supannCivilite')) {
            $civilite = $value;
302
303
        }

304
        $shibUser = new ShibUser();
305
        // propriétés de UserInterface
306
307
308
309
        $shibUser->setId($id);
        $shibUser->setUsername($eppn);
        $shibUser->setDisplayName($displayName);
        $shibUser->setEmail($mail);
310
311
312
313
314
        $shibUser->setPassword(null);
        // autres propriétés
        $shibUser->setNom($surname);
        $shibUser->setPrenom($givenName);
        $shibUser->setCivilite($civilite);
315
316
317
318

        return $shibUser;
    }

Bertrand Gauthier's avatar
Bertrand Gauthier committed
319
320
321
322
323
324
325
326
    /**
     * Retourne l'URL de déconnexion Shibboleth.
     *
     * @param string $returnAbsoluteUrl Eventuelle URL *absolue* de retour après déconnexion
     * @return string
     */
    public function getLogoutUrl($returnAbsoluteUrl = null)
    {
327
328
329
        if ($this->getShibbolethSimulate()) {
            return '/';
        }
330
331
332
        if ($this->getAuthenticatedUser() === null) {
            return '/';
        }
333

Bertrand Gauthier's avatar
Bertrand Gauthier committed
334
335
336
337
338
339
340
341
342
        $logoutRelativeUrl = '/Shibboleth.sso/Logout?return='; // NB: '?return=' semble obligatoire!

        if ($returnAbsoluteUrl) {
            $logoutRelativeUrl .= urlencode($returnAbsoluteUrl);
        }

        return $logoutRelativeUrl;
    }

343
344
345
346
347
348
349
    /**
     * @param ModuleOptions $options
     */
    public function setOptions(ModuleOptions $options)
    {
        $this->options = $options;
    }
Bertrand Gauthier's avatar
Bertrand Gauthier committed
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394

    /**
     * @param TreeRouteStack $router
     */
    public function reconfigureRoutesForShibAuth(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', // NB: lorsque l'auth Shibboleth est activée, la page propose
                                'action'     => 'login',   //     2 possibilités d'auth : LDAP et Shibboleth.
                            ],
                        ],
                    ],
                    'logout' => [
                        'type'    => 'Segment',
                        'options' => [
                            'route'    => '/:operation/shibboleth/',
                            'defaults' => [
                                'controller' => 'UnicaenAuth\Controller\Auth',
                                'action'     => 'shibboleth',
                                'operation'  => 'deconnexion'
                            ],
                        ],
                    ],
                ],
            ],
        ]);
    }
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420

    /**
     * @param string $name
     * @param string $value
     */
    private function setServerArrayVariable($name, $value)
    {
        $key = $this->getShibbolethAliasFor($name) ?: $name;

        $_SERVER[$key] = $value;
    }

    /**
     * @param $name
     * @return string
     */
    private function getServerArrayVariable($name)
    {
        $key = $this->getShibbolethAliasFor($name) ?: $name;

        if (! array_key_exists($key, $_SERVER)) {
            return null;
        }

        return $_SERVER[$key];
    }
421
}