@idleware/ringi 0.7.1 → 0.7.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@idleware/ringi",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "description": "Distributed agent coordinator",
   "os": [
     "darwin",

package/target/dts/core/hub/usecases/hubs.d.ts

@@ -17,6 +17,7 @@ export declare const create: (name: string, { signed, url }?: {
 }) => {
     H: Hub;
     rootKey: string | null;
+    remote: string | null;
     add: string | null;
 };
 export declare const use: (name: string) => void;

package/target/dts/lib/fail.d.ts

@@ -1,3 +1,4 @@
+export declare const withoutCredentials: (text: string) => string;
 export declare class Fail extends Error {
 }
 export declare const fail: (msg: string) => never;

package/target/esm/clients/cli/operator/hub-commands.js

@@ -14,7 +14,7 @@ export const createHub = (o) => {
     const r = Hubs.create(arg ?? '', { signed: flag(o, 'signed'), url: opt(o, 'url') });
     if (!r.add)
         return out(`created hub ${arg} (${r.H.dir})`);
-    return out(`created signed hub ${arg}${r.H.d.store.remote ? `, published to ${r.H.d.store.remote}` : ''}. Its root key stays on this machine (${r.rootKey}).
+    return out(`created signed hub ${arg}${r.remote ? `, published to ${r.remote}` : ''}. Its root key stays on this machine (${r.rootKey}).
 Give every machine that joins it, out of band:
   ${r.add}`);
 };

package/target/esm/core/hub/usecases/hubs.js

@@ -2,8 +2,10 @@
 import { DEFAULT_PROFILE, PROFILES_CAPABILITY, parseProfile } from '../work/index.js';
 import { OPERATOR, config, createHub, hubNames, openHub, roomNames, setConfig, transportOf } from '../rooms/index.js';
 import { hubPorts } from '../ports/index.js';
-import { fail, strictJson, words } from '../../../lib/index.js';
+import { fail, strictJson, withoutCredentials, words } from '../../../lib/index.js';
 import { ID_RE, compose } from '../protocol/index.js';
+// A remote as shown and handed to other machines: never with a password or token in it; each machine has its own.
+const shown = (url) => url ? withoutCredentials(url) : null;
 // The operator's terminal context picks the hub unless one is named.
 export const hubOf = (name) => openHub(name ?? config().hub);
 export const hubs = () => {
@@ -14,7 +16,7 @@ export const hubs = () => {
     return hubNames().map(n => {
         const H = openHub(n);
         return { name: H.name, current: H.name === cur, store: H.d.store.type, trust: H.contract.trust, contract: H.contract.version,
-            rooms: roomNames(H).length, remote: H.d.store.remote ?? null, dir: H.dir };
+            rooms: roomNames(H).length, remote: shown(H.d.store.remote), dir: H.dir };
     });
 };
 // A new hub; a signed one makes its root key here and returns what other machines need to pin it.
@@ -22,9 +24,9 @@ export const create = (name, { signed = false, url } = {}) => {
     if (!ID_RE.test(name))
         fail('usage: ringi hub create <name> [--signed [--url <git url>]]');
     const { custody } = createHub(name, { signed, url });
-    const H = openHub(name);
-    return { H, rootKey: custody,
-        add: H.signed ? `ringi hub add ${name} ${H.d.store.remote ?? '<url>'} --root '${H.d.root}' --genesis ${H.d.genesis}` : null };
+    const H = openHub(name), remote = shown(H.d.store.remote);
+    return { H, rootKey: custody, remote,
+        add: H.signed ? `ringi hub add ${name} ${remote ?? '<url>'} --root '${H.d.root}' --genesis ${H.d.genesis}` : null };
 };
 export const use = (name) => {
     openHub(name);

package/target/esm/lib/fail.js

@@ -1,7 +1,12 @@
 // fail: a refusal ringi explains (Fail, shown as its message), apart from a bug (any other error, shown with its stack).
+// A URL's credentials never shown, however git or a person wrote them: everything before its host goes, up to the last
+// `@` (a token may be the whole user, or hold an `@`), except an SSH login name, which is no secret.
+const USERINFO = /\b([a-z][a-z0-9+.-]*:\/\/)([^\s/?#'"]*)@/gi;
+export const withoutCredentials = (text) => text.replace(USERINFO, (_, scheme, user) => /^ssh:/i.test(scheme) && !user.includes(':') ? `${scheme}${user}@` : scheme);
 export class Fail extends Error {
 }
-export const fail = (msg) => { throw new Fail(msg); };
+// Every refusal passes here, git's own diagnostics included, so none shows a URL's credentials.
+export const fail = (msg) => { throw new Fail(withoutCredentials(msg)); };
 export const errno = (e) => e?.code;
 // A write the host refused: what to do is the same for every host; a tool's own way (its sandbox settings) is added
 // by the interface that knows the tools (cli.ts).

package/target/esm/lib/index.js

@@ -1,7 +1,8 @@
 // lib: helpers that know nothing of ringi and touch no host: failing (fail.ts), notes, formatting, strict JSON
 // (json.ts). Files and locks are the adapters' (adapters/fs).
-// Notes and alarms go where the program sends them (composition/: stderr). Those written before it says where wait
-// for it, so none is lost to the order modules load in.
+import { withoutCredentials } from './fail.js';
+// Notes and alarms go where the program sends them (composition/: stderr), never with a URL's credentials. Those
+// written before it says where wait for it, so none is lost to the order modules load in.
 const notes = [];
 let sink = null;
 export const notesTo = (fn) => {
@@ -10,7 +11,7 @@ export const notesTo = (fn) => {
         fn(line);
 };
 export const note = (s) => {
-    const line = `ringi: ${s}\n`;
+    const line = `ringi: ${withoutCredentials(s)}\n`;
     if (sink)
         sink(line);
     else