Skip to content

A local-first personal finance app

[AI] Restrict secrets API access to admins in OpenID mode (#7862)

Matiss Janis Aboltins3494f78c9459
diff --git a/packages/sync-server/src/app-secrets.js b/packages/sync-server/src/app-secrets.js
index 7c36ad7d63..dc9b45551c 100644
--- a/packages/sync-server/src/app-secrets.js
+++ b/packages/sync-server/src/app-secrets.js
@@ -1,7 +1,7 @@
import express from 'express';
-import { getAccountDb, isAdmin } from './account-db';
-import { secretsService } from './services/secrets-service';
+import { getActiveLoginMethod, isAdmin } from './account-db';
+import { SecretName, secretsService } from './services/secrets-service';
import {
requestLoggerMiddleware,
validateSessionMiddleware,
@@ -14,35 +14,32 @@ app.use(express.json());
app.use(requestLoggerMiddleware);
app.use(validateSessionMiddleware);
+// In OpenID mode the secrets store is admin-managed; non-admins must be
+// blocked from both reads and writes, otherwise they can enumerate which
+// integrations are configured.
+function canManageSecrets(userId) {
+ return getActiveLoginMethod() !== 'openid' || isAdmin(userId);
+}
+
app.post('/', async (req, res) => {
- let method;
- try {
- const result = getAccountDb().first(
- 'SELECT method FROM auth WHERE active = 1',
- );
- method = result?.method;
- } catch (error) {
- console.error('Failed to fetch auth method:', error);
- return res.status(500).send({
+ if (!canManageSecrets(res.locals.user_id)) {
+ res.status(403).send({
status: 'error',
- reason: 'database-error',
- details: 'Failed to validate authentication method',
+ reason: 'not-admin',
+ details: 'You have to be admin to set secrets',
});
+ return;
}
- const { name, value } = req.body || {};
- if (method === 'openid') {
- const canSaveSecrets = isAdmin(res.locals.user_id);
-
- if (!canSaveSecrets) {
- res.status(403).send({
- status: 'error',
- reason: 'not-admin',
- details: 'You have to be admin to set secrets',
- });
+ const { name, value } = req.body || {};
- return;
- }
+ if (!(name in SecretName)) {
+ res.status(400).send({
+ status: 'error',
+ reason: 'invalid-secret-name',
+ details: 'Unknown secret name',
+ });
+ return;
}
secretsService.set(name, value);
@@ -51,9 +48,22 @@ app.post('/', async (req, res) => {
});
app.get('/:name', async (req, res) => {
+ if (!canManageSecrets(res.locals.user_id)) {
+ res.status(403).send({
+ status: 'error',
+ reason: 'not-admin',
+ details: 'You have to be admin to read secrets',
+ });
+ return;
+ }
+
const name = req.params.name;
- const keyExists = secretsService.exists(name);
- if (keyExists) {
+ if (!(name in SecretName)) {
+ res.status(404).send('key not found');
+ return;
+ }
+
+ if (secretsService.exists(name)) {
res.sendStatus(204);
} else {
res.status(404).send('key not found');
diff --git a/packages/sync-server/src/secrets.test.js b/packages/sync-server/src/secrets.test.js
index 8d580de6ff..4197381f90 100644
--- a/packages/sync-server/src/secrets.test.js
+++ b/packages/sync-server/src/secrets.test.js
@@ -1,9 +1,19 @@
import request from 'supertest';
+import { getAccountDb } from './account-db';
import { handlers as app } from './app-secrets';
-import { secretsService } from './services/secrets-service';
+import { SecretName, secretsService } from './services/secrets-service';
+
+const enableOpenIdAuth = () => {
+ const db = getAccountDb();
+ db.mutate('DELETE FROM auth');
+ db.mutate(
+ "INSERT INTO auth (method, active, extra_data, display_name) VALUES ('openid', 1, '', 'OpenID')",
+ );
+};
+
describe('secretsService', () => {
- const testSecretName = 'testSecret';
+ const testSecretName = SecretName.simplefin_token;
const testSecretValue = 'testValue';
it('should set a secret', () => {
@@ -38,6 +48,10 @@ describe('secretsService', () => {
});
describe('secrets api', () => {
+ afterEach(() => {
+ getAccountDb().mutate('DELETE FROM auth');
+ });
+
it('returns 401 if the user is not authenticated', async () => {
secretsService.set(testSecretName, testSecretValue);
const res = await request(app).get(`/${testSecretName}`);
@@ -52,7 +66,15 @@ describe('secretsService', () => {
it('returns 404 if secret does not exist', async () => {
const res = await request(app)
- .get(`/thiskeydoesnotexist`)
+ .get(`/${SecretName.gocardless_secretKey}`)
+ .set('x-actual-token', 'valid-token');
+
+ expect(res.statusCode).toEqual(404);
+ });
+
+ it('returns 404 for unknown secret names without revealing existence', async () => {
+ const res = await request(app)
+ .get('/thiskeydoesnotexist')
.set('x-actual-token', 'valid-token');
expect(res.statusCode).toEqual(404);
@@ -68,7 +90,6 @@ describe('secretsService', () => {
});
it('returns 200 if secret was set', async () => {
- secretsService.set(testSecretName, testSecretValue);
const res = await request(app)
.post(`/`)
.set('x-actual-token', 'valid-token')
@@ -79,5 +100,71 @@ describe('secretsService', () => {
status: 'ok',
});
});
+
+ it('POST returns 400 for unknown secret names', async () => {
+ const res = await request(app)
+ .post('/')
+ .set('x-actual-token', 'valid-token')
+ .send({ name: 'thiskeydoesnotexist', value: 'whatever' });
+
+ expect(res.statusCode).toEqual(400);
+ expect(res.body).toEqual({
+ status: 'error',
+ reason: 'invalid-secret-name',
+ details: 'Unknown secret name',
+ });
+ });
+
+ describe('when OpenID is the active auth method', () => {
+ beforeEach(() => {
+ enableOpenIdAuth();
+ secretsService.set(testSecretName, testSecretValue);
+ });
+
+ it('GET returns 403 for non-admin users', async () => {
+ const res = await request(app)
+ .get(`/${testSecretName}`)
+ .set('x-actual-token', 'valid-token-user');
+
+ expect(res.statusCode).toEqual(403);
+ expect(res.body).toEqual({
+ status: 'error',
+ reason: 'not-admin',
+ details: 'You have to be admin to read secrets',
+ });
+ });
+
+ it('GET returns 204 for admin users when secret exists', async () => {
+ const res = await request(app)
+ .get(`/${testSecretName}`)
+ .set('x-actual-token', 'valid-token-admin');
+
+ expect(res.statusCode).toEqual(204);
+ });
+
+ it('POST returns 403 for non-admin users', async () => {
+ const res = await request(app)
+ .post('/')
+ .set('x-actual-token', 'valid-token-user')
+ .send({ name: testSecretName, value: testSecretValue });
+
+ expect(res.statusCode).toEqual(403);
+ expect(res.body).toEqual({
+ status: 'error',
+ reason: 'not-admin',
+ details: 'You have to be admin to set secrets',
+ });
+ });
+
+ it('POST returns 200 for admin users', async () => {
+ const res = await request(app)
+ .post('/')
+ .set('x-actual-token', 'valid-token-admin')
+ .send({ name: testSecretName, value: 'newValue' });
+
+ expect(res.statusCode).toEqual(200);
+ expect(res.body).toEqual({ status: 'ok' });
+ });
+ });
});
});
diff --git a/upcoming-release-notes/7862.md b/upcoming-release-notes/7862.md
new file mode 100644
index 0000000000..2c22fcb8f7
--- /dev/null
+++ b/upcoming-release-notes/7862.md
@@ -0,0 +1,6 @@
+---
+category: Bugfixes
+authors: [MatissJanis]
+---
+
+Restrict the sync-server secrets API to admins in OpenID mode so non-admin users can no longer enumerate configured bank-sync integrations.