Files
fluxer/fluxer_api/src/api/auth/services/DesktopHandoffService.ts
T

242 lines
8.1 KiB
TypeScript

// SPDX-License-Identifier: AGPL-3.0-or-later
import {createHash, randomBytes, timingSafeEqual} from 'node:crypto';
import type {ApiContext} from '@app/api/ApiContext';
import type {SessionOrigin} from '@app/api/auth/AuthSession';
import {HandoffCodeExpiredError} from '@fluxer/errors/src/domains/auth/HandoffCodeExpiredError';
import {InvalidHandoffCodeError} from '@fluxer/errors/src/domains/auth/InvalidHandoffCodeError';
import {
DESKTOP_HANDOFF_CODE_ALPHABET,
DESKTOP_HANDOFF_CODE_LENGTH,
formatDesktopHandoffCode,
parseDesktopHandoffCode,
} from '@fluxer/schema/src/domains/auth/DesktopHandoffCode';
import {ms, seconds} from 'itty-time';
const HANDOFF_CODE_PREFIX = 'desktop-handoff-v2:';
const HANDOFF_TOKEN_PREFIX = 'desktop-handoff-token:';
const HANDOFF_ATTEMPT_PREFIX = 'desktop-handoff-attempts:';
const HANDOFF_APPROVER_PREFIX = 'desktop-handoff-approver:';
const MAX_FAILED_ATTEMPTS = 5;
const ATTEMPT_TTL_SECONDS = 900;
const MAX_INFO_LOOKUPS = 3;
const POLL_SECRET_BYTES = 32;
interface HandoffData {
createdAt: number;
origin: SessionOrigin;
initiatorOrigin?: string | null;
infoLookupCount: number;
pollSecretHash: string;
}
interface HandoffTokenData {
token: string;
userId: string;
pollSecretHash: string;
}
interface HandoffApproverData {
approvedAt: number;
}
function generateNormalizedHandoffCode(): string {
const maxUnbiased = 256 - (256 % DESKTOP_HANDOFF_CODE_ALPHABET.length);
let code = '';
while (code.length < DESKTOP_HANDOFF_CODE_LENGTH) {
const bytes = randomBytes(DESKTOP_HANDOFF_CODE_LENGTH - code.length);
for (let i = 0; i < bytes.length && code.length < DESKTOP_HANDOFF_CODE_LENGTH; i++) {
if (bytes[i] < maxUnbiased) {
code += DESKTOP_HANDOFF_CODE_ALPHABET[bytes[i] % DESKTOP_HANDOFF_CODE_ALPHABET.length];
}
}
}
return code;
}
function requireNormalizedHandoffCode(code: string): string {
const normalized = parseDesktopHandoffCode(code);
if (normalized == null) {
throw new InvalidHandoffCodeError();
}
return normalized;
}
function generatePollSecret(): string {
return randomBytes(POLL_SECRET_BYTES).toString('base64url');
}
function hashPollSecret(secret: string): string {
return createHash('sha256').update(secret).digest('hex');
}
function pollSecretMatches(presented: string | undefined, storedHash: string | undefined): boolean {
if (!presented || !storedHash) {
return false;
}
const presentedHash = Buffer.from(hashPollSecret(presented), 'hex');
const stored = Buffer.from(storedHash, 'hex');
if (presentedHash.length !== stored.length) {
return false;
}
return timingSafeEqual(presentedHash, stored);
}
export class DesktopHandoffService {
constructor(private readonly apiContext: ApiContext) {}
async initiateHandoff(args: {origin: SessionOrigin; initiatorOrigin?: string | null}): Promise<{
code: string;
expiresAt: Date;
pollSecret: string;
}> {
const {cache} = this.apiContext.services;
const normalizedCode = generateNormalizedHandoffCode();
const pollSecret = generatePollSecret();
const handoffData: HandoffData = {
createdAt: Date.now(),
origin: args.origin,
initiatorOrigin: args.initiatorOrigin ?? null,
infoLookupCount: 0,
pollSecretHash: hashPollSecret(pollSecret),
};
const expirySeconds = seconds('5 minutes');
await cache.set(`${HANDOFF_CODE_PREFIX}${normalizedCode}`, handoffData, expirySeconds);
const expiresAt = new Date(Date.now() + ms('5 minutes'));
return {code: formatDesktopHandoffCode(normalizedCode), expiresAt, pollSecret};
}
async completeHandoff(
code: string,
createTokenData: (origin: SessionOrigin) => Promise<{token: string; userId: string}>,
approverIp: string,
): Promise<{initiatorOrigin: string | null}> {
const {cache} = this.apiContext.services;
const normalizedCode = requireNormalizedHandoffCode(code);
await this.checkAttemptLimit(approverIp);
const storedApprover = await cache.get<HandoffApproverData>(`${HANDOFF_APPROVER_PREFIX}${normalizedCode}`);
if (!storedApprover) {
await this.recordFailedAttempt(approverIp);
throw new InvalidHandoffCodeError();
}
const handoffData = await cache.get<HandoffData>(`${HANDOFF_CODE_PREFIX}${normalizedCode}`);
if (!handoffData) {
await this.recordFailedAttempt(approverIp);
throw new InvalidHandoffCodeError();
}
const remainingSeconds = Math.max(
0,
seconds('5 minutes') - Math.floor((Date.now() - handoffData.createdAt) / 1000),
);
if (remainingSeconds <= 0) {
throw new HandoffCodeExpiredError();
}
const {token, userId} = await createTokenData(handoffData.origin);
const tokenData: HandoffTokenData = {
token,
userId,
pollSecretHash: handoffData.pollSecretHash,
};
await cache.set(`${HANDOFF_TOKEN_PREFIX}${normalizedCode}`, tokenData, remainingSeconds);
await cache.delete(`${HANDOFF_CODE_PREFIX}${normalizedCode}`);
await cache.delete(`${HANDOFF_APPROVER_PREFIX}${normalizedCode}`);
return {initiatorOrigin: handoffData.initiatorOrigin ?? null};
}
async getHandoffInfo(
code: string,
approverIp: string,
): Promise<{
status: 'pending' | 'expired';
origin?: SessionOrigin;
}> {
const {cache} = this.apiContext.services;
const normalizedCode = requireNormalizedHandoffCode(code);
await this.checkAttemptLimit(approverIp);
const codeKey = `${HANDOFF_CODE_PREFIX}${normalizedCode}`;
const handoffData = await cache.get<HandoffData>(codeKey);
if (!handoffData) {
await this.recordFailedAttempt(approverIp);
return {status: 'expired'};
}
if (handoffData.infoLookupCount >= MAX_INFO_LOOKUPS) {
throw new InvalidHandoffCodeError();
}
const remainingTtl = await cache.ttl(codeKey);
if (remainingTtl > 0) {
handoffData.infoLookupCount += 1;
await cache.set(codeKey, handoffData, remainingTtl);
}
await cache.set<HandoffApproverData>(
`${HANDOFF_APPROVER_PREFIX}${normalizedCode}`,
{approvedAt: Date.now()},
remainingTtl > 0 ? remainingTtl : seconds('5 minutes'),
);
return {status: 'pending', origin: handoffData.origin};
}
async getHandoffStatus(
code: string,
pollerIp: string,
pollSecret: string | undefined,
): Promise<{
status: 'pending' | 'completed' | 'expired';
token?: string;
userId?: string;
}> {
const {cache} = this.apiContext.services;
const normalizedCode = requireNormalizedHandoffCode(code);
await this.checkAttemptLimit(pollerIp);
const tokenKey = `${HANDOFF_TOKEN_PREFIX}${normalizedCode}`;
const tokenData = await cache.get<HandoffTokenData>(tokenKey);
if (tokenData) {
if (!pollSecretMatches(pollSecret, tokenData.pollSecretHash)) {
await this.recordFailedAttempt(pollerIp);
return {status: 'pending'};
}
await cache.delete(tokenKey);
return {
status: 'completed',
token: tokenData.token,
userId: tokenData.userId,
};
}
const handoffData = await cache.get<HandoffData>(`${HANDOFF_CODE_PREFIX}${normalizedCode}`);
if (handoffData) {
return {status: 'pending'};
}
return {status: 'expired'};
}
async cancelHandoff(code: string, pollSecret: string): Promise<void> {
const {cache} = this.apiContext.services;
const normalizedCode = requireNormalizedHandoffCode(code);
const codeKey = `${HANDOFF_CODE_PREFIX}${normalizedCode}`;
const tokenKey = `${HANDOFF_TOKEN_PREFIX}${normalizedCode}`;
const handoffData = await cache.get<HandoffData>(codeKey);
const tokenData = await cache.get<HandoffTokenData>(tokenKey);
const storedHash = handoffData?.pollSecretHash ?? tokenData?.pollSecretHash;
if (!pollSecretMatches(pollSecret, storedHash)) {
throw new InvalidHandoffCodeError();
}
await cache.delete(codeKey);
await cache.delete(tokenKey);
await cache.delete(`${HANDOFF_APPROVER_PREFIX}${normalizedCode}`);
}
private async checkAttemptLimit(clientIp: string): Promise<void> {
const {cache} = this.apiContext.services;
const count = await cache.get<number>(`${HANDOFF_ATTEMPT_PREFIX}${clientIp}`);
if (count != null && count >= MAX_FAILED_ATTEMPTS) {
throw new InvalidHandoffCodeError();
}
}
private async recordFailedAttempt(clientIp: string): Promise<void> {
const {cache} = this.apiContext.services;
const key = `${HANDOFF_ATTEMPT_PREFIX}${clientIp}`;
const current = await cache.get<number>(key);
await cache.set(key, (current ?? 0) + 1, ATTEMPT_TTL_SECONDS);
}
}