-
Notifications
You must be signed in to change notification settings - Fork 16
/
OidcAuthenticator.php
146 lines (122 loc) · 5.46 KB
/
OidcAuthenticator.php
1
2
3
4
5
6
7
8
9
10
11
12
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<?php
/**
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; under version 2
* of the License (non-upgradable).
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Copyright (c) 2020 (original work) Open Assessment Technologies S.A.
*/
declare(strict_types=1);
namespace OAT\Library\Lti1p3Core\Security\Oidc;
use OAT\Library\Lti1p3Core\Exception\LtiException;
use OAT\Library\Lti1p3Core\Exception\LtiExceptionInterface;
use OAT\Library\Lti1p3Core\Message\LtiMessage;
use OAT\Library\Lti1p3Core\Message\LtiMessageInterface;
use OAT\Library\Lti1p3Core\Message\Payload\Builder\MessagePayloadBuilder;
use OAT\Library\Lti1p3Core\Message\Payload\Builder\MessagePayloadBuilderInterface;
use OAT\Library\Lti1p3Core\Message\Payload\LtiMessagePayloadInterface;
use OAT\Library\Lti1p3Core\Registration\RegistrationRepositoryInterface;
use OAT\Library\Lti1p3Core\Security\Jwt\Parser\Parser;
use OAT\Library\Lti1p3Core\Security\Jwt\Parser\ParserInterface;
use OAT\Library\Lti1p3Core\Security\Jwt\Validator\Validator;
use OAT\Library\Lti1p3Core\Security\Jwt\Validator\ValidatorInterface;
use OAT\Library\Lti1p3Core\Security\User\UserAuthenticatorInterface;
use Psr\Http\Message\ServerRequestInterface;
use Throwable;
/**
* @see https://www.imsglobal.org/spec/security/v1p0/#step-3-authentication-response
*/
class OidcAuthenticator
{
/** @var RegistrationRepositoryInterface */
private $repository;
/** @var UserAuthenticatorInterface */
private $authenticator;
/** @var MessagePayloadBuilderInterface */
private $builder;
/** @var ValidatorInterface */
private $validator;
/** @var ParserInterface */
private $parser;
public function __construct(
RegistrationRepositoryInterface $repository,
UserAuthenticatorInterface $authenticator,
?MessagePayloadBuilderInterface $builder = null,
?ValidatorInterface $validator = null,
?ParserInterface $parser = null
) {
$this->repository = $repository;
$this->authenticator = $authenticator;
$this->builder = $builder ?? new MessagePayloadBuilder();
$this->validator = $validator ?? new Validator();
$this->parser = $parser ?? new Parser();
}
/**
* @throws LtiExceptionInterface
*/
public function authenticate(ServerRequestInterface $request): LtiMessageInterface
{
try {
$oidcRequest = LtiMessage::fromServerRequest($request);
$originalToken = $this->parser->parse($oidcRequest->getParameters()->get('lti_message_hint'));
$registration = $this->repository->find(
$originalToken->getClaims()->getMandatory(LtiMessagePayloadInterface::CLAIM_REGISTRATION_ID)
);
if (null === $registration) {
throw new LtiException('Invalid message hint registration id claim');
}
if (!$this->validator->validate($originalToken, $registration->getPlatformKeyChain()->getPublicKey())) {
throw new LtiException('Invalid message hint');
}
$authenticationResult = $this->authenticator->authenticate(
$registration,
$oidcRequest->getParameters()->getMandatory('login_hint')
);
if (!$authenticationResult->isSuccess()) {
throw new LtiException('User authentication failure');
}
$this->builder
->withClaims($this->sanitizeClaims($originalToken->getClaims()->all()))
->withClaim(LtiMessagePayloadInterface::CLAIM_ISS, $registration->getPlatform()->getAudience())
->withClaim(LtiMessagePayloadInterface::CLAIM_AUD, $registration->getClientId());
if (!$authenticationResult->isAnonymous()) {
foreach ($authenticationResult->getUserIdentity()->normalize() as $claimName => $claimValue) {
$this->builder->withClaim($claimName, $claimValue);
}
}
$payload = $this->builder->buildMessagePayload($registration->getPlatformKeyChain());
return new LtiMessage(
$originalToken->getClaims()->getMandatory(LtiMessagePayloadInterface::CLAIM_LTI_TARGET_LINK_URI),
[
'id_token' => $payload->getToken()->toString(),
'state' => $oidcRequest->getParameters()->getMandatory('state')
]
);
} catch (LtiExceptionInterface $exception) {
throw $exception;
} catch (Throwable $exception) {
throw new LtiException(
sprintf('OIDC authentication failed: %s', $exception->getMessage()),
$exception->getCode(),
$exception
);
}
}
private function sanitizeClaims(array $claims): array
{
foreach (LtiMessagePayloadInterface::RESERVED_USER_CLAIMS as $reservedClaim) {
unset($claims[$reservedClaim]);
}
return $claims;
}
}