Skip to content

Commit 5dd1c6b

Browse files
tsdicloudtsdicloud
committed
Merge #4 Add event based provisioning
2 parents 6e51457 + 0057237 commit 5dd1c6b

6 files changed

Lines changed: 496 additions & 4 deletions

File tree

‎lib/Controller/LoginController.php‎

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@
3636
use OCA\UserOIDC\Service\DiscoveryService;
3737
use OCA\UserOIDC\Service\LdapService;
3838
use OCA\UserOIDC\Service\ProviderService;
39+
use OCA\UserOIDC\Service\EventProvisioningService;
40+
use OCA\UserOIDC\Service\ProvisioningDeniedException;
3941
use OCA\UserOIDC\Service\ProvisioningService;
4042
use OCA\UserOIDC\Vendor\Firebase\JWT\JWT;
4143
use OCA\UserOIDC\AppInfo\Application;
@@ -118,6 +120,9 @@ class LoginController extends BaseOidcController {
118120
/** @var SessionMapper */
119121
private $sessionMapper;
120122

123+
/** @var EventProvisioningService */
124+
private $eventProvisioningService;
125+
121126
/** @var ProvisioningService */
122127
private $provisioningService;
123128

@@ -145,6 +150,7 @@ public function __construct(
145150
IConfig $config,
146151
IProvider $authTokenProvider,
147152
SessionMapper $sessionMapper,
153+
EventProvisioningService $eventProvisioningService,
148154
ProvisioningService $provisioningService,
149155
IL10N $l10n,
150156
ILogger $logger,
@@ -168,6 +174,7 @@ public function __construct(
168174
$this->ldapService = $ldapService;
169175
$this->authTokenProvider = $authTokenProvider;
170176
$this->sessionMapper = $sessionMapper;
177+
$this->eventProvisioningService = $eventProvisioningService;
171178
$this->provisioningService = $provisioningService;
172179
$this->request = $request;
173180
$this->l10n = $l10n;
@@ -471,10 +478,29 @@ public function code(string $state = '', string $code = '', string $scope = '',
471478
}
472479

473480
$oidcSystemConfig = $this->config->getSystemValue('user_oidc', []);
481+
$eventProvisionAllowed = (!isset($oidcSystemConfig['event_provision']) || $oidcSystemConfig['event_provision']);
474482
$autoProvisionAllowed = (!isset($oidcSystemConfig['auto_provision']) || $oidcSystemConfig['auto_provision']);
475483

476484
// Provisioning
477-
if ($autoProvisionAllowed) {
485+
if ($eventProvisionAllowed) {
486+
// for the moment, make event provisioning another (prio) config option
487+
// TODO: (proposal) refactor all provisioning strategies into event handlers
488+
try {
489+
$user = $this->eventProvisioningService->provisionUser($userId, $providerId, $idTokenPayload);
490+
} catch (ProvisioningDeniedException $denied) {
491+
$redirectUrl = $denied->getRedirectUrl();
492+
if ($redirectUrl === null) {
493+
$message = $this->l10n->t('Failed to provision the user');
494+
return $this->build403TemplateResponse($message, Http::STATUS_BAD_REQUEST, ['reason' => $denied->getMessage()]);
495+
} else {
496+
// error response is a redirect, e.g. to a booking site
497+
// so that you can immediately get the registration page
498+
return new RedirectResponse($redirectUrl);
499+
}
500+
} catch (\Exception $e) {
501+
$user = null;
502+
}
503+
} elseif ($autoProvisionAllowed) {
478504
$user = $this->provisioningService->provisionUser($userId, $providerId, $idTokenPayload);
479505
} else {
480506
// in case user is provisioned by user_ldap, userManager->search() triggers an ldap search which syncs the results
@@ -563,7 +589,8 @@ public function singleLogoutService() {
563589
$endSessionEndpoint .= '&client_id=' . $provider->getClientId();
564590
$shouldSendIdToken = $this->providerService->getSetting(
565591
$provider->getId(),
566-
ProviderService::SETTING_SEND_ID_TOKEN_HINT, '0'
592+
ProviderService::SETTING_SEND_ID_TOKEN_HINT,
593+
'0'
567594
) === '1';
568595
$idToken = $this->session->get(self::ID_TOKEN);
569596
if ($shouldSendIdToken && $idToken) {
@@ -712,8 +739,12 @@ public function backChannelLogout(string $providerIdentifier, string $logout_tok
712739
* @param bool|null $throttle
713740
* @return JSONResponse
714741
*/
715-
private function getBackchannelLogoutErrorResponse(string $error, string $description,
716-
array $throttleMetadata = [], ?bool $throttle = null): JSONResponse {
742+
private function getBackchannelLogoutErrorResponse(
743+
string $error,
744+
string $description,
745+
array $throttleMetadata = [],
746+
?bool $throttle = null
747+
): JSONResponse {
717748
$this->logger->debug('Backchannel logout error. ' . $error . ' ; ' . $description);
718749
$response = new JSONResponse(
719750
[

‎lib/Event/UserAccountChangeEvent.php‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
<?php
2+
/*
3+
* @copyright Copyright (c) 2023 T-Systems International
4+
*
5+
* @author B. Rederlechner <bernd.rederlechner@t-systems.com>
6+
*
7+
* @license GNU AGPL version 3 or any later version
8+
*
9+
*/
10+
11+
declare(strict_types=1);
12+
13+
namespace OCA\UserOIDC\Event;
14+
15+
use OCP\EventDispatcher\Event;
16+
17+
/**
18+
* Event to provide custom mapping logic based on the OIDC token data
19+
* In order to avoid further processing the event propagation should be stopped
20+
* in the listener after processing as the value might get overwritten afterwards
21+
* by other listeners through $event->stopPropagation();
22+
*/
23+
class UserAccountChangeEvent extends Event {
24+
private $uid;
25+
private $displayname;
26+
private $mainEmail;
27+
private $quota;
28+
private $claims;
29+
private $result;
30+
31+
32+
public function __construct(string $uid, ?string $displayname, ?string $mainEmail, ?string $quota, object $claims, bool $accessAllowed = false) {
33+
parent::__construct();
34+
$this->uid = $uid;
35+
$this->displayname = $displayname;
36+
$this->mainEmail = $mainEmail;
37+
$this->quota = $quota;
38+
$this->claims = $claims;
39+
$this->result = new UserAccountChangeResult($accessAllowed, 'default');
40+
}
41+
42+
/**
43+
* @return get event username (uid)
44+
*/
45+
public function getUid(): string {
46+
return $this->uid;
47+
}
48+
49+
/**
50+
* @return get event displayname
51+
*/
52+
public function getDisplayName(): ?string {
53+
return $this->displayname;
54+
}
55+
56+
/**
57+
* @return get event main email
58+
*/
59+
public function getMainEmail(): ?string {
60+
return $this->mainEmail;
61+
}
62+
63+
/**
64+
* @return get event quota
65+
*/
66+
public function getQuota(): ?string {
67+
return $this->quota;
68+
}
69+
70+
/**
71+
* @return array the array of claim values associated with the event
72+
*/
73+
public function getClaims(): object {
74+
return $this->claims;
75+
}
76+
77+
/**
78+
* @return value for the logged in user attribute
79+
*/
80+
public function getResult(): UserAccountChangeResult {
81+
return $this->result;
82+
}
83+
84+
public function setResult(bool $accessAllowed, string $reason = '', ?string $redirectUrl = null) : void {
85+
$this->result = new UserAccountChangeResult($accessAllowed, $reason, $redirectUrl);
86+
}
87+
}

‎lib/Event/UserAccountChangeResult.php‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<?php
2+
/*
3+
* @copyright Copyright (c) 2023 T-Systems International
4+
*
5+
* @author B. Rederlechner <bernd.rederlechner@t-systems.com>
6+
*
7+
* @license GNU AGPL version 3 or any later version
8+
*
9+
*/
10+
11+
declare(strict_types=1);
12+
13+
namespace OCA\UserOIDC\Event;
14+
15+
/**
16+
* Event to provide custom mapping logic based on the OIDC token data
17+
* In order to avoid further processing the event propagation should be stopped
18+
* in the listener after processing as the value might get overwritten afterwards
19+
* by other listeners through $event->stopPropagation();
20+
*/
21+
class UserAccountChangeResult {
22+
23+
/** @var bool */
24+
private $accessAllowed;
25+
/** @var string */
26+
private $reason;
27+
/** @var string */
28+
private $redirectUrl;
29+
30+
public function __construct(bool $accessAllowed, string $reason = '', ?string $redirectUrl = null) {
31+
$this->accessAllowed = $accessAllowed;
32+
$this->redirectUrl = $redirectUrl;
33+
$this->reason = $reason;
34+
}
35+
36+
/**
37+
* @return value for the logged in user attribute
38+
*/
39+
public function isAccessAllowed(): bool {
40+
return $this->accessAllowed;
41+
}
42+
43+
public function setAccessAllowed(bool $accessAllowed): void {
44+
$this->accessAllowed = $accessAllowed;
45+
}
46+
47+
/**
48+
* @return get optional alternate redirect address
49+
*/
50+
public function getRedirectUrl(): ?string {
51+
return $this->redirectUrl;
52+
}
53+
54+
/**
55+
* @return set optional alternate redirect address
56+
*/
57+
public function setRedirectUrl(?string $redirectUrl): void {
58+
$this->redirectUrl = $redirectUrl;
59+
}
60+
61+
/**
62+
* @return get decision reason
63+
*/
64+
public function getReason(): string {
65+
return $this->reason;
66+
}
67+
68+
/**
69+
* @return set decision reason
70+
*/
71+
public function setReason(string $reason): void {
72+
$this->reason = $reason;
73+
}
74+
}

‎lib/Service/ProvisioningDeniedException.php‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
/**
6+
* @copyright Copyright (c) 2023, T-Systems International
7+
*
8+
* @author B. Rederlechner <bernd.rederlechner@t-Systems.com>
9+
*
10+
* @license AGPL-3.0
11+
*
12+
* This code is free software: you can redistribute it and/or modify
13+
* it under the terms of the GNU Affero General Public License, version 3,
14+
* as published by the Free Software Foundation.
15+
*
16+
* This program is distributed in the hope that it will be useful,
17+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
18+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19+
* GNU Affero General Public License for more details.
20+
*
21+
* You should have received a copy of the GNU Affero General Public License, version 3,
22+
* along with this program. If not, see <http://www.gnu.org/licenses/>
23+
*
24+
*/
25+
26+
namespace OCP;
27+
28+
/**
29+
* Exception if the precondition of the config update method isn't met
30+
* @since 1.4.0
31+
*/
32+
class ProvisioningDeniedException extends \Exception {
33+
private $redirectUrl;
34+
35+
/**
36+
* Exception constructor including an option redirect url.
37+
*
38+
* @param string $message The error message. It will be not revealed to the
39+
* the user (unless the hint is empty) and thus
40+
* should be not translated.
41+
* @param string $hint A useful message that is presented to the end
42+
* user. It should be translated, but must not
43+
* contain sensitive data.
44+
* @param int $code Set default to 403 (Forbidden)
45+
* @param \Exception|null $previous
46+
*/
47+
public function __construct(string $message, ?string $redirectUrl = null, int $code = 403, \Exception $previous = null) {
48+
parent::__construct($message, $code, $previous);
49+
$this->redirectUrl = $redirectUrl;
50+
}
51+
52+
/**
53+
* Read optional failure redirect if available
54+
* @return string|null
55+
*/
56+
public function getRedirectUrl(): ?string {
57+
return $this->redirectUrl;
58+
}
59+
60+
/**
61+
* Include redirect in string serialisation.
62+
*
63+
* @return string
64+
*/
65+
public function __toString(): string {
66+
$redirect = $this->redirectUrl ?? '<no redirect>';
67+
return __CLASS__ . ": [{$this->code}]: {$this->message} ({$redirect})\n";
68+
}
69+
}

0 commit comments

Comments
 (0)