@gjermundgaraba/clankerbox-sdk 0.19.0 → 0.20.0

package/dist/{client-BodRGKAX.d.mts → client-Dr3PcuCP.d.mts}

@@ -249,6 +249,7 @@ declare const Http: ActionHttp.Binding<readonly [Action.Action<"listMachines", S
   readonly setup: Schema.optionalKey<Schema.Struct<{
     readonly script: Schema.String;
     readonly timeoutSeconds: Schema.optionalKey<Schema.Int>;
+    readonly authorizedKeys: Schema.optionalKey<Schema.String>;
   }>>;
   readonly profile: Schema.optionalKey<Schema.String>;
   readonly id: Schema.String;
@@ -451,6 +452,7 @@ declare const Http: ActionHttp.Binding<readonly [Action.Action<"listMachines", S
   readonly setup: Schema.Struct<{
     readonly script: Schema.String;
     readonly timeoutSeconds: Schema.optionalKey<Schema.Int>;
+    readonly authorizedKeys: Schema.optionalKey<Schema.String>;
   }>;
 }>, Schema.Struct<{
   readonly checkpoint: Schema.Struct<{
@@ -506,6 +508,7 @@ declare const actionsByName: {
     readonly setup: Schema.optionalKey<Schema.Struct<{
       readonly script: Schema.String;
       readonly timeoutSeconds: Schema.optionalKey<Schema.Int>;
+      readonly authorizedKeys: Schema.optionalKey<Schema.String>;
     }>>;
     readonly profile: Schema.optionalKey<Schema.String>;
     readonly id: Schema.String;
@@ -689,6 +692,7 @@ declare const actionsByName: {
     readonly setup: Schema.Struct<{
       readonly script: Schema.String;
       readonly timeoutSeconds: Schema.optionalKey<Schema.Int>;
+      readonly authorizedKeys: Schema.optionalKey<Schema.String>;
     }>;
   }>, Schema.Struct<{
     readonly checkpoint: Schema.Struct<{
@@ -942,10 +946,20 @@ type Usage = typeof Usage.Type;
 type WithoutHost<Row> = Row extends unknown ? Omit<Row, "host"> : never;
 /** A `Usage` row as a runtime reads it, before the host names itself on it. */
 type Reading = WithoutHost<Usage>;
-/** Nothing logs the script: it can carry secrets. */
+/**
+ * Public keys, as `.pub` files hold them: each line that isn't blank is `<type> <base64>
+ * [comment]`, the type an OpenSSH key's, its certificate's or a hardware key's, and at least one
+ * line is. Anything else, a private key included, is refused.
+ */
+declare const PublicKeys: Schema.String;
+/**
+ * Nothing logs the script: it can carry secrets. `authorizedKeys` is appended to the login user's
+ * `~/.ssh/authorized_keys` once the script exits 0, through the guest's `sudo`.
+ */
 declare const Setup: Schema.Struct<{
   readonly script: Schema.String;
   readonly timeoutSeconds: Schema.optionalKey<Schema.Int>;
+  readonly authorizedKeys: Schema.optionalKey<Schema.String>;
 }>;
 type Setup = typeof Setup.Type;
 /** A profile file fills these in; the host sees only the `profile` label. */
@@ -957,6 +971,7 @@ declare const MachineSpec: Schema.Struct<{
   setup: Schema.optionalKey<Schema.Struct<{
     readonly script: Schema.String;
     readonly timeoutSeconds: Schema.optionalKey<Schema.Int>;
+    readonly authorizedKeys: Schema.optionalKey<Schema.String>;
   }>>;
   profile: Schema.optionalKey<Schema.String>;
 }>;
@@ -970,6 +985,7 @@ declare const CreateRequest: Schema.Struct<{
   readonly setup: Schema.optionalKey<Schema.Struct<{
     readonly script: Schema.String;
     readonly timeoutSeconds: Schema.optionalKey<Schema.Int>;
+    readonly authorizedKeys: Schema.optionalKey<Schema.String>;
   }>>;
   readonly profile: Schema.optionalKey<Schema.String>;
   readonly id: Schema.String;
@@ -986,6 +1002,7 @@ declare const PrebuildRequest: Schema.Struct<{
   readonly setup: Schema.Struct<{
     readonly script: Schema.String;
     readonly timeoutSeconds: Schema.optionalKey<Schema.Int>;
+    readonly authorizedKeys: Schema.optionalKey<Schema.String>;
   }>;
 }>;
 type PrebuildRequest = typeof PrebuildRequest.Type;
@@ -1096,4 +1113,4 @@ declare class Client extends Client_base {}
 declare const make: (hosts: ReadonlyArray<HostEntry>, options?: Options) => Effect.Effect<Interface, Invalid, HttpClient.HttpClient>;
 declare const layer: (hosts: ReadonlyArray<HostEntry>, options?: Options) => Layer.Layer<Client, Invalid, HttpClient.HttpClient>;
 //#endregion
-export { Conflict as A, ScriptFailed as B, stateLabel as C, readTimeout as D, actionsByName as E, NotFound as F, hostErrors as G, Unavailable as H, NotMade as I, retryable as K, NotOffered as L, Internal as M, Invalid as N, Capacity as O, Missing as P, PinMismatch as R, Usage as S, Http as T, Unsizable as U, Superseded as V, WrongState as W, Runtime as _, Options as a, SshLogin as b, CreateRequest as c, Machine as d, MachineSpec as f, Reading as g, Prebuilt as h, Interface as i, HostError as j, ClankerboxError as k, Desired as l, PrebuildRequest as m, CreateOptions as n, client_d_exports as o, Phase as p, HostEntry as r, Checkpoint as s, Client as t, Host as u, Setup as v, Declared as w, TailnetStatus as x, SshEndpoint as y, Refused as z };
+export { ClankerboxError as A, Refused as B, Usage as C, actionsByName as D, Http as E, Missing as F, WrongState as G, Superseded as H, NotFound as I, hostErrors as K, NotMade as L, HostError as M, Internal as N, readTimeout as O, Invalid as P, NotOffered as R, TailnetStatus as S, Declared as T, Unavailable as U, ScriptFailed as V, Unsizable as W, Reading as _, Options as a, SshEndpoint as b, CreateRequest as c, Machine as d, MachineSpec as f, PublicKeys as g, Prebuilt as h, Interface as i, Conflict as j, Capacity as k, Desired as l, PrebuildRequest as m, CreateOptions as n, client_d_exports as o, Phase as p, retryable as q, HostEntry as r, Checkpoint as s, Client as t, Host as u, Runtime as v, stateLabel as w, SshLogin as x, Setup as y, PinMismatch as z };

package/dist/{client-BwhQ_WUi.mjs → client-S3cTnrsp.mjs}

@@ -349,10 +349,25 @@ const Usage = Schema.Union([Schema.Struct({
 	...usageFields,
 	unread: Schema.Array(Id)
 })]).annotate({ identifier: "Usage" });
-/** Nothing logs the script: it can carry secrets. */
+const publicKeyLine = /^(?:ssh|ecdsa|sk)-[a-z0-9@.-]+ [A-Za-z0-9+/]+={0,3}(?: .*)?$/u;
+const blankLine = /^\s*$/u;
+/**
+* Public keys, as `.pub` files hold them: each line that isn't blank is `<type> <base64>
+* [comment]`, the type an OpenSSH key's, its certificate's or a hardware key's, and at least one
+* line is. Anything else, a private key included, is refused.
+*/
+const PublicKeys = Schema.String.check(Schema.makeFilter((text) => {
+	const lines = text.split("\n").filter((line) => !blankLine.test(line));
+	return lines.length > 0 && lines.every((line) => publicKeyLine.test(line)) || "each line that isn't blank is a public key, <type> <base64> [comment], as a .pub file holds it";
+}));
+/**
+* Nothing logs the script: it can carry secrets. `authorizedKeys` is appended to the login user's
+* `~/.ssh/authorized_keys` once the script exits 0, through the guest's `sudo`.
+*/
 const Setup = Schema.Struct({
 	script: Schema.String,
-	timeoutSeconds: Schema.optionalKey(Size)
+	timeoutSeconds: Schema.optionalKey(Size),
+	authorizedKeys: Schema.optionalKey(PublicKeys)
 });
 const specFields = {
 	base: Schema.String,
@@ -547,7 +562,7 @@ const actionsByName = Action.byName(Http.actions);
 //#endregion
 //#region src/release.ts
 /** Also the version of the clankerbox CLI released with it. */
-const version = "0.19.0";
+const version = "0.20.0";
 /** major.minor: releases that share it speak the same API. */
 const release = (of) => of.split(".").slice(0, 2).join(".");
 /** A host refuses a request whose `release` differs from its own, or that has none. */
@@ -755,4 +770,4 @@ const make = (hosts, options) => Effect.gen(function* () {
 });
 const layer = (hosts, options) => Layer.effect(Client, make(hosts, options));
 //#endregion
-export { formatId as A, NotFound as B, SshLogin as C, HostId as D, stateLabel as E, Conflict as F, ScriptFailed as G, NotOffered as H, HostError as I, Unsizable as J, Superseded as K, Internal as L, parseName as M, Capacity as N, Id as O, ClankerboxError as P, Invalid as R, SshEndpoint as S, Usage as T, PinMismatch as U, NotMade as V, Refused as W, hostErrors as X, WrongState as Y, retryable as Z, Phase as _, release as a, Runtime as b, Http as c, Checkpoint as d, CreateRequest as f, MachineSpec as g, Machine as h, describeIssues as i, parseId as j, Name as k, actionsByName as l, Host as m, layer as n, version as o, Desired as p, Unavailable as q, describeFileError as r, versionHeader as s, client_exports as t, readTimeout as u, PrebuildRequest as v, TailnetStatus as w, Setup as x, Prebuilt as y, Missing as z };
+export { Name as A, Missing as B, SshEndpoint as C, stateLabel as D, Usage as E, ClankerboxError as F, Refused as G, NotMade as H, Conflict as I, Unavailable as J, ScriptFailed as K, HostError as L, parseId as M, parseName as N, HostId as O, Capacity as P, retryable as Q, Internal as R, Setup as S, TailnetStatus as T, NotOffered as U, NotFound as V, PinMismatch as W, WrongState as X, Unsizable as Y, hostErrors as Z, Phase as _, release as a, PublicKeys as b, Http as c, Checkpoint as d, CreateRequest as f, MachineSpec as g, Machine as h, describeIssues as i, formatId as j, Id as k, actionsByName as l, Host as m, layer as n, version as o, Desired as p, Superseded as q, describeFileError as r, versionHeader as s, client_exports as t, readTimeout as u, PrebuildRequest as v, SshLogin as w, Runtime as x, Prebuilt as y, Invalid as z };

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { A as Conflict, B as ScriptFailed, C as stateLabel, D as readTimeout, E as actionsByName, F as NotFound, G as hostErrors, H as Unavailable, I as NotMade, K as retryable, L as NotOffered, M as Internal, N as Invalid, O as Capacity, P as Missing, R as PinMismatch, S as Usage, T as Http, U as Unsizable, V as Superseded, W as WrongState, _ as Runtime, b as SshLogin, c as CreateRequest, d as Machine, f as MachineSpec, g as Reading, h as Prebuilt, i as Interface, j as HostError, k as ClankerboxError, l as Desired, m as PrebuildRequest, n as CreateOptions$1, o as client_d_exports, p as Phase, s as Checkpoint, u as Host, v as Setup, w as Declared, x as TailnetStatus, y as SshEndpoint, z as Refused } from "./client-BodRGKAX.mjs";
+import { A as ClankerboxError, B as Refused, C as Usage, D as actionsByName, E as Http, F as Missing, G as WrongState, H as Superseded, I as NotFound, K as hostErrors, L as NotMade, M as HostError, N as Internal, O as readTimeout, P as Invalid, R as NotOffered, S as TailnetStatus, T as Declared, U as Unavailable, V as ScriptFailed, W as Unsizable, _ as Reading, b as SshEndpoint, c as CreateRequest, d as Machine, f as MachineSpec, g as PublicKeys, h as Prebuilt, i as Interface, j as Conflict, k as Capacity, l as Desired, m as PrebuildRequest, n as CreateOptions$1, o as client_d_exports, p as Phase, q as retryable, s as Checkpoint, u as Host, v as Runtime, w as stateLabel, x as SshLogin, y as Setup, z as PinMismatch } from "./client-Dr3PcuCP.mjs";
 import { Effect, FileSystem, Path, PlatformError, Schema, Scope } from "effect";
 //#region src/ids.d.ts
 export declare const HostId: Schema.String;
@@ -18,8 +18,8 @@ declare namespace prebuild_d_exports {
   export { CreateOptions, Created, build, create, nameOf };
 }
 /**
- * A digest of the spec's label, base, sizes, setup script as sent, and the host's runtime
- * version: a `ram` checkpoint restores only under the release that saved it, so after a runtime
+ * A digest of the spec's label, base, sizes, setup script as sent, authorized keys, and the host's
+ * runtime version: a `ram` checkpoint restores only under the release that saved it, so after a runtime
  * bump a create misses the old prebuild instead of failing to restore it. The setup's timeout and
  * the base's image are no part of it.
  */
@@ -87,6 +87,8 @@ export type Overrides = { readonly [K in keyof Sizes]?: Sizes[K] | undefined; }
   readonly setup?: string | undefined;
   readonly setupTimeoutSeconds?: number | undefined;
   readonly host?: string | undefined;
+  /** A public-key file, already resolved, which a setup needs and which is read only for one. */
+  readonly authorizedKeys?: string | undefined;
 };
 export interface SpecRequest {
   readonly spec: MachineSpec;
@@ -107,6 +109,11 @@ export declare const specRequest: (what: string, profile: LoadedProfile | undefi
 export declare const packRecipe: (directory: string) => Effect.Effect<string, Invalid, FileSystem.FileSystem>;
 /** A script file's text, or a recipe directory packed into one script. */
 export declare const readSetup: (path: string) => Effect.Effect<string, Invalid, FileSystem.FileSystem>;
+/**
+ * A public-key file's text, such as `~/.ssh/id_ed25519.pub`'s, for a setup's `authorizedKeys`, with
+ * its line endings as `\n`.
+ */
+export declare const readAuthorizedKeys: (path: string) => Effect.Effect<string, Invalid, FileSystem.FileSystem>;
 //#endregion
 //#region src/ssh.d.ts
 export interface SshTarget {
@@ -145,4 +152,4 @@ export declare const formatMib: (mib: number) => string;
 /** As a size flag takes it: `60G`. */
 export declare const formatGib: (gib: number) => string;
 //#endregion
-export { Capacity, Checkpoint, ClankerboxError, client_d_exports as Client, Conflict, CreateRequest, Declared, Desired, Host, HostError, Http, Internal, Invalid, Machine, MachineSpec, Missing, NotFound, NotMade, NotOffered, Phase, PinMismatch, prebuild_d_exports as Prebuild, PrebuildRequest, Prebuilt, Reading, Refused, Runtime, ScriptFailed, Setup, SshEndpoint, SshLogin, Superseded, TailnetStatus, Unavailable, Unsizable, Usage, WrongState, actionsByName, hostErrors, readTimeout, retryable, stateLabel };
+export { Capacity, Checkpoint, ClankerboxError, client_d_exports as Client, Conflict, CreateRequest, Declared, Desired, Host, HostError, Http, Internal, Invalid, Machine, MachineSpec, Missing, NotFound, NotMade, NotOffered, Phase, PinMismatch, prebuild_d_exports as Prebuild, PrebuildRequest, Prebuilt, PublicKeys, Reading, Refused, Runtime, ScriptFailed, Setup, SshEndpoint, SshLogin, Superseded, TailnetStatus, Unavailable, Unsizable, Usage, WrongState, actionsByName, hostErrors, readTimeout, retryable, stateLabel };

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { t as __exportAll } from "./rolldown-runtime-D7D4PA-g.mjs";
-import { A as formatId, B as NotFound, C as SshLogin, D as HostId, E as stateLabel, F as Conflict, G as ScriptFailed, H as NotOffered, I as HostError, J as Unsizable, K as Superseded, L as Internal, M as parseName, N as Capacity, O as Id, P as ClankerboxError, R as Invalid, S as SshEndpoint, T as Usage, U as PinMismatch, V as NotMade, W as Refused, X as hostErrors, Y as WrongState, Z as retryable, _ as Phase, a as release, b as Runtime, c as Http, d as Checkpoint, f as CreateRequest, g as MachineSpec, h as Machine, i as describeIssues, j as parseId, k as Name, l as actionsByName, m as Host, o as version, p as Desired, q as Unavailable, r as describeFileError, s as versionHeader, t as client_exports, u as readTimeout, v as PrebuildRequest, w as TailnetStatus, x as Setup, y as Prebuilt, z as Missing } from "./client-BwhQ_WUi.mjs";
+import { A as Name, B as Missing, C as SshEndpoint, D as stateLabel, E as Usage, F as ClankerboxError, G as Refused, H as NotMade, I as Conflict, J as Unavailable, K as ScriptFailed, L as HostError, M as parseId, N as parseName, O as HostId, P as Capacity, Q as retryable, R as Internal, S as Setup, T as TailnetStatus, U as NotOffered, V as NotFound, W as PinMismatch, X as WrongState, Y as Unsizable, Z as hostErrors, _ as Phase, a as release, b as PublicKeys, c as Http, d as Checkpoint, f as CreateRequest, g as MachineSpec, h as Machine, i as describeIssues, j as formatId, k as Id, l as actionsByName, m as Host, o as version, p as Desired, q as Superseded, r as describeFileError, s as versionHeader, t as client_exports, u as readTimeout, v as PrebuildRequest, w as SshLogin, x as Runtime, y as Prebuilt, z as Invalid } from "./client-S3cTnrsp.mjs";
 import { Effect, FileSystem, Option, Path, Predicate, Record, Schema } from "effect";
 import { Base64, Hex } from "effect/encoding";
 //#region src/prebuild.ts
@@ -11,8 +11,8 @@ var prebuild_exports = /* @__PURE__ */ __exportAll({
 const prefix = "prebuilt-";
 const digestDigits = 12;
 /**
-* A digest of the spec's label, base, sizes, setup script as sent, and the host's runtime
-* version: a `ram` checkpoint restores only under the release that saved it, so after a runtime
+* A digest of the spec's label, base, sizes, setup script as sent, authorized keys, and the host's
+* runtime version: a `ram` checkpoint restores only under the release that saved it, so after a runtime
 * bump a create misses the old prebuild instead of failing to restore it. The setup's timeout and
 * the base's image are no part of it.
 */
@@ -23,6 +23,7 @@ const nameOf = (spec, host) => Effect.promise(() => globalThis.crypto.subtle.dig
 	spec.ramMib,
 	spec.diskGib,
 	spec.setup?.script ?? null,
+	spec.setup?.authorizedKeys ?? null,
 	host.runtimeVersion
 ])))).pipe(Effect.map((digest) => `${prefix}${Hex.encode(new Uint8Array(digest)).slice(0, digestDigits)}`));
 const lookup = (client, id) => client.getCheckpoint({ id }).pipe(Effect.map(Option.some), Effect.catchTag("NotFound", () => Effect.succeedNone));
@@ -131,6 +132,21 @@ const readSetup = (path) => Effect.gen(function* () {
 	message: `couldn't read setup ${path}: ${describeFileError(error)}`,
 	file: path
 }))));
+const decodePublicKeys = Schema.decodeUnknownEffect(PublicKeys);
+/**
+* A public-key file's text, such as `~/.ssh/id_ed25519.pub`'s, for a setup's `authorizedKeys`, with
+* its line endings as `\n`.
+*/
+const readAuthorizedKeys = (path) => Effect.gen(function* () {
+	const text = yield* (yield* FileSystem.FileSystem).readFileString(path).pipe(Effect.mapError((error) => new Invalid({
+		message: `couldn't read authorized keys ${path}: ${describeFileError(error)}`,
+		file: path
+	})));
+	return yield* decodePublicKeys(text.replaceAll("\r\n", "\n")).pipe(Effect.mapError((error) => new Invalid({
+		message: `authorized keys ${path}: ${describeIssues(error)}`,
+		file: path
+	})));
+});
 //#endregion
 //#region src/profile.ts
 /**
@@ -189,16 +205,18 @@ const specRequest = (what, profile, overrides, names) => Effect.gen(function* ()
 	const file = overrides.setup ?? profile?.setup?.path;
 	const timeoutSeconds = overrides.setupTimeoutSeconds ?? profile?.setup?.timeoutSeconds;
 	if (file === void 0 && overrides.setupTimeoutSeconds !== void 0) return yield* new Invalid({ message: `${what}: ${names?.get("setupTimeoutSeconds") ?? "the setup timeout"} needs a setup to time` });
-	const script = file === void 0 ? void 0 : yield* readSetup(file);
+	const keys = overrides.authorizedKeys;
+	const setup = file === void 0 ? void 0 : keys === void 0 ? yield* new Invalid({ message: `${what}: a setup needs ${names?.get("authorizedKeys") ?? "authorizedKeys"}, the public keys the host installs for the login user after it` }) : Record.filter({
+		script: yield* readSetup(file),
+		timeoutSeconds,
+		authorizedKeys: yield* readAuthorizedKeys(keys)
+	}, Predicate.isNotUndefined);
 	const fields = {
 		base: overrides.base ?? profile?.base,
 		cpu: overrides.cpu ?? profile?.cpu,
 		ramMib: overrides.ramMib ?? profile?.ramMib,
 		diskGib: overrides.diskGib ?? profile?.diskGib,
-		setup: script === void 0 ? void 0 : Record.filter({
-			script,
-			timeoutSeconds
-		}, Predicate.isNotUndefined),
+		setup,
 		profile: profile?.label
 	};
 	return {
@@ -274,4 +292,4 @@ const formatMib = (mib) => mib >= 1024 && mib % 512 === 0 ? `${mib / mibPerGib}G
 /** As a size flag takes it: `60G`. */
 const formatGib = (gib) => `${gib}G`;
 //#endregion
-export { Capacity, Checkpoint, ClankerboxError, client_exports as Client, Conflict, CreateRequest, Desired, Host, HostError, HostId, Http, Id, Internal, Invalid, Machine, MachineSpec, Missing, Name, NotFound, NotMade, NotOffered, Phase, PinMismatch, prebuild_exports as Prebuild, PrebuildRequest, Prebuilt, Profile, Refused, Runtime, ScriptFailed, Setup, SshEndpoint, SshLogin, Superseded, TailnetStatus, Unavailable, Unsizable, Usage, WrongState, actionsByName, describeFileError, describeIssues, formatGib, formatId, formatMib, hostErrors, knownHostsLine, loadProfile, mibPerGib, packRecipe, parseId, parseName, pinnedSsh, readSetup, readTimeout, release, retryable, specRequest, sshTarget, stateLabel, version, versionHeader };
+export { Capacity, Checkpoint, ClankerboxError, client_exports as Client, Conflict, CreateRequest, Desired, Host, HostError, HostId, Http, Id, Internal, Invalid, Machine, MachineSpec, Missing, Name, NotFound, NotMade, NotOffered, Phase, PinMismatch, prebuild_exports as Prebuild, PrebuildRequest, Prebuilt, Profile, PublicKeys, Refused, Runtime, ScriptFailed, Setup, SshEndpoint, SshLogin, Superseded, TailnetStatus, Unavailable, Unsizable, Usage, WrongState, actionsByName, describeFileError, describeIssues, formatGib, formatId, formatMib, hostErrors, knownHostsLine, loadProfile, mibPerGib, packRecipe, parseId, parseName, pinnedSsh, readAuthorizedKeys, readSetup, readTimeout, release, retryable, specRequest, sshTarget, stateLabel, version, versionHeader };

package/dist/node.d.mts

@@ -1,4 +1,4 @@
-import { N as Invalid, a as Options, r as HostEntry, t as Client } from "./client-BodRGKAX.mjs";
+import { P as Invalid, a as Options, r as HostEntry, t as Client } from "./client-Dr3PcuCP.mjs";
 import { Layer } from "effect";
 //#region src/node.d.ts
 /**

package/dist/node.mjs

@@ -1,4 +1,4 @@
-import { n as layer$1 } from "./client-BwhQ_WUi.mjs";
+import { n as layer$1 } from "./client-S3cTnrsp.mjs";
 import { Layer } from "effect";
 import * as NodeHttpClient from "@effect/platform-node/NodeHttpClient";
 //#region src/node.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gjermundgaraba/clankerbox-sdk",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "description": "clankerbox's API contract and client library, for Effect",
   "license": "MIT",
   "repository": {