mirror of
https://github.com/Mic92/sops-nix.git
synced 2025-12-26 14:14:58 +08:00
692f94d84a
gosec only found int to uint downcasts which are unavoidable as sadly the go API usually uses int instead of uint in places.
364 lines
9.2 KiB
Go
364 lines
9.2 KiB
Go
//go:build linux || darwin
|
|
// +build linux darwin
|
|
|
|
package main
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"os"
|
|
"os/exec"
|
|
"os/user"
|
|
"path"
|
|
"path/filepath"
|
|
"reflect"
|
|
"runtime"
|
|
"strconv"
|
|
"strings"
|
|
"syscall"
|
|
"testing"
|
|
)
|
|
|
|
// ok fails the test if an err is not nil.
|
|
func ok(tb testing.TB, err error) {
|
|
if err != nil {
|
|
_, file, line, _ := runtime.Caller(1)
|
|
fmt.Printf("\033[31m%s:%d: unexpected error: %s\033[39m\n\n", filepath.Base(file), line, err.Error())
|
|
tb.FailNow()
|
|
}
|
|
}
|
|
|
|
func equals(tb testing.TB, exp, act interface{}) {
|
|
if !reflect.DeepEqual(exp, act) {
|
|
_, file, line, _ := runtime.Caller(1)
|
|
fmt.Printf("\033[31m%s:%d:\n\n\texp: %#v\n\n\tgot: %#v\033[39m\n\n", filepath.Base(file), line, exp, act)
|
|
tb.FailNow()
|
|
}
|
|
}
|
|
|
|
func writeManifest(t *testing.T, dir string, m *manifest) string {
|
|
filename := path.Join(dir, "manifest.json")
|
|
f, err := os.OpenFile(filename, os.O_RDWR|os.O_CREATE, 0o755)
|
|
ok(t, err)
|
|
encoder := json.NewEncoder(f)
|
|
ok(t, encoder.Encode(m))
|
|
_ = f.Close()
|
|
return filename
|
|
}
|
|
|
|
func testAssetPath() string {
|
|
assets := os.Getenv("TEST_ASSETS")
|
|
if assets != "" {
|
|
return assets
|
|
}
|
|
_, filename, _, _ := runtime.Caller(0)
|
|
return path.Join(path.Dir(filename), "test-assets")
|
|
}
|
|
|
|
type testDir struct {
|
|
path, secretsPath, symlinkPath string
|
|
}
|
|
|
|
func (dir testDir) Remove() {
|
|
_ = os.RemoveAll(dir.path)
|
|
}
|
|
|
|
func newTestDir(t *testing.T) testDir {
|
|
tempdir, err := os.MkdirTemp("", "symlinkDir")
|
|
ok(t, err)
|
|
return testDir{tempdir, path.Join(tempdir, "secrets.d"), path.Join(tempdir, "secrets")}
|
|
}
|
|
|
|
func testInstallSecret(t *testing.T, testdir testDir, m *manifest) {
|
|
path := writeManifest(t, testdir.path, m)
|
|
ok(t, installSecrets([]string{"sops-install-secrets", path}))
|
|
}
|
|
|
|
func testGPG(t *testing.T) {
|
|
assets := testAssetPath()
|
|
|
|
testdir := newTestDir(t)
|
|
defer testdir.Remove()
|
|
gpgHome := path.Join(testdir.path, "gpg-home")
|
|
gpgEnv := append(os.Environ(), fmt.Sprintf("GNUPGHOME=%s", gpgHome))
|
|
|
|
ok(t, os.Mkdir(gpgHome, os.FileMode(0o700)))
|
|
cmd := exec.Command("gpg", "--import", path.Join(assets, "key.asc")) // nolint:gosec
|
|
cmd.Stdout = os.Stdout
|
|
cmd.Stderr = os.Stderr
|
|
cmd.Env = gpgEnv
|
|
ok(t, cmd.Run())
|
|
stopGpgCmd := exec.Command("gpgconf", "--kill", "gpg-agent")
|
|
stopGpgCmd.Stdout = os.Stdout
|
|
stopGpgCmd.Stderr = os.Stderr
|
|
stopGpgCmd.Env = gpgEnv
|
|
defer func() {
|
|
if err := stopGpgCmd.Run(); err != nil {
|
|
fmt.Printf("failed to stop gpg-agent: %s\n", err)
|
|
}
|
|
}()
|
|
|
|
nobody := "nobody"
|
|
nogroup := "nogroup"
|
|
// should create a symlink
|
|
yamlSecret := secret{
|
|
Name: "test",
|
|
Key: "test_key",
|
|
Owner: &nobody,
|
|
Group: &nogroup,
|
|
SopsFile: path.Join(assets, "secrets.yaml"),
|
|
Path: path.Join(testdir.path, "test-target"),
|
|
Mode: "0400",
|
|
RestartUnits: []string{"affected-service"},
|
|
ReloadUnits: []string{"affected-reload-service"},
|
|
}
|
|
|
|
var jsonSecret, binarySecret, dotenvSecret, iniSecret secret
|
|
root := "root"
|
|
// should not create a symlink
|
|
jsonSecret = yamlSecret
|
|
jsonSecret.Name = "test2"
|
|
jsonSecret.Owner = &root
|
|
jsonSecret.Format = "json"
|
|
jsonSecret.Group = &root
|
|
jsonSecret.SopsFile = path.Join(assets, "secrets.json")
|
|
jsonSecret.Path = path.Join(testdir.secretsPath, "test2")
|
|
jsonSecret.Mode = "0700"
|
|
|
|
binarySecret = yamlSecret
|
|
binarySecret.Name = "test3"
|
|
binarySecret.Format = "binary"
|
|
binarySecret.SopsFile = path.Join(assets, "secrets.bin")
|
|
binarySecret.Path = path.Join(testdir.secretsPath, "test3")
|
|
|
|
dotenvSecret = yamlSecret
|
|
dotenvSecret.Name = "test4"
|
|
dotenvSecret.Owner = &root
|
|
dotenvSecret.Group = &root
|
|
dotenvSecret.Format = "dotenv"
|
|
dotenvSecret.SopsFile = path.Join(assets, "secrets.env")
|
|
dotenvSecret.Path = path.Join(testdir.secretsPath, "test4")
|
|
|
|
iniSecret = yamlSecret
|
|
iniSecret.Name = "test5"
|
|
iniSecret.Owner = &root
|
|
iniSecret.Group = &root
|
|
iniSecret.Format = "ini"
|
|
iniSecret.SopsFile = path.Join(assets, "secrets.ini")
|
|
iniSecret.Path = path.Join(testdir.secretsPath, "test5")
|
|
|
|
manifest := manifest{
|
|
Secrets: []secret{yamlSecret, jsonSecret, binarySecret, dotenvSecret, iniSecret},
|
|
SecretsMountPoint: testdir.secretsPath,
|
|
SymlinkPath: testdir.symlinkPath,
|
|
GnupgHome: gpgHome,
|
|
}
|
|
|
|
testInstallSecret(t, testdir, &manifest)
|
|
|
|
_, err := os.Stat(manifest.SecretsMountPoint)
|
|
ok(t, err)
|
|
|
|
_, err = os.Stat(manifest.SymlinkPath)
|
|
ok(t, err)
|
|
|
|
yamlLinkStat, err := os.Lstat(yamlSecret.Path)
|
|
ok(t, err)
|
|
|
|
equals(t, os.ModeSymlink, yamlLinkStat.Mode()&os.ModeSymlink)
|
|
|
|
yamlStat, err := os.Stat(yamlSecret.Path)
|
|
ok(t, err)
|
|
|
|
equals(t, true, yamlStat.Mode().IsRegular())
|
|
equals(t, 0o400, int(yamlStat.Mode().Perm()))
|
|
stat, success := yamlStat.Sys().(*syscall.Stat_t)
|
|
equals(t, true, success)
|
|
content, err := os.ReadFile(yamlSecret.Path)
|
|
ok(t, err)
|
|
equals(t, "test_value", string(content))
|
|
|
|
u, err := user.LookupId(strconv.Itoa(int(stat.Uid)))
|
|
ok(t, err)
|
|
equals(t, "nobody", u.Username)
|
|
|
|
g, err := user.LookupGroupId(strconv.Itoa(int(stat.Gid)))
|
|
ok(t, err)
|
|
equals(t, "nogroup", g.Name)
|
|
|
|
jsonStat, err := os.Stat(jsonSecret.Path)
|
|
ok(t, err)
|
|
equals(t, true, jsonStat.Mode().IsRegular())
|
|
equals(t, 0o700, int(jsonStat.Mode().Perm()))
|
|
if stat, ok := jsonStat.Sys().(*syscall.Stat_t); ok {
|
|
equals(t, 0, int(stat.Uid))
|
|
equals(t, 0, int(stat.Gid))
|
|
}
|
|
|
|
content, err = os.ReadFile(binarySecret.Path)
|
|
ok(t, err)
|
|
equals(t, 13, len(content))
|
|
|
|
testInstallSecret(t, testdir, &manifest)
|
|
|
|
target, err := os.Readlink(testdir.symlinkPath)
|
|
ok(t, err)
|
|
equals(t, path.Join(testdir.secretsPath, "2"), target)
|
|
}
|
|
|
|
func testSSHKey(t *testing.T) {
|
|
assets := testAssetPath()
|
|
|
|
testdir := newTestDir(t)
|
|
defer testdir.Remove()
|
|
|
|
target := path.Join(testdir.path, "existing-target")
|
|
file, err := os.Create(target)
|
|
ok(t, err)
|
|
_ = file.Close()
|
|
|
|
nobody := "nobody"
|
|
nogroup := "nogroup"
|
|
s := secret{
|
|
Name: "test",
|
|
Key: "test_key",
|
|
Owner: &nobody,
|
|
Group: &nogroup,
|
|
SopsFile: path.Join(assets, "secrets.yaml"),
|
|
Path: target,
|
|
Mode: "0400",
|
|
RestartUnits: []string{"affected-service"},
|
|
ReloadUnits: []string{"affected-reload-service"},
|
|
}
|
|
|
|
m := manifest{
|
|
Secrets: []secret{s},
|
|
SecretsMountPoint: testdir.secretsPath,
|
|
SymlinkPath: testdir.symlinkPath,
|
|
SSHKeyPaths: []string{path.Join(assets, "ssh-key")},
|
|
}
|
|
|
|
testInstallSecret(t, testdir, &m)
|
|
}
|
|
|
|
func TestAge(t *testing.T) {
|
|
assets := testAssetPath()
|
|
|
|
testdir := newTestDir(t)
|
|
defer testdir.Remove()
|
|
|
|
target := path.Join(testdir.path, "existing-target")
|
|
file, err := os.Create(target)
|
|
ok(t, err)
|
|
_ = file.Close()
|
|
|
|
nobody := "nobody"
|
|
nogroup := "nogroup"
|
|
s := secret{
|
|
Name: "test",
|
|
Key: "test_key",
|
|
Owner: &nobody,
|
|
Group: &nogroup,
|
|
SopsFile: path.Join(assets, "secrets.yaml"),
|
|
Path: target,
|
|
Mode: "0400",
|
|
RestartUnits: []string{"affected-service"},
|
|
ReloadUnits: []string{"affected-reload-service"},
|
|
}
|
|
|
|
m := manifest{
|
|
Secrets: []secret{s},
|
|
SecretsMountPoint: testdir.secretsPath,
|
|
SymlinkPath: testdir.symlinkPath,
|
|
AgeKeyFile: path.Join(assets, "age-keys.txt"),
|
|
}
|
|
|
|
testInstallSecret(t, testdir, &m)
|
|
}
|
|
|
|
func TestAgeWithSSH(t *testing.T) {
|
|
assets := testAssetPath()
|
|
|
|
testdir := newTestDir(t)
|
|
defer testdir.Remove()
|
|
|
|
target := path.Join(testdir.path, "existing-target")
|
|
file, err := os.Create(target)
|
|
ok(t, err)
|
|
_ = file.Close()
|
|
|
|
nobody := "nobody"
|
|
nogroup := "nogroup"
|
|
s := secret{
|
|
Name: "test",
|
|
Key: "test_key",
|
|
Owner: &nobody,
|
|
Group: &nogroup,
|
|
SopsFile: path.Join(assets, "secrets.yaml"),
|
|
Path: target,
|
|
Mode: "0400",
|
|
RestartUnits: []string{"affected-service"},
|
|
ReloadUnits: []string{"affected-reload-service"},
|
|
}
|
|
|
|
m := manifest{
|
|
Secrets: []secret{s},
|
|
SecretsMountPoint: testdir.secretsPath,
|
|
SymlinkPath: testdir.symlinkPath,
|
|
AgeSSHKeyPaths: []string{path.Join(assets, "ssh-ed25519-key")},
|
|
}
|
|
|
|
testInstallSecret(t, testdir, &m)
|
|
}
|
|
|
|
func TestAll(t *testing.T) {
|
|
// we can't test in parallel because we rely on GNUPGHOME environment variable
|
|
testGPG(t)
|
|
testSSHKey(t)
|
|
}
|
|
|
|
func TestValidateManifest(t *testing.T) {
|
|
assets := testAssetPath()
|
|
|
|
testdir := newTestDir(t)
|
|
defer testdir.Remove()
|
|
|
|
nobody := "nobody"
|
|
nogroup := "nogroup"
|
|
s := secret{
|
|
Name: "test",
|
|
Key: "test_key",
|
|
Owner: &nobody,
|
|
Group: &nogroup,
|
|
SopsFile: path.Join(assets, "secrets.yaml"),
|
|
Path: path.Join(testdir.path, "test-target"),
|
|
Mode: "0400",
|
|
RestartUnits: []string{},
|
|
ReloadUnits: []string{},
|
|
}
|
|
|
|
m := manifest{
|
|
Secrets: []secret{s},
|
|
SecretsMountPoint: testdir.secretsPath,
|
|
SymlinkPath: testdir.symlinkPath,
|
|
SSHKeyPaths: []string{"non-existing-key"},
|
|
}
|
|
|
|
path := writeManifest(t, testdir.path, &m)
|
|
|
|
ok(t, installSecrets([]string{"sops-install-secrets", "-check-mode=manifest", path}))
|
|
ok(t, installSecrets([]string{"sops-install-secrets", "-check-mode=sopsfile", path}))
|
|
}
|
|
|
|
func TestIsValidFormat(t *testing.T) {
|
|
generateCase := func(input string, mustBe bool) {
|
|
result := IsValidFormat(input)
|
|
if result != mustBe {
|
|
t.Errorf("input %s must return %v but returned %v", input, mustBe, result)
|
|
}
|
|
}
|
|
for _, format := range []string{string(Yaml), string(JSON), string(Binary), string(Dotenv)} {
|
|
generateCase(format, true)
|
|
generateCase(strings.ToUpper(format), false)
|
|
}
|
|
}
|