Umami is a privacy-first web and product analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place. No cookies, no surveillance, self-hosted or in the cloud.
TypeScript analyticsaudience-segmentationchartscohort-analysisgoogle-analyticsproduct-analyticsstatisticsuser-journeyweb-analytics
Fix board share entity authorization
Mike Caoa5f4a39f2b5c
diff --git a/src/app/api/boards/[boardId]/route.ts b/src/app/api/boards/[boardId]/route.tsindex 8d7a23aeb..1f1ea33f1 100644--- a/src/app/api/boards/[boardId]/route.ts+++ b/src/app/api/boards/[boardId]/route.ts@@ -1,8 +1,9 @@import { z } from 'zod';import { BOARD_TYPES, normalizeBoardType } from '@/lib/boards';+import type { BoardParameters } from '@/lib/types';import { parseRequest } from '@/lib/request';-import { json, ok, serverError, unauthorized } from '@/lib/response';-import { canDeleteBoard, canUpdateBoard, canViewBoard } from '@/permissions';+import { badRequest, json, ok, serverError, unauthorized } from '@/lib/response';+import { canDeleteBoard, canUpdateBoard, canViewBoard, canViewBoardEntities } from '@/permissions';import { deleteBoard, getBoard, updateBoard } from '@/queries/prisma';export async function GET(request: Request, { params }: { params: Promise<{ boardId: string }> }) {@@ -54,6 +55,21 @@ export async function POST(request: Request, { params }: { params: Promise<{ boareturn unauthorized();}+ if (type !== undefined || parameters !== undefined) {+ const currentBoard = await getBoard(boardId);++ if (!currentBoard) {+ return unauthorized();+ }++ const nextType = type ?? currentBoard.type;+ const nextParameters = (parameters ?? currentBoard.parameters) as BoardParameters;++ if (!(await canViewBoardEntities(auth, nextType, nextParameters))) {+ return badRequest({ message: 'Board contains inaccessible entities.' });+ }+ }+try {const board = await updateBoard(boardId, { type, name, description, parameters });diff --git a/src/app/api/boards/route.ts b/src/app/api/boards/route.tsindex 655486182..fd78f0029 100644--- a/src/app/api/boards/route.ts+++ b/src/app/api/boards/route.ts@@ -2,9 +2,9 @@ import { z } from 'zod';import { BOARD_TYPES, normalizeBoardType } from '@/lib/boards';import { uuid } from '@/lib/crypto';import { getQueryFilters, parseRequest } from '@/lib/request';-import { json, unauthorized } from '@/lib/response';+import { badRequest, json, unauthorized } from '@/lib/response';import { pagingParams, searchParams, sortingParams } from '@/lib/schema';-import { canCreateTeamWebsite, canCreateWebsite } from '@/permissions';+import { canCreateTeamWebsite, canCreateWebsite, canViewBoardEntities } from '@/permissions';import { createBoard, getUserBoards } from '@/queries/prisma';export async function GET(request: Request) {@@ -58,6 +58,10 @@ export async function POST(request: Request) {return unauthorized();}+ if (!(await canViewBoardEntities(auth, body.type, body.parameters))) {+ return badRequest({ message: 'Board contains inaccessible entities.' });+ }+const data = {...body,type: normalizeBoardType(body.type),diff --git a/src/app/api/share/[slug]/route.ts b/src/app/api/share/[slug]/route.tsindex 933ae6e48..d371e01e3 100644--- a/src/app/api/share/[slug]/route.ts+++ b/src/app/api/share/[slug]/route.ts@@ -5,8 +5,11 @@ import { createToken } from '@/lib/jwt';import prisma from '@/lib/prisma';import redis from '@/lib/redis';import { json, notFound } from '@/lib/response';-import type { BoardParameters, WhiteLabel } from '@/lib/types';-import { getBoard, getLink, getPixel, getShareByCode, getWebsite } from '@/queries/prisma';+import type { Auth, BoardParameters, WhiteLabel } from '@/lib/types';+import { canViewLink, canViewPixel, canViewWebsite } from '@/permissions';+import { getBoard, getLink, getPixel, getShareByCode, getUser, getWebsite } from '@/queries/prisma';++type BoardEntityIds = ReturnType<typeof getBoardEntityIds>;async function getAccountId(entity: { userId?: string; teamId?: string }): Promise<string | null> {if (entity.userId) {@@ -44,6 +47,70 @@ async function getWhiteLabel(accountId: string): Promise<WhiteLabel | null> {return null;}+async function filterEntityIds(+ ids: string[],+ canView: (id: string) => Promise<boolean>,+): Promise<string[]> {+ const results = await Promise.all(+ ids.map(async id => {+ try {+ return (await canView(id)) ? id : null;+ } catch {+ return null;+ }+ }),+ );++ return results.filter((id): id is string => !!id);+}++async function filterBoardEntityIdsForShare(+ entity: { userId?: string | null; teamId?: string | null },+ ids: BoardEntityIds,+): Promise<BoardEntityIds> {+ if (entity.teamId) {+ return {+ websiteIds: await filterEntityIds(+ ids.websiteIds,+ async id => (await getWebsite(id))?.teamId === entity.teamId,+ ),+ pixelIds: await filterEntityIds(+ ids.pixelIds,+ async id => (await getPixel(id))?.teamId === entity.teamId,+ ),+ linkIds: await filterEntityIds(+ ids.linkIds,+ async id => (await getLink(id))?.teamId === entity.teamId,+ ),+ };+ }++ if (!entity.userId) {+ return { websiteIds: [], pixelIds: [], linkIds: [] };+ }++ const user = await getUser(entity.userId);++ if (!user) {+ return { websiteIds: [], pixelIds: [], linkIds: [] };+ }++ const auth: Auth = {+ user: {+ id: user.id,+ username: user.username,+ role: user.role,+ isAdmin: user.role === ROLES.admin,+ },+ };++ return {+ websiteIds: await filterEntityIds(ids.websiteIds, id => canViewWebsite(auth, id)),+ pixelIds: await filterEntityIds(ids.pixelIds, id => canViewPixel(auth, id)),+ linkIds: await filterEntityIds(ids.linkIds, id => canViewLink(auth, id)),+ };+}+export async function GET(_request: Request, { params }: { params: Promise<{ slug: string }> }) {const { slug } = await params;@@ -70,9 +137,10 @@ export async function GET(_request: Request, { params }: { params: Promise<{ slutype: board.type,parameters: board.parameters as BoardParameters,});- data.websiteIds = boardEntityIds.websiteIds;- data.pixelIds = boardEntityIds.pixelIds;- data.linkIds = boardEntityIds.linkIds;+ const authorizedEntityIds = await filterBoardEntityIdsForShare(board, boardEntityIds);+ data.websiteIds = authorizedEntityIds.websiteIds;+ data.pixelIds = authorizedEntityIds.pixelIds;+ data.linkIds = authorizedEntityIds.linkIds;} else if (share.shareType === ENTITY_TYPE.website) {entity = await getWebsite(share.entityId);if (!entity) return notFound();diff --git a/src/permissions/board.test.ts b/src/permissions/board.test.tsnew file mode 100644index 000000000..afae58084--- /dev/null+++ b/src/permissions/board.test.ts@@ -0,0 +1,84 @@+import { beforeEach, expect, test, vi } from 'vitest';+import { BOARD_TYPES } from '@/lib/boards';+import { canViewBoardEntities } from './board';+import { canViewLink } from './link';+import { canViewPixel } from './pixel';+import { canViewWebsite } from './website';++vi.mock('@/queries/prisma', () => ({+ getBoard: vi.fn(),+ getTeamUser: vi.fn(),+}));++vi.mock('@/lib/prisma', () => ({+ default: {},+}));++vi.mock('./website', () => ({+ canViewWebsite: vi.fn(),+}));++vi.mock('./pixel', () => ({+ canViewPixel: vi.fn(),+}));++vi.mock('./link', () => ({+ canViewLink: vi.fn(),+}));++const auth = {+ user: {+ id: 'user-1',+ username: 'user',+ role: 'user',+ isAdmin: false,+ },+ shareToken: {+ websiteIds: ['victim-website-id'],+ },+};++beforeEach(() => {+ vi.mocked(canViewWebsite).mockReset();+ vi.mocked(canViewPixel).mockReset();+ vi.mocked(canViewLink).mockReset();+});++test('canViewBoardEntities validates board IDs with user auth only', async () => {+ vi.mocked(canViewWebsite).mockResolvedValue(true);++ await expect(+ canViewBoardEntities(auth, BOARD_TYPES.website, { websiteId: 'owned-website-id' }),+ ).resolves.toBe(true);++ expect(canViewWebsite).toHaveBeenCalledWith(+ {+ user: auth.user,+ },+ 'owned-website-id',+ );+});++test('canViewBoardEntities rejects IDs not accessible to the user', async () => {+ vi.mocked(canViewWebsite).mockResolvedValue(false);++ await expect(+ canViewBoardEntities(auth, BOARD_TYPES.mixed, {+ rows: [+ {+ id: 'row-1',+ columns: [+ {+ id: 'column-1',+ component: {+ type: 'WebsiteChart',+ entityType: 'website',+ entityId: 'victim-website-id',+ },+ },+ ],+ },+ ],+ }),+ ).resolves.toBe(false);+});diff --git a/src/permissions/board.ts b/src/permissions/board.tsindex 67c25d03a..b78da0eb9 100644--- a/src/permissions/board.ts+++ b/src/permissions/board.ts@@ -1,7 +1,37 @@import { hasPermission } from '@/lib/auth';+import { getBoardEntityIds } from '@/lib/boards';import { PERMISSIONS } from '@/lib/constants';-import type { Auth } from '@/lib/types';+import type { Auth, BoardParameters } from '@/lib/types';import { getBoard, getTeamUser } from '@/queries/prisma';+import { canViewLink } from './link';+import { canViewPixel } from './pixel';+import { canViewWebsite } from './website';++async function checkBoardEntityAccess(check: Promise<boolean>) {+ try {+ return await check;+ } catch {+ return false;+ }+}++export async function canViewBoardEntities(+ auth: Auth,+ type: string | undefined,+ parameters: BoardParameters = {},+) {+ const { websiteIds, pixelIds, linkIds } = getBoardEntityIds({ type, parameters });+ const userOnlyAuth: Auth = auth.user ? { user: auth.user } : {};+ const checks = [+ ...websiteIds.map(id => checkBoardEntityAccess(canViewWebsite(userOnlyAuth, id))),+ ...pixelIds.map(id => checkBoardEntityAccess(canViewPixel(userOnlyAuth, id))),+ ...linkIds.map(id => checkBoardEntityAccess(canViewLink(userOnlyAuth, id))),+ ];++ const results = await Promise.all(checks);++ return results.every(Boolean);+}export async function canViewBoard({ user, shareToken }: Auth, boardId: string) {if (user?.isAdmin) {diff --git a/src/permissions/link.ts b/src/permissions/link.tsindex f274c7b25..7c51a2c6b 100644--- a/src/permissions/link.ts+++ b/src/permissions/link.ts@@ -18,6 +18,10 @@ export async function canViewLink({ user, shareToken }: Auth, linkId: string) {const link = await getLink(linkId);+ if (!link) {+ return false;+ }+if (link.userId) {return user.id === link.userId;}@@ -42,6 +46,10 @@ export async function canUpdateLink({ user }: Auth, linkId: string) {const link = await getLink(linkId);+ if (!link) {+ return false;+ }+if (link.userId) {return user.id === link.userId;}@@ -66,6 +74,10 @@ export async function canDeleteLink({ user }: Auth, linkId: string) {const link = await getLink(linkId);+ if (!link) {+ return false;+ }+if (link.userId) {return user.id === link.userId;}diff --git a/src/permissions/pixel.ts b/src/permissions/pixel.tsindex 79b1b5976..72f221965 100644--- a/src/permissions/pixel.ts+++ b/src/permissions/pixel.ts@@ -18,6 +18,10 @@ export async function canViewPixel({ user, shareToken }: Auth, pixelId: string)const pixel = await getPixel(pixelId);+ if (!pixel) {+ return false;+ }+if (pixel.userId) {return user.id === pixel.userId;}@@ -42,6 +46,10 @@ export async function canUpdatePixel({ user }: Auth, pixelId: string) {const pixel = await getPixel(pixelId);+ if (!pixel) {+ return false;+ }+if (pixel.userId) {return user.id === pixel.userId;}@@ -66,6 +74,10 @@ export async function canDeletePixel({ user }: Auth, pixelId: string) {const pixel = await getPixel(pixelId);+ if (!pixel) {+ return false;+ }+if (pixel.userId) {return user.id === pixel.userId;}