A free and open source instant messaging and VoIP chat app built for friends, groups, and communities.
// SPDX-License-Identifier: AGPL-3.0-or-later
import {createTestAccount} from '@app/api/auth/tests/AuthTestUtils';
import {createGuild} from '@app/api/guild/tests/GuildTestUtils';
import {type ApiTestHarness, createApiTestHarness} from '@app/api/test/ApiTestHarness';
import {HTTP_STATUS} from '@app/api/test/TestConstants';
import {createBuilderWithoutAuth} from '@app/api/test/TestRequestBuilder';
import {createWebhook, deleteWebhook} from '@app/api/webhook/tests/WebhookTestUtils';
import type {WebhookTokenResponse} from '@fluxer/schema/src/domains/webhook/WebhookSchemas';
import {afterEach, beforeEach, describe, expect, it} from 'vitest';
describe('Webhook token authentication', () => {
let harness: ApiTestHarness;
beforeEach(async () => {
harness = await createApiTestHarness();
});
afterEach(async () => {
await harness?.shutdown();
});
describe('GET /webhooks/:webhook_id/:token', () => {
it('returns webhook with valid token', async () => {
const owner = await createTestAccount(harness);
const guild = await createGuild(harness, owner.token, 'Token Auth Guild');
const channelId = guild.system_channel_id!;
const webhook = await createWebhook(harness, channelId, owner.token, 'Token Auth Webhook');
const response = await createBuilderWithoutAuth<WebhookTokenResponse>(harness)
.get(`/webhooks/${webhook.id}/${webhook.token}`)
.expect(HTTP_STATUS.OK)
.execute();
expect(response).not.toHaveProperty('user');
await deleteWebhook(harness, webhook.id, owner.token);
});
it('rejects invalid token', async () => {
const owner = await createTestAccount(harness);
const guild = await createGuild(harness, owner.token, 'Token Auth Guild');
const channelId = guild.system_channel_id!;
const webhook = await createWebhook(harness, channelId, owner.token, 'Token Auth Webhook');
await createBuilderWithoutAuth(harness)
.get(`/webhooks/${webhook.id}/invalid_token_12345`)
.expect(HTTP_STATUS.NOT_FOUND)
.execute();
await deleteWebhook(harness, webhook.id, owner.token);
});
it('rejects valid id with wrong token', async () => {
const owner = await createTestAccount(harness);
const guild = await createGuild(harness, owner.token, 'Token Auth Guild');
const channelId = guild.system_channel_id!;
const webhook1 = await createWebhook(harness, channelId, owner.token, 'First Webhook');
const webhook2 = await createWebhook(harness, channelId, owner.token, 'Second Webhook');
await createBuilderWithoutAuth(harness)
.get(`/webhooks/${webhook1.id}/${webhook2.token}`)
.expect(HTTP_STATUS.NOT_FOUND)
.execute();
await deleteWebhook(harness, webhook1.id, owner.token);
await deleteWebhook(harness, webhook2.id, owner.token);
});
});
describe('PATCH /webhooks/:webhook_id/:token', () => {
it('updates webhook with valid token', async () => {
const owner = await createTestAccount(harness);
const guild = await createGuild(harness, owner.token, 'Token Auth Guild');
const channelId = guild.system_channel_id!;
const webhook = await createWebhook(harness, channelId, owner.token, 'Original Name');
const response = await createBuilderWithoutAuth<WebhookTokenResponse>(harness)
.patch(`/webhooks/${webhook.id}/${webhook.token}`)
.body({name: 'Updated Name'})
.expect(HTTP_STATUS.OK)
.execute();
expect(response).not.toHaveProperty('user');
await deleteWebhook(harness, webhook.id, owner.token);
});
it('rejects channel_id updates with token', async () => {
const owner = await createTestAccount(harness);
const guild = await createGuild(harness, owner.token, 'Token Auth Guild');
const channelId = guild.system_channel_id!;
const webhook = await createWebhook(harness, channelId, owner.token, 'Token Patch Webhook');
await createBuilderWithoutAuth(harness)
.patch(`/webhooks/${webhook.id}/${webhook.token}`)
.body({channel_id: channelId})
.expect(HTTP_STATUS.BAD_REQUEST, 'INVALID_FORM_BODY')
.execute();
await deleteWebhook(harness, webhook.id, owner.token);
});
it('rejects update with invalid token', async () => {
const owner = await createTestAccount(harness);
const guild = await createGuild(harness, owner.token, 'Token Auth Guild');
const channelId = guild.system_channel_id!;
const webhook = await createWebhook(harness, channelId, owner.token, 'Token Patch Webhook');
await createBuilderWithoutAuth(harness)
.patch(`/webhooks/${webhook.id}/wrong_token`)
.body({name: 'Hacked Name'})
.expect(HTTP_STATUS.NOT_FOUND)
.execute();
await deleteWebhook(harness, webhook.id, owner.token);
});
});
describe('DELETE /webhooks/:webhook_id/:token', () => {
it('deletes webhook with valid token', async () => {
const owner = await createTestAccount(harness);
const guild = await createGuild(harness, owner.token, 'Token Auth Guild');
const channelId = guild.system_channel_id!;
const webhook = await createWebhook(harness, channelId, owner.token, 'Delete With Token');
await createBuilderWithoutAuth(harness)
.delete(`/webhooks/${webhook.id}/${webhook.token}`)
.expect(HTTP_STATUS.NO_CONTENT)
.execute();
await createBuilderWithoutAuth(harness)
.get(`/webhooks/${webhook.id}/${webhook.token}`)
.expect(HTTP_STATUS.NOT_FOUND)
.execute();
});
it('rejects delete with invalid token', async () => {
const owner = await createTestAccount(harness);
const guild = await createGuild(harness, owner.token, 'Token Auth Guild');
const channelId = guild.system_channel_id!;
const webhook = await createWebhook(harness, channelId, owner.token, 'Protected Webhook');
await createBuilderWithoutAuth(harness)
.delete(`/webhooks/${webhook.id}/bad_token`)
.expect(HTTP_STATUS.NOT_FOUND)
.execute();
await createBuilderWithoutAuth(harness)
.get(`/webhooks/${webhook.id}/${webhook.token}`)
.expect(HTTP_STATUS.OK)
.execute();
await deleteWebhook(harness, webhook.id, owner.token);
});
});
describe('POST /webhooks/:webhook_id/:token (execute)', () => {
it('rejects execution with invalid token', async () => {
const owner = await createTestAccount(harness);
const guild = await createGuild(harness, owner.token, 'Token Auth Guild');
const channelId = guild.system_channel_id!;
const webhook = await createWebhook(harness, channelId, owner.token, 'Execute Webhook');
await createBuilderWithoutAuth(harness)
.post(`/webhooks/${webhook.id}/invalid_token`)
.body({content: 'Should fail'})
.expect(HTTP_STATUS.NOT_FOUND)
.execute();
await deleteWebhook(harness, webhook.id, owner.token);
});
});
describe('CORS', () => {
it('allows browser requests from arbitrary origins on token-authenticated webhook routes', async () => {
const owner = await createTestAccount(harness);
const guild = await createGuild(harness, owner.token, 'Token Auth Guild');
const channelId = guild.system_channel_id!;
const webhook = await createWebhook(harness, channelId, owner.token, 'CORS Webhook');
const response = await harness.app.request(`/webhooks/${webhook.id}/${webhook.token}`, {
headers: {
origin: 'https://discohook.org',
'x-forwarded-for': '127.0.0.1',
},
});
expect(response.status).toBe(HTTP_STATUS.OK);
expect(response.headers.get('Access-Control-Allow-Origin')).toBe('*');
await deleteWebhook(harness, webhook.id, owner.token);
});
it('allows CORS preflight for webhook execution', async () => {
const owner = await createTestAccount(harness);
const guild = await createGuild(harness, owner.token, 'Token Auth Guild');
const channelId = guild.system_channel_id!;
const webhook = await createWebhook(harness, channelId, owner.token, 'CORS Execute Webhook');
const response = await harness.app.request(`/webhooks/${webhook.id}/${webhook.token}`, {
method: 'OPTIONS',
headers: {
origin: 'https://discohook.org',
'access-control-request-method': 'POST',
'access-control-request-headers': 'content-type',
},
});
expect(response.status).toBe(HTTP_STATUS.NO_CONTENT);
expect(response.headers.get('Access-Control-Allow-Origin')).toBe('*');
expect(response.headers.get('Access-Control-Allow-Methods')).toContain('POST');
expect(response.headers.get('Access-Control-Allow-Headers')).toContain('Content-Type');
await deleteWebhook(harness, webhook.id, owner.token);
});
it('keeps authenticated management routes on the standard API CORS allowlist', async () => {
const owner = await createTestAccount(harness);
const guild = await createGuild(harness, owner.token, 'Token Auth Guild');
const channelId = guild.system_channel_id!;
const response = await harness.app.request(`/channels/${channelId}/webhooks`, {
method: 'OPTIONS',
headers: {
origin: 'https://discohook.org',
'access-control-request-method': 'GET',
},
});
expect(response.status).toBe(HTTP_STATUS.NO_CONTENT);
expect(response.headers.get('Access-Control-Allow-Origin')).toBeNull();
});
});
});