Skip to content

Make admin config values lazy, make client id and secret sensitive #164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marcelklehr merged 3 commits into from
Jan 7, 2026
Merged

Make admin config values lazy, make client id and secret sensitive #164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9056f2f
enh: make admin config values lazy, make client id and secret sensitive
julien-nc Dec 30, 2025
e941b38
fix: avoid using Php 8.5 in psalm action, not supported by psalm for now
julien-nc Dec 30, 2025
c101b0f
fix: disable ensureOverrideAttribute in psalm config
julien-nc Dec 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion appinfo/info.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<summary>Integration of Zammad user support/ticketing solution</summary>
<description><![CDATA[Zammad integration provides a dashboard widget displaying your important notifications,
a search provider for tickets and notifications for new open tickets.]]></description>
<version>3.1.0</version>
<version>3.2.0</version>
<licence>agpl</licence>
<author>Julien Veyssier</author>
<namespace>Zammad</namespace>
Expand Down
19 changes: 9 additions & 10 deletions lib/Controller/ConfigController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
use OCP\AppFramework\Http\Attribute\PasswordConfirmationRequired;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\Http\RedirectResponse;
use OCP\IAppConfig;
use OCP\IConfig;
use OCP\IL10N;
use OCP\IRequest;
Expand All @@ -37,6 +38,7 @@ public function __construct(
string $appName,
IRequest $request,
private IConfig $config,
private IAppConfig $appConfig,
private IURLGenerator $urlGenerator,
private IL10N $l,
private ICrypto $crypto,
Expand Down Expand Up @@ -120,7 +122,7 @@ public function setAdminConfig(array $values): DataResponse {
if (in_array($key, ['client_id', 'client_secret', 'oauth_instance_url'], true)) {
return new DataResponse([], Http::STATUS_BAD_REQUEST);
}
$this->config->setAppValue(Application::APP_ID, $key, $value);
$this->appConfig->setValueString(Application::APP_ID, $key, $value, lazy: true);
}
return new DataResponse([]);
}
Expand All @@ -135,10 +137,9 @@ public function setAdminConfig(array $values): DataResponse {
public function setSensitiveAdminConfig(array $values): DataResponse {
foreach ($values as $key => $value) {
if (in_array($key, ['client_id', 'client_secret'], true) && $value !== '') {
$encryptedValue = $this->crypto->encrypt($value);
$this->config->setAppValue(Application::APP_ID, $key, $encryptedValue);
$this->appConfig->setValueString(Application::APP_ID, $key, $value, lazy: true, sensitive: true);
} else {
$this->config->setAppValue(Application::APP_ID, $key, $value);
$this->appConfig->setValueString(Application::APP_ID, $key, $value, lazy: true);
}
}
return new DataResponse([]);
Expand All @@ -156,15 +157,13 @@ public function setSensitiveAdminConfig(array $values): DataResponse {
#[NoCSRFRequired]
public function oauthRedirect(string $code = '', string $state = ''): RedirectResponse {
$configState = $this->config->getUserValue($this->userId, Application::APP_ID, 'oauth_state');
$clientID = $this->config->getAppValue(Application::APP_ID, 'client_id');
$clientID = $clientID === '' ? '' : $this->crypto->decrypt($clientID);
$clientSecret = $this->config->getAppValue(Application::APP_ID, 'client_secret');
$clientSecret = $clientSecret === '' ? '' : $this->crypto->decrypt($clientSecret);
$clientID = $this->appConfig->getValueString(Application::APP_ID, 'client_id', lazy: true);
$clientSecret = $this->appConfig->getValueString(Application::APP_ID, 'client_secret', lazy: true);

// anyway, reset state
$this->config->setUserValue($this->userId, Application::APP_ID, 'oauth_state', '');

$adminZammadOauthUrl = $this->config->getAppValue(Application::APP_ID, 'oauth_instance_url');
$adminZammadOauthUrl = $this->appConfig->getValueString(Application::APP_ID, 'oauth_instance_url', lazy: true);

if ($clientID && $clientSecret && $configState !== '' && $configState === $state) {
$redirect_uri = $this->config->getUserValue($this->userId, Application::APP_ID, 'redirect_uri');
Expand Down Expand Up @@ -211,7 +210,7 @@ public function oauthRedirect(string $code = '', string $state = ''): RedirectRe
* @throws PreConditionNotMetException
*/
private function storeUserInfo(): array {
$adminZammadOauthUrl = $this->config->getAppValue(Application::APP_ID, 'oauth_instance_url');
$adminZammadOauthUrl = $this->appConfig->getValueString(Application::APP_ID, 'oauth_instance_url', lazy: true);
$zammadUrl = $this->config->getUserValue($this->userId, Application::APP_ID, 'url') ?: $adminZammadOauthUrl;

if (!$zammadUrl || !preg_match('/^(https?:\/\/)?[^.]+\.[^.].*/', $zammadUrl)) {
Expand Down
48 changes: 48 additions & 0 deletions lib/Migration/Version030200Date20251230225956.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<?php

declare(strict_types=1);

/**
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCA\Zammad\Migration;

use Closure;
use OCA\Zammad\AppInfo\Application;
use OCP\IAppConfig;
use OCP\Migration\IOutput;
use OCP\Migration\SimpleMigrationStep;
use OCP\Security\ICrypto;

class Version030200Date20251230225956 extends SimpleMigrationStep {

public function __construct(
private ICrypto $crypto,
private IAppConfig $appConfig,
) {
}

/**
* @param IOutput $output
* @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
* @param array $options
*/
public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options) {
// store client_id and client_secret again as lazy and sensitive
foreach (['client_id', 'client_secret'] as $key) {
$value = $this->appConfig->getValueString(Application::APP_ID, $key);
if ($value !== '') {
$decryptedValue = $this->crypto->decrypt($value);
$this->appConfig->setValueString(Application::APP_ID, $key, $decryptedValue, lazy: true, sensitive: true);
}
}

foreach (['oauth_instance_url', 'link_preview_enabled'] as $key) {
$value = $this->appConfig->getValueString(Application::APP_ID, $key);
if ($value !== '') {
$this->appConfig->setValueString(Application::APP_ID, $key, $value, lazy: true);
}
}
}
}
8 changes: 5 additions & 3 deletions lib/Reference/ZammadReferenceProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
use OCP\Collaboration\Reference\IReferenceManager;
use OCP\Collaboration\Reference\ISearchableReferenceProvider;
use OCP\Collaboration\Reference\Reference;
use OCP\IAppConfig;
use OCP\IConfig;
use OCP\IL10N;
use OCP\IURLGenerator;
Expand All @@ -41,6 +42,7 @@ class ZammadReferenceProvider extends ADiscoverableReferenceProvider implements
public function __construct(
private ZammadAPIService $zammadAPIService,
private IConfig $config,
private IAppConfig $appConfig,
private IReferenceManager $referenceManager,
private IURLGenerator $urlGenerator,
private IL10N $l10n,
Expand Down Expand Up @@ -108,12 +110,12 @@ public function matchReference(string $referenceText): bool {
return false;
}
}
$adminLinkPreviewEnabled = $this->config->getAppValue(Application::APP_ID, 'link_preview_enabled', '1') === '1';
$adminLinkPreviewEnabled = $this->appConfig->getValueString(Application::APP_ID, 'link_preview_enabled', '1', lazy: true) === '1';
if (!$adminLinkPreviewEnabled) {
return false;
}

$adminZammadOauthUrl = $this->config->getAppValue(Application::APP_ID, 'oauth_instance_url');
$adminZammadOauthUrl = $this->appConfig->getValueString(Application::APP_ID, 'oauth_instance_url', lazy: true);
$zammadUrl = $this->config->getUserValue($this->userId, Application::APP_ID, 'url') ?: $adminZammadOauthUrl;

return $this->isMatching($referenceText, $zammadUrl);
Expand All @@ -123,7 +125,7 @@ public function matchReference(string $referenceText): bool {
* @inheritDoc
*/
public function resolveReference(string $referenceText): ?IReference {
$adminZammadOauthUrl = $this->config->getAppValue(Application::APP_ID, 'oauth_instance_url');
$adminZammadOauthUrl = $this->appConfig->getValueString(Application::APP_ID, 'oauth_instance_url', lazy: true);
$zammadUrl = $this->config->getUserValue($this->userId, Application::APP_ID, 'url') ?: $adminZammadOauthUrl;
if ($zammadUrl !== '') {
$parts = $this->getLinkParts($zammadUrl, $referenceText);
Expand Down
4 changes: 3 additions & 1 deletion lib/Search/ZammadSearchProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
use OCA\Zammad\AppInfo\Application;
use OCA\Zammad\Service\ZammadAPIService;
use OCP\App\IAppManager;
use OCP\IAppConfig;
use OCP\IConfig;
use OCP\IDateTimeFormatter;
use OCP\IL10N;
Expand All @@ -43,6 +44,7 @@ public function __construct(
private IAppManager $appManager,
private IL10N $l10n,
private IConfig $config,
private IAppConfig $appConfig,
private IURLGenerator $urlGenerator,
private IDateTimeFormatter $dateTimeFormatter,
private ZammadAPIService $service,
Expand Down Expand Up @@ -93,7 +95,7 @@ public function search(IUser $user, ISearchQuery $query): SearchResult {
? $this->urlGenerator->imagePath(Application::APP_ID, 'app.svg')
: $this->urlGenerator->imagePath(Application::APP_ID, 'app-dark.svg');

$adminZammadOauthUrl = $this->config->getAppValue(Application::APP_ID, 'oauth_instance_url');
$adminZammadOauthUrl = $this->appConfig->getValueString(Application::APP_ID, 'oauth_instance_url', lazy: true);
$zammadUrl = $this->config->getUserValue($user->getUID(), Application::APP_ID, 'url') ?: $adminZammadOauthUrl;
$hasAccessToken = $this->config->getUserValue($user->getUID(), Application::APP_ID, 'token') !== '';

Expand Down
12 changes: 6 additions & 6 deletions lib/Service/ZammadAPIService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
use OCP\AppFramework\Http;
use OCP\Http\Client\IClient;
use OCP\Http\Client\IClientService;
use OCP\IAppConfig;
use OCP\ICache;
use OCP\ICacheFactory;
use OCP\IConfig;
Expand All @@ -45,6 +46,7 @@ public function __construct(
private LoggerInterface $logger,
private IL10N $l10n,
private IConfig $config,
private IAppConfig $appConfig,
private INotificationManager $notificationManager,
private ICrypto $crypto,
ICacheFactory $cacheFactory,
Expand All @@ -55,7 +57,7 @@ public function __construct(
}

public function getZammadUrl(string $userId): string {
$adminZammadOauthUrl = $this->config->getAppValue(Application::APP_ID, 'oauth_instance_url');
$adminZammadOauthUrl = $this->appConfig->getValueString(Application::APP_ID, 'oauth_instance_url', lazy: true);
return $this->config->getUserValue($userId, Application::APP_ID, 'url') ?: $adminZammadOauthUrl;
}

Expand Down Expand Up @@ -537,13 +539,11 @@ private function checkTokenExpiration(string $userId): void {
}

private function refreshToken(string $userId): bool {
$clientID = $this->config->getAppValue(Application::APP_ID, 'client_id');
$clientID = $clientID === '' ? '' : $this->crypto->decrypt($clientID);
$clientSecret = $this->config->getAppValue(Application::APP_ID, 'client_secret');
$clientSecret = $clientSecret === '' ? '' : $this->crypto->decrypt($clientSecret);
$clientID = $this->appConfig->getValueString(Application::APP_ID, 'client_id', lazy: true);
$clientSecret = $this->appConfig->getValueString(Application::APP_ID, 'client_secret', lazy: true);
$refreshToken = $this->config->getUserValue($userId, Application::APP_ID, 'refresh_token');
$refreshToken = $refreshToken === '' ? '' : $this->crypto->decrypt($refreshToken);
$adminZammadOauthUrl = $this->config->getAppValue(Application::APP_ID, 'oauth_instance_url');
$adminZammadOauthUrl = $this->appConfig->getValueString(Application::APP_ID, 'oauth_instance_url', lazy: true);
if (!$refreshToken) {
$this->logger->error('No Zammad refresh token found', ['app' => Application::APP_ID]);
return false;
Expand Down
16 changes: 6 additions & 10 deletions lib/Settings/Admin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,27 @@
use OCA\Zammad\AppInfo\Application;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\AppFramework\Services\IInitialState;
use OCP\IConfig;
use OCP\IAppConfig;

use OCP\Security\ICrypto;
use OCP\Settings\ISettings;

class Admin implements ISettings {

public function __construct(
private IConfig $config,
private IAppConfig $appConfig,
private IInitialState $initialStateService,
private ICrypto $crypto,
) {
}

/**
* @return TemplateResponse
*/
public function getForm(): TemplateResponse {
$clientID = $this->config->getAppValue(Application::APP_ID, 'client_id');
$clientID = $clientID === '' ? '' : $this->crypto->decrypt($clientID);
$clientSecret = $this->config->getAppValue(Application::APP_ID, 'client_secret');
$clientSecret = $clientSecret === '' ? '' : $this->crypto->decrypt($clientSecret);
$clientID = $this->appConfig->getValueString(Application::APP_ID, 'client_id', lazy: true);
$clientSecret = $this->appConfig->getValueString(Application::APP_ID, 'client_secret', lazy: true);

$oauthUrl = $this->config->getAppValue(Application::APP_ID, 'oauth_instance_url');
$adminLinkPreviewEnabled = $this->config->getAppValue(Application::APP_ID, 'link_preview_enabled', '1') === '1';
$oauthUrl = $this->appConfig->getValueString(Application::APP_ID, 'oauth_instance_url', lazy: true);
$adminLinkPreviewEnabled = $this->appConfig->getValueString(Application::APP_ID, 'link_preview_enabled', '1', lazy: true) === '1';

$adminConfig = [
'client_id' => $clientID,
Expand Down
10 changes: 5 additions & 5 deletions lib/Settings/Personal.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
use OCA\Zammad\AppInfo\Application;
use OCP\AppFramework\Http\TemplateResponse;
use OCP\AppFramework\Services\IInitialState;
use OCP\IAppConfig;
use OCP\IConfig;

use OCP\Security\ICrypto;
Expand All @@ -14,6 +15,7 @@ class Personal implements ISettings {

public function __construct(
private IConfig $config,
private IAppConfig $appConfig,
private IInitialState $initialStateService,
private ICrypto $crypto,
private ?string $userId,
Expand All @@ -25,11 +27,9 @@ public function __construct(
*/
public function getForm(): TemplateResponse {
// for OAuth
$clientID = $this->config->getAppValue(Application::APP_ID, 'client_id');
$clientID = $clientID === '' ? '' : $this->crypto->decrypt($clientID);
$clientSecret = $this->config->getAppValue(Application::APP_ID, 'client_secret');
$clientSecret = $clientSecret === '' ? '' : $this->crypto->decrypt($clientSecret);
$adminOauthUrl = $this->config->getAppValue(Application::APP_ID, 'oauth_instance_url');
$clientID = $this->appConfig->getValueString(Application::APP_ID, 'client_id', lazy: true);
$clientSecret = $this->appConfig->getValueString(Application::APP_ID, 'client_secret', lazy: true);
$adminOauthUrl = $this->appConfig->getValueString(Application::APP_ID, 'oauth_instance_url', lazy: true);

$token = $this->config->getUserValue($this->userId, Application::APP_ID, 'token');
$token = $token === '' ? '' : $this->crypto->decrypt($token);
Expand Down