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

namespace UnicaenAuth\Service;

5
6
use Assert\Assertion;
use Assert\AssertionFailedException;
7
use InvalidArgumentException;
8
use UnicaenApp\Exception\LogicException;
9
10
use UnicaenApp\Exception\RuntimeException;
use UnicaenAuth\Entity\Shibboleth\ShibUser;
Bertrand Gauthier's avatar
Bertrand Gauthier committed
11
use Zend\Mvc\Router\Http\TreeRouteStack;
12
use Zend\Session\Container;
13
14

/**
15
 * Shibboleth service.
16
17
18
19
20
21
 *
 * @author Unicaen
 */
class ShibService
{
    /**
22
     * @var \UnicaenAuth\Entity\Shibboleth\ShibUser
23
     */
24
    protected $authenticatedUser;
25
26

    /**
27
     * @var array
28
     */
29
30
31
32
33
34
    protected $shibbolethConfig = [];

    /**
     * @var array
     */
    protected $usurpationAllowedUsernames = [];
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

    /**
     * @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;
    }

56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
    /**
     * @param array $shibbolethConfig
     */
    public function setShibbolethConfig(array $shibbolethConfig)
    {
        $this->shibbolethConfig = $shibbolethConfig;
    }

    /**
     * @param array $usurpationAllowedUsernames
     */
    public function setUsurpationAllowedUsernames(array $usurpationAllowedUsernames)
    {
        $this->usurpationAllowedUsernames = $usurpationAllowedUsernames;
    }

72
73
74
75
76
77
78
79
80
81
    /**
     * @return ShibUser|null
     */
    public function getAuthenticatedUser()
    {
        if (! $this->isShibbolethEnabled()) {
            return null;
        }

        if ($this->authenticatedUser === null) {
82

83
            // D'ABORD activation éventuelle de la simulation
84
            $this->handleSimulation();
85
86
            // ENSUITE activation éventuelle de l'usurpation
            $this->handleUsurpation();
87

88
89
90
91
            if (! $this->isAuthenticated()) {
                return null;
            }

92
93
94
95
96
97
            $this->authenticatedUser = $this->createShibUserFromServerArrayData();
        }

        return $this->authenticatedUser;
    }

98
99
100
101
102
103
104
105
    /**
     * @return bool
     */
    private function isAuthenticated()
    {
        return (bool) $this->getServerArrayVariable('REMOTE_USER');
    }

106
107
108
    /**
     * @return boolean
     */
109
    public function isShibbolethEnabled()
110
    {
111
        return array_key_exists('enable', $this->shibbolethConfig) && (bool) $this->shibbolethConfig['enable'];
112
113
    }

114
115
116
117
118
    /**
     * @return array
     */
    public function getShibbolethSimulate()
    {
119
        if (! array_key_exists('simulate', $this->shibbolethConfig) || ! is_array($this->shibbolethConfig['simulate'])) {
120
121
122
            return [];
        }

123
        return $this->shibbolethConfig['simulate'];
124
125
    }

126
127
128
129
    /**
     * @param string $attributeName
     * @return string
     */
130
    private function getShibbolethAliasFor($attributeName)
131
    {
132
133
134
        if (! array_key_exists('aliases', $this->shibbolethConfig) ||
            ! is_array($this->shibbolethConfig['aliases']) ||
            ! isset($this->shibbolethConfig['aliases'][$attributeName])) {
135
136
137
            return null;
        }

138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
        return $this->shibbolethConfig['aliases'][$attributeName];
    }

    /**
     * Retourne les alias des attributs spécifiés.
     * Si un attribut n'a pas d'alias, c'est l'attribut lui-même qui est retourné.
     *
     * @param array $attributeNames
     * @return array
     */
    private function getAliasedShibbolethAttributes(array $attributeNames)
    {
        $aliasedAttributes = [];
        foreach ($attributeNames as $attributeName) {
            $alias = $this->getShibbolethAliasFor($attributeName);
            $aliasedAttributes[$attributeName] = $alias ?: $attributeName;
        }

        return $aliasedAttributes;
157
158
    }

159
160
161
162
163
164
165
    /**
     * Retourne true si la simulation d'un utilisateur authentifié via Shibboleth est en cours.
     *
     * @return bool
     */
    public function isSimulationActive()
    {
166
167
168
        if (array_key_exists('simulate', $this->shibbolethConfig) &&
            is_array($this->shibbolethConfig['simulate']) &&
            ! empty($this->shibbolethConfig['simulate'])) {
169
170
171
172
173
174
            return true;
        }

        return false;
    }

175
176
177
178
179
180
181
182
183
184
185
186
187
188
    /**
     * Retourne la liste des attributs requis.
     *
     * @return array
     */
    private function getShibbolethRequiredAttributes()
    {
        if (! array_key_exists('required_attributes', $this->shibbolethConfig)) {
            return [];
        }

        return (array)$this->shibbolethConfig['required_attributes'];
    }

189
    /**
190
     *
191
     */
192
    public function handleSimulation()
193
    {
194
        if (! $this->isSimulationActive()) {
195
            return;
196
197
        }

198
        try {
199
            $shibUser = $this->createShibUserFromSimulationData();
200
201
202
203
        } catch (AssertionFailedException $e) {
            throw new LogicException("Configuration erronée", null, $e);
        }

204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
        $this->simulateAuthenticatedUser($shibUser);
    }

    /**
     * @return ShibUser
     * @throws AssertionFailedException
     */
    private function createShibUserFromSimulationData()
    {
        $data = $this->getShibbolethSimulate();

        $this->assertRequiredAttributesExistInData($data);

        $eppn = $this->getValueFromShibData('eppn', $data);
        $supannId = $this->getValueFromShibData('supannEmpId', $data) ?: $this->getValueFromShibData('supannEtuId', $data);
        $email = $this->getValueFromShibData('mail', $data);
        $displayName = $this->getValueFromShibData('displayName', $data);
        $givenName = $this->getValueFromShibData('givenName', $data);
        $surname = $this->getValueFromShibData('sn', $data);
        $civilite = $this->getValueFromShibData('supannCivilite', $data);

        Assertion::contains($eppn, '@', "L'eppn '" . $eppn . "' n'est pas de la forme 'id@domaine' attendue (ex: 'tartempion@unicaen.fr')");
226
227
228
229

        $shibUser = new ShibUser();
        $shibUser->setEppn($eppn);
        $shibUser->setId($supannId);
230
        $shibUser->setDisplayName($displayName);
231
        $shibUser->setEmail($email);
232
233
234
        $shibUser->setNom($surname);
        $shibUser->setPrenom($givenName);
        $shibUser->setCivilite($civilite);
235
236
237

        return $shibUser;
    }
238
    
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
    /**
     * 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
257
        if (! in_array($fromShibUser->getUsername(), $this->usurpationAllowedUsernames)) {
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
            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);
    }

312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
    /**
     * @param array $data
     * @return array
     */
    private function getMissingRequiredAttributesFromData(array $data)
    {
        $requiredAttributes = $this->getShibbolethRequiredAttributes();
        $missingAttributes = [];

        foreach ($requiredAttributes as $requiredAttribute) {
            // un pipe permet d'exprimer un OU logique, ex: 'supannEmpId|supannEtuId'
            $attributes = array_map('trim', explode('|', $requiredAttribute));
            // attributs aliasés
            $attributes = $this->getAliasedShibbolethAttributes($attributes);

            $found = false;
            foreach (array_map('trim', $attributes) as $attribute) {
                if (isset($data[$attribute])) {
                    $found = true;
                }
            }
            if (!$found) {
                // attributs aliasés, dont l'un au moins est manquant, mise sous forme 'a|b'
                $missingAttributes[] = implode('|', $attributes);
            }
        }

        return $missingAttributes;
    }

    /**
     * @param array $data
     * @throws InvalidArgumentException
     */
    private function assertRequiredAttributesExistInData(array $data)
    {
        $missingAttributes = $this->getMissingRequiredAttributesFromData($data);

        if (!empty($missingAttributes)) {
            throw new InvalidArgumentException(
                "Les attributs suivants sont manquants : " . implode(', ', $missingAttributes));
        }
    }

356
357
    /**
     * Inscrit dans le tableau $_SERVER le nécessaire pour usurper l'identité d'un utilisateur
358
     * qui se serait authentifié via Shibboleth.
359
360
361
362
363
364
365
     *
     * @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')
    {
366
367
368
        // 'REMOTE_USER' est utilisé pour savoir si un utilisateur est authentifié ou non
        $this->setServerArrayVariable('REMOTE_USER', $shibUser->getEppn());

369
370
371
372
373
374
375
376
//        // on s'assure que tous les attributs obligatoires ont une valeur
//        foreach ($this->getShibbolethRequiredAttributes() as $requiredAttribute) {
//            // un pipe permet d'exprimer un OU logique, ex: 'supannEmpId|supannEtuId'
//            $attributes = array_map('trim', explode('|', $requiredAttribute));
//            foreach ($attributes as $attribute) {
//                $this->setServerArrayVariable($attribute, 'qqchose');
//            }
//        }
377
378

        // pour certains attributs, on veut une valeur sensée!
379
380
381
        $this->setServerArrayVariable('eppn', $shibUser->getEppn());
        $this->setServerArrayVariable($keyForId, $shibUser->getId());
        $this->setServerArrayVariable('displayName', $shibUser->getDisplayName());
382
        $this->setServerArrayVariable('mail', $shibUser->getEppn());
383
384
        $this->setServerArrayVariable('sn', $shibUser->getNom());
        $this->setServerArrayVariable('givenName', $shibUser->getPrenom());
385
        $this->setServerArrayVariable('supannCivilite', $shibUser->getCivilite());
386
387
388
389
390
    }

    /**
     * @return ShibUser
     */
391
    private function createShibUserFromServerArrayData()
392
    {
393
394
395
396
        try {
            $this->assertRequiredAttributesExistInData($_SERVER);
        } catch (InvalidArgumentException $e) {
            throw new RuntimeException('Des attributs Shibboleth obligatoires font défaut dans $_SERVER.', null, $e);
397
398
        }

399
400
401
402
403
404
405
        $eppn = $this->getServerArrayVariable('eppn');
        $id = $this->getServerArrayVariable('supannEtuId') ?: $this->getServerArrayVariable('supannEmpId');
        $mail = $this->getServerArrayVariable('mail');
        $displayName = $this->getServerArrayVariable('displayName');
        $surname = $this->getServerArrayVariable('sn') ?: $this->getServerArrayVariable('surname');
        $givenName = $this->getServerArrayVariable('givenName');
        $civilite = $this->getServerArrayVariable('supannCivilite');
406

407
        $shibUser = new ShibUser();
408
        // propriétés de UserInterface
409
410
411
412
        $shibUser->setId($id);
        $shibUser->setUsername($eppn);
        $shibUser->setDisplayName($displayName);
        $shibUser->setEmail($mail);
413
414
415
416
417
        $shibUser->setPassword(null);
        // autres propriétés
        $shibUser->setNom($surname);
        $shibUser->setPrenom($givenName);
        $shibUser->setCivilite($civilite);
418
419
420
421

        return $shibUser;
    }

Bertrand Gauthier's avatar
Bertrand Gauthier committed
422
423
424
425
426
427
428
429
    /**
     * 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)
    {
430
431
432
        if ($this->getShibbolethSimulate()) {
            return '/';
        }
433
434
435
        if ($this->getAuthenticatedUser() === null) {
            return '/';
        }
436

Bertrand Gauthier's avatar
Bertrand Gauthier committed
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
        $logoutRelativeUrl = '/Shibboleth.sso/Logout?return='; // NB: '?return=' semble obligatoire!

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

        return $logoutRelativeUrl;
    }

    /**
     * @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' => [
470
471
                                'controller' => 'zfcuser',
                                'action'     => 'login',
Bertrand Gauthier's avatar
Bertrand Gauthier committed
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
                            ],
                        ],
                    ],
                    'logout' => [
                        'type'    => 'Segment',
                        'options' => [
                            'route'    => '/:operation/shibboleth/',
                            'defaults' => [
                                'controller' => 'UnicaenAuth\Controller\Auth',
                                'action'     => 'shibboleth',
                                'operation'  => 'deconnexion'
                            ],
                        ],
                    ],
                ],
            ],
        ]);
    }
490

491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
    /**
     * @param string $name
     * @param array  $data
     * @return string
     */
    private function getValueFromShibData($name, array $data)
    {
        $key = $this->getShibbolethAliasFor($name) ?: $name;

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

        return $data[$key];
    }

507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
    /**
     * @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];
    }
532
}