upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-06-04 06:13:34 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 16

Merge pull request #57372 from nextcloud/feat/adapt-webhook

Browse source 
Feat(webhook_listeners): adapt webhook payload format
This commit is contained in:
Tobias Kaminsky 2026-01-06 15:55:27 +01:00 committed by GitHub
commit fdfaf6b363
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 45 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
apps/webhook_listeners/lib/BackgroundJobs/WebhookCall.php
View file

@ -46,7 +46,7 @@ class WebhookCall extends QueuedJob {
$client = $this->clientService->newClient();
// adding Ephemeral auth tokens to the call
$data['tokens'] = $this->tokenService->getTokens($webhookListener, $data['user']['uid'] ?? null);
$data['authentication'] = $this->tokenService->getTokens($webhookListener, $data['user']['uid'] ?? null);
$options = [
'verify' => $this->certificateManager->getAbsoluteBundlePath(),
'headers' => $webhookListener->getHeaders() ?? [],

54
apps/webhook_listeners/lib/Service/TokenService.php
View file

@ -14,6 +14,7 @@ use OCA\WebhookListeners\Db\EphemeralTokenMapper;
use OCA\WebhookListeners\Db\WebhookListener;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\Authentication\Token\IToken;
use OCP\IURLGenerator;
use OCP\IUserManager;
use OCP\L10N\IFactory;
use OCP\Security\ISecureRandom;
@ -22,6 +23,7 @@ use Psr\Log\LoggerInterface;
class TokenService {
public function __construct(
private IProvider $tokenProvider,
private IURLGenerator $urlGenerator,
private ISecureRandom $random,
private EphemeralTokenMapper $tokenMapper,
private LoggerInterface $logger,
@ -35,7 +37,30 @@ class TokenService {
* creates an array which includes two arrays of tokens: 'user_ids' and 'user_roles'
* The array ['user_ids' => ['jane', 'bob'], 'user_roles' => ['owner', 'trigger']]
* as requested tokens in the registered webhook produces a result like
* ['user_ids' => [['jane' => 'abcdtokenabcd1'], ['bob','=> 'abcdtokenabcd2']], 'user_roles' => ['owner' => ['admin' => 'abcdtokenabcd3'], 'trigger' => ['user1' => 'abcdtokenabcd4']]]
* [
* ['user_ids' => [
* ['jane' => [
* 'userId' => 'jane',
* 'token' => 'abcdtokenabcd1'
* 'baseUrl' => 'https://nextcloud.example'
* ],
* ['bob'=> [
* 'userId' => 'bob',
* 'token' => 'abcdtokenabcd2'
* 'baseUrl' => 'https://nextcloud.example'
* ],
* ],
* 'owner' => [
* 'userId' => 'admin',
* 'token' => 'abcdtokenabcd3'
* 'baseUrl' => 'https://nextcloud.example'
* ],
* 'trigger' => [
* 'userId' => 'user1',
* 'token' => 'abcdtokenabcd4'
* 'baseUrl' => 'https://nextcloud.example'
* ],
* ]
* Created auth tokens are valid for 1 hour.
*
* @param WebhookListener $webhookListener
@ -43,15 +68,20 @@ class TokenService {
* @return array{user_ids?:array<string,string>,user_roles?:array{owner?:array<string,string>,trigger?:array<string,string>}}
*/
public function getTokens(WebhookListener $webhookListener, ?string $triggerUserId): array {
$tokens = [
'user_ids' => [],
'user_roles' => [],
];
$tokens = [];
$tokenNeeded = $webhookListener->getTokenNeeded();
if (isset($tokenNeeded['user_ids'])) {
$tokens = [
'user_ids' => [],
];
foreach ($tokenNeeded['user_ids'] as $userId) {
try {
$tokens['user_ids'][$userId] = $this->createEphemeralToken($userId);
$tokens['user_ids'][$userId] = [
'userId' => $userId,
'token' => $this->createEphemeralToken($userId),
'baseUrl' => $this->urlGenerator->getBaseUrl()
];
} catch (\Exception $e) {
$this->logger->error('Webhook token creation for user ' . $userId . ' failed: ' . $e->getMessage(), ['exception' => $e]);
}
@ -67,8 +97,10 @@ class TokenService {
if (is_null($ownerId)) { // no owner uid available
break;
}
$tokens['user_roles']['owner'] = [
$ownerId => $this->createEphemeralToken($ownerId)
$tokens['owner'] = [
'userId' => $ownerId,
'token' => $this->createEphemeralToken($ownerId),
'baseUrl' => $this->urlGenerator->getBaseUrl()
];
break;
case 'trigger':
@ -76,8 +108,10 @@ class TokenService {
if (is_null($triggerUserId)) { // no trigger uid available
break;
}
$tokens['user_roles']['trigger'] = [
$triggerUserId => $this->createEphemeralToken($triggerUserId)
$tokens['trigger'] = [
'userId' => $triggerUserId,
'token' => $this->createEphemeralToken($triggerUserId),
'baseUrl' => $this->urlGenerator->getBaseUrl()
];
break;
default: