MasterKeyManager.loadKeytar() now bails out early when FUSION_MASTER_KEY_DISABLE_KEYCHAIN=1, and the core vitest setup sets that flag for every worker. Eight tests across master-key/secrets-store/ secrets-sync-passphrase were timing out at exactly the 15s testTimeout because they constructed MasterKeyManager without injecting a fake KeytarLike, which made loadKeytar() reach the real OS keychain. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
245 lines
7.1 KiB
TypeScript
245 lines
7.1 KiB
TypeScript
import { randomBytes } from "node:crypto";
|
|
import * as fs from "node:fs/promises";
|
|
import { join } from "node:path";
|
|
import { createRequire } from "node:module";
|
|
import { resolveGlobalDir } from "./global-settings.js";
|
|
|
|
export const MASTER_KEY_KEYCHAIN_SERVICE = "fusion";
|
|
export const MASTER_KEY_KEYCHAIN_ACCOUNT = "master-key";
|
|
export const MASTER_KEY_FILENAME = "master.key";
|
|
|
|
export type KeytarLike = {
|
|
getPassword(service: string, account: string): Promise<string | null>;
|
|
setPassword(service: string, account: string, password: string): Promise<void>;
|
|
deletePassword(service: string, account: string): Promise<boolean>;
|
|
};
|
|
|
|
export class MasterKeyPermissionError extends Error {
|
|
constructor(message = "master key file permissions must be 0600") {
|
|
super(message);
|
|
this.name = "MasterKeyPermissionError";
|
|
}
|
|
}
|
|
|
|
export class MasterKeyCorruptError extends Error {
|
|
constructor(public readonly backend: "keychain" | "file", message: string) {
|
|
super(message);
|
|
this.name = "MasterKeyCorruptError";
|
|
}
|
|
}
|
|
|
|
type FsLike = Pick<typeof fs, "mkdir" | "open" | "chmod" | "stat" | "readFile">;
|
|
|
|
export class MasterKeyManager {
|
|
private readonly globalDir: string;
|
|
private readonly filePath: string;
|
|
private readonly injectedKeytar?: KeytarLike;
|
|
private readonly fsModule: FsLike;
|
|
|
|
constructor(options?: { globalDir?: string; keytarModule?: KeytarLike; fsModule?: FsLike }) {
|
|
this.globalDir = resolveGlobalDir(options?.globalDir);
|
|
this.filePath = join(this.globalDir, MASTER_KEY_FILENAME);
|
|
this.injectedKeytar = options?.keytarModule;
|
|
this.fsModule = options?.fsModule ?? fs;
|
|
}
|
|
|
|
async getOrCreateKey(): Promise<Buffer> {
|
|
const keychainKey = await this.readKeychainKey();
|
|
if (keychainKey) {
|
|
return keychainKey;
|
|
}
|
|
|
|
const fileKey = await this.readFileKey();
|
|
if (fileKey) {
|
|
return fileKey;
|
|
}
|
|
|
|
const generated = randomBytes(32);
|
|
const persisted = await this.persistNewKeyWithRaceHandling(generated);
|
|
console.info(`master key created (${persisted.backend})`);
|
|
return persisted.key;
|
|
}
|
|
|
|
async rotateKey(): Promise<Buffer> {
|
|
const next = randomBytes(32);
|
|
const backend = await this.getBackend();
|
|
|
|
if (backend === "file") {
|
|
await this.writeFileKey(next, { overwrite: true });
|
|
console.info("master key rotated (file)");
|
|
return next;
|
|
}
|
|
|
|
if (backend === "keychain") {
|
|
const wroteKeychain = await this.writeKeychainKey(next);
|
|
if (!wroteKeychain) {
|
|
throw new Error("unable to rotate master key in active keychain backend");
|
|
}
|
|
console.info("master key rotated (keychain)");
|
|
return next;
|
|
}
|
|
|
|
const persisted = await this.persistNewKeyWithRaceHandling(next);
|
|
console.info(`master key rotated (${persisted.backend})`);
|
|
return persisted.key;
|
|
}
|
|
|
|
async getBackend(): Promise<"keychain" | "file" | "missing"> {
|
|
const keychainKey = await this.readKeychainKey();
|
|
if (keychainKey) {
|
|
return "keychain";
|
|
}
|
|
|
|
const fileKey = await this.readFileKey();
|
|
if (fileKey) {
|
|
return "file";
|
|
}
|
|
|
|
return "missing";
|
|
}
|
|
|
|
private async persistNewKeyWithRaceHandling(
|
|
generated: Buffer,
|
|
): Promise<{ key: Buffer; backend: "keychain" | "file" }> {
|
|
const keytar = await this.loadKeytar();
|
|
if (keytar) {
|
|
const raced = await this.readKeychainKey();
|
|
if (raced) {
|
|
return { key: raced, backend: "keychain" };
|
|
}
|
|
try {
|
|
await keytar.setPassword(
|
|
MASTER_KEY_KEYCHAIN_SERVICE,
|
|
MASTER_KEY_KEYCHAIN_ACCOUNT,
|
|
generated.toString("base64"),
|
|
);
|
|
return { key: generated, backend: "keychain" };
|
|
} catch {
|
|
const afterRace = await this.readKeychainKey();
|
|
if (afterRace) {
|
|
return { key: afterRace, backend: "keychain" };
|
|
}
|
|
console.warn("master key keychain unavailable; using file backend");
|
|
}
|
|
}
|
|
|
|
const racedFile = await this.readFileKey();
|
|
if (racedFile) {
|
|
return { key: racedFile, backend: "file" };
|
|
}
|
|
|
|
try {
|
|
await this.writeFileKey(generated, { overwrite: false });
|
|
return { key: generated, backend: "file" };
|
|
} catch (error) {
|
|
if (error instanceof MasterKeyPermissionError) {
|
|
throw error;
|
|
}
|
|
const afterRace = await this.readFileKey();
|
|
if (afterRace) {
|
|
return { key: afterRace, backend: "file" };
|
|
}
|
|
throw new Error("failed to persist master key", { cause: error });
|
|
}
|
|
}
|
|
|
|
private async readKeychainKey(): Promise<Buffer | null> {
|
|
const keytar = await this.loadKeytar();
|
|
if (!keytar) {
|
|
return null;
|
|
}
|
|
|
|
try {
|
|
const value = await keytar.getPassword(
|
|
MASTER_KEY_KEYCHAIN_SERVICE,
|
|
MASTER_KEY_KEYCHAIN_ACCOUNT,
|
|
);
|
|
if (!value) {
|
|
return null;
|
|
}
|
|
const decoded = Buffer.from(value, "base64");
|
|
if (decoded.length !== 32 || decoded.toString("base64") !== value) {
|
|
throw new MasterKeyCorruptError("keychain", "keychain master key is corrupt");
|
|
}
|
|
return decoded;
|
|
} catch (error) {
|
|
if (error instanceof MasterKeyCorruptError) {
|
|
throw error;
|
|
}
|
|
console.warn("master key keychain unavailable; using file backend");
|
|
return null;
|
|
}
|
|
}
|
|
|
|
private async readFileKey(): Promise<Buffer | null> {
|
|
try {
|
|
const value = await this.fsModule.readFile(this.filePath);
|
|
if (value.length !== 32) {
|
|
throw new MasterKeyCorruptError("file", "file master key is corrupt");
|
|
}
|
|
return value;
|
|
} catch (error) {
|
|
if (error instanceof MasterKeyCorruptError) {
|
|
throw error;
|
|
}
|
|
if ((error as NodeJS.ErrnoException).code === "ENOENT") {
|
|
return null;
|
|
}
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
private async writeFileKey(value: Buffer, options: { overwrite: boolean }): Promise<void> {
|
|
await this.fsModule.mkdir(this.globalDir, { recursive: true });
|
|
const handle = await this.fsModule.open(this.filePath, options.overwrite ? "w" : "wx");
|
|
try {
|
|
await handle.writeFile(value);
|
|
} finally {
|
|
await handle.close();
|
|
}
|
|
await this.fsModule.chmod(this.filePath, 0o600);
|
|
const fileStat = await this.fsModule.stat(this.filePath);
|
|
if ((fileStat.mode & 0o777) !== 0o600) {
|
|
throw new MasterKeyPermissionError();
|
|
}
|
|
}
|
|
|
|
private async writeKeychainKey(value: Buffer): Promise<boolean> {
|
|
const keytar = await this.loadKeytar();
|
|
if (!keytar) {
|
|
return false;
|
|
}
|
|
|
|
try {
|
|
await keytar.setPassword(
|
|
MASTER_KEY_KEYCHAIN_SERVICE,
|
|
MASTER_KEY_KEYCHAIN_ACCOUNT,
|
|
value.toString("base64"),
|
|
);
|
|
return true;
|
|
} catch {
|
|
console.warn("master key keychain unavailable; using file backend");
|
|
return false;
|
|
}
|
|
}
|
|
|
|
private async loadKeytar(): Promise<KeytarLike | null> {
|
|
if (this.injectedKeytar) {
|
|
return this.injectedKeytar;
|
|
}
|
|
|
|
if (process.env.FUSION_MASTER_KEY_DISABLE_KEYCHAIN === "1") {
|
|
return null;
|
|
}
|
|
|
|
try {
|
|
const require = createRequire(import.meta.url);
|
|
const modName = `key${"tar"}`;
|
|
const module = require(modName) as { default?: KeytarLike } & KeytarLike;
|
|
return module.default ?? module;
|
|
} catch {
|
|
return null;
|
|
}
|
|
}
|
|
}
|