mirror of
https://github.com/documenso/documenso.git
synced 2026-06-22 04:12:06 +10:00
d5ce222482
Adds Cloud Signature Consortium (CSC) integration for AES/QES signing against a configured TSP. v1 ships as instance-wide configuration via environment variables, with per-envelope signature level selection, license gating, and an OAuth-driven signing flow (capture + FIFO signers, SAD session, blocking/in-progress recipient pages). Includes signature level compatibility checks (role, signing order, dictate next signer), envelope mutability assertions, Prisma migration for signature level and CSC tables, and docs for the new signing certificate options.
155 lines
4.4 KiB
TypeScript
155 lines
4.4 KiB
TypeScript
import { AppError, AppErrorCode } from '@documenso/lib/errors/app-error';
|
|
import { getRecipientByToken } from '@documenso/lib/server-only/recipient/get-recipient-by-token';
|
|
import { prisma } from '@documenso/prisma';
|
|
import { sValidator } from '@hono/standard-validator';
|
|
import { Hono } from 'hono';
|
|
import { z } from 'zod';
|
|
|
|
import {
|
|
buildCscCredentialScopeAuthorizeUrl,
|
|
buildCscServiceScopeAuthorizeUrl,
|
|
generateCodeVerifier,
|
|
generateState,
|
|
} from '../client/oauth';
|
|
import { setCscOAuthFlowCookie } from '../cookies/oauth-flow-cookie';
|
|
import { loadCscCredential } from '../credential';
|
|
import { loadCscSession } from '../sign-session';
|
|
import { getCscTransport } from '../transport';
|
|
import type { HonoCscEnv } from './context';
|
|
|
|
/**
|
|
* `GET /api/csc/oauth/authorize` — initiates the CSC OAuth round-trip and
|
|
* 302-redirects to the TSP's authorize URL with a signed `csc_oauth_flow`
|
|
* cookie carrying the state, PKCE verifier, and recipient context the
|
|
* callback needs to resume the flow.
|
|
*
|
|
* Branches on `?scope=service|credential`:
|
|
* - `service`: authorised by recipient token; precedes credentials/list.
|
|
* - `credential`: authorised by an active `CscSession`; binds the issued SAD
|
|
* to the per-item hashes captured at prep.
|
|
*
|
|
* Errors bubble to the parent app's `.onError` handler (see `./index.ts`).
|
|
*/
|
|
|
|
const ZAuthorizeQuerySchema = z.discriminatedUnion('scope', [
|
|
z.object({
|
|
scope: z.literal('service'),
|
|
token: z.string().min(1),
|
|
}),
|
|
z.object({
|
|
scope: z.literal('credential'),
|
|
session: z.string().min(1),
|
|
}),
|
|
]);
|
|
|
|
export const cscOAuthAuthorizeRoute = new Hono<HonoCscEnv>().get(
|
|
'/',
|
|
sValidator('query', ZAuthorizeQuerySchema),
|
|
async (c) => {
|
|
const logger = c.get('logger');
|
|
|
|
const query = c.req.valid('query');
|
|
|
|
const transport = await getCscTransport();
|
|
|
|
if (query.scope === 'service') {
|
|
const recipient = await getRecipientByToken({ token: query.token }).catch(() => null);
|
|
|
|
if (!recipient) {
|
|
throw new AppError(AppErrorCode.NOT_FOUND, {
|
|
message: 'Recipient not found for the provided token.',
|
|
});
|
|
}
|
|
|
|
logger.info({
|
|
event: 'csc.oauth.authorize.start',
|
|
scope: 'service',
|
|
recipientId: recipient.id,
|
|
});
|
|
|
|
const state = generateState();
|
|
const codeVerifier = generateCodeVerifier();
|
|
|
|
const authorizeUrl = buildCscServiceScopeAuthorizeUrl({
|
|
client: transport.oauthClient,
|
|
oauthBaseUrl: transport.oauthBaseUrl,
|
|
state,
|
|
codeVerifier,
|
|
});
|
|
|
|
await setCscOAuthFlowCookie({
|
|
c,
|
|
payload: {
|
|
scope: 'service',
|
|
state,
|
|
codeVerifier,
|
|
recipientToken: query.token,
|
|
},
|
|
});
|
|
|
|
return c.redirect(authorizeUrl.toString(), 302);
|
|
}
|
|
|
|
const session = await loadCscSession(query.session);
|
|
|
|
if (!session) {
|
|
throw new AppError(AppErrorCode.NOT_FOUND, {
|
|
message: 'CSC session not found or already consumed.',
|
|
});
|
|
}
|
|
|
|
const credential = await loadCscCredential(session.recipientId);
|
|
|
|
if (!credential) {
|
|
throw new AppError(AppErrorCode.NOT_FOUND, {
|
|
message: 'CSC credential missing — service-scope OAuth must complete first.',
|
|
});
|
|
}
|
|
|
|
const recipient = await prisma.recipient.findUnique({
|
|
where: { id: session.recipientId },
|
|
select: { token: true },
|
|
});
|
|
|
|
if (!recipient) {
|
|
throw new AppError(AppErrorCode.NOT_FOUND, {
|
|
message: 'Recipient not found for the CSC session.',
|
|
});
|
|
}
|
|
|
|
logger.info({
|
|
event: 'csc.oauth.authorize.start',
|
|
scope: 'credential',
|
|
recipientId: session.recipientId,
|
|
sessionId: session.id,
|
|
numSignatures: session.items.length,
|
|
});
|
|
|
|
const state = generateState();
|
|
const codeVerifier = generateCodeVerifier();
|
|
|
|
const authorizeUrl = buildCscCredentialScopeAuthorizeUrl({
|
|
client: transport.oauthClient,
|
|
oauthBaseUrl: transport.oauthBaseUrl,
|
|
state,
|
|
codeVerifier,
|
|
credentialId: credential.credentialId,
|
|
numSignatures: session.items.length,
|
|
hashes: session.items.map((item) => item.hashB64),
|
|
});
|
|
|
|
await setCscOAuthFlowCookie({
|
|
c,
|
|
payload: {
|
|
scope: 'credential',
|
|
state,
|
|
codeVerifier,
|
|
recipientToken: recipient.token,
|
|
sessionId: session.id,
|
|
},
|
|
});
|
|
|
|
return c.redirect(authorizeUrl.toString(), 302);
|
|
},
|
|
);
|