@eeacms/volto-eea-chatbot 2.0.4 → 2.0.5

package/CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+### [2.0.5](https://github.com/eea/volto-eea-chatbot/compare/2.0.4...2.0.5) - 21 June 2026
+
+#### :bug: Bug Fixes
+
+- fix: add method to halloumi middleware test req [Tiberiu Ichim - [`082c285`](https://github.com/eea/volto-eea-chatbot/commit/082c285636b6dad397af9778b49361d6e29b8dec)]
+
+#### :hammer_and_wrench: Others
+
+- Formatting [Tiberiu Ichim - [`aabcc7a`](https://github.com/eea/volto-eea-chatbot/commit/aabcc7aafe720d47e4cae72215db8dfd8b55f7d9)]
+- Increase code coverage [Tiberiu Ichim - [`fdbcd85`](https://github.com/eea/volto-eea-chatbot/commit/fdbcd8580d44d1b3d41f024ae97670131951f822)]
 ### [2.0.4](https://github.com/eea/volto-eea-chatbot/compare/2.0.3...2.0.4) - 28 May 2026
 
 #### :bug: Bug Fixes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-eea-chatbot",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "description": "@eeacms/volto-eea-chatbot: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",

package/src/halloumi/middleware.js

@@ -1,11 +1,19 @@
 // import debug from 'debug';
 import { getVerifyClaimResponse } from './generative';
+import { isPathAllowed } from '../middleware';
 
 // const log = debug('halloumi');
 
 const MSG_INVALID_CONFIGURATION =
   'Invalid configuration: missing LLMGW_TOKEN or LLMGW_URL';
 
+// Allowed paths for _ha (Halloumi) proxy.
+// When adding new endpoints, update this list.
+const ALLOWED_HALLOUMI_PATHS = [
+  { path: '/generate', methods: ['POST'] },
+  { path: '/classify', methods: ['POST'] },
+];
+
 const LLMGW_URL = process.env.LLMGW_URL;
 const LLMGW_TOKEN = process.env.LLMGW_TOKEN;
 
@@ -32,6 +40,14 @@ const classifyModel = {
 export default async function middleware(req, res, next) {
   const path = req.url.replace('/_ha/', '/');
 
+  // Reject paths not on the allowlist — prevents Confused Deputy attacks
+  if (!isPathAllowed(path, req.method, ALLOWED_HALLOUMI_PATHS)) {
+    res.statusCode = 404;
+    res.statusMessage = 'Not Found';
+    res.send({ error: 'Not Found' });
+    return;
+  }
+
   if (!(LLMGW_TOKEN && LLMGW_URL)) {
     res.send({
       error: MSG_INVALID_CONFIGURATION,

package/src/halloumi/middleware.test.js

@@ -1,4 +1,5 @@
 import middleware from './middleware';
+import { isPathAllowed } from '../middleware';
 
 jest.mock('./generative');
 
@@ -8,11 +9,14 @@ describe('halloumi middleware', () => {
   beforeEach(() => {
     req = {
       url: '/_ha/generate',
+      method: 'POST',
       body: {
         sources: ['source1', 'source2'],
         answer: 'test answer',
         maxContextSegments: 3,
       },
+      headers: {},
+      ip: '127.0.0.1',
     };
     res = {
       send: jest.fn(),
@@ -42,28 +46,144 @@ describe('halloumi middleware', () => {
     process.env.LLMGW_URL = origUrl;
   });
 
-  it('calls getVerifyClaimResponse and sends response on success', async () => {
+  it('rejects disallowed paths with 404', async () => {
+    req.url = '/_ha/admin/config';
+    req.method = 'POST';
+
+    await middleware(req, res, next);
+
+    expect(res.statusCode).toBe(404);
+    expect(res.send).toHaveBeenCalledWith({ error: 'Not Found' });
+  });
+
+  it('rejects allowed path with wrong HTTP method', async () => {
+    req.url = '/_ha/generate';
+    req.method = 'GET';
+
+    await middleware(req, res, next);
+
+    expect(res.statusCode).toBe(404);
+    expect(res.send).toHaveBeenCalledWith({ error: 'Not Found' });
+  });
+});
+
+// These tests need a fresh module loaded with env vars set so that
+// LLMGW_TOKEN and LLMGW_URL are defined at module load time,
+// allowing the code to reach getVerifyClaimResponse.
+describe('halloumi middleware - dynamic import', () => {
+  const buildReq = () => ({
+    url: '/_ha/generate',
+    method: 'POST',
+    body: {
+      sources: ['source1', 'source2'],
+      answer: 'test answer',
+      maxContextSegments: 3,
+    },
+    headers: {},
+    ip: '127.0.0.1',
+  });
+
+  const buildRes = () => ({
+    send: jest.fn(),
+    set: jest.fn(),
+    status: jest.fn().mockReturnThis(),
+  });
+
+  it('sends response on successful getVerifyClaimResponse', async () => {
     const origToken = process.env.LLMGW_TOKEN;
     const origUrl = process.env.LLMGW_URL;
     process.env.LLMGW_TOKEN = 'test-token';
     process.env.LLMGW_URL = 'http://test-url';
 
-    // Need to re-import since env vars are read at module level
     jest.resetModules();
-    const genMod = require('./generative');
-    const middlewareMod = require('./middleware').default;
 
-    genMod.getVerifyClaimResponse = jest
+    const mockGetVerifyClaimResponse = jest
       .fn()
       .mockResolvedValue({ claims: [], segments: {} });
 
-    await middlewareMod(req, res, next);
+    jest.setMock('./generative', {
+      getVerifyClaimResponse: mockGetVerifyClaimResponse,
+    });
+
+    const middlewareMod = require('./middleware').default;
+
+    const req = buildReq();
+    const res = buildRes();
 
-    // It may send error if env vars weren't set before module load,
-    // but we verify the middleware doesn't crash
-    expect(res.send).toHaveBeenCalled();
+    await middlewareMod(req, res, jest.fn());
+
+    expect(mockGetVerifyClaimResponse).toHaveBeenCalled();
+    expect(res.set).toHaveBeenCalledWith('Content-Type', 'application/json');
+    expect(res.send).toHaveBeenCalledWith({ claims: [], segments: {} });
 
     process.env.LLMGW_TOKEN = origToken;
     process.env.LLMGW_URL = origUrl;
   });
+
+  it('handles errors from getVerifyClaimResponse', async () => {
+    const origToken = process.env.LLMGW_TOKEN;
+    const origUrl = process.env.LLMGW_URL;
+    process.env.LLMGW_TOKEN = 'test-token';
+    process.env.LLMGW_URL = 'http://test-url';
+
+    jest.resetModules();
+
+    const mockGetVerifyClaimResponse = jest
+      .fn()
+      .mockRejectedValue(new Error('LLM error'));
+
+    jest.setMock('./generative', {
+      getVerifyClaimResponse: mockGetVerifyClaimResponse,
+    });
+
+    const middlewareMod = require('./middleware').default;
+
+    const req = buildReq();
+    const res = buildRes();
+
+    await middlewareMod(req, res, jest.fn());
+
+    expect(res.status).toHaveBeenCalledWith(500);
+    expect(res.send).toHaveBeenCalledWith(
+      expect.objectContaining({ error: expect.stringContaining('LLM error') }),
+    );
+
+    process.env.LLMGW_TOKEN = origToken;
+    process.env.LLMGW_URL = origUrl;
+  });
+});
+
+describe('halloumi path allowlist', () => {
+  // Mirror of ALLOWED_HALLOUMI_PATHS from middleware.js
+  const ALLOWED_HALLOUMI_PATHS = [
+    { path: '/generate', methods: ['POST'] },
+    { path: '/classify', methods: ['POST'] },
+  ];
+
+  it('allows /generate with POST', () => {
+    expect(isPathAllowed('/generate', 'POST', ALLOWED_HALLOUMI_PATHS)).toBe(
+      true,
+    );
+  });
+
+  it('allows /classify with POST', () => {
+    expect(isPathAllowed('/classify', 'POST', ALLOWED_HALLOUMI_PATHS)).toBe(
+      true,
+    );
+  });
+
+  it('rejects /generate with wrong method', () => {
+    expect(isPathAllowed('/generate', 'GET', ALLOWED_HALLOUMI_PATHS)).toBe(
+      false,
+    );
+  });
+
+  it('rejects disallowed paths', () => {
+    expect(isPathAllowed('/admin/config', 'POST', ALLOWED_HALLOUMI_PATHS)).toBe(
+      false,
+    );
+    expect(
+      isPathAllowed('/../../etc/passwd', 'POST', ALLOWED_HALLOUMI_PATHS),
+    ).toBe(false);
+  });
 });

package/src/middleware.js

@@ -9,6 +9,31 @@ const log = debug('volto-eea-chatbot');
 
 const MOCK_STREAM_DELAY = parseInt(process.env.MOCK_STREAM_DELAY || '0');
 
+// Allowed paths for _da and _rq proxy (shared).
+// When adding new endpoints, update this list.
+const ALLOWED_PROXY_PATHS = [
+  { path: '/persona', methods: ['GET'] },
+  { pathPattern: /^\/persona\/\d+$/, methods: ['GET'] },
+  { path: '/chat/create-chat-session', methods: ['POST'] },
+  { path: '/chat/send-message', methods: ['POST'] },
+  { path: '/chat/send-chat-message', methods: ['POST'] },
+  { path: '/chat/create-chat-message-feedback', methods: ['POST'] },
+];
+
+/**
+ * Check whether a stripped path matches the allowlist.
+ * Strips query strings before comparison.
+ */
+function isPathAllowed(strippedPath, method, allowedPaths) {
+  const cleanPath = strippedPath.split('?')[0];
+  return allowedPaths.some(
+    (entry) =>
+      (entry.path === cleanPath ||
+        (entry.pathPattern && entry.pathPattern.test(cleanPath))) &&
+      entry.methods.includes(method),
+  );
+}
+
 let cached_auth_cookie = null;
 let last_fetched = null;
 let maxAge;
@@ -249,10 +274,19 @@ async function send_onyx_request(
   }
 }
 
+export { isPathAllowed, ALLOWED_PROXY_PATHS };
 export default async function middleware(req, res, next) {
   const is_related_question = req.url.includes('/_rq/');
   const path = req.url.replace('/_da/', '/').replace('/_rq/', '/');
 
+  // Reject paths not on the allowlist — prevents Confused Deputy attacks
+  if (!isPathAllowed(path, req.method, ALLOWED_PROXY_PATHS)) {
+    res.statusCode = 404;
+    res.statusMessage = 'Not Found';
+    res.send({ error: 'Not Found' });
+    return;
+  }
+
   const reqUrl = `${process.env.ONYX_URL || ''}/api${path}`;
 
   const api_key = process.env.ONYX_API_KEY;

package/src/middleware.test.js

@@ -1,5 +1,5 @@
 // Mock superagent
-import middleware from './middleware';
+import middleware, { isPathAllowed, ALLOWED_PROXY_PATHS } from './middleware';
 
 jest.mock('superagent', () => ({
   post: jest.fn().mockReturnValue({
@@ -234,4 +234,116 @@ describe('src/middleware', () => {
       '/tmp/dumped_response.jsonl',
     );
   });
+
+  it('rejects disallowed paths with 404', async () => {
+    process.env.ONYX_API_KEY = 'test-key';
+    process.env.ONYX_URL = 'http://localhost:3000';
+    req.url = '/_da/admin/users/delete';
+    req.method = 'POST';
+
+    await middleware(req, res, next);
+
+    expect(res.statusCode).toBe(404);
+    expect(res.send).toHaveBeenCalledWith({ error: 'Not Found' });
+    expect(nodeFetch).not.toHaveBeenCalled();
+  });
+
+  it('rejects allowed path with wrong HTTP method', async () => {
+    process.env.ONYX_API_KEY = 'test-key';
+    process.env.ONYX_URL = 'http://localhost:3000';
+    req.url = '/_da/persona';
+    req.method = 'DELETE';
+
+    await middleware(req, res, next);
+
+    expect(res.statusCode).toBe(404);
+    expect(res.send).toHaveBeenCalledWith({ error: 'Not Found' });
+    expect(nodeFetch).not.toHaveBeenCalled();
+  });
+
+  it('rejects path traversal attempts', async () => {
+    process.env.ONYX_API_KEY = 'test-key';
+    process.env.ONYX_URL = 'http://localhost:3000';
+    req.url = '/_da/../../etc/passwd';
+    req.method = 'GET';
+
+    await middleware(req, res, next);
+
+    expect(res.statusCode).toBe(404);
+    expect(res.send).toHaveBeenCalledWith({ error: 'Not Found' });
+    expect(nodeFetch).not.toHaveBeenCalled();
+  });
+});
+
+describe('isPathAllowed', () => {
+  it('allows all defined _da proxy paths with correct methods', () => {
+    expect(isPathAllowed('/persona', 'GET', ALLOWED_PROXY_PATHS)).toBe(true);
+    expect(isPathAllowed('/persona/25', 'GET', ALLOWED_PROXY_PATHS)).toBe(true);
+    expect(
+      isPathAllowed('/chat/create-chat-session', 'POST', ALLOWED_PROXY_PATHS),
+    ).toBe(true);
+    expect(
+      isPathAllowed('/chat/send-message', 'POST', ALLOWED_PROXY_PATHS),
+    ).toBe(true);
+    expect(
+      isPathAllowed('/chat/send-chat-message', 'POST', ALLOWED_PROXY_PATHS),
+    ).toBe(true);
+    expect(
+      isPathAllowed(
+        '/chat/create-chat-message-feedback',
+        'POST',
+        ALLOWED_PROXY_PATHS,
+      ),
+    ).toBe(true);
+  });
+
+  it('rejects allowed paths with wrong methods', () => {
+    expect(isPathAllowed('/persona', 'POST', ALLOWED_PROXY_PATHS)).toBe(false);
+    expect(
+      isPathAllowed('/chat/send-message', 'GET', ALLOWED_PROXY_PATHS),
+    ).toBe(false);
+  });
+
+  it('rejects disallowed paths', () => {
+    expect(
+      isPathAllowed('/admin/users/delete', 'POST', ALLOWED_PROXY_PATHS),
+    ).toBe(false);
+    expect(isPathAllowed('/../../etc/passwd', 'GET', ALLOWED_PROXY_PATHS)).toBe(
+      false,
+    );
+    expect(isPathAllowed('/api/debug', 'GET', ALLOWED_PROXY_PATHS)).toBe(false);
+  });
+
+  it('strips query strings before comparison', () => {
+    expect(
+      isPathAllowed(
+        '/persona?include_deleted=false',
+        'GET',
+        ALLOWED_PROXY_PATHS,
+      ),
+    ).toBe(true);
+    expect(
+      isPathAllowed('/persona/25?fields=name', 'GET', ALLOWED_PROXY_PATHS),
+    ).toBe(true);
+  });
+
+  it('rejects non-numeric persona IDs', () => {
+    expect(isPathAllowed('/persona/abc', 'GET', ALLOWED_PROXY_PATHS)).toBe(
+      false,
+    );
+  });
+});
+
+describe('isPathAllowed with _rq paths', () => {
+  it('allows related question paths via shared allowlist', () => {
+    expect(
+      isPathAllowed('/chat/create-chat-session', 'POST', ALLOWED_PROXY_PATHS),
+    ).toBe(true);
+    expect(
+      isPathAllowed('/chat/send-message', 'POST', ALLOWED_PROXY_PATHS),
+    ).toBe(true);
+    expect(
+      isPathAllowed('/chat/send-chat-message', 'POST', ALLOWED_PROXY_PATHS),
+    ).toBe(true);
+  });
 });