The Open Source DocuSign Alternative.
TypeScript digital-signaturedocument-signingdocusign-alternativee-signatureesignesignaturenext-authnextjsopen-sourcepades-standardpdfpdf-signpdf-signaturepostgresqlprismaself-hostedsigningtypescript
chore: add tests for cert and audit log download via api (#3043)
Lucas Smithc219305eb1b6
diff --git a/apps/remix/server/api/download/download.ts b/apps/remix/server/api/download/download.tsindex 796a68653..6682c327c 100644--- a/apps/remix/server/api/download/download.ts+++ b/apps/remix/server/api/download/download.ts@@ -146,7 +146,7 @@ export const downloadRoute = new Hono<HonoEnv>()* Requires API key authentication via Authorization header.*/.get(- '/envelope/:envelopeId/audit-log/pdf',+ '/envelope/:envelopeId/audit-log/download',sValidator('param', ZDownloadEnvelopeAuditLogPdfRequestParamsSchema),async (c) => {const logger = c.get('logger');@@ -220,7 +220,7 @@ export const downloadRoute = new Hono<HonoEnv>()* Requires API key authentication via Authorization header.*/.get(- '/envelope/:envelopeId/certificate/pdf',+ '/envelope/:envelopeId/certificate/download',sValidator('param', ZDownloadEnvelopeCertificatePdfRequestParamsSchema),async (c) => {const logger = c.get('logger');diff --git a/packages/app-tests/e2e/api/v2/unauthorized-api-access/api-access-envelope-cert-audit-log.spec.ts b/packages/app-tests/e2e/api/v2/unauthorized-api-access/api-access-envelope-cert-audit-log.spec.tsnew file mode 100644index 000000000..17216ee67--- /dev/null+++ b/packages/app-tests/e2e/api/v2/unauthorized-api-access/api-access-envelope-cert-audit-log.spec.ts@@ -0,0 +1,284 @@+import { NEXT_PUBLIC_WEBAPP_URL } from '@documenso/lib/constants/app';+import { hashString } from '@documenso/lib/server-only/auth/hash';+import { createApiToken } from '@documenso/lib/server-only/public-api/create-api-token';+import { alphaid } from '@documenso/lib/universal/id';+import { prisma } from '@documenso/prisma';+import { DocumentVisibility, TeamMemberRole } from '@documenso/prisma/client';+import { seedCompletedDocument } from '@documenso/prisma/seed/documents';+import { seedTeam, seedTeamMember } from '@documenso/prisma/seed/teams';+import { seedUser } from '@documenso/prisma/seed/users';+import { type APIRequestContext, expect, test } from '@playwright/test';+import type { Team, User } from '@prisma/client';++const WEBAPP_BASE_URL = NEXT_PUBLIC_WEBAPP_URL();+const API_BASE_URL = `${WEBAPP_BASE_URL}/api/v2-beta`;++/**+ * Create an API token directly, bypassing the role check in `createApiToken`.+ *+ * This simulates a token that was minted while the user had permission, and which+ * survives a later downgrade to a lower team role (e.g. MEMBER). Such a token must+ * still respect document visibility at request time.+ */+const seedApiTokenForUser = async ({+ userId,+ teamId,+ tokenName,+}: {+ userId: number;+ teamId: number;+ tokenName: string;+}) => {+ const token = `api_${alphaid(16)}`;++ await prisma.apiToken.create({+ data: {+ name: tokenName,+ token: hashString(token),+ expires: null,+ userId,+ teamId,+ },+ });++ return { token };+};++test.describe.configure({+ mode: 'parallel',+});++const downloadAuditLogPdf = (request: APIRequestContext, envelopeId: string, authToken?: string) => {+ return request.get(`${API_BASE_URL}/envelope/${envelopeId}/audit-log/download`, {+ headers: authToken ? { Authorization: `Bearer ${authToken}` } : {},+ });+};++const downloadCertificatePdf = (request: APIRequestContext, envelopeId: string, authToken?: string) => {+ return request.get(`${API_BASE_URL}/envelope/${envelopeId}/certificate/download`, {+ headers: authToken ? { Authorization: `Bearer ${authToken}` } : {},+ });+};++test.describe('Envelope certificate / audit log PDF download API V2 - access control', () => {+ let userA: User, teamA: Team, userB: User, teamB: Team, tokenA: string, tokenB: string;++ test.beforeEach(async () => {+ ({ user: userA, team: teamA } = await seedUser());+ ({ token: tokenA } = await createApiToken({+ userId: userA.id,+ teamId: teamA.id,+ tokenName: 'userA',+ expiresIn: null,+ }));++ ({ user: userB, team: teamB } = await seedUser());+ ({ token: tokenB } = await createApiToken({+ userId: userB.id,+ teamId: teamB.id,+ tokenName: 'userB',+ expiresIn: null,+ }));+ });++ test('should reject audit log download without an API token', async ({ request }) => {+ const document = await seedCompletedDocument(userA, teamA.id, ['[email protected]']);++ const res = await downloadAuditLogPdf(request, document.id);++ expect(res.ok()).toBeFalsy();+ expect(res.status()).toBe(401);+ });++ test('should reject certificate download without an API token', async ({ request }) => {+ const document = await seedCompletedDocument(userA, teamA.id, ['[email protected]']);++ const res = await downloadCertificatePdf(request, document.id);++ expect(res.ok()).toBeFalsy();+ expect(res.status()).toBe(401);+ });++ test('should reject audit log download from a user in a different team', async ({ request }) => {+ const document = await seedCompletedDocument(userA, teamA.id, ['[email protected]']);++ const res = await downloadAuditLogPdf(request, document.id, tokenB);++ expect(res.ok()).toBeFalsy();+ expect(res.status()).toBe(404);+ });++ test('should reject certificate download from a user in a different team', async ({ request }) => {+ const document = await seedCompletedDocument(userA, teamA.id, ['[email protected]']);++ const res = await downloadCertificatePdf(request, document.id, tokenB);++ expect(res.ok()).toBeFalsy();+ expect(res.status()).toBe(404);+ });++ test('should reject a disabled user downloading the audit log', async ({ request }) => {+ const document = await seedCompletedDocument(userA, teamA.id, ['[email protected]']);++ await prisma.user.update({+ where: { id: userA.id },+ data: { disabled: true },+ });++ const res = await downloadAuditLogPdf(request, document.id, tokenA);++ expect(res.ok()).toBeFalsy();+ expect(res.status()).toBe(401);+ });++ test('should reject a disabled user downloading the certificate', async ({ request }) => {+ const document = await seedCompletedDocument(userA, teamA.id, ['[email protected]']);++ await prisma.user.update({+ where: { id: userA.id },+ data: { disabled: true },+ });++ const res = await downloadCertificatePdf(request, document.id, tokenA);++ expect(res.ok()).toBeFalsy();+ expect(res.status()).toBe(401);+ });++ test('should return 404 for a non-existent envelope id', async ({ request }) => {+ const auditLogRes = await downloadAuditLogPdf(request, 'envelope_doesnotexist', tokenA);+ expect(auditLogRes.status()).toBe(404);++ const certificateRes = await downloadCertificatePdf(request, 'envelope_doesnotexist', tokenA);+ expect(certificateRes.status()).toBe(404);+ });+});++test.describe('Envelope certificate / audit log PDF download API V2 - document visibility', () => {+ test.describe.configure({+ mode: 'parallel',+ });++ test('should hide an ADMIN-only document from a downgraded member (audit log)', async ({ request }) => {+ const { team, owner } = await seedTeam();+ const member = await seedTeamMember({ teamId: team.id, role: TeamMemberRole.MEMBER });++ const { token: memberToken } = await seedApiTokenForUser({+ userId: member.id,+ teamId: team.id,+ tokenName: 'member-audit-log-token',+ });++ // ADMIN-visibility document owned by the team owner - a member must not see it.+ const document = await seedCompletedDocument(owner, team.id, ['[email protected]'], {+ createDocumentOptions: { visibility: DocumentVisibility.ADMIN },+ });++ const res = await downloadAuditLogPdf(request, document.id, memberToken);++ // Visibility failure surfaces as not-found, matching the canonical access checks.+ expect(res.ok()).toBeFalsy();+ expect(res.status()).toBe(404);+ });++ test('should hide an ADMIN-only document from a downgraded member (certificate)', async ({ request }) => {+ const { team, owner } = await seedTeam();+ const member = await seedTeamMember({ teamId: team.id, role: TeamMemberRole.MEMBER });++ const { token: memberToken } = await seedApiTokenForUser({+ userId: member.id,+ teamId: team.id,+ tokenName: 'member-certificate-token',+ });++ const document = await seedCompletedDocument(owner, team.id, ['[email protected]'], {+ createDocumentOptions: { visibility: DocumentVisibility.ADMIN },+ });++ const res = await downloadCertificatePdf(request, document.id, memberToken);++ expect(res.ok()).toBeFalsy();+ expect(res.status()).toBe(404);+ });++ test('should hide a MANAGER_AND_ABOVE document from a downgraded member (audit log)', async ({ request }) => {+ const { team, owner } = await seedTeam();+ const member = await seedTeamMember({ teamId: team.id, role: TeamMemberRole.MEMBER });++ const { token: memberToken } = await seedApiTokenForUser({+ userId: member.id,+ teamId: team.id,+ tokenName: 'member-manager-vis-token',+ });++ const document = await seedCompletedDocument(owner, team.id, ['[email protected]'], {+ createDocumentOptions: { visibility: DocumentVisibility.MANAGER_AND_ABOVE },+ });++ const res = await downloadAuditLogPdf(request, document.id, memberToken);++ expect(res.ok()).toBeFalsy();+ expect(res.status()).toBe(404);+ });++ test('should hide a MANAGER_AND_ABOVE document from a downgraded member (certificate)', async ({ request }) => {+ const { team, owner } = await seedTeam();+ const member = await seedTeamMember({ teamId: team.id, role: TeamMemberRole.MEMBER });++ const { token: memberToken } = await seedApiTokenForUser({+ userId: member.id,+ teamId: team.id,+ tokenName: 'member-manager-vis-cert-token',+ });++ const document = await seedCompletedDocument(owner, team.id, ['[email protected]'], {+ createDocumentOptions: { visibility: DocumentVisibility.MANAGER_AND_ABOVE },+ });++ const res = await downloadCertificatePdf(request, document.id, memberToken);++ expect(res.ok()).toBeFalsy();+ expect(res.status()).toBe(404);+ });++ test('should hide an ADMIN-only document from a downgraded manager (certificate)', async ({ request }) => {+ const { team, owner } = await seedTeam();+ const manager = await seedTeamMember({ teamId: team.id, role: TeamMemberRole.MANAGER });++ const { token: managerToken } = await seedApiTokenForUser({+ userId: manager.id,+ teamId: team.id,+ tokenName: 'manager-admin-vis-cert-token',+ });++ const document = await seedCompletedDocument(owner, team.id, ['[email protected]'], {+ createDocumentOptions: { visibility: DocumentVisibility.ADMIN },+ });++ const res = await downloadCertificatePdf(request, document.id, managerToken);++ expect(res.ok()).toBeFalsy();+ expect(res.status()).toBe(404);+ });++ test('should allow a member to download an EVERYONE-visibility document (audit log)', async ({ request }) => {+ const { team, owner } = await seedTeam();+ const member = await seedTeamMember({ teamId: team.id, role: TeamMemberRole.MEMBER });++ const { token: memberToken } = await seedApiTokenForUser({+ userId: member.id,+ teamId: team.id,+ tokenName: 'member-everyone-vis-token',+ });++ const document = await seedCompletedDocument(owner, team.id, ['[email protected]'], {+ createDocumentOptions: { visibility: DocumentVisibility.EVERYONE },+ });++ const res = await downloadAuditLogPdf(request, document.id, memberToken);++ expect(res.ok()).toBeTruthy();+ expect(res.status()).toBe(200);+ expect(res.headers()['content-type']).toContain('application/pdf');+ });+});diff --git a/packages/trpc/server/envelope-router/download-envelope-audit-log-pdf.types.ts b/packages/trpc/server/envelope-router/download-envelope-audit-log-pdf.types.tsindex 3e43033ac..2c725d7f8 100644--- a/packages/trpc/server/envelope-router/download-envelope-audit-log-pdf.types.ts+++ b/packages/trpc/server/envelope-router/download-envelope-audit-log-pdf.types.ts@@ -5,7 +5,7 @@ import type { TrpcRouteMeta } from '../trpc';export const downloadEnvelopeAuditLogPdfMeta: TrpcRouteMeta = {openapi: {method: 'GET',- path: '/envelope/{envelopeId}/audit-log/pdf',+ path: '/envelope/{envelopeId}/audit-log/download',summary: 'Download envelope audit log PDF',description: 'Download the audit log for a document as a PDF.',tags: ['Envelope'],diff --git a/packages/trpc/server/envelope-router/download-envelope-certificate-pdf.types.ts b/packages/trpc/server/envelope-router/download-envelope-certificate-pdf.types.tsindex eeab2be69..b35e7aa11 100644--- a/packages/trpc/server/envelope-router/download-envelope-certificate-pdf.types.ts+++ b/packages/trpc/server/envelope-router/download-envelope-certificate-pdf.types.ts@@ -5,7 +5,7 @@ import type { TrpcRouteMeta } from '../trpc';export const downloadEnvelopeCertificatePdfMeta: TrpcRouteMeta = {openapi: {method: 'GET',- path: '/envelope/{envelopeId}/certificate/pdf',+ path: '/envelope/{envelopeId}/certificate/download',summary: 'Download envelope certificate PDF',description: 'Download the signing certificate for a completed document as a PDF.',tags: ['Envelope'],