@tumbaland/backend-core 1.32.0 → 1.33.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tumbaland/backend-core",
-  "version": "1.32.0",
+  "version": "1.33.0",
   "description": "Core shared functionality for Tumbaland backend services",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/apiKeys/ApiKey.test.ts

@@ -0,0 +1,118 @@
+import { ApiKey } from './ApiKey';
+
+/** The fields the schema insists on, so each test only varies what it is about. */
+const complete = {
+  userId: 'u1',
+  userEmail: 'u1@example.com',
+  userName: 'Tester',
+  name: 'Claude Code',
+  keyId: 'abcdef123456',
+  hash: 'a'.repeat(64),
+  sealedCiphertext: 'ct',
+  sealedIv: 'iv',
+  sealedTag: 'tag'
+};
+
+describe('required fields', () => {
+  it('accepts a complete document', () => {
+    expect(new ApiKey(complete).validateSync()).toBeUndefined();
+  });
+
+  it.each([
+    'userId',
+    'userEmail',
+    'name',
+    'keyId',
+    'hash',
+    'sealedCiphertext',
+    'sealedIv',
+    'sealedTag'
+  ])('refuses a document with no %s', (field) => {
+    const doc = new ApiKey({ ...complete, [field]: undefined });
+    expect(doc.validateSync()?.errors[field]).toBeDefined();
+  });
+
+  it('will not store a key without the material needed to verify it', () => {
+    // A record missing its digest could never authenticate anything, and one
+    // missing the sealed copy could never be revealed — both are corruption,
+    // not a valid state.
+    const doc = new ApiKey({ ...complete, hash: undefined, sealedCiphertext: undefined });
+    const err = doc.validateSync();
+
+    expect(err?.errors.hash).toBeDefined();
+    expect(err?.errors.sealedCiphertext).toBeDefined();
+  });
+});
+
+describe('defaults', () => {
+  it('treats an unpinned key as personal rather than as unset', () => {
+    // `null` and "nobody set this" must not be distinguishable downstream: the
+    // middleware reads a null groupId as the owner's personal scope.
+    expect(new ApiKey(complete).groupId).toBeNull();
+  });
+
+  it('starts with no scopes, so a key grants nothing until asked', () => {
+    expect(new ApiKey(complete).scopes).toEqual([]);
+  });
+
+  it('starts the reveal counter at zero', () => {
+    expect(new ApiKey(complete).revealCount).toBe(0);
+  });
+
+  it('leaves the lifecycle timestamps unset', () => {
+    const doc = new ApiKey(complete);
+
+    expect(doc.lastUsedAt).toBeUndefined();
+    expect(doc.expiresAt).toBeUndefined();
+    expect(doc.revokedAt).toBeUndefined();
+    expect(doc.lastRevealedAt).toBeUndefined();
+  });
+});
+
+describe('name', () => {
+  it('trims surrounding whitespace', () => {
+    expect(new ApiKey({ ...complete, name: '  Claude  ' }).name).toBe('Claude');
+  });
+
+  it('caps the length so a listing stays readable', () => {
+    const doc = new ApiKey({ ...complete, name: 'x'.repeat(61) });
+    expect(doc.validateSync()?.errors.name).toBeDefined();
+  });
+
+  it('accepts a name at the cap', () => {
+    const doc = new ApiKey({ ...complete, name: 'x'.repeat(60) });
+    expect(doc.validateSync()?.errors.name).toBeUndefined();
+  });
+});
+
+describe('indexes', () => {
+  const indexes = ApiKey.schema.indexes().map(([fields]) => fields);
+
+  it('indexes keyId, which every verification looks a key up by', () => {
+    const path = ApiKey.schema.path('keyId') as unknown as { options: Record<string, unknown> };
+    expect(path.options.index).toBe(true);
+    expect(path.options.unique).toBe(true);
+  });
+
+  it('indexes a user’s keys newest first, matching how the listing reads them', () => {
+    expect(indexes).toContainEqual({ userId: 1, createdAt: -1 });
+  });
+});
+
+describe('collection', () => {
+  it('lives in api_keys', () => {
+    // Named explicitly rather than pluralised by Mongoose, so the collection a
+    // migration or a manual query targets is not a guess.
+    expect(ApiKey.collection.collectionName).toBe('api_keys');
+  });
+});
+
+describe('model registration', () => {
+  it('reuses the compiled model instead of redefining it', () => {
+    // backend-core is imported by every service, and some import it more than
+    // once through different paths; recompiling would throw OverwriteModelError.
+    // eslint-disable-next-line @typescript-eslint/no-require-imports
+    const again = require('./ApiKey').ApiKey;
+    expect(again).toBe(ApiKey);
+  });
+});

package/src/apiKeys/index.test.ts

@@ -0,0 +1,72 @@
+import * as core from '../index';
+import * as apiKeys from './index';
+
+/**
+ * The package's public surface, as the services actually consume it.
+ *
+ * Services install this lib from npm, so an export dropped in a refactor does
+ * not fail here — it fails inside a Docker build as "has no exported member X",
+ * against a registry that genuinely has the code. That is a slow and confusing
+ * loop, and it is entirely preventable by naming the surface once.
+ */
+const PUBLIC_SURFACE = [
+  // middleware the services mount
+  'authenticateAgent',
+  'requireScope',
+  'denyApiKeys',
+  // key lifecycle, used by auth-service
+  'createApiKey',
+  'listApiKeys',
+  'revealApiKey',
+  'revokeApiKey',
+  'deleteApiKey',
+  'verifyApiKey',
+  // configuration and vocabulary
+  'isEncryptionConfigured',
+  'API_KEY_SCOPES',
+  'isApiKeyScope',
+  'ApiKey',
+  // helpers
+  'looksLikeApiKey',
+  'displayPrefix',
+  'resetEncryptionKeyCache'
+] as const;
+
+describe('the apiKeys barrel', () => {
+  it.each(PUBLIC_SURFACE)('exports %s', (name) => {
+    expect(apiKeys).toHaveProperty(name);
+    expect((apiKeys as Record<string, unknown>)[name]).toBeDefined();
+  });
+});
+
+describe('the package root', () => {
+  it.each(PUBLIC_SURFACE)('re-exports %s, which is how services import it', (name) => {
+    expect((core as Record<string, unknown>)[name]).toBeDefined();
+  });
+
+  it('exposes the same binding through both paths', () => {
+    for (const name of PUBLIC_SURFACE) {
+      expect((core as Record<string, unknown>)[name]).toBe((apiKeys as Record<string, unknown>)[name]);
+    }
+  });
+
+  it('still exports the session middleware the key work sits alongside', () => {
+    // `authenticateToken` stays JWT-only and is what auth-service and
+    // payment-service rely on to refuse keys outright.
+    expect(core.authenticateToken).toBeDefined();
+    expect(core.optionalAuth).toBeDefined();
+  });
+});
+
+describe('the scope vocabulary', () => {
+  it('is the same list the services and the UI are written against', () => {
+    expect([...core.API_KEY_SCOPES]).toEqual([
+      'relationship:read',
+      'relationship:write',
+      'album:read',
+      'album:write',
+      'finance:read',
+      'finance:write'
+    ]);
+  });
+});

package/src/apiKeys/middleware.test.ts

@@ -8,7 +8,7 @@ jest.mock('../logging/logger', () => ({
 
 import jwt from 'jsonwebtoken';
 import { verifyApiKey } from './service';
-import { authenticateAgent, denyApiKeys } from './middleware';
+import { authenticateAgent, requireScope, denyApiKeys } from './middleware';
 
 const mockedVerify = verifyApiKey as jest.Mock;
 const ORIGINAL_ENV = process.env;
@@ -157,6 +157,37 @@ describe('authenticateAgent — API keys', () => {
   });
 });
 
+it('authenticates a key stored before the owner snapshot existed', async () => {
+  // Records written by an earlier version carry no userEmail/userName. Such a
+  // key must still work — the id is what every handler actually reads — rather
+  // than 500 on a missing field.
+  mockedVerify.mockResolvedValue({
+    ok: true,
+    userId: 'u1',
+    keyId: 'k1',
+    scopes: ['relationship:read'],
+    groupId: null
+  });
+  const request = withKey();
+  const next = jest.fn();
+
+  await authenticateAgent('relationship:read')(request, mockRes(), next);
+
+  expect(next).toHaveBeenCalled();
+  expect(request.user).toEqual({ id: 'u1', email: '', name: '' });
+});
+
+it('treats a verification result with no scopes as granting nothing', async () => {
+  mockedVerify.mockResolvedValue({ ok: true, userId: 'u1', keyId: 'k1', groupId: null });
+  const res = mockRes();
+  const next = jest.fn();
+
+  await authenticateAgent('relationship:read')(withKey(), res, next);
+
+  expect(res.status).toHaveBeenCalledWith(403);
+  expect(next).not.toHaveBeenCalled();
+});
+
 describe('authenticateAgent — tenant pinning', () => {
   it('grants a personal key no groups at all', async () => {
     mockedVerify.mockResolvedValue(okVerification({ groupId: null }));
@@ -231,6 +262,74 @@ describe('authenticateAgent — tenant pinning', () => {
   });
 });
 
+describe('requireScope', () => {
+  const keyReq = (scopes: string[]) =>
+    req({ apiKey: { keyId: 'k1', scopes, groupId: null } } as Partial<Request>);
+
+  it('lets a session through unconditionally', () => {
+    // Scopes narrow what software may do on a person's behalf, not what the
+    // person may do themselves — a session carries no apiKey context at all.
+    const next = jest.fn();
+    requireScope('relationship:write')(req(), mockRes(), next);
+    expect(next).toHaveBeenCalled();
+  });
+
+  it('lets a key with the required scope through', () => {
+    const next = jest.fn();
+    requireScope('relationship:read')(keyReq(['relationship:read']), mockRes(), next);
+    expect(next).toHaveBeenCalled();
+  });
+
+  it('refuses a key without it, naming what is missing', () => {
+    const res = mockRes();
+    const next = jest.fn();
+
+    requireScope('relationship:write')(keyReq(['relationship:read']), res, next);
+
+    expect(res.status).toHaveBeenCalledWith(403);
+    expect(res.json).toHaveBeenCalledWith(
+      expect.objectContaining({ message: expect.stringContaining('relationship:write') })
+    );
+    expect(next).not.toHaveBeenCalled();
+  });
+
+  it('does not let a read scope stand in for a write', () => {
+    const next = jest.fn();
+    requireScope('album:write')(keyReq(['album:read']), mockRes(), next);
+    expect(next).not.toHaveBeenCalled();
+  });
+
+  it('does not let one area’s scope stand in for another’s', () => {
+    const next = jest.fn();
+    requireScope('finance:read')(keyReq(['relationship:read', 'album:read']), mockRes(), next);
+    expect(next).not.toHaveBeenCalled();
+  });
+
+  it('requires every named scope, not just one of them', () => {
+    const res = mockRes();
+    const next = jest.fn();
+
+    requireScope('relationship:read', 'album:write')(keyReq(['relationship:read']), res, next);
+
+    expect(next).not.toHaveBeenCalled();
+    expect(res.json).toHaveBeenCalledWith(
+      expect.objectContaining({ message: expect.stringContaining('album:write') })
+    );
+  });
+
+  it('refuses a key with no scopes at all', () => {
+    const next = jest.fn();
+    requireScope('relationship:read')(keyReq([]), mockRes(), next);
+    expect(next).not.toHaveBeenCalled();
+  });
+
+  it('lets any authenticated caller through when no scope is named', () => {
+    const next = jest.fn();
+    requireScope()(keyReq([]), mockRes(), next);
+    expect(next).toHaveBeenCalled();
+  });
+});
+
 describe('denyApiKeys', () => {
   it('lets a session through', () => {
     const next = jest.fn();

package/src/apiKeys/types.test.ts

@@ -0,0 +1,41 @@
+import { API_KEY_SCOPES, isApiKeyScope } from './types';
+
+describe('API_KEY_SCOPES', () => {
+  it('has no duplicates', () => {
+    expect(new Set(API_KEY_SCOPES).size).toBe(API_KEY_SCOPES.length);
+  });
+
+  it('offers a read and a write for every area it covers', () => {
+    for (const area of ['relationship', 'album', 'finance']) {
+      expect(API_KEY_SCOPES).toContain(`${area}:read`);
+      expect(API_KEY_SCOPES).toContain(`${area}:write`);
+    }
+  });
+
+  it('grants nothing over auth or payment, which stay a person’s to do', () => {
+    // A key that could mint keys could not be revoked, and one that could change
+    // a subscription has no ceiling on what it can cost.
+    for (const scope of API_KEY_SCOPES) {
+      expect(scope.startsWith('auth:')).toBe(false);
+      expect(scope.startsWith('payment:')).toBe(false);
+    }
+  });
+});
+
+describe('isApiKeyScope', () => {
+  it.each([...API_KEY_SCOPES])('accepts %s', (scope) => {
+    expect(isApiKeyScope(scope)).toBe(true);
+  });
+
+  it.each([
+    ['an invented area', 'admin:everything'],
+    ['an invented verb', 'relationship:delete'],
+    ['a bare area', 'relationship'],
+    ['an empty string', ''],
+    ['a non-string', 42],
+    ['null', null],
+    ['undefined', undefined]
+  ])('rejects %s', (_label, value) => {
+    expect(isApiKeyScope(value)).toBe(false);
+  });
+});