Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

feat(api-keys): added format check for api tokens to avoid unnecessary db call (#514)

Corentin Thomasset097b6bf2b706
diff --git a/apps/papra-server/src/modules/api-keys/api-keys.constants.ts b/apps/papra-server/src/modules/api-keys/api-keys.constants.ts
index 3aa1a0b1..824a5508 100644
--- a/apps/papra-server/src/modules/api-keys/api-keys.constants.ts
+++ b/apps/papra-server/src/modules/api-keys/api-keys.constants.ts
@@ -5,6 +5,7 @@ export const API_KEY_ID_REGEX = createPrefixedIdRegex({ prefix: API_KEY_ID_PREFI
export const API_KEY_PREFIX = 'ppapi';
export const API_KEY_TOKEN_LENGTH = 64;
+export const API_KEY_TOKEN_REGEX = new RegExp(`^${API_KEY_PREFIX}_[A-Za-z0-9]{${API_KEY_TOKEN_LENGTH}}$`);
export const API_KEY_PERMISSIONS = {
ORGANIZATIONS: {
diff --git a/apps/papra-server/src/modules/api-keys/api-keys.middlewares.ts b/apps/papra-server/src/modules/api-keys/api-keys.middlewares.ts
index a621c0c3..9de91a2c 100644
--- a/apps/papra-server/src/modules/api-keys/api-keys.middlewares.ts
+++ b/apps/papra-server/src/modules/api-keys/api-keys.middlewares.ts
@@ -4,6 +4,7 @@ import { createMiddleware } from 'hono/factory';
import { createUnauthorizedError } from '../app/auth/auth.errors';
import { getAuthorizationHeader } from '../shared/headers/headers.models';
import { isNil } from '../shared/utils';
+import { looksLikeAnApiKey } from './api-keys.models';
import { createApiKeysRepository } from './api-keys.repository';
import { getApiKey } from './api-keys.usecases';
@@ -31,8 +32,7 @@ export function createApiKeyMiddleware({ db }: { db: Database }) {
throw createUnauthorizedError();
}
- if (isNil(token)) {
- // For type safety
+ if (!looksLikeAnApiKey(token)) {
throw createUnauthorizedError();
}
diff --git a/apps/papra-server/src/modules/api-keys/api-keys.models.test.ts b/apps/papra-server/src/modules/api-keys/api-keys.models.test.ts
index c6958c31..3c3cedd3 100644
--- a/apps/papra-server/src/modules/api-keys/api-keys.models.test.ts
+++ b/apps/papra-server/src/modules/api-keys/api-keys.models.test.ts
@@ -1,5 +1,6 @@
import { describe, expect, test } from 'vitest';
-import { getApiKeyUiPrefix } from './api-keys.models';
+import { getApiKeyUiPrefix, looksLikeAnApiKey } from './api-keys.models';
+import { generateApiToken } from './api-keys.services';
describe('api-keys models', () => {
describe('getApiKeyUiPrefix', () => {
@@ -11,4 +12,39 @@ describe('api-keys models', () => {
);
});
});
+
+ describe('looksLikeAnApiKey', () => {
+ test(`validate that a token looks like an api key
+ - it starts with the api key prefix
+ - it has the correct length
+ - it only contains alphanumeric characters`, () => {
+ expect(
+ looksLikeAnApiKey('ppapi_29qxv9eCbRkQQGhwrVZCEXEFjOYpXZX07G4vDK4HT03Jp7fVHyJx1b0l6e1LIEPD'),
+ ).toBe(true);
+
+ expect(
+ looksLikeAnApiKey(''),
+ ).toBe(false);
+
+ expect(
+ looksLikeAnApiKey('ppapi_'),
+ ).toBe(false);
+
+ expect(
+ looksLikeAnApiKey('ppapi_29qxv9eCbRkQQGhwrVZCEXEFjOYpXZX07G4vDK4HT03Jp7fVHyJx1b0l6e1LIEPD_extra'),
+ ).toBe(false);
+
+ expect(
+ looksLikeAnApiKey('invalidprefix_29qxv9eCbRkQQGhwrVZCEXEFjOYpXZX07G4vDK4HT03Jp7fVHyJx1b0l6e1LIEPD'),
+ ).toBe(false);
+ });
+
+ test('a freshly generated token should always look like an api key', () => {
+ const { token } = generateApiToken();
+
+ expect(
+ looksLikeAnApiKey(token),
+ ).toBe(true);
+ });
+ });
});
diff --git a/apps/papra-server/src/modules/api-keys/api-keys.models.ts b/apps/papra-server/src/modules/api-keys/api-keys.models.ts
index d37bf6d3..c3a7cee8 100644
--- a/apps/papra-server/src/modules/api-keys/api-keys.models.ts
+++ b/apps/papra-server/src/modules/api-keys/api-keys.models.ts
@@ -1,5 +1,6 @@
import { sha256 } from '../shared/crypto/hash';
-import { API_KEY_PREFIX } from './api-keys.constants';
+import { isNil } from '../shared/utils';
+import { API_KEY_PREFIX, API_KEY_TOKEN_REGEX } from './api-keys.constants';
export function getApiKeyUiPrefix({ token }: { token: string }) {
return {
@@ -12,3 +13,12 @@ export function getApiKeyHash({ token }: { token: string }) {
keyHash: sha256(token, { digest: 'base64url' }),
};
}
+
+// Positional argument as TS does not like named argument with type guards
+export function looksLikeAnApiKey(token?: string | null | undefined): token is string {
+ if (isNil(token)) {
+ return false;
+ }
+
+ return API_KEY_TOKEN_REGEX.test(token);
+}