mesh-tools
05e6b583e2
mesh/merge-gate head 05e6b583e2e3 merged into trunk ce56b491cffd — pass: builds ssh-client → ace, g14, novox, shanks; no bus step; every machine composes w…
mesh/repo-check head 05e6b583e2e3 merged into trunk ce56b491cffd — pass: THE CHANGE ALTERS ITS OWN CHECK (merge-check.sh): main's version judged it; the ch…
mesh/delivery delivered
The sweep from issue 1017 moved known_hosts2, rc and environment, which ssh and sshd read by default, and moved a link to a folder of keys, breaking every login through it. It could move a file a tool was still writing. When ~/.local was on another file system, every sweep failed at its first move and left an empty folder each round, seen only in the journal. Its list was written after the moves with errors ignored. Now those files and linked key folders stay; a link whose target, or the folder it names, cannot be checked is left and named; a copy of authorized_keys is moved at any depth; a path changed in the last minute, at any depth, waits for the next sweep; a retired folder on another file system fails the sweep before anything is made; the list names each move before it is made; and each sweep's outcome is kept for ssh_client_check, which shows a failed sweep as a problem. A key's first line is read only so far. The catalogue's new checks/sshdir refuses any manifest but ssh-client naming a path under ~/.ssh (ADR 0415 §6). The README cites §7 for config.d.
113 lines
3.1 KiB
Go
113 lines
3.1 KiB
Go
// Command sshdir refuses any manifest but modules/ssh-client naming a path under ~/.ssh (novox/hq ADR 0415 §6,
|
|
// issue 1020): ssh-client owns ~/.ssh and sweeps what it does not know, so a path another module placed there
|
|
// would be moved out at the next sweep. A module that needs something there provides it to ssh-client instead.
|
|
//
|
|
// go run . <catalogue root>
|
|
//
|
|
// Every string of a manifest is read, wherever it stands, except prose and a file's text (Prose): a path, a
|
|
// place, a volume. Exits 1 on a finding.
|
|
package main
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"regexp"
|
|
"sort"
|
|
)
|
|
|
|
// SSHModule is the one module allowed to name a path under ~/.ssh.
|
|
const SSHModule = "ssh-client"
|
|
|
|
// underSSH is a path under ~/.ssh, or ~/.ssh itself, however the home is spelled: ${machine:account-home}/.ssh,
|
|
// ~/.ssh, .ssh/config, or a volume's host side (…/.ssh:/root/.ssh).
|
|
var underSSH = regexp.MustCompile(`(^|[/~])\.ssh($|[/:])`)
|
|
|
|
// Prose are the keys whose strings are words or a file's text, not a path: a template may say ~/.ssh in a comment.
|
|
var Prose = map[string]bool{"description": true, "why": true, "does": true, "template": true, "content": true, "title": true}
|
|
|
|
// Finding is one path under ~/.ssh in a manifest other than ssh-client's.
|
|
type Finding struct {
|
|
Module string
|
|
Key string
|
|
Value string
|
|
}
|
|
|
|
// Check reads every manifest under root/modules and answers which paths it refuses.
|
|
func Check(root string) ([]Finding, error) {
|
|
manifests, err := filepath.Glob(filepath.Join(root, "modules", "*", "module.json"))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
sort.Strings(manifests)
|
|
var out []Finding
|
|
for _, path := range manifests {
|
|
raw, err := os.ReadFile(path)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
var m any
|
|
if err := json.Unmarshal(raw, &m); err != nil {
|
|
return nil, fmt.Errorf("%s: %w", path, err)
|
|
}
|
|
module := filepath.Base(filepath.Dir(path))
|
|
if obj, ok := m.(map[string]any); ok {
|
|
if name, ok := obj["module"].(string); ok && name != "" {
|
|
module = name
|
|
}
|
|
}
|
|
if module == SSHModule {
|
|
continue
|
|
}
|
|
walk(m, "", func(key, value string) {
|
|
out = append(out, Finding{Module: module, Key: key, Value: value})
|
|
})
|
|
}
|
|
return out, nil
|
|
}
|
|
|
|
// walk calls found for every string under v, outside Prose, that names a path under ~/.ssh.
|
|
func walk(v any, key string, found func(key, value string)) {
|
|
switch x := v.(type) {
|
|
case map[string]any:
|
|
keys := make([]string, 0, len(x))
|
|
for k := range x {
|
|
keys = append(keys, k)
|
|
}
|
|
sort.Strings(keys)
|
|
for _, k := range keys {
|
|
if !Prose[k] {
|
|
walk(x[k], k, found)
|
|
}
|
|
}
|
|
case []any:
|
|
for _, e := range x {
|
|
walk(e, key, found)
|
|
}
|
|
case string:
|
|
if underSSH.MatchString(x) {
|
|
found(key, x)
|
|
}
|
|
}
|
|
}
|
|
|
|
func main() {
|
|
root := "."
|
|
if len(os.Args) > 1 {
|
|
root = os.Args[1]
|
|
}
|
|
found, err := Check(root)
|
|
if err != nil {
|
|
fmt.Fprintln(os.Stderr, err)
|
|
os.Exit(1)
|
|
}
|
|
for _, f := range found {
|
|
fmt.Printf("%s names %q (%s) under ~/.ssh: only %s may, and the sweep moves anything else out (novox/hq ADR 0415 §6)\n", f.Module, f.Value, f.Key, SSHModule)
|
|
}
|
|
if len(found) > 0 {
|
|
os.Exit(1)
|
|
}
|
|
fmt.Println("~/.ssh: named only by ssh-client")
|
|
}
|