Files
archie/examples/secret-engines/sops.go
T
sam a5a878c2d0 feat(secret): add sops, vault/openbao and age engine plugins
CLI-based, env-configured, cache-less engines resolving SecretRef values
through the existing Yaegi plugin surface. Fresh resolve per call, so
values updated in the backend are picked up without daemon restart —
closing the gap that motivated the remote secret-input epic (#504),
whose value-entry web form duplicated the Bitwarden app for bws.

- examples/secret-engines/: sops (SOPS_FILE), vault (VAULT_ADDR/TOKEN,
  key "path/field" or VAULT_SECRET_PATH prefix), age (AGE_FILE/
  AGE_IDENTITY, key=value lines). //go:build ignore keeps them out of
  the Go toolchain; yaegi treats the tag as a comment and loads them.
- enginehost: host-side Run helper registered as a Yaegi symbol. yaegi's
  interpreted os/exec cannot pass env to child processes, so plugins
  shell out through host code; bounded by a 30s timeout like the bws
  engine.
- secret.LoadDir seeds the interpreter with the host environment: yaegi's
  interpreted os package keeps a private env otherwise, and plugin
  os.Getenv would silently see nothing.
- cmd/archied wires enginehost + unrestricted symbols into the engine
  plugin loader, matching skillscript's interpretation posture.
- tests load the real shipped plugin files with fake CLIs on PATH;
  added CONTEXT.md glossary for the remote secret-input vocabulary.
2026-08-18 00:32:57 +10:00

59 lines
2.0 KiB
Go

//go:build ignore
// sops secret engine plugin for archied.
//
// Resolves a SecretRef key to its plaintext value from a sops-encrypted
// file. Requires the sops CLI on PATH and the SOPS_FILE env var naming the
// encrypted file. Decryption keys are handled by sops itself via .sops.yaml
// or --age/--pgp configuration; no credentials are configured here.
//
// Install: copy this file into the configured secret_engine_dir (default
// ~/.config/archie/secret-engines) and restart archied. The daemon
// evaluates it with Yaegi and registers engine "sops". The //go:build
// ignore tag is a comment to the interpreter, so this file loads normally;
// the Go toolchain skips it, so it may live inside the module tree.
//
// The CLI is run through enginehost.Run rather than os/exec because
// yaegi's interpreted os/exec cannot pass an environment to child
// processes; env config is read with os.Getenv, which the daemon seeds
// with the host environment.
//
// Key names must be plain leaf names (e.g. "DB_PASSWORD"). Nested
// sops --extract JSON paths are not supported; quotes, backslashes and
// brackets in keys are rejected with a clear error.
package main
import (
"errors"
"fmt"
"os"
"strings"
"github.com/samcharles93/archie-core/internal/secret"
"github.com/samcharles93/archie-core/internal/secret/enginehost"
)
var Engine = secret._Engine{
WName: func() string { return "sops" },
WVersion: func() string { return "1.0.0" },
WResolve: resolveSops,
}
func resolveSops(key string) (string, error) {
file := os.Getenv("SOPS_FILE")
if file == "" {
return "", errors.New("sops engine: SOPS_FILE is not set")
}
if strings.ContainsAny(key, `"\[`) {
return "", fmt.Errorf("sops engine: key %q is not a valid --extract path", key)
}
value, err := enginehost.Run("sops", []string{"-d", "--extract", `["` + key + `"]`, file})
if err != nil {
return "", fmt.Errorf("sops engine: decrypt %s: %w", file, err)
}
if value == "" {
return "", fmt.Errorf("sops engine: key %q not found in %s", key, file)
}
return value, nil
}