Skip to content

config: support setting age and PGP keys as a strings array #849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
johanfleury wants to merge 1 commit into from
Closed

config: support setting age and PGP keys as a strings array #849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions age/keysource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import (
"io"
"os"
"path/filepath"
"strings"

"filippo.io/age"
"filippo.io/age/armor"
Expand Down Expand Up @@ -155,14 +154,12 @@ func (key *MasterKey) ToMap() map[string]interface{} {

// MasterKeysFromRecipients takes a comma-separated list of Bech32-encoded public keys and returns a
// slice of new MasterKeys.
func MasterKeysFromRecipients(commaSeparatedRecipients string) ([]*MasterKey, error) {
if commaSeparatedRecipients == "" {
// otherwise Split returns [""] and MasterKeyFromRecipient is unhappy
func MasterKeysFromRecipients(recipients []string) ([]*MasterKey, error) {
var keys []*MasterKey

if len(recipients) < 1 {
return make([]*MasterKey, 0), nil
}
recipients := strings.Split(commaSeparatedRecipients, ",")

var keys []*MasterKey

for _, recipient := range recipients {
key, err := MasterKeyFromRecipient(recipient)
Expand Down
3 changes: 1 addition & 2 deletions age/keysource_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ import (
func TestMasterKeysFromRecipientsEmpty(t *testing.T) {
assert := assert.New(t)

commaSeparatedRecipients := ""
recipients, err := MasterKeysFromRecipients(commaSeparatedRecipients)
recipients, err := MasterKeysFromRecipients([]string{})

assert.NoError(err)

Expand Down
14 changes: 7 additions & 7 deletions cmd/sops/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -574,7 +574,7 @@ func main() {
Usage: "comma separated list of vault's key URI (e.g. 'https://vault.example.org:8200/v1/transit/keys/dev')",
EnvVar: "SOPS_VAULT_URIS",
},
cli.StringFlag{
cli.StringSliceFlag{
Name: "pgp, p",
Usage: "comma separated list of PGP fingerprints",
EnvVar: "SOPS_PGP_FP",
Expand Down Expand Up @@ -822,7 +822,7 @@ func main() {
for _, k := range kms.MasterKeysFromArnString(c.String("add-kms"), kmsEncryptionContext, c.String("aws-profile")) {
addMasterKeys = append(addMasterKeys, k)
}
for _, k := range pgp.MasterKeysFromFingerprintString(c.String("add-pgp")) {
for _, k := range pgp.MasterKeysFromFingerprintString(c.StringSlice("add-pgp")) {
addMasterKeys = append(addMasterKeys, k)
}
for _, k := range gcpkms.MasterKeysFromResourceIDString(c.String("add-gcp-kms")) {
Expand All @@ -842,7 +842,7 @@ func main() {
for _, k := range hcVaultKeys {
addMasterKeys = append(addMasterKeys, k)
}
ageKeys, err := age.MasterKeysFromRecipients(c.String("add-age"))
ageKeys, err := age.MasterKeysFromRecipients(c.StringSlice("add-age"))
if err != nil {
return err
}
Expand All @@ -854,7 +854,7 @@ func main() {
for _, k := range kms.MasterKeysFromArnString(c.String("rm-kms"), kmsEncryptionContext, c.String("aws-profile")) {
rmMasterKeys = append(rmMasterKeys, k)
}
for _, k := range pgp.MasterKeysFromFingerprintString(c.String("rm-pgp")) {
for _, k := range pgp.MasterKeysFromFingerprintString(c.StringSlice("rm-pgp")) {
rmMasterKeys = append(rmMasterKeys, k)
}
for _, k := range gcpkms.MasterKeysFromResourceIDString(c.String("rm-gcp-kms")) {
Expand All @@ -874,7 +874,7 @@ func main() {
for _, k := range hcVaultKeys {
rmMasterKeys = append(rmMasterKeys, k)
}
ageKeys, err = age.MasterKeysFromRecipients(c.String("rm-age"))
ageKeys, err = age.MasterKeysFromRecipients(c.StringSlice("rm-age"))
if err != nil {
return err
}
Expand Down Expand Up @@ -1111,12 +1111,12 @@ func keyGroups(c *cli.Context, file string) ([]sops.KeyGroup, error) {
}
}
if c.String("pgp") != "" {
for _, k := range pgp.MasterKeysFromFingerprintString(c.String("pgp")) {
for _, k := range pgp.MasterKeysFromFingerprintString(c.StringSlice("pgp")) {
pgpKeys = append(pgpKeys, k)
}
}
if c.String("age") != "" {
ageKeys, err := age.MasterKeysFromRecipients(c.String("age"))
ageKeys, err := age.MasterKeysFromRecipients(c.StringSlice("age"))
if err != nil {
return nil, err
}
Expand Down
30 changes: 26 additions & 4 deletions config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,28 @@ import (
"gopkg.in/yaml.v3"
)

type CommaSeparatedValue []string

func (a *CommaSeparatedValue) UnmarshalYAML(unmarshal func(interface{}) error) error {
var multi []string
if err := unmarshal(&multi); err != nil {
var single string
if err := unmarshal(&single); err != nil {
return err
}

if single == "" {
*a = []string{}
} else {
*a = []string{single}
}
} else {
*a = multi
}

return nil
}

var log *logrus.Logger

func init() {
Expand Down Expand Up @@ -110,9 +132,9 @@ type destinationRule struct {
type creationRule struct {
PathRegex string `yaml:"path_regex"`
KMS string
AwsProfile string `yaml:"aws_profile"`
Age string `yaml:"age"`
PGP string
AwsProfile string `yaml:"aws_profile"`
Age CommaSeparatedValue `yaml:"age"`
PGP CommaSeparatedValue
GCPKMS string `yaml:"gcp_kms"`
AzureKeyVault string `yaml:"azure_keyvault"`
VaultURI string `yaml:"hc_vault_transit_uri"`
Expand Down Expand Up @@ -180,7 +202,7 @@ func getKeyGroupsFromCreationRule(cRule *creationRule, kmsEncryptionContext map[
}
} else {
var keyGroup sops.KeyGroup
if cRule.Age != "" {
if len(cRule.Age) > 0 {
ageKeys, err := age.MasterKeysFromRecipients(cRule.Age)
if err != nil {
return nil, err
Expand Down
6 changes: 3 additions & 3 deletions config/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,14 +239,14 @@ func TestLoadConfigFile(t *testing.T) {
{
PathRegex: "foobar*",
KMS: "1",
PGP: "2",
PGP: []string{"2"},
GCPKMS: "3",
VaultURI: "http://4:8200/v1/4/keys/4",
},
{
PathRegex: "",
KMS: "foo",
PGP: "bar",
PGP: []string{"bar"},
GCPKMS: "baz",
VaultURI: "http://127.0.1.1/v1/baz/keys/baz",
},
Expand All @@ -265,7 +265,7 @@ func TestLoadConfigFileWithGroups(t *testing.T) {
{
PathRegex: "foobar*",
KMS: "1",
PGP: "2",
PGP: []string{"2"},
},
{
PathRegex: "",
Expand Down
7 changes: 2 additions & 5 deletions pgp/keysource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,12 +268,9 @@ func NewMasterKeyFromFingerprint(fingerprint string) *MasterKey {
}

// MasterKeysFromFingerprintString takes a comma separated list of PGP fingerprints and returns a slice of new MasterKeys with those fingerprints
func MasterKeysFromFingerprintString(fingerprint string) []*MasterKey {
func MasterKeysFromFingerprintString(fingerprints []string) []*MasterKey {
var keys []*MasterKey
if fingerprint == "" {
return keys
}
for _, s := range strings.Split(fingerprint, ",") {
for _, s := range fingerprints {
keys = append(keys, NewMasterKeyFromFingerprint(s))
}
return keys
Expand Down
2 changes: 1 addition & 1 deletion pgp/keysource_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ func TestPGP(t *testing.T) {
}

func TestPGPKeySourceFromString(t *testing.T) {
s := "C8C5 2C0A B2A4 8174 01E8 12C8 F3CC 3233 3FAD 9F1E, C8C5 2C0A B2A4 8174 01E8 12C8 F3CC 3233 3FAD 9F1E"
s := []string{"C8C5 2C0A B2A4 8174 01E8 12C8 F3CC 3233 3FAD 9F1E", "C8C5 2C0A B2A4 8174 01E8 12C8 F3CC 3233 3FAD 9F1E"}
ks := MasterKeysFromFingerprintString(s)
expected := "C8C52C0AB2A4817401E812C8F3CC32333FAD9F1E"
if ks[0].Fingerprint != expected {
Expand Down