Compare commits
9
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1e34ecc16b | ||
|
|
31af3f0ecc | ||
|
|
958a6f4e3a | ||
|
|
f14c763463 | ||
|
|
ab44ff02e1 | ||
|
|
c4c44efb1b | ||
|
|
5cc6258326 | ||
|
|
1df2a0b346 | ||
|
|
21f5301268 |
@@ -9,13 +9,13 @@
|
|||||||
"model-access"
|
"model-access"
|
||||||
],
|
],
|
||||||
"binds": {
|
"binds": {
|
||||||
"model-access": "${dir:state}/model.json"
|
"model-access": "/var/lib/anthropic-consumer/model.json"
|
||||||
},
|
},
|
||||||
"secrets": {
|
"secrets": {
|
||||||
"model-access": "${dir:state}/access-token"
|
"model-access": "/var/lib/anthropic-consumer/access-token"
|
||||||
},
|
},
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/anthropic-consumer/broker"
|
||||||
},
|
},
|
||||||
"emits": [
|
"emits": [
|
||||||
"usage.session"
|
"usage.session"
|
||||||
@@ -24,14 +24,14 @@
|
|||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/anthropic-consumer",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/anthropic-consumer",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "claude-home",
|
"id": "claude-home",
|
||||||
@@ -42,6 +42,7 @@
|
|||||||
{
|
{
|
||||||
"id": "out",
|
"id": "out",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/var/lib/anthropic-consumer/out",
|
||||||
"mode": "0700"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -55,7 +56,7 @@
|
|||||||
"/app/modules/anthropic-consumer/dist/apply/index.js"
|
"/app/modules/anthropic-consumer/dist/apply/index.js"
|
||||||
],
|
],
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:state}:/run/state"
|
"/var/lib/anthropic-consumer:/run/state"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_MODEL_ACCESS_SECRET_FILE": "/run/state/access-token",
|
"MESH_MODEL_ACCESS_SECRET_FILE": "/run/state/access-token",
|
||||||
@@ -76,8 +77,8 @@
|
|||||||
"/app/modules/anthropic-consumer/dist/usage/index.js"
|
"/app/modules/anthropic-consumer/dist/usage/index.js"
|
||||||
],
|
],
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/anthropic-consumer/broker:/run/secrets/broker:ro",
|
||||||
"${dir:state}:/run/state"
|
"/var/lib/anthropic-consumer:/run/state"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
|
|||||||
@@ -9,13 +9,13 @@
|
|||||||
"model-access"
|
"model-access"
|
||||||
],
|
],
|
||||||
"binds": {
|
"binds": {
|
||||||
"model-access": "${dir:mesh-state}/model.json"
|
"model-access": "/var/lib/mesh/anthropic-manager/model.json"
|
||||||
},
|
},
|
||||||
"secrets": {
|
"secrets": {
|
||||||
"model-access": "${dir:mesh-state}/refresh-token"
|
"model-access": "/var/lib/mesh/anthropic-manager/refresh-token"
|
||||||
},
|
},
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/anthropic-manager/broker"
|
||||||
},
|
},
|
||||||
"emits": [
|
"emits": [
|
||||||
"usage.read"
|
"usage.read"
|
||||||
@@ -24,13 +24,13 @@
|
|||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/anthropic-manager",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "out",
|
"id": "out",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"path": "${dir:mesh-state}/out",
|
"path": "/var/lib/mesh/anthropic-manager/out",
|
||||||
"mode": "0700"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -45,8 +45,8 @@
|
|||||||
"/app/modules/anthropic-manager/dist/refresh/index.js"
|
"/app/modules/anthropic-manager/dist/refresh/index.js"
|
||||||
],
|
],
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/anthropic-manager/broker:/run/secrets/broker:ro",
|
||||||
"${dir:mesh-state}:/run/state"
|
"/var/lib/mesh/anthropic-manager:/run/state"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
"**"
|
"**"
|
||||||
],
|
],
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"broker": "${dir:state}/broker"
|
"broker": "/var/lib/audit-logger/broker"
|
||||||
},
|
},
|
||||||
"build": {
|
"build": {
|
||||||
"on": [
|
"on": [
|
||||||
@@ -33,12 +33,13 @@
|
|||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/audit-logger",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "trail",
|
"id": "trail",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/var/lib/audit-logger/trail",
|
||||||
"mode": "0700"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -47,8 +48,8 @@
|
|||||||
"name": "mesh-audit-logger",
|
"name": "mesh-audit-logger",
|
||||||
"network": "host",
|
"network": "host",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:state}/broker:/run/secrets/broker:ro",
|
"/var/lib/audit-logger/broker:/run/secrets/broker:ro",
|
||||||
"${dir:trail}:/trail"
|
"/var/lib/audit-logger/trail:/trail"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
|
|||||||
+24
-55
@@ -2,15 +2,12 @@
|
|||||||
// module's tools and anything else baserow-specific import it; nothing outside baserow does.
|
// module's tools and anything else baserow-specific import it; nothing outside baserow does.
|
||||||
//
|
//
|
||||||
// Baserow authenticates a person with email + password, exchanged for a JWT at /api/user/token-auth/.
|
// Baserow authenticates a person with email + password, exchanged for a JWT at /api/user/token-auth/.
|
||||||
// The standard image creates no admin from env, so the account is one a person made in Baserow: its
|
// Those credentials are the mesh's own: a person signs up in Baserow (the standard image creates no
|
||||||
// password is the module's `admin` secret, accepted from the operator, and its email and the public
|
// admin from env), and the credential is placed in the runtime config file the mesh mounts. Until
|
||||||
// host Baserow answers to reach the runtime config file the mesh mounts (the email from the
|
// that happens fromEnv throws and the module simply exposes no tools — the same dormant-until-
|
||||||
// assignment's settings). Until both are there fromEnv throws and the module exposes no tools — the
|
// configured shape gitea uses for its token.
|
||||||
// same dormant-until-configured shape gitea uses for its token.
|
|
||||||
|
|
||||||
import { readFileSync } from "node:fs";
|
import { readFileSync } from "node:fs";
|
||||||
import { request as httpRequest } from "node:http";
|
|
||||||
import { request as httpsRequest } from "node:https";
|
|
||||||
|
|
||||||
export interface BaserowApplication {
|
export interface BaserowApplication {
|
||||||
id: number;
|
id: number;
|
||||||
@@ -71,63 +68,35 @@ export class BaserowClient {
|
|||||||
return h;
|
return h;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/** Exchange email + password for a JWT, caching it for the client's lifetime. Handles both the
|
||||||
* One HTTP exchange. Not `fetch`: Node's fetch drops a caller's Host header and sends the URL's
|
|
||||||
* own, and Baserow answers only the host of its BASEROW_PUBLIC_URL — any other Host is looked up
|
|
||||||
* as a published builder site and gets 404, `/api/_health/` included. A co-located caller reaching
|
|
||||||
* it by container name must present the public host, so the request is made with node:http, which
|
|
||||||
* sends the Host it is given.
|
|
||||||
*/
|
|
||||||
private send(path: string, method: string, headers: Record<string, string>, body?: string): Promise<{ status: number; text: string }> {
|
|
||||||
const url = new URL(`${this.baseUrl}${path}`);
|
|
||||||
const request = url.protocol === "https:" ? httpsRequest : httpRequest;
|
|
||||||
// A length, never chunked: Baserow's server reads a chunked body as empty.
|
|
||||||
const sent = body === undefined ? headers : { ...headers, "Content-Length": String(Buffer.byteLength(body)) };
|
|
||||||
return new Promise((resolve, reject) => {
|
|
||||||
const req = request(url, { method, headers: sent }, (res) => {
|
|
||||||
let text = "";
|
|
||||||
res.setEncoding("utf8");
|
|
||||||
res.on("data", (chunk: string) => (text += chunk));
|
|
||||||
res.on("end", () => resolve({ status: res.statusCode ?? 0, text }));
|
|
||||||
res.on("error", reject);
|
|
||||||
});
|
|
||||||
req.on("error", reject);
|
|
||||||
if (body !== undefined) req.write(body);
|
|
||||||
req.end();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Exchange email + password for a JWT, caching it until Baserow refuses it. Handles both the
|
|
||||||
* older `{ token }` and the newer `{ access_token }` response shapes. */
|
* older `{ token }` and the newer `{ access_token }` response shapes. */
|
||||||
async authenticate(): Promise<string> {
|
async authenticate(): Promise<string> {
|
||||||
if (this.token) return this.token;
|
if (this.token) return this.token;
|
||||||
const res = await this.send(
|
const res = await fetch(`${this.baseUrl}/api/user/token-auth/`, {
|
||||||
"/api/user/token-auth/",
|
method: "POST",
|
||||||
"POST",
|
headers: this.headers(),
|
||||||
this.headers(),
|
body: JSON.stringify({ email: this.email, password: this.password }),
|
||||||
JSON.stringify({ email: this.email, password: this.password }),
|
});
|
||||||
);
|
if (!res.ok) throw new Error(`baserow auth failed: ${res.status} ${await res.text()}`);
|
||||||
if (res.status < 200 || res.status >= 300) throw new Error(`baserow auth failed: ${res.status} ${res.text}`);
|
const data = (await res.json()) as { token?: string; access_token?: string };
|
||||||
const data = JSON.parse(res.text) as { token?: string; access_token?: string };
|
|
||||||
const token = data.access_token ?? data.token;
|
const token = data.access_token ?? data.token;
|
||||||
if (!token) throw new Error("baserow auth returned no token");
|
if (!token) throw new Error("baserow auth returned no token");
|
||||||
this.token = token;
|
this.token = token;
|
||||||
return token;
|
return token;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** An authenticated GET. A refused token is dropped and the call made once more with a fresh one:
|
private async authed<T>(path: string, options: RequestInit = {}): Promise<T> {
|
||||||
* Baserow's access tokens expire after minutes, and the runtime lives for weeks. */
|
const token = await this.authenticate();
|
||||||
private async authed<T>(path: string): Promise<T> {
|
const res = await fetch(`${this.baseUrl}${path}`, {
|
||||||
for (let attempt = 0; ; attempt++) {
|
...options,
|
||||||
const token = await this.authenticate();
|
headers: this.headers({
|
||||||
const res = await this.send(path, "GET", this.headers({ Authorization: `JWT ${token}` }));
|
Authorization: `JWT ${token}`,
|
||||||
if (res.status === 401 && attempt === 0) {
|
...(options.headers as Record<string, string> | undefined),
|
||||||
this.token = null;
|
}),
|
||||||
continue;
|
});
|
||||||
}
|
if (!res.ok) throw new Error(`baserow ${path}: ${res.status} ${await res.text()}`);
|
||||||
if (res.status < 200 || res.status >= 300) throw new Error(`baserow ${path}: ${res.status} ${res.text}`);
|
const text = await res.text();
|
||||||
return (res.text ? JSON.parse(res.text) : null) as T;
|
return (text ? JSON.parse(text) : null) as T;
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/** The applications (databases) the account can see, across all its workspaces. */
|
/** The applications (databases) the account can see, across all its workspaces. */
|
||||||
|
|||||||
+22
-21
@@ -18,15 +18,15 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"binds": {
|
"binds": {
|
||||||
"postgres-database": "${dir:state}/database.json",
|
"postgres-database": "/var/lib/baserow/database.json",
|
||||||
"route": "${dir:state}/route.json"
|
"route": "/var/lib/baserow/route.json"
|
||||||
},
|
},
|
||||||
"secrets": {
|
"secrets": {
|
||||||
"postgres-database": "${dir:state}/database.secret"
|
"postgres-database": "/var/lib/baserow/database.secret"
|
||||||
},
|
},
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"admin": "${dir:state}/admin.secret",
|
"secret-key": "/var/lib/baserow/secret-key.secret",
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/baserow/broker"
|
||||||
},
|
},
|
||||||
"listens": [
|
"listens": [
|
||||||
{
|
{
|
||||||
@@ -34,34 +34,35 @@
|
|||||||
"port": 80,
|
"port": 80,
|
||||||
"protocol": "tcp",
|
"protocol": "tcp",
|
||||||
"from": "mesh",
|
"from": "mesh",
|
||||||
"why": "the Baserow web UI and REST API, served by the image's own Caddy; a public name is the route's"
|
"why": "the Baserow web UI and REST API; a public name is a route grant later"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/baserow",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/baserow",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "data",
|
"id": "data",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/services/baserow/data",
|
||||||
"mode": "0755",
|
"mode": "0755",
|
||||||
"owner": "9999:9999"
|
"owner": "9999:9999"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "server-env",
|
"id": "server-env",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/server.env",
|
"path": "/var/lib/baserow/server.env",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "DATABASE_HOST=${bound:postgres-database:at}\nDATABASE_PORT=${bound:postgres-database:port}\nDATABASE_NAME=${bound:postgres-database:as}\nDATABASE_USER=${bound:postgres-database:as}\nDATABASE_PASSWORD_FILE=/run/secrets/database\nDISABLE_EMBEDDED_PSQL=true\nBASEROW_PUBLIC_URL=https://${bound:route:name}\n"
|
"content": "DATABASE_HOST=${bound:postgres-database:at}\nDATABASE_PORT=${bound:postgres-database:port}\nDATABASE_NAME=${bound:postgres-database:as}\nDATABASE_USER=${bound:postgres-database:as}\nDATABASE_PASSWORD=${secret:postgres-database}\nSECRET_KEY=${secret:secret-key}\nBASEROW_PUBLIC_URL=http://localhost\n"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "net",
|
"id": "net",
|
||||||
@@ -72,25 +73,25 @@
|
|||||||
"id": "server",
|
"id": "server",
|
||||||
"type": "container",
|
"type": "container",
|
||||||
"name": "baserow",
|
"name": "baserow",
|
||||||
"image": "baserow/baserow@sha256:263ea6c4b72c9eccabcd975ffe9fdebf23913a293a514bec6a3897a5e0a5a080",
|
"image": "baserow/baserow@sha256:834424a10413798567f76428f255dc259445b7f8dcec56598c05b4073bb2a124",
|
||||||
"network": "baserow",
|
"network": "baserow",
|
||||||
"env-file": [
|
"env-file": [
|
||||||
"${dir:state}/server.env"
|
"/var/lib/baserow/server.env"
|
||||||
],
|
],
|
||||||
"ports": [
|
"ports": [
|
||||||
"80"
|
"80"
|
||||||
],
|
],
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:data}:/baserow/data",
|
"/services/baserow/data:/baserow/data"
|
||||||
"${dir:state}/database.secret:/run/secrets/database:ro"
|
],
|
||||||
]
|
"secrets-in-environment": "baserow reads DATABASE_PASSWORD and SECRET_KEY with os.getenv and has no _FILE twin (settings/base.py); not convertible"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "runtime-config",
|
"id": "runtime-config",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:mesh-state}/config.json",
|
"path": "/var/lib/mesh/baserow/config.json",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "{\n \"password\": \"${secret:admin}\",\n \"host\": \"${bound:route:name}\"\n}\n",
|
"content": "{}\n",
|
||||||
"merge": "json"
|
"merge": "json"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -99,8 +100,8 @@
|
|||||||
"name": "mesh-baserow",
|
"name": "mesh-baserow",
|
||||||
"network": "baserow",
|
"network": "baserow",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/baserow/broker:/run/secrets/broker:ro",
|
||||||
"${dir:mesh-state}/config.json:/run/config/config.json:ro"
|
"/var/lib/mesh/baserow/config.json:/run/config/config.json:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
|
|||||||
@@ -0,0 +1,24 @@
|
|||||||
|
# bazarr's runtime: the tool runtime, carrying this module's compiled code.
|
||||||
|
#
|
||||||
|
# **Built from this module's own directory and nothing else.** The sdk and the tool runtime are in
|
||||||
|
# the base images, published like any other artifact — which is what makes this buildable by the
|
||||||
|
# mesh from a repository and a path (novox/hq ADR 0069) rather than only on a workstation that
|
||||||
|
# happens to have the siblings.
|
||||||
|
#
|
||||||
|
# Two bases, named rather than pinned (novox/hq issue 044): the image this is COMPILED in and the
|
||||||
|
# image it RUNS in — the second must not carry a compiler. Declared in module.json's `build.on`.
|
||||||
|
ARG BUILD_BASE
|
||||||
|
ARG RUNTIME_BASE
|
||||||
|
|
||||||
|
FROM ${BUILD_BASE} AS build
|
||||||
|
WORKDIR /app/modules/bazarr
|
||||||
|
COPY . .
|
||||||
|
RUN node /app/node_modules/typescript/bin/tsc client.ts index.ts tools/index.ts \
|
||||||
|
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
||||||
|
|
||||||
|
FROM ${RUNTIME_BASE}
|
||||||
|
COPY --from=build /app/modules/bazarr/dist /app/modules/bazarr/dist
|
||||||
|
# Every serve-time entrypoint, loaded by the runtime in serve mode: tools and events serve, and a
|
||||||
|
# provider's provisioner runs its reconcile loop in the same process, with the broker connected —
|
||||||
|
# the convention novox/hq issues 060/061 settled.
|
||||||
|
ENV MESH_TOOL_MODULES=/app/modules/bazarr/dist/index.js,/app/modules/bazarr/dist/tools/index.js
|
||||||
@@ -0,0 +1,173 @@
|
|||||||
|
// The Bazarr API client — bazarr's own code, living in the module (novox/hq ADR 0039). Bazarr
|
||||||
|
// manages subtitles for a Sonarr/Radarr library: it tracks which episodes and movies are still
|
||||||
|
// missing subtitles, searches providers for them, and records what it downloaded. This client
|
||||||
|
// talks its /api surface (keyed by an X-API-KEY header); bazarr's tools and events import it.
|
||||||
|
|
||||||
|
import { readFileSync } from "node:fs";
|
||||||
|
|
||||||
|
export interface WantedSubtitle {
|
||||||
|
kind: "episode" | "movie";
|
||||||
|
title: string; // series + episode, or movie title
|
||||||
|
path?: string;
|
||||||
|
seriesId?: number; // sonarr series id (episodes)
|
||||||
|
episodeId?: number; // sonarr episode id (episodes)
|
||||||
|
radarrId?: number; // radarr movie id (movies)
|
||||||
|
missing: string[]; // language names still missing
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ProviderSubtitle {
|
||||||
|
provider: string;
|
||||||
|
language: string;
|
||||||
|
hearingImpaired: boolean;
|
||||||
|
forced: boolean;
|
||||||
|
score?: number;
|
||||||
|
release?: string;
|
||||||
|
subtitle: string; // the opaque token Bazarr uses to download this exact result
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface HistoryEntry {
|
||||||
|
kind: "episode" | "movie";
|
||||||
|
id: string; // stable dedup key across polls
|
||||||
|
title: string;
|
||||||
|
language?: string;
|
||||||
|
provider?: string;
|
||||||
|
path?: string;
|
||||||
|
timestamp?: string;
|
||||||
|
description?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The settings-merged config the mesh delivers (novox/hq ADR 0046): { url, apiKey, token, password, user, ... }. */
|
||||||
|
function meshConfig(file?: string): Record<string, string> {
|
||||||
|
if (!file) return {};
|
||||||
|
try { return JSON.parse(readFileSync(file, "utf8")) as Record<string, string>; }
|
||||||
|
catch { return {}; }
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Read a secret the mesh mounted at a file path (an own-secret delivered by `secret accept`);
|
||||||
|
* absent or unreadable yields undefined so callers fall back rather than crash. */
|
||||||
|
function readSecret(file?: string): string | undefined {
|
||||||
|
if (!file) return undefined;
|
||||||
|
try { return readFileSync(file, "utf8").trim(); }
|
||||||
|
catch { return undefined; }
|
||||||
|
}
|
||||||
|
|
||||||
|
export class BazarrClient {
|
||||||
|
readonly baseUrl: string;
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
url: string,
|
||||||
|
private readonly apiKey: string,
|
||||||
|
) {
|
||||||
|
this.baseUrl = url.replace(/\/$/, "");
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Build from the module's resolved environment. Bazarr's API is keyed; without URL and key
|
||||||
|
* there is nothing to talk to, so this throws rather than run half-configured. */
|
||||||
|
static fromEnv(env: NodeJS.ProcessEnv = process.env): BazarrClient {
|
||||||
|
const cfg = meshConfig(env.MESH_BAZARR_CONFIG_FILE);
|
||||||
|
const url = cfg.url ?? env.MESH_BAZARR_URL;
|
||||||
|
const apiKey = cfg.apiKey ?? readSecret(env.MESH_BAZARR_API_KEY_FILE) ?? env.MESH_BAZARR_API_KEY;
|
||||||
|
if (!url) throw new Error("no Bazarr URL — set MESH_BAZARR_URL");
|
||||||
|
if (!apiKey) throw new Error("no Bazarr API key — set MESH_BAZARR_API_KEY");
|
||||||
|
return new BazarrClient(url, apiKey);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async request(method: string, path: string, params: Record<string, string> = {}): Promise<any> {
|
||||||
|
const url = new URL(`${this.baseUrl}/api${path}`);
|
||||||
|
for (const [k, v] of Object.entries(params)) url.searchParams.set(k, v);
|
||||||
|
const res = await fetch(url.toString(), { method, headers: { "X-API-KEY": this.apiKey, Accept: "application/json" } });
|
||||||
|
if (!res.ok) throw new Error(`Bazarr API ${method} ${path}: ${res.status} ${await res.text()}`);
|
||||||
|
// Downloads/patches return an empty body; only GETs carry JSON.
|
||||||
|
const text = await res.text();
|
||||||
|
return text ? JSON.parse(text) : {};
|
||||||
|
}
|
||||||
|
|
||||||
|
private get(path: string, params?: Record<string, string>): Promise<any> {
|
||||||
|
return this.request("GET", path, params);
|
||||||
|
}
|
||||||
|
|
||||||
|
private languageNames(missing: any[]): string[] {
|
||||||
|
return (missing ?? []).map((m: any) => m?.name ?? m?.code2 ?? m?.code3).filter(Boolean);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Episodes and movies still missing subtitles — Bazarr's core "what's left to do" list. */
|
||||||
|
async getWanted(limit = 50): Promise<WantedSubtitle[]> {
|
||||||
|
const [eps, movies] = await Promise.all([
|
||||||
|
this.get("/episodes/wanted", { start: "0", length: String(limit) }),
|
||||||
|
this.get("/movies/wanted", { start: "0", length: String(limit) }),
|
||||||
|
]);
|
||||||
|
const episodes: WantedSubtitle[] = (eps?.data ?? []).map((e: any) => ({
|
||||||
|
kind: "episode" as const,
|
||||||
|
title: `${e.seriesTitle ?? e.series ?? "Unknown"} — ${e.episodeTitle ?? e.episode_title ?? ""}`.trim(),
|
||||||
|
path: e.path,
|
||||||
|
seriesId: e.sonarrSeriesId,
|
||||||
|
episodeId: e.sonarrEpisodeId,
|
||||||
|
missing: this.languageNames(e.missing_subtitles),
|
||||||
|
}));
|
||||||
|
const films: WantedSubtitle[] = (movies?.data ?? []).map((m: any) => ({
|
||||||
|
kind: "movie" as const,
|
||||||
|
title: m.title ?? "Unknown",
|
||||||
|
path: m.path,
|
||||||
|
radarrId: m.radarrId,
|
||||||
|
missing: this.languageNames(m.missing_subtitles),
|
||||||
|
}));
|
||||||
|
return [...episodes, ...films];
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Ask providers what subtitles are available for one wanted episode — a manual search. */
|
||||||
|
async searchEpisode(episodeId: number): Promise<ProviderSubtitle[]> {
|
||||||
|
const raw = await this.get("/providers/episodes", { episodeid: String(episodeId) });
|
||||||
|
return this.mapProviderResults(raw);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Ask providers what subtitles are available for one movie — a manual search. */
|
||||||
|
async searchMovie(radarrId: number): Promise<ProviderSubtitle[]> {
|
||||||
|
const raw = await this.get("/providers/movies", { radarrid: String(radarrId) });
|
||||||
|
return this.mapProviderResults(raw);
|
||||||
|
}
|
||||||
|
|
||||||
|
private mapProviderResults(raw: any): ProviderSubtitle[] {
|
||||||
|
const list = Array.isArray(raw) ? raw : (raw?.data ?? []);
|
||||||
|
return list.map((r: any) => ({
|
||||||
|
provider: r.provider,
|
||||||
|
language: r.language?.name ?? r.language ?? "unknown",
|
||||||
|
hearingImpaired: Boolean(r.hearing_impaired ?? r.hi),
|
||||||
|
forced: Boolean(r.forced),
|
||||||
|
score: r.score,
|
||||||
|
release: r.release_info?.[0] ?? r.release_info,
|
||||||
|
subtitle: r.subtitle,
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Recent subtitle-download history, episodes and movies together, newest first. Each entry
|
||||||
|
* carries a stable id so the events poller can tell a fresh download from one already seen. */
|
||||||
|
async getHistory(limit = 40): Promise<HistoryEntry[]> {
|
||||||
|
const [eps, movies] = await Promise.all([
|
||||||
|
this.get("/episodes/history", { start: "0", length: String(limit) }),
|
||||||
|
this.get("/movies/history", { start: "0", length: String(limit) }),
|
||||||
|
]);
|
||||||
|
const key = (kind: string, r: any): string =>
|
||||||
|
`${kind}:${r.timestamp ?? r.parsed_timestamp ?? ""}:${r.subtitles_path ?? r.path ?? ""}:${r.language?.code3 ?? r.language ?? ""}`;
|
||||||
|
const episodes: HistoryEntry[] = (eps?.data ?? []).map((r: any) => ({
|
||||||
|
kind: "episode" as const,
|
||||||
|
id: key("episode", r),
|
||||||
|
title: `${r.seriesTitle ?? "Unknown"} — ${r.episodeTitle ?? ""}`.trim(),
|
||||||
|
language: r.language?.name ?? r.language,
|
||||||
|
provider: r.provider,
|
||||||
|
path: r.subtitles_path,
|
||||||
|
timestamp: r.timestamp,
|
||||||
|
description: r.description,
|
||||||
|
}));
|
||||||
|
const films: HistoryEntry[] = (movies?.data ?? []).map((r: any) => ({
|
||||||
|
kind: "movie" as const,
|
||||||
|
id: key("movie", r),
|
||||||
|
title: r.title ?? "Unknown",
|
||||||
|
language: r.language?.name ?? r.language,
|
||||||
|
provider: r.provider,
|
||||||
|
path: r.subtitles_path,
|
||||||
|
timestamp: r.timestamp,
|
||||||
|
description: r.description,
|
||||||
|
}));
|
||||||
|
return [...episodes, ...films];
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
// bazarr's events. The tool runtime imports this once the broker is bound. Bazarr's one genuinely
|
||||||
|
// observable thing is a subtitle arriving: it works away in the background, searching providers for
|
||||||
|
// the missing-subtitle list, and when it succeeds a subtitle appears in its history. That is worth
|
||||||
|
// announcing to the mesh.
|
||||||
|
//
|
||||||
|
// Emits (novox/hq ADR 0041/0042):
|
||||||
|
// module.bazarr.subtitle.downloaded — a subtitle was fetched for an episode or movie
|
||||||
|
//
|
||||||
|
// Bazarr has nothing on the mesh it usefully reacts to (a download completing is Sonarr/Radarr's
|
||||||
|
// business, and they trigger Bazarr directly), so it consumes nothing — a pure emitter.
|
||||||
|
//
|
||||||
|
// The event is observation-based: poll history and diff. Primed silently on the first look, or a
|
||||||
|
// restart would re-announce the whole recent history as freshly downloaded.
|
||||||
|
|
||||||
|
import { emit } from "@novox/mesh-sdk/events";
|
||||||
|
import { BazarrClient } from "./client.js";
|
||||||
|
|
||||||
|
const bazarr = BazarrClient.fromEnv();
|
||||||
|
|
||||||
|
const seen = new Set<string>();
|
||||||
|
let primed = false;
|
||||||
|
async function pollHistory(): Promise<void> {
|
||||||
|
const entries = await bazarr.getHistory(40);
|
||||||
|
for (const entry of entries) {
|
||||||
|
if (seen.has(entry.id)) continue;
|
||||||
|
if (primed) {
|
||||||
|
await emit("subtitle.downloaded", {
|
||||||
|
kind: entry.kind,
|
||||||
|
title: entry.title,
|
||||||
|
language: entry.language,
|
||||||
|
provider: entry.provider,
|
||||||
|
path: entry.path,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
seen.add(entry.id);
|
||||||
|
}
|
||||||
|
primed = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
const tick = (fn: () => Promise<void>, everyMs: number): void => {
|
||||||
|
const run = (): void => void fn().catch((err) => console.error(`[bazarr] ${err}`));
|
||||||
|
setInterval(run, everyMs);
|
||||||
|
run();
|
||||||
|
};
|
||||||
|
tick(pollHistory, 60_000);
|
||||||
|
|
||||||
|
console.log("[bazarr] watching subtitle-download history");
|
||||||
@@ -0,0 +1,141 @@
|
|||||||
|
{
|
||||||
|
"module": "bazarr",
|
||||||
|
"version": "1",
|
||||||
|
"capabilities": [
|
||||||
|
"container-runtime"
|
||||||
|
],
|
||||||
|
"emits": [
|
||||||
|
"subtitle.downloaded"
|
||||||
|
],
|
||||||
|
"own-secrets": {
|
||||||
|
"broker": "/var/lib/mesh/bazarr/broker",
|
||||||
|
"api-key": "/var/lib/mesh/bazarr/api-key"
|
||||||
|
},
|
||||||
|
"listens": [
|
||||||
|
{
|
||||||
|
"name": "web",
|
||||||
|
"port": 6767,
|
||||||
|
"protocol": "tcp",
|
||||||
|
"from": "mesh",
|
||||||
|
"why": "managing subtitles"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"accesses": [
|
||||||
|
{
|
||||||
|
"path": "/services/media/movies",
|
||||||
|
"mode": "read-write"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"path": "/services/media/series",
|
||||||
|
"mode": "read-write"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"path": "/services/media/anime",
|
||||||
|
"mode": "read-write"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"path": "/services/media/downloads",
|
||||||
|
"mode": "read"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"resources": [
|
||||||
|
{
|
||||||
|
"id": "mesh-state",
|
||||||
|
"type": "directory",
|
||||||
|
"path": "/var/lib/mesh/bazarr",
|
||||||
|
"mode": "0700"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "config",
|
||||||
|
"type": "directory",
|
||||||
|
"path": "/services/bazarr/config",
|
||||||
|
"mode": "0700",
|
||||||
|
"owner": "1000:1000"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "server",
|
||||||
|
"type": "container",
|
||||||
|
"name": "bazarr",
|
||||||
|
"image": "lscr.io/linuxserver/bazarr@sha256:3a820372f19fcb2981ea19fe4b5382934d67414afaba974bce831ddda0a64a02",
|
||||||
|
"env": {
|
||||||
|
"PUID": "1000",
|
||||||
|
"PGID": "1000",
|
||||||
|
"TZ": "Etc/UTC"
|
||||||
|
},
|
||||||
|
"ports": [
|
||||||
|
"6767"
|
||||||
|
],
|
||||||
|
"volumes": [
|
||||||
|
"/services/bazarr/config:/config",
|
||||||
|
"/services/media/movies:/movies",
|
||||||
|
"/services/media/series:/series",
|
||||||
|
"/services/media/anime:/anime",
|
||||||
|
"/services/media/downloads:/downloads"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "runtime-config",
|
||||||
|
"type": "file",
|
||||||
|
"path": "/var/lib/mesh/bazarr/config.json",
|
||||||
|
"mode": "0600",
|
||||||
|
"content": "{}\n",
|
||||||
|
"merge": "json"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "runtime",
|
||||||
|
"type": "container",
|
||||||
|
"name": "mesh-bazarr",
|
||||||
|
"network": "host",
|
||||||
|
"volumes": [
|
||||||
|
"/var/lib/mesh/bazarr/broker:/run/secrets/broker:ro",
|
||||||
|
"/var/lib/mesh/bazarr/api-key:/run/secrets/api-key:ro",
|
||||||
|
"/var/lib/mesh/bazarr/config.json:/run/config/config.json:ro",
|
||||||
|
"/services/bazarr/config:/var/lib/bazarr/config:ro"
|
||||||
|
],
|
||||||
|
"env": {
|
||||||
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
|
"MESH_BAZARR_URL": "http://127.0.0.1:${port:6767}",
|
||||||
|
"MESH_BAZARR_API_KEY_FILE": "/run/secrets/api-key",
|
||||||
|
"MESH_BAZARR_CONFIG_FILE": "/run/config/config.json",
|
||||||
|
"MESH_BAZARR_CONFIG_DIR": "/var/lib/bazarr/config"
|
||||||
|
},
|
||||||
|
"restart-on": [
|
||||||
|
"runtime-config"
|
||||||
|
],
|
||||||
|
"artifact": "runtime"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"requires": [
|
||||||
|
"route"
|
||||||
|
],
|
||||||
|
"contributes": {
|
||||||
|
"route": {
|
||||||
|
"label": "subs",
|
||||||
|
"endpoint": "web"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"binds": {
|
||||||
|
"route": "/var/lib/mesh/bazarr/route.json"
|
||||||
|
},
|
||||||
|
"build": {
|
||||||
|
"on": [
|
||||||
|
{
|
||||||
|
"arg": "BUILD_BASE",
|
||||||
|
"module": "mesh-tools",
|
||||||
|
"artifact": "build"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"arg": "RUNTIME_BASE",
|
||||||
|
"module": "mesh-tools",
|
||||||
|
"artifact": "runtime"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"artifacts": [
|
||||||
|
{
|
||||||
|
"name": "runtime",
|
||||||
|
"kind": "image",
|
||||||
|
"from": "Dockerfile"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
{
|
||||||
|
"name": "@novox/module-bazarr",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "bazarr — subtitle management. Its API client, tools and events live here (novox/hq ADR 0039).",
|
||||||
|
"type": "module",
|
||||||
|
"private": true,
|
||||||
|
"dependencies": {
|
||||||
|
"@novox/mesh-sdk": "^0.1.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/node": "^22.0.0",
|
||||||
|
"typescript": "^5.6.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
// bazarr's tools — its own code (novox/hq ADR 0039), importing bazarr's client. They return
|
||||||
|
// structured data; the mesh serves them through the sdk's tool harness.
|
||||||
|
|
||||||
|
import { registerModuleTools, type ToolDefinition } from "@novox/mesh-sdk/tools";
|
||||||
|
import { BazarrClient } from "../client.js";
|
||||||
|
|
||||||
|
export function getBazarrTools(bazarr: BazarrClient): ToolDefinition[] {
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
name: "bazarr_wanted",
|
||||||
|
description: "Episodes and movies still missing subtitles, with the languages each still needs.",
|
||||||
|
input: { limit: { type: "number", description: "max items per kind (default 50)" } },
|
||||||
|
run: async (args) => {
|
||||||
|
const wanted = await bazarr.getWanted(args.limit ? Number(args.limit) : 50);
|
||||||
|
return { count: wanted.length, wanted };
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "bazarr_search_subtitles",
|
||||||
|
description: "Manually search subtitle providers for one wanted item — pass an episodeId or a radarrId.",
|
||||||
|
input: {
|
||||||
|
episodeId: { type: "number", description: "a Sonarr episode id (from bazarr_wanted)" },
|
||||||
|
radarrId: { type: "number", description: "a Radarr movie id (from bazarr_wanted)" },
|
||||||
|
},
|
||||||
|
run: async (args) => {
|
||||||
|
if (args.episodeId !== undefined) {
|
||||||
|
const results = await bazarr.searchEpisode(Number(args.episodeId));
|
||||||
|
return { kind: "episode", episodeId: Number(args.episodeId), count: results.length, results };
|
||||||
|
}
|
||||||
|
if (args.radarrId !== undefined) {
|
||||||
|
const results = await bazarr.searchMovie(Number(args.radarrId));
|
||||||
|
return { kind: "movie", radarrId: Number(args.radarrId), count: results.length, results };
|
||||||
|
}
|
||||||
|
throw new Error("pass either episodeId or radarrId");
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "bazarr_history",
|
||||||
|
description: "Recent subtitle-download history — what was downloaded, for which title, from which provider.",
|
||||||
|
input: { limit: { type: "number", description: "max entries per kind (default 40)" } },
|
||||||
|
run: async (args) => {
|
||||||
|
const history = await bazarr.getHistory(args.limit ? Number(args.limit) : 40);
|
||||||
|
return { count: history.length, history };
|
||||||
|
},
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
// Exposed only when Bazarr is configured; otherwise bazarr contributes no tools rather than
|
||||||
|
// failing the whole runtime.
|
||||||
|
registerModuleTools("bazarr", (env) => {
|
||||||
|
try {
|
||||||
|
return getBazarrTools(BazarrClient.fromEnv(env));
|
||||||
|
} catch {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
});
|
||||||
@@ -8,5 +8,5 @@
|
|||||||
"skipLibCheck": true,
|
"skipLibCheck": true,
|
||||||
"noEmit": true
|
"noEmit": true
|
||||||
},
|
},
|
||||||
"include": ["records.ts", "index.ts", "tools/index.ts"]
|
"include": ["client.ts", "index.ts", "tools/index.ts"]
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
# bookshelf's runtime: the tool runtime, carrying this module's compiled code.
|
||||||
|
#
|
||||||
|
# **Built from this module's own directory and nothing else.** The sdk and the tool runtime are in
|
||||||
|
# the base images, published like any other artifact — which is what makes this buildable by the
|
||||||
|
# mesh from a repository and a path (novox/hq ADR 0069) rather than only on a workstation that
|
||||||
|
# happens to have the siblings.
|
||||||
|
#
|
||||||
|
# Two bases, named rather than pinned (novox/hq issue 044): the image this is COMPILED in and the
|
||||||
|
# image it RUNS in — the second must not carry a compiler. Declared in module.json's `build.on`.
|
||||||
|
ARG BUILD_BASE
|
||||||
|
ARG RUNTIME_BASE
|
||||||
|
|
||||||
|
FROM ${BUILD_BASE} AS build
|
||||||
|
WORKDIR /app/modules/bookshelf
|
||||||
|
COPY . .
|
||||||
|
RUN node /app/node_modules/typescript/bin/tsc client.ts index.ts tools/index.ts \
|
||||||
|
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
||||||
|
|
||||||
|
FROM ${RUNTIME_BASE}
|
||||||
|
COPY --from=build /app/modules/bookshelf/dist /app/modules/bookshelf/dist
|
||||||
|
# Every serve-time entrypoint, loaded by the runtime in serve mode: tools and events serve, and a
|
||||||
|
# provider's provisioner runs its reconcile loop in the same process, with the broker connected —
|
||||||
|
# the convention novox/hq issues 060/061 settled.
|
||||||
|
ENV MESH_TOOL_MODULES=/app/modules/bookshelf/dist/index.js,/app/modules/bookshelf/dist/tools/index.js
|
||||||
@@ -0,0 +1,136 @@
|
|||||||
|
// The Bookshelf API client — bookshelf's own code, living in the module (novox/hq ADR 0039).
|
||||||
|
// Ported from the shared hal `arr` client, but self-contained: in nox each Servarr app owns its own
|
||||||
|
// copy, so a change to Bookshelf's API rebuilds only bookshelf and nothing else. Both this module's
|
||||||
|
// tools and its events entrypoint import it, and nothing outside bookshelf does.
|
||||||
|
//
|
||||||
|
// Bookshelf is a Readarr fork (ghcr.io/pennydreadful/bookshelf). It speaks the Servarr v1 API; its
|
||||||
|
// content is "book". Unlike Sonarr/Radarr it exposes no calendar endpoint, so there is no calendar
|
||||||
|
// tool here — matching hal, which excluded bookshelf from its calendar-capable apps.
|
||||||
|
|
||||||
|
import { existsSync, readFileSync } from "node:fs";
|
||||||
|
import { join } from "node:path";
|
||||||
|
|
||||||
|
// Bookshelf speaks the v1 API; its content is "book".
|
||||||
|
const API_VERSION = "v1";
|
||||||
|
const CONTENT_ENDPOINT = "book";
|
||||||
|
const APP_NAME = "Bookshelf";
|
||||||
|
|
||||||
|
export interface BookshelfQueueItem {
|
||||||
|
/** The queue record id — stable while the item is in the queue, so events can diff on it. */
|
||||||
|
id: number;
|
||||||
|
title: string;
|
||||||
|
status: string;
|
||||||
|
size: string;
|
||||||
|
sizeleft: string;
|
||||||
|
timeleft?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface BookshelfContentItem {
|
||||||
|
title: string;
|
||||||
|
author?: string;
|
||||||
|
year?: number;
|
||||||
|
status?: string;
|
||||||
|
monitored: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class BookshelfClient {
|
||||||
|
readonly baseUrl: string;
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
url: string,
|
||||||
|
private readonly apiKey: string,
|
||||||
|
) {
|
||||||
|
this.baseUrl = url.replace(/\/$/, "");
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build from the module's resolved environment. The URL defaults to the server on this node (the
|
||||||
|
* runtime shares its network), and the API key is read from MESH_BOOKSHELF_API_KEY or, failing
|
||||||
|
* that, discovered from the server's own config.xml under MESH_BOOKSHELF_CONFIG_DIR — the same
|
||||||
|
* file Bookshelf writes it to, so a running server needs nothing configured by hand. Throws when
|
||||||
|
* no key can be found, so the tools/events simply do not load (the harness treats the throw as
|
||||||
|
* "exposes nothing").
|
||||||
|
*/
|
||||||
|
static fromEnv(env: NodeJS.ProcessEnv = process.env): BookshelfClient {
|
||||||
|
const url = env.MESH_BOOKSHELF_URL ?? `http://127.0.0.1:${env.MESH_BOOKSHELF_PORT ?? "8787"}`;
|
||||||
|
const configDir = env.MESH_BOOKSHELF_CONFIG_DIR ?? "/config";
|
||||||
|
const apiKey = env.MESH_BOOKSHELF_API_KEY ?? BookshelfClient.detectApiKey(configDir);
|
||||||
|
if (!apiKey) {
|
||||||
|
throw new Error("Bookshelf not configured — set MESH_BOOKSHELF_API_KEY or make the config dir readable");
|
||||||
|
}
|
||||||
|
return new BookshelfClient(url, apiKey);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Discover the API key from the server's config.xml, falling back to null. Every Servarr app
|
||||||
|
* writes <ApiKey> into config.xml at the root of its config directory. */
|
||||||
|
static detectApiKey(configDir: string): string | null {
|
||||||
|
const config = join(configDir, "config.xml");
|
||||||
|
if (existsSync(config)) {
|
||||||
|
const match = readFileSync(config, "utf8").match(/<ApiKey>([^<]+)<\/ApiKey>/);
|
||||||
|
if (match) return match[1];
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
private async get(endpoint: string, params?: Record<string, string>): Promise<unknown> {
|
||||||
|
const url = new URL(`${this.baseUrl}/api/${API_VERSION}/${endpoint}`);
|
||||||
|
if (params) {
|
||||||
|
for (const [k, v] of Object.entries(params)) url.searchParams.set(k, v);
|
||||||
|
}
|
||||||
|
const res = await fetch(url.toString(), { headers: { "X-Api-Key": this.apiKey } });
|
||||||
|
if (!res.ok) throw new Error(`${APP_NAME} API /${endpoint}: ${res.status} ${await res.text()}`);
|
||||||
|
return res.json();
|
||||||
|
}
|
||||||
|
|
||||||
|
async getStatus(): Promise<{ appName: string; version: string }> {
|
||||||
|
const data = (await this.get("system/status")) as { appName?: string; version?: string };
|
||||||
|
return { appName: data.appName || APP_NAME, version: data.version ?? "unknown" };
|
||||||
|
}
|
||||||
|
|
||||||
|
async getContent(limit?: number): Promise<BookshelfContentItem[]> {
|
||||||
|
const data = await this.get(CONTENT_ENDPOINT);
|
||||||
|
const items: any[] = Array.isArray(data) ? data : ((data as any)?.records ?? []);
|
||||||
|
const mapped = items.map((item) => ({
|
||||||
|
title: item.title ?? "Unknown",
|
||||||
|
author: item.author?.authorName ?? item.authorName,
|
||||||
|
year: item.releaseDate ? new Date(item.releaseDate).getFullYear() : item.year,
|
||||||
|
status: item.status,
|
||||||
|
monitored: item.monitored ?? true,
|
||||||
|
}));
|
||||||
|
return limit ? mapped.slice(0, limit) : mapped;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Library search is a filter over existing content, not an indexer lookup — same as hal's. */
|
||||||
|
async searchContent(term: string): Promise<BookshelfContentItem[]> {
|
||||||
|
const all = await this.getContent();
|
||||||
|
const lower = term.toLowerCase();
|
||||||
|
return all.filter(
|
||||||
|
(item) =>
|
||||||
|
item.title.toLowerCase().includes(lower) ||
|
||||||
|
(item.author?.toLowerCase().includes(lower) ?? false),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
async getQueue(): Promise<{ totalRecords: number; items: BookshelfQueueItem[] }> {
|
||||||
|
const data = (await this.get("queue", { pageSize: "50" })) as { totalRecords?: number; records?: any[] };
|
||||||
|
const records = data.records ?? [];
|
||||||
|
return {
|
||||||
|
totalRecords: data.totalRecords ?? records.length,
|
||||||
|
items: records.map((r) => ({
|
||||||
|
id: r.id,
|
||||||
|
title: r.title ?? r.book?.title ?? r.author?.authorName ?? "Unknown",
|
||||||
|
status: r.status ?? "unknown",
|
||||||
|
size: formatBytes(r.size ?? 0),
|
||||||
|
sizeleft: formatBytes(r.sizeleft ?? 0),
|
||||||
|
timeleft: r.timeleft,
|
||||||
|
})),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function formatBytes(bytes: number): string {
|
||||||
|
if (bytes === 0) return "0 B";
|
||||||
|
const units = ["B", "KB", "MB", "GB", "TB"];
|
||||||
|
const i = Math.floor(Math.log(bytes) / Math.log(1024));
|
||||||
|
return `${(bytes / Math.pow(1024, i)).toFixed(1)} ${units[i]}`;
|
||||||
|
}
|
||||||
@@ -0,0 +1,74 @@
|
|||||||
|
// bookshelf's events. The tool runtime imports this once the broker is bound. It watches the
|
||||||
|
// download queue and turns its comings and goings into mesh events — the same mechanism radarr uses,
|
||||||
|
// applied to a Servarr book manager.
|
||||||
|
//
|
||||||
|
// Emits (novox/hq ADR 0041/0042):
|
||||||
|
// module.bookshelf.book.grabbed — a release entered the queue (Bookshelf grabbed it)
|
||||||
|
// module.bookshelf.download.completed — a release left the queue, imported. This routing key is
|
||||||
|
// what the plex module consumes (module.*.download.completed)
|
||||||
|
// to rescan, so a new audiobook becomes a visible item.
|
||||||
|
// Consumes: none.
|
||||||
|
//
|
||||||
|
// NOTE: the hal bookshelf module emitted no events (its hooks only did install-time provisioning).
|
||||||
|
// This queue watcher is new in nox, modelled exactly on radarr's — bookshelf is a Servarr app with
|
||||||
|
// the same queue semantics, so the diff-and-emit pattern carries over unchanged.
|
||||||
|
//
|
||||||
|
// The queue is polled and diffed, primed silently on the first look (like plex's index.ts) so a
|
||||||
|
// restart mid-download does not re-announce everything already in flight as freshly grabbed.
|
||||||
|
|
||||||
|
import { emit } from "@novox/mesh-sdk/events";
|
||||||
|
import { BookshelfClient, type BookshelfQueueItem } from "./client.js";
|
||||||
|
|
||||||
|
// Building the client throws when Bookshelf has no URL/key yet. Like the tools (see tools/index.ts),
|
||||||
|
// the events entrypoint must not crash the runtime for that — it stays idle until configured.
|
||||||
|
function buildClient(): BookshelfClient | null {
|
||||||
|
try {
|
||||||
|
return BookshelfClient.fromEnv();
|
||||||
|
} catch {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const bookshelf = buildClient();
|
||||||
|
|
||||||
|
// Bookshelf removes an item from the queue once it has been imported; a "warning"/"failed" status is
|
||||||
|
// how a stuck or broken grab shows itself, so we do not call those a completion when they vanish.
|
||||||
|
const FAILED_STATUSES = new Set(["failed", "warning"]);
|
||||||
|
|
||||||
|
const inQueue = new Map<number, BookshelfQueueItem>();
|
||||||
|
let primed = false;
|
||||||
|
|
||||||
|
async function pollQueue(bookshelf: BookshelfClient): Promise<void> {
|
||||||
|
const { items } = await bookshelf.getQueue();
|
||||||
|
const now = new Map(items.map((i) => [i.id, i]));
|
||||||
|
|
||||||
|
if (primed) {
|
||||||
|
// Entered the queue since last look — Bookshelf grabbed a release.
|
||||||
|
for (const [id, item] of now) {
|
||||||
|
if (!inQueue.has(id)) await emit("book.grabbed", { title: item.title, status: item.status });
|
||||||
|
}
|
||||||
|
// Left the queue — imported and done, unless it was last seen failing.
|
||||||
|
for (const [id, item] of inQueue) {
|
||||||
|
if (!now.has(id) && !FAILED_STATUSES.has(item.status)) {
|
||||||
|
await emit("download.completed", { title: item.title });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
inQueue.clear();
|
||||||
|
for (const [id, item] of now) inQueue.set(id, item);
|
||||||
|
primed = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
const tick = (fn: () => Promise<void>, everyMs: number): void => {
|
||||||
|
const run = (): void => void fn().catch((err) => console.error(`[bookshelf] ${err}`));
|
||||||
|
setInterval(run, everyMs);
|
||||||
|
run();
|
||||||
|
};
|
||||||
|
|
||||||
|
if (bookshelf) {
|
||||||
|
tick(() => pollQueue(bookshelf), 30_000);
|
||||||
|
console.log("[bookshelf] watching the download queue, emitting grabs and completions");
|
||||||
|
} else {
|
||||||
|
console.log("[bookshelf] not configured — events idle until an API key is available");
|
||||||
|
}
|
||||||
@@ -0,0 +1,118 @@
|
|||||||
|
{
|
||||||
|
"module": "bookshelf",
|
||||||
|
"version": "1",
|
||||||
|
"slug": "books",
|
||||||
|
"capabilities": [
|
||||||
|
"container-runtime"
|
||||||
|
],
|
||||||
|
"emits": [
|
||||||
|
"book.grabbed",
|
||||||
|
"download.completed"
|
||||||
|
],
|
||||||
|
"consumes": [],
|
||||||
|
"own-secrets": {
|
||||||
|
"broker": "/var/lib/mesh/bookshelf/broker"
|
||||||
|
},
|
||||||
|
"listens": [
|
||||||
|
{
|
||||||
|
"name": "web",
|
||||||
|
"port": 8787,
|
||||||
|
"protocol": "tcp",
|
||||||
|
"from": "mesh",
|
||||||
|
"why": "managing the ebook/audiobook library"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"accesses": [
|
||||||
|
{
|
||||||
|
"path": "/services/media/books",
|
||||||
|
"mode": "read-write"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"path": "/services/media/downloads",
|
||||||
|
"mode": "read-write"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"resources": [
|
||||||
|
{
|
||||||
|
"id": "mesh-state",
|
||||||
|
"type": "directory",
|
||||||
|
"path": "/var/lib/mesh/bookshelf",
|
||||||
|
"mode": "0700"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "config",
|
||||||
|
"type": "directory",
|
||||||
|
"path": "/services/bookshelf/config",
|
||||||
|
"mode": "0700",
|
||||||
|
"owner": "1000:1000"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "server",
|
||||||
|
"type": "container",
|
||||||
|
"name": "bookshelf",
|
||||||
|
"image": "ghcr.io/pennydreadful/bookshelf@sha256:388eecc94362580eae31ee0a454be6af516f8a311f8432a521c202fb475f4359",
|
||||||
|
"env": {
|
||||||
|
"PUID": "1000",
|
||||||
|
"PGID": "1000",
|
||||||
|
"TZ": "Etc/UTC"
|
||||||
|
},
|
||||||
|
"ports": [
|
||||||
|
"8787"
|
||||||
|
],
|
||||||
|
"volumes": [
|
||||||
|
"/services/bookshelf/config:/config",
|
||||||
|
"/services/media/books:/books",
|
||||||
|
"/services/media/downloads:/downloads"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "runtime",
|
||||||
|
"type": "container",
|
||||||
|
"name": "mesh-bookshelf",
|
||||||
|
"network": "host",
|
||||||
|
"volumes": [
|
||||||
|
"/var/lib/mesh/bookshelf/broker:/run/secrets/broker:ro",
|
||||||
|
"/services/bookshelf/config:/var/lib/bookshelf/config:ro"
|
||||||
|
],
|
||||||
|
"env": {
|
||||||
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
|
"MESH_BOOKSHELF_URL": "http://127.0.0.1:${port:8787}",
|
||||||
|
"MESH_BOOKSHELF_CONFIG_DIR": "/var/lib/bookshelf/config"
|
||||||
|
},
|
||||||
|
"artifact": "runtime"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"requires": [
|
||||||
|
"route"
|
||||||
|
],
|
||||||
|
"contributes": {
|
||||||
|
"route": {
|
||||||
|
"label": "books",
|
||||||
|
"endpoint": "web"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"binds": {
|
||||||
|
"route": "/var/lib/mesh/bookshelf/route.json"
|
||||||
|
},
|
||||||
|
"build": {
|
||||||
|
"on": [
|
||||||
|
{
|
||||||
|
"arg": "BUILD_BASE",
|
||||||
|
"module": "mesh-tools",
|
||||||
|
"artifact": "build"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"arg": "RUNTIME_BASE",
|
||||||
|
"module": "mesh-tools",
|
||||||
|
"artifact": "runtime"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"artifacts": [
|
||||||
|
{
|
||||||
|
"name": "runtime",
|
||||||
|
"kind": "image",
|
||||||
|
"from": "Dockerfile"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
{
|
||||||
|
"name": "@novox/module-bookshelf",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "bookshelf — ebook/audiobook management (Readarr fork). Its API client, tools and events live here (novox/hq ADR 0039).",
|
||||||
|
"type": "module",
|
||||||
|
"private": true,
|
||||||
|
"dependencies": {
|
||||||
|
"@novox/mesh-sdk": "^0.1.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/node": "^22.0.0",
|
||||||
|
"typescript": "^5.6.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
// bookshelf's tools — ported from the shared hal `arr` sdk (novox/hq ADR 0039), importing
|
||||||
|
// bookshelf's own client. They return structured data (not the pre-formatted text hal returned); the
|
||||||
|
// mesh serves them through the sdk's tool harness. Bookshelf has no calendar endpoint, so there is
|
||||||
|
// no calendar tool — matching hal, which excluded it from its calendar-capable apps.
|
||||||
|
|
||||||
|
import { registerModuleTools, type ToolDefinition } from "@novox/mesh-sdk/tools";
|
||||||
|
import { BookshelfClient } from "../client.js";
|
||||||
|
|
||||||
|
export function getBookshelfTools(bookshelf: BookshelfClient): ToolDefinition[] {
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
name: "bookshelf_status",
|
||||||
|
description: "Bookshelf status overview: version, book count, monitored count, queue size.",
|
||||||
|
input: {},
|
||||||
|
run: async () => {
|
||||||
|
const [status, content, queue] = await Promise.all([
|
||||||
|
bookshelf.getStatus(),
|
||||||
|
bookshelf.getContent(),
|
||||||
|
bookshelf.getQueue(),
|
||||||
|
]);
|
||||||
|
return {
|
||||||
|
app: status.appName,
|
||||||
|
version: status.version,
|
||||||
|
books: content.length,
|
||||||
|
monitored: content.filter((c) => c.monitored).length,
|
||||||
|
queue: queue.totalRecords,
|
||||||
|
};
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "bookshelf_library",
|
||||||
|
description: "List books from the Bookshelf library.",
|
||||||
|
input: { limit: { type: "number", description: "max items to return (default 50)" } },
|
||||||
|
run: async (args) => {
|
||||||
|
const items = await bookshelf.getContent(args.limit ? Number(args.limit) : 50);
|
||||||
|
return { count: items.length, books: items };
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "bookshelf_search",
|
||||||
|
description:
|
||||||
|
"Search the Bookshelf library for books by title or author (filters existing content, not indexers).",
|
||||||
|
input: { query: { type: "string", description: "the search term" } },
|
||||||
|
run: async (args) => {
|
||||||
|
const query = String(args.query);
|
||||||
|
return { query, results: await bookshelf.searchContent(query) };
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "bookshelf_queue",
|
||||||
|
description: "Show the Bookshelf download queue — what is downloading and how far along.",
|
||||||
|
input: {},
|
||||||
|
run: async () => {
|
||||||
|
const queue = await bookshelf.getQueue();
|
||||||
|
return { count: queue.totalRecords, items: queue.items };
|
||||||
|
},
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
// The tools exist only when Bookshelf is configured; without a URL and key, bookshelf contributes
|
||||||
|
// none rather than failing the whole runtime.
|
||||||
|
registerModuleTools("bookshelf", (env) => {
|
||||||
|
try {
|
||||||
|
return getBookshelfTools(BookshelfClient.fromEnv(env));
|
||||||
|
} catch {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
});
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "ES2022",
|
||||||
|
"module": "NodeNext",
|
||||||
|
"moduleResolution": "NodeNext",
|
||||||
|
"strict": true,
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"noEmit": true
|
||||||
|
},
|
||||||
|
"include": ["client.ts", "index.ts", "tools/index.ts"]
|
||||||
|
}
|
||||||
+12
-12
@@ -15,32 +15,33 @@
|
|||||||
"npm-package-registry"
|
"npm-package-registry"
|
||||||
],
|
],
|
||||||
"binds": {
|
"binds": {
|
||||||
"npm-package-registry": "${dir:mesh-state}/package-registry.json"
|
"npm-package-registry": "/var/lib/mesh/builder/package-registry.json"
|
||||||
},
|
},
|
||||||
"secrets": {
|
"secrets": {
|
||||||
"npm-package-registry": "${dir:mesh-state}/package-registry.secret"
|
"npm-package-registry": "/var/lib/mesh/builder/package-registry.secret"
|
||||||
},
|
},
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/builder/broker"
|
||||||
},
|
},
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/builder",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "workspace",
|
"id": "workspace",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/var/lib/builder/workspace",
|
||||||
"mode": "0700"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "builder-env",
|
"id": "builder-env",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:mesh-state}/builder.env",
|
"path": "/var/lib/mesh/builder/builder.env",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "MESH_BROKER_FILE=/run/mesh/broker\nMESH_NODE=${machine:name}\nMESH_REGISTRY=${bound:artifact-store:at}:${bound:artifact-store:port}\nMESH_PACKAGE_BINDING=/run/mesh/package-registry.json\nMESH_NPM_TOKEN_FILE=/run/mesh/package-registry.secret\nMESH_WORKSPACE=${dir:workspace}\n"
|
"content": "MESH_BROKER_FILE=/run/mesh/broker\nMESH_NODE=${machine:name}\nMESH_REGISTRY=${bound:artifact-store:at}:${bound:artifact-store:port}\nMESH_PACKAGE_BINDING=/run/mesh/package-registry.json\nMESH_NPM_TOKEN_FILE=/run/mesh/package-registry.secret\nMESH_WORKSPACE=/var/lib/builder/workspace\n"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "server",
|
"id": "server",
|
||||||
@@ -48,11 +49,11 @@
|
|||||||
"name": "mesh-builder",
|
"name": "mesh-builder",
|
||||||
"artifact": "server",
|
"artifact": "server",
|
||||||
"env-file": [
|
"env-file": [
|
||||||
"${dir:mesh-state}/builder.env"
|
"/var/lib/mesh/builder/builder.env"
|
||||||
],
|
],
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}:/run/mesh:ro",
|
"/var/lib/mesh/builder:/run/mesh:ro",
|
||||||
"${dir:workspace}:${dir:workspace}",
|
"/var/lib/builder/workspace:/var/lib/builder/workspace",
|
||||||
"/var/run/docker.sock:/var/run/docker.sock"
|
"/var/run/docker.sock:/var/run/docker.sock"
|
||||||
],
|
],
|
||||||
"restart-on": [
|
"restart-on": [
|
||||||
@@ -68,8 +69,7 @@
|
|||||||
"kind": "image",
|
"kind": "image",
|
||||||
"from": "Dockerfile",
|
"from": "Dockerfile",
|
||||||
"context": {
|
"context": {
|
||||||
"seat": "git",
|
"repository": "https://git.novox.be/novox/mesh-controller.git",
|
||||||
"repository": "novox/mesh-controller",
|
|
||||||
"ref": "main"
|
"ref": "main"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -12,14 +12,14 @@
|
|||||||
"public-dns": {}
|
"public-dns": {}
|
||||||
},
|
},
|
||||||
"grants": {
|
"grants": {
|
||||||
"public-dns": "${dir:grants}"
|
"public-dns": "/var/lib/cloudflare-dns/grants"
|
||||||
},
|
},
|
||||||
"receives": {
|
"receives": {
|
||||||
"public-dns": "${dir:grants}/mesh.json"
|
"public-dns": "/var/lib/cloudflare-dns/grants/mesh.json"
|
||||||
},
|
},
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"token": "${dir:state}/token",
|
"token": "/var/lib/cloudflare-dns/token",
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/cloudflare-dns/broker"
|
||||||
},
|
},
|
||||||
"emits": [
|
"emits": [
|
||||||
"record.created",
|
"record.created",
|
||||||
@@ -29,24 +29,25 @@
|
|||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/cloudflare-dns",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/cloudflare-dns",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "grants",
|
"id": "grants",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/var/lib/cloudflare-dns/grants",
|
||||||
"mode": "0700"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "config",
|
"id": "config",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/config.json",
|
"path": "/var/lib/cloudflare-dns/config.json",
|
||||||
"merge": "json",
|
"merge": "json",
|
||||||
"content": "{}",
|
"content": "{}",
|
||||||
"mode": "0600"
|
"mode": "0600"
|
||||||
@@ -57,10 +58,10 @@
|
|||||||
"name": "mesh-cloudflare-dns",
|
"name": "mesh-cloudflare-dns",
|
||||||
"network": "host",
|
"network": "host",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:state}/config.json:/run/config/config.json:ro",
|
"/var/lib/cloudflare-dns/config.json:/run/config/config.json:ro",
|
||||||
"${dir:grants}:/grants",
|
"/var/lib/cloudflare-dns/grants:/grants",
|
||||||
"${dir:state}/token:/run/secrets/token:ro",
|
"/var/lib/cloudflare-dns/token:/run/secrets/token:ro",
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro"
|
"/var/lib/mesh/cloudflare-dns/broker:/run/secrets/broker:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_CLOUDFLARE_TOKEN_FILE": "/run/secrets/token",
|
"MESH_CLOUDFLARE_TOKEN_FILE": "/run/secrets/token",
|
||||||
|
|||||||
@@ -3,26 +3,26 @@
|
|||||||
"version": "1",
|
"version": "1",
|
||||||
"slug": "confl",
|
"slug": "confl",
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"token": "${dir:state}/token",
|
"token": "/var/lib/confluence/token",
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/confluence/broker"
|
||||||
},
|
},
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/confluence",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/confluence",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "config",
|
"id": "config",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/config.json",
|
"path": "/var/lib/confluence/config.json",
|
||||||
"merge": "json",
|
"merge": "json",
|
||||||
"content": "{}",
|
"content": "{}",
|
||||||
"mode": "0600"
|
"mode": "0600"
|
||||||
@@ -33,9 +33,9 @@
|
|||||||
"name": "mesh-runtime-confluence",
|
"name": "mesh-runtime-confluence",
|
||||||
"network": "host",
|
"network": "host",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:state}/config.json:/run/config/config.json:ro",
|
"/var/lib/confluence/config.json:/run/config/config.json:ro",
|
||||||
"${dir:state}/token:/run/secrets/token:ro",
|
"/var/lib/confluence/token:/run/secrets/token:ro",
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro"
|
"/var/lib/mesh/confluence/broker:/run/secrets/broker:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_CONFLUENCE_TOKEN_FILE": "/run/secrets/token",
|
"MESH_CONFLUENCE_TOKEN_FILE": "/run/secrets/token",
|
||||||
|
|||||||
@@ -15,11 +15,11 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"binds": {
|
"binds": {
|
||||||
"route": "${dir:state}/route.json"
|
"route": "/var/lib/de-spiegel/route.json"
|
||||||
},
|
},
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"smtp-user": "${dir:state}/smtp-user.secret",
|
"smtp-user": "/var/lib/de-spiegel/smtp-user.secret",
|
||||||
"smtp-pass": "${dir:state}/smtp-pass.secret"
|
"smtp-pass": "/var/lib/de-spiegel/smtp-pass.secret"
|
||||||
},
|
},
|
||||||
"listens": [
|
"listens": [
|
||||||
{
|
{
|
||||||
@@ -27,20 +27,20 @@
|
|||||||
"port": 35621,
|
"port": 35621,
|
||||||
"protocol": "tcp",
|
"protocol": "tcp",
|
||||||
"from": "mesh",
|
"from": "mesh",
|
||||||
"why": "the de-spiegel site and its /contact endpoint over http; its public name is a route grant, and route-proxy reaches it on this published port"
|
"why": "the de-spiegel site and its /contact endpoint over http; the public name de-spiegel.novox.be is a route grant, and route-proxy reaches it on this published port"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/de-spiegel",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "server-env",
|
"id": "server-env",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/server.env",
|
"path": "/var/lib/de-spiegel/server.env",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "SMTP_AUTH_USER=${secret:smtp-user}\nSMTP_AUTH_PASS=${secret:smtp-pass}\n"
|
"content": "SMTP_AUTH_USER=${secret:smtp-user}\nSMTP_AUTH_PASS=${secret:smtp-pass}\n"
|
||||||
},
|
},
|
||||||
@@ -56,15 +56,12 @@
|
|||||||
"image": "registry-api.novox.be/novox/de-spiegel@sha256:e144b72ce9c145870470d765343549f2c60211728cd118b9ff0e4029f36342ba",
|
"image": "registry-api.novox.be/novox/de-spiegel@sha256:e144b72ce9c145870470d765343549f2c60211728cd118b9ff0e4029f36342ba",
|
||||||
"network": "de-spiegel",
|
"network": "de-spiegel",
|
||||||
"env-file": [
|
"env-file": [
|
||||||
"${dir:state}/server.env"
|
"/var/lib/de-spiegel/server.env"
|
||||||
],
|
],
|
||||||
"ports": [
|
"ports": [
|
||||||
"35621"
|
"35621"
|
||||||
],
|
],
|
||||||
"secrets-in-environment": "the application's own code reads SMTP_AUTH_USER/PASS from the environment (de-spiegel server/index.js); converting is that repository's change",
|
"secrets-in-environment": "the application's own code reads SMTP_AUTH_USER/PASS from the environment (de-spiegel server/index.js); converting is that repository's change"
|
||||||
"names-on-purpose": {
|
|
||||||
"registry-api.novox.be": "built outside the mesh, from the application's own repository, and pulled from the registry that built it; moves when that repository is a build source on the git seat (novox/hq ADR 0155, issue 122)"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,8 +3,7 @@
|
|||||||
"version": "1",
|
"version": "1",
|
||||||
"capabilities": [
|
"capabilities": [
|
||||||
"package-manager",
|
"package-manager",
|
||||||
"service-manager",
|
"service-manager"
|
||||||
"uplink-dhcpcd"
|
|
||||||
],
|
],
|
||||||
"claims": [
|
"claims": [
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -9,7 +9,7 @@
|
|||||||
],
|
],
|
||||||
"claims": [
|
"claims": [
|
||||||
{
|
{
|
||||||
"name": "mesh-artifact-store",
|
"name": "the-artifact-store",
|
||||||
"scope": "mesh"
|
"scope": "mesh"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
|||||||
File diff suppressed because one or more lines are too long
@@ -45,14 +45,6 @@ export interface GiteaPull {
|
|||||||
html_url: string;
|
html_url: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface GiteaComment {
|
|
||||||
id: number;
|
|
||||||
user?: string;
|
|
||||||
body: string;
|
|
||||||
created_at?: string;
|
|
||||||
html_url: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface GiteaLabel {
|
export interface GiteaLabel {
|
||||||
id: number;
|
id: number;
|
||||||
name: string;
|
name: string;
|
||||||
@@ -103,13 +95,6 @@ export class GiteaClient {
|
|||||||
if (res.status === 401) {
|
if (res.status === 401) {
|
||||||
token = await this.tokens.renew(token);
|
token = await this.tokens.renew(token);
|
||||||
res = await this.send(path, options, token);
|
res = await this.send(path, options, token);
|
||||||
} else if (res.status === 403) {
|
|
||||||
// A kept token minted before a scope was added lacks it. The forge says so; the source
|
|
||||||
// re-mints with the whole list and the call is retried once. Any other 403 stays a 403.
|
|
||||||
const text = await res.text();
|
|
||||||
if (!MintedToken.lacksScope(res.status, text)) throw new Error(`Gitea API ${path}: 403 ${text}`);
|
|
||||||
token = await this.tokens.renew(token);
|
|
||||||
res = await this.send(path, options, token);
|
|
||||||
}
|
}
|
||||||
if (!res.ok) throw new Error(`Gitea API ${path}: ${res.status} ${await res.text()}`);
|
if (!res.ok) throw new Error(`Gitea API ${path}: ${res.status} ${await res.text()}`);
|
||||||
if (res.status === 204) return null as T;
|
if (res.status === 204) return null as T;
|
||||||
@@ -265,64 +250,6 @@ export class GiteaClient {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Close or reopen a pull request without merging it. A pull request is an issue to the forge's
|
|
||||||
* state machine, and the pulls endpoint takes the same `state`. */
|
|
||||||
async setPullState(owner: string, repo: string, index: number, state: "open" | "closed"): Promise<GiteaPull> {
|
|
||||||
return GiteaClient.mapPull(
|
|
||||||
await this.request<any>(`/repos/${owner}/${repo}/pulls/${index}`, { method: "PATCH", body: JSON.stringify({ state }) }),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Change a pull request's title or body; a field left undefined is left alone. */
|
|
||||||
async updatePullRequest(owner: string, repo: string, index: number, data: { title?: string; body?: string }): Promise<GiteaPull> {
|
|
||||||
return GiteaClient.mapPull(
|
|
||||||
await this.request<any>(`/repos/${owner}/${repo}/pulls/${index}`, { method: "PATCH", body: JSON.stringify(data) }),
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The unified diff of a pull request, as text. */
|
|
||||||
async pullDiff(owner: string, repo: string, index: number): Promise<string> {
|
|
||||||
return this.requestText(`/repos/${owner}/${repo}/pulls/${index}.diff`);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Every comment on an issue or pull request, oldest first. */
|
|
||||||
async listComments(owner: string, repo: string, index: number): Promise<GiteaComment[]> {
|
|
||||||
const raw = await this.request<any[]>(`/repos/${owner}/${repo}/issues/${index}/comments`);
|
|
||||||
return (raw ?? []).map((c) => ({
|
|
||||||
id: Number(c?.id ?? 0),
|
|
||||||
user: c?.user?.login,
|
|
||||||
body: String(c?.body ?? ""),
|
|
||||||
created_at: c?.created_at,
|
|
||||||
html_url: String(c?.html_url ?? ""),
|
|
||||||
}));
|
|
||||||
}
|
|
||||||
|
|
||||||
/** One file's contents at a ref (default the repository's default branch), decoded. */
|
|
||||||
async getFile(owner: string, repo: string, path: string, ref?: string): Promise<{ path: string; ref?: string; sha: string; size: number; content: string }> {
|
|
||||||
const qs = ref ? `?ref=${encodeURIComponent(ref)}` : "";
|
|
||||||
const f = await this.request<any>(`/repos/${owner}/${repo}/contents/${path.split("/").map(encodeURIComponent).join("/")}${qs}`);
|
|
||||||
if (!f || f.type !== "file") throw new Error(`Gitea API: ${path} is not a file`);
|
|
||||||
const content = f.encoding === "base64" ? Buffer.from(String(f.content ?? ""), "base64").toString("utf8") : String(f.content ?? "");
|
|
||||||
return { path, ref, sha: String(f.sha ?? ""), size: Number(f.size ?? content.length), content };
|
|
||||||
}
|
|
||||||
|
|
||||||
async listBranches(owner: string, repo: string): Promise<{ name: string; commit: string; protected: boolean }[]> {
|
|
||||||
const raw = await this.request<any[]>(`/repos/${owner}/${repo}/branches?limit=100`);
|
|
||||||
return (raw ?? []).map((b) => ({ name: String(b?.name ?? ""), commit: String(b?.commit?.id ?? ""), protected: Boolean(b?.protected) }));
|
|
||||||
}
|
|
||||||
|
|
||||||
async deleteBranch(owner: string, repo: string, branch: string): Promise<void> {
|
|
||||||
await this.request(`/repos/${owner}/${repo}/branches/${encodeURIComponent(branch)}`, { method: "DELETE" });
|
|
||||||
}
|
|
||||||
|
|
||||||
/** A request whose answer is text, not JSON — a diff. Same token handling as request(). */
|
|
||||||
private async requestText(path: string): Promise<string> {
|
|
||||||
const token = await this.tokens.current();
|
|
||||||
const res = await this.send(path, { headers: { Accept: "text/plain" } }, token);
|
|
||||||
if (!res.ok) throw new Error(`Gitea API ${path}: ${res.status} ${await res.text()}`);
|
|
||||||
return res.text();
|
|
||||||
}
|
|
||||||
|
|
||||||
async mergePullRequest(owner: string, repo: string, index: number, method = "merge", deleteBranch = false): Promise<void> {
|
async mergePullRequest(owner: string, repo: string, index: number, method = "merge", deleteBranch = false): Promise<void> {
|
||||||
await this.request(`/repos/${owner}/${repo}/pulls/${index}/merge`, {
|
await this.request(`/repos/${owner}/${repo}/pulls/${index}/merge`, {
|
||||||
method: "POST",
|
method: "POST",
|
||||||
|
|||||||
@@ -86,19 +86,19 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/gitea/broker"
|
||||||
},
|
},
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/gitea",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "runtime-state",
|
"id": "runtime-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"path": "${dir:mesh-state}/state",
|
"path": "/var/lib/mesh/gitea/state",
|
||||||
"mode": "0700"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -175,7 +175,7 @@
|
|||||||
{
|
{
|
||||||
"id": "runtime-config",
|
"id": "runtime-config",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:mesh-state}/config.json",
|
"path": "/var/lib/mesh/gitea/config.json",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "{}\n",
|
"content": "{}\n",
|
||||||
"merge": "json"
|
"merge": "json"
|
||||||
@@ -186,11 +186,11 @@
|
|||||||
"name": "mesh-gitea",
|
"name": "mesh-gitea",
|
||||||
"network": "host",
|
"network": "host",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/gitea/broker:/run/secrets/broker:ro",
|
||||||
"${dir:mesh-state}/config.json:/run/config/config.json:ro",
|
"/var/lib/mesh/gitea/config.json:/run/config/config.json:ro",
|
||||||
"${dir:grants}:${dir:grants}:ro",
|
"${dir:grants}:${dir:grants}:ro",
|
||||||
"${dir:state}/admin.secret:/run/secrets/admin:ro",
|
"${dir:state}/admin.secret:/run/secrets/admin:ro",
|
||||||
"${dir:runtime-state}:/run/state"
|
"/var/lib/mesh/gitea/state:/run/state"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
|
|||||||
@@ -29,11 +29,7 @@ interface Forge {
|
|||||||
mints: number;
|
mints: number;
|
||||||
lastScopes: string[] | null;
|
lastScopes: string[] | null;
|
||||||
tokens: Map<string, string>;
|
tokens: Map<string, string>;
|
||||||
scopesOf: Map<string, string[]>;
|
|
||||||
admins: Map<string, string>;
|
admins: Map<string, string>;
|
||||||
pullState: string;
|
|
||||||
pullTitle: string;
|
|
||||||
branchDeleted: boolean;
|
|
||||||
close(): Promise<void>;
|
close(): Promise<void>;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -44,9 +40,6 @@ function fakeForge(): Promise<Forge> {
|
|||||||
tokens: new Map<string, string>(), // name -> value
|
tokens: new Map<string, string>(), // name -> value
|
||||||
scopesOf: new Map<string, string[]>(), // value -> scopes, so a route can enforce them like gitea does
|
scopesOf: new Map<string, string[]>(), // value -> scopes, so a route can enforce them like gitea does
|
||||||
admins: new Map([[ADMIN, PASSWORD]]),
|
admins: new Map([[ADMIN, PASSWORD]]),
|
||||||
pullState: "open",
|
|
||||||
pullTitle: "The console shipped",
|
|
||||||
branchDeleted: false,
|
|
||||||
};
|
};
|
||||||
// write:X implies read:X — gitea's own rule (models/auth/access_token_scope.go).
|
// write:X implies read:X — gitea's own rule (models/auth/access_token_scope.go).
|
||||||
const covers = (scopes: string[], required: string): boolean =>
|
const covers = (scopes: string[], required: string): boolean =>
|
||||||
@@ -92,51 +85,6 @@ function fakeForge(): Promise<Forge> {
|
|||||||
}
|
}
|
||||||
return json(res, 405, { message: "method not allowed" });
|
return json(res, 405, { message: "method not allowed" });
|
||||||
}
|
}
|
||||||
const tokenOf = (): string => {
|
|
||||||
const h = req.headers.authorization ?? "";
|
|
||||||
return h.startsWith("token ") ? h.slice(6) : "";
|
|
||||||
};
|
|
||||||
const pull = url.pathname.match(/^\/api\/v1\/repos\/novox\/hq\/pulls\/(\d+)(\.diff)?$/);
|
|
||||||
if (pull) {
|
|
||||||
if (![...forge.tokens.values()].includes(tokenOf())) return json(res, 401, { message: "token is required" });
|
|
||||||
if (pull[2]) {
|
|
||||||
res.writeHead(200, { "Content-Type": "text/plain" });
|
|
||||||
return res.end("diff --git a/x b/x\n--- a/x\n+++ b/x\n@@ -1 +1 @@\n-old\n+new\n");
|
|
||||||
}
|
|
||||||
if (req.method === "PATCH") {
|
|
||||||
const patch = await body(req);
|
|
||||||
forge.pullState = patch?.state ?? forge.pullState;
|
|
||||||
forge.pullTitle = patch?.title ?? forge.pullTitle;
|
|
||||||
}
|
|
||||||
return json(res, 200, { number: Number(pull[1]), title: forge.pullTitle, state: forge.pullState, merged: false,
|
|
||||||
user: { login: "mesh-admin" }, head: { ref: "feat/x" }, base: { ref: "main" }, html_url: "http://fake/novox/hq/pulls/" + pull[1] });
|
|
||||||
}
|
|
||||||
if (url.pathname === "/api/v1/repos/novox/hq/issues/223/comments") {
|
|
||||||
return json(res, 200, [{ id: 1, user: { login: "jochen" }, body: "landed elsewhere", created_at: "2026-10-01T00:00:00Z", html_url: "http://fake/c/1" }]);
|
|
||||||
}
|
|
||||||
if (url.pathname === "/api/v1/repos/novox/hq/contents/README.md") {
|
|
||||||
return json(res, 200, { type: "file", encoding: "base64", sha: "abc", size: 5, content: Buffer.from("hello").toString("base64") });
|
|
||||||
}
|
|
||||||
if (url.pathname === "/api/v1/repos/novox/hq/branches") {
|
|
||||||
return json(res, 200, [{ name: "main", protected: true, commit: { id: "aaaa" } }, { name: "feat/x", protected: false, commit: { id: "bbbb" } }]);
|
|
||||||
}
|
|
||||||
if (url.pathname === "/api/v1/repos/novox/hq/branches/feat%2Fx" || url.pathname === "/api/v1/repos/novox/hq/branches/feat/x") {
|
|
||||||
if (req.method === "DELETE") { forge.branchDeleted = true; return json(res, 204, null); }
|
|
||||||
}
|
|
||||||
if (url.pathname === "/api/v1/repos/search") {
|
|
||||||
// The client lists through the search endpoint since 2026-09-28 (the forge's whole view);
|
|
||||||
// it sits under `repository`, which write:repository covers.
|
|
||||||
const h = req.headers.authorization ?? "";
|
|
||||||
const value = h.startsWith("token ") ? h.slice(6) : "";
|
|
||||||
if (![...forge.tokens.values()].includes(value)) return json(res, 401, { message: "token is required" });
|
|
||||||
if (!covers(forge.scopesOf.get(value) ?? [], "read:repository")) {
|
|
||||||
return json(res, 403, { message: `token does not have at least one of required scope(s), required=[read:repository]` });
|
|
||||||
}
|
|
||||||
return json(res, 200, {
|
|
||||||
ok: true,
|
|
||||||
data: [{ full_name: "novox/hq", name: "hq", owner: { login: "novox" }, private: true, html_url: "http://fake/novox/hq" }],
|
|
||||||
});
|
|
||||||
}
|
|
||||||
if (url.pathname === "/api/v1/user/repos") {
|
if (url.pathname === "/api/v1/user/repos") {
|
||||||
const h = req.headers.authorization ?? "";
|
const h = req.headers.authorization ?? "";
|
||||||
const value = h.startsWith("token ") ? h.slice(6) : "";
|
const value = h.startsWith("token ") ? h.slice(6) : "";
|
||||||
@@ -153,21 +101,6 @@ function fakeForge(): Promise<Forge> {
|
|||||||
{ full_name: "novox/hq", name: "hq", owner: { login: "novox" }, private: true, html_url: "http://fake/novox/hq" },
|
{ full_name: "novox/hq", name: "hq", owner: { login: "novox" }, private: true, html_url: "http://fake/novox/hq" },
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
const adminUser = url.pathname.match(/^\/api\/v1\/admin\/users\/([^/]+)$/);
|
|
||||||
if (adminUser && req.method === "PATCH") {
|
|
||||||
const h = req.headers.authorization ?? "";
|
|
||||||
const value = h.startsWith("token ") ? h.slice(6) : "";
|
|
||||||
if (![...forge.tokens.values()].includes(value)) return json(res, 401, { message: "token is required" });
|
|
||||||
if (!covers(forge.scopesOf.get(value) ?? [], "write:admin")) {
|
|
||||||
return json(res, 403, {
|
|
||||||
message: `token does not have at least one of required scope(s), required=[write:admin]`,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
const login = decodeURIComponent(adminUser[1]);
|
|
||||||
if (login === "untouchable") return json(res, 403, { message: "user untouchable may not be edited" });
|
|
||||||
const patch = await body(req);
|
|
||||||
return json(res, 200, { login, is_admin: patch?.admin === true });
|
|
||||||
}
|
|
||||||
return json(res, 404, { message: "no such route in the fake" });
|
return json(res, 404, { message: "no such route in the fake" });
|
||||||
});
|
});
|
||||||
return new Promise((resolve) => {
|
return new Promise((resolve) => {
|
||||||
@@ -177,11 +110,7 @@ function fakeForge(): Promise<Forge> {
|
|||||||
url: `http://127.0.0.1:${port}`,
|
url: `http://127.0.0.1:${port}`,
|
||||||
get mints() { return forge.mints; },
|
get mints() { return forge.mints; },
|
||||||
get lastScopes() { return forge.lastScopes; },
|
get lastScopes() { return forge.lastScopes; },
|
||||||
get pullState() { return forge.pullState; },
|
|
||||||
get pullTitle() { return forge.pullTitle; },
|
|
||||||
get branchDeleted() { return forge.branchDeleted; },
|
|
||||||
tokens: forge.tokens,
|
tokens: forge.tokens,
|
||||||
scopesOf: forge.scopesOf,
|
|
||||||
admins: forge.admins,
|
admins: forge.admins,
|
||||||
close: () => new Promise((r) => server.close(() => r())),
|
close: () => new Promise((r) => server.close(() => r())),
|
||||||
});
|
});
|
||||||
@@ -223,14 +152,14 @@ function minted(env: NodeJS.ProcessEnv, logs: string[]): GiteaClient {
|
|||||||
const forge = await fakeForge();
|
const forge = await fakeForge();
|
||||||
after(() => forge.close());
|
after(() => forge.close());
|
||||||
|
|
||||||
test("first start: mints with the admin account, keeps the token at 0600, asks for the tools' scopes only", async () => {
|
test("first start: mints with the admin account, keeps the token at 0600, asks for two scopes only", async () => {
|
||||||
const { env, file, logs } = await delivered(forge);
|
const { env, file, logs } = await delivered(forge);
|
||||||
|
|
||||||
const repos = await minted(env, logs).listRepos();
|
const repos = await minted(env, logs).listRepos();
|
||||||
|
|
||||||
assert.equal(repos[0]?.full_name, "novox/hq");
|
assert.equal(repos[0]?.full_name, "novox/hq");
|
||||||
assert.equal(forge.mints, 1);
|
assert.equal(forge.mints, 1);
|
||||||
assert.deepEqual(forge.lastScopes, ["write:repository", "write:issue", "read:user", "write:admin"]);
|
assert.deepEqual(forge.lastScopes, ["write:repository", "write:issue", "read:user"]);
|
||||||
assert.deepEqual(forge.lastScopes, [...TOKEN_SCOPES]);
|
assert.deepEqual(forge.lastScopes, [...TOKEN_SCOPES]);
|
||||||
const token = forge.tokens.get("mesh-tools")!;
|
const token = forge.tokens.get("mesh-tools")!;
|
||||||
assert.equal(await readFile(file, "utf8"), token + "\n");
|
assert.equal(await readFile(file, "utf8"), token + "\n");
|
||||||
@@ -268,34 +197,6 @@ test("the forge rejects the kept token (its data was restored): minted afresh, o
|
|||||||
assert.ok(logs.some((l) => l.startsWith("the forge rejected the kept token")), logs.join("\n"));
|
assert.ok(logs.some((l) => l.startsWith("the forge rejected the kept token")), logs.join("\n"));
|
||||||
});
|
});
|
||||||
|
|
||||||
test("a kept token from before write:admin: the forge refuses the admin route for the scope, the token is re-minted with the whole list, and the call goes through", async () => {
|
|
||||||
const { env, file, logs } = await delivered(forge);
|
|
||||||
const client = minted(env, logs);
|
|
||||||
await client.listRepos();
|
|
||||||
const before = forge.mints;
|
|
||||||
const old = forge.tokens.get("mesh-tools")!;
|
|
||||||
forge.scopesOf.set(old, ["write:repository", "write:issue", "read:user"]); // minted by the previous build
|
|
||||||
|
|
||||||
const user = await client.api<{ login: string; is_admin: boolean }>("/admin/users/mesh_novox_builder", {
|
|
||||||
method: "PATCH",
|
|
||||||
body: JSON.stringify({ admin: true }),
|
|
||||||
});
|
|
||||||
|
|
||||||
assert.equal(user.is_admin, true);
|
|
||||||
assert.equal(forge.mints, before + 1);
|
|
||||||
assert.deepEqual(forge.lastScopes, [...TOKEN_SCOPES]);
|
|
||||||
assert.notEqual(forge.tokens.get("mesh-tools"), old);
|
|
||||||
assert.equal(await readFile(file, "utf8"), forge.tokens.get("mesh-tools") + "\n");
|
|
||||||
assert.ok(logs.some((l) => l.startsWith("the forge rejected the kept token")), logs.join("\n"));
|
|
||||||
// A 403 that is not about scopes is the forge's answer, not a reason to mint.
|
|
||||||
const again = forge.mints;
|
|
||||||
await assert.rejects(
|
|
||||||
client.api("/admin/users/untouchable", { method: "PATCH", body: JSON.stringify({ admin: true }) }),
|
|
||||||
/403 .*untouchable/,
|
|
||||||
);
|
|
||||||
assert.equal(forge.mints, again);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the kept file is gone but the forge still holds a token by that name: replaced, not refused", async () => {
|
test("the kept file is gone but the forge still holds a token by that name: replaced, not refused", async () => {
|
||||||
const { env, file, logs } = await delivered(forge);
|
const { env, file, logs } = await delivered(forge);
|
||||||
await minted(env, logs).listRepos();
|
await minted(env, logs).listRepos();
|
||||||
@@ -400,16 +301,6 @@ test("the tools register once there is a way to a token, and the first call mint
|
|||||||
"gitea_list_repos", "gitea_create_repo", "gitea_delete_repo",
|
"gitea_list_repos", "gitea_create_repo", "gitea_delete_repo",
|
||||||
"gitea_list_issues", "gitea_get_issue", "gitea_create_issue", "gitea_close_issue", "gitea_add_comment",
|
"gitea_list_issues", "gitea_get_issue", "gitea_create_issue", "gitea_close_issue", "gitea_add_comment",
|
||||||
"gitea_list_pull_requests", "gitea_get_pull_request", "gitea_create_pull_request", "gitea_merge_pull_request",
|
"gitea_list_pull_requests", "gitea_get_pull_request", "gitea_create_pull_request", "gitea_merge_pull_request",
|
||||||
"gitea_close_pull_request",
|
|
||||||
"gitea_reopen_pull_request",
|
|
||||||
"gitea_update_pull_request",
|
|
||||||
"gitea_pull_request_files",
|
|
||||||
"gitea_pull_request_diff",
|
|
||||||
"gitea_list_comments",
|
|
||||||
"gitea_reopen_issue",
|
|
||||||
"gitea_get_file",
|
|
||||||
"gitea_list_branches",
|
|
||||||
"gitea_delete_branch",
|
|
||||||
"gitea_list_labels", "gitea_create_label",
|
"gitea_list_labels", "gitea_create_label",
|
||||||
"gitea_api",
|
"gitea_api",
|
||||||
],
|
],
|
||||||
@@ -420,32 +311,3 @@ test("the tools register once there is a way to a token, and the first call mint
|
|||||||
assert.equal(result.repos.length, 1);
|
assert.equal(result.repos.length, 1);
|
||||||
assert.equal(forge.mints, before + 1);
|
assert.equal(forge.mints, before + 1);
|
||||||
});
|
});
|
||||||
|
|
||||||
// The forge's tools reach every action a review needs without a checkout and without the API
|
|
||||||
// escape hatch: close a pull request whose work landed elsewhere, read its diff, its comments, a
|
|
||||||
// file, the branches, and delete the branch left behind. Against the fake forge, through the
|
|
||||||
// compiled tools, the way the console calls them.
|
|
||||||
test("a pull request can be closed, read and cleaned up through the tools", async () => {
|
|
||||||
const { env } = await delivered(forge);
|
|
||||||
const tools = collectTools(env).find((c) => c.module === "gitea")!.tools;
|
|
||||||
const tool = (name: string) => tools.find((t) => t.name === name)!;
|
|
||||||
for (const name of ["gitea_close_pull_request", "gitea_reopen_pull_request", "gitea_update_pull_request", "gitea_pull_request_files",
|
|
||||||
"gitea_pull_request_diff", "gitea_list_comments", "gitea_reopen_issue", "gitea_get_file", "gitea_list_branches", "gitea_delete_branch"]) {
|
|
||||||
assert.ok(tool(name), `${name} is not a tool`);
|
|
||||||
}
|
|
||||||
const closed = (await tool("gitea_close_pull_request").run({ owner: "novox", repo: "hq", number: 223 })) as { pull: { state: string } };
|
|
||||||
assert.equal(closed.pull.state, "closed");
|
|
||||||
assert.equal(forge.pullState, "closed");
|
|
||||||
const renamed = (await tool("gitea_update_pull_request").run({ owner: "novox", repo: "hq", number: 223, title: "Superseded" })) as { pull: { title: string } };
|
|
||||||
assert.equal(renamed.pull.title, "Superseded");
|
|
||||||
const diff = (await tool("gitea_pull_request_diff").run({ owner: "novox", repo: "hq", number: 223 })) as { diff: string };
|
|
||||||
assert.match(diff.diff, /^diff --git/);
|
|
||||||
const comments = (await tool("gitea_list_comments").run({ owner: "novox", repo: "hq", number: 223 })) as { comments: { body: string }[] };
|
|
||||||
assert.equal(comments.comments[0].body, "landed elsewhere");
|
|
||||||
const file = (await tool("gitea_get_file").run({ owner: "novox", repo: "hq", path: "README.md" })) as { file: { content: string } };
|
|
||||||
assert.equal(file.file.content, "hello");
|
|
||||||
const branches = (await tool("gitea_list_branches").run({ owner: "novox", repo: "hq" })) as { branches: { name: string }[] };
|
|
||||||
assert.deepEqual(branches.branches.map((b) => b.name), ["main", "feat/x"]);
|
|
||||||
await tool("gitea_delete_branch").run({ owner: "novox", repo: "hq", branch: "feat/x" });
|
|
||||||
assert.equal(forge.branchDeleted, true);
|
|
||||||
});
|
|
||||||
|
|||||||
+3
-14
@@ -34,21 +34,15 @@ export const TOKEN_NAME = "mesh-tools";
|
|||||||
* It sits under the `user` category despite listing repositories, not `repository`
|
* It sits under the `user` category despite listing repositories, not `repository`
|
||||||
* — confirmed against the running forge (1.27.3), which answered
|
* — confirmed against the running forge (1.27.3), which answered
|
||||||
* `required=[read:user]` to a token carrying only the other two.
|
* `required=[read:user]` to a token carrying only the other two.
|
||||||
* write:admin — /admin/users: the forge's own users are the mesh's to settle, such as making
|
* Nothing under /admin, /orgs or write:user — the escape-hatch tool reaches only what these three cover.
|
||||||
* the builder's login a site admin so every repository the mesh may build is
|
|
||||||
* clonable (novox/hq 229). Nothing under /orgs or write:user.
|
|
||||||
*
|
|
||||||
* A token kept from before a scope was added lacks it: the forge answers such a call with
|
|
||||||
* `403 token does not have at least one of required scope(s)`, and the client treats that like a
|
|
||||||
* 401 — the source re-mints by name, with the whole list, and the call is retried once.
|
|
||||||
*/
|
*/
|
||||||
export const TOKEN_SCOPES: readonly string[] = ["write:repository", "write:issue", "read:user", "write:admin"];
|
export const TOKEN_SCOPES: readonly string[] = ["write:repository", "write:issue", "read:user"];
|
||||||
|
|
||||||
/** Where a client's token comes from, and what to do when the forge says it is wrong. */
|
/** Where a client's token comes from, and what to do when the forge says it is wrong. */
|
||||||
export interface TokenSource {
|
export interface TokenSource {
|
||||||
/** The token to authenticate with now; minted, read or configured. */
|
/** The token to authenticate with now; minted, read or configured. */
|
||||||
current(): Promise<string>;
|
current(): Promise<string>;
|
||||||
/** The forge answered 401 to `rejected`, or 403 for a scope it lacks. A fresh token, or a plain error when there is nothing to renew with. */
|
/** The forge answered 401 to `rejected`. A fresh token, or a plain error when there is nothing to renew with. */
|
||||||
renew(rejected: string): Promise<string>;
|
renew(rejected: string): Promise<string>;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -176,11 +170,6 @@ export class MintedToken implements TokenSource {
|
|||||||
return this.mint("the forge rejected the kept token — minting a fresh one");
|
return this.mint("the forge rejected the kept token — minting a fresh one");
|
||||||
}
|
}
|
||||||
|
|
||||||
/** What the forge's scoped tokens say when a kept token predates a scope the tools now need. */
|
|
||||||
static lacksScope(status: number, body: string): boolean {
|
|
||||||
return status === 403 && /required scope/i.test(body);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** One mint at a time: concurrent first calls share it, rather than each minting its own. */
|
/** One mint at a time: concurrent first calls share it, rather than each minting its own. */
|
||||||
private mint(why: string): Promise<string> {
|
private mint(why: string): Promise<string> {
|
||||||
if (this.inflight === null) {
|
if (this.inflight === null) {
|
||||||
|
|||||||
@@ -254,131 +254,6 @@ export function getGiteaTools(gitea: GiteaClient): ToolDefinition[] {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|
||||||
{
|
|
||||||
name: "gitea_close_pull_request",
|
|
||||||
description: "Close a pull request without merging it — one whose work landed elsewhere, or was abandoned.",
|
|
||||||
input: {
|
|
||||||
owner: { type: "string", description: "the repository owner" },
|
|
||||||
repo: { type: "string", description: "the repository name" },
|
|
||||||
number: { type: "number", description: "the PR number" },
|
|
||||||
},
|
|
||||||
run: async (args) => ({
|
|
||||||
pull: await gitea.setPullState(String(args.owner), String(args.repo), Number(args.number), "closed"),
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "gitea_reopen_pull_request",
|
|
||||||
description: "Reopen a closed, unmerged pull request.",
|
|
||||||
input: {
|
|
||||||
owner: { type: "string", description: "the repository owner" },
|
|
||||||
repo: { type: "string", description: "the repository name" },
|
|
||||||
number: { type: "number", description: "the PR number" },
|
|
||||||
},
|
|
||||||
run: async (args) => ({
|
|
||||||
pull: await gitea.setPullState(String(args.owner), String(args.repo), Number(args.number), "open"),
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "gitea_update_pull_request",
|
|
||||||
description: "Change a pull request's title or body; a field not given is left as it is.",
|
|
||||||
input: {
|
|
||||||
owner: { type: "string", description: "the repository owner" },
|
|
||||||
repo: { type: "string", description: "the repository name" },
|
|
||||||
number: { type: "number", description: "the PR number" },
|
|
||||||
title: { type: "string", description: "the new title (optional)" },
|
|
||||||
body: { type: "string", description: "the new body, markdown (optional)" },
|
|
||||||
},
|
|
||||||
run: async (args) => ({
|
|
||||||
pull: await gitea.updatePullRequest(String(args.owner), String(args.repo), Number(args.number), {
|
|
||||||
title: args.title === undefined ? undefined : String(args.title),
|
|
||||||
body: args.body === undefined ? undefined : String(args.body),
|
|
||||||
}),
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "gitea_pull_request_files",
|
|
||||||
description: "The files a pull request changes, as paths from the repository's root (up to 100; says when there are more).",
|
|
||||||
input: {
|
|
||||||
owner: { type: "string", description: "the repository owner" },
|
|
||||||
repo: { type: "string", description: "the repository name" },
|
|
||||||
number: { type: "number", description: "the PR number" },
|
|
||||||
},
|
|
||||||
run: async (args) => gitea.listPullFiles(String(args.owner), String(args.repo), Number(args.number)),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "gitea_pull_request_diff",
|
|
||||||
description: "A pull request's unified diff, as text — for reviewing it without a checkout.",
|
|
||||||
input: {
|
|
||||||
owner: { type: "string", description: "the repository owner" },
|
|
||||||
repo: { type: "string", description: "the repository name" },
|
|
||||||
number: { type: "number", description: "the PR number" },
|
|
||||||
},
|
|
||||||
run: async (args) => ({
|
|
||||||
diff: await gitea.pullDiff(String(args.owner), String(args.repo), Number(args.number)),
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "gitea_list_comments",
|
|
||||||
description: "Every comment on an issue or pull request, oldest first.",
|
|
||||||
input: {
|
|
||||||
owner: { type: "string", description: "the repository owner" },
|
|
||||||
repo: { type: "string", description: "the repository name" },
|
|
||||||
number: { type: "number", description: "the issue or PR number" },
|
|
||||||
},
|
|
||||||
run: async (args) => ({
|
|
||||||
comments: await gitea.listComments(String(args.owner), String(args.repo), Number(args.number)),
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "gitea_reopen_issue",
|
|
||||||
description: "Reopen a closed issue.",
|
|
||||||
input: {
|
|
||||||
owner: { type: "string", description: "the repository owner" },
|
|
||||||
repo: { type: "string", description: "the repository name" },
|
|
||||||
number: { type: "number", description: "the issue number" },
|
|
||||||
},
|
|
||||||
run: async (args) => ({
|
|
||||||
issue: await gitea.setIssueState(String(args.owner), String(args.repo), Number(args.number), "open"),
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
|
|
||||||
// ---- Contents and branches ----
|
|
||||||
{
|
|
||||||
name: "gitea_get_file",
|
|
||||||
description: "One file's contents from a repository, decoded, at a branch, tag or commit (default the repository's default branch).",
|
|
||||||
input: {
|
|
||||||
owner: { type: "string", description: "the repository owner" },
|
|
||||||
repo: { type: "string", description: "the repository name" },
|
|
||||||
path: { type: "string", description: "the file's path from the repository's root" },
|
|
||||||
ref: { type: "string", description: "branch, tag or commit (optional)" },
|
|
||||||
},
|
|
||||||
run: async (args) => ({
|
|
||||||
file: await gitea.getFile(String(args.owner), String(args.repo), String(args.path), args.ref ? String(args.ref) : undefined),
|
|
||||||
}),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "gitea_list_branches",
|
|
||||||
description: "Every branch of a repository with the commit it points at.",
|
|
||||||
input: {
|
|
||||||
owner: { type: "string", description: "the repository owner" },
|
|
||||||
repo: { type: "string", description: "the repository name" },
|
|
||||||
},
|
|
||||||
run: async (args) => ({ branches: await gitea.listBranches(String(args.owner), String(args.repo)) }),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "gitea_delete_branch",
|
|
||||||
description: "Delete a branch — a feature branch whose pull request was closed rather than merged. Refused by the forge for a protected branch.",
|
|
||||||
input: {
|
|
||||||
owner: { type: "string", description: "the repository owner" },
|
|
||||||
repo: { type: "string", description: "the repository name" },
|
|
||||||
branch: { type: "string", description: "the branch name" },
|
|
||||||
},
|
|
||||||
run: async (args) => {
|
|
||||||
await gitea.deleteBranch(String(args.owner), String(args.repo), String(args.branch));
|
|
||||||
return { deleted: true, branch: String(args.branch) };
|
|
||||||
},
|
|
||||||
},
|
|
||||||
|
|
||||||
// ---- Labels ----
|
// ---- Labels ----
|
||||||
{
|
{
|
||||||
name: "gitea_list_labels",
|
name: "gitea_list_labels",
|
||||||
|
|||||||
+10
-10
@@ -2,26 +2,26 @@
|
|||||||
"module": "gitlab",
|
"module": "gitlab",
|
||||||
"version": "1",
|
"version": "1",
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"token": "${dir:state}/token",
|
"token": "/var/lib/gitlab/token",
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/gitlab/broker"
|
||||||
},
|
},
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/gitlab",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/gitlab",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "config",
|
"id": "config",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/config.json",
|
"path": "/var/lib/gitlab/config.json",
|
||||||
"merge": "json",
|
"merge": "json",
|
||||||
"content": "{}",
|
"content": "{}",
|
||||||
"mode": "0600"
|
"mode": "0600"
|
||||||
@@ -32,9 +32,9 @@
|
|||||||
"name": "mesh-runtime-gitlab",
|
"name": "mesh-runtime-gitlab",
|
||||||
"network": "host",
|
"network": "host",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:state}/config.json:/run/config/config.json:ro",
|
"/var/lib/gitlab/config.json:/run/config/config.json:ro",
|
||||||
"${dir:state}/token:/run/secrets/token:ro",
|
"/var/lib/gitlab/token:/run/secrets/token:ro",
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro"
|
"/var/lib/mesh/gitlab/broker:/run/secrets/broker:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_GITLAB_TOKEN_FILE": "/run/secrets/token",
|
"MESH_GITLAB_TOKEN_FILE": "/run/secrets/token",
|
||||||
|
|||||||
+22
-80
@@ -5,8 +5,8 @@
|
|||||||
"alert.firing"
|
"alert.firing"
|
||||||
],
|
],
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"admin": "${dir:mesh-state}/admin",
|
"admin": "/var/lib/grafana-module/admin.secret",
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/grafana/broker"
|
||||||
},
|
},
|
||||||
"capabilities": [
|
"capabilities": [
|
||||||
"container-runtime"
|
"container-runtime"
|
||||||
@@ -24,93 +24,51 @@
|
|||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/grafana",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/grafana-module",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "data",
|
"id": "data",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/services/grafana/data",
|
||||||
"mode": "0700",
|
"mode": "0700",
|
||||||
"owner": "472:472"
|
"owner": "472:472"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "admin-secret",
|
"id": "server-env",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/admin.secret",
|
"path": "/var/lib/grafana-module/server.env",
|
||||||
"mode": "0400",
|
"mode": "0600",
|
||||||
"owner": "472:472",
|
"content": "GF_SECURITY_ADMIN_PASSWORD=${secret:admin}\n"
|
||||||
"content": "${secret:admin}"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "oidc-secret",
|
|
||||||
"type": "file",
|
|
||||||
"path": "${dir:state}/oidc-client.secret",
|
|
||||||
"mode": "0400",
|
|
||||||
"owner": "472:472",
|
|
||||||
"content": "${secret:oidc-client}"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "oidc-env",
|
|
||||||
"type": "file",
|
|
||||||
"path": "${dir:state}/oidc.env",
|
|
||||||
"mode": "0644",
|
|
||||||
"content": "GF_SERVER_ROOT_URL=https://${bound:route:name}\nGF_AUTH_GENERIC_OAUTH_ENABLED=true\nGF_AUTH_GENERIC_OAUTH_NAME=Keycloak\nGF_AUTH_GENERIC_OAUTH_CLIENT_ID=${bound:oidc-client:as}\nGF_AUTH_GENERIC_OAUTH_CLIENT_SECRET__FILE=/run/secrets/oidc-client\nGF_AUTH_GENERIC_OAUTH_SCOPES=openid email profile roles\nGF_AUTH_GENERIC_OAUTH_AUTH_URL=${bound:oidc-client:issuer}${bound:oidc-client:authorization-path}\nGF_AUTH_GENERIC_OAUTH_TOKEN_URL=${bound:oidc-client:issuer}${bound:oidc-client:token-path}\nGF_AUTH_GENERIC_OAUTH_API_URL=${bound:oidc-client:issuer}${bound:oidc-client:userinfo-path}\nGF_AUTH_GENERIC_OAUTH_ROLE_ATTRIBUTE_PATH=contains(roles[*], 'admin') && 'Admin' || contains(realm_access.roles[*], 'admin') && 'Admin' || 'Viewer'\nGF_AUTH_GENERIC_OAUTH_USE_PKCE=true\nGF_AUTH_GENERIC_OAUTH_ALLOW_SIGN_UP=true\nGF_AUTH_GENERIC_OAUTH_ALLOW_ASSIGN_GRAFANA_ADMIN=true\n"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "influxdb-secret",
|
|
||||||
"type": "file",
|
|
||||||
"path": "${dir:state}/influxdb-api.secret",
|
|
||||||
"mode": "0400",
|
|
||||||
"owner": "472:472",
|
|
||||||
"content": "${secret:influxdb-api}"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "influxdb-datasource",
|
|
||||||
"type": "file",
|
|
||||||
"path": "${dir:state}/datasource-influxdb.yaml",
|
|
||||||
"mode": "0644",
|
|
||||||
"content": "apiVersion: 1\n# Written by the mesh from grafana's influxdb-api binding; grafana reads it at start. Its own name and\n# uid, so a data source somebody made in the UI is never overwritten, and read-only in the UI because\n# the mesh resets it. The password is read from the file the mesh delivers, never written here.\ndatasources:\n - name: InfluxDB (mesh)\n uid: mesh-influxdb-api\n type: influxdb\n access: proxy\n url: ${bound:influxdb-api:scheme}://${bound:influxdb-api:at}:${bound:influxdb-api:port}\n user: ${bound:influxdb-api:as}\n isDefault: false\n editable: false\n jsonData:\n dbName: ${bound:influxdb-api:bucket}\n httpMode: POST\n secureJsonData:\n password: $__file{/run/secrets/influxdb-api}\n"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "server",
|
"id": "server",
|
||||||
"type": "container",
|
"type": "container",
|
||||||
"name": "grafana",
|
"name": "grafana",
|
||||||
"image": "grafana/grafana@sha256:ac461fb352abc50da10a51c7d02462e9c05488f11f53f14b3ad79a8145f638a0",
|
"image": "grafana/grafana@sha256:f772d434e8fab0049deb2b1b30abd43342bcfca1537614aa8d36080232cf4283",
|
||||||
"ports": [
|
"ports": [
|
||||||
"3000"
|
"3000"
|
||||||
],
|
],
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:data}:/var/lib/grafana",
|
"/services/grafana/data:/var/lib/grafana"
|
||||||
"${dir:state}/admin.secret:/run/secrets/admin:ro",
|
|
||||||
"${dir:state}/oidc-client.secret:/run/secrets/oidc-client:ro",
|
|
||||||
"${dir:state}/influxdb-api.secret:/run/secrets/influxdb-api:ro",
|
|
||||||
"${dir:state}/datasource-influxdb.yaml:/etc/grafana/provisioning/datasources/mesh-influxdb.yaml:ro"
|
|
||||||
],
|
],
|
||||||
"env": {
|
|
||||||
"GF_SECURITY_ADMIN_PASSWORD__FILE": "/run/secrets/admin"
|
|
||||||
},
|
|
||||||
"env-file": [
|
"env-file": [
|
||||||
"${dir:state}/oidc.env"
|
"/var/lib/grafana-module/server.env"
|
||||||
],
|
],
|
||||||
"restart-on": [
|
"secrets-in-environment": "grafana honours GF_SECURITY_ADMIN_PASSWORD__FILE; convertible, awaiting a bed that exercises the admin password (assigned-grafana serves tools only)"
|
||||||
"oidc-env",
|
|
||||||
"oidc-secret",
|
|
||||||
"influxdb-datasource",
|
|
||||||
"influxdb-secret"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "runtime-config",
|
"id": "runtime-config",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:mesh-state}/config.json",
|
"path": "/var/lib/mesh/grafana/config.json",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "{\n \"user\": \"admin\",\n \"password\": \"${secret:admin}\"\n}\n",
|
"content": "{}\n",
|
||||||
"merge": "json"
|
"merge": "json"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -119,12 +77,12 @@
|
|||||||
"name": "mesh-grafana",
|
"name": "mesh-grafana",
|
||||||
"network": "host",
|
"network": "host",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/grafana/broker:/run/secrets/broker:ro",
|
||||||
"${dir:mesh-state}/config.json:/run/config/config.json:ro"
|
"/var/lib/mesh/grafana/config.json:/run/config/config.json:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_GRAFANA_URL": "http://127.0.0.1:${port:3000}",
|
"MESH_GRAFANA_URL": "http://127.0.0.1:3000",
|
||||||
"MESH_GRAFANA_CONFIG_FILE": "/run/config/config.json"
|
"MESH_GRAFANA_CONFIG_FILE": "/run/config/config.json"
|
||||||
},
|
},
|
||||||
"restart-on": [
|
"restart-on": [
|
||||||
@@ -134,32 +92,16 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"requires": [
|
"requires": [
|
||||||
"route",
|
"route"
|
||||||
"oidc-client",
|
|
||||||
"influxdb-api"
|
|
||||||
],
|
],
|
||||||
"contributes": {
|
"contributes": {
|
||||||
"route": {
|
"route": {
|
||||||
"label": "grafana",
|
"label": "grafana",
|
||||||
"endpoint": "web"
|
"endpoint": "web"
|
||||||
},
|
|
||||||
"oidc-client": {
|
|
||||||
"label": "grafana",
|
|
||||||
"endpoint": "web",
|
|
||||||
"callback": "/login/generic_oauth"
|
|
||||||
},
|
|
||||||
"influxdb-api": {
|
|
||||||
"access": "read"
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"binds": {
|
"binds": {
|
||||||
"route": "${dir:state}/route.json",
|
"route": "/var/lib/mesh/grafana/route.json"
|
||||||
"oidc-client": "${dir:state}/oidc.json",
|
|
||||||
"influxdb-api": "${dir:state}/influxdb.json"
|
|
||||||
},
|
|
||||||
"secrets": {
|
|
||||||
"oidc-client": "${dir:mesh-state}/oidc-client",
|
|
||||||
"influxdb-api": "${dir:mesh-state}/influxdb-api"
|
|
||||||
},
|
},
|
||||||
"build": {
|
"build": {
|
||||||
"on": [
|
"on": [
|
||||||
|
|||||||
@@ -15,7 +15,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"binds": {
|
"binds": {
|
||||||
"route": "${dir:state}/route.json"
|
"route": "/var/lib/hello-web/route.json"
|
||||||
},
|
},
|
||||||
"listens": [
|
"listens": [
|
||||||
{
|
{
|
||||||
@@ -30,13 +30,13 @@
|
|||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/hello-web",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "page",
|
"id": "page",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/index.html",
|
"path": "/var/lib/hello-web/index.html",
|
||||||
"mode": "0644",
|
"mode": "0644",
|
||||||
"content": "hello from hello-web, routed by the mesh\n"
|
"content": "hello from hello-web, routed by the mesh\n"
|
||||||
},
|
},
|
||||||
@@ -54,7 +54,7 @@
|
|||||||
"8080"
|
"8080"
|
||||||
],
|
],
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:state}/index.html:/www/index.html:ro"
|
"/var/lib/hello-web/index.html:/www/index.html:ro"
|
||||||
],
|
],
|
||||||
"args": [
|
"args": [
|
||||||
"sh",
|
"sh",
|
||||||
|
|||||||
@@ -9,8 +9,8 @@
|
|||||||
"state.changed"
|
"state.changed"
|
||||||
],
|
],
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"broker": "${dir:mesh-state}/broker",
|
"broker": "/var/lib/mesh/home-assistant/broker",
|
||||||
"token": "${dir:mesh-state}/token"
|
"token": "/var/lib/mesh/home-assistant/token"
|
||||||
},
|
},
|
||||||
"listens": [
|
"listens": [
|
||||||
{
|
{
|
||||||
@@ -39,8 +39,8 @@
|
|||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/home-assistant",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
@@ -74,7 +74,7 @@
|
|||||||
{
|
{
|
||||||
"id": "runtime-config",
|
"id": "runtime-config",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:mesh-state}/config.json",
|
"path": "/var/lib/mesh/home-assistant/config.json",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "{}\n",
|
"content": "{}\n",
|
||||||
"merge": "json"
|
"merge": "json"
|
||||||
@@ -85,9 +85,9 @@
|
|||||||
"name": "mesh-home-assistant",
|
"name": "mesh-home-assistant",
|
||||||
"network": "host",
|
"network": "host",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/home-assistant/broker:/run/secrets/broker:ro",
|
||||||
"${dir:mesh-state}/token:/run/secrets/token:ro",
|
"/var/lib/mesh/home-assistant/token:/run/secrets/token:ro",
|
||||||
"${dir:mesh-state}/config.json:/run/config/config.json:ro"
|
"/var/lib/mesh/home-assistant/config.json:/run/config/config.json:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
@@ -107,7 +107,7 @@
|
|||||||
"network": "host",
|
"network": "host",
|
||||||
"run-once": true,
|
"run-once": true,
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/token:/run/secrets/token:ro",
|
"/var/lib/mesh/home-assistant/token:/run/secrets/token:ro",
|
||||||
"${dir:written}:/var/lib/home-assistant-provisions",
|
"${dir:written}:/var/lib/home-assistant-provisions",
|
||||||
"${dir:state}/mqtt-topic.json:/run/provisions/mqtt-topic.json:ro",
|
"${dir:state}/mqtt-topic.json:/run/provisions/mqtt-topic.json:ro",
|
||||||
"${dir:state}/mqtt-topic.secret:/run/provisions/mqtt-topic.secret:ro",
|
"${dir:state}/mqtt-topic.secret:/run/provisions/mqtt-topic.secret:ro",
|
||||||
|
|||||||
+28
-53
@@ -1,26 +1,6 @@
|
|||||||
{
|
{
|
||||||
"module": "icecast",
|
"module": "icecast",
|
||||||
"version": "1",
|
"version": "1",
|
||||||
"requires": [
|
|
||||||
"route",
|
|
||||||
"secret"
|
|
||||||
],
|
|
||||||
"contributes": {
|
|
||||||
"route": {
|
|
||||||
"label": "icecast",
|
|
||||||
"endpoint": "stream"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"binds": {
|
|
||||||
"route": "${dir:state}/route.json"
|
|
||||||
},
|
|
||||||
"secrets": {
|
|
||||||
"secret": {
|
|
||||||
"source": "${dir:state}/source.secret",
|
|
||||||
"admin": "${dir:state}/admin.secret",
|
|
||||||
"relay": "${dir:state}/relay.secret"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"capabilities": [
|
"capabilities": [
|
||||||
"container-runtime"
|
"container-runtime"
|
||||||
],
|
],
|
||||||
@@ -29,7 +9,7 @@
|
|||||||
"stream.stopped"
|
"stream.stopped"
|
||||||
],
|
],
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/icecast/broker"
|
||||||
},
|
},
|
||||||
"listens": [
|
"listens": [
|
||||||
{
|
{
|
||||||
@@ -37,61 +17,46 @@
|
|||||||
"port": 8000,
|
"port": 8000,
|
||||||
"protocol": "tcp",
|
"protocol": "tcp",
|
||||||
"from": "mesh",
|
"from": "mesh",
|
||||||
"why": "streams in from sources (HTTP PUT) and out to listeners, plus the status and admin pages; a public name is its route"
|
"why": "streams in from sources and out to listeners"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/icecast",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/icecast-module",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "logs",
|
"id": "server-env",
|
||||||
"type": "directory",
|
|
||||||
"mode": "0700",
|
|
||||||
"owner": "100:101"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "server-conf",
|
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/icecast.xml",
|
"path": "/var/lib/icecast-module/server.env",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "<icecast>\n <!-- Written by the mesh (modules/icecast). Passwords arrive as secrets rendered into this file,\n never as environment: the image's entrypoint seds ICECAST_* variables into the file only\n when they are set, and none are. -->\n <location>Earth</location>\n <admin>icemaster@localhost</admin>\n <limits>\n <clients>100</clients>\n <sources>2</sources>\n <queue-size>524288</queue-size>\n <client-timeout>30</client-timeout>\n <header-timeout>15</header-timeout>\n <source-timeout>10</source-timeout>\n <burst-on-connect>1</burst-on-connect>\n <burst-size>65535</burst-size>\n </limits>\n <authentication>\n <source-password>${secret:source}</source-password>\n <relay-password>${secret:relay}</relay-password>\n <admin-user>admin</admin-user>\n <admin-password>${secret:admin}</admin-password>\n </authentication>\n <!-- The name icecast writes into playlists (.m3u/.xspf: http://<hostname>:<port>/<mount>) and\n would announce to YP (none configured). A machine's own name belongs to its assignment, and\n an assignment merges only into JSON; this XML cannot take it, so the neutral default stays. -->\n <hostname>localhost</hostname>\n <listen-socket>\n <port>8000</port>\n </listen-socket>\n <http-headers>\n <header name=\"Access-Control-Allow-Origin\" value=\"*\" />\n </http-headers>\n <fileserve>1</fileserve>\n <paths>\n <basedir>/usr/share/icecast</basedir>\n <logdir>/var/log/icecast</logdir>\n <webroot>/usr/share/icecast/web</webroot>\n <adminroot>/usr/share/icecast/admin</adminroot>\n <alias source=\"/\" destination=\"/status.xsl\"/>\n </paths>\n <logging>\n <accesslog>access.log</accesslog>\n <errorlog>error.log</errorlog>\n <loglevel>3</loglevel>\n <logsize>10000</logsize>\n </logging>\n <security>\n <chroot>0</chroot>\n <!-- Starts as root, reads this 0600 root-owned file, then drops to the image's icecast user\n (uid 100, group icecast 101) before serving. -->\n <changeowner>\n <user>icecast</user>\n <group>icecast</group>\n </changeowner>\n </security>\n</icecast>\n"
|
"content": "ICECAST_SOURCE_PASSWORD=${secret:source}\nICECAST_ADMIN_PASSWORD=${secret:admin}\nICECAST_RELAY_PASSWORD=${secret:relay}\nICECAST_ADMIN_USERNAME=admin\n"
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "net",
|
|
||||||
"type": "network",
|
|
||||||
"name": "icecast"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "server",
|
"id": "server",
|
||||||
"type": "container",
|
"type": "container",
|
||||||
"name": "icecast",
|
"name": "icecast",
|
||||||
"image": "infiniteproject/icecast@sha256:cd506cf3dfe31ce05fd37d7e672dbd1213e7255cc93d28ecf5a3b547af4e162c",
|
"image": "infiniteproject/icecast@sha256:cd506cf3dfe31ce05fd37d7e672dbd1213e7255cc93d28ecf5a3b547af4e162c",
|
||||||
"network": "icecast",
|
"env-file": [
|
||||||
|
"/var/lib/icecast-module/server.env"
|
||||||
|
],
|
||||||
"ports": [
|
"ports": [
|
||||||
"8000"
|
"8000"
|
||||||
],
|
],
|
||||||
"volumes": [
|
"secrets-in-environment": "the image seds ICECAST_*_PASSWORD into icecast.xml and has no _FILE; convertible by mounting a generated icecast.xml, not yet done"
|
||||||
"${dir:state}/icecast.xml:/etc/icecast.xml:ro",
|
|
||||||
"${dir:logs}:/var/log/icecast"
|
|
||||||
],
|
|
||||||
"restart-on": [
|
|
||||||
"server-conf"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "runtime-config",
|
"id": "runtime-config",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:mesh-state}/config.json",
|
"path": "/var/lib/mesh/icecast/config.json",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "{}\n",
|
"content": "{}\n",
|
||||||
"merge": "json"
|
"merge": "json"
|
||||||
@@ -100,14 +65,14 @@
|
|||||||
"id": "runtime",
|
"id": "runtime",
|
||||||
"type": "container",
|
"type": "container",
|
||||||
"name": "mesh-icecast",
|
"name": "mesh-icecast",
|
||||||
"network": "icecast",
|
"network": "host",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/icecast/broker:/run/secrets/broker:ro",
|
||||||
"${dir:mesh-state}/config.json:/run/config/config.json:ro"
|
"/var/lib/mesh/icecast/config.json:/run/config/config.json:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_ICECAST_URL": "http://icecast:8000",
|
"MESH_ICECAST_URL": "http://127.0.0.1:8000",
|
||||||
"MESH_ICECAST_CONFIG_FILE": "/run/config/config.json"
|
"MESH_ICECAST_CONFIG_FILE": "/run/config/config.json"
|
||||||
},
|
},
|
||||||
"restart-on": [
|
"restart-on": [
|
||||||
@@ -136,5 +101,15 @@
|
|||||||
"from": "Dockerfile"
|
"from": "Dockerfile"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
"requires": [
|
||||||
|
"secret"
|
||||||
|
],
|
||||||
|
"secrets": {
|
||||||
|
"secret": {
|
||||||
|
"source": "/var/lib/icecast-module/source.secret",
|
||||||
|
"admin": "/var/lib/icecast-module/admin.secret",
|
||||||
|
"relay": "/var/lib/icecast-module/relay.secret"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ ARG RUNTIME_BASE
|
|||||||
FROM ${BUILD_BASE} AS build
|
FROM ${BUILD_BASE} AS build
|
||||||
WORKDIR /app/modules/influxdb
|
WORKDIR /app/modules/influxdb
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN node /app/node_modules/typescript/bin/tsc client.ts grants.ts provisioner/index.ts tools/index.ts \
|
RUN node /app/node_modules/typescript/bin/tsc client.ts tools/index.ts \
|
||||||
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
||||||
|
|
||||||
FROM ${RUNTIME_BASE}
|
FROM ${RUNTIME_BASE}
|
||||||
@@ -21,4 +21,4 @@ COPY --from=build /app/modules/influxdb/dist /app/modules/influxdb/dist
|
|||||||
# Every serve-time entrypoint, loaded by the runtime in serve mode: tools and events serve, and a
|
# Every serve-time entrypoint, loaded by the runtime in serve mode: tools and events serve, and a
|
||||||
# provider's provisioner runs its reconcile loop in the same process, with the broker connected —
|
# provider's provisioner runs its reconcile loop in the same process, with the broker connected —
|
||||||
# the convention novox/hq issues 060/061 settled.
|
# the convention novox/hq issues 060/061 settled.
|
||||||
ENV MESH_TOOL_MODULES=/app/modules/influxdb/dist/tools/index.js,/app/modules/influxdb/dist/provisioner/index.js
|
ENV MESH_TOOL_MODULES=/app/modules/influxdb/dist/tools/index.js
|
||||||
|
|||||||
+3
-118
@@ -17,25 +17,6 @@ export interface InfluxBucket {
|
|||||||
retentionSeconds?: number;
|
retentionSeconds?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** One permission of an authorization, as InfluxDB represents it: an action on a resource type,
|
|
||||||
* in one org, optionally narrowed to one resource by id (no id = every resource of that type). */
|
|
||||||
export interface InfluxPermission {
|
|
||||||
action: "read" | "write";
|
|
||||||
resource: { type: string; orgID?: string; id?: string; name?: string; org?: string };
|
|
||||||
}
|
|
||||||
|
|
||||||
/** A v1-compatibility ("legacy") authorization: a username (InfluxDB calls it `token`) and a
|
|
||||||
* password the caller chooses, scoped by permissions. The one credential InfluxDB 2.x lets a
|
|
||||||
* caller set to a value it did not generate — which is what a mesh-minted password needs. */
|
|
||||||
export interface LegacyAuthorization {
|
|
||||||
id: string;
|
|
||||||
token: string;
|
|
||||||
orgID: string;
|
|
||||||
status?: "active" | "inactive";
|
|
||||||
description?: string;
|
|
||||||
permissions: InfluxPermission[];
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The settings-merged config the mesh delivers (novox/hq ADR 0046): { url, apiKey, token, password, user, ... }. */
|
/** The settings-merged config the mesh delivers (novox/hq ADR 0046): { url, apiKey, token, password, user, ... }. */
|
||||||
function meshConfig(file?: string): Record<string, string> {
|
function meshConfig(file?: string): Record<string, string> {
|
||||||
if (!file) return {};
|
if (!file) return {};
|
||||||
@@ -43,20 +24,13 @@ function meshConfig(file?: string): Record<string, string> {
|
|||||||
catch { return {}; }
|
catch { return {}; }
|
||||||
}
|
}
|
||||||
|
|
||||||
/** A secret delivered as a file, trimmed; undefined when there is none, so the caller can fall back. */
|
|
||||||
function tokenFromFile(file?: string): string | undefined {
|
|
||||||
if (!file) return undefined;
|
|
||||||
try { return readFileSync(file, "utf8").trim() || undefined; }
|
|
||||||
catch { return undefined; }
|
|
||||||
}
|
|
||||||
|
|
||||||
export class InfluxDBClient {
|
export class InfluxDBClient {
|
||||||
readonly baseUrl: string;
|
readonly baseUrl: string;
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
url: string,
|
url: string,
|
||||||
private readonly token: string,
|
private readonly token: string,
|
||||||
readonly org: string,
|
private readonly org: string,
|
||||||
) {
|
) {
|
||||||
this.baseUrl = url.replace(/\/$/, "");
|
this.baseUrl = url.replace(/\/$/, "");
|
||||||
}
|
}
|
||||||
@@ -69,10 +43,8 @@ export class InfluxDBClient {
|
|||||||
static fromEnv(env: NodeJS.ProcessEnv = process.env): InfluxDBClient {
|
static fromEnv(env: NodeJS.ProcessEnv = process.env): InfluxDBClient {
|
||||||
const cfg = meshConfig(env.MESH_INFLUXDB_CONFIG_FILE);
|
const cfg = meshConfig(env.MESH_INFLUXDB_CONFIG_FILE);
|
||||||
const url = cfg.url ?? env.MESH_INFLUXDB_URL ?? `http://127.0.0.1:${env.INFLUXDB_PORT ?? "8086"}`;
|
const url = cfg.url ?? env.MESH_INFLUXDB_URL ?? `http://127.0.0.1:${env.INFLUXDB_PORT ?? "8086"}`;
|
||||||
// The token reaches the process as a file (novox/hq ADR 0086); the environment variable stays
|
const token = cfg.token ?? env.MESH_INFLUXDB_TOKEN;
|
||||||
// only for a workstation running the tools by hand.
|
if (!token) throw new Error("no InfluxDB token — set MESH_INFLUXDB_TOKEN");
|
||||||
const token = cfg.token ?? tokenFromFile(env.MESH_INFLUXDB_TOKEN_FILE) ?? env.MESH_INFLUXDB_TOKEN;
|
|
||||||
if (!token) throw new Error("no InfluxDB token — set MESH_INFLUXDB_TOKEN_FILE");
|
|
||||||
const org = cfg.org ?? env.MESH_INFLUXDB_ORG ?? "mesh";
|
const org = cfg.org ?? env.MESH_INFLUXDB_ORG ?? "mesh";
|
||||||
return new InfluxDBClient(url, token, org);
|
return new InfluxDBClient(url, token, org);
|
||||||
}
|
}
|
||||||
@@ -89,93 +61,6 @@ export class InfluxDBClient {
|
|||||||
return res;
|
return res;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Like request, but the answer is returned whatever its status, for the caller to read. */
|
|
||||||
private async raw(path: string, init?: RequestInit): Promise<Response> {
|
|
||||||
return fetch(`${this.baseUrl}${path}`, {
|
|
||||||
...init,
|
|
||||||
headers: { Authorization: `Token ${this.token}`, ...(init?.headers ?? {}) },
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
private async send(path: string, method: string, body?: unknown): Promise<Response> {
|
|
||||||
return this.request(path, {
|
|
||||||
method,
|
|
||||||
headers: { "Content-Type": "application/json" },
|
|
||||||
body: body === undefined ? undefined : JSON.stringify(body),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The id of the org of this name, or undefined when there is none. */
|
|
||||||
async orgID(name: string): Promise<string | undefined> {
|
|
||||||
const res = await this.raw(`/api/v2/orgs?org=${encodeURIComponent(name)}`);
|
|
||||||
if (res.status === 404) return undefined;
|
|
||||||
if (!res.ok) throw new Error(`InfluxDB API /api/v2/orgs: ${res.status} ${await res.text()}`);
|
|
||||||
const body = (await res.json()) as { orgs?: { id: string; name: string }[] };
|
|
||||||
return body.orgs?.find((o) => o.name === name)?.id;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The bucket of exactly this name in the org, or undefined. */
|
|
||||||
async findBucket(orgID: string, name: string): Promise<InfluxBucket | undefined> {
|
|
||||||
const res = await this.raw(`/api/v2/buckets?orgID=${encodeURIComponent(orgID)}&name=${encodeURIComponent(name)}`);
|
|
||||||
if (res.status === 404) return undefined;
|
|
||||||
if (!res.ok) throw new Error(`InfluxDB API /api/v2/buckets: ${res.status} ${await res.text()}`);
|
|
||||||
const body = (await res.json()) as { buckets?: { id: string; name: string; orgID?: string }[] };
|
|
||||||
const b = body.buckets?.find((x) => x.name === name);
|
|
||||||
return b ? { id: b.id, name: b.name, orgID: b.orgID } : undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Create a bucket that keeps its data for ever — retention is the operator's choice, never the mesh's. */
|
|
||||||
async createBucket(orgID: string, name: string, description: string): Promise<InfluxBucket> {
|
|
||||||
const b = (await (await this.send("/api/v2/buckets", "POST", {
|
|
||||||
orgID, name, description, retentionRules: [],
|
|
||||||
})).json()) as { id: string; name: string; orgID?: string };
|
|
||||||
return { id: b.id, name: b.name, orgID: b.orgID };
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The v1 authorization whose username is exactly this, or undefined. */
|
|
||||||
async findLegacy(username: string): Promise<LegacyAuthorization | undefined> {
|
|
||||||
const path = `/private/legacy/authorizations?token=${encodeURIComponent(username)}`;
|
|
||||||
const res = await this.raw(path);
|
|
||||||
// InfluxDB answers a filter matching nothing with 404, not an empty list.
|
|
||||||
if (res.status === 404) return undefined;
|
|
||||||
if (!res.ok) throw new Error(`InfluxDB API ${path}: ${res.status} ${await res.text()}`);
|
|
||||||
const body = (await res.json()) as { authorizations?: LegacyAuthorization[] };
|
|
||||||
return body.authorizations?.find((a) => a.token === username);
|
|
||||||
}
|
|
||||||
|
|
||||||
async createLegacy(a: Omit<LegacyAuthorization, "id">): Promise<LegacyAuthorization> {
|
|
||||||
return (await (await this.send("/private/legacy/authorizations", "POST", a)).json()) as LegacyAuthorization;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Set a v1 authorization's password. InfluxDB keeps only a hash of it, so it can be set, never read. */
|
|
||||||
async setLegacyPassword(id: string, password: string): Promise<void> {
|
|
||||||
await this.send(`/private/legacy/authorizations/${encodeURIComponent(id)}/password`, "POST", { password });
|
|
||||||
}
|
|
||||||
|
|
||||||
async updateLegacy(id: string, patch: { status?: "active" | "inactive"; description?: string }): Promise<void> {
|
|
||||||
await this.send(`/private/legacy/authorizations/${encodeURIComponent(id)}`, "PATCH", patch);
|
|
||||||
}
|
|
||||||
|
|
||||||
async deleteLegacy(id: string): Promise<void> {
|
|
||||||
await this.send(`/private/legacy/authorizations/${encodeURIComponent(id)}`, "DELETE");
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Whether this username and password sign in on the v1 API — the consumer's own view. Asked with
|
|
||||||
* a statement that reads nothing (`SHOW DATABASES` lists only what the credential may read), sent
|
|
||||||
* with Basic auth so the password is never in a URL. 401 is a wrong password or no such user;
|
|
||||||
* anything else that is not a server error means InfluxDB knew who was asking.
|
|
||||||
*/
|
|
||||||
async legacySignsIn(username: string, password: string): Promise<boolean> {
|
|
||||||
const res = await fetch(`${this.baseUrl}/query?q=${encodeURIComponent("SHOW DATABASES")}`, {
|
|
||||||
headers: { Authorization: `Basic ${Buffer.from(`${username}:${password}`).toString("base64")}` },
|
|
||||||
});
|
|
||||||
await res.arrayBuffer();
|
|
||||||
if (res.status === 401) return false;
|
|
||||||
if (res.status >= 500) throw new Error(`InfluxDB v1 /query: ${res.status}`);
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Server health — the one endpoint that needs no token, but we send it anyway. */
|
/** Server health — the one endpoint that needs no token, but we send it anyway. */
|
||||||
async health(): Promise<InfluxHealth> {
|
async health(): Promise<InfluxHealth> {
|
||||||
return (await (await this.request("/health")).json()) as InfluxHealth;
|
return (await (await this.request("/health")).json()) as InfluxHealth;
|
||||||
|
|||||||
@@ -1,186 +0,0 @@
|
|||||||
// What the `influxdb-api` provision means in InfluxDB: one v1-compatibility authorization per
|
|
||||||
// consumer, in the org this module serves, under the username and password the mesh gave both ends,
|
|
||||||
// allowed exactly the access the consumer contributed. The provisioner (provisioner/index.ts) is the
|
|
||||||
// sdk harness calling these; they are here, apart from it, so they can be exercised against a fake
|
|
||||||
// InfluxDB without a broker or a contributions file.
|
|
||||||
//
|
|
||||||
// **Why a v1 authorization and not a v2 API token.** The mesh mints the consumer's password and
|
|
||||||
// hands it to both ends (novox/hq ADR 0048); the provider sets it, and never hands one back. An
|
|
||||||
// InfluxDB 2.x API token is generated by the server — `POST /api/v2/authorizations` ignores a token
|
|
||||||
// the caller sends — so a token could only ever be the operator's to accept, one per pair, by hand.
|
|
||||||
// A v1 authorization is a username and a password the caller chooses (8–72 characters; the mesh
|
|
||||||
// mints 40), stored hashed, and it reads and writes through InfluxQL (`/query`) and line protocol
|
|
||||||
// (`/write`), which every bucket answers under its own name as a database (InfluxDB maps each
|
|
||||||
// bucket to a database of the same name by itself). That is what grafana's InfluxDB data source
|
|
||||||
// speaks, and what Node-RED's influxdb nodes speak in their 1.x mode — so the mesh can make every
|
|
||||||
// consumer's credential, rotate it and withdraw it, with no person in the loop.
|
|
||||||
//
|
|
||||||
// **What a consumer contributes.** `access`: "read" (the default), "write" or "read-write".
|
|
||||||
// `buckets`: the buckets it may use, by name. A reader that names none may read every bucket of the
|
|
||||||
// org — a dashboard is pointed at data, it does not own it. A writer must name its buckets: writing
|
|
||||||
// everywhere, the org's system buckets included, is never what a consumer means. A named bucket
|
|
||||||
// that does not exist is created, keeping its data for ever; the mesh never deletes a bucket.
|
|
||||||
//
|
|
||||||
// **Only what the mesh made is touched.** An authorization this module creates is named with the
|
|
||||||
// mesh's identity prefix and its description starts with MARK. One with the same username that
|
|
||||||
// lacks the mark is somebody else's: it is refused, never adopted, never updated, never deleted.
|
|
||||||
// Every other authorization, token, user and bucket in the instance is left exactly as it was.
|
|
||||||
|
|
||||||
import type { InfluxDBClient, InfluxPermission, LegacyAuthorization } from "./client.js";
|
|
||||||
|
|
||||||
/** How a description marks an authorization as the mesh's own work. */
|
|
||||||
export const MARK = "[mesh]";
|
|
||||||
|
|
||||||
/** The prefix the mesh gives every consumer identity (novox/hq ADR 0049). */
|
|
||||||
const IDENTITY_PREFIX = "mesh_";
|
|
||||||
|
|
||||||
/** One consumer, as the harness hands it over. */
|
|
||||||
export interface ApiGrant {
|
|
||||||
readonly as: string;
|
|
||||||
readonly password: string;
|
|
||||||
readonly values: Readonly<Record<string, unknown>>;
|
|
||||||
readonly consumer?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export type Access = "read" | "write" | "read-write";
|
|
||||||
|
|
||||||
/** What a contribution asks for, checked. Refused when it cannot be served as asked. */
|
|
||||||
export function askedFor(values: Readonly<Record<string, unknown>>): { access: Access; buckets: string[] } {
|
|
||||||
const access = values.access ?? "read";
|
|
||||||
if (access !== "read" && access !== "write" && access !== "read-write") {
|
|
||||||
throw new Error(`contributes an access of ${JSON.stringify(access)} — it is "read", "write" or "read-write"`);
|
|
||||||
}
|
|
||||||
const raw = values.buckets ?? [];
|
|
||||||
if (!Array.isArray(raw) || raw.some((b) => typeof b !== "string" || b.trim() === "")) {
|
|
||||||
throw new Error(`contributes buckets of ${JSON.stringify(raw)} — a list of bucket names`);
|
|
||||||
}
|
|
||||||
const buckets = [...new Set((raw as string[]).map((b) => b.trim()))].sort();
|
|
||||||
if (access !== "read" && buckets.length === 0) {
|
|
||||||
throw new Error(`asks to write and names no bucket (\`buckets\`) — a writer names what it writes to`);
|
|
||||||
}
|
|
||||||
if (buckets.some((b) => b.startsWith("_"))) {
|
|
||||||
throw new Error(`names a system bucket (${buckets.filter((b) => b.startsWith("_")).join(", ")}) — those are InfluxDB's own`);
|
|
||||||
}
|
|
||||||
return { access: access as Access, buckets };
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The permissions a grant resolves to, given each named bucket's id. */
|
|
||||||
export function permissionsFor(orgID: string, access: Access, bucketIDs: string[]): InfluxPermission[] {
|
|
||||||
const actions: ("read" | "write")[] = access === "read-write" ? ["read", "write"] : [access];
|
|
||||||
const out: InfluxPermission[] = [];
|
|
||||||
for (const action of actions) {
|
|
||||||
if (bucketIDs.length === 0) {
|
|
||||||
out.push({ action, resource: { type: "buckets", orgID } });
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
for (const id of bucketIDs) out.push({ action, resource: { type: "buckets", orgID, id } });
|
|
||||||
}
|
|
||||||
return out;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** A permission as a comparable string: what InfluxDB answers carries names and links besides. */
|
|
||||||
function key(p: InfluxPermission): string {
|
|
||||||
return `${p.action}:${p.resource.type}:${p.resource.orgID ?? ""}:${p.resource.id ?? "*"}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
function samePermissions(a: readonly InfluxPermission[], b: readonly InfluxPermission[]): boolean {
|
|
||||||
const x = a.map(key).sort();
|
|
||||||
const y = b.map(key).sort();
|
|
||||||
return x.length === y.length && x.every((v, i) => v === y[i]);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function marked(a: Pick<LegacyAuthorization, "token" | "description">): boolean {
|
|
||||||
return a.token.startsWith(IDENTITY_PREFIX) && (a.description ?? "").startsWith(MARK);
|
|
||||||
}
|
|
||||||
|
|
||||||
function describe(g: ApiGrant): string {
|
|
||||||
return `${MARK} made by the mesh for ${g.consumer ? `a module on ${g.consumer}` : "a consumer"} — do not edit; it is reset`;
|
|
||||||
}
|
|
||||||
|
|
||||||
export class ApiGrants {
|
|
||||||
constructor(private readonly influx: InfluxDBClient, readonly org: string) {}
|
|
||||||
|
|
||||||
private async orgID(): Promise<string> {
|
|
||||||
const id = await this.influx.orgID(this.org);
|
|
||||||
if (!id) throw new Error(`InfluxDB has no org ${JSON.stringify(this.org)} — the org this module serves must exist`);
|
|
||||||
return id;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The ids of the named buckets, creating any that are missing when `create` says so. Undefined
|
|
||||||
* when one is missing and may not be created (a read-only question). */
|
|
||||||
private async bucketIDs(orgID: string, names: string[], create: ApiGrant | undefined): Promise<string[] | undefined> {
|
|
||||||
const ids: string[] = [];
|
|
||||||
for (const name of names) {
|
|
||||||
let b = await this.influx.findBucket(orgID, name);
|
|
||||||
if (!b) {
|
|
||||||
if (!create) return undefined;
|
|
||||||
b = await this.influx.createBucket(orgID, name, `${MARK} made by the mesh for ${create.as}; the mesh never deletes it`);
|
|
||||||
}
|
|
||||||
ids.push(b.id);
|
|
||||||
}
|
|
||||||
return ids.sort();
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Create the consumer's authorization, or bring the mesh's existing one back to what the grant
|
|
||||||
* says. Idempotent: a second apply of the same grant changes nothing beyond re-asserting the
|
|
||||||
* password, which InfluxDB can be told but never asked. */
|
|
||||||
async ensure(g: ApiGrant): Promise<"created" | "updated" | "unchanged"> {
|
|
||||||
if (!g.as.startsWith(IDENTITY_PREFIX)) {
|
|
||||||
throw new Error(`${g.as} is not a mesh identity — the mesh names every consumer ${IDENTITY_PREFIX}<node>_<module>`);
|
|
||||||
}
|
|
||||||
const { access, buckets } = askedFor(g.values);
|
|
||||||
const orgID = await this.orgID();
|
|
||||||
const found = await this.influx.findLegacy(g.as);
|
|
||||||
if (found && !marked(found)) {
|
|
||||||
throw new Error(
|
|
||||||
`InfluxDB already has a v1 authorization ${g.as} the mesh did not make — left alone; ` +
|
|
||||||
`delete it if the mesh should own that name`);
|
|
||||||
}
|
|
||||||
const want = permissionsFor(orgID, access, (await this.bucketIDs(orgID, buckets, g))!);
|
|
||||||
|
|
||||||
if (found && found.orgID === orgID && samePermissions(found.permissions, want)) {
|
|
||||||
// Only what differs is written. The password cannot be read back, so it is tried instead.
|
|
||||||
let changed = false;
|
|
||||||
if (found.status === "inactive") {
|
|
||||||
await this.influx.updateLegacy(found.id, { status: "active" });
|
|
||||||
changed = true;
|
|
||||||
}
|
|
||||||
if (!(await this.influx.legacySignsIn(g.as, g.password))) {
|
|
||||||
await this.influx.setLegacyPassword(found.id, g.password);
|
|
||||||
changed = true;
|
|
||||||
}
|
|
||||||
return changed ? "updated" : "unchanged";
|
|
||||||
}
|
|
||||||
// InfluxDB cannot change an authorization's permissions in place, so the mesh's own is made
|
|
||||||
// again. Only ever one the mesh made: a foreign one was refused above.
|
|
||||||
if (found) await this.influx.deleteLegacy(found.id);
|
|
||||||
const made = await this.influx.createLegacy({
|
|
||||||
token: g.as, orgID, status: "active", description: describe(g), permissions: want,
|
|
||||||
});
|
|
||||||
await this.influx.setLegacyPassword(made.id, g.password);
|
|
||||||
return found ? "updated" : "created";
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Whether InfluxDB still holds this consumer's authorization exactly as the grant says: present,
|
|
||||||
* the mesh's, active, allowed what was asked and nothing more, and signing in with the mesh's
|
|
||||||
* password. Reads only — a missing bucket is "not held", never created here. */
|
|
||||||
async holds(g: ApiGrant): Promise<boolean> {
|
|
||||||
const { access, buckets } = askedFor(g.values);
|
|
||||||
const orgID = await this.influx.orgID(this.org);
|
|
||||||
if (!orgID) return false;
|
|
||||||
const found = await this.influx.findLegacy(g.as);
|
|
||||||
if (!found || !marked(found) || found.status === "inactive" || found.orgID !== orgID) return false;
|
|
||||||
const ids = await this.bucketIDs(orgID, buckets, undefined);
|
|
||||||
if (!ids || !samePermissions(found.permissions, permissionsFor(orgID, access, ids))) return false;
|
|
||||||
return this.influx.legacySignsIn(g.as, g.password);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Withdraw a consumer's authorization — only one the mesh made. Its buckets and their data stay. */
|
|
||||||
async remove(as: string): Promise<"removed" | "absent" | "not ours"> {
|
|
||||||
const found = await this.influx.findLegacy(as);
|
|
||||||
if (!found) return "absent";
|
|
||||||
if (!marked(found)) return "not ours";
|
|
||||||
await this.influx.deleteLegacy(found.id);
|
|
||||||
return "removed";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,19 +1,11 @@
|
|||||||
{
|
{
|
||||||
"module": "influxdb",
|
"module": "influxdb",
|
||||||
"version": "1",
|
"version": "1",
|
||||||
"provides": [
|
|
||||||
{
|
|
||||||
"name": "influxdb-api",
|
|
||||||
"scope": "mesh"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"capabilities": [
|
"capabilities": [
|
||||||
"container-runtime"
|
"container-runtime"
|
||||||
],
|
],
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"broker": "${dir:mesh-state}/broker",
|
"broker": "/var/lib/mesh/influxdb/broker"
|
||||||
"admin": "${dir:state}/admin.secret",
|
|
||||||
"admin-token": "${dir:state}/admin-token.secret"
|
|
||||||
},
|
},
|
||||||
"listens": [
|
"listens": [
|
||||||
{
|
{
|
||||||
@@ -21,82 +13,64 @@
|
|||||||
"port": 8086,
|
"port": 8086,
|
||||||
"protocol": "tcp",
|
"protocol": "tcp",
|
||||||
"from": "mesh",
|
"from": "mesh",
|
||||||
"why": "queries, writes and the web UI, over http; consumers granted influxdb-api sign in with the mesh's credential, and a name is a route grant"
|
"why": "queries and writes, over http"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"serves": {
|
|
||||||
"influxdb-api": {
|
|
||||||
"scheme": "http",
|
|
||||||
"port": 8086,
|
|
||||||
"org": "mesh",
|
|
||||||
"bucket": "default"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"receives": {
|
|
||||||
"influxdb-api": "${dir:grants}/mesh.json"
|
|
||||||
},
|
|
||||||
"grants": {
|
|
||||||
"influxdb-api": "${dir:grants}"
|
|
||||||
},
|
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/influxdb",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/influxdb-module",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "server-env",
|
||||||
|
"type": "file",
|
||||||
|
"path": "/var/lib/influxdb-module/server.env",
|
||||||
|
"mode": "0600",
|
||||||
|
"content": "DOCKER_INFLUXDB_INIT_MODE=setup\nDOCKER_INFLUXDB_INIT_USERNAME=admin\nDOCKER_INFLUXDB_INIT_PASSWORD=${secret:admin}\nDOCKER_INFLUXDB_INIT_ADMIN_TOKEN=${secret:admin-token}\nDOCKER_INFLUXDB_INIT_ORG=mesh\nDOCKER_INFLUXDB_INIT_BUCKET=default\n"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "data",
|
"id": "data",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/services/influxdb/data",
|
||||||
"mode": "0700",
|
"mode": "0700",
|
||||||
"owner": "1000:1000"
|
"owner": "1000:1000"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "config",
|
"id": "config",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/services/influxdb/config",
|
||||||
"mode": "0700",
|
"mode": "0700",
|
||||||
"owner": "1000:1000"
|
"owner": "1000:1000"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"id": "grants",
|
|
||||||
"type": "directory",
|
|
||||||
"mode": "0700"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "server-env",
|
|
||||||
"type": "file",
|
|
||||||
"path": "${dir:state}/server.env",
|
|
||||||
"mode": "0600",
|
|
||||||
"content": "DOCKER_INFLUXDB_INIT_MODE=setup\nDOCKER_INFLUXDB_INIT_USERNAME=admin\nDOCKER_INFLUXDB_INIT_PASSWORD_FILE=/run/secrets/admin\nDOCKER_INFLUXDB_INIT_ADMIN_TOKEN_FILE=/run/secrets/admin-token\nDOCKER_INFLUXDB_INIT_ORG=mesh\nDOCKER_INFLUXDB_INIT_BUCKET=default\n"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"id": "server",
|
"id": "server",
|
||||||
"type": "container",
|
"type": "container",
|
||||||
"name": "influxdb",
|
"name": "influxdb",
|
||||||
"image": "influxdb@sha256:f75e48af0598e8aec7986e991a848d19a119101a7d563a2e5db1dfaac9c45daa",
|
"image": "influxdb@sha256:f75e48af0598e8aec7986e991a848d19a119101a7d563a2e5db1dfaac9c45daa",
|
||||||
"env-file": [
|
"env-file": [
|
||||||
"${dir:state}/server.env"
|
"/var/lib/influxdb-module/server.env"
|
||||||
],
|
],
|
||||||
"ports": [
|
"ports": [
|
||||||
"8086"
|
"8086"
|
||||||
],
|
],
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:data}:/var/lib/influxdb2",
|
"/services/influxdb/data:/var/lib/influxdb2",
|
||||||
"${dir:config}:/etc/influxdb2",
|
"/services/influxdb/config:/etc/influxdb2"
|
||||||
"${dir:state}/admin.secret:/run/secrets/admin:ro",
|
],
|
||||||
"${dir:state}/admin-token.secret:/run/secrets/admin-token:ro"
|
"secrets-in-environment": "the image honours DOCKER_INFLUXDB_INIT_PASSWORD_FILE and _ADMIN_TOKEN_FILE; convertible, awaiting a bed that proves it"
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "runtime-config",
|
"id": "runtime-config",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:mesh-state}/config.json",
|
"path": "/var/lib/mesh/influxdb/config.json",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "{}\n",
|
"content": "{}\n",
|
||||||
"merge": "json"
|
"merge": "json"
|
||||||
@@ -107,17 +81,15 @@
|
|||||||
"name": "mesh-influxdb",
|
"name": "mesh-influxdb",
|
||||||
"network": "host",
|
"network": "host",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/influxdb/broker:/run/secrets/broker:ro",
|
||||||
"${dir:mesh-state}/config.json:/run/config/config.json:ro",
|
"/var/lib/mesh/influxdb/config.json:/run/config/config.json:ro",
|
||||||
"${dir:state}/admin-token.secret:/run/secrets/admin-token:ro",
|
"/services/influxdb/config:/var/lib/influxdb/config:ro"
|
||||||
"${dir:grants}:${dir:grants}:ro"
|
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_INFLUXDB_URL": "http://127.0.0.1:${port:8086}",
|
"MESH_INFLUXDB_URL": "http://127.0.0.1:8086",
|
||||||
"MESH_INFLUXDB_CONFIG_FILE": "/run/config/config.json",
|
"MESH_INFLUXDB_CONFIG_FILE": "/run/config/config.json",
|
||||||
"MESH_INFLUXDB_TOKEN_FILE": "/run/secrets/admin-token",
|
"MESH_INFLUXDB_CONFIG_DIR": "/var/lib/influxdb/config"
|
||||||
"MESH_RECEIVES": "${dir:grants}/mesh.json"
|
|
||||||
},
|
},
|
||||||
"restart-on": [
|
"restart-on": [
|
||||||
"runtime-config"
|
"runtime-config"
|
||||||
@@ -125,15 +97,6 @@
|
|||||||
"artifact": "runtime"
|
"artifact": "runtime"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"requires": [
|
|
||||||
"route"
|
|
||||||
],
|
|
||||||
"contributes": {
|
|
||||||
"route": {
|
|
||||||
"label": "influxdb",
|
|
||||||
"endpoint": "api"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"build": {
|
"build": {
|
||||||
"on": [
|
"on": [
|
||||||
{
|
{
|
||||||
@@ -154,5 +117,14 @@
|
|||||||
"from": "Dockerfile"
|
"from": "Dockerfile"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
"requires": [
|
||||||
|
"secret"
|
||||||
|
],
|
||||||
|
"secrets": {
|
||||||
|
"secret": {
|
||||||
|
"admin": "/var/lib/influxdb-module/admin.secret",
|
||||||
|
"admin-token": "/var/lib/influxdb-module/admin-token.secret"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,14 +1,9 @@
|
|||||||
{
|
{
|
||||||
"name": "@novox/module-influxdb",
|
"name": "@novox/module-influxdb",
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"description": "influxdb — time-series database; provides the mesh influxdb-api interface. Its API client, provisioner and tools live here (novox/hq ADR 0039).",
|
"description": "influxdb — time-series database. Its API client and tools live here (novox/hq ADR 0039).",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
|
||||||
"build": "tsc client.ts grants.ts provisioner/index.ts tools/index.ts --module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist",
|
|
||||||
"typecheck": "tsc -p tsconfig.json",
|
|
||||||
"test": "npm run build && node --test --experimental-strip-types 'test/*.test.ts'"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@novox/mesh-sdk": "^0.1.0"
|
"@novox/mesh-sdk": "^0.1.0"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -1,54 +0,0 @@
|
|||||||
// influxdb's provisioner — the adapter that makes influxdb a provider of the mesh `influxdb-api`
|
|
||||||
// interface. The reconcile loop, the contributions file and reading the mesh's minted secret are the
|
|
||||||
// sdk harness's; this writes only the per-service half: how InfluxDB creates, checks and removes a
|
|
||||||
// consumer's credential (novox/hq ADR 0039/0040/0048). What that credential is, and why it is a v1
|
|
||||||
// authorization, is in ../grants.ts.
|
|
||||||
//
|
|
||||||
// The `influxdb-api` interface: a consumer reaches `${bound:influxdb-api:scheme}://…:at:…:port`,
|
|
||||||
// signs in as `${bound:influxdb-api:as}` with the password the mesh minted for the pair, and reads
|
|
||||||
// or writes the org's buckets as databases of the same name — `${bound:influxdb-api:bucket}` being
|
|
||||||
// the one this instance serves by default. The org and the default bucket are the assignment's
|
|
||||||
// settings, which reach both what is served and this module's config.json, so the org a consumer is
|
|
||||||
// told and the org its credential is made in cannot disagree.
|
|
||||||
|
|
||||||
import { runProvisioner, type Provision } from "@novox/mesh-sdk/provisioner";
|
|
||||||
import { InfluxDBClient } from "../client.js";
|
|
||||||
import { ApiGrants } from "../grants.js";
|
|
||||||
|
|
||||||
let grants: ApiGrants | undefined;
|
|
||||||
try {
|
|
||||||
const influx = InfluxDBClient.fromEnv();
|
|
||||||
grants = new ApiGrants(influx, influx.org);
|
|
||||||
} catch (err) {
|
|
||||||
// No admin token: nothing can be provisioned, and the tools loaded beside this must still serve.
|
|
||||||
console.error(`[provisioner:influxdb-api] not started: ${err instanceof Error ? err.message : err}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (grants) serve(grants);
|
|
||||||
|
|
||||||
function serve(grants: ApiGrants): void {
|
|
||||||
runProvisioner("influxdb-api", {
|
|
||||||
async create(p: Provision): Promise<void> {
|
|
||||||
const done = await grants.ensure(p);
|
|
||||||
if (done !== "unchanged") {
|
|
||||||
console.log(`[provisioner:influxdb-api] ${done} v1 authorization ${p.as} in org ${grants.org}`);
|
|
||||||
}
|
|
||||||
},
|
|
||||||
|
|
||||||
async remove(p: { as: string }): Promise<void> {
|
|
||||||
const done = await grants.remove(p.as);
|
|
||||||
if (done === "not ours") {
|
|
||||||
console.error(`[provisioner:influxdb-api] ${p.as}: an authorization of that name exists that the mesh did not make — left alone`);
|
|
||||||
} else if (done === "removed") {
|
|
||||||
console.log(`[provisioner:influxdb-api] removed v1 authorization ${p.as}; its buckets and their data stay`);
|
|
||||||
}
|
|
||||||
},
|
|
||||||
|
|
||||||
// Asked every minute by the harness: whether InfluxDB still holds this consumer's authorization
|
|
||||||
// exactly as the mesh gave it, so one deleted, disabled or re-passworded behind the mesh's back is
|
|
||||||
// made whole again (hq issue 120).
|
|
||||||
async holds(p: Provision): Promise<boolean> {
|
|
||||||
return grants.holds(p);
|
|
||||||
},
|
|
||||||
});
|
|
||||||
}
|
|
||||||
@@ -1,246 +0,0 @@
|
|||||||
// What holds influxdb to the `influxdb-api` provision (grants.ts): one v1 authorization per consumer,
|
|
||||||
// under the username and password the mesh gave, allowed only what the consumer contributed; made
|
|
||||||
// once and brought back on every apply; buckets created when missing and never deleted; and an
|
|
||||||
// authorization the mesh did not make — same name or not — never adopted, changed or deleted.
|
|
||||||
//
|
|
||||||
// InfluxDB is a fake: the routes the module touches, answering with the status codes and shapes
|
|
||||||
// InfluxDB 2.9 gives (a filter matching nothing is a 404, a password outside 8–72 characters a 400,
|
|
||||||
// an inactive authorization or a wrong password a 401 on /query). Run against the compiled module
|
|
||||||
// (npm test builds first), the way the runtime loads it.
|
|
||||||
|
|
||||||
import { test, after, beforeEach } from "node:test";
|
|
||||||
import assert from "node:assert/strict";
|
|
||||||
import { createServer, type IncomingMessage, type ServerResponse } from "node:http";
|
|
||||||
|
|
||||||
import { InfluxDBClient } from "../dist/client.js";
|
|
||||||
import { ApiGrants, MARK, askedFor, marked } from "../dist/grants.js";
|
|
||||||
|
|
||||||
type Rec = Record<string, any>;
|
|
||||||
|
|
||||||
const ADMIN = "operator-token";
|
|
||||||
const orgs = new Map<string, string>([["zurag", "org1"]]);
|
|
||||||
let buckets: Rec[] = [];
|
|
||||||
let auths: Rec[] = [];
|
|
||||||
let calls: string[] = [];
|
|
||||||
let seq = 0;
|
|
||||||
|
|
||||||
function body(req: IncomingMessage): Promise<any> {
|
|
||||||
return new Promise((resolve) => {
|
|
||||||
let raw = "";
|
|
||||||
req.on("data", (c) => (raw += c));
|
|
||||||
req.on("end", () => resolve(raw ? JSON.parse(raw) : undefined));
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function send(res: ServerResponse, status: number, value?: unknown): void {
|
|
||||||
res.writeHead(status, { "Content-Type": "application/json" });
|
|
||||||
res.end(value === undefined ? "" : JSON.stringify(value));
|
|
||||||
}
|
|
||||||
|
|
||||||
const server = createServer(async (req, res) => {
|
|
||||||
const url = new URL(req.url!, "http://fake");
|
|
||||||
const p = url.pathname;
|
|
||||||
calls.push(`${req.method} ${p}`);
|
|
||||||
if (p === "/query") {
|
|
||||||
const basic = (req.headers.authorization ?? "").replace(/^Basic /, "");
|
|
||||||
const [u, pw] = Buffer.from(basic, "base64").toString().split(":");
|
|
||||||
const a = auths.find((x) => x.token === u);
|
|
||||||
if (!a || a.status !== "active" || a.password === undefined || a.password !== pw) {
|
|
||||||
return send(res, 401, { code: "unauthorized", message: "Unauthorized" });
|
|
||||||
}
|
|
||||||
return send(res, 200, { results: [{ statement_id: 0 }] });
|
|
||||||
}
|
|
||||||
if (req.headers.authorization !== `Token ${ADMIN}`) return send(res, 401, { code: "unauthorized" });
|
|
||||||
if (p === "/api/v2/orgs") {
|
|
||||||
const id = orgs.get(url.searchParams.get("org") ?? "");
|
|
||||||
if (!id) return send(res, 404, { code: "not found", message: "organization name not found" });
|
|
||||||
return send(res, 200, { orgs: [{ id, name: url.searchParams.get("org") }] });
|
|
||||||
}
|
|
||||||
if (p === "/api/v2/buckets" && req.method === "GET") {
|
|
||||||
const found = buckets.filter((b) => b.orgID === url.searchParams.get("orgID") && b.name === url.searchParams.get("name"));
|
|
||||||
if (found.length === 0) return send(res, 404, { code: "not found", message: "bucket not found" });
|
|
||||||
return send(res, 200, { buckets: found });
|
|
||||||
}
|
|
||||||
if (p === "/api/v2/buckets" && req.method === "POST") {
|
|
||||||
const b = { ...(await body(req)), id: `b${++seq}` };
|
|
||||||
buckets.push(b);
|
|
||||||
return send(res, 201, b);
|
|
||||||
}
|
|
||||||
if (p === "/private/legacy/authorizations" && req.method === "GET") {
|
|
||||||
const found = auths.filter((a) => a.token === url.searchParams.get("token"));
|
|
||||||
if (found.length === 0) return send(res, 404, { code: "not found", message: "authorization not found" });
|
|
||||||
// Never answers with the password: InfluxDB keeps only its hash.
|
|
||||||
return send(res, 200, { authorizations: found.map(({ password, ...a }) => ({ ...a, links: {} })) });
|
|
||||||
}
|
|
||||||
if (p === "/private/legacy/authorizations" && req.method === "POST") {
|
|
||||||
const a = await body(req);
|
|
||||||
if (auths.some((x) => x.token === a.token)) return send(res, 409, { code: "conflict", message: "token already exists" });
|
|
||||||
const made = { ...a, id: `a${++seq}`, status: a.status ?? "active" };
|
|
||||||
auths.push(made);
|
|
||||||
return send(res, 201, made);
|
|
||||||
}
|
|
||||||
const m = /^\/private\/legacy\/authorizations\/([^/]+)(\/password)?$/.exec(p);
|
|
||||||
const a = m && auths.find((x) => x.id === m[1]);
|
|
||||||
if (!a) return send(res, 404, { code: "not found" });
|
|
||||||
if (m![2] && req.method === "POST") {
|
|
||||||
const { password } = await body(req);
|
|
||||||
if (typeof password !== "string" || password.length < 8 || password.length > 72) {
|
|
||||||
return send(res, 400, { code: "invalid", message: "passwords must be between 8 and 72 characters long" });
|
|
||||||
}
|
|
||||||
a.password = password;
|
|
||||||
return send(res, 204);
|
|
||||||
}
|
|
||||||
if (req.method === "PATCH") {
|
|
||||||
Object.assign(a, await body(req));
|
|
||||||
return send(res, 200, a);
|
|
||||||
}
|
|
||||||
if (req.method === "DELETE") {
|
|
||||||
auths = auths.filter((x) => x !== a);
|
|
||||||
return send(res, 204);
|
|
||||||
}
|
|
||||||
send(res, 405);
|
|
||||||
});
|
|
||||||
await new Promise<void>((r) => server.listen(0, "127.0.0.1", r));
|
|
||||||
after(() => server.close());
|
|
||||||
const port = (server.address() as { port: number }).port;
|
|
||||||
|
|
||||||
const grants = new ApiGrants(new InfluxDBClient(`http://127.0.0.1:${port}`, ADMIN, "zurag"), "zurag");
|
|
||||||
|
|
||||||
const PW = "mesh-minted-password-of-forty-characters";
|
|
||||||
|
|
||||||
/** Grafana on ace, as the mesh hands it to the provisioner. */
|
|
||||||
function grafana(password = PW, values: Record<string, unknown> = { access: "read" }) {
|
|
||||||
return { as: "mesh_ace_grafana", password, consumer: "ace", values };
|
|
||||||
}
|
|
||||||
/** Node-RED on ace: writes one bucket. */
|
|
||||||
function nodered(password = PW, values: Record<string, unknown> = { access: "write", buckets: ["zurag"] }) {
|
|
||||||
return { as: "mesh_ace_nodered", password, consumer: "ace", values };
|
|
||||||
}
|
|
||||||
|
|
||||||
function only(token: string): Rec {
|
|
||||||
const found = auths.filter((a) => a.token === token);
|
|
||||||
assert.equal(found.length, 1, `exactly one authorization ${token}, found ${found.length}`);
|
|
||||||
return found[0];
|
|
||||||
}
|
|
||||||
|
|
||||||
function perms(a: Rec): string[] {
|
|
||||||
return a.permissions.map((p: Rec) => `${p.action}:${p.resource.type}:${p.resource.id ?? "*"}`).sort();
|
|
||||||
}
|
|
||||||
|
|
||||||
beforeEach(() => {
|
|
||||||
buckets = [{ id: "zb", orgID: "org1", name: "zurag" }];
|
|
||||||
auths = [];
|
|
||||||
calls = [];
|
|
||||||
});
|
|
||||||
|
|
||||||
test("what a contribution may ask for, and what is refused", () => {
|
|
||||||
assert.deepEqual(askedFor({}), { access: "read", buckets: [] });
|
|
||||||
assert.deepEqual(askedFor({ access: "read-write", buckets: ["b", "a", "a"] }), { access: "read-write", buckets: ["a", "b"] });
|
|
||||||
assert.throws(() => askedFor({ access: "admin" }), /access/);
|
|
||||||
assert.throws(() => askedFor({ access: "write" }), /names no bucket/);
|
|
||||||
assert.throws(() => askedFor({ buckets: "zurag" }), /list of bucket names/);
|
|
||||||
assert.throws(() => askedFor({ access: "write", buckets: ["_monitoring"] }), /system bucket/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a reader is given one authorization, reading every bucket of the org, under the mesh's password", async () => {
|
|
||||||
assert.equal(await grants.ensure(grafana()), "created");
|
|
||||||
const a = only("mesh_ace_grafana");
|
|
||||||
assert.equal(a.orgID, "org1");
|
|
||||||
assert.equal(a.status, "active");
|
|
||||||
assert.ok(a.description.startsWith(MARK));
|
|
||||||
assert.deepEqual(perms(a), ["read:buckets:*"]);
|
|
||||||
assert.equal(a.password, PW);
|
|
||||||
assert.equal(await grants.holds(grafana()), true);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a writer is allowed its own buckets only, and a missing one is made — never deleted", async () => {
|
|
||||||
assert.equal(await grants.ensure(nodered(PW, { access: "write", buckets: ["zurag", "printer"] })), "created");
|
|
||||||
const made = buckets.find((b) => b.name === "printer");
|
|
||||||
assert.ok(made, "the missing bucket was created");
|
|
||||||
assert.deepEqual(made!.retentionRules, [], "kept for ever: retention is the operator's choice");
|
|
||||||
assert.deepEqual(perms(only("mesh_ace_nodered")), [`write:buckets:${made!.id}`, "write:buckets:zb"]);
|
|
||||||
assert.equal(await grants.remove("mesh_ace_nodered"), "removed");
|
|
||||||
assert.equal(buckets.length, 2, "withdrawing the consumer leaves every bucket and its data");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("applying the same grant again writes nothing", async () => {
|
|
||||||
await grants.ensure(grafana());
|
|
||||||
calls = [];
|
|
||||||
assert.equal(await grants.ensure(grafana()), "unchanged");
|
|
||||||
assert.ok(calls.every((c) => c.startsWith("GET")), `only reads: ${calls.join(", ")}`);
|
|
||||||
only("mesh_ace_grafana");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a rotated password is set in place; a changed access remakes only the mesh's own", async () => {
|
|
||||||
await grants.ensure(nodered());
|
|
||||||
const id = only("mesh_ace_nodered").id;
|
|
||||||
assert.equal(await grants.holds(nodered("rotated-password-0123456789")), false);
|
|
||||||
assert.equal(await grants.ensure(nodered("rotated-password-0123456789")), "updated");
|
|
||||||
assert.equal(only("mesh_ace_nodered").id, id, "updated, not replaced");
|
|
||||||
assert.equal(await grants.holds(nodered("rotated-password-0123456789")), true);
|
|
||||||
|
|
||||||
await grants.ensure(nodered(PW, { access: "read-write", buckets: ["zurag"] }));
|
|
||||||
assert.deepEqual(perms(only("mesh_ace_nodered")), ["read:buckets:zb", "write:buckets:zb"]);
|
|
||||||
assert.equal(await grants.holds(nodered(PW, { access: "read-write", buckets: ["zurag"] })), true);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an authorization disabled, re-passworded or deleted behind the mesh's back is not held, and is made whole", async () => {
|
|
||||||
await grants.ensure(grafana());
|
|
||||||
only("mesh_ace_grafana").status = "inactive";
|
|
||||||
assert.equal(await grants.holds(grafana()), false);
|
|
||||||
assert.equal(await grants.ensure(grafana()), "updated");
|
|
||||||
assert.equal(await grants.holds(grafana()), true);
|
|
||||||
|
|
||||||
only("mesh_ace_grafana").password = "somebody-else-set-this";
|
|
||||||
assert.equal(await grants.holds(grafana()), false);
|
|
||||||
await grants.ensure(grafana());
|
|
||||||
assert.equal(await grants.holds(grafana()), true);
|
|
||||||
|
|
||||||
auths = [];
|
|
||||||
assert.equal(await grants.holds(grafana()), false);
|
|
||||||
assert.equal(await grants.ensure(grafana()), "created");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("holds only reads, and a bucket gone missing is not held rather than made", async () => {
|
|
||||||
await grants.ensure(nodered());
|
|
||||||
buckets = [];
|
|
||||||
calls = [];
|
|
||||||
assert.equal(await grants.holds(nodered()), false);
|
|
||||||
assert.ok(calls.every((c) => c.startsWith("GET")), `only reads: ${calls.join(", ")}`);
|
|
||||||
assert.equal(buckets.length, 0);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an authorization of the same name the mesh did not make is refused, and left exactly as it was", async () => {
|
|
||||||
auths = [{ id: "theirs", token: "mesh_ace_grafana", orgID: "org1", status: "active", description: "hand-made",
|
|
||||||
permissions: [{ action: "write", resource: { type: "buckets", orgID: "org1" } }], password: "their-password" }];
|
|
||||||
const before = JSON.stringify(auths);
|
|
||||||
await assert.rejects(grants.ensure(grafana()), /did not make/);
|
|
||||||
assert.equal(JSON.stringify(auths), before);
|
|
||||||
assert.ok(calls.every((c) => c.startsWith("GET")), `only reads: ${calls.join(", ")}`);
|
|
||||||
assert.equal(await grants.holds(grafana()), false);
|
|
||||||
assert.equal(await grants.remove("mesh_ace_grafana"), "not ours");
|
|
||||||
assert.equal(auths.length, 1, "never deleted");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the predecessor's own v1 users and tokens are never touched", async () => {
|
|
||||||
auths = [{ id: "hal", token: "grafana", orgID: "org1", status: "active", description: "",
|
|
||||||
permissions: [{ action: "read", resource: { type: "buckets", orgID: "org1" } }], password: "old-password" }];
|
|
||||||
await grants.ensure(grafana());
|
|
||||||
assert.equal(auths.find((a) => a.id === "hal")!.password, "old-password");
|
|
||||||
assert.equal(await grants.remove("grafana"), "not ours");
|
|
||||||
assert.equal(marked({ token: "grafana", description: `${MARK} x` }), false, "the mark needs the mesh's name too");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an org the instance does not have, or a non-mesh name, makes nothing", async () => {
|
|
||||||
const elsewhere = new ApiGrants(new InfluxDBClient(`http://127.0.0.1:${port}`, ADMIN, "nope"), "nope");
|
|
||||||
await assert.rejects(elsewhere.ensure(grafana()), /no org "nope"/);
|
|
||||||
await assert.rejects(grants.ensure({ ...grafana(), as: "grafana" }), /not a mesh identity/);
|
|
||||||
assert.equal(auths.length, 0);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a withdrawn consumer's authorization is removed, and an absent one is not an error", async () => {
|
|
||||||
await grants.ensure(grafana());
|
|
||||||
assert.equal(await grants.remove("mesh_ace_grafana"), "removed");
|
|
||||||
assert.equal(auths.length, 0);
|
|
||||||
assert.equal(await grants.remove("mesh_ace_grafana"), "absent");
|
|
||||||
});
|
|
||||||
@@ -8,10 +8,5 @@
|
|||||||
"skipLibCheck": true,
|
"skipLibCheck": true,
|
||||||
"noEmit": true
|
"noEmit": true
|
||||||
},
|
},
|
||||||
"include": [
|
"include": ["client.ts", "tools/index.ts"]
|
||||||
"client.ts",
|
|
||||||
"grants.ts",
|
|
||||||
"provisioner/index.ts",
|
|
||||||
"tools/index.ts"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -26,13 +26,13 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"binds": {
|
"binds": {
|
||||||
"mongodb-database": "${dir:state}/database.json",
|
"mongodb-database": "/var/lib/invoicing/database.json",
|
||||||
"s3-bucket": "${dir:state}/store.json",
|
"s3-bucket": "/var/lib/invoicing/store.json",
|
||||||
"route": "${dir:state}/route.json"
|
"route": "/var/lib/invoicing/route.json"
|
||||||
},
|
},
|
||||||
"secrets": {
|
"secrets": {
|
||||||
"mongodb-database": "${dir:state}/database.secret",
|
"mongodb-database": "/var/lib/invoicing/database.secret",
|
||||||
"s3-bucket": "${dir:state}/store.secret"
|
"s3-bucket": "/var/lib/invoicing/store.secret"
|
||||||
},
|
},
|
||||||
"listens": [
|
"listens": [
|
||||||
{
|
{
|
||||||
@@ -54,19 +54,19 @@
|
|||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/invoicing",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/invoicing",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "api-env",
|
"id": "api-env",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/api.env",
|
"path": "/var/lib/invoicing/api.env",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "NODE_ENV=production\nPORT=9000\nMONGO_URL=mongodb://${bound:mongodb-database:as}:${secret:mongodb-database}@${bound:mongodb-database:at}:${bound:mongodb-database:port}/${bound:mongodb-database:as}?authSource=${bound:mongodb-database:as}\nMONGO_DB=${bound:mongodb-database:as}\nMINIO_BUCKET=mesh-novox-invoice\nMINIO_ENDPOINT=${bound:s3-bucket:at}\nMINIO_PORT=${bound:s3-bucket:port}\nMINIO_ACCESSKEY=${bound:s3-bucket:as}\nMINIO_SECRET=${secret:s3-bucket}\n"
|
"content": "NODE_ENV=production\nPORT=9000\nMONGO_URL=mongodb://${bound:mongodb-database:as}:${secret:mongodb-database}@${bound:mongodb-database:at}:${bound:mongodb-database:port}/${bound:mongodb-database:as}?authSource=${bound:mongodb-database:as}\nMONGO_DB=${bound:mongodb-database:as}\nMINIO_BUCKET=mesh-novox-invoice\nMINIO_ENDPOINT=${bound:s3-bucket:at}\nMINIO_PORT=${bound:s3-bucket:port}\nMINIO_ACCESSKEY=${bound:s3-bucket:as}\nMINIO_SECRET=${secret:s3-bucket}\n"
|
||||||
},
|
},
|
||||||
@@ -87,10 +87,7 @@
|
|||||||
},
|
},
|
||||||
"ports": [
|
"ports": [
|
||||||
"80"
|
"80"
|
||||||
],
|
]
|
||||||
"names-on-purpose": {
|
|
||||||
"registry-api.novox.be": "built outside the mesh, from the application's own repository, and pulled from the registry that built it; moves when that repository is a build source on the git seat (novox/hq ADR 0155, issue 122)"
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "api",
|
"id": "api",
|
||||||
@@ -103,15 +100,12 @@
|
|||||||
"GID": "2201"
|
"GID": "2201"
|
||||||
},
|
},
|
||||||
"env-file": [
|
"env-file": [
|
||||||
"${dir:state}/api.env"
|
"/var/lib/invoicing/api.env"
|
||||||
],
|
],
|
||||||
"ports": [
|
"ports": [
|
||||||
"9000"
|
"9000"
|
||||||
],
|
],
|
||||||
"secrets-in-environment": "the application's own code reads MONGO_URL and MINIO_SECRET from the environment (invoicing-app server/src/config.js); converting is that repository's change",
|
"secrets-in-environment": "the application's own code reads MONGO_URL and MINIO_SECRET from the environment (invoicing-app server/src/config.js); converting is that repository's change"
|
||||||
"names-on-purpose": {
|
|
||||||
"registry-api.novox.be": "built outside the mesh, from the application's own repository, and pulled from the registry that built it; moves when that repository is a build source on the git seat (novox/hq ADR 0155, issue 122)"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,24 @@
|
|||||||
|
# jackett's runtime: the tool runtime, carrying this module's compiled code.
|
||||||
|
#
|
||||||
|
# **Built from this module's own directory and nothing else.** The sdk and the tool runtime are in
|
||||||
|
# the base images, published like any other artifact — which is what makes this buildable by the
|
||||||
|
# mesh from a repository and a path (novox/hq ADR 0069) rather than only on a workstation that
|
||||||
|
# happens to have the siblings.
|
||||||
|
#
|
||||||
|
# Two bases, named rather than pinned (novox/hq issue 044): the image this is COMPILED in and the
|
||||||
|
# image it RUNS in — the second must not carry a compiler. Declared in module.json's `build.on`.
|
||||||
|
ARG BUILD_BASE
|
||||||
|
ARG RUNTIME_BASE
|
||||||
|
|
||||||
|
FROM ${BUILD_BASE} AS build
|
||||||
|
WORKDIR /app/modules/jackett
|
||||||
|
COPY . .
|
||||||
|
RUN node /app/node_modules/typescript/bin/tsc client.ts tools/index.ts \
|
||||||
|
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
||||||
|
|
||||||
|
FROM ${RUNTIME_BASE}
|
||||||
|
COPY --from=build /app/modules/jackett/dist /app/modules/jackett/dist
|
||||||
|
# Every serve-time entrypoint, loaded by the runtime in serve mode: tools and events serve, and a
|
||||||
|
# provider's provisioner runs its reconcile loop in the same process, with the broker connected —
|
||||||
|
# the convention novox/hq issues 060/061 settled.
|
||||||
|
ENV MESH_TOOL_MODULES=/app/modules/jackett/dist/tools/index.js
|
||||||
@@ -0,0 +1,99 @@
|
|||||||
|
// The Jackett API client — jackett's own code, living in the module (novox/hq ADR 0039). Jackett is
|
||||||
|
// an indexer proxy: it normalises many torrent trackers behind one Torznab surface. This client
|
||||||
|
// talks its /api/v2.0 REST API, and only jackett's tools import it.
|
||||||
|
|
||||||
|
import { readFileSync } from "node:fs";
|
||||||
|
|
||||||
|
export interface JackettIndexer {
|
||||||
|
id: string;
|
||||||
|
name: string;
|
||||||
|
type: string; // "public" | "private" | "semi-public"
|
||||||
|
configured: boolean;
|
||||||
|
siteLink?: string;
|
||||||
|
lastError?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface JackettResult {
|
||||||
|
title: string;
|
||||||
|
tracker: string;
|
||||||
|
category?: string;
|
||||||
|
size: number;
|
||||||
|
seeders?: number;
|
||||||
|
peers?: number;
|
||||||
|
publishDate?: string;
|
||||||
|
link?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The settings-merged config the mesh delivers (novox/hq ADR 0046): { url, apiKey, token, password, user, ... }. */
|
||||||
|
function meshConfig(file?: string): Record<string, string> {
|
||||||
|
if (!file) return {};
|
||||||
|
try { return JSON.parse(readFileSync(file, "utf8")) as Record<string, string>; }
|
||||||
|
catch { return {}; }
|
||||||
|
}
|
||||||
|
|
||||||
|
export class JackettClient {
|
||||||
|
readonly baseUrl: string;
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
url: string,
|
||||||
|
private readonly apiKey: string,
|
||||||
|
) {
|
||||||
|
this.baseUrl = url.replace(/\/$/, "");
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build from the module's resolved environment. Jackett's REST API is keyed, so both the URL and
|
||||||
|
* the key must be present — without them there is nothing to talk to, so this throws and the
|
||||||
|
* module contributes no tools rather than failing half-configured.
|
||||||
|
*/
|
||||||
|
static fromEnv(env: NodeJS.ProcessEnv = process.env): JackettClient {
|
||||||
|
const cfg = meshConfig(env.MESH_JACKETT_CONFIG_FILE);
|
||||||
|
const url = cfg.url ?? env.MESH_JACKETT_URL;
|
||||||
|
const apiKey = cfg.apiKey ?? env.MESH_JACKETT_API_KEY;
|
||||||
|
if (!url) throw new Error("no Jackett URL — set MESH_JACKETT_URL");
|
||||||
|
if (!apiKey) throw new Error("no Jackett API key — set MESH_JACKETT_API_KEY");
|
||||||
|
return new JackettClient(url, apiKey);
|
||||||
|
}
|
||||||
|
|
||||||
|
private async get(path: string, params: Record<string, string> = {}): Promise<any> {
|
||||||
|
const url = new URL(`${this.baseUrl}${path}`);
|
||||||
|
url.searchParams.set("apikey", this.apiKey);
|
||||||
|
for (const [k, v] of Object.entries(params)) url.searchParams.set(k, v);
|
||||||
|
const res = await fetch(url.toString(), { headers: { Accept: "application/json" } });
|
||||||
|
if (!res.ok) throw new Error(`Jackett API ${path}: ${res.status} ${await res.text()}`);
|
||||||
|
return res.json();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The configured indexers Jackett proxies. `configured=false` also lists the ones not set up. */
|
||||||
|
async getIndexers(configuredOnly = true): Promise<JackettIndexer[]> {
|
||||||
|
const raw = await this.get("/api/v2.0/indexers", { configured: configuredOnly ? "true" : "false" });
|
||||||
|
const list = Array.isArray(raw) ? raw : [];
|
||||||
|
return list.map((i: any) => ({
|
||||||
|
id: i.id,
|
||||||
|
name: i.name,
|
||||||
|
type: i.type,
|
||||||
|
configured: i.configured ?? false,
|
||||||
|
siteLink: i.site_link,
|
||||||
|
lastError: i.last_error || undefined,
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A Torznab search across one indexer, or the "all" aggregate. Jackett returns a normalised JSON
|
||||||
|
* result set regardless of the underlying tracker, which is the whole point of the proxy.
|
||||||
|
*/
|
||||||
|
async search(query: string, indexer = "all", limit = 25): Promise<JackettResult[]> {
|
||||||
|
const raw = await this.get(`/api/v2.0/indexers/${encodeURIComponent(indexer)}/results`, { Query: query });
|
||||||
|
const results = Array.isArray(raw?.Results) ? raw.Results : [];
|
||||||
|
return results.slice(0, limit).map((r: any) => ({
|
||||||
|
title: r.Title,
|
||||||
|
tracker: r.Tracker ?? r.TrackerId ?? "unknown",
|
||||||
|
category: Array.isArray(r.CategoryDesc) ? r.CategoryDesc.join(", ") : r.CategoryDesc,
|
||||||
|
size: r.Size ?? 0,
|
||||||
|
seeders: r.Seeders,
|
||||||
|
peers: r.Peers,
|
||||||
|
publishDate: r.PublishDate,
|
||||||
|
link: r.Link ?? r.Details,
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,113 @@
|
|||||||
|
{
|
||||||
|
"module": "jackett",
|
||||||
|
"version": "1",
|
||||||
|
"capabilities": [
|
||||||
|
"container-runtime"
|
||||||
|
],
|
||||||
|
"listens": [
|
||||||
|
{
|
||||||
|
"name": "web",
|
||||||
|
"port": 9117,
|
||||||
|
"protocol": "tcp",
|
||||||
|
"from": "mesh",
|
||||||
|
"why": "the indexer proxy"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"resources": [
|
||||||
|
{
|
||||||
|
"id": "mesh-state",
|
||||||
|
"type": "directory",
|
||||||
|
"path": "/var/lib/mesh/jackett",
|
||||||
|
"mode": "0700"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "config",
|
||||||
|
"type": "directory",
|
||||||
|
"path": "/services/jackett/config",
|
||||||
|
"mode": "0700",
|
||||||
|
"owner": "1000:1000"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "server",
|
||||||
|
"type": "container",
|
||||||
|
"name": "jackett",
|
||||||
|
"image": "lscr.io/linuxserver/jackett@sha256:fd72d42b731ebf750b5de9711127251cf3b3f609419c32083ea8b3b3ee840b77",
|
||||||
|
"env": {
|
||||||
|
"PUID": "1000",
|
||||||
|
"PGID": "1000",
|
||||||
|
"TZ": "Etc/UTC"
|
||||||
|
},
|
||||||
|
"ports": [
|
||||||
|
"9117"
|
||||||
|
],
|
||||||
|
"volumes": [
|
||||||
|
"/services/jackett/config:/config"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "runtime-config",
|
||||||
|
"type": "file",
|
||||||
|
"path": "/var/lib/mesh/jackett/config.json",
|
||||||
|
"mode": "0600",
|
||||||
|
"content": "{}\n",
|
||||||
|
"merge": "json"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "runtime",
|
||||||
|
"type": "container",
|
||||||
|
"name": "mesh-jackett",
|
||||||
|
"network": "host",
|
||||||
|
"volumes": [
|
||||||
|
"/var/lib/mesh/jackett/broker:/run/secrets/broker:ro",
|
||||||
|
"/var/lib/mesh/jackett/config.json:/run/config/config.json:ro",
|
||||||
|
"/services/jackett/config:/var/lib/jackett/config:ro"
|
||||||
|
],
|
||||||
|
"env": {
|
||||||
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
|
"MESH_JACKETT_URL": "http://127.0.0.1:9117",
|
||||||
|
"MESH_JACKETT_CONFIG_FILE": "/run/config/config.json",
|
||||||
|
"MESH_JACKETT_CONFIG_DIR": "/var/lib/jackett/config"
|
||||||
|
},
|
||||||
|
"restart-on": [
|
||||||
|
"runtime-config"
|
||||||
|
],
|
||||||
|
"artifact": "runtime"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"own-secrets": {
|
||||||
|
"broker": "/var/lib/mesh/jackett/broker"
|
||||||
|
},
|
||||||
|
"requires": [
|
||||||
|
"route"
|
||||||
|
],
|
||||||
|
"contributes": {
|
||||||
|
"route": {
|
||||||
|
"label": "indexers",
|
||||||
|
"endpoint": "web"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"binds": {
|
||||||
|
"route": "/var/lib/mesh/jackett/route.json"
|
||||||
|
},
|
||||||
|
"build": {
|
||||||
|
"on": [
|
||||||
|
{
|
||||||
|
"arg": "BUILD_BASE",
|
||||||
|
"module": "mesh-tools",
|
||||||
|
"artifact": "build"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"arg": "RUNTIME_BASE",
|
||||||
|
"module": "mesh-tools",
|
||||||
|
"artifact": "runtime"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"artifacts": [
|
||||||
|
{
|
||||||
|
"name": "runtime",
|
||||||
|
"kind": "image",
|
||||||
|
"from": "Dockerfile"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
{
|
||||||
|
"name": "@novox/module-jackett",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "jackett — indexer proxy. Its API client and tools live here (novox/hq ADR 0039).",
|
||||||
|
"type": "module",
|
||||||
|
"private": true,
|
||||||
|
"dependencies": {
|
||||||
|
"@novox/mesh-sdk": "^0.1.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/node": "^22.0.0",
|
||||||
|
"typescript": "^5.6.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
// jackett's tools — its own code (novox/hq ADR 0039), importing jackett's client. Jackett has
|
||||||
|
// nothing worth watching (an indexer proxy answers queries; it has no timeline of its own), so it
|
||||||
|
// is a tools-only module: no events entrypoint, no broker. What is useful is asking it things.
|
||||||
|
|
||||||
|
import { registerModuleTools, type ToolDefinition } from "@novox/mesh-sdk/tools";
|
||||||
|
import { JackettClient } from "../client.js";
|
||||||
|
|
||||||
|
export function getJackettTools(jackett: JackettClient): ToolDefinition[] {
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
name: "jackett_indexers",
|
||||||
|
description: "List the indexers Jackett proxies, with their type and any last error.",
|
||||||
|
input: { all: { type: "boolean", description: "include indexers not yet configured (default false)" } },
|
||||||
|
run: async (args) => {
|
||||||
|
const indexers = await jackett.getIndexers(!args.all);
|
||||||
|
return { count: indexers.length, indexers };
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "jackett_search",
|
||||||
|
description: "Torznab search across Jackett's indexers, returning normalised torrent results.",
|
||||||
|
input: {
|
||||||
|
query: { type: "string", description: "the search query" },
|
||||||
|
indexer: { type: "string", description: 'an indexer id, or "all" to aggregate (default "all")' },
|
||||||
|
limit: { type: "number", description: "max results (default 25)" },
|
||||||
|
},
|
||||||
|
run: async (args) => {
|
||||||
|
const query = String(args.query);
|
||||||
|
const results = await jackett.search(
|
||||||
|
query,
|
||||||
|
args.indexer ? String(args.indexer) : "all",
|
||||||
|
args.limit ? Number(args.limit) : 25,
|
||||||
|
);
|
||||||
|
return { query, count: results.length, results };
|
||||||
|
},
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
// Only exposed when Jackett is configured; otherwise jackett contributes no tools rather than
|
||||||
|
// failing the whole runtime.
|
||||||
|
registerModuleTools("jackett", (env) => {
|
||||||
|
try {
|
||||||
|
return getJackettTools(JackettClient.fromEnv(env));
|
||||||
|
} catch {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
});
|
||||||
@@ -8,5 +8,5 @@
|
|||||||
"skipLibCheck": true,
|
"skipLibCheck": true,
|
||||||
"noEmit": true
|
"noEmit": true
|
||||||
},
|
},
|
||||||
"include": ["tools/index.ts", "tools/runs.ts"]
|
"include": ["client.ts", "tools/index.ts"]
|
||||||
}
|
}
|
||||||
+10
-10
@@ -2,26 +2,26 @@
|
|||||||
"module": "jira",
|
"module": "jira",
|
||||||
"version": "1",
|
"version": "1",
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"token": "${dir:state}/token",
|
"token": "/var/lib/jira/token",
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/jira/broker"
|
||||||
},
|
},
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/jira",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/jira",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "config",
|
"id": "config",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/config.json",
|
"path": "/var/lib/jira/config.json",
|
||||||
"merge": "json",
|
"merge": "json",
|
||||||
"content": "{}",
|
"content": "{}",
|
||||||
"mode": "0600"
|
"mode": "0600"
|
||||||
@@ -32,9 +32,9 @@
|
|||||||
"name": "mesh-runtime-jira",
|
"name": "mesh-runtime-jira",
|
||||||
"network": "host",
|
"network": "host",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:state}/config.json:/run/config/config.json:ro",
|
"/var/lib/jira/config.json:/run/config/config.json:ro",
|
||||||
"${dir:state}/token:/run/secrets/token:ro",
|
"/var/lib/jira/token:/run/secrets/token:ro",
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro"
|
"/var/lib/mesh/jira/broker:/run/secrets/broker:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_JIRA_TOKEN_FILE": "/run/secrets/token",
|
"MESH_JIRA_TOKEN_FILE": "/run/secrets/token",
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ FROM ${BUILD_BASE} AS build
|
|||||||
# resolved away.
|
# resolved away.
|
||||||
WORKDIR /app/modules/keycloak
|
WORKDIR /app/modules/keycloak
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN node /app/node_modules/typescript/bin/tsc client.ts oidc.ts index.ts provisioner/index.ts tools/index.ts \
|
RUN node /app/node_modules/typescript/bin/tsc client.ts index.ts tools/index.ts \
|
||||||
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
||||||
|
|
||||||
FROM ${RUNTIME_BASE}
|
FROM ${RUNTIME_BASE}
|
||||||
@@ -27,4 +27,4 @@ COPY --from=build /app/modules/keycloak/dist /app/modules/keycloak/dist
|
|||||||
# the convention novox/hq issues 060/061 settled. A container that instead ran only its
|
# the convention novox/hq issues 060/061 settled. A container that instead ran only its
|
||||||
# provisioner (`run`) served no tools and emitted no events; a container that named no command
|
# provisioner (`run`) served no tools and emitted no events; a container that named no command
|
||||||
# ran no provisioner at all.
|
# ran no provisioner at all.
|
||||||
ENV MESH_TOOL_MODULES=/app/modules/keycloak/dist/index.js,/app/modules/keycloak/dist/tools/index.js,/app/modules/keycloak/dist/provisioner/index.js
|
ENV MESH_TOOL_MODULES=/app/modules/keycloak/dist/index.js,/app/modules/keycloak/dist/tools/index.js
|
||||||
|
|||||||
@@ -12,45 +12,6 @@ function meshConfig(file?: string): Record<string, string> {
|
|||||||
catch { return {}; }
|
catch { return {}; }
|
||||||
}
|
}
|
||||||
|
|
||||||
/** A secret file's value, trailing newline trimmed; undefined when unset or unreadable. */
|
|
||||||
function secretFile(file?: string): string | undefined {
|
|
||||||
if (!file) return undefined;
|
|
||||||
try { return readFileSync(file, "utf8").replace(/\n$/, "") || undefined; }
|
|
||||||
catch { return undefined; }
|
|
||||||
}
|
|
||||||
|
|
||||||
/** A client as the admin API represents it — only the fields this module reads or writes are typed;
|
|
||||||
* the rest travel through untouched, so an update never drops what somebody else set. */
|
|
||||||
export interface ClientRepresentation {
|
|
||||||
id?: string;
|
|
||||||
clientId: string;
|
|
||||||
name?: string;
|
|
||||||
enabled?: boolean;
|
|
||||||
protocol?: string;
|
|
||||||
publicClient?: boolean;
|
|
||||||
clientAuthenticatorType?: string;
|
|
||||||
secret?: string;
|
|
||||||
rootUrl?: string;
|
|
||||||
baseUrl?: string;
|
|
||||||
redirectUris?: string[];
|
|
||||||
webOrigins?: string[];
|
|
||||||
standardFlowEnabled?: boolean;
|
|
||||||
implicitFlowEnabled?: boolean;
|
|
||||||
directAccessGrantsEnabled?: boolean;
|
|
||||||
serviceAccountsEnabled?: boolean;
|
|
||||||
attributes?: Record<string, string>;
|
|
||||||
protocolMappers?: ProtocolMapperRepresentation[];
|
|
||||||
[other: string]: unknown;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ProtocolMapperRepresentation {
|
|
||||||
id?: string;
|
|
||||||
name: string;
|
|
||||||
protocol: string;
|
|
||||||
protocolMapper: string;
|
|
||||||
config: Record<string, string>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export class KeycloakClient {
|
export class KeycloakClient {
|
||||||
readonly baseUrl: string;
|
readonly baseUrl: string;
|
||||||
readonly defaultRealm: string;
|
readonly defaultRealm: string;
|
||||||
@@ -79,13 +40,8 @@ export class KeycloakClient {
|
|||||||
const cfg = meshConfig(env.MESH_KEYCLOAK_CONFIG_FILE);
|
const cfg = meshConfig(env.MESH_KEYCLOAK_CONFIG_FILE);
|
||||||
const url = cfg.url ?? env.MESH_KEYCLOAK_URL ?? `http://127.0.0.1:${env.KEYCLOAK_PORT ?? "8080"}`;
|
const url = cfg.url ?? env.MESH_KEYCLOAK_URL ?? `http://127.0.0.1:${env.KEYCLOAK_PORT ?? "8080"}`;
|
||||||
const adminUser = cfg.user ?? env.MESH_KEYCLOAK_ADMIN ?? env.KEYCLOAK_ADMIN ?? "admin";
|
const adminUser = cfg.user ?? env.MESH_KEYCLOAK_ADMIN ?? env.KEYCLOAK_ADMIN ?? "admin";
|
||||||
// The admin password reaches the runtime as a file (novox/hq ADR 0086): the module's own `admin`
|
const adminPass = cfg.password ?? env.MESH_KEYCLOAK_PASSWORD ?? env.KEYCLOAK_ADMIN_PASSWORD;
|
||||||
// secret, mounted read-only. The environment forms stay for a co-located server that has them.
|
if (!adminPass) throw new Error("no Keycloak admin password — set MESH_KEYCLOAK_PASSWORD");
|
||||||
const adminPass = cfg.password ?? secretFile(env.MESH_KEYCLOAK_PASSWORD_FILE)
|
|
||||||
?? env.MESH_KEYCLOAK_PASSWORD ?? env.KEYCLOAK_ADMIN_PASSWORD;
|
|
||||||
if (!adminPass) {
|
|
||||||
throw new Error("no Keycloak admin password — set MESH_KEYCLOAK_PASSWORD_FILE (or MESH_KEYCLOAK_PASSWORD)");
|
|
||||||
}
|
|
||||||
const realm = cfg.realm ?? env.MESH_KEYCLOAK_REALM ?? "master";
|
const realm = cfg.realm ?? env.MESH_KEYCLOAK_REALM ?? "master";
|
||||||
return new KeycloakClient(url, adminUser, adminPass, realm);
|
return new KeycloakClient(url, adminUser, adminPass, realm);
|
||||||
}
|
}
|
||||||
@@ -203,50 +159,6 @@ export class KeycloakClient {
|
|||||||
return client.id as string;
|
return client.id as string;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** The one client with exactly this clientId, or undefined. The admin API's `clientId` filter is an
|
|
||||||
* exact match unless `search=true` is asked for. */
|
|
||||||
async findClient(realm: string, clientId: string): Promise<ClientRepresentation | undefined> {
|
|
||||||
const found = await this.request<ClientRepresentation[]>(
|
|
||||||
`/${realm}/clients?clientId=${encodeURIComponent(clientId)}`);
|
|
||||||
return found.find((c) => c.clientId === clientId);
|
|
||||||
}
|
|
||||||
|
|
||||||
async createClientFrom(realm: string, rep: ClientRepresentation): Promise<void> {
|
|
||||||
await this.request(`/${realm}/clients`, { method: "POST", body: JSON.stringify(rep) });
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Replace a client's representation, addressed by its internal id. */
|
|
||||||
async updateClient(realm: string, id: string, rep: ClientRepresentation): Promise<void> {
|
|
||||||
await this.request(`/${realm}/clients/${id}`, { method: "PUT", body: JSON.stringify(rep) });
|
|
||||||
}
|
|
||||||
|
|
||||||
async deleteClientById(realm: string, id: string): Promise<void> {
|
|
||||||
await this.request(`/${realm}/clients/${id}`, { method: "DELETE" });
|
|
||||||
}
|
|
||||||
|
|
||||||
async clientSecretById(realm: string, id: string): Promise<string | undefined> {
|
|
||||||
const result = await this.request<{ value?: string }>(`/${realm}/clients/${id}/client-secret`);
|
|
||||||
return result.value;
|
|
||||||
}
|
|
||||||
|
|
||||||
async listClientMappers(realm: string, id: string): Promise<ProtocolMapperRepresentation[]> {
|
|
||||||
return this.request(`/${realm}/clients/${id}/protocol-mappers/models`);
|
|
||||||
}
|
|
||||||
|
|
||||||
async addClientMapper(realm: string, id: string, mapper: ProtocolMapperRepresentation): Promise<void> {
|
|
||||||
await this.request(`/${realm}/clients/${id}/protocol-mappers/models`, {
|
|
||||||
method: "POST",
|
|
||||||
body: JSON.stringify(mapper),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
async updateClientMapper(realm: string, id: string, mapper: ProtocolMapperRepresentation): Promise<void> {
|
|
||||||
await this.request(`/${realm}/clients/${id}/protocol-mappers/models/${mapper.id}`, {
|
|
||||||
method: "PUT",
|
|
||||||
body: JSON.stringify(mapper),
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
async deleteClient(realm: string, clientId: string): Promise<void> {
|
async deleteClient(realm: string, clientId: string): Promise<void> {
|
||||||
await this.request(`/${realm}/clients/${await this.resolveClientId(realm, clientId)}`, { method: "DELETE" });
|
await this.request(`/${realm}/clients/${await this.resolveClientId(realm, clientId)}`, { method: "DELETE" });
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,12 +1,6 @@
|
|||||||
{
|
{
|
||||||
"module": "keycloak",
|
"module": "keycloak",
|
||||||
"version": "1",
|
"version": "1",
|
||||||
"provides": [
|
|
||||||
{
|
|
||||||
"name": "oidc-client",
|
|
||||||
"scope": "mesh"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requires": [
|
"requires": [
|
||||||
"postgres-database",
|
"postgres-database",
|
||||||
"route"
|
"route"
|
||||||
@@ -21,11 +15,11 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"binds": {
|
"binds": {
|
||||||
"postgres-database": "${dir:state}/database.json",
|
"postgres-database": "/var/lib/keycloak/database.json",
|
||||||
"route": "${dir:state}/route.json"
|
"route": "/var/lib/keycloak/route.json"
|
||||||
},
|
},
|
||||||
"secrets": {
|
"secrets": {
|
||||||
"postgres-database": "${dir:state}/database.secret"
|
"postgres-database": "/var/lib/keycloak/database.secret"
|
||||||
},
|
},
|
||||||
"capabilities": [
|
"capabilities": [
|
||||||
"container-runtime"
|
"container-runtime"
|
||||||
@@ -47,53 +41,34 @@
|
|||||||
"why": "anything the mesh runs that authenticates a person"
|
"why": "anything the mesh runs that authenticates a person"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"serves": {
|
|
||||||
"oidc-client": {
|
|
||||||
"authorization-path": "/protocol/openid-connect/auth",
|
|
||||||
"token-path": "/protocol/openid-connect/token",
|
|
||||||
"userinfo-path": "/protocol/openid-connect/userinfo",
|
|
||||||
"issuer": "${setting:issuer}"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"receives": {
|
|
||||||
"oidc-client": "${dir:grants}/mesh.json"
|
|
||||||
},
|
|
||||||
"grants": {
|
|
||||||
"oidc-client": "${dir:grants}"
|
|
||||||
},
|
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"admin": "${dir:state}/admin.secret",
|
"admin": "/var/lib/keycloak/admin.secret",
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/keycloak/broker"
|
||||||
},
|
},
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/keycloak",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/keycloak",
|
||||||
"place": "."
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "grants",
|
|
||||||
"type": "directory",
|
|
||||||
"mode": "0700"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "admin-env",
|
"id": "admin-env",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/admin.env",
|
"path": "/var/lib/keycloak/admin.env",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "KEYCLOAK_ADMIN=admin\nKEYCLOAK_ADMIN_PASSWORD=${secret:admin}\n"
|
"content": "KEYCLOAK_ADMIN=admin\nKEYCLOAK_ADMIN_PASSWORD=${secret:admin}\n"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "database-env",
|
"id": "database-env",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/database.env",
|
"path": "/var/lib/keycloak/database.env",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "KC_DB_URL=jdbc:postgresql://${bound:postgres-database:at}:${bound:postgres-database:port}/${bound:postgres-database:as}\nKC_DB_USERNAME=${bound:postgres-database:as}\nKC_DB_PASSWORD=${secret:postgres-database}\n"
|
"content": "KC_DB_URL=jdbc:postgresql://${bound:postgres-database:at}:${bound:postgres-database:port}/${bound:postgres-database:as}\nKC_DB_USERNAME=${bound:postgres-database:as}\nKC_DB_PASSWORD=${secret:postgres-database}\n"
|
||||||
},
|
},
|
||||||
@@ -102,13 +77,6 @@
|
|||||||
"type": "network",
|
"type": "network",
|
||||||
"name": "keycloak"
|
"name": "keycloak"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"id": "hostname",
|
|
||||||
"type": "file",
|
|
||||||
"path": "${dir:state}/hostname.env",
|
|
||||||
"mode": "0644",
|
|
||||||
"content": "KC_HOSTNAME=https://${bound:route:name}\n"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"id": "server",
|
"id": "server",
|
||||||
"type": "container",
|
"type": "container",
|
||||||
@@ -122,25 +90,22 @@
|
|||||||
"KC_DB": "postgres",
|
"KC_DB": "postgres",
|
||||||
"KC_HTTP_ENABLED": "true",
|
"KC_HTTP_ENABLED": "true",
|
||||||
"KC_HEALTH_ENABLED": "true",
|
"KC_HEALTH_ENABLED": "true",
|
||||||
|
"KC_HOSTNAME": "https://keycloak.novox.be",
|
||||||
"KC_PROXY_HEADERS": "xforwarded"
|
"KC_PROXY_HEADERS": "xforwarded"
|
||||||
},
|
},
|
||||||
"env-file": [
|
"env-file": [
|
||||||
"${dir:state}/admin.env",
|
"/var/lib/keycloak/admin.env",
|
||||||
"${dir:state}/database.env",
|
"/var/lib/keycloak/database.env"
|
||||||
"${dir:state}/hostname.env"
|
|
||||||
],
|
],
|
||||||
"ports": [
|
"ports": [
|
||||||
"8080"
|
"8080"
|
||||||
],
|
],
|
||||||
"secrets-in-environment": "KC_DB_PASSWORD is convertible through a generated keycloak.conf (db-password=); KEYCLOAK_ADMIN_PASSWORD is env-only before Keycloak 26; not yet converted",
|
"secrets-in-environment": "KC_DB_PASSWORD is convertible through a generated keycloak.conf (db-password=); KEYCLOAK_ADMIN_PASSWORD is env-only before Keycloak 26; not yet converted"
|
||||||
"restart-on": [
|
|
||||||
"hostname"
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "runtime-config",
|
"id": "runtime-config",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:mesh-state}/config.json",
|
"path": "/var/lib/mesh/keycloak/config.json",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "{}\n",
|
"content": "{}\n",
|
||||||
"merge": "json"
|
"merge": "json"
|
||||||
@@ -151,17 +116,13 @@
|
|||||||
"name": "mesh-keycloak",
|
"name": "mesh-keycloak",
|
||||||
"network": "host",
|
"network": "host",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/keycloak/broker:/run/secrets/broker:ro",
|
||||||
"${dir:mesh-state}/config.json:/run/config/config.json:ro",
|
"/var/lib/mesh/keycloak/config.json:/run/config/config.json:ro"
|
||||||
"${dir:state}/admin.secret:/run/secrets/admin:ro",
|
|
||||||
"${dir:grants}:${dir:grants}:ro"
|
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_KEYCLOAK_URL": "http://127.0.0.1:${port:8080}",
|
"MESH_KEYCLOAK_URL": "http://127.0.0.1:${port:8080}",
|
||||||
"MESH_KEYCLOAK_CONFIG_FILE": "/run/config/config.json",
|
"MESH_KEYCLOAK_CONFIG_FILE": "/run/config/config.json"
|
||||||
"MESH_KEYCLOAK_PASSWORD_FILE": "/run/secrets/admin",
|
|
||||||
"MESH_RECEIVES": "${dir:grants}/mesh.json"
|
|
||||||
},
|
},
|
||||||
"restart-on": [
|
"restart-on": [
|
||||||
"runtime-config"
|
"runtime-config"
|
||||||
|
|||||||
@@ -1,185 +0,0 @@
|
|||||||
// What the `oidc-client` provision means in Keycloak: one confidential OpenID Connect client per
|
|
||||||
// consumer, in the realm this module serves, under the name and secret the mesh gave both ends.
|
|
||||||
// The provisioner (provisioner/index.ts) is the sdk harness calling these; they are here, apart from
|
|
||||||
// it, so they can be exercised against a fake admin API without a broker or a contributions file.
|
|
||||||
//
|
|
||||||
// **The client id and the secret are the mesh's, not Keycloak's (novox/hq ADR 0048).** The mesh
|
|
||||||
// derives the consumer's identity (`as`, e.g. `mesh_ace_grafana`) and hands it to both ends — the
|
|
||||||
// consumer names it as its client id through `${bound:oidc-client:as}` — and mints the secret, which
|
|
||||||
// this sets as the client's secret. Keycloak generates neither.
|
|
||||||
//
|
|
||||||
// **Where the consumer's browser comes back to is the consumer's to say.** Its contribution carries
|
|
||||||
// `callback` (a path, e.g. `/login/generic_oauth`) and the `label`/`endpoint` of the endpoint it is
|
|
||||||
// reached on; the mesh composes that endpoint's names into `name` (public) and `internal-name`
|
|
||||||
// (private network) exactly as it does for a route (novox/hq ADR 0056, 0138), so the redirect URI
|
|
||||||
// registered here is built from the same names the proxy serves the consumer under.
|
|
||||||
//
|
|
||||||
// **Only what the mesh made is touched.** A client this module creates carries the attribute
|
|
||||||
// `mesh.provisioned=true`, and its id starts with the mesh's own prefix. A client with the same id
|
|
||||||
// that lacks the mark is somebody else's: it is refused, never adopted, never updated, never deleted.
|
|
||||||
|
|
||||||
import type { ClientRepresentation, KeycloakClient, ProtocolMapperRepresentation } from "./client.js";
|
|
||||||
|
|
||||||
/** The attribute marking a client as the mesh's own work. */
|
|
||||||
export const MARK = "mesh.provisioned";
|
|
||||||
|
|
||||||
/** The mapper every mesh client carries: realm roles as a flat `roles` claim in the id token, the
|
|
||||||
* access token and userinfo — what a consumer maps its own roles from (grafana's role path reads
|
|
||||||
* `roles[*]`), and what the predecessor added to its hand-made clients by hand. */
|
|
||||||
export const ROLES_MAPPER: ProtocolMapperRepresentation = {
|
|
||||||
name: "realm roles",
|
|
||||||
protocol: "openid-connect",
|
|
||||||
protocolMapper: "oidc-usermodel-realm-role-mapper",
|
|
||||||
config: {
|
|
||||||
"claim.name": "roles",
|
|
||||||
"jsonType.label": "String",
|
|
||||||
multivalued: "true",
|
|
||||||
"id.token.claim": "true",
|
|
||||||
"access.token.claim": "true",
|
|
||||||
"userinfo.token.claim": "true",
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
/** One consumer, as the harness hands it over. */
|
|
||||||
export interface OidcGrant {
|
|
||||||
readonly as: string;
|
|
||||||
readonly password: string;
|
|
||||||
readonly values: Readonly<Record<string, unknown>>;
|
|
||||||
readonly consumer?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The realm named by an issuer URL — `https://id.example/realms/Novox` is realm `Novox`. The issuer is
|
|
||||||
* the one value an assignment sets (it is also what consumers are served), so the realm is read
|
|
||||||
* out of it rather than set a second time where the two could disagree. */
|
|
||||||
export function realmOf(issuer: string): string {
|
|
||||||
let path: string;
|
|
||||||
try {
|
|
||||||
path = new URL(issuer).pathname;
|
|
||||||
} catch {
|
|
||||||
throw new Error(`the issuer ${JSON.stringify(issuer)} is not a URL`);
|
|
||||||
}
|
|
||||||
const m = /\/realms\/([^/]+)\/?$/.exec(path);
|
|
||||||
if (!m) throw new Error(`the issuer ${JSON.stringify(issuer)} does not end in /realms/<realm>`);
|
|
||||||
return decodeURIComponent(m[1]);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The redirect URIs a consumer's contribution asks for: its callback under each name the mesh
|
|
||||||
* composed for its endpoint. Refused when there is nothing to register — a client that accepts no
|
|
||||||
* redirect is a client nobody can log in through, and one that accepts any is worse. */
|
|
||||||
export function redirectsOf(values: Readonly<Record<string, unknown>>): { root: string; redirects: string[] } {
|
|
||||||
const callback = values.callback;
|
|
||||||
if (typeof callback !== "string" || !callback.startsWith("/")) {
|
|
||||||
throw new Error(`contributes no callback path (\`callback\`, starting with "/"): ${JSON.stringify(callback)}`);
|
|
||||||
}
|
|
||||||
const names: string[] = [];
|
|
||||||
for (const key of ["name", "internal-name"]) {
|
|
||||||
const n = values[key];
|
|
||||||
if (typeof n === "string" && n.trim() !== "" && !names.includes(n.trim())) names.push(n.trim());
|
|
||||||
}
|
|
||||||
if (names.length === 0) {
|
|
||||||
throw new Error("has no name the mesh composed (`name` / `internal-name`) — contribute a `label` and the `endpoint` it is reached on");
|
|
||||||
}
|
|
||||||
return { root: `https://${names[0]}`, redirects: names.map((n) => `https://${n}${callback}`) };
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The fields the mesh owns on a client it made. Everything else on the client is left as found. */
|
|
||||||
function wanted(g: OidcGrant): ClientRepresentation {
|
|
||||||
const { root, redirects } = redirectsOf(g.values);
|
|
||||||
return {
|
|
||||||
clientId: g.as,
|
|
||||||
name: g.as,
|
|
||||||
description: `made by the mesh for ${g.consumer ? `a module on ${g.consumer}` : "a consumer"} — do not edit; it is reset`,
|
|
||||||
enabled: true,
|
|
||||||
protocol: "openid-connect",
|
|
||||||
publicClient: false,
|
|
||||||
clientAuthenticatorType: "client-secret",
|
|
||||||
secret: g.password,
|
|
||||||
rootUrl: root,
|
|
||||||
baseUrl: root,
|
|
||||||
redirectUris: redirects,
|
|
||||||
standardFlowEnabled: true,
|
|
||||||
implicitFlowEnabled: false,
|
|
||||||
directAccessGrantsEnabled: false,
|
|
||||||
serviceAccountsEnabled: false,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
function sameSet(a: readonly string[] | undefined, b: readonly string[]): boolean {
|
|
||||||
const x = [...(a ?? [])].sort();
|
|
||||||
const y = [...b].sort();
|
|
||||||
return x.length === y.length && x.every((v, i) => v === y[i]);
|
|
||||||
}
|
|
||||||
|
|
||||||
function marked(c: ClientRepresentation): boolean {
|
|
||||||
return c.attributes?.[MARK] === "true";
|
|
||||||
}
|
|
||||||
|
|
||||||
export class OidcClients {
|
|
||||||
constructor(private readonly kc: KeycloakClient, readonly realm: string) {}
|
|
||||||
|
|
||||||
/** Create the consumer's client, or bring the mesh's existing one back to what the grant says.
|
|
||||||
* Returns whether it was newly created. Idempotent: applying the same grant twice changes nothing
|
|
||||||
* the second time beyond re-asserting it. */
|
|
||||||
async ensure(g: OidcGrant): Promise<"created" | "updated"> {
|
|
||||||
const want = wanted(g);
|
|
||||||
const found = await this.kc.findClient(this.realm, g.as);
|
|
||||||
if (found && !marked(found)) {
|
|
||||||
throw new Error(
|
|
||||||
`realm ${this.realm} already has a client ${g.as} the mesh did not make — left alone; ` +
|
|
||||||
`delete or rename it if the mesh should own that id`);
|
|
||||||
}
|
|
||||||
if (!found) {
|
|
||||||
await this.kc.createClientFrom(this.realm, {
|
|
||||||
...want,
|
|
||||||
attributes: { [MARK]: "true" },
|
|
||||||
protocolMappers: [ROLES_MAPPER],
|
|
||||||
});
|
|
||||||
return "created";
|
|
||||||
}
|
|
||||||
// Overlay what the mesh owns on what is there, so a field Keycloak added or an operator set on a
|
|
||||||
// field the mesh does not own survives the update.
|
|
||||||
await this.kc.updateClient(this.realm, found.id!, {
|
|
||||||
...found,
|
|
||||||
...want,
|
|
||||||
attributes: { ...(found.attributes ?? {}), [MARK]: "true" },
|
|
||||||
});
|
|
||||||
await this.ensureMapper(found.id!);
|
|
||||||
return "updated";
|
|
||||||
}
|
|
||||||
|
|
||||||
private async ensureMapper(id: string): Promise<void> {
|
|
||||||
const mappers = await this.kc.listClientMappers(this.realm, id);
|
|
||||||
const have = mappers.find((m) => m.name === ROLES_MAPPER.name);
|
|
||||||
if (!have) {
|
|
||||||
await this.kc.addClientMapper(this.realm, id, ROLES_MAPPER);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const drifted =
|
|
||||||
have.protocolMapper !== ROLES_MAPPER.protocolMapper ||
|
|
||||||
Object.entries(ROLES_MAPPER.config).some(([k, v]) => have.config?.[k] !== v);
|
|
||||||
if (drifted) {
|
|
||||||
await this.kc.updateClientMapper(this.realm, id, { ...ROLES_MAPPER, id: have.id });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Whether Keycloak still holds this consumer's client exactly as the grant says: present, the
|
|
||||||
* mesh's, enabled, confidential, with the mesh's secret and the redirects asked for. Reads only. */
|
|
||||||
async holds(g: OidcGrant): Promise<boolean> {
|
|
||||||
const want = wanted(g);
|
|
||||||
const found = await this.kc.findClient(this.realm, g.as);
|
|
||||||
if (!found || !marked(found) || found.enabled === false || found.publicClient) return false;
|
|
||||||
if (!sameSet(found.redirectUris, want.redirectUris!)) return false;
|
|
||||||
const mappers = await this.kc.listClientMappers(this.realm, found.id!);
|
|
||||||
if (!mappers.some((m) => m.name === ROLES_MAPPER.name)) return false;
|
|
||||||
return (await this.kc.clientSecretById(this.realm, found.id!)) === g.password;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Withdraw a consumer's client — only one the mesh made. Returns what happened, for the log. */
|
|
||||||
async remove(as: string): Promise<"removed" | "absent" | "not ours"> {
|
|
||||||
const found = await this.kc.findClient(this.realm, as);
|
|
||||||
if (!found) return "absent";
|
|
||||||
if (!marked(found)) return "not ours";
|
|
||||||
await this.kc.deleteClientById(this.realm, found.id!);
|
|
||||||
return "removed";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,15 +1,11 @@
|
|||||||
{
|
{
|
||||||
"name": "@novox/module-keycloak",
|
"name": "@novox/module-keycloak",
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"description": "keycloak — identity and access; provides the mesh oidc-client interface. Its admin API client, provisioner, tools and events live here (novox/hq ADR 0039).",
|
"description": "keycloak — identity and access. Its admin API client, tools and events live here (novox/hq ADR 0039).",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
|
||||||
"build": "tsc client.ts oidc.ts index.ts provisioner/index.ts tools/index.ts --module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist",
|
|
||||||
"test": "npm run build && node --test --experimental-strip-types 'test/*.test.ts'"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@novox/mesh-sdk": "^0.1.1"
|
"@novox/mesh-sdk": "^0.1.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/node": "^22.0.0",
|
"@types/node": "^22.0.0",
|
||||||
|
|||||||
@@ -1,73 +0,0 @@
|
|||||||
// keycloak's provisioner — the adapter that makes keycloak a provider of the mesh `oidc-client`
|
|
||||||
// interface. The reconcile loop, the contributions file and reading the mesh's minted secret are the
|
|
||||||
// sdk harness's; this writes only the per-service half: how Keycloak creates, checks and removes a
|
|
||||||
// consumer's client (novox/hq ADR 0039/0040/0048). What a client is, and which ones are the mesh's,
|
|
||||||
// is in ../oidc.ts.
|
|
||||||
//
|
|
||||||
// The `oidc-client` interface: a consumer logs people in through the realm this module serves, as
|
|
||||||
// the confidential client `as` with the secret the mesh minted, and is redirected back to the
|
|
||||||
// callback it contributed under the names the mesh composed for its endpoint. What it is served —
|
|
||||||
// the issuer and the endpoint paths under it — is in the manifest's `serves`, settled with the
|
|
||||||
// assignment's settings.
|
|
||||||
//
|
|
||||||
// **The realm is read out of the issuer**, the one value an assignment sets (settings reach both the
|
|
||||||
// served facts and this module's config.json): a realm set in one place and an issuer in another
|
|
||||||
// would let the consumer be told one realm while its client is made in another.
|
|
||||||
|
|
||||||
import { runProvisioner, type Provision } from "@novox/mesh-sdk/provisioner";
|
|
||||||
import { emit } from "@novox/mesh-sdk/events";
|
|
||||||
import { readFileSync } from "node:fs";
|
|
||||||
import { KeycloakClient } from "../client.js";
|
|
||||||
import { OidcClients, realmOf } from "../oidc.js";
|
|
||||||
|
|
||||||
/** The issuer this assignment serves, from the settings-merged config the mesh delivers. */
|
|
||||||
function issuer(): string {
|
|
||||||
const file = process.env.MESH_KEYCLOAK_CONFIG_FILE;
|
|
||||||
let cfg: Record<string, unknown> = {};
|
|
||||||
if (file) {
|
|
||||||
try {
|
|
||||||
cfg = JSON.parse(readFileSync(file, "utf8")) as Record<string, unknown>;
|
|
||||||
} catch {
|
|
||||||
// Absent or unreadable: fall through to the environment, and refuse below if that is empty too.
|
|
||||||
}
|
|
||||||
}
|
|
||||||
const said = typeof cfg.issuer === "string" ? cfg.issuer : process.env.MESH_KEYCLOAK_ISSUER;
|
|
||||||
if (!said) throw new Error("no issuer — the module's config.json carries none and MESH_KEYCLOAK_ISSUER is unset");
|
|
||||||
return said;
|
|
||||||
}
|
|
||||||
|
|
||||||
const clients = new OidcClients(KeycloakClient.fromEnv(), realmOf(issuer()));
|
|
||||||
|
|
||||||
/** Emit a lifecycle event without letting a broker hiccup fail the provisioning itself. */
|
|
||||||
async function announce(type: string, body: Record<string, string>): Promise<void> {
|
|
||||||
try {
|
|
||||||
await emit(type, body);
|
|
||||||
} catch (err) {
|
|
||||||
console.error(`[provisioner:oidc-client] emit ${type} failed: ${err}`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
runProvisioner("oidc-client", {
|
|
||||||
async create(p: Provision): Promise<void> {
|
|
||||||
const done = await clients.ensure(p);
|
|
||||||
if (done === "created") {
|
|
||||||
console.log(`[provisioner:oidc-client] created client ${p.as} in realm ${clients.realm}`);
|
|
||||||
await announce("client.created", { realm: clients.realm, clientId: p.as, consumer: p.consumer ?? "" });
|
|
||||||
}
|
|
||||||
},
|
|
||||||
|
|
||||||
async remove(p: { as: string }): Promise<void> {
|
|
||||||
const done = await clients.remove(p.as);
|
|
||||||
if (done === "not ours") {
|
|
||||||
console.error(`[provisioner:oidc-client] ${p.as}: a client of that id exists that the mesh did not make — left alone`);
|
|
||||||
} else if (done === "removed") {
|
|
||||||
console.log(`[provisioner:oidc-client] removed client ${p.as} from realm ${clients.realm}`);
|
|
||||||
}
|
|
||||||
},
|
|
||||||
|
|
||||||
// Asked every minute by the harness: whether Keycloak still holds this consumer's client exactly as
|
|
||||||
// the mesh gave it, so a client deleted or edited behind the mesh's back is made again (hq issue 120).
|
|
||||||
async holds(p: Provision): Promise<boolean> {
|
|
||||||
return clients.holds(p);
|
|
||||||
},
|
|
||||||
});
|
|
||||||
@@ -1,239 +0,0 @@
|
|||||||
// What holds keycloak to the `oidc-client` provision (oidc.ts): one confidential client per consumer,
|
|
||||||
// under the id and secret the mesh gave, redirecting only to the consumer's own callback under the
|
|
||||||
// names the mesh composed; made once and brought back on every apply; and a client the mesh did not
|
|
||||||
// make — same id or not — never adopted, changed or deleted.
|
|
||||||
//
|
|
||||||
// Keycloak is a fake: the admin routes the module touches, answering with the status codes and the
|
|
||||||
// shapes Keycloak gives. Run against the compiled module (npm test builds first), the way the runtime
|
|
||||||
// loads it.
|
|
||||||
|
|
||||||
import { test, after } from "node:test";
|
|
||||||
import assert from "node:assert/strict";
|
|
||||||
import { createServer, type IncomingMessage, type ServerResponse } from "node:http";
|
|
||||||
import { randomUUID } from "node:crypto";
|
|
||||||
|
|
||||||
import { KeycloakClient } from "../dist/client.js";
|
|
||||||
import { MARK, OidcClients, ROLES_MAPPER, realmOf, redirectsOf } from "../dist/oidc.js";
|
|
||||||
|
|
||||||
type Client = Record<string, any>;
|
|
||||||
|
|
||||||
/** The realm's clients, by internal id, and what the fake was asked. */
|
|
||||||
const realm = "Novox";
|
|
||||||
const clients = new Map<string, Client>();
|
|
||||||
const calls: string[] = [];
|
|
||||||
|
|
||||||
function body(req: IncomingMessage): Promise<any> {
|
|
||||||
return new Promise((resolve) => {
|
|
||||||
let raw = "";
|
|
||||||
req.on("data", (c) => (raw += c));
|
|
||||||
req.on("end", () => resolve(raw ? JSON.parse(raw) : undefined));
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function send(res: ServerResponse, status: number, value?: unknown): void {
|
|
||||||
res.writeHead(status, { "Content-Type": "application/json" });
|
|
||||||
res.end(value === undefined ? "" : JSON.stringify(value));
|
|
||||||
}
|
|
||||||
|
|
||||||
const server = createServer(async (req, res) => {
|
|
||||||
const url = new URL(req.url!, "http://fake");
|
|
||||||
calls.push(`${req.method} ${url.pathname}`);
|
|
||||||
if (url.pathname === "/realms/master/protocol/openid-connect/token") {
|
|
||||||
return send(res, 200, { access_token: "t", expires_in: 300 });
|
|
||||||
}
|
|
||||||
const base = `/admin/realms/${realm}/clients`;
|
|
||||||
if (!url.pathname.startsWith(base)) return send(res, 404, { error: "Realm not found." });
|
|
||||||
const rest = url.pathname.slice(base.length).split("/").filter(Boolean);
|
|
||||||
if (rest.length === 0 && req.method === "GET") {
|
|
||||||
const want = url.searchParams.get("clientId");
|
|
||||||
return send(res, 200, [...clients.values()].filter((c) => !want || c.clientId === want));
|
|
||||||
}
|
|
||||||
if (rest.length === 0 && req.method === "POST") {
|
|
||||||
const rep = await body(req);
|
|
||||||
if ([...clients.values()].some((c) => c.clientId === rep.clientId)) {
|
|
||||||
return send(res, 409, { errorMessage: `Client ${rep.clientId} already exists` });
|
|
||||||
}
|
|
||||||
const id = randomUUID();
|
|
||||||
const mappers = (rep.protocolMappers ?? []).map((m: Client) => ({ ...m, id: randomUUID() }));
|
|
||||||
clients.set(id, { ...rep, id, protocolMappers: mappers });
|
|
||||||
return send(res, 201);
|
|
||||||
}
|
|
||||||
const c = clients.get(rest[0]);
|
|
||||||
if (!c) return send(res, 404, { error: "Could not find client" });
|
|
||||||
if (rest.length === 1 && req.method === "PUT") {
|
|
||||||
// Keycloak ignores protocolMappers on a client update: they have their own endpoints.
|
|
||||||
const rep = await body(req);
|
|
||||||
clients.set(c.id, { ...rep, id: c.id, protocolMappers: c.protocolMappers });
|
|
||||||
return send(res, 204);
|
|
||||||
}
|
|
||||||
if (rest.length === 1 && req.method === "DELETE") {
|
|
||||||
clients.delete(c.id);
|
|
||||||
return send(res, 204);
|
|
||||||
}
|
|
||||||
if (rest[1] === "client-secret" && req.method === "GET") {
|
|
||||||
return send(res, 200, { type: "secret", value: c.secret });
|
|
||||||
}
|
|
||||||
if (rest[1] === "protocol-mappers") {
|
|
||||||
if (req.method === "GET") return send(res, 200, c.protocolMappers ?? []);
|
|
||||||
if (req.method === "POST") {
|
|
||||||
c.protocolMappers = [...(c.protocolMappers ?? []), { ...(await body(req)), id: randomUUID() }];
|
|
||||||
return send(res, 201);
|
|
||||||
}
|
|
||||||
if (req.method === "PUT") {
|
|
||||||
const m = await body(req);
|
|
||||||
c.protocolMappers = c.protocolMappers.map((x: Client) => (x.id === rest[4] ? m : x));
|
|
||||||
return send(res, 204);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
send(res, 405);
|
|
||||||
});
|
|
||||||
await new Promise<void>((r) => server.listen(0, "127.0.0.1", r));
|
|
||||||
after(() => server.close());
|
|
||||||
const port = (server.address() as { port: number }).port;
|
|
||||||
|
|
||||||
const oidc = new OidcClients(new KeycloakClient(`http://127.0.0.1:${port}`, "admin", "pw"), realm);
|
|
||||||
|
|
||||||
/** Grafana on ace, as the mesh hands it to the provisioner. */
|
|
||||||
function grafana(secret = "s3cret", values: Record<string, unknown> = {}) {
|
|
||||||
return {
|
|
||||||
as: "mesh_ace_grafana",
|
|
||||||
password: secret,
|
|
||||||
consumer: "ace",
|
|
||||||
values: {
|
|
||||||
label: "grafana", endpoint: "web", port: 20010, callback: "/login/generic_oauth",
|
|
||||||
name: "grafana.zurag.be", "internal-name": "grafana.ace.internal", ...values,
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
function only(clientId: string): Client {
|
|
||||||
const found = [...clients.values()].filter((c) => c.clientId === clientId);
|
|
||||||
assert.equal(found.length, 1, `exactly one client ${clientId}, found ${found.length}`);
|
|
||||||
return found[0];
|
|
||||||
}
|
|
||||||
|
|
||||||
test("the realm is read out of the issuer, and an issuer that names none is refused", () => {
|
|
||||||
assert.equal(realmOf("https://keycloak.novox.be/realms/Novox"), "Novox");
|
|
||||||
assert.equal(realmOf("https://keycloak.novox.be/realms/Novox/"), "Novox");
|
|
||||||
assert.equal(realmOf("http://127.0.0.1:18500/realms/master"), "master");
|
|
||||||
assert.throws(() => realmOf("https://keycloak.novox.be"), /realms/);
|
|
||||||
assert.throws(() => realmOf("keycloak"), /not a URL/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the redirect is the consumer's callback under every name the mesh composed for it", () => {
|
|
||||||
assert.deepEqual(redirectsOf(grafana().values), {
|
|
||||||
root: "https://grafana.zurag.be",
|
|
||||||
redirects: ["https://grafana.zurag.be/login/generic_oauth", "https://grafana.ace.internal/login/generic_oauth"],
|
|
||||||
});
|
|
||||||
// A route reaching only the private network has only the internal name, and that is enough.
|
|
||||||
assert.deepEqual(redirectsOf({ callback: "/cb", "internal-name": "x.ace.internal" }).redirects,
|
|
||||||
["https://x.ace.internal/cb"]);
|
|
||||||
assert.throws(() => redirectsOf({ name: "grafana.zurag.be" }), /callback/);
|
|
||||||
assert.throws(() => redirectsOf({ name: "grafana.zurag.be", callback: "login" }), /callback/);
|
|
||||||
assert.throws(() => redirectsOf({ callback: "/cb" }), /label/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a consumer is given one confidential client, under its id and the mesh's secret", async () => {
|
|
||||||
clients.clear();
|
|
||||||
assert.equal(await oidc.ensure(grafana()), "created");
|
|
||||||
const c = only("mesh_ace_grafana");
|
|
||||||
assert.equal(c.publicClient, false);
|
|
||||||
assert.equal(c.clientAuthenticatorType, "client-secret");
|
|
||||||
assert.equal(c.secret, "s3cret");
|
|
||||||
assert.equal(c.enabled, true);
|
|
||||||
assert.equal(c.standardFlowEnabled, true);
|
|
||||||
assert.equal(c.directAccessGrantsEnabled, false);
|
|
||||||
assert.equal(c.implicitFlowEnabled, false);
|
|
||||||
assert.deepEqual(c.redirectUris, [
|
|
||||||
"https://grafana.zurag.be/login/generic_oauth", "https://grafana.ace.internal/login/generic_oauth"]);
|
|
||||||
assert.equal(c.attributes[MARK], "true");
|
|
||||||
assert.deepEqual(c.protocolMappers.map((m: Client) => m.name), [ROLES_MAPPER.name]);
|
|
||||||
assert.equal(await oidc.holds(grafana()), true);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("applying the same grant again makes no second client", async () => {
|
|
||||||
clients.clear();
|
|
||||||
await oidc.ensure(grafana());
|
|
||||||
assert.equal(await oidc.ensure(grafana()), "updated");
|
|
||||||
assert.equal(await oidc.ensure(grafana()), "updated");
|
|
||||||
only("mesh_ace_grafana");
|
|
||||||
assert.equal(only("mesh_ace_grafana").protocolMappers.length, 1, "the roles mapper is not added twice");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a new secret or a moved name is applied in place, and what the mesh does not own survives", async () => {
|
|
||||||
clients.clear();
|
|
||||||
await oidc.ensure(grafana());
|
|
||||||
const id = only("mesh_ace_grafana").id;
|
|
||||||
// Something the mesh does not own, set on the client after it was made.
|
|
||||||
clients.get(id)!.consentRequired = true;
|
|
||||||
clients.get(id)!.attributes["post.logout.redirect.uris"] = "+";
|
|
||||||
|
|
||||||
assert.equal(await oidc.holds(grafana("rotated")), false, "a rotated secret is not held until applied");
|
|
||||||
await oidc.ensure(grafana("rotated", { name: "dash.zurag.be" }));
|
|
||||||
const c = only("mesh_ace_grafana");
|
|
||||||
assert.equal(c.id, id, "updated, not replaced");
|
|
||||||
assert.equal(c.secret, "rotated");
|
|
||||||
assert.deepEqual(c.redirectUris, [
|
|
||||||
"https://dash.zurag.be/login/generic_oauth", "https://grafana.ace.internal/login/generic_oauth"]);
|
|
||||||
assert.equal(c.rootUrl, "https://dash.zurag.be");
|
|
||||||
assert.equal(c.consentRequired, true);
|
|
||||||
assert.equal(c.attributes["post.logout.redirect.uris"], "+");
|
|
||||||
assert.equal(c.attributes[MARK], "true");
|
|
||||||
assert.equal(await oidc.holds(grafana("rotated", { name: "dash.zurag.be" })), true);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a client lost or edited behind the mesh's back is not held, and is made whole again", async () => {
|
|
||||||
clients.clear();
|
|
||||||
await oidc.ensure(grafana());
|
|
||||||
const c = only("mesh_ace_grafana");
|
|
||||||
c.redirectUris = ["*"];
|
|
||||||
assert.equal(await oidc.holds(grafana()), false, "a widened redirect is not what the mesh gave");
|
|
||||||
await oidc.ensure(grafana());
|
|
||||||
assert.equal(await oidc.holds(grafana()), true);
|
|
||||||
|
|
||||||
only("mesh_ace_grafana").protocolMappers = [];
|
|
||||||
assert.equal(await oidc.holds(grafana()), false, "a client without its roles mapper is not held");
|
|
||||||
await oidc.ensure(grafana());
|
|
||||||
assert.equal(await oidc.holds(grafana()), true);
|
|
||||||
|
|
||||||
clients.clear();
|
|
||||||
assert.equal(await oidc.holds(grafana()), false);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a client of the same id the mesh did not make is refused, and left exactly as it was", async () => {
|
|
||||||
clients.clear();
|
|
||||||
clients.set("theirs", { id: "theirs", clientId: "mesh_ace_grafana", secret: "their-secret", redirectUris: ["*"] });
|
|
||||||
const before = JSON.stringify(clients.get("theirs"));
|
|
||||||
const writes = calls.length;
|
|
||||||
await assert.rejects(oidc.ensure(grafana()), /did not make/);
|
|
||||||
assert.equal(JSON.stringify(clients.get("theirs")), before);
|
|
||||||
assert.ok(calls.slice(writes).every((c) => c.startsWith("GET") || c.startsWith("POST /realms/master")),
|
|
||||||
`only reads were made: ${calls.slice(writes).join(", ")}`);
|
|
||||||
assert.equal(await oidc.holds(grafana()), false);
|
|
||||||
assert.equal(await oidc.remove("mesh_ace_grafana"), "not ours");
|
|
||||||
assert.ok(clients.has("theirs"), "a client the mesh did not make is never deleted");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the predecessor's hand-made client is never touched: the mesh's has its own id", async () => {
|
|
||||||
clients.clear();
|
|
||||||
clients.set("hal", { id: "hal", clientId: "grafana", secret: "old", redirectUris: ["https://grafana.zurag.be/*"] });
|
|
||||||
await oidc.ensure(grafana());
|
|
||||||
assert.equal(clients.get("hal")!.secret, "old");
|
|
||||||
only("mesh_ace_grafana");
|
|
||||||
assert.equal(await oidc.remove("grafana"), "not ours");
|
|
||||||
assert.ok(clients.has("hal"));
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a withdrawn consumer's client is removed, and an absent one is not an error", async () => {
|
|
||||||
clients.clear();
|
|
||||||
await oidc.ensure(grafana());
|
|
||||||
assert.equal(await oidc.remove("mesh_ace_grafana"), "removed");
|
|
||||||
assert.equal([...clients.values()].length, 0);
|
|
||||||
assert.equal(await oidc.remove("mesh_ace_grafana"), "absent");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a contribution with no callback makes no client at all", async () => {
|
|
||||||
clients.clear();
|
|
||||||
await assert.rejects(oidc.ensure({ ...grafana(), values: { name: "grafana.zurag.be" } }), /callback/);
|
|
||||||
assert.equal(clients.size, 0);
|
|
||||||
});
|
|
||||||
@@ -8,5 +8,5 @@
|
|||||||
"skipLibCheck": true,
|
"skipLibCheck": true,
|
||||||
"noEmit": true
|
"noEmit": true
|
||||||
},
|
},
|
||||||
"include": ["client.ts", "oidc.ts", "index.ts", "provisioner/index.ts", "tools/index.ts"]
|
"include": ["client.ts", "index.ts", "tools/index.ts"]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,31 +0,0 @@
|
|||||||
# lab's runtime: the tool runtime, carrying this module's code, and the toolchain the lab's suite
|
|
||||||
# builds the mesh with (novox/hq ADR 0172). It reaches the machine's virtualisation and container
|
|
||||||
# runtime through their sockets, so what it raises is what a hand run on this machine raises.
|
|
||||||
#
|
|
||||||
# Every download is pinned by its checksum: an image that builds the mesh is the last place to take
|
|
||||||
# whatever an upstream serves today.
|
|
||||||
ARG BUILD_BASE
|
|
||||||
ARG RUNTIME_BASE
|
|
||||||
|
|
||||||
FROM ${BUILD_BASE} AS build
|
|
||||||
WORKDIR /app/modules/lab
|
|
||||||
COPY . .
|
|
||||||
RUN node /app/node_modules/typescript/bin/tsc tools/index.ts tools/runs.ts \
|
|
||||||
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
|
||||||
|
|
||||||
FROM ${RUNTIME_BASE}
|
|
||||||
RUN apt-get update \
|
|
||||||
&& apt-get install -y --no-install-recommends git make ca-certificates curl \
|
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
|
||||||
RUN curl -fsSL -o /tmp/go.tgz https://go.dev/dl/go1.26.8.linux-amd64.tar.gz \
|
|
||||||
&& echo "d0f743b33e8d8945e6b1f432edd15785c70507121d6e2a723b21285eddf8b57b /tmp/go.tgz" | sha256sum -c - \
|
|
||||||
&& tar -C /usr/local -xzf /tmp/go.tgz && rm /tmp/go.tgz
|
|
||||||
RUN curl -fsSL -o /usr/local/bin/incus https://github.com/lxc/incus/releases/download/v7.5.1/bin.linux.incus.x86_64 \
|
|
||||||
&& echo "7bd6223b369f4d693fcde695bd8549a73b5b3d403735329212483702aa22c179 /usr/local/bin/incus" | sha256sum -c - \
|
|
||||||
&& chmod 0755 /usr/local/bin/incus
|
|
||||||
RUN curl -fsSL -o /tmp/docker.tgz https://download.docker.com/linux/static/stable/x86_64/docker-28.5.2.tgz \
|
|
||||||
&& echo "ea90cfd12e1eeb12aa1c971741adb8bd4ed88e2a574eaac13f5029a1dbc6300d /tmp/docker.tgz" | sha256sum -c - \
|
|
||||||
&& tar -C /tmp -xzf /tmp/docker.tgz docker/docker && mv /tmp/docker/docker /usr/local/bin/docker && rm -rf /tmp/docker /tmp/docker.tgz
|
|
||||||
ENV PATH=/usr/local/go/bin:$PATH
|
|
||||||
COPY --from=build /app/modules/lab/dist /app/modules/lab/dist
|
|
||||||
ENV MESH_TOOL_MODULES=/app/modules/lab/dist/tools/index.js
|
|
||||||
@@ -1,81 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "lab",
|
|
||||||
"version": "1",
|
|
||||||
"capabilities": [
|
|
||||||
"container-runtime"
|
|
||||||
],
|
|
||||||
"own-secrets": {
|
|
||||||
"broker": "${dir:mesh-state}/broker"
|
|
||||||
},
|
|
||||||
"resources": [
|
|
||||||
{
|
|
||||||
"id": "mesh-state",
|
|
||||||
"type": "directory",
|
|
||||||
"mode": "0700",
|
|
||||||
"place": "mesh"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "state",
|
|
||||||
"type": "directory",
|
|
||||||
"mode": "0700",
|
|
||||||
"place": "."
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "work",
|
|
||||||
"type": "directory",
|
|
||||||
"path": "/var/lib/mesh-lab-runs",
|
|
||||||
"mode": "0700"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "runtime-env",
|
|
||||||
"type": "file",
|
|
||||||
"path": "${dir:state}/lab.env",
|
|
||||||
"mode": "0600",
|
|
||||||
"content": "MESH_LAB_FORGE=${setting:forge}\n"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "runtime",
|
|
||||||
"type": "container",
|
|
||||||
"name": "mesh-lab",
|
|
||||||
"network": "host",
|
|
||||||
"env-file": [
|
|
||||||
"${dir:state}/lab.env"
|
|
||||||
],
|
|
||||||
"volumes": [
|
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
|
||||||
"${dir:work}:${dir:work}",
|
|
||||||
"/var/run/docker.sock:/var/run/docker.sock",
|
|
||||||
"/var/lib/incus/unix.socket:/var/lib/incus/unix.socket"
|
|
||||||
],
|
|
||||||
"env": {
|
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
|
||||||
"MESH_LAB_WORK": "${dir:work}"
|
|
||||||
},
|
|
||||||
"restart-on": [
|
|
||||||
"runtime-env"
|
|
||||||
],
|
|
||||||
"artifact": "runtime"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"build": {
|
|
||||||
"on": [
|
|
||||||
{
|
|
||||||
"arg": "BUILD_BASE",
|
|
||||||
"module": "mesh-tools",
|
|
||||||
"artifact": "build"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"arg": "RUNTIME_BASE",
|
|
||||||
"module": "mesh-tools",
|
|
||||||
"artifact": "runtime"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"artifacts": [
|
|
||||||
{
|
|
||||||
"name": "runtime",
|
|
||||||
"kind": "image",
|
|
||||||
"from": "Dockerfile"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "@novox/module-lab",
|
|
||||||
"version": "0.1.0",
|
|
||||||
"description": "lab — the lab, as a module: runs beds against the forge's branches when the mesh asks (novox/hq ADR 0172).",
|
|
||||||
"type": "module",
|
|
||||||
"private": true,
|
|
||||||
"dependencies": { "@novox/mesh-sdk": "^0.1.0" },
|
|
||||||
"devDependencies": { "@types/node": "^22.0.0", "typescript": "^5.6.0" }
|
|
||||||
}
|
|
||||||
@@ -1,86 +0,0 @@
|
|||||||
// lab's tools — the lab, as the mesh asks for it (novox/hq ADR 0172). They run on the machine the
|
|
||||||
// lab is assigned to, and only there: a bed raises virtual machines on that machine's virtualisation.
|
|
||||||
|
|
||||||
import { spawnSync } from "node:child_process";
|
|
||||||
import { registerModuleTools, type ToolDefinition } from "@novox/mesh-sdk/tools";
|
|
||||||
import { listRuns, readStatus, REPOSITORIES, running, start, stop, tail } from "./runs.js";
|
|
||||||
|
|
||||||
export function getLabTools(env: NodeJS.ProcessEnv): ToolDefinition[] {
|
|
||||||
const work = env.MESH_LAB_WORK ?? "/var/lib/mesh-lab-runs";
|
|
||||||
const forge = (env.MESH_LAB_FORGE ?? "").replace(/\/+$/, "");
|
|
||||||
return [
|
|
||||||
{
|
|
||||||
name: "lab_check",
|
|
||||||
description: "Whether this machine can run the lab's beds: the lab's own check, against the forge's main branch.",
|
|
||||||
input: {},
|
|
||||||
run: async () => {
|
|
||||||
if (!forge) return { ok: false, output: "the lab's forge is not set: settings for lab, {\"forge\": \"<url>\"}" };
|
|
||||||
const dir = `${work}/check`;
|
|
||||||
spawnSync("rm", ["-rf", dir]);
|
|
||||||
const clone = spawnSync("git", ["clone", "--quiet", "--depth", "1", `${forge}/novox/mesh-lab.git`, dir], { encoding: "utf8" });
|
|
||||||
if (clone.status !== 0) return { ok: false, output: clone.stderr };
|
|
||||||
spawnSync("npm", ["ci", "--no-audit", "--no-fund", "--loglevel=error"], { cwd: dir, encoding: "utf8" });
|
|
||||||
const check = spawnSync("node", ["--experimental-strip-types", "src/cli.ts", "check"], { cwd: dir, encoding: "utf8" });
|
|
||||||
return { ok: check.status === 0, output: `${check.stdout}${check.stderr}`.trim() };
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "lab_run",
|
|
||||||
description:
|
|
||||||
"Run the lab's beds against branches on the forge: fresh checkouts of every repository the lab builds, " +
|
|
||||||
"side by side, then the suite on the named test files. Answers at once with the run's id; lab_status " +
|
|
||||||
"and lab_log follow it. One run at a time.",
|
|
||||||
input: {
|
|
||||||
tests: { type: "string", description: "the bed test files, comma-separated, relative to mesh-lab (e.g. test/integration/mesh.test.ts)" },
|
|
||||||
refs: {
|
|
||||||
type: "string",
|
|
||||||
description: `a JSON object of repository to branch, for any of ${REPOSITORIES.join(", ")}; the rest run main`,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
run: async (args) => {
|
|
||||||
if (!forge) return { started: false, reason: "the lab's forge is not set: settings for lab, {\"forge\": \"<url>\"}" };
|
|
||||||
const tests = String(args.tests ?? "").split(",").map((s) => s.trim()).filter(Boolean);
|
|
||||||
if (tests.length === 0) return { started: false, reason: "name at least one bed test file" };
|
|
||||||
let refs: Record<string, string> = {};
|
|
||||||
if (args.refs) {
|
|
||||||
try {
|
|
||||||
refs = JSON.parse(String(args.refs)) as Record<string, string>;
|
|
||||||
} catch {
|
|
||||||
return { started: false, reason: "refs is not a JSON object of repository to branch" };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
const stranger = Object.keys(refs).filter((r) => !REPOSITORIES.includes(r));
|
|
||||||
if (stranger.length > 0) return { started: false, reason: `the lab does not build ${stranger.join(", ")}` };
|
|
||||||
const busy = running(work);
|
|
||||||
if (busy) return { started: false, reason: `${busy.id} is still ${busy.state}; one run at a time`, running: busy };
|
|
||||||
return { started: true, run: start(work, forge, tests, refs) };
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "lab_status",
|
|
||||||
description: "A run's state, the commits it tested and how it ended — or every run, newest first, when no id is given.",
|
|
||||||
input: { id: { type: "string", description: "the run's id (optional)" } },
|
|
||||||
run: async (args) => {
|
|
||||||
if (args.id) return readStatus(work, String(args.id)) ?? { found: false, id: String(args.id) };
|
|
||||||
return { runs: listRuns(work).slice(0, 10) };
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "lab_log",
|
|
||||||
description: "The last lines of a run's log.",
|
|
||||||
input: {
|
|
||||||
id: { type: "string", description: "the run's id" },
|
|
||||||
lines: { type: "number", description: "how many lines from the end (default 200)" },
|
|
||||||
},
|
|
||||||
run: async (args) => ({ id: String(args.id), log: tail(work, String(args.id), Number(args.lines ?? 200)) }),
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "lab_stop",
|
|
||||||
description: "Stop a run and everything it started.",
|
|
||||||
input: { id: { type: "string", description: "the run's id" } },
|
|
||||||
run: async (args) => stop(work, String(args.id)) ?? { found: false, id: String(args.id) },
|
|
||||||
},
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
registerModuleTools("lab", (env) => getLabTools(env));
|
|
||||||
@@ -1,171 +0,0 @@
|
|||||||
// A lab run: fresh checkouts of the named branches, side by side, then the lab's suite on the named
|
|
||||||
// beds (novox/hq ADR 0172).
|
|
||||||
//
|
|
||||||
// **A run is a detached script with its own process group**, so it outlives the tool call that started
|
|
||||||
// it and `stop` ends everything it started. It writes what it is doing to a status file beside its log,
|
|
||||||
// and that file is the whole of what the tools read back: a runtime that restarts mid-run still answers
|
|
||||||
// for it, and says it was lost rather than pretending it is still going.
|
|
||||||
|
|
||||||
import { spawn } from "node:child_process";
|
|
||||||
import { existsSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from "node:fs";
|
|
||||||
import { join } from "node:path";
|
|
||||||
|
|
||||||
/** The repositories a lab run checks out, side by side, as the lab expects its siblings. */
|
|
||||||
export const REPOSITORIES = ["mesh-lab", "mesh-controller", "mesh-host", "mesh-catalog", "mesh-tools", "mesh-sdk"];
|
|
||||||
|
|
||||||
export interface RunStatus {
|
|
||||||
id: string;
|
|
||||||
state: "checking-out" | "building" | "running" | "passed" | "failed" | "stopped" | "lost";
|
|
||||||
started: string;
|
|
||||||
ended?: string;
|
|
||||||
tests: string[];
|
|
||||||
refs: Record<string, string>;
|
|
||||||
commits?: Record<string, string>;
|
|
||||||
exit?: number;
|
|
||||||
pid?: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function runDir(work: string, id: string): string {
|
|
||||||
return join(work, id);
|
|
||||||
}
|
|
||||||
|
|
||||||
function statusPath(work: string, id: string): string {
|
|
||||||
return join(runDir(work, id), "status.json");
|
|
||||||
}
|
|
||||||
|
|
||||||
export function readStatus(work: string, id: string): RunStatus | undefined {
|
|
||||||
try {
|
|
||||||
const s = JSON.parse(readFileSync(statusPath(work, id), "utf8")) as RunStatus;
|
|
||||||
// A run whose process is gone while its status still says it is going was lost — the runtime or
|
|
||||||
// the machine restarted under it. Said, rather than left reading as running for ever.
|
|
||||||
if (!["passed", "failed", "stopped", "lost"].includes(s.state) && s.pid && !alive(s.pid)) {
|
|
||||||
s.state = "lost";
|
|
||||||
}
|
|
||||||
return s;
|
|
||||||
} catch {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function alive(pid: number): boolean {
|
|
||||||
try {
|
|
||||||
process.kill(pid, 0);
|
|
||||||
return true;
|
|
||||||
} catch {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export function listRuns(work: string): RunStatus[] {
|
|
||||||
if (!existsSync(work)) return [];
|
|
||||||
return readdirSync(work)
|
|
||||||
.filter((d) => d.startsWith("run-"))
|
|
||||||
.map((id) => readStatus(work, id))
|
|
||||||
.filter((s): s is RunStatus => !!s)
|
|
||||||
.sort((a, b) => b.started.localeCompare(a.started));
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The run still going, if any: one at a time, because two would contend for the same machine. */
|
|
||||||
export function running(work: string): RunStatus | undefined {
|
|
||||||
return listRuns(work).find((s) => !["passed", "failed", "stopped", "lost"].includes(s.state));
|
|
||||||
}
|
|
||||||
|
|
||||||
const shellQuote = (s: string) => `'${s.replace(/'/g, `'\\''`)}'`;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The script one run executes. Every step writes its state first, so a run that dies says where.
|
|
||||||
*
|
|
||||||
* The environment is the one the lab's README describes for a run against sibling checkouts, pointed
|
|
||||||
* at this run's own tree, so what is built and claimed is exactly what was checked out.
|
|
||||||
*/
|
|
||||||
export function script(work: string, id: string, forge: string, tests: string[], refs: Record<string, string>): string {
|
|
||||||
const dir = runDir(work, id);
|
|
||||||
const setState = (state: string) =>
|
|
||||||
`node -e ${shellQuote(
|
|
||||||
`const f=${JSON.stringify(join(dir, "status.json"))};const s=JSON.parse(require("fs").readFileSync(f,"utf8"));s.state=${JSON.stringify(state)};require("fs").writeFileSync(f,JSON.stringify(s,null,2))`,
|
|
||||||
)}`;
|
|
||||||
const clones = REPOSITORIES.map((repo) => {
|
|
||||||
const ref = refs[repo] ?? "main";
|
|
||||||
return [
|
|
||||||
`git clone --quiet --depth 50 --branch ${shellQuote(ref)} ${shellQuote(`${forge}/novox/${repo}.git`)} ${shellQuote(join(dir, repo))}`,
|
|
||||||
`echo "${repo} $(git -C ${shellQuote(join(dir, repo))} rev-parse HEAD)" >> ${shellQuote(join(dir, "commits.txt"))}`,
|
|
||||||
].join("\n");
|
|
||||||
}).join("\n");
|
|
||||||
const bin = join(dir, "bin");
|
|
||||||
return `set -euo pipefail
|
|
||||||
cd ${shellQuote(dir)}
|
|
||||||
${setState("checking-out")}
|
|
||||||
${clones}
|
|
||||||
node -e ${shellQuote(
|
|
||||||
`const fs=require("fs");const f=${JSON.stringify(join(dir, "status.json"))};const s=JSON.parse(fs.readFileSync(f,"utf8"));s.commits=Object.fromEntries(fs.readFileSync(${JSON.stringify(join(dir, "commits.txt"))},"utf8").trim().split("\\n").map(l=>l.split(" ")));fs.writeFileSync(f,JSON.stringify(s,null,2))`,
|
|
||||||
)}
|
|
||||||
${setState("building")}
|
|
||||||
for repo in mesh-sdk mesh-tools mesh-lab; do (cd ${shellQuote(dir)}/$repo && npm ci --no-audit --no-fund --loglevel=error); done
|
|
||||||
(cd ${shellQuote(dir)}/mesh-sdk && npm run build --if-present)
|
|
||||||
(cd ${shellQuote(dir)}/mesh-tools && npm run build --if-present)
|
|
||||||
mkdir -p ${shellQuote(bin)}
|
|
||||||
for p in postgres-provisioner objectstore-provisioner route-proxy; do
|
|
||||||
(cd ${shellQuote(dir)}/mesh-controller && CGO_ENABLED=0 go build -o ${shellQuote(bin)}/$p ./examples/$p)
|
|
||||||
done
|
|
||||||
export MESH_LAB_HOST_BINARY=${shellQuote(join(dir, "mesh-host", "mesh-host"))}
|
|
||||||
export MESH_LAB_BUNDLE=${shellQuote(join(dir, "mesh-host", "examples", "foundation-first-node-nats.lock"))}
|
|
||||||
export MESH_LAB_MODULES=${shellQuote(join(dir, "mesh-controller", "examples", "modules"))}
|
|
||||||
export MESH_LAB_BUILDER=${shellQuote(join(dir, "mesh-controller", "build", "mesh-builder"))}
|
|
||||||
export MESH_LAB_BOOTSTRAP_BINARY=${shellQuote(join(dir, "mesh-host", "mesh-bootstrap"))}
|
|
||||||
export MESH_LAB_CATALOG=${shellQuote(join(dir, "mesh-catalog", "modules"))}
|
|
||||||
export MESH_LAB_PROVISIONER=${shellQuote(join(bin, "postgres-provisioner"))}
|
|
||||||
export MESH_LAB_OBJECTSTORE_PROVISIONER=${shellQuote(join(bin, "objectstore-provisioner"))}
|
|
||||||
export MESH_LAB_ROUTE_PROXY=${shellQuote(join(bin, "route-proxy"))}
|
|
||||||
${setState("running")}
|
|
||||||
cd ${shellQuote(join(dir, "mesh-lab"))}
|
|
||||||
node --experimental-strip-types src/cli.ts suite ${tests.map(shellQuote).join(" ")}
|
|
||||||
`;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** start begins a run and returns at once with its status. */
|
|
||||||
export function start(work: string, forge: string, tests: string[], refs: Record<string, string>): RunStatus {
|
|
||||||
const id = `run-${new Date().toISOString().replace(/[:.]/g, "-")}`;
|
|
||||||
const dir = runDir(work, id);
|
|
||||||
mkdirSync(dir, { recursive: true });
|
|
||||||
const status: RunStatus = { id, state: "checking-out", started: new Date().toISOString(), tests, refs };
|
|
||||||
writeFileSync(statusPath(work, id), JSON.stringify(status, null, 2));
|
|
||||||
writeFileSync(join(dir, "run.sh"), script(work, id, forge, tests, refs), { mode: 0o700 });
|
|
||||||
|
|
||||||
// The wrapper records how the run ended, then removes the checkouts and keeps the log and status: a
|
|
||||||
// run's tree is its own, and the next run starts from fresh ones (novox/hq ADR 0172).
|
|
||||||
const wrapper = `bash ${shellQuote(join(dir, "run.sh"))} > ${shellQuote(join(dir, "run.log"))} 2>&1; code=$?
|
|
||||||
node -e ${shellQuote(
|
|
||||||
`const f=${JSON.stringify(statusPath(work, id))};const s=JSON.parse(require("fs").readFileSync(f,"utf8"));if(s.state!=="stopped"){s.state=process.argv[1]==="0"?"passed":"failed"};s.exit=Number(process.argv[1]);s.ended=new Date().toISOString();require("fs").writeFileSync(f,JSON.stringify(s,null,2))`,
|
|
||||||
)} "$code"
|
|
||||||
cd ${shellQuote(dir)} && rm -rf ${REPOSITORIES.map(shellQuote).join(" ")} bin`;
|
|
||||||
const child = spawn("bash", ["-c", wrapper], { detached: true, stdio: "ignore" });
|
|
||||||
child.unref();
|
|
||||||
status.pid = child.pid;
|
|
||||||
writeFileSync(statusPath(work, id), JSON.stringify(status, null, 2));
|
|
||||||
return status;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** stop ends a run and everything it started, by its process group. */
|
|
||||||
export function stop(work: string, id: string): RunStatus | undefined {
|
|
||||||
const s = readStatus(work, id);
|
|
||||||
if (!s || !s.pid) return s;
|
|
||||||
if (["passed", "failed", "stopped", "lost"].includes(s.state)) return s;
|
|
||||||
s.state = "stopped";
|
|
||||||
writeFileSync(statusPath(work, id), JSON.stringify(s, null, 2));
|
|
||||||
try {
|
|
||||||
process.kill(-s.pid, "SIGTERM");
|
|
||||||
} catch {
|
|
||||||
// Already gone between the read and the kill.
|
|
||||||
}
|
|
||||||
return s;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** tail is the last lines of a run's log. */
|
|
||||||
export function tail(work: string, id: string, lines: number): string {
|
|
||||||
try {
|
|
||||||
const all = readFileSync(join(runDir(work, id), "run.log"), "utf8").split("\n");
|
|
||||||
return all.slice(-Math.max(1, lines)).join("\n");
|
|
||||||
} catch {
|
|
||||||
return "";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,10 +1,10 @@
|
|||||||
// The Letta API client — letta's own code, living in the module (novox/hq ADR 0039). Its tools
|
// The Letta API client — letta's own code, living in the module (novox/hq ADR 0039). Its tools
|
||||||
// import it; nothing outside letta does.
|
// import it; nothing outside letta does.
|
||||||
//
|
//
|
||||||
// Letta authenticates with a single server password. That password is a mesh own-secret handed to
|
// Letta authenticates with a single server password, presented as a Bearer token. That password is
|
||||||
// both the server (LETTA_SERVER_PASSWORD) and this client, through the runtime config file the mesh
|
// a mesh own-secret, minted once and handed to both the server (LETTA_SERVER_PASSWORD) and this
|
||||||
// mounts (its `password` key) — so the module's tools are live without anything configured by hand.
|
// client (MESH_LETTA_PASSWORD) — so the module's tools are live without anything configured by hand.
|
||||||
// Where a server already has clients, the password is accepted rather than minted.
|
// The runtime config file may still override the URL or password.
|
||||||
|
|
||||||
import { readFileSync } from "node:fs";
|
import { readFileSync } from "node:fs";
|
||||||
|
|
||||||
@@ -58,10 +58,6 @@ export class LettaClient {
|
|||||||
...options,
|
...options,
|
||||||
headers: {
|
headers: {
|
||||||
"Content-Type": "application/json",
|
"Content-Type": "application/json",
|
||||||
// The server's --secure mode checks X-BARE-PASSWORD ("password <it>") and answers a Bearer
|
|
||||||
// token alone with 401 (letta/server/rest_api/app.py, 0.6.x). Both are sent: Bearer is what
|
|
||||||
// later servers read.
|
|
||||||
"X-BARE-PASSWORD": `password ${this.password}`,
|
|
||||||
Authorization: `Bearer ${this.password}`,
|
Authorization: `Bearer ${this.password}`,
|
||||||
...(options.headers as Record<string, string> | undefined),
|
...(options.headers as Record<string, string> | undefined),
|
||||||
},
|
},
|
||||||
|
|||||||
+31
-27
@@ -5,29 +5,22 @@
|
|||||||
"container-runtime"
|
"container-runtime"
|
||||||
],
|
],
|
||||||
"requires": [
|
"requires": [
|
||||||
"postgres-database",
|
"postgres-database"
|
||||||
"route"
|
|
||||||
],
|
],
|
||||||
"contributes": {
|
"contributes": {
|
||||||
"postgres-database": {
|
"postgres-database": {
|
||||||
"name": "letta"
|
"name": "letta"
|
||||||
},
|
|
||||||
"route": {
|
|
||||||
"label": "letta",
|
|
||||||
"endpoint": "web"
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"binds": {
|
"binds": {
|
||||||
"postgres-database": "${dir:state}/database.json",
|
"postgres-database": "/var/lib/letta/database.json"
|
||||||
"route": "${dir:state}/route.json"
|
|
||||||
},
|
},
|
||||||
"secrets": {
|
"secrets": {
|
||||||
"postgres-database": "${dir:state}/database.secret"
|
"postgres-database": "/var/lib/letta/database.secret"
|
||||||
},
|
},
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"server-password": "${dir:state}/server-password.secret",
|
"server-password": "/var/lib/letta/server-password.secret",
|
||||||
"openai-api-key": "${dir:state}/openai-api-key.secret",
|
"broker": "/var/lib/mesh/letta/broker"
|
||||||
"broker": "${dir:mesh-state}/broker"
|
|
||||||
},
|
},
|
||||||
"listens": [
|
"listens": [
|
||||||
{
|
{
|
||||||
@@ -35,28 +28,28 @@
|
|||||||
"port": 8283,
|
"port": 8283,
|
||||||
"protocol": "tcp",
|
"protocol": "tcp",
|
||||||
"from": "mesh",
|
"from": "mesh",
|
||||||
"why": "the Letta agent server REST API and web UI, password-protected (--secure); a public name is the route's"
|
"why": "the Letta agent server REST API and web UI; a public name is a route grant later"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/letta",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/letta",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "server-env",
|
"id": "server-env",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/server.env",
|
"path": "/var/lib/letta/server.env",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "LETTA_PG_URI=postgresql://${bound:postgres-database:as}:${secret:postgres-database}@${bound:postgres-database:at}:${bound:postgres-database:port}/${bound:postgres-database:as}\nLETTA_SERVER_PASSWORD=${secret:server-password}\nOPENAI_API_KEY=${secret:openai-api-key}\nSECURE=true\nTZ=Europe/Brussels\n"
|
"content": "LETTA_PG_URI=postgresql://${bound:postgres-database:as}:${secret:postgres-database}@${bound:postgres-database:at}:${bound:postgres-database:port}/${bound:postgres-database:as}\nLETTA_SERVER_PASSWORD=${secret:server-password}\nSECURE=true\nTZ=Europe/Brussels\n"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "net",
|
"id": "net",
|
||||||
@@ -67,42 +60,53 @@
|
|||||||
"id": "server",
|
"id": "server",
|
||||||
"type": "container",
|
"type": "container",
|
||||||
"name": "letta",
|
"name": "letta",
|
||||||
"image": "letta/letta@sha256:bfd1e49ce45b9a208c941e832c1d1d194017ff210a3784b0ca6c323aed767a29",
|
"image": "letta/letta@sha256:1d2e0692514287c5ed1a483e14e16ed945f8632d315539f5e66373bb7d7c471b",
|
||||||
"network": "letta",
|
"network": "letta",
|
||||||
"env-file": [
|
"env-file": [
|
||||||
"${dir:state}/server.env"
|
"/var/lib/letta/server.env"
|
||||||
],
|
],
|
||||||
"ports": [
|
"ports": [
|
||||||
"8283"
|
"8283"
|
||||||
],
|
],
|
||||||
"secrets-in-environment": "letta 0.6.x reads its settings from the environment only (pydantic settings, no secrets_dir or _FILE twin), and its startup.sh starts an embedded PostgreSQL unless LETTA_PG_URI is set - so the database password travels inside that URI (startup.sh also echoes it to the log); LETTA_SERVER_PASSWORD and OPENAI_API_KEY have no file source either"
|
"secrets-in-environment": "the letta image is env-driven and its file-source support could not be verified; the mesh runtime can take its password from config.json (client.ts) \u2014 not yet converted"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "runtime-config",
|
"id": "runtime-config",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:mesh-state}/config.json",
|
"path": "/var/lib/mesh/letta/config.json",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "{\n \"password\": \"${secret:server-password}\"\n}\n",
|
"content": "{}\n",
|
||||||
"merge": "json"
|
"merge": "json"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"id": "runtime-env",
|
||||||
|
"type": "file",
|
||||||
|
"path": "/var/lib/letta/runtime.env",
|
||||||
|
"mode": "0600",
|
||||||
|
"content": "MESH_LETTA_PASSWORD=${secret:server-password}\n"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"id": "runtime",
|
"id": "runtime",
|
||||||
"type": "container",
|
"type": "container",
|
||||||
"name": "mesh-letta",
|
"name": "mesh-letta",
|
||||||
"network": "letta",
|
"network": "letta",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/letta/broker:/run/secrets/broker:ro",
|
||||||
"${dir:mesh-state}/config.json:/run/config/config.json:ro"
|
"/var/lib/mesh/letta/config.json:/run/config/config.json:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_LETTA_URL": "http://letta:8283",
|
"MESH_LETTA_URL": "http://letta:8283",
|
||||||
"MESH_LETTA_CONFIG_FILE": "/run/config/config.json"
|
"MESH_LETTA_CONFIG_FILE": "/run/config/config.json"
|
||||||
},
|
},
|
||||||
|
"env-file": [
|
||||||
|
"/var/lib/letta/runtime.env"
|
||||||
|
],
|
||||||
"restart-on": [
|
"restart-on": [
|
||||||
"runtime-config"
|
"runtime-config"
|
||||||
],
|
],
|
||||||
"artifact": "runtime"
|
"artifact": "runtime",
|
||||||
|
"secrets-in-environment": "the letta image is env-driven and its file-source support could not be verified; the mesh runtime can take its password from config.json (client.ts) \u2014 not yet converted"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"build": {
|
"build": {
|
||||||
|
|||||||
@@ -0,0 +1,24 @@
|
|||||||
|
# lidarr's runtime: the tool runtime, carrying this module's compiled code.
|
||||||
|
#
|
||||||
|
# **Built from this module's own directory and nothing else.** The sdk and the tool runtime are in
|
||||||
|
# the base images, published like any other artifact — which is what makes this buildable by the
|
||||||
|
# mesh from a repository and a path (novox/hq ADR 0069) rather than only on a workstation that
|
||||||
|
# happens to have the siblings.
|
||||||
|
#
|
||||||
|
# Two bases, named rather than pinned (novox/hq issue 044): the image this is COMPILED in and the
|
||||||
|
# image it RUNS in — the second must not carry a compiler. Declared in module.json's `build.on`.
|
||||||
|
ARG BUILD_BASE
|
||||||
|
ARG RUNTIME_BASE
|
||||||
|
|
||||||
|
FROM ${BUILD_BASE} AS build
|
||||||
|
WORKDIR /app/modules/lidarr
|
||||||
|
COPY . .
|
||||||
|
RUN node /app/node_modules/typescript/bin/tsc client.ts index.ts tools/index.ts \
|
||||||
|
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
||||||
|
|
||||||
|
FROM ${RUNTIME_BASE}
|
||||||
|
COPY --from=build /app/modules/lidarr/dist /app/modules/lidarr/dist
|
||||||
|
# Every serve-time entrypoint, loaded by the runtime in serve mode: tools and events serve, and a
|
||||||
|
# provider's provisioner runs its reconcile loop in the same process, with the broker connected —
|
||||||
|
# the convention novox/hq issues 060/061 settled.
|
||||||
|
ENV MESH_TOOL_MODULES=/app/modules/lidarr/dist/index.js,/app/modules/lidarr/dist/tools/index.js
|
||||||
@@ -0,0 +1,144 @@
|
|||||||
|
// The Lidarr API client — lidarr's own code, living in the module (novox/hq ADR 0039). Ported from
|
||||||
|
// the shared hal `arr` client, but self-contained: in nox each Servarr app owns its own copy, so a
|
||||||
|
// change to Lidarr's API rebuilds only lidarr and nothing else. Both this module's tools and its
|
||||||
|
// events entrypoint import it, and nothing outside lidarr does.
|
||||||
|
|
||||||
|
import { existsSync, readFileSync } from "node:fs";
|
||||||
|
import { join } from "node:path";
|
||||||
|
|
||||||
|
// Lidarr speaks the v1 API (Radarr/Sonarr are v3); its content is the "artist".
|
||||||
|
const API_VERSION = "v1";
|
||||||
|
const CONTENT_ENDPOINT = "artist";
|
||||||
|
const APP_NAME = "Lidarr";
|
||||||
|
|
||||||
|
export interface LidarrQueueItem {
|
||||||
|
/** The queue record id — stable while the item is in the queue, so events can diff on it. */
|
||||||
|
id: number;
|
||||||
|
title: string;
|
||||||
|
status: string;
|
||||||
|
size: string;
|
||||||
|
sizeleft: string;
|
||||||
|
timeleft?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface LidarrCalendarItem {
|
||||||
|
title: string;
|
||||||
|
date: string;
|
||||||
|
overview?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface LidarrContentItem {
|
||||||
|
title: string;
|
||||||
|
status?: string;
|
||||||
|
monitored: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class LidarrClient {
|
||||||
|
readonly baseUrl: string;
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
url: string,
|
||||||
|
private readonly apiKey: string,
|
||||||
|
) {
|
||||||
|
this.baseUrl = url.replace(/\/$/, "");
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Build from the module's resolved environment. The URL defaults to the server on this node (the
|
||||||
|
* runtime shares its network), and the API key is read from MESH_LIDARR_API_KEY or, failing that,
|
||||||
|
* discovered from the server's own config.xml under MESH_LIDARR_CONFIG_DIR — the same file Lidarr
|
||||||
|
* writes it to, so a running server needs nothing configured by hand. Throws when no key can be
|
||||||
|
* found, so the tools/events simply do not load (the harness treats the throw as "exposes
|
||||||
|
* nothing").
|
||||||
|
*/
|
||||||
|
static fromEnv(env: NodeJS.ProcessEnv = process.env): LidarrClient {
|
||||||
|
const url = env.MESH_LIDARR_URL ?? `http://127.0.0.1:${env.MESH_LIDARR_PORT ?? "8686"}`;
|
||||||
|
const configDir = env.MESH_LIDARR_CONFIG_DIR ?? "/config";
|
||||||
|
const apiKey = env.MESH_LIDARR_API_KEY ?? LidarrClient.detectApiKey(configDir);
|
||||||
|
if (!apiKey) {
|
||||||
|
throw new Error("Lidarr not configured — set MESH_LIDARR_API_KEY or make the config dir readable");
|
||||||
|
}
|
||||||
|
return new LidarrClient(url, apiKey);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Discover the API key from the server's config.xml, falling back to null. Every Servarr app
|
||||||
|
* writes <ApiKey> into config.xml at the root of its config directory. */
|
||||||
|
static detectApiKey(configDir: string): string | null {
|
||||||
|
const config = join(configDir, "config.xml");
|
||||||
|
if (existsSync(config)) {
|
||||||
|
const match = readFileSync(config, "utf8").match(/<ApiKey>([^<]+)<\/ApiKey>/);
|
||||||
|
if (match) return match[1];
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
private async get(endpoint: string, params?: Record<string, string>): Promise<unknown> {
|
||||||
|
const url = new URL(`${this.baseUrl}/api/${API_VERSION}/${endpoint}`);
|
||||||
|
if (params) {
|
||||||
|
for (const [k, v] of Object.entries(params)) url.searchParams.set(k, v);
|
||||||
|
}
|
||||||
|
const res = await fetch(url.toString(), { headers: { "X-Api-Key": this.apiKey } });
|
||||||
|
if (!res.ok) throw new Error(`${APP_NAME} API /${endpoint}: ${res.status} ${await res.text()}`);
|
||||||
|
return res.json();
|
||||||
|
}
|
||||||
|
|
||||||
|
async getStatus(): Promise<{ appName: string; version: string }> {
|
||||||
|
const data = (await this.get("system/status")) as { appName?: string; version?: string };
|
||||||
|
return { appName: data.appName || APP_NAME, version: data.version ?? "unknown" };
|
||||||
|
}
|
||||||
|
|
||||||
|
async getContent(limit?: number): Promise<LidarrContentItem[]> {
|
||||||
|
const data = await this.get(CONTENT_ENDPOINT);
|
||||||
|
const items: any[] = Array.isArray(data) ? data : ((data as any)?.records ?? []);
|
||||||
|
const mapped = items.map((item) => ({
|
||||||
|
// Lidarr's content is an artist; its display name is artistName, not title.
|
||||||
|
title: item.artistName ?? item.title ?? "Unknown",
|
||||||
|
status: item.status,
|
||||||
|
monitored: item.monitored ?? true,
|
||||||
|
}));
|
||||||
|
return limit ? mapped.slice(0, limit) : mapped;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Library search is a filter over existing content, not an indexer lookup — same as hal's. */
|
||||||
|
async searchContent(term: string): Promise<LidarrContentItem[]> {
|
||||||
|
const all = await this.getContent();
|
||||||
|
const lower = term.toLowerCase();
|
||||||
|
return all.filter((item) => item.title.toLowerCase().includes(lower));
|
||||||
|
}
|
||||||
|
|
||||||
|
async getQueue(): Promise<{ totalRecords: number; items: LidarrQueueItem[] }> {
|
||||||
|
const data = (await this.get("queue", { pageSize: "50" })) as { totalRecords?: number; records?: any[] };
|
||||||
|
const records = data.records ?? [];
|
||||||
|
return {
|
||||||
|
totalRecords: data.totalRecords ?? records.length,
|
||||||
|
items: records.map((r) => ({
|
||||||
|
id: r.id,
|
||||||
|
title: r.title ?? r.artist?.artistName ?? r.album?.title ?? "Unknown",
|
||||||
|
status: r.status ?? "unknown",
|
||||||
|
size: formatBytes(r.size ?? 0),
|
||||||
|
sizeleft: formatBytes(r.sizeleft ?? 0),
|
||||||
|
timeleft: r.timeleft,
|
||||||
|
})),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async getCalendar(days = 7): Promise<LidarrCalendarItem[]> {
|
||||||
|
const start = new Date().toISOString().split("T")[0];
|
||||||
|
const end = new Date(Date.now() + days * 86400000).toISOString().split("T")[0];
|
||||||
|
const data = await this.get("calendar", { start, end });
|
||||||
|
const items: any[] = Array.isArray(data) ? data : [];
|
||||||
|
return items.map((item) => ({
|
||||||
|
// A Lidarr calendar entry is an album release.
|
||||||
|
title: item.title ?? item.artist?.artistName ?? "Unknown",
|
||||||
|
date: item.releaseDate ?? "",
|
||||||
|
overview: item.overview?.slice(0, 150),
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function formatBytes(bytes: number): string {
|
||||||
|
if (bytes === 0) return "0 B";
|
||||||
|
const units = ["B", "KB", "MB", "GB", "TB"];
|
||||||
|
const i = Math.floor(Math.log(bytes) / Math.log(1024));
|
||||||
|
return `${(bytes / Math.pow(1024, i)).toFixed(1)} ${units[i]}`;
|
||||||
|
}
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
// lidarr's events. The tool runtime imports this once the broker is bound. It watches the download
|
||||||
|
// queue and turns its comings and goings into mesh events.
|
||||||
|
//
|
||||||
|
// Emits (novox/hq ADR 0041/0042):
|
||||||
|
// module.lidarr.album.grabbed — a release entered the queue (Lidarr grabbed it)
|
||||||
|
// module.lidarr.download.completed — a release left the queue, imported. The download.completed
|
||||||
|
// routing key matches what a media consumer subscribes to
|
||||||
|
// (module.*.download.completed) to rescan its library.
|
||||||
|
// Consumes: none.
|
||||||
|
//
|
||||||
|
// The queue is polled and diffed, primed silently on the first look (like plex's index.ts) so a
|
||||||
|
// restart mid-download does not re-announce everything already in flight as freshly grabbed.
|
||||||
|
|
||||||
|
import { emit } from "@novox/mesh-sdk/events";
|
||||||
|
import { LidarrClient, type LidarrQueueItem } from "./client.js";
|
||||||
|
|
||||||
|
// Building the client throws when Lidarr has no URL/key yet. Like the tools (see tools/index.ts),
|
||||||
|
// the events entrypoint must not crash the runtime for that — it stays idle until configured.
|
||||||
|
function buildClient(): LidarrClient | null {
|
||||||
|
try {
|
||||||
|
return LidarrClient.fromEnv();
|
||||||
|
} catch {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const lidarr = buildClient();
|
||||||
|
|
||||||
|
// Lidarr removes an item from the queue once it has been imported; a "warning"/"failed" status is
|
||||||
|
// how a stuck or broken grab shows itself, so we do not call those a completion when they vanish.
|
||||||
|
const FAILED_STATUSES = new Set(["failed", "warning"]);
|
||||||
|
|
||||||
|
const inQueue = new Map<number, LidarrQueueItem>();
|
||||||
|
let primed = false;
|
||||||
|
|
||||||
|
async function pollQueue(lidarr: LidarrClient): Promise<void> {
|
||||||
|
const { items } = await lidarr.getQueue();
|
||||||
|
const now = new Map(items.map((i) => [i.id, i]));
|
||||||
|
|
||||||
|
if (primed) {
|
||||||
|
// Entered the queue since last look — Lidarr grabbed a release.
|
||||||
|
for (const [id, item] of now) {
|
||||||
|
if (!inQueue.has(id)) await emit("album.grabbed", { title: item.title, status: item.status });
|
||||||
|
}
|
||||||
|
// Left the queue — imported and done, unless it was last seen failing.
|
||||||
|
for (const [id, item] of inQueue) {
|
||||||
|
if (!now.has(id) && !FAILED_STATUSES.has(item.status)) {
|
||||||
|
await emit("download.completed", { title: item.title });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
inQueue.clear();
|
||||||
|
for (const [id, item] of now) inQueue.set(id, item);
|
||||||
|
primed = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
const tick = (fn: () => Promise<void>, everyMs: number): void => {
|
||||||
|
const run = (): void => void fn().catch((err) => console.error(`[lidarr] ${err}`));
|
||||||
|
setInterval(run, everyMs);
|
||||||
|
run();
|
||||||
|
};
|
||||||
|
|
||||||
|
if (lidarr) {
|
||||||
|
tick(() => pollQueue(lidarr), 30_000);
|
||||||
|
console.log("[lidarr] watching the download queue, emitting grabs and completions");
|
||||||
|
} else {
|
||||||
|
console.log("[lidarr] not configured — events idle until an API key is available");
|
||||||
|
}
|
||||||
@@ -0,0 +1,130 @@
|
|||||||
|
{
|
||||||
|
"module": "lidarr",
|
||||||
|
"version": "1",
|
||||||
|
"provides": [
|
||||||
|
{
|
||||||
|
"name": "lidarr-api",
|
||||||
|
"scope": "mesh"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"serves": {
|
||||||
|
"lidarr-api": {
|
||||||
|
"scheme": "http",
|
||||||
|
"port": 8686,
|
||||||
|
"url-base": ""
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"capabilities": [
|
||||||
|
"container-runtime"
|
||||||
|
],
|
||||||
|
"emits": [
|
||||||
|
"album.grabbed",
|
||||||
|
"download.completed"
|
||||||
|
],
|
||||||
|
"consumes": [],
|
||||||
|
"own-secrets": {
|
||||||
|
"broker": "/var/lib/mesh/lidarr/broker"
|
||||||
|
},
|
||||||
|
"listens": [
|
||||||
|
{
|
||||||
|
"name": "web",
|
||||||
|
"port": 8686,
|
||||||
|
"protocol": "tcp",
|
||||||
|
"from": "mesh",
|
||||||
|
"why": "managing music"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"accesses": [
|
||||||
|
{
|
||||||
|
"path": "/services/media/music",
|
||||||
|
"mode": "read-write"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"path": "/services/media/downloads",
|
||||||
|
"mode": "read-write"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"resources": [
|
||||||
|
{
|
||||||
|
"id": "mesh-state",
|
||||||
|
"type": "directory",
|
||||||
|
"path": "/var/lib/mesh/lidarr",
|
||||||
|
"mode": "0700"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "config",
|
||||||
|
"type": "directory",
|
||||||
|
"path": "/services/lidarr/config",
|
||||||
|
"mode": "0700",
|
||||||
|
"owner": "1000:1000"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "server",
|
||||||
|
"type": "container",
|
||||||
|
"name": "lidarr",
|
||||||
|
"image": "lscr.io/linuxserver/lidarr@sha256:6b38dd330b0c653351c2e23c8b962ea51c95683dd7acace9d106c922baf85f75",
|
||||||
|
"env": {
|
||||||
|
"PUID": "1000",
|
||||||
|
"PGID": "1000",
|
||||||
|
"TZ": "Etc/UTC"
|
||||||
|
},
|
||||||
|
"ports": [
|
||||||
|
"8686"
|
||||||
|
],
|
||||||
|
"volumes": [
|
||||||
|
"/services/lidarr/config:/config",
|
||||||
|
"/services/media/music:/music",
|
||||||
|
"/services/media/downloads:/downloads"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "runtime",
|
||||||
|
"type": "container",
|
||||||
|
"name": "mesh-lidarr",
|
||||||
|
"network": "host",
|
||||||
|
"volumes": [
|
||||||
|
"/var/lib/mesh/lidarr/broker:/run/secrets/broker:ro",
|
||||||
|
"/services/lidarr/config:/var/lib/lidarr/config:ro"
|
||||||
|
],
|
||||||
|
"env": {
|
||||||
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
|
"MESH_LIDARR_URL": "http://127.0.0.1:${port:8686}",
|
||||||
|
"MESH_LIDARR_CONFIG_DIR": "/var/lib/lidarr/config"
|
||||||
|
},
|
||||||
|
"artifact": "runtime"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"requires": [
|
||||||
|
"route"
|
||||||
|
],
|
||||||
|
"contributes": {
|
||||||
|
"route": {
|
||||||
|
"label": "lidarr",
|
||||||
|
"endpoint": "web"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"binds": {
|
||||||
|
"route": "/var/lib/mesh/lidarr/route.json"
|
||||||
|
},
|
||||||
|
"build": {
|
||||||
|
"on": [
|
||||||
|
{
|
||||||
|
"arg": "BUILD_BASE",
|
||||||
|
"module": "mesh-tools",
|
||||||
|
"artifact": "build"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"arg": "RUNTIME_BASE",
|
||||||
|
"module": "mesh-tools",
|
||||||
|
"artifact": "runtime"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"artifacts": [
|
||||||
|
{
|
||||||
|
"name": "runtime",
|
||||||
|
"kind": "image",
|
||||||
|
"from": "Dockerfile"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
{
|
||||||
|
"name": "@novox/module-lidarr",
|
||||||
|
"version": "0.1.0",
|
||||||
|
"description": "lidarr — music management. Its API client, tools and events live here (novox/hq ADR 0039).",
|
||||||
|
"type": "module",
|
||||||
|
"private": true,
|
||||||
|
"dependencies": {
|
||||||
|
"@novox/mesh-sdk": "^0.1.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/node": "^22.0.0",
|
||||||
|
"typescript": "^5.6.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,78 @@
|
|||||||
|
// lidarr's tools — ported from the shared hal sdk (novox/hq ADR 0039), importing lidarr's own
|
||||||
|
// client. They return structured data (not pre-formatted text as hal did); the mesh serves them
|
||||||
|
// through the sdk's tool harness.
|
||||||
|
|
||||||
|
import { registerModuleTools, type ToolDefinition } from "@novox/mesh-sdk/tools";
|
||||||
|
import { LidarrClient } from "../client.js";
|
||||||
|
|
||||||
|
export function getLidarrTools(lidarr: LidarrClient): ToolDefinition[] {
|
||||||
|
return [
|
||||||
|
{
|
||||||
|
name: "lidarr_status",
|
||||||
|
description: "Lidarr status overview: version, artist count, monitored count, queue size.",
|
||||||
|
input: {},
|
||||||
|
run: async () => {
|
||||||
|
const [status, content, queue] = await Promise.all([
|
||||||
|
lidarr.getStatus(),
|
||||||
|
lidarr.getContent(),
|
||||||
|
lidarr.getQueue(),
|
||||||
|
]);
|
||||||
|
return {
|
||||||
|
app: status.appName,
|
||||||
|
version: status.version,
|
||||||
|
artists: content.length,
|
||||||
|
monitored: content.filter((c) => c.monitored).length,
|
||||||
|
queue: queue.totalRecords,
|
||||||
|
};
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "lidarr_library",
|
||||||
|
description: "List artists from the Lidarr library.",
|
||||||
|
input: { limit: { type: "number", description: "max items to return (default 50)" } },
|
||||||
|
run: async (args) => {
|
||||||
|
const items = await lidarr.getContent(args.limit ? Number(args.limit) : 50);
|
||||||
|
return { count: items.length, artists: items };
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "lidarr_search",
|
||||||
|
description: "Search the Lidarr library for artists by name (filters existing content, not indexers).",
|
||||||
|
input: { query: { type: "string", description: "the search term" } },
|
||||||
|
run: async (args) => {
|
||||||
|
const query = String(args.query);
|
||||||
|
return { query, results: await lidarr.searchContent(query) };
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "lidarr_queue",
|
||||||
|
description: "Show the Lidarr download queue — what is downloading and how far along.",
|
||||||
|
input: {},
|
||||||
|
run: async () => {
|
||||||
|
const queue = await lidarr.getQueue();
|
||||||
|
return { count: queue.totalRecords, items: queue.items };
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "lidarr_calendar",
|
||||||
|
description: "Upcoming album releases from the Lidarr calendar.",
|
||||||
|
input: { days: { type: "number", description: "how many days to look ahead (default 7)" } },
|
||||||
|
run: async (args) => {
|
||||||
|
const days = args.days ? Number(args.days) : 7;
|
||||||
|
const items = await lidarr.getCalendar(days);
|
||||||
|
items.sort((a, b) => a.date.localeCompare(b.date));
|
||||||
|
return { days, count: items.length, items };
|
||||||
|
},
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
// The tools exist only when Lidarr is configured; without a URL and key, lidarr contributes none
|
||||||
|
// rather than failing the whole runtime.
|
||||||
|
registerModuleTools("lidarr", (env) => {
|
||||||
|
try {
|
||||||
|
return getLidarrTools(LidarrClient.fromEnv(env));
|
||||||
|
} catch {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
});
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "ES2022",
|
||||||
|
"module": "NodeNext",
|
||||||
|
"moduleResolution": "NodeNext",
|
||||||
|
"strict": true,
|
||||||
|
"esModuleInterop": true,
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"noEmit": true
|
||||||
|
},
|
||||||
|
"include": ["client.ts", "index.ts", "tools/index.ts"]
|
||||||
|
}
|
||||||
@@ -6,24 +6,25 @@
|
|||||||
"model-access"
|
"model-access"
|
||||||
],
|
],
|
||||||
"binds": {
|
"binds": {
|
||||||
"model-access": "${dir:state}/model.json"
|
"model-access": "/var/lib/local-model-consumer/model.json"
|
||||||
},
|
},
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/local-model-consumer",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "config",
|
"id": "config",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/var/lib/local-model-consumer/config",
|
||||||
"mode": "0700"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "openai-env",
|
"id": "openai-env",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:config}/openai.env",
|
"path": "/var/lib/local-model-consumer/config/openai.env",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "OPENAI_BASE_URL=http://${bound:model-access:at}:${bound:model-access:port}/v1\nOPENAI_MODEL=${bound:model-access:model}\nOPENAI_API_KEY=local\n"
|
"content": "OPENAI_BASE_URL=http://${bound:model-access:at}:${bound:model-access:port}/v1\nOPENAI_MODEL=${bound:model-access:model}\nOPENAI_API_KEY=local\n"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,17 +0,0 @@
|
|||||||
# mailu
|
|
||||||
|
|
||||||
Mail — Mailu, with its provisioner (the `smtp` provision) and tools, on the tool runtime.
|
|
||||||
|
|
||||||
## Settings
|
|
||||||
|
|
||||||
A definition names no mesh (novox/hq ADR 0112, ADR 0155), so the values that are this
|
|
||||||
installation's are settings on the assignment, `settings set mailu <file>`:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{"domain": "…", "sitename": "…", "website": "https://…", "proxy-address": "…"}
|
|
||||||
```
|
|
||||||
|
|
||||||
`domain` is the mail domain (also the provisioner's, for a consumer's address); `sitename` and
|
|
||||||
`website` are shown by the web front; `proxy-address` is what `REAL_IP_FROM` trusts a real-IP
|
|
||||||
header from — the address the proxy forwards with. The front's own hostname is the name of its
|
|
||||||
`web` route, told to it by the mesh.
|
|
||||||
+17
-12
@@ -120,32 +120,32 @@
|
|||||||
"port": 7080,
|
"port": 7080,
|
||||||
"protocol": "tcp",
|
"protocol": "tcp",
|
||||||
"from": "mesh",
|
"from": "mesh",
|
||||||
"why": "the web front over http; only the ACME HTTP-01 passthrough is routed here — everything else 301s to https and would loop a proxy"
|
"why": "the web front over http; only the ACME HTTP-01 passthrough is routed here \u2014 everything else 301s to https and would loop a proxy"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "web-tls",
|
"name": "web-tls",
|
||||||
"port": 7443,
|
"port": 7443,
|
||||||
"protocol": "tcp",
|
"protocol": "tcp",
|
||||||
"from": "mesh",
|
"from": "mesh",
|
||||||
"why": "the web front over its own TLS (admin, webmail, API); its public name is a route grant reaching it here"
|
"why": "the web front over its own TLS (admin, webmail, API); the public name mail.novox.be is a route grant reaching it here"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"name": "autoconfig",
|
"name": "autoconfig",
|
||||||
"port": 4243,
|
"port": 4243,
|
||||||
"protocol": "tcp",
|
"protocol": "tcp",
|
||||||
"from": "mesh",
|
"from": "mesh",
|
||||||
"why": "automx: mail client autoconfiguration; the autoconfig, autodiscover and automx names are route grants reaching it here"
|
"why": "automx: mail client autoconfiguration; autoconfig/autodiscover/automx.novox.be are route grants reaching it here"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/mailu/broker"
|
||||||
},
|
},
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/mailu",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
@@ -168,7 +168,7 @@
|
|||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/mailu.env",
|
"path": "${dir:state}/mailu.env",
|
||||||
"mode": "0644",
|
"mode": "0644",
|
||||||
"content": "ADMIN_ADDRESS=mailu-admin\nANTISPAM_ADDRESS=mailu-antispam\nANTIVIRUS_ADDRESS=mailu-antivirus\nIMAP_ADDRESS=mailu-imap\nSMTP_ADDRESS=mailu-smtp\nFRONT_ADDRESS=mailu-front\nWEBMAIL_ADDRESS=mailu-webmail\nWEBDAV_ADDRESS=mailu-webdav\nREDIS_ADDRESS=mailu-redis\nPORTS=25,80,443,465,993,995,4190,110,143,587\nDOMAIN=${setting:domain}\nHOSTNAMES=${bound:route:name-web}\nPOSTMASTER=admin\nSITENAME=${setting:sitename}\nWEBSITE=${setting:website}\nTLS_FLAVOR=letsencrypt\nSUBNET=192.168.203.0/24\nCOMPOSE_PROJECT_NAME=mailu\nANTIVIRUS=clamav\nWEBMAIL=roundcube\nWEBDAV=radicale\nFETCHMAIL_ENABLED=True\nFETCHMAIL_DELAY=600\nADMIN=true\nWEB_ADMIN=/admin\nWEB_WEBMAIL=/webmail\nWEBROOT_REDIRECT=/webmail\nAPI=true\nWEB_API=/api\nAUTH_RATELIMIT_IP=6000/hour\nAUTH_RATELIMIT_USER=1000/day\nCREDENTIAL_ROUNDS=12\nPASSWORD_SCHEME=PBKDF2\nDISABLE_STATISTICS=True\nMESSAGE_SIZE_LIMIT=50000000\nMESSAGE_RATELIMIT=200/day\nRECIPIENT_DELIMITER=+\nPOSTFIX_MYNETWORKS=127.0.0.0/8 [::1]/128\nRELAYNETS=\nRELAYHOST=\nREJECT_UNLISTED_RECIPIENT=\nDB_FLAVOR=postgresql\nINITIAL_ADMIN_ACCOUNT=admin\nINITIAL_ADMIN_DOMAIN=${setting:domain}\nINITIAL_ADMIN_MODE=ifmissing\nSMTP_PORT=25\nSMTPS_PORT=465\nSUBMISSION_PORT=587\nPOP3_PORT=110\nPOP3S_PORT=995\nIMAP_PORT=143\nIMAPS_PORT=993\nHTTP_PORT=7080\nHTTPS_PORT=7443\nAUTOMX_PORT=4243\nAMX_SMTP_ADDRESS=${bound:route:name-web}\nAMX_SMTP_PORT=587\nAMX_IMAP_ADDRESS=${bound:route:name-web}\nAMX_IMAP_PORT=143\nAMX_MAIL_DOMAINS=${setting:domain}\nDMARC_RUA=admin\nDMARC_RUF=admin\nLETSENCRYPT_SHORTCHAIN=True\nTZ=Etc/UTC\nLOG_LEVEL=INFO\nWELCOME=false\nREAL_IP_HEADER=X-Real-IP\nREAL_IP_FROM=${setting:proxy-address}\nCOMPRESSION=\nCOMPRESS_LEVEL=\nCOMPRESSION_LEVEL=\nBIND_ADDRESS4=127.0.0.1\nBIND_ADDRESS6=::1\nMAILU_VERSION=1.9\nDOCKER_ORG=mailu\nDOCKER_PREFIX=\nWELCOME_SUBJECT=Welcome to your new email account\nWELCOME_BODY=Welcome to your new email account, if you can read this, then it is configured properly!\n"
|
"content": "ADMIN_ADDRESS=mailu-admin\nANTISPAM_ADDRESS=mailu-antispam\nANTIVIRUS_ADDRESS=mailu-antivirus\nIMAP_ADDRESS=mailu-imap\nSMTP_ADDRESS=mailu-smtp\nFRONT_ADDRESS=mailu-front\nWEBMAIL_ADDRESS=mailu-webmail\nWEBDAV_ADDRESS=mailu-webdav\nREDIS_ADDRESS=mailu-redis\nPORTS=25,80,443,465,993,995,4190,110,143,587\nDOMAIN=novox.be\nHOSTNAMES=mail.novox.be\nPOSTMASTER=admin\nSITENAME=Novox\nWEBSITE=https://novox.be\nTLS_FLAVOR=letsencrypt\nSUBNET=192.168.203.0/24\nCOMPOSE_PROJECT_NAME=mailu\nANTIVIRUS=clamav\nWEBMAIL=roundcube\nWEBDAV=radicale\nFETCHMAIL_ENABLED=True\nFETCHMAIL_DELAY=600\nADMIN=true\nWEB_ADMIN=/admin\nWEB_WEBMAIL=/webmail\nWEBROOT_REDIRECT=/webmail\nAPI=true\nWEB_API=/api\nAUTH_RATELIMIT_IP=6000/hour\nAUTH_RATELIMIT_USER=1000/day\nCREDENTIAL_ROUNDS=12\nPASSWORD_SCHEME=PBKDF2\nDISABLE_STATISTICS=True\nMESSAGE_SIZE_LIMIT=50000000\nMESSAGE_RATELIMIT=200/day\nRECIPIENT_DELIMITER=+\nPOSTFIX_MYNETWORKS=127.0.0.0/8 [::1]/128\nRELAYNETS=\nRELAYHOST=\nREJECT_UNLISTED_RECIPIENT=\nDB_FLAVOR=postgresql\nINITIAL_ADMIN_ACCOUNT=admin\nINITIAL_ADMIN_DOMAIN=novox.be\nINITIAL_ADMIN_MODE=ifmissing\nSMTP_PORT=25\nSMTPS_PORT=465\nSUBMISSION_PORT=587\nPOP3_PORT=110\nPOP3S_PORT=995\nIMAP_PORT=143\nIMAPS_PORT=993\nHTTP_PORT=7080\nHTTPS_PORT=7443\nAUTOMX_PORT=4243\nAMX_SMTP_ADDRESS=mail.novox.be\nAMX_SMTP_PORT=587\nAMX_IMAP_ADDRESS=mail.novox.be\nAMX_IMAP_PORT=143\nAMX_MAIL_DOMAINS=novox.be\nDMARC_RUA=admin\nDMARC_RUF=admin\nLETSENCRYPT_SHORTCHAIN=True\nTZ=Etc/UTC\nLOG_LEVEL=INFO\nWELCOME=false\nREAL_IP_HEADER=X-Real-IP\nREAL_IP_FROM=142.132.152.141\nCOMPRESSION=\nCOMPRESS_LEVEL=\nCOMPRESSION_LEVEL=\nBIND_ADDRESS4=127.0.0.1\nBIND_ADDRESS6=::1\nMAILU_VERSION=1.9\nDOCKER_ORG=mailu\nDOCKER_PREFIX=\nWELCOME_SUBJECT=Welcome to your new email account\nWELCOME_BODY=Welcome to your new email account, if you can read this, then it is configured properly!\n"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "secret-env",
|
"id": "secret-env",
|
||||||
@@ -315,7 +315,10 @@
|
|||||||
"${dir:data-data}:/data",
|
"${dir:data-data}:/data",
|
||||||
"${dir:data-dkim}:/dkim"
|
"${dir:data-dkim}:/dkim"
|
||||||
],
|
],
|
||||||
"secrets-in-environment": "mailu-admin honours SECRET_KEY_FILE, DB_PW_FILE and API_TOKEN_FILE (configuration.py) but INITIAL_ADMIN_PW is env-only (start.py); the remaining containers' need for SECRET_KEY is unverified"
|
"secrets-in-environment": "mailu-admin honours SECRET_KEY_FILE, DB_PW_FILE and API_TOKEN_FILE (configuration.py) but INITIAL_ADMIN_PW is env-only (start.py); the remaining containers' need for SECRET_KEY is unverified",
|
||||||
|
"dns": [
|
||||||
|
"192.168.203.254"
|
||||||
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "imap",
|
"id": "imap",
|
||||||
@@ -467,7 +470,7 @@
|
|||||||
{
|
{
|
||||||
"id": "runtime-config",
|
"id": "runtime-config",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:mesh-state}/config.json",
|
"path": "/var/lib/mesh/mailu/config.json",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "{}\n",
|
"content": "{}\n",
|
||||||
"merge": "json"
|
"merge": "json"
|
||||||
@@ -478,10 +481,10 @@
|
|||||||
"name": "mesh-mailu",
|
"name": "mesh-mailu",
|
||||||
"network": "mailu",
|
"network": "mailu",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/mailu/broker:/run/secrets/broker:ro",
|
||||||
"${dir:state}/api-token.secret:/run/secrets/api-token:ro",
|
"${dir:state}/api-token.secret:/run/secrets/api-token:ro",
|
||||||
"${dir:grants}:${dir:grants}:ro",
|
"${dir:grants}:${dir:grants}:ro",
|
||||||
"${dir:mesh-state}/config.json:/run/config/config.json:ro",
|
"/var/lib/mesh/mailu/config.json:/run/config/config.json:ro",
|
||||||
"/var/run/docker.sock:/var/run/docker.sock"
|
"/var/run/docker.sock:/var/run/docker.sock"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
@@ -490,6 +493,7 @@
|
|||||||
"MESH_MAILU_API_KEY_FILE": "/run/secrets/api-token",
|
"MESH_MAILU_API_KEY_FILE": "/run/secrets/api-token",
|
||||||
"MESH_MAILU_IMAP_CONTAINER": "mailu-imap",
|
"MESH_MAILU_IMAP_CONTAINER": "mailu-imap",
|
||||||
"MESH_MAILU_CONFIG_FILE": "/run/config/config.json",
|
"MESH_MAILU_CONFIG_FILE": "/run/config/config.json",
|
||||||
|
"MESH_MAILU_DOMAIN": "novox.be",
|
||||||
"MESH_RECEIVES": "${dir:grants}/mesh.json"
|
"MESH_RECEIVES": "${dir:grants}/mesh.json"
|
||||||
},
|
},
|
||||||
"restart-on": [
|
"restart-on": [
|
||||||
@@ -553,7 +557,8 @@
|
|||||||
"serves": {
|
"serves": {
|
||||||
"smtp": {
|
"smtp": {
|
||||||
"port": 587,
|
"port": 587,
|
||||||
"domain": "${setting:domain}"
|
"domain": "novox.be",
|
||||||
|
"name": "mail.novox.be"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"receives": {
|
"receives": {
|
||||||
|
|||||||
@@ -13,32 +13,17 @@
|
|||||||
// it to both ends; mailu sets exactly that password every run — so a rotation takes — and seals
|
// it to both ends; mailu sets exactly that password every run — so a rotation takes — and seals
|
||||||
// nothing: the consumer already has its copy through the mesh's own channel.
|
// nothing: the consumer already has its copy through the mesh's own channel.
|
||||||
|
|
||||||
import { readFileSync } from "node:fs";
|
|
||||||
import { runProvisioner, type Provision } from "@novox/mesh-sdk/provisioner";
|
import { runProvisioner, type Provision } from "@novox/mesh-sdk/provisioner";
|
||||||
import { MailuClient } from "../client.js";
|
import { MailuClient } from "../client.js";
|
||||||
|
|
||||||
const mailu = MailuClient.fromEnv();
|
const mailu = MailuClient.fromEnv();
|
||||||
|
|
||||||
// The mail server's own domain: the operator's value, from the settings the mesh merges into this
|
// The mail server's own domain. From the environment the manifest composes, because the client's
|
||||||
// module's config file (`settings set mailu` with {"domain": …}; novox/hq ADR 0112, ADR 0155). A
|
// config file carries the admin API's coordinates, not the mail domain.
|
||||||
// definition names no mesh, so it is never a literal in the manifest — and it used to be, as
|
|
||||||
// MESH_MAILU_DOMAIN, which is still read for a mesh that has not re-registered the manifest.
|
|
||||||
function domain(): string {
|
function domain(): string {
|
||||||
const file = process.env.MESH_MAILU_CONFIG_FILE;
|
|
||||||
if (file) {
|
|
||||||
try {
|
|
||||||
const config = JSON.parse(readFileSync(file, "utf8")) as { domain?: unknown };
|
|
||||||
if (typeof config.domain === "string" && config.domain.trim() !== "") return config.domain.trim();
|
|
||||||
} catch {
|
|
||||||
// Unreadable or not JSON: fall through to the environment, and the error below names both.
|
|
||||||
}
|
|
||||||
}
|
|
||||||
const named = (process.env.MESH_MAILU_DOMAIN ?? "").trim();
|
const named = (process.env.MESH_MAILU_DOMAIN ?? "").trim();
|
||||||
if (named === "") {
|
if (named === "") {
|
||||||
throw new Error(
|
throw new Error("MESH_MAILU_DOMAIN is not set, so a consumer's address cannot be composed");
|
||||||
"no mail domain is set, so a consumer's address cannot be composed — `settings set mailu <file>` " +
|
|
||||||
'with {"domain": "<the mail domain>"}',
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
return named;
|
return named;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -17,8 +17,8 @@
|
|||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/marrytts",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "server",
|
"id": "server",
|
||||||
|
|||||||
@@ -1,125 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "matrix",
|
|
||||||
"version": "1",
|
|
||||||
"capabilities": [
|
|
||||||
"container-runtime"
|
|
||||||
],
|
|
||||||
"listens": [
|
|
||||||
{
|
|
||||||
"name": "client",
|
|
||||||
"port": 6167,
|
|
||||||
"protocol": "tcp",
|
|
||||||
"from": "mesh",
|
|
||||||
"why": "Conduit's client-server and federation APIs over plain HTTP. Both arrive through the route on 443: Conduit answers /.well-known/matrix/server with <its name>:443, so other homeservers federate through the proxy and nothing needs the traditional 8448"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "web",
|
|
||||||
"port": 80,
|
|
||||||
"protocol": "tcp",
|
|
||||||
"from": "mesh",
|
|
||||||
"why": "Element Web, the static browser client, served by the image's nginx; reached through its route"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"requires": [
|
|
||||||
"route"
|
|
||||||
],
|
|
||||||
"contributes": {
|
|
||||||
"route": {
|
|
||||||
"homeserver": {
|
|
||||||
"label": "matrix",
|
|
||||||
"endpoint": "client"
|
|
||||||
},
|
|
||||||
"element": {
|
|
||||||
"label": "element",
|
|
||||||
"endpoint": "web"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"binds": {
|
|
||||||
"route": "${dir:state}/route.json"
|
|
||||||
},
|
|
||||||
"resources": [
|
|
||||||
{
|
|
||||||
"id": "state",
|
|
||||||
"type": "directory",
|
|
||||||
"mode": "0700",
|
|
||||||
"place": "."
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "db",
|
|
||||||
"type": "directory",
|
|
||||||
"mode": "0700"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "conduit-conf",
|
|
||||||
"type": "file",
|
|
||||||
"path": "${dir:state}/conduit.toml",
|
|
||||||
"mode": "0644",
|
|
||||||
"content": "# Written by the mesh (modules/matrix). Conduit reads this file (CONDUIT_CONFIG); nothing comes\n# from the environment. server_name is the homeserver's permanent identity: every user id, room id\n# and signature in the database carries it, so it is the name this module is served under\n# (${bound:route:name-homeserver}) and never changes once a database exists.\n[global]\nserver_name = \"${bound:route:name-homeserver}\"\ndatabase_backend = \"rocksdb\"\ndatabase_path = \"/var/lib/matrix-conduit/\"\naddress = \"0.0.0.0\"\nport = 6167\nmax_request_size = 20000000\nallow_registration = false\nallow_federation = true\nallow_check_for_updates = true\ntrusted_servers = [\"matrix.org\"]\n",
|
|
||||||
"names-on-purpose": {
|
|
||||||
"matrix.org": "the federation's public key server, trusted by default; the world's, not this mesh's"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "element-conf",
|
|
||||||
"type": "file",
|
|
||||||
"path": "${dir:state}/element.json",
|
|
||||||
"mode": "0644",
|
|
||||||
"merge": "json",
|
|
||||||
"content": "{\n \"default_server_name\": \"${bound:route:name-homeserver}\",\n \"default_server_config\": {\n \"m.homeserver\": {\n \"base_url\": \"https://${bound:route:name-homeserver}\"\n },\n \"m.identity_server\": {\n \"base_url\": \"https://vector.im\"\n }\n },\n \"brand\": \"Element\",\n \"integrations_ui_url\": \"https://scalar.vector.im/\",\n \"integrations_rest_url\": \"https://scalar.vector.im/api\",\n \"integrations_widgets_urls\": [\n \"https://scalar.vector.im/_matrix/integrations/v1\",\n \"https://scalar.vector.im/api\",\n \"https://scalar-staging.vector.im/_matrix/integrations/v1\",\n \"https://scalar-staging.vector.im/api\",\n \"https://scalar-staging.riot.im/scalar/api\"\n ],\n \"bug_report_endpoint_url\": \"https://element.io/bugreports/submit\",\n \"uisi_autorageshake_app\": \"element-auto-uisi\",\n \"show_labs_settings\": true,\n \"room_directory\": {\n \"servers\": [\n \"${bound:route:name-homeserver}\",\n \"matrix.org\",\n \"gitter.im\",\n \"libera.chat\"\n ]\n },\n \"enable_presence_by_hs_url\": {\n \"https://matrix.org\": false,\n \"https://matrix-client.matrix.org\": false\n },\n \"terms_and_conditions_links\": [\n {\n \"url\": \"https://element.io/privacy\",\n \"text\": \"Privacy Policy\"\n },\n {\n \"url\": \"https://element.io/cookie-policy\",\n \"text\": \"Cookie Policy\"\n }\n ],\n \"features\": {\n \"feature_video_rooms\": true,\n \"feature_rust_crypto\": true\n },\n \"element_call\": {\n \"url\": \"https://call.element.dev\"\n }\n}\n",
|
|
||||||
"names-on-purpose": {
|
|
||||||
"matrix.org": "the public room directory and the federation's largest homeserver; the world's",
|
|
||||||
"matrix-client.matrix.org": "the same homeserver's client endpoint; the world's",
|
|
||||||
"vector.im": "Element's public identity server; the world's",
|
|
||||||
"scalar.vector.im": "Element's public integration manager; the world's",
|
|
||||||
"scalar-staging.vector.im": "Element's staging integration manager, named by the upstream default config; the world's",
|
|
||||||
"scalar-staging.riot.im": "the same, under its former name; the world's",
|
|
||||||
"element.io": "Element's bug reports, privacy and cookie pages; the world's",
|
|
||||||
"gitter.im": "a public room directory; the world's",
|
|
||||||
"libera.chat": "a public room directory; the world's",
|
|
||||||
"call.element.dev": "Element Call's public instance; the world's"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "net",
|
|
||||||
"type": "network",
|
|
||||||
"name": "matrix"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "homeserver",
|
|
||||||
"type": "container",
|
|
||||||
"name": "matrix",
|
|
||||||
"image": "matrixconduit/matrix-conduit@sha256:b0d24248e94f944ca49f90f10c429e3d65f4472bdde25661ecea9840134fb133",
|
|
||||||
"network": "matrix",
|
|
||||||
"env": {
|
|
||||||
"CONDUIT_CONFIG": "/etc/conduit/conduit.toml"
|
|
||||||
},
|
|
||||||
"ports": [
|
|
||||||
"6167"
|
|
||||||
],
|
|
||||||
"volumes": [
|
|
||||||
"${dir:db}:/var/lib/matrix-conduit",
|
|
||||||
"${dir:state}/conduit.toml:/etc/conduit/conduit.toml:ro"
|
|
||||||
],
|
|
||||||
"restart-on": [
|
|
||||||
"conduit-conf"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "element",
|
|
||||||
"type": "container",
|
|
||||||
"name": "element-web",
|
|
||||||
"image": "vectorim/element-web@sha256:a8f415462ab8d2600a592ba1b92bea51efe5a4d10eb738aab9bed769f7099613",
|
|
||||||
"network": "matrix",
|
|
||||||
"ports": [
|
|
||||||
"80"
|
|
||||||
],
|
|
||||||
"volumes": [
|
|
||||||
"${dir:state}/element.json:/app/config.json:ro"
|
|
||||||
],
|
|
||||||
"restart-on": [
|
|
||||||
"element-conf"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -20,13 +20,13 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"binds": {
|
"binds": {
|
||||||
"postgres-database": "${dir:state}/database.json"
|
"postgres-database": "/var/lib/mesh-catalog/database.json"
|
||||||
},
|
},
|
||||||
"secrets": {
|
"secrets": {
|
||||||
"postgres-database": "${dir:state}/database.secret"
|
"postgres-database": "/var/lib/mesh-catalog/database.secret"
|
||||||
},
|
},
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/mesh-catalog/broker"
|
||||||
},
|
},
|
||||||
"consumes": [
|
"consumes": [
|
||||||
"mesh-build-machine.built",
|
"mesh-build-machine.built",
|
||||||
@@ -43,19 +43,19 @@
|
|||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/mesh-catalog",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh-catalog",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "database-url",
|
"id": "database-url",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/database.url",
|
"path": "/var/lib/mesh-catalog/database.url",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "postgresql://${bound:postgres-database:as}:${secret:postgres-database}@${bound:postgres-database:at}:${bound:postgres-database:port}/${bound:postgres-database:as}\n"
|
"content": "postgresql://${bound:postgres-database:as}:${secret:postgres-database}@${bound:postgres-database:at}:${bound:postgres-database:port}/${bound:postgres-database:as}\n"
|
||||||
},
|
},
|
||||||
@@ -65,9 +65,9 @@
|
|||||||
"name": "mesh-catalog",
|
"name": "mesh-catalog",
|
||||||
"network": "host",
|
"network": "host",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/mesh-catalog/broker:/run/secrets/broker:ro",
|
||||||
"${dir:state}:/run/state",
|
"/var/lib/mesh-catalog:/run/state",
|
||||||
"${dir:state}/database.url:/run/secrets/database-url:ro"
|
"/var/lib/mesh-catalog/database.url:/run/secrets/database-url:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
|
|||||||
@@ -1,13 +0,0 @@
|
|||||||
# The console (novox/hq ADR 0152, design 34): the mesh's tools for whoever is on a machine, served
|
|
||||||
# over MCP on that machine's loopback.
|
|
||||||
#
|
|
||||||
# **Nothing is compiled here.** The console is the tool runtime's own client — `mesh serve` — which
|
|
||||||
# the runtime image already carries beside the runtime it runs modules with. This recipe changes the
|
|
||||||
# program the image starts and nothing else, so the console is exactly the client a person can run by
|
|
||||||
# hand, started by the mesh instead, on the credential the mesh sealed to the machine.
|
|
||||||
#
|
|
||||||
# One base, named rather than pinned: the mesh answers with the copy it holds (novox/hq issue 044).
|
|
||||||
ARG RUNTIME_BASE
|
|
||||||
|
|
||||||
FROM ${RUNTIME_BASE}
|
|
||||||
ENTRYPOINT ["node", "dist/mesh.js"]
|
|
||||||
@@ -1,38 +0,0 @@
|
|||||||
# mesh-console
|
|
||||||
|
|
||||||
The mesh's tools, on the machine a person sits at, served by a module the mesh assigned there
|
|
||||||
(novox/hq [ADR 0152](https://git.novox.be/novox/hq), design 34).
|
|
||||||
|
|
||||||
Assign it to a machine and an agent on that machine has the mesh's tools at
|
|
||||||
`http://127.0.0.1:<port>/mcp` — MCP over HTTP, `initialize`, `tools/list`, `tools/call`. A person at
|
|
||||||
a terminal reaches the same endpoint with `mesh tools --console http://127.0.0.1:<port>` and
|
|
||||||
`mesh call <module>.<tool> --console …`, with no credential of their own: the console holds it.
|
|
||||||
|
|
||||||
## What it is
|
|
||||||
|
|
||||||
The tool runtime's own client, `mesh serve`, started by the mesh on the credential it sealed to the
|
|
||||||
machine for `<node>.mesh-console`. The manifest says three things nothing else in the catalogue says
|
|
||||||
together:
|
|
||||||
|
|
||||||
- `invokes: ["*"]` — it calls every tool on the mesh, and the bus grants exactly that publish side;
|
|
||||||
- a listener `from: machine` — loopback only, and the filter opens nothing for it;
|
|
||||||
- no `emits`, no `consumes`, no `tools` — nothing on the bus can address it.
|
|
||||||
|
|
||||||
**Loopback is the authority boundary.** Whoever can connect is on the machine, and whoever is on the
|
|
||||||
machine is the account that owns the mesh there (ADR 0034, ADR 0144). There is no token and no login,
|
|
||||||
and `mesh serve` refuses to bind anything but a loopback address.
|
|
||||||
|
|
||||||
## What it lists
|
|
||||||
|
|
||||||
What the running modules answer: every tool runtime serves a `tools` verb for its module, and the
|
|
||||||
console asks the catalogue which modules the mesh holds and each module what it serves. A module that
|
|
||||||
did not answer — not assigned, not up, or built before the runtime answered `tools` — is named in the
|
|
||||||
list's `_meta.notAnswering` and can still be called by `<module>.<tool>`.
|
|
||||||
|
|
||||||
The mesh's own verbs (`status`, `push`, `assign`) are the `mesh-controller` seat's tools under
|
|
||||||
ADR 0132 and are not served on the bus yet; they appear here when they are.
|
|
||||||
|
|
||||||
## Port
|
|
||||||
|
|
||||||
The manifest declares port 4270 and the mesh assigns the machine port as it does for any listener;
|
|
||||||
the console binds `127.0.0.1:${port:4270}`. `node show <machine>` says which port a machine was given.
|
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
{
|
|
||||||
"module": "mesh-console",
|
|
||||||
"version": "1",
|
|
||||||
"slug": "console",
|
|
||||||
"capabilities": [
|
|
||||||
"container-runtime"
|
|
||||||
],
|
|
||||||
"invokes": [
|
|
||||||
"*"
|
|
||||||
],
|
|
||||||
"own-secrets": {
|
|
||||||
"broker": "${dir:mesh-state}/broker"
|
|
||||||
},
|
|
||||||
"listens": [
|
|
||||||
{
|
|
||||||
"name": "mcp",
|
|
||||||
"port": 4270,
|
|
||||||
"protocol": "tcp",
|
|
||||||
"from": "machine",
|
|
||||||
"why": "the mesh's tools for whoever is on this machine, over MCP on loopback; the machine's login is the authority (novox/hq ADR 0152)"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"resources": [
|
|
||||||
{
|
|
||||||
"id": "mesh-state",
|
|
||||||
"type": "directory",
|
|
||||||
"mode": "0700",
|
|
||||||
"place": "mesh"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "server",
|
|
||||||
"type": "container",
|
|
||||||
"name": "mesh-console",
|
|
||||||
"network": "host",
|
|
||||||
"args": [
|
|
||||||
"serve"
|
|
||||||
],
|
|
||||||
"env": {
|
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
|
||||||
"MESH_CONSOLE_LISTEN": "127.0.0.1:${port:4270}"
|
|
||||||
},
|
|
||||||
"volumes": [
|
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro"
|
|
||||||
],
|
|
||||||
"artifact": "runtime"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"build": {
|
|
||||||
"on": [
|
|
||||||
{
|
|
||||||
"arg": "RUNTIME_BASE",
|
|
||||||
"module": "mesh-tools",
|
|
||||||
"artifact": "runtime"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"artifacts": [
|
|
||||||
{
|
|
||||||
"name": "runtime",
|
|
||||||
"kind": "image",
|
|
||||||
"from": "Dockerfile"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,9 +1,9 @@
|
|||||||
// mesh-vault's events entrypoint, loaded by the per-node tool host (the provisioner runs in the same
|
// mesh-vault's events entrypoint, loaded by the per-node tool host (the provisioner runs in the same
|
||||||
// process — ADR 0052). The lifecycle events are EMITTED from the provisioner, where custody
|
// process — ADR 0052). The lifecycle events are EMITTED from the provisioner, where custody
|
||||||
// actually changes (novox/hq ADR 0041/0042):
|
// actually changes (novox/hq ADR 0041/0042):
|
||||||
// mesh-vault.provisioned — a consumer was granted a secret
|
// module.mesh-vault.secret.provisioned — a consumer was granted a secret
|
||||||
// mesh-vault.rotated — that consumer's value changed (`rotate secret`)
|
// module.mesh-vault.secret.rotated — that consumer's value changed (`rotate secret`)
|
||||||
// mesh-vault.deprovisioned — the consumer went away and its secret was withdrawn
|
// module.mesh-vault.secret.deprovisioned — the consumer went away and its secret was withdrawn
|
||||||
// Here the vault reacts to them, keeping a lightweight audit line of who holds what and when it
|
// Here the vault reacts to them, keeping a lightweight audit line of who holds what and when it
|
||||||
// moved — the audit an owner of secrets is best placed to log. Fingerprints, never values.
|
// moved — the audit an owner of secrets is best placed to log. Fingerprints, never values.
|
||||||
|
|
||||||
@@ -16,15 +16,15 @@ interface SecretEvent {
|
|||||||
rotations?: number;
|
rotations?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
await on<SecretEvent>("provisioned", async (e) => {
|
await on<SecretEvent>("secret.provisioned", async (e) => {
|
||||||
console.log(`[mesh-vault] secret provisioned for ${e.body.as} on ${e.body.consumer} (${e.body.fingerprint})`);
|
console.log(`[mesh-vault] secret provisioned for ${e.body.as} on ${e.body.consumer} (${e.body.fingerprint})`);
|
||||||
});
|
});
|
||||||
|
|
||||||
await on<SecretEvent>("rotated", async (e) => {
|
await on<SecretEvent>("secret.rotated", async (e) => {
|
||||||
console.log(`[mesh-vault] secret rotated for ${e.body.as} — rotation ${e.body.rotations} (${e.body.fingerprint})`);
|
console.log(`[mesh-vault] secret rotated for ${e.body.as} — rotation ${e.body.rotations} (${e.body.fingerprint})`);
|
||||||
});
|
});
|
||||||
|
|
||||||
await on<SecretEvent>("deprovisioned", async (e) => {
|
await on<SecretEvent>("secret.deprovisioned", async (e) => {
|
||||||
console.log(`[mesh-vault] secret withdrawn from ${e.body.as}`);
|
console.log(`[mesh-vault] secret withdrawn from ${e.body.as}`);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -11,51 +11,54 @@
|
|||||||
"container-runtime"
|
"container-runtime"
|
||||||
],
|
],
|
||||||
"emits": [
|
"emits": [
|
||||||
"provisioned",
|
"secret.provisioned",
|
||||||
"rotated",
|
"secret.rotated",
|
||||||
"deprovisioned"
|
"secret.deprovisioned"
|
||||||
],
|
],
|
||||||
"consumes": [
|
"consumes": [
|
||||||
"mesh-vault.provisioned",
|
"mesh-vault.secret.provisioned",
|
||||||
"mesh-vault.rotated",
|
"mesh-vault.secret.rotated",
|
||||||
"mesh-vault.deprovisioned"
|
"mesh-vault.secret.deprovisioned"
|
||||||
],
|
],
|
||||||
"receives": {
|
"receives": {
|
||||||
"secret": "${dir:grants}/mesh.json"
|
"secret": "/var/lib/mesh-vault/grants/mesh.json"
|
||||||
},
|
},
|
||||||
"grants": {
|
"grants": {
|
||||||
"secret": "${dir:grants}"
|
"secret": "/var/lib/mesh-vault/grants"
|
||||||
},
|
},
|
||||||
"keeps": "/var/lib/mesh-vault/root",
|
"keeps": "/var/lib/mesh-vault/root",
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/mesh-vault/broker"
|
||||||
},
|
},
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/mesh-vault",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh-vault",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "grants",
|
"id": "grants",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/var/lib/mesh-vault/grants",
|
||||||
"mode": "0700"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "ledger",
|
"id": "ledger",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/var/lib/mesh-vault/ledger",
|
||||||
"mode": "0700"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "root",
|
"id": "root",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/var/lib/mesh-vault/root",
|
||||||
"mode": "0700"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -64,16 +67,16 @@
|
|||||||
"name": "mesh-vault",
|
"name": "mesh-vault",
|
||||||
"network": "host",
|
"network": "host",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/mesh-vault/broker:/run/secrets/broker:ro",
|
||||||
"${dir:grants}:${dir:grants}:ro",
|
"/var/lib/mesh-vault/grants:/var/lib/mesh-vault/grants:ro",
|
||||||
"${dir:ledger}:${dir:ledger}",
|
"/var/lib/mesh-vault/ledger:/var/lib/mesh-vault/ledger",
|
||||||
"${dir:root}:${dir:root}:ro"
|
"/var/lib/mesh-vault/root:/var/lib/mesh-vault/root:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_RECEIVES": "${dir:grants}/mesh.json",
|
"MESH_RECEIVES": "/var/lib/mesh-vault/grants/mesh.json",
|
||||||
"MESH_VAULT_LEDGER": "${dir:ledger}",
|
"MESH_VAULT_LEDGER": "/var/lib/mesh-vault/ledger",
|
||||||
"MESH_VAULT_ROOT": "${dir:root}"
|
"MESH_VAULT_ROOT": "/var/lib/mesh-vault/root"
|
||||||
},
|
},
|
||||||
"artifact": "runtime"
|
"artifact": "runtime"
|
||||||
}
|
}
|
||||||
@@ -98,11 +101,5 @@
|
|||||||
"from": "Dockerfile"
|
"from": "Dockerfile"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
}
|
||||||
"claims": [
|
|
||||||
{
|
|
||||||
"name": "mesh-vault",
|
|
||||||
"scope": "mesh"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -43,6 +43,6 @@ runProvisioner("secret", {
|
|||||||
async remove(p: { as: string }): Promise<void> {
|
async remove(p: { as: string }): Promise<void> {
|
||||||
if (!ledger.withdraw(p.as)) return;
|
if (!ledger.withdraw(p.as)) return;
|
||||||
console.log(`[mesh-vault] withdrawn: ${p.as}`);
|
console.log(`[mesh-vault] withdrawn: ${p.as}`);
|
||||||
await announce("deprovisioned", { as: p.as });
|
await announce("secret.deprovisioned", { as: p.as });
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|||||||
+18
-16
@@ -53,39 +53,40 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"receives": {
|
"receives": {
|
||||||
"s3-bucket": "${dir:grants}/mesh.json"
|
"s3-bucket": "/var/lib/minio/grants/mesh.json"
|
||||||
},
|
},
|
||||||
"grants": {
|
"grants": {
|
||||||
"s3-bucket": "${dir:grants}"
|
"s3-bucket": "/var/lib/minio/grants"
|
||||||
},
|
},
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"root": "${dir:state}/root.secret",
|
"root": "/var/lib/minio/root.secret",
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/minio/broker"
|
||||||
},
|
},
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/minio",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/minio",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "grants",
|
"id": "grants",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/var/lib/minio/grants",
|
||||||
"mode": "0700"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "root-env",
|
"id": "root-env",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/root.env",
|
"path": "/var/lib/minio/root.env",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "MINIO_ROOT_USER=meshroot\nMINIO_BROWSER_REDIRECT_URL=https://${bound:route:name-console}\n"
|
"content": "MINIO_ROOT_USER=meshroot\n"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "data",
|
"id": "data",
|
||||||
@@ -111,7 +112,7 @@
|
|||||||
":9001"
|
":9001"
|
||||||
],
|
],
|
||||||
"env-file": [
|
"env-file": [
|
||||||
"${dir:state}/root.env"
|
"/var/lib/minio/root.env"
|
||||||
],
|
],
|
||||||
"ports": [
|
"ports": [
|
||||||
"9000",
|
"9000",
|
||||||
@@ -119,10 +120,11 @@
|
|||||||
],
|
],
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"/var/lib/minio-store:/data",
|
"/var/lib/minio-store:/data",
|
||||||
"${dir:state}/root.secret:/run/secrets/root:ro"
|
"/var/lib/minio/root.secret:/run/secrets/root:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MINIO_ROOT_PASSWORD_FILE": "/run/secrets/root",
|
"MINIO_ROOT_PASSWORD_FILE": "/run/secrets/root",
|
||||||
|
"MINIO_BROWSER_REDIRECT_URL": "https://files.novox.be",
|
||||||
"MINIO_REGION": "eu-west"
|
"MINIO_REGION": "eu-west"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
@@ -132,9 +134,9 @@
|
|||||||
"name": "mesh-minio",
|
"name": "mesh-minio",
|
||||||
"network": "minio-net",
|
"network": "minio-net",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/minio/broker:/run/secrets/broker:ro",
|
||||||
"${dir:grants}:${dir:grants}:ro",
|
"/var/lib/minio/grants:/var/lib/minio/grants:ro",
|
||||||
"${dir:state}/root.secret:/run/secrets/root:ro"
|
"/var/lib/minio/root.secret:/run/secrets/root:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_MINIO_ENDPOINT": "http://minio:9000",
|
"MESH_MINIO_ENDPOINT": "http://minio:9000",
|
||||||
@@ -142,7 +144,7 @@
|
|||||||
"MESH_MINIO_ROOT_PASSWORD_FILE": "/run/secrets/root",
|
"MESH_MINIO_ROOT_PASSWORD_FILE": "/run/secrets/root",
|
||||||
"MESH_MINIO_REGION": "eu-west",
|
"MESH_MINIO_REGION": "eu-west",
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_RECEIVES": "${dir:grants}/mesh.json"
|
"MESH_RECEIVES": "/var/lib/minio/grants/mesh.json"
|
||||||
},
|
},
|
||||||
"artifact": "runtime"
|
"artifact": "runtime"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -14,34 +14,34 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"binds": {
|
"binds": {
|
||||||
"postgres-database": "${dir:state}/database.json"
|
"postgres-database": "/var/lib/model-usage/database.json"
|
||||||
},
|
},
|
||||||
"secrets": {
|
"secrets": {
|
||||||
"postgres-database": "${dir:state}/database.secret"
|
"postgres-database": "/var/lib/model-usage/database.secret"
|
||||||
},
|
},
|
||||||
"consumes": [
|
"consumes": [
|
||||||
"*.usage.*"
|
"*.usage.*"
|
||||||
],
|
],
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/model-usage/broker"
|
||||||
},
|
},
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/model-usage",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/model-usage",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "database-url",
|
"id": "database-url",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/database.url",
|
"path": "/var/lib/model-usage/database.url",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"content": "postgresql://${bound:postgres-database:as}:${secret:postgres-database}@${bound:postgres-database:at}:${bound:postgres-database:port}/${bound:postgres-database:as}\n"
|
"content": "postgresql://${bound:postgres-database:as}:${secret:postgres-database}@${bound:postgres-database:at}:${bound:postgres-database:port}/${bound:postgres-database:as}\n"
|
||||||
},
|
},
|
||||||
@@ -52,9 +52,9 @@
|
|||||||
"image": "mesh-runtime-model-usage@sha256:0000000000000000000000000000000000000000000000000000000000000000",
|
"image": "mesh-runtime-model-usage@sha256:0000000000000000000000000000000000000000000000000000000000000000",
|
||||||
"network": "host",
|
"network": "host",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/model-usage/broker:/run/secrets/broker:ro",
|
||||||
"${dir:state}:/run/state",
|
"/var/lib/model-usage:/run/state",
|
||||||
"${dir:state}/database.url:/run/secrets/database-url:ro"
|
"/var/lib/model-usage/database.url:/run/secrets/database-url:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
|
|||||||
@@ -40,15 +40,15 @@
|
|||||||
},
|
},
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"root": "${dir:state}/root.secret",
|
"root": "${dir:state}/root.secret",
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/mongodb/broker"
|
||||||
},
|
},
|
||||||
"secrets-owner": "999:999",
|
"secrets-owner": "999:999",
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/mongodb",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
@@ -95,7 +95,7 @@
|
|||||||
"name": "mesh-mongodb",
|
"name": "mesh-mongodb",
|
||||||
"network": "mongodb",
|
"network": "mongodb",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/mongodb/broker:/run/secrets/broker:ro",
|
||||||
"${dir:grants}:${dir:grants}:ro",
|
"${dir:grants}:${dir:grants}:ro",
|
||||||
"${dir:state}/root.secret:/run/secrets/root:ro"
|
"${dir:state}/root.secret:/run/secrets/root:ro"
|
||||||
],
|
],
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ ARG RUNTIME_BASE
|
|||||||
FROM ${BUILD_BASE} AS build
|
FROM ${BUILD_BASE} AS build
|
||||||
WORKDIR /app/modules/mosquitto
|
WORKDIR /app/modules/mosquitto
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN node /app/node_modules/typescript/bin/tsc topics.ts client.ts index.ts tools/index.ts provisioner/index.ts bootstrap/index.ts \
|
RUN node /app/node_modules/typescript/bin/tsc client.ts index.ts tools/index.ts provisioner/index.ts bootstrap/index.ts \
|
||||||
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
||||||
|
|
||||||
FROM ${RUNTIME_BASE}
|
FROM ${RUNTIME_BASE}
|
||||||
|
|||||||
+24
-38
@@ -20,8 +20,6 @@ import { readFileSync } from "node:fs";
|
|||||||
import { execFile } from "node:child_process";
|
import { execFile } from "node:child_process";
|
||||||
import { promisify } from "node:util";
|
import { promisify } from "node:util";
|
||||||
|
|
||||||
import { missingAcls, parseRoleAcls, staleAcls, wantedAcls } from "./topics.js";
|
|
||||||
|
|
||||||
const run = promisify(execFile);
|
const run = promisify(execFile);
|
||||||
|
|
||||||
export interface MqttConn {
|
export interface MqttConn {
|
||||||
@@ -143,19 +141,14 @@ export class MosquittoClient {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create (or reset to a known state) a client granted exactly these topic filters, idempotently.
|
* Create (or reset to a known state) a client scoped to one topic namespace, idempotently. The
|
||||||
* The grant is a same-named role carrying, for every filter, publish, receive and subscribe — and
|
* client is confined to `<prefix>/#` by a same-named role: it may publish to, subscribe to and
|
||||||
* nothing else: an ACL the role carries that the filters no longer name is removed, so narrowing a
|
* receive on exactly its own subtree and nothing else — the MQTT analog of redis's keyspace-scoped
|
||||||
* consumer's `topics` narrows what it may do. By default the filters are the consumer's own
|
* ACL user. Called again for an existing client, it resets the password and re-asserts the ACLs.
|
||||||
* subtree, `<as>/#` (see topics.ts). Called again for an existing client, it resets the password
|
|
||||||
* and re-asserts the ACLs.
|
|
||||||
*
|
|
||||||
* Only the role named for this client is ever changed. A client or role the mesh did not make —
|
|
||||||
* a device carried from the predecessor's password file, its `legacy-full-access` role — is never
|
|
||||||
* read, changed or removed here.
|
|
||||||
*/
|
*/
|
||||||
async createScopedClient(username: string, password: string, filters: readonly string[]): Promise<void> {
|
async createScopedClient(username: string, password: string, topicPrefix: string): Promise<void> {
|
||||||
const role = username; // one role per client, named for it
|
const role = username; // one role per client, named for it
|
||||||
|
const pattern = `${topicPrefix}/#`;
|
||||||
|
|
||||||
if (await this.clientExists(username)) {
|
if (await this.clientExists(username)) {
|
||||||
await this.ctl("setClientPassword", username, password);
|
await this.ctl("setClientPassword", username, password);
|
||||||
@@ -168,18 +161,17 @@ export class MosquittoClient {
|
|||||||
await this.ctl("createClient", username, "-p", password);
|
await this.ctl("createClient", username, "-p", password);
|
||||||
}
|
}
|
||||||
|
|
||||||
// createRole and addRoleACL are one-shot: each rejects with an "already exists" when re-run
|
// A role carrying exactly this client's topic ACLs. createRole, addRoleACL and addClientRole are
|
||||||
// against a role/ACL it created on a previous reconcile. That rejection is the intended terminal
|
// all one-shot: each rejects with an "already exists" when re-run against a role/ACL/binding it
|
||||||
// state, so it is swallowed.
|
// created on a previous reconcile. That rejection is the intended terminal state — the ACL is
|
||||||
|
// deterministic (`<prefix>/#`, allow), so re-adding the identical entry is a no-op — so it is
|
||||||
|
// swallowed. (Until the exit code was fixed this was invisible: the tool returned 0 and the
|
||||||
|
// rejection was lost; now it surfaces, and each of these adds must tolerate its own idempotent
|
||||||
|
// re-run explicitly.)
|
||||||
await ignoreExisting(this.ctl("createRole", role));
|
await ignoreExisting(this.ctl("createRole", role));
|
||||||
const wanted = wantedAcls(filters);
|
for (const acl of ["publishClientSend", "publishClientReceive", "subscribePattern"]) {
|
||||||
const current = parseRoleAcls(await this.ctl("getRole", role));
|
// allow (1) this client to send to, receive on, and subscribe under its own subtree.
|
||||||
for (const acl of missingAcls(current, wanted)) {
|
await ignoreExisting(this.ctl("addRoleACL", role, acl, pattern, "allow"));
|
||||||
await ignoreExisting(this.ctl("addRoleACL", role, acl.type, acl.topic, "allow"));
|
|
||||||
}
|
|
||||||
// What the consumer no longer asks for — added before it narrowed its topics — is taken away.
|
|
||||||
for (const acl of staleAcls(current, wanted)) {
|
|
||||||
await ignoreMissing(this.ctl("removeRoleACL", role, acl.type, acl.topic));
|
|
||||||
}
|
}
|
||||||
// Bind the role only when it is not already bound — addClientRole is the one call whose
|
// Bind the role only when it is not already bound — addClientRole is the one call whose
|
||||||
// idempotent re-run cannot be recognised by message (see clientHasRole).
|
// idempotent re-run cannot be recognised by message (see clientHasRole).
|
||||||
@@ -189,31 +181,25 @@ export class MosquittoClient {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Whether a consumer's client accepts exactly this password, still carries its own role, and that
|
* Whether a consumer's client accepts exactly this password and still carries its own role.
|
||||||
* role grants exactly these filters. Read-only. The password is checked the way the consumer is
|
* Read-only. The password is checked the way the consumer is checked, by an MQTT CONNECT as it,
|
||||||
* checked, by an MQTT CONNECT as it, and the broker's CONNACK code is the answer: 0 accepted,
|
* and the broker's CONNACK code is the answer: 0 accepted, 4 bad credentials, 5 not authorised.
|
||||||
* 4 bad credentials, 5 not authorised. Nothing rides on argv. An unreachable broker rejects
|
* Nothing rides on argv. An unreachable broker rejects (novox/hq issue 120).
|
||||||
* (novox/hq issue 120).
|
|
||||||
*/
|
*/
|
||||||
async holdsClient(username: string, password: string, filters: readonly string[]): Promise<boolean> {
|
async holdsClient(username: string, password: string): Promise<boolean> {
|
||||||
const code = await mqttConnack(this.conn.host, this.conn.port, username, password);
|
const code = await mqttConnack(this.conn.host, this.conn.port, username, password);
|
||||||
if (code === 4 || code === 5) return false;
|
if (code === 4 || code === 5) return false;
|
||||||
if (code !== 0) throw new Error(`mosquitto refused ${username} with CONNACK ${code}`);
|
if (code !== 0) throw new Error(`mosquitto refused ${username} with CONNACK ${code}`);
|
||||||
// The role, asked directly: only "not found" means absent. Any other failure to ask rejects,
|
// The role, asked directly: only "not found" means absent. Any other failure to ask rejects,
|
||||||
// unlike clientHasRole, which reads every failure as "no role".
|
// unlike clientHasRole, which reads every failure as "no role".
|
||||||
let client: string;
|
let out: string;
|
||||||
let role: string;
|
|
||||||
try {
|
try {
|
||||||
client = await this.ctl("getClient", username);
|
out = await this.ctl("getClient", username);
|
||||||
role = await this.ctl("getRole", username);
|
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
if (/not\s*found|does not exist|no such/i.test(String(err))) return false;
|
if (/not\s*found|does not exist|no such/i.test(String(err))) return false;
|
||||||
throw err;
|
throw err;
|
||||||
}
|
}
|
||||||
if (!new RegExp(`(^|\\s)${escapeRegExp(username)}\\s+\\(priority`, "m").test(client)) return false;
|
return new RegExp(`(^|\\s)${escapeRegExp(username)}\\s+\\(priority`, "m").test(out);
|
||||||
const current = parseRoleAcls(role);
|
|
||||||
const wanted = wantedAcls(filters);
|
|
||||||
return missingAcls(current, wanted).length === 0 && staleAcls(current, wanted).length === 0;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Remove a client and the per-client role created for it, idempotently. */
|
/** Remove a client and the per-client role created for it, idempotently. */
|
||||||
|
|||||||
@@ -20,20 +20,17 @@
|
|||||||
"mosquitto.topic.deprovisioned"
|
"mosquitto.topic.deprovisioned"
|
||||||
],
|
],
|
||||||
"serves": {
|
"serves": {
|
||||||
"mqtt-topic": {
|
"mqtt-topic": {}
|
||||||
"scheme": "mqtt",
|
|
||||||
"port": 1883
|
|
||||||
}
|
|
||||||
},
|
},
|
||||||
"receives": {
|
"receives": {
|
||||||
"mqtt-topic": "${dir:grants}/mesh.json"
|
"mqtt-topic": "/var/lib/mosquitto-module/grants/mesh.json"
|
||||||
},
|
},
|
||||||
"grants": {
|
"grants": {
|
||||||
"mqtt-topic": "${dir:grants}"
|
"mqtt-topic": "/var/lib/mosquitto-module/grants"
|
||||||
},
|
},
|
||||||
"own-secrets": {
|
"own-secrets": {
|
||||||
"admin": "${dir:mesh-state}/admin",
|
"admin": "/var/lib/mosquitto-module/admin.secret",
|
||||||
"broker": "${dir:mesh-state}/broker"
|
"broker": "/var/lib/mesh/mosquitto/broker"
|
||||||
},
|
},
|
||||||
"listens": [
|
"listens": [
|
||||||
{
|
{
|
||||||
@@ -55,30 +52,32 @@
|
|||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mesh/mosquitto",
|
||||||
"place": "mesh"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"mode": "0700",
|
"path": "/var/lib/mosquitto-module",
|
||||||
"place": "."
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "grants",
|
"id": "grants-dir",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/var/lib/mosquitto-module/grants",
|
||||||
"mode": "0700"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "data",
|
"id": "data",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/services/mosquitto/data",
|
||||||
"mode": "0700",
|
"mode": "0700",
|
||||||
"owner": "1883:1883"
|
"owner": "1883:1883"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "server-conf",
|
"id": "server-conf",
|
||||||
"type": "file",
|
"type": "file",
|
||||||
"path": "${dir:state}/mosquitto.conf",
|
"path": "/var/lib/mosquitto-module/mosquitto.conf",
|
||||||
"mode": "0600",
|
"mode": "0600",
|
||||||
"owner": "1883:1883",
|
"owner": "1883:1883",
|
||||||
"content": "persistence true\npersistence_location /mosquitto/data\n\nlog_dest stdout\nlog_type warning\nlog_type error\nlog_type notice\n\n# Every client authenticates; identities and their per-topic ACLs are managed\n# at runtime by the dynamic security plugin, whose store the plugin itself owns.\nallow_anonymous false\nplugin /usr/lib/mosquitto_dynamic_security.so\nplugin_opt_config_file /mosquitto/data/dynamic-security.json\n\n# MQTT listener\nlistener 1883\n\n# MQTT-over-WebSockets listener\nlistener 8081\nprotocol websockets\n"
|
"content": "persistence true\npersistence_location /mosquitto/data\n\nlog_dest stdout\nlog_type warning\nlog_type error\nlog_type notice\n\n# Every client authenticates; identities and their per-topic ACLs are managed\n# at runtime by the dynamic security plugin, whose store the plugin itself owns.\nallow_anonymous false\nplugin /usr/lib/mosquitto_dynamic_security.so\nplugin_opt_config_file /mosquitto/data/dynamic-security.json\n\n# MQTT listener\nlistener 1883\n\n# MQTT-over-WebSockets listener\nlistener 8081\nprotocol websockets\n"
|
||||||
@@ -94,8 +93,8 @@
|
|||||||
"name": "mosquitto-bootstrap",
|
"name": "mosquitto-bootstrap",
|
||||||
"run-once": true,
|
"run-once": true,
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:data}:/mosquitto/data",
|
"/services/mosquitto/data:/mosquitto/data",
|
||||||
"${dir:mesh-state}/admin:/run/secrets/admin:ro"
|
"/var/lib/mosquitto-module/admin.secret:/run/secrets/admin:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_PROVISION_MQTT": "mosquitto:1883",
|
"MESH_PROVISION_MQTT": "mosquitto:1883",
|
||||||
@@ -113,15 +112,15 @@
|
|||||||
"id": "server",
|
"id": "server",
|
||||||
"type": "container",
|
"type": "container",
|
||||||
"name": "mosquitto",
|
"name": "mosquitto",
|
||||||
"image": "eclipse-mosquitto@sha256:38c0da4f2ef84284d47b3b3eeea1cb3bdeabe81ee10caf0cd5c5ff61ee3ea408",
|
"image": "eclipse-mosquitto@sha256:6f8d8a947c506f8a2290ec65cd4bd2bc7cb4d43fb5f6271f861cb013e2ef9797",
|
||||||
"network": "mosquitto",
|
"network": "mosquitto",
|
||||||
"ports": [
|
"ports": [
|
||||||
"1883",
|
"1883",
|
||||||
"8081"
|
"8081"
|
||||||
],
|
],
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:data}:/mosquitto/data",
|
"/services/mosquitto/data:/mosquitto/data",
|
||||||
"${dir:state}/mosquitto.conf:/mosquitto/config/mosquitto.conf:ro"
|
"/var/lib/mosquitto-module/mosquitto.conf:/mosquitto/config/mosquitto.conf:ro"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -130,13 +129,13 @@
|
|||||||
"name": "mesh-mosquitto",
|
"name": "mesh-mosquitto",
|
||||||
"network": "mosquitto",
|
"network": "mosquitto",
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:mesh-state}/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/mosquitto/broker:/run/secrets/broker:ro",
|
||||||
"${dir:grants}:${dir:grants}:ro",
|
"/var/lib/mosquitto-module/grants:/var/lib/mosquitto-module/grants:ro",
|
||||||
"${dir:mesh-state}/admin:/run/secrets/admin:ro"
|
"/var/lib/mosquitto-module/admin.secret:/run/secrets/admin:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_RECEIVES": "${dir:grants}/mesh.json",
|
"MESH_RECEIVES": "/var/lib/mosquitto-module/grants/mesh.json",
|
||||||
"MESH_PROVISION_MQTT": "mosquitto:1883",
|
"MESH_PROVISION_MQTT": "mosquitto:1883",
|
||||||
"MESH_PROVISION_ADMIN_USER": "mesh-admin",
|
"MESH_PROVISION_ADMIN_USER": "mesh-admin",
|
||||||
"MESH_PROVISION_PASSWORD_FILE": "/run/secrets/admin"
|
"MESH_PROVISION_PASSWORD_FILE": "/run/secrets/admin"
|
||||||
|
|||||||
@@ -1,14 +1,9 @@
|
|||||||
{
|
{
|
||||||
"name": "@novox/module-mosquitto",
|
"name": "@novox/module-mosquitto",
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"description": "mosquitto \u2014 provides the mesh mqtt-topic interface. Its admin client, provisioner, tools and events live here (novox/hq ADR 0039).",
|
"description": "mosquitto — provides the mesh mqtt-topic interface. Its admin client, provisioner, tools and events live here (novox/hq ADR 0039).",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
|
||||||
"build": "tsc topics.ts client.ts index.ts tools/index.ts provisioner/index.ts bootstrap/index.ts --module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist",
|
|
||||||
"typecheck": "tsc -p tsconfig.json",
|
|
||||||
"test": "node --test --experimental-strip-types 'test/*.test.ts'"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@novox/mesh-sdk": "^0.1.1"
|
"@novox/mesh-sdk": "^0.1.1"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -5,14 +5,7 @@
|
|||||||
//
|
//
|
||||||
// The `mqtt-topic` interface: a consumer connects as `as` with the password the mesh minted, and
|
// The `mqtt-topic` interface: a consumer connects as `as` with the password the mesh minted, and
|
||||||
// publishes and subscribes under `<as>/#`, isolated from every other consumer by a Dynamic Security
|
// publishes and subscribes under `<as>/#`, isolated from every other consumer by a Dynamic Security
|
||||||
// role scoped to exactly that subtree — unless it contributed `topics`, the MQTT topic filters its
|
// role scoped to exactly that subtree.
|
||||||
// work needs (a home-automation hub needs the devices' topics); then the role grants exactly those
|
|
||||||
// (topics.ts). A list that is not valid topic filters is refused, and the consumer is not created
|
|
||||||
// or changed until it is fixed.
|
|
||||||
//
|
|
||||||
// What a consumer is told (its binding): `at` — the broker's machine — and `port`, the machine port
|
|
||||||
// of the MQTT listener (the manifest's `serves`); `as` is its login, and its copy of the password is
|
|
||||||
// the pair credential the mesh delivers to it.
|
|
||||||
//
|
//
|
||||||
// **The login and password are the mesh's, not the provisioner's (ADR 0048).** The mesh derives the
|
// **The login and password are the mesh's, not the provisioner's (ADR 0048).** The mesh derives the
|
||||||
// login and hands it to both ends so they agree, and mints the password and delivers a copy to each.
|
// login and hands it to both ends so they agree, and mints the password and delivers a copy to each.
|
||||||
@@ -22,7 +15,6 @@
|
|||||||
import { runProvisioner, type Provision } from "@novox/mesh-sdk/provisioner";
|
import { runProvisioner, type Provision } from "@novox/mesh-sdk/provisioner";
|
||||||
import { emit } from "@novox/mesh-sdk/events";
|
import { emit } from "@novox/mesh-sdk/events";
|
||||||
import { MosquittoClient } from "../client.js";
|
import { MosquittoClient } from "../client.js";
|
||||||
import { topicFilters } from "../topics.js";
|
|
||||||
|
|
||||||
const mosquitto = MosquittoClient.fromEnv();
|
const mosquitto = MosquittoClient.fromEnv();
|
||||||
|
|
||||||
@@ -37,20 +29,13 @@ async function announce(type: string, body: Record<string, string>): Promise<voi
|
|||||||
|
|
||||||
runProvisioner("mqtt-topic", {
|
runProvisioner("mqtt-topic", {
|
||||||
async create(p: Provision): Promise<void> {
|
async create(p: Provision): Promise<void> {
|
||||||
// By default the consumer's own subtree, so one cannot read another's topics; what it
|
// The topic subtree is scoped to the consumer's own login, so one cannot read another's topics.
|
||||||
// contributed as `topics` otherwise.
|
const topicPrefix = p.as;
|
||||||
const granted = topicFilters(p.values, p.as);
|
await mosquitto.createScopedClient(p.as, p.password, topicPrefix);
|
||||||
if ("problem" in granted) {
|
|
||||||
// Thrown, so the harness logs it and retries: the consumer stays as it was (or absent) until
|
|
||||||
// its contribution is valid, rather than being given a grant it did not ask for.
|
|
||||||
throw new Error(`${p.as}: ${granted.problem}`);
|
|
||||||
}
|
|
||||||
await mosquitto.createScopedClient(p.as, p.password, granted.filters);
|
|
||||||
await announce("topic.provisioned", {
|
await announce("topic.provisioned", {
|
||||||
consumer: p.consumer ?? "",
|
consumer: p.consumer ?? "",
|
||||||
username: p.as,
|
username: p.as,
|
||||||
topicPrefix: granted.own ? p.as : "",
|
topicPrefix,
|
||||||
topics: granted.filters.join(" "),
|
|
||||||
});
|
});
|
||||||
},
|
},
|
||||||
|
|
||||||
@@ -61,9 +46,6 @@ runProvisioner("mqtt-topic", {
|
|||||||
// Asked every minute by the harness: whether the backend still holds this consumer exactly as
|
// Asked every minute by the harness: whether the backend still holds this consumer exactly as
|
||||||
// the mesh gave it, so a login lost behind the provisioner's back is made again (novox/hq issue 120).
|
// the mesh gave it, so a login lost behind the provisioner's back is made again (novox/hq issue 120).
|
||||||
async holds(p: Provision): Promise<boolean> {
|
async holds(p: Provision): Promise<boolean> {
|
||||||
const granted = topicFilters(p.values, p.as);
|
return mosquitto.holdsClient(p.as, p.password);
|
||||||
// An invalid list was never applied; create refuses it again, loudly, on every pass.
|
|
||||||
if ("problem" in granted) return false;
|
|
||||||
return mosquitto.holdsClient(p.as, p.password, granted.filters);
|
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -1,72 +0,0 @@
|
|||||||
// What a consumer of mqtt-topic is granted (topics.ts): its own subtree unless it contributed
|
|
||||||
// `topics`; a contributed list is granted exactly, refused whole when it is not topic filters; and
|
|
||||||
// the role is brought to exactly the wanted ACLs — missing ones added, stale ones removed — read from
|
|
||||||
// `mosquitto_ctrl dynsec getRole` as eclipse-mosquitto 2.1.2 prints it.
|
|
||||||
|
|
||||||
import { test } from "node:test";
|
|
||||||
import assert from "node:assert/strict";
|
|
||||||
|
|
||||||
import { filterProblem, missingAcls, parseRoleAcls, staleAcls, topicFilters, wantedAcls } from "../topics.ts";
|
|
||||||
|
|
||||||
test("a consumer that contributed nothing gets its own subtree", () => {
|
|
||||||
assert.deepEqual(topicFilters({}, "mesh_ace_hass"), { ok: true, filters: ["mesh_ace_hass/#"], own: true });
|
|
||||||
assert.deepEqual(topicFilters(undefined, "x"), { ok: true, filters: ["x/#"], own: true });
|
|
||||||
// Settings merge into every contribution: keys that are not `topics` change nothing.
|
|
||||||
assert.deepEqual(topicFilters({ endpoints: { web: {} } }, "x"), { ok: true, filters: ["x/#"], own: true });
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a contributed list is granted exactly, duplicates once", () => {
|
|
||||||
assert.deepEqual(topicFilters({ topics: ["#"] }, "x"), { ok: true, filters: ["#"], own: false });
|
|
||||||
assert.deepEqual(topicFilters({ topics: ["stat/+/POWER", "tele/#", "tele/#", "/octoprint/x"] }, "x"), {
|
|
||||||
ok: true,
|
|
||||||
filters: ["stat/+/POWER", "tele/#", "/octoprint/x"],
|
|
||||||
own: false,
|
|
||||||
});
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a list that is not topic filters is refused whole", () => {
|
|
||||||
for (const topics of [[], "#", [""], ["a/#/b"], ["a#"], ["a/b+"], [42], ["a\u0000b"], {}]) {
|
|
||||||
const out = topicFilters({ topics } as Record<string, unknown>, "x");
|
|
||||||
assert.equal(out.ok, false, JSON.stringify(topics));
|
|
||||||
}
|
|
||||||
assert.equal(filterProblem("+/+/#"), undefined);
|
|
||||||
assert.equal(filterProblem("#"), undefined);
|
|
||||||
});
|
|
||||||
|
|
||||||
const GET_ROLE = `Warning: You are running mosquitto_ctrl without encryption.
|
|
||||||
This means all of the configuration changes you are making are visible on the network, including passwords.
|
|
||||||
|
|
||||||
Rolename: u1
|
|
||||||
ACLs: publishClientSend : allow : # (priority: 0)
|
|
||||||
subscribePattern : allow : u1/# (priority: 0)
|
|
||||||
publishClientReceive : deny : secret topic/with space (priority: -1)
|
|
||||||
`;
|
|
||||||
|
|
||||||
test("getRole's ACL lines are read, the warning and headings are not", () => {
|
|
||||||
assert.deepEqual(parseRoleAcls(GET_ROLE), [
|
|
||||||
{ type: "publishClientSend", allow: true, topic: "#" },
|
|
||||||
{ type: "subscribePattern", allow: true, topic: "u1/#" },
|
|
||||||
{ type: "publishClientReceive", allow: false, topic: "secret topic/with space" },
|
|
||||||
]);
|
|
||||||
assert.deepEqual(parseRoleAcls("Rolename: empty\nACLs:\n"), []);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the role is brought to exactly the wanted ACLs", () => {
|
|
||||||
const current = parseRoleAcls(GET_ROLE);
|
|
||||||
const wanted = wantedAcls(["u1/#"]);
|
|
||||||
assert.deepEqual(wanted, [
|
|
||||||
{ type: "publishClientSend", allow: true, topic: "u1/#" },
|
|
||||||
{ type: "publishClientReceive", allow: true, topic: "u1/#" },
|
|
||||||
{ type: "subscribePattern", allow: true, topic: "u1/#" },
|
|
||||||
]);
|
|
||||||
assert.deepEqual(missingAcls(current, wanted), [
|
|
||||||
{ type: "publishClientSend", allow: true, topic: "u1/#" },
|
|
||||||
{ type: "publishClientReceive", allow: true, topic: "u1/#" },
|
|
||||||
]);
|
|
||||||
assert.deepEqual(staleAcls(current, wanted), [
|
|
||||||
{ type: "publishClientSend", allow: true, topic: "#" },
|
|
||||||
{ type: "publishClientReceive", allow: false, topic: "secret topic/with space" },
|
|
||||||
]);
|
|
||||||
assert.deepEqual(staleAcls(wanted, wanted), []);
|
|
||||||
assert.deepEqual(missingAcls(wanted, wanted), []);
|
|
||||||
});
|
|
||||||
@@ -1,107 +0,0 @@
|
|||||||
// Which topics a consumer of `mqtt-topic` may use — the one choice a consumer makes about its grant.
|
|
||||||
//
|
|
||||||
// **By default, its own subtree and nothing else.** A consumer connects as the login the mesh derived
|
|
||||||
// (`as`) and may publish, receive and subscribe under `<as>/#` — isolated from every other consumer,
|
|
||||||
// which is the point of a per-consumer client (novox/hq ADR 0039/0048).
|
|
||||||
//
|
|
||||||
// **A consumer whose work IS the shared topic space says so.** Home Assistant discovers devices
|
|
||||||
// under `homeassistant/#` and `tasmota/discovery/#` and follows whatever state topics they announce;
|
|
||||||
// Node-RED's flows subscribe to the topics devices publish on (`stat/<device>/POWER`, …). Confined
|
|
||||||
// to `<as>/#` neither could do its job. So a consumer contributes `topics` to its `mqtt-topic`
|
|
||||||
// requirement — a list of MQTT topic filters — and the provisioner grants exactly those, both ways.
|
|
||||||
// Because assignment settings merge into every contribution, an operator narrows (or widens) the
|
|
||||||
// list per machine with the same key, without editing a manifest.
|
|
||||||
//
|
|
||||||
// Pure, so it is tested without a broker (test/topics.test.ts).
|
|
||||||
|
|
||||||
/** The dynsec ACL types a granted filter carries: send to it, receive from it, subscribe to it. */
|
|
||||||
export const GRANTED_ACL_TYPES = ["publishClientSend", "publishClientReceive", "subscribePattern"] as const;
|
|
||||||
|
|
||||||
/** One ACL on a role, as `mosquitto_ctrl dynsec getRole` reports it. */
|
|
||||||
export interface Acl {
|
|
||||||
type: string;
|
|
||||||
allow: boolean;
|
|
||||||
topic: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export type Filters = { ok: true; filters: string[]; own: boolean } | { ok: false; problem: string };
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The topic filters a consumer is granted: what it contributed as `topics`, or its own subtree when
|
|
||||||
* it contributed nothing. Refused — never silently narrowed or widened — when the list is not a
|
|
||||||
* list of valid MQTT topic filters: a grant that quietly differs from what was asked is a consumer
|
|
||||||
* that fails somewhere far from the cause.
|
|
||||||
*/
|
|
||||||
export function topicFilters(values: Readonly<Record<string, unknown>> | undefined, as: string): Filters {
|
|
||||||
const given = values?.topics;
|
|
||||||
if (given === undefined || given === null) {
|
|
||||||
return { ok: true, filters: [`${as}/#`], own: true };
|
|
||||||
}
|
|
||||||
if (!Array.isArray(given) || given.length === 0) {
|
|
||||||
return { ok: false, problem: `topics must be a non-empty list of MQTT topic filters, not ${JSON.stringify(given)}` };
|
|
||||||
}
|
|
||||||
const out: string[] = [];
|
|
||||||
for (const f of given) {
|
|
||||||
if (typeof f !== "string") {
|
|
||||||
return { ok: false, problem: `topics holds ${JSON.stringify(f)}, which is not a topic filter` };
|
|
||||||
}
|
|
||||||
const problem = filterProblem(f);
|
|
||||||
if (problem) return { ok: false, problem: `topic filter ${JSON.stringify(f)}: ${problem}` };
|
|
||||||
if (!out.includes(f)) out.push(f);
|
|
||||||
}
|
|
||||||
return { ok: true, filters: out, own: out.length === 1 && out[0] === `${as}/#` };
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Why a string is not a valid MQTT topic filter (MQTT 3.1.1 §4.7), or undefined when it is one. */
|
|
||||||
export function filterProblem(filter: string): string | undefined {
|
|
||||||
if (filter.length === 0) return "it is empty";
|
|
||||||
if (Buffer.byteLength(filter, "utf8") > 65535) return "it is longer than MQTT allows";
|
|
||||||
if (filter.includes("\u0000")) return "it contains a NUL character";
|
|
||||||
const levels = filter.split("/");
|
|
||||||
for (let i = 0; i < levels.length; i++) {
|
|
||||||
const level = levels[i];
|
|
||||||
if (level.includes("#") && (level !== "#" || i !== levels.length - 1)) {
|
|
||||||
return "'#' must be a whole level, and the last one";
|
|
||||||
}
|
|
||||||
if (level.includes("+") && level !== "+") return "'+' must be a whole level";
|
|
||||||
}
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The ACLs a role must carry to grant these filters: every granted type, allowed, on every filter. */
|
|
||||||
export function wantedAcls(filters: readonly string[]): Acl[] {
|
|
||||||
const out: Acl[] = [];
|
|
||||||
for (const topic of filters) {
|
|
||||||
for (const type of GRANTED_ACL_TYPES) out.push({ type, allow: true, topic });
|
|
||||||
}
|
|
||||||
return out;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The ACLs `mosquitto_ctrl dynsec getRole` lists, one per line under its "ACLs:" heading:
|
|
||||||
* `ACLs: publishClientSend : allow : # (priority: 0)`
|
|
||||||
* ` subscribePattern : allow : u1/# (priority: 0)`
|
|
||||||
*/
|
|
||||||
export function parseRoleAcls(output: string): Acl[] {
|
|
||||||
const out: Acl[] = [];
|
|
||||||
const line = /^(?:ACLs:)?\s*([A-Za-z]+)\s*:\s*(allow|deny)\s*:\s*(.*?)\s+\(priority:\s*-?\d+\)\s*$/;
|
|
||||||
for (const raw of output.split(/\r?\n/)) {
|
|
||||||
const m = raw.match(line);
|
|
||||||
if (m) out.push({ type: m[1], allow: m[2] === "allow", topic: m[3] });
|
|
||||||
}
|
|
||||||
return out;
|
|
||||||
}
|
|
||||||
|
|
||||||
const key = (a: Acl): string => `${a.type}\u0000${a.allow ? "allow" : "deny"}\u0000${a.topic}`;
|
|
||||||
|
|
||||||
/** ACLs a role carries that it should not: in `current` and not in `wanted`. */
|
|
||||||
export function staleAcls(current: readonly Acl[], wanted: readonly Acl[]): Acl[] {
|
|
||||||
const want = new Set(wanted.map(key));
|
|
||||||
return current.filter((a) => !want.has(key(a)));
|
|
||||||
}
|
|
||||||
|
|
||||||
/** ACLs a role should carry and does not. */
|
|
||||||
export function missingAcls(current: readonly Acl[], wanted: readonly Acl[]): Acl[] {
|
|
||||||
const have = new Set(current.map(key));
|
|
||||||
return wanted.filter((a) => !have.has(key(a)));
|
|
||||||
}
|
|
||||||
@@ -8,5 +8,5 @@
|
|||||||
"skipLibCheck": true,
|
"skipLibCheck": true,
|
||||||
"noEmit": true
|
"noEmit": true
|
||||||
},
|
},
|
||||||
"include": ["topics.ts", "client.ts", "index.ts", "provisioner/index.ts", "tools/index.ts", "bootstrap/index.ts"]
|
"include": ["client.ts", "index.ts", "provisioner/index.ts", "tools/index.ts", "bootstrap/index.ts"]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -20,20 +20,7 @@ COPY . .
|
|||||||
RUN node /app/node_modules/typescript/bin/tsc client.ts index.ts tools/index.ts provisioner/index.ts \
|
RUN node /app/node_modules/typescript/bin/tsc client.ts index.ts tools/index.ts provisioner/index.ts \
|
||||||
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
||||||
|
|
||||||
# **sqlcmd, which this module's client drives, has to be here** — it never was, so every tool failed
|
|
||||||
# with `spawn sqlcmd ENOENT`. go-sqlcmd is one static binary; fetched at a pinned release and checked
|
|
||||||
# against its digest, so a build that receives anything else stops here.
|
|
||||||
FROM ${BUILD_BASE} AS sqlcmd
|
|
||||||
ARG SQLCMD_VERSION=v1.10.0
|
|
||||||
ARG SQLCMD_SHA256=92516d98c63d99b0994de5b61350c91f6915f9b76f139a59039fbcb225c2e987
|
|
||||||
RUN apt-get update && apt-get install -y --no-install-recommends curl ca-certificates bzip2 \
|
|
||||||
&& curl -fsSL -o /tmp/sqlcmd.tar.bz2 \
|
|
||||||
"https://github.com/microsoft/go-sqlcmd/releases/download/${SQLCMD_VERSION}/sqlcmd-linux-amd64.tar.bz2" \
|
|
||||||
&& echo "${SQLCMD_SHA256} /tmp/sqlcmd.tar.bz2" | sha256sum -c - \
|
|
||||||
&& tar -xjf /tmp/sqlcmd.tar.bz2 -C /usr/local/bin sqlcmd
|
|
||||||
|
|
||||||
FROM ${RUNTIME_BASE}
|
FROM ${RUNTIME_BASE}
|
||||||
COPY --from=sqlcmd /usr/local/bin/sqlcmd /usr/local/bin/sqlcmd
|
|
||||||
COPY --from=build /app/modules/mssql/dist /app/modules/mssql/dist
|
COPY --from=build /app/modules/mssql/dist /app/modules/mssql/dist
|
||||||
# Every serve-time entrypoint, loaded by the runtime in serve mode: tools and events serve, and a
|
# Every serve-time entrypoint, loaded by the runtime in serve mode: tools and events serve, and a
|
||||||
# provider's provisioner runs its reconcile loop in the same process, with the broker connected —
|
# provider's provisioner runs its reconcile loop in the same process, with the broker connected —
|
||||||
|
|||||||
+10
-107
@@ -29,40 +29,11 @@ export interface MssqlConn {
|
|||||||
readonly port: number;
|
readonly port: number;
|
||||||
readonly user: string;
|
readonly user: string;
|
||||||
readonly password: string;
|
readonly password: string;
|
||||||
/**
|
|
||||||
* The read-only login's password, which the mesh mints for this module (`own-secrets.reader`).
|
|
||||||
* Absent when the mesh has not delivered it: then a caller's statement is refused, never run as
|
|
||||||
* the administrator (novox/hq issue 193).
|
|
||||||
*/
|
|
||||||
readonly readerPassword?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The login a caller's statement runs as (novox/hq issue 193). It may connect to every database and
|
|
||||||
* read every table, and holds no other permission. A statement cannot climb out of a login the way it
|
|
||||||
* could out of a transaction wrapped around it as text, and the administrator — who can run programs
|
|
||||||
* on the server — never runs a caller's text.
|
|
||||||
*/
|
|
||||||
export const READER = "mesh_mssql_reader";
|
|
||||||
|
|
||||||
/** Who a sqlcmd invocation logs in as, and whether the text is a caller's rather than the module's. */
|
|
||||||
interface Invocation {
|
|
||||||
readonly user: string;
|
|
||||||
readonly password: string;
|
|
||||||
/**
|
|
||||||
* A caller's text: sqlcmd substitutes no `$(NAME)` in it, which would read this process's
|
|
||||||
* environment — the administrator's password among it. (Its own commands are kept out by the
|
|
||||||
* caller's text never beginning a line; see readOnlyQuery.)
|
|
||||||
*/
|
|
||||||
readonly caller: boolean;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export class MssqlClient {
|
export class MssqlClient {
|
||||||
constructor(private readonly conn: MssqlConn) {}
|
constructor(private readonly conn: MssqlConn) {}
|
||||||
|
|
||||||
/** The reader is made once per process: idempotent, and repeating it re-sets a rotated password. */
|
|
||||||
private readerReady?: Promise<void>;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Build from the module's resolved environment. Reads MESH_MSSQL_* first (the documented
|
* Build from the module's resolved environment. Reads MESH_MSSQL_* first (the documented
|
||||||
* names), falling back to the MESH_PROVISION_* keys the manifest already sets on the provisioner
|
* names), falling back to the MESH_PROVISION_* keys the manifest already sets on the provisioner
|
||||||
@@ -77,9 +48,7 @@ export class MssqlClient {
|
|||||||
if (!host || !password) {
|
if (!host || !password) {
|
||||||
throw new Error("mssql host or admin password is not set — mssql's own code cannot reach the server");
|
throw new Error("mssql host or admin password is not set — mssql's own code cannot reach the server");
|
||||||
}
|
}
|
||||||
const readerPassword = env.MESH_MSSQL_READER_PASSWORD ??
|
return new MssqlClient({ host, port, user, password });
|
||||||
readSecretFile(env.MESH_MSSQL_READER_PASSWORD_FILE);
|
|
||||||
return new MssqlClient({ host, port, user, password, readerPassword });
|
|
||||||
}
|
}
|
||||||
|
|
||||||
get host(): string {
|
get host(): string {
|
||||||
@@ -117,12 +86,7 @@ export class MssqlClient {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/** The one execution boundary: invoke `sqlcmd` and return its concatenated stdout. */
|
/** The one execution boundary: invoke `sqlcmd` and return its concatenated stdout. */
|
||||||
private async sqlcmd(
|
private async sqlcmd(sql: string, database: string, variables: Record<string, string> = {}): Promise<string> {
|
||||||
sql: string,
|
|
||||||
database: string,
|
|
||||||
variables: Record<string, string> = {},
|
|
||||||
as: Invocation = { user: this.conn.user, password: this.conn.password, caller: false },
|
|
||||||
): Promise<string> {
|
|
||||||
// `-h -1` drops the column-header rule; `-y 0`/`-Y 0` lift the display-width cap so a long
|
// `-h -1` drops the column-header rule; `-y 0`/`-Y 0` lift the display-width cap so a long
|
||||||
// JSON document is not truncated; `-W` trims trailing whitespace so the JSON chunks rejoin
|
// JSON document is not truncated; `-W` trims trailing whitespace so the JSON chunks rejoin
|
||||||
// cleanly. sqlcmd from the mssql-tools ships in the runtime container, the way `psql` ships
|
// cleanly. sqlcmd from the mssql-tools ships in the runtime container, the way `psql` ships
|
||||||
@@ -131,9 +95,8 @@ export class MssqlClient {
|
|||||||
"sqlcmd",
|
"sqlcmd",
|
||||||
[
|
[
|
||||||
"-S", `${this.conn.host},${this.conn.port}`,
|
"-S", `${this.conn.host},${this.conn.port}`,
|
||||||
"-U", as.user,
|
"-U", this.conn.user,
|
||||||
"-d", database,
|
"-d", database,
|
||||||
...(as.caller ? ["-x"] : []),
|
|
||||||
"-C",
|
"-C",
|
||||||
"-b",
|
"-b",
|
||||||
"-h", "-1",
|
"-h", "-1",
|
||||||
@@ -144,7 +107,7 @@ export class MssqlClient {
|
|||||||
],
|
],
|
||||||
// `variables` reach sqlcmd as environment variables, which it substitutes as `$(NAME)` scripting
|
// `variables` reach sqlcmd as environment variables, which it substitutes as `$(NAME)` scripting
|
||||||
// variables: a value that must not appear on argv, or in the message of a failed command.
|
// variables: a value that must not appear on argv, or in the message of a failed command.
|
||||||
{ env: { ...process.env, ...variables, SQLCMDPASSWORD: as.password }, maxBuffer: 16 << 20 },
|
{ env: { ...process.env, ...variables, SQLCMDPASSWORD: this.conn.password }, maxBuffer: 16 << 20 },
|
||||||
);
|
);
|
||||||
return stdout;
|
return stdout;
|
||||||
}
|
}
|
||||||
@@ -262,78 +225,18 @@ export class MssqlClient {
|
|||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/** Run a read-only SELECT against a named database, for the mssql_query tool. */
|
||||||
* Make the read-only login, idempotently, with the password the mesh minted for it: it may connect
|
|
||||||
* to every database and read every table, and is taken out of the administrators' role should
|
|
||||||
* anyone have put it there. Run as the administrator, because only it can make a login.
|
|
||||||
*/
|
|
||||||
async ensureReader(): Promise<void> {
|
|
||||||
const password = this.conn.readerPassword;
|
|
||||||
if (!password) throw readerMissing();
|
|
||||||
const logins = await this.query(
|
|
||||||
`SELECT 1 AS ok FROM sys.server_principals WHERE name = ${literal(READER)}`,
|
|
||||||
);
|
|
||||||
if (logins.length === 0) {
|
|
||||||
await this.exec(
|
|
||||||
`CREATE LOGIN ${ident(READER)} WITH PASSWORD = ${literal(password)}, CHECK_POLICY = OFF`,
|
|
||||||
);
|
|
||||||
} else {
|
|
||||||
await this.exec(`ALTER LOGIN ${ident(READER)} WITH PASSWORD = ${literal(password)}`);
|
|
||||||
await this.exec(`ALTER LOGIN ${ident(READER)} ENABLE`);
|
|
||||||
}
|
|
||||||
await this.exec(
|
|
||||||
`IF IS_SRVROLEMEMBER('sysadmin', ${literal(READER)}) = 1 ` +
|
|
||||||
`ALTER SERVER ROLE sysadmin DROP MEMBER ${ident(READER)}`,
|
|
||||||
);
|
|
||||||
await this.exec(`GRANT CONNECT ANY DATABASE TO ${ident(READER)}`);
|
|
||||||
await this.exec(`GRANT SELECT ALL USER SECURABLES TO ${ident(READER)}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Run a caller's SELECT against a named database as the read-only login, for the mssql_query tool
|
|
||||||
* (novox/hq issue 193). Read-only by the login, not by a transaction wrapped around the text; the
|
|
||||||
* rows are rendered by FOR JSON. Never as the administrator: without the reader's password the call
|
|
||||||
* is refused.
|
|
||||||
*/
|
|
||||||
async readOnlyQuery(database: string, sql: string): Promise<QueryResult> {
|
async readOnlyQuery(database: string, sql: string): Promise<QueryResult> {
|
||||||
const password = this.conn.readerPassword;
|
// The read-only guarantee is a wrapping transaction that is always rolled back: any write the
|
||||||
if (!password) throw readerMissing();
|
// statement attempts is undone. The rows are rendered by FOR JSON inside query().
|
||||||
// **One line, refused otherwise.** sqlcmd reads a line that BEGINS with `:` or `!!` as its own
|
const rows = await this.query(
|
||||||
// command rather than SQL, and `:!!` starts a program in this container, which holds the
|
`BEGIN TRANSACTION;\n${stripTrailingSemis(sql)}\nFOR JSON PATH, INCLUDE_NULL_VALUES;\nROLLBACK;`,
|
||||||
// administrator's password. Its switch for refusing those (-X) makes it ignore -Q in the
|
|
||||||
// version shipped here, so instead no line of a caller's text can begin one: the text follows
|
|
||||||
// this module's own on the first line, and a line break in it is refused. Proven on a throwaway
|
|
||||||
// server: the same text at the start of a line ran a program; mid-line it is a syntax error.
|
|
||||||
if (/[\r\n]/.test(sql)) {
|
|
||||||
throw new Error(
|
|
||||||
"mssql_query: the statement must be one line — sqlcmd takes a line beginning with ':' or " +
|
|
||||||
"'!!' as a command of its own, which can start a program (novox/hq issue 193)",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
this.readerReady ??= this.ensureReader().catch((err) => {
|
|
||||||
this.readerReady = undefined; // asked again next call, not failed for the process's life
|
|
||||||
throw err;
|
|
||||||
});
|
|
||||||
await this.readerReady;
|
|
||||||
const stdout = await this.sqlcmd(
|
|
||||||
`SET NOCOUNT ON; ${stripTrailingSemis(sql)}\nFOR JSON PATH, INCLUDE_NULL_VALUES;`,
|
|
||||||
database,
|
database,
|
||||||
{},
|
|
||||||
{ user: READER, password, caller: true },
|
|
||||||
);
|
);
|
||||||
const command = /^\s*([A-Za-z]+)/.exec(sql)?.[1]?.toUpperCase() ?? "";
|
return { command: sql.trimStart().split(/\s+/)[0]?.toUpperCase() ?? "", rows };
|
||||||
return { command, rows: parseJsonRows(stdout) };
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function readerMissing(): Error {
|
|
||||||
return new Error(
|
|
||||||
"the read-only login's password was not delivered (own-secrets.reader, " +
|
|
||||||
"MESH_MSSQL_READER_PASSWORD_FILE), so the statement is refused rather than run as the " +
|
|
||||||
"administrator (novox/hq issue 193)",
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Generate a URL-safe password. */
|
/** Generate a URL-safe password. */
|
||||||
export function generatePassword(): string {
|
export function generatePassword(): string {
|
||||||
return randomBytes(24).toString("base64url");
|
return randomBytes(24).toString("base64url");
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user