@tomato414941/foundation 0.2.0 → 0.4.0

package/guide.mjs

@@ -28,26 +28,33 @@ export function guide(connectors) {
     'Never ask the owner to paste passwords, keys or tokens into chat. Use a storage request or OAuth URL instead.', '',
     'WHO YOU ARE',
     '   Everything that comes to Foundation is a principal: a person, an AI, an app. You are one, and your key is what',
-    '   proves it: a secret of your own making, 43 URL-safe base64 characters after `fdn_`. Generate one, keep it private,',
-    '   and never print it. If you can write a private file, keep it there; otherwise keep it wherever your secrets go.',
+    '   proves it. Foundation issues it, once, and shows it once: keep it private and never print it. If you can write a',
+    '   private file, keep it there; otherwise keep it wherever your secrets go.',
+    '   POST /v1/principals  {"name": "<what to call you>"}   with no credential at all. Makes you, and answers with token.',
     '   What you may reach follows from lines between principals: whoever you act for (actor), whoever made you (owner).',
     '   POST /v1/requests  {"kind": "actor", "input": {"name": "<what to call you>"}}   with your key as the bearer.',
     '     Asks whoever opens it to let you act for them. Returns verification_uri and confirmation_code. Give the person',
-    '     both; they open the URL and type the code. Until they do you act for nobody: everything below answers as',
-    '     your own, empty, holdings. Retry GET /v1/principals/me every few seconds and look at acts_for. Do not hammer it.',
+    '     both; they open the URL and type the code. Until they do you act for nobody. Retry GET /v1/principals/me every',
+    '     few seconds and look at acts_for. Do not hammer it.',
     '   GET /v1/principals/me    who you are: principal, acts_for (whom you act for), owners, credentials, your open requests.',
-    '     Acting for exactly one principal, their holdings are what the calls below reach. For several, name one: ?as=<id>.',
+    '     Every call below reaches your own holdings unless you name whose: ?as=<id of one you act for>. The foundation CLI',
+    '     and the MCP tool add ?as= for you when you act for exactly one; over raw HTTP, add it yourself.',
     '   PATCH /v1/principals/me {"name"}    DELETE /v1/principals/me    a new name; leaving (your key stops working).',
     '   GET /v1/requests/<id>   one of your requests and what happened at its page (events).   DELETE cancels it.',
-    '   GET /v1/relations   every line you are on.   GET /v1/records   what was done in your name or to you.', '',
+    '   GET /v1/relations   every line you are on.   GET /v1/records   what was done in your name or to you.',
+    '   Everything kept has an id, shown in every listing. The holder shows one thing to another principal with',
+    '   POST /v1/relations {"subject":"<principal id>","relation":"viewer"|"editor","object_type":"holding","object_id":"<id>"}   DELETE takes it back.',
+    '   GET /v1/holdings   what others have shown you.   GET /v1/holdings/<id>   one thing, whoever holds it.',
+    '   GET /v1/holdings/<id>/content   reads it; PUT writes it, as editor. Lines point at the id, so renaming changes nothing.', '',
     'WHAT IS KEPT',
-    '   PUT /v1/secrets?name=<name>&secret=true    body: raw bytes, up to 1MB. The same exact name replaces that value.',
-    '     secret=true blocks direct GET by an access key. The owner can read it; authorized delivery can still return it.',
-    '     This is not a boundary against an agent with the approved key. Do not print delivered values into its context.',
-    '   GET /v1/secrets    names, sizes, read permissions and timestamps, not contents.',
-    '   GET /v1/secrets?prefix=<literal prefix>   optional case-sensitive text filtering, not a directory.',
-    '   GET /v1/secrets?name=<name>               bytes, as written; 403 write_only for a secret.',
-    '   DELETE /v1/secrets?name=<name>',
+    '   PUT /v1/holdings?kind=secret&name=<name>    body: raw bytes, up to 1MB. The same exact name replaces that value; the answer carries its id.',
+    '     What you keep for the holder you may read back (an editor line is drawn for you). What the holder kept, or a',
+    '     connection handed over, you may deliver into a command but not read, unless the holder draws you a line.',
+    '     Do not print delivered values into your context.',
+    '   GET /v1/holdings?kind=secret    ids, names, sizes and timestamps, not contents. &prefix=<literal prefix> narrows by text, not directory.',
+    '   GET /v1/holdings?kind=secret&name=<name>   the one thing by name: its id and metadata. 404 if no such name.',
+    '   GET /v1/holdings/<id>/content    bytes, as written; 403 forbidden without a line to it.   PUT writes them.',
+    '   PATCH /v1/holdings/<id> {"name"}    a new name for the same thing.   DELETE /v1/holdings/<id>   removes it.',
     '   URL-encode the name. A name is any text, which is why it travels as a query and not as a path. Names are 1-200 characters without control characters; case, spaces, slashes and punctuation',
     '   remain literal. No normalization, hierarchy, service ownership or automatic renewal is inferred.',
     '   The owner can read, rename or delete any saved value. Stored copies survive OAuth disconnection.', '',
@@ -60,7 +67,7 @@ export function guide(connectors) {
     '     Calling this into an agent context exposes values. Use exec when the intent is to run a local command.', '',
     'FILLING THE STORE',
     '',
-    '1. Put it there yourself. Anything you obtained or wrote: PUT /v1/secrets?name=<name>, above.',
+    '1. Put it there yourself. Anything you obtained or wrote: PUT /v1/holdings?kind=secret&name=<name>, above.',
     '',
     '2. ASKING THE OWNER, for what only they can fetch -- an API token, a key, a certificate they must go and create.',
     '   POST /v1/requests  {"kind":"store", "input":{"fields":[{...}]}, "purpose":"...", "steps":["..."], "valid_minutes":30}',
@@ -68,7 +75,7 @@ export function guide(connectors) {
     '     fields[].label     what they are being asked for, in their language. It titles the screen and names the field.',
 
     '     fields[].site      the page where they make it, offered as a link',
-    '     fields[].secret    false lets you read it back afterwards; the default is that you cannot',
+    '     fields[].readable  true asks to read it back afterwards (a viewer line); the default is that you cannot',
     '     fields[].multiline true for something like a PEM',
     '     fields[].replace   true to put the value in place of the one already kept under that exact name (rotation).',
     '                     Refused at creation: name_taken when the name exists and replace is not declared, name_missing',
@@ -109,9 +116,10 @@ export function guide(connectors) {
     '   reconnect_required (the service rejected it) / already_connected. A key approval shows its own events at',
     '   GET /v1/requests/<id>: confirmation_required (a wrong code) / confirmation_locked (5 tries).', '',
     'A PLACE FOR FILES (object storage the owner did not have to sign up for)',
-    '   PUT /v1/objects/<key>      body is the bytes; the Content-Type you send is what a reader gets back. Up to 25MB.',
-    '   GET /v1/objects/<key>      the bytes. DELETE removes it. GET /v1/objects?prefix=<p>&cursor=<c> lists what is there.',
-    '   POST /v1/objects/<key>/link {"minutes":n}   a time-limited URL anyone can read, for a thing that only takes a URL.',
+    '   PUT /v1/holdings?kind=object&name=<key>   body is the bytes; the Content-Type you send is what a reader gets back. Up to 25MB.',
+    '   GET /v1/holdings?kind=object&prefix=<p>   lists what is there, with ids. &name=<key> finds one.',
+    '   GET /v1/holdings/<id>/content   the bytes. PUT writes them. DELETE /v1/holdings/<id> removes it. PATCH renames it.',
+    '   POST /v1/holdings/<id>/link {"minutes":n}   a time-limited URL anyone can read, for a thing that only takes a URL.',
     '   Keys look like a path (a/b/c.txt) but name one whole object: no renaming, no directories, no partial reads or writes.',
     '   This is not a filesystem. If the owner needs one, they need a machine to mount it on.',
     '   Where the bytes live is the owner\'s business: a space lent to them now, a bucket of their own later. Nothing you call changes.', '',
@@ -143,7 +151,7 @@ export function guide(connectors) {
     '     Use this instead of POST /v1/deliveries whenever the point is to run something.',
     `   foundation exec --output '{"name":"login config","as":"AUTH_FILE","filename":"auth.json"}' -- <command>`,
     '     Creates one empty private file and sets as to its path. Tell the command to write its authentication result there.',
-    '     After exit 0, saves the file bytes under the exact name with secret=true, then removes the temporary file.',
+    '     After exit 0, saves the file bytes under the exact name, then removes the temporary file.',
     '     An existing value at that name is replaced. Output must be a private regular file containing 1 byte to 1MB.',
     '     May be combined with inputs, using a different environment variable. A failed command never saves its output.',
     '     If upload cannot be confirmed, exits with an error and reports the retained private file for recovery; inputs are',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomato414941/foundation",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Foundation CLI: make a key, and hand what is kept to a command without it passing through the agent.",
   "type": "module",
   "engines": {

package/runtime.mjs

@@ -3,7 +3,7 @@ import { open, mkdir, stat, lstat, mkdtemp, writeFile, chmod, readFile, rename }
 import { parseArgs } from 'node:util';
 import { rmSync, readdirSync, constants } from 'node:fs';
 import { spawn } from 'node:child_process';
-import { createHash, randomBytes } from 'node:crypto';
+import { createHash } from 'node:crypto';
 import { homedir, hostname, tmpdir } from 'node:os';
 import { dirname, join } from 'node:path';
 import { createRequire } from 'node:module';
@@ -21,21 +21,9 @@ import { guide } from './guide.mjs';
 // There is also `api`, which is for people and for scripts rather than for agents: it attaches the key to a
 // request and prints what comes back. One escape hatch, so that the API can grow without this program growing
 // a verb for every endpoint, and without deciding for an agent how it ought to use any of them.
-async function runtimeKey(path, create, privateDirectory) {
-  if (create) {
-    await mkdir(dirname(path), { recursive: true, mode: 0o700 });
-    if (privateDirectory) {
-      const directory = await stat(dirname(path));
-      if ((directory.mode & 0o077) || (process.getuid && directory.uid !== process.getuid())) throw new Error('Foundation key directory must be owned by the current user and private (mode 700).');
-    }
-    let created;
-    try {
-      created = await open(path, constants.O_WRONLY | constants.O_CREAT | constants.O_EXCL | constants.O_NOFOLLOW, 0o600);
-      await created.writeFile('fdn_' + randomBytes(32).toString('base64url') + '\n');
-      await created.sync();
-    } catch (error) { if (error.code !== 'EEXIST') throw error; }
-    finally { await created?.close(); }
-  }
+// The key file: what Foundation issued, kept private. Nothing here makes a key; Foundation does, once, when this
+// machine becomes a principal, and the file is the only place it lives afterwards.
+async function readKey(path, { missingOk = false } = {}) {
   let handle;
   try {
     handle = await open(path, constants.O_RDONLY | constants.O_NOFOLLOW | constants.O_NONBLOCK);
@@ -45,11 +33,20 @@ async function runtimeKey(path, create, privateDirectory) {
     if (!/^fdn_[A-Za-z0-9_-]{43}$/.test(token)) throw new Error('Invalid runtime key file.');
     return token;
   } catch (error) {
-    if (error.code === 'ENOENT') throw new Error('No key yet. Run: foundation connect');
+    if (error.code === 'ENOENT') { if (missingOk) return null; throw new Error('No key yet. Run: foundation connect'); }
     if (error.code === 'ELOOP') throw new Error('Runtime key file must not be a symbolic link.');
     throw error;
   } finally { await handle?.close(); }
 }
+async function writeKey(path, token, privateDirectory) {
+  await mkdir(dirname(path), { recursive: true, mode: 0o700 });
+  if (privateDirectory) {
+    const directory = await stat(dirname(path));
+    if ((directory.mode & 0o077) || (process.getuid && directory.uid !== process.getuid())) throw new Error('Foundation key directory must be owned by the current user and private (mode 700).');
+  }
+  const created = await open(path, constants.O_WRONLY | constants.O_CREAT | constants.O_TRUNC | constants.O_NOFOLLOW, 0o600);
+  try { await created.writeFile(token + '\n'); await created.sync(); } finally { await created.close(); }
+}
 
 const VERSION = createRequire(import.meta.url)('./package.json').version;
 // Which server this machine talks to is a setting, not part of the program: `connect <url>` writes it here,
@@ -185,7 +182,7 @@ async function main() {
   }
   const url = serverUrl(connectTo ?? configured);
   const keyPath = process.env.FOUNDATION_RUNTIME_KEY_FILE || join(homedir(), '.local', 'state', 'foundation', createHash('sha256').update(url.origin).digest('hex').slice(0, 24) + (agentName ? '-' + agentName.toLowerCase().replace(/[^a-z0-9]+/g, '-') : '') + '.key');
-  const token = await runtimeKey(keyPath, action === 'connect', !process.env.FOUNDATION_RUNTIME_KEY_FILE);
+  let token = await readKey(keyPath, { missingOk: action === 'connect' });
   async function send(target, payload, { accept, method = 'POST', type = 'application/json' } = {}) {
     const response = await fetch(url.origin + target, { method, headers: { authorization: 'Bearer ' + token, ...(payload === undefined ? {} : { 'content-type': type }) },
       body: payload === undefined ? undefined : type === 'application/json' ? JSON.stringify(payload) : payload, redirect: 'error', signal: AbortSignal.timeout(30_000) });
@@ -195,6 +192,10 @@ async function main() {
   }
   // One request, with the key attached and the answer printed as it came. Nothing here knows the endpoints.
   if (action === 'api') {
+    if (!/[?&]as=/.test(call.target)) {
+      const me = await send('/v1/principals/me', undefined, { method: 'GET', accept: () => true });
+      if (me.acts_for?.length === 1) call.target += (call.target.includes('?') ? '&' : '?') + 'as=' + encodeURIComponent(me.acts_for[0].id);
+    }
     const response = await fetch(url.origin + call.target, { method: call.method, headers: { authorization: 'Bearer ' + token, ...(call.body === undefined ? {} : { 'content-type': call.type }) },
       ...(call.body === undefined ? {} : { body: call.body }), redirect: 'error', signal: AbortSignal.timeout(30_000) });
     const bytes = Buffer.from(await response.arrayBuffer());
@@ -207,9 +208,18 @@ async function main() {
   // A key the owner already approved has nothing to ask; connecting again only changes which server is remembered.
   if (action === 'connect') {
     // A key someone already accepted has nothing to ask; connecting again only changes which server is remembered.
+    // No key, or one this server does not know: become a principal there first, and keep what it issues.
+    const wanted = name ?? hostname() + ' の ' + (agentName || 'AI');
     let me = null;
-    try { me = await send('/v1/principals/me', undefined, { method: 'GET' }); } catch {}
-    const answer = me?.acts_for?.length ? null : await send('/v1/requests', { kind: 'actor', input: { name: name ?? hostname() + ' の ' + (agentName || 'AI') } });
+    if (token) me = await send('/v1/principals/me', undefined, { method: 'GET', accept: data => data.error?.code === 'not_approved' });
+    if (!token || me?.error) {
+      const response = await fetch(url.origin + '/v1/principals', { method: 'POST', headers: { 'content-type': 'application/json' }, body: JSON.stringify({ name: wanted }), redirect: 'error', signal: AbortSignal.timeout(30_000) });
+      const made = await response.json();
+      if (!response.ok || !/^fdn_[A-Za-z0-9_-]{43}$/.test(made.token ?? '')) throw new Error('Foundation did not issue a key (' + response.status + ', ' + (made.error?.code || 'unknown') + ').');
+      await writeKey(keyPath, made.token, !process.env.FOUNDATION_RUNTIME_KEY_FILE);
+      token = made.token; me = null;
+    }
+    const answer = me?.acts_for?.length ? null : await send('/v1/requests', { kind: 'actor', input: { name: wanted } });
     if (connectTo !== undefined) await saveUrl(url.origin);
     console.log(answer === null ? 'Already approved on ' + url.origin + '.' : JSON.stringify(answer, null, 2));
     console.log('\nKey file: ' + keyPath + '\nServer: ' + url.origin + (connectTo !== undefined ? ' (saved to ' + configPath() + ')' : '') + '\nEverything else is HTTP: Authorization: Bearer <the contents of that file>');
@@ -219,8 +229,12 @@ async function main() {
   // and the person it asked has yet to answer.
   const current = await send('/v1/principals/me', undefined, { method: 'GET' });
   if (!current.acts_for?.length) throw new Error('Foundation request failed (401, not_approved). This key acts for nobody yet' + (current.requests?.[0] ? '; it is waiting for approval at ' + current.requests[0].verification_uri : '') + '.');
+  // Whose holdings a run reaches: the one this key acts for, or the one named when it acts for several.
+  const holder = process.env.FOUNDATION_AS || (current.acts_for.length === 1 ? current.acts_for[0].id : null);
+  if (!holder) throw new Error('This key acts for several principals. Set FOUNDATION_AS=<principal id> to say which one this run is for.');
+  const forHolder = target => target + (target.includes('?') ? '&' : '?') + 'as=' + encodeURIComponent(holder);
   let delivery;
-  if (names.length) ({ delivery } = await send('/v1/deliveries', { names }));
+  if (names.length) ({ delivery } = await send(forHolder('/v1/deliveries'), { names }));
   else delivery = { environment: {}, files: [] };
   if (!delivery || typeof delivery.environment !== 'object' || !Array.isArray(delivery.files)) throw new Error('Foundation returned an invalid delivery.');
   // What each of them sets is the server's to say; this applies it and refuses anything it may not set.
@@ -250,7 +264,7 @@ async function main() {
       }
     }
   };
-  const recovery = () => 'Foundation could not confirm the output was saved. The private output file is retained for recovery: ' + outputPath + '\nRetry with foundation api PUT "/v1/secrets?name=<URL-encoded-name>&secret=true" --from <file>, then remove that recovery file.';
+  const recovery = () => 'Foundation could not confirm the output was saved. The private output file is retained for recovery: ' + outputPath + '\nRetry with foundation api PUT "/v1/holdings?kind=secret&name=<URL-encoded-name>" --from <file>, then remove that recovery file.';
   process.once('exit', cleanup);
   for (const signal of ['SIGINT', 'SIGTERM', 'SIGHUP']) process.once(signal, () => {
     interrupted = true;
@@ -287,8 +301,11 @@ async function main() {
     if (output && process.exitCode === 0) {
       const bytes = await outputBytes(outputPath);
       retainOutput = true;
-      try { await send('/v1/secrets?name=' + encodeURIComponent(output.name) + '&secret=true', bytes, { method: 'PUT', type: 'application/octet-stream' }); }
+      // The command wrote it; the agent never saw it, and keeps it that way: the line drawn for the one who kept it is declined.
+      let saved;
+      try { saved = await send(forHolder('/v1/holdings?kind=secret&name=' + encodeURIComponent(output.name)), bytes, { method: 'PUT', type: 'application/octet-stream' }); }
       catch { throw new Error(recovery()); }
+      try { await send('/v1/relations', { relation: 'editor', object_type: 'holding', object_id: saved.holding.id }, { method: 'DELETE' }); } catch {}
       retainOutput = false;
       console.error('Saved output as ' + JSON.stringify(output.name) + '.');
     }