failproofai 1.0.0-beta.2 → 1.0.0-beta.21

package/src/hooks/collector-config.ts

@@ -0,0 +1,218 @@
+/**
+ * Writing the collector's configuration from the setup wizard.
+ *
+ * Two files, deliberately:
+ *
+ *   ~/.failproofai/credentials.toml  mode 0600, including the ingest credential
+ *   ~/.failproofai/config.toml       non-secret collector settings
+ *
+ * The split keeps bearer credentials out of the human-readable configuration
+ * file and gives every token the same owner-only storage boundary.
+ *
+ * The Rust daemon reads both (see `crates/fpai-collect/src/config.rs`); this is
+ * the only thing that writes them.
+ */
+import { credentialsFile, failproofaiHome as layoutHome } from "./fp-home";
+import { readCredentials, writeCredentials, updateConfig } from "./fp-config";
+
+/**
+ * The hosted ingest endpoint — a COMPLETE endpoint, not a base to join onto.
+ *
+ * The DASHBOARD hostname, not the API server's. On the hosted deployment a
+ * reverse proxy routes `/v1/*` and `/enforcement/v1/*` to the server and
+ * everything else to the Next.js app, so this path already reaches ingest —
+ * the server hostname is not needed to get there and does not need to be a
+ * public name for the product to work.
+ *
+ * One hostname is also what makes `--connect <origin>` mean one thing. Ingest,
+ * key introspection (`/v1/auth/introspect`) and cloud-managed policy
+ * (`/enforcement/v1/*`) all resolve against the same origin someone pastes,
+ * which is the origin they already have in their browser.
+ *
+ * MUST stay byte-identical to `DEFAULT_INGEST_URL` in
+ * `crates/fpai-collect/src/config.rs` — see that copy for why.
+ */
+export const DEFAULT_INGEST_URL = "https://app.befailproof.ai/v1/events";
+
+export interface IngestCredential {
+  url: string;
+  key: string;
+}
+
+export interface CollectorSettings {
+  /** Ship agent session transcripts. Separate opt-in from having a key. */
+  sessions: boolean;
+  /** Ship hook activity. */
+  hooks: boolean;
+  hooksVerbosity?: "all" | "decisions" | "off";
+  redact?: "minimal" | "off";
+  environment?: string;
+  /**
+   * The machine's id, so the daemon can stamp it on every collected event and
+   * the dashboard groups by machine rather than by `agent_id` (a per-project
+   * identity). Written by `--connect --machine-id`; the Rust collector reads it
+   * as `collector.machineId`.
+   */
+  machineId?: string;
+}
+
+export function failproofaiHome(): string {
+  return layoutHome();
+}
+
+export function ingestPath(): string {
+  return credentialsFile();
+}
+
+/** Whether an ingest credential is already configured on this machine. */
+export function hasIngestCredential(): boolean {
+  return Boolean(readCredentials().ingest);
+}
+
+/**
+ * The stored ingest credential, or null.
+ *
+ * Malformed JSON reads as absent rather than throwing: this is called from
+ * `--status`, and a status command that crashes on a corrupt file is worse
+ * than one reporting the capability as unconfigured — which, given the daemon
+ * cannot read it either, is the truth.
+ */
+export function readIngestCredential(): IngestCredential | null {
+  const ingest = readCredentials().ingest;
+  return ingest ? { url: ingest.url, key: ingest.key } : null;
+}
+
+/** Remove the ingest credential. Returns whether a file was actually removed. */
+export function clearIngestCredential(): boolean {
+  const current = readCredentials();
+  if (!current.ingest) return false;
+  // Drop only the ingest table: stopping event reporting must not also revoke
+  // the policy-pull credential or the dashboard session.
+  const { ingest: _dropped, ...rest } = current;
+  writeCredentials(rest);
+  return true;
+}
+
+/**
+ * Write the credential at owner-only permissions, and tighten the home that
+ * holds it.
+ *
+ * A 0600 file inside a 0775 directory is still reachable by every local user,
+ * so the directory is tightened too. Both are best-effort on a filesystem
+ * without POSIX modes; the write itself is not.
+ */
+export function writeIngestCredential(cred: IngestCredential): string {
+  // Merge, never replace — credentials.toml also holds the cloud token and the
+  // auth session, and one caller rewriting the file must not drop the others.
+  // writeCredentials owns the 0600 mode and tightens the home around it.
+  writeCredentials({ ...readCredentials(), ingest: cred });
+  return credentialsFile();
+}
+
+/** Merge the collector block into the shared (non-secret) config. */
+export function writeCollectorSettings(settings: CollectorSettings): void {
+  // Collector preferences are NOT secret, so they live in config.json. The key
+  // that makes them meaningful lives in credentials.toml; that split is the
+  // whole point of layout 2.
+  updateConfig({
+    collector: {
+      sessions: settings.sessions,
+      hooks: settings.hooks,
+      hooksVerbosity: settings.hooksVerbosity ?? "decisions",
+      redact: settings.redact ?? "minimal",
+      environment: settings.environment ?? "local",
+      machineId: settings.machineId,
+    },
+  });
+}
+
+export type KeyCheck =
+  | { ok: true }
+  | { ok: false; reason: string };
+
+/**
+ * Verify a key against the endpoint before writing it anywhere.
+ *
+ * Sends an EMPTY body: ingest answers `{"accepted":0,"skipped":0}` for it, so
+ * the round-trip proves the URL resolves and the key authenticates without
+ * creating a spurious event in the user's dashboard.
+ *
+ * Failing here at setup is the whole point — otherwise a typo'd key is only
+ * discovered later as a silent pile of 401s in `failed/`, which reads like a
+ * server problem rather than a typo.
+ */
+export async function validateIngestKey(
+  cred: IngestCredential,
+  fetchImpl: typeof fetch = fetch,
+  timeoutMs = 10_000,
+): Promise<KeyCheck> {
+  const controller = new AbortController();
+  const timer = setTimeout(() => controller.abort(), timeoutMs);
+  try {
+    const res = await fetchImpl(cred.url, {
+      method: "POST",
+      headers: {
+        Authorization: `Bearer ${cred.key}`,
+        "Content-Type": "application/x-ndjson",
+      },
+      body: "",
+      // Never follow a redirect. `fetch` follows by default, and the dashboard
+      // (which sits on a different port of the same host, and is printed during
+      // setup right beside the API) answers POST /events with a 307 to its
+      // login page — which then returns 200. So `res.ok` was true for an
+      // endpoint that authenticates nothing and stores nothing: the credential
+      // was written, setup reported success, and every batch afterwards was
+      // POSTed into a login form and lost. Confusing the two URLs is the most
+      // likely mistake available here.
+      redirect: "manual",
+      signal: controller.signal,
+    });
+    if (res.status >= 300 && res.status < 400) {
+      return {
+        ok: false,
+        reason:
+          "that URL redirects rather than accepting events — it looks like the dashboard, not the ingest API",
+      };
+    }
+    if (res.status === 401 || res.status === 403) {
+      return { ok: false, reason: `the server rejected that key (${res.status})` };
+    }
+    if (res.status === 404) {
+      return { ok: false, reason: `no ingest endpoint at that URL (404)` };
+    }
+    if (!res.ok) {
+      return { ok: false, reason: `the server answered ${res.status}` };
+    }
+    // A 2xx is not enough either. Ingest answers `{"accepted":N,"skipped":M}`;
+    // anything else returning 200 (a proxy, a static host, a catch-all router)
+    // would otherwise pass. Requiring the shape is what actually proves this is
+    // the endpoint the uploader will be talking to.
+    let body: unknown;
+    try {
+      body = await res.json();
+    } catch {
+      return {
+        ok: false,
+        reason: "that URL answered without an ingest response — it is not the events endpoint",
+      };
+    }
+    const shaped =
+      typeof body === "object" &&
+      body !== null &&
+      typeof (body as { accepted?: unknown }).accepted === "number";
+    if (!shaped) {
+      return {
+        ok: false,
+        reason: "that URL answered, but not with an ingest response — it is not the events endpoint",
+      };
+    }
+    return { ok: true };
+  } catch (err) {
+    const msg = err instanceof Error ? err.message : String(err);
+    // Deliberately does not echo the URL back: it may contain a hostname the
+    // user would rather not see in a shared terminal recording.
+    return { ok: false, reason: `could not reach the server (${msg})` };
+  } finally {
+    clearTimeout(timer);
+  }
+}