Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

Read action token file modes portably on macOS

rcourtmane78f17979e81
diff --git a/cmd/pulse-agent/collector_token_ingress_unix_test.go b/cmd/pulse-agent/collector_token_ingress_unix_test.go
new file mode 100644
index 0000000000..dd57bbd787
--- /dev/null
+++ b/cmd/pulse-agent/collector_token_ingress_unix_test.go
@@ -0,0 +1,133 @@
+//go:build !windows
+
+package main
+
+import (
+ "bytes"
+ "context"
+ "os"
+ "os/exec"
+ "path/filepath"
+ "regexp"
+ "strings"
+ "testing"
+ "time"
+)
+
+// Run the real main/CLI dispatch inside the compiled test executable, before
+// any agent module can start. No synthetic token-reader output is substituted.
+func TestCollectorLifecycleTokenReaderProcess(t *testing.T) {
+ if os.Getenv("PULSE_TEST_COLLECTOR_TOKEN_READER") != "1" {
+ return
+ }
+ for i, arg := range os.Args {
+ if arg == "--" && i+1 < len(os.Args) && os.Args[i+1] == collectorReadTokenCommand {
+ os.Args = append(os.Args[:1], os.Args[i+1:]...)
+ main()
+ os.Exit(0) // Do not append the test harness's PASS line to the value.
+ }
+ }
+ os.Exit(90)
+}
+
+func TestCollectorTokenReaderInstallerIngress(t *testing.T) {
+ source, err := os.ReadFile(filepath.Join("..", "..", "scripts", "install.sh"))
+ if err != nil {
+ t.Fatal(err)
+ }
+ var functions strings.Builder
+ for _, name := range []string{"portable_path_uid", "portable_path_mode", "trusted_lifecycle_regular_file",
+ "trusted_private_lifecycle_regular_file", "read_collector_token_file_safely"} {
+ function := regexp.MustCompile(`(?ms)^` + name + `\(\) \{\n.*?^\}`).Find(source)
+ if len(function) == 0 {
+ t.Fatalf("missing production function %s", name)
+ }
+ functions.Write(function)
+ functions.WriteByte('\n')
+ }
+ _, ingress, ok := strings.Cut(string(source), "# Read token from file if --token-file was provided\n")
+ if !ok {
+ t.Fatal("missing production token ingress")
+ }
+ ingress, _, ok = strings.Cut(ingress, `if [[ -n "$PROXMOX_TYPE"`)
+ if !ok {
+ t.Fatal("missing production token ingress boundary")
+ }
+ testBinary, err := os.Executable()
+ if err != nil {
+ t.Fatal(err)
+ }
+ for name, encoded := range map[string]string{
+ "bare": "synthetic-secret", "LF": "synthetic-secret\n",
+ "normalized": " \tsynthetic-secret\r\n", "literal": "PULSE_TOKEN='synthetic-secret'",
+ "UTF8": "synthetic-caf\u00e9", "limit": strings.Repeat("s", 4096),
+ "NUL leading": "\x00synthetic-secret", "NUL interior": "synthetic\x00-secret",
+ "NUL trailing": "synthetic-secret\x00", "NUL before LF": "synthetic-secret\x00\n",
+ "NUL after LF": "synthetic-secret\n\x00", "NUL only": "\x00",
+ } {
+ for _, option := range []string{"collector", "action"} {
+ t.Run(name+"/"+option, func(t *testing.T) {
+ directory := t.TempDir()
+ path := filepath.Join(directory, "selected.token")
+ if err := os.WriteFile(path, []byte(encoded), 0600); err != nil {
+ t.Fatal(err)
+ }
+ before, err := os.Stat(path)
+ if err != nil {
+ t.Fatal(err)
+ }
+ // Only executable discovery is fixture-wired. File/parent trust,
+ // the Go reader, shell substitution and both ingress gates are real.
+ reader := filepath.Join(directory, "reader")
+ adapter := "#!/usr/bin/env bash\nset -eu\nprintf 'invoked\\n' >> \"$READER_EVENTS\"\n" +
+ "exec \"$READER_TEST_BINARY\" -test.run='^TestCollectorLifecycleTokenReaderProcess$' -- \"$@\"\n"
+ if err := os.WriteFile(reader, []byte(adapter), 0755); err != nil {
+ t.Fatal(err)
+ }
+ if err := os.Chmod(reader, 0755); err != nil {
+ t.Fatal(err)
+ }
+ script := `set -euo pipefail
+STATE_DIR="$FIXTURE"
+RUNTIME_TOKEN_FILE="" PULSE_TOKEN="" ACTION_TOKEN=""
+TOKEN_FILE_PATH="" ACTION_TOKEN_FILE_PATH="" EXIT_MISSING_ARGS=16
+LEAST_PRIVILEGE_USER="$(id -u)"
+collector_lifecycle_binary() { printf '%s\n' "$READER"; }
+fail() { printf '%s\n' "$1" >&2; exit "$2"; }
+if [[ "$TOKEN_OPTION" == collector ]]; then TOKEN_FILE_PATH="$SELECTED"; else ACTION_TOKEN_FILE_PATH="$SELECTED"; fi
+` + functions.String() + ingress + `printf '%s' "$PULSE_TOKEN$ACTION_TOKEN"`
+ ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+ defer cancel()
+ cmd := exec.CommandContext(ctx, "bash", "-c", script)
+ cmd.Env = append(os.Environ(), "PULSE_TEST_COLLECTOR_TOKEN_READER=1", "FIXTURE="+directory,
+ "SELECTED="+path, "READER="+reader, "READER_TEST_BINARY="+testBinary,
+ "READER_EVENTS="+filepath.Join(directory, "events"), "TOKEN_OPTION="+option)
+ var stdout, stderr bytes.Buffer
+ cmd.Stdout, cmd.Stderr = &stdout, &stderr
+ err = cmd.Run()
+ if strings.ContainsRune(encoded, 0) {
+ if err == nil || cmd.ProcessState.ExitCode() != 16 || stdout.Len() != 0 {
+ t.Fatal("malformed credential was not refused without output at installer ingress")
+ }
+ if strings.Contains(stderr.String(), "synthetic") || strings.Contains(stderr.String(), "ignored null byte") {
+ t.Fatal("malformed credential reached shell output or lossy substitution")
+ }
+ } else if err != nil || stdout.String() != strings.TrimSpace(encoded) || stderr.Len() != 0 {
+ t.Fatal("valid credential did not reach the installer unchanged after existing normalization")
+ }
+ events, err := os.ReadFile(filepath.Join(directory, "events"))
+ if err != nil || string(events) != "invoked\n" {
+ t.Fatal("production Go command was not invoked exactly once")
+ }
+ after, err := os.Stat(path)
+ if err != nil || !os.SameFile(before, after) || before.Mode() != after.Mode() {
+ t.Fatal("token ingress replaced the caller's file or changed its mode")
+ }
+ content, err := os.ReadFile(path)
+ if err != nil || !bytes.Equal(content, []byte(encoded)) {
+ t.Fatal("token ingress changed the caller's credential bytes")
+ }
+ })
+ }
+ }
+}
diff --git a/scripts/install.sh b/scripts/install.sh
index e52e3a3450..07ea20b7d3 100755
--- a/scripts/install.sh
+++ b/scripts/install.sh
@@ -6081,7 +6081,8 @@ if [[ -n "$ACTION_TOKEN_FILE_PATH" ]]; then
if [[ ! -f "$ACTION_TOKEN_FILE_PATH" || -L "$ACTION_TOKEN_FILE_PATH" ]]; then
fail "Action token file must be a regular non-symlink file: ${ACTION_TOKEN_FILE_PATH}" "$EXIT_MISSING_ARGS"
fi
- ACTION_TOKEN_MODE=$(stat -c '%a' "$ACTION_TOKEN_FILE_PATH" 2>/dev/null || true)
+ # GNU and BSD stat differ; a GNU-only read refused every action token on macOS.
+ ACTION_TOKEN_MODE=$(portable_path_mode "$ACTION_TOKEN_FILE_PATH" || true)
if [[ ! "$ACTION_TOKEN_MODE" =~ ^[0-7]{3,4}$ ]] || (( (8#$ACTION_TOKEN_MODE & 8#077) != 0 )); then
fail "Action token file must be inaccessible to group and other users (mode 0600 or stricter)" "$EXIT_MISSING_ARGS"
fi