Skip to content
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

Jump to bottom

Support loading the secret key from a file #333

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Support loading the secret key from a file #333

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
2 changes: 1 addition & 1 deletion sigv4/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ go 1.15
require (
github.com/aws/aws-sdk-go v1.38.35
github.com/prometheus/client_golang v1.11.0
github.com/prometheus/common v0.29.0
github.com/prometheus/common v0.31.2-0.20211011203104-9789762a2ddb
github.com/stretchr/testify v1.7.0
gopkg.in/yaml.v2 v2.4.0
)
2 changes: 2 additions & 0 deletions sigv4/go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,8 @@ github.com/prometheus/common v0.10.0/go.mod h1:Tlit/dnDKsSWFlCLTWaA1cyBgKHSMdTB8
github.com/prometheus/common v0.26.0/go.mod h1:M7rCNAaPfAosfx8veZJCuw84e35h3Cfd9VFqTh1DIvc=
github.com/prometheus/common v0.29.0 h1:3jqPBvKT4OHAbje2Ql7KeaaSicDBCxMYwEJU1zRJceE=
github.com/prometheus/common v0.29.0/go.mod h1:vu+V0TpY+O6vW9J44gczi3Ap/oXXR10b+M/gUGO4Hls=
github.com/prometheus/common v0.31.2-0.20211011203104-9789762a2ddb h1:nDUL0g/BSYon1707Ums2YQG50fvMgV2D8otbQZHNnEs=
github.com/prometheus/common v0.31.2-0.20211011203104-9789762a2ddb/go.mod h1:vu+V0TpY+O6vW9J44gczi3Ap/oXXR10b+M/gUGO4Hls=
github.com/prometheus/procfs v0.0.0-20181005140218-185b4288413d/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk=
github.com/prometheus/procfs v0.0.2/go.mod h1:TjEm7ze935MbeOT/UhFTIMYKhuLP4wbCsTZCD3I8kEA=
github.com/prometheus/procfs v0.1.3/go.mod h1:lV6e/gmhEcM9IjHGsFOCxxuZ+z1YqCvr4OA4YeYWdaU=
Expand Down
18 changes: 13 additions & 5 deletions sigv4/sigv4_config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,12 @@ import (
// AWS's SigV4 verification process. Empty values will be retrieved using the
// AWS default credentials chain.
type SigV4Config struct {
Region string `yaml:"region,omitempty"`
AccessKey string `yaml:"access_key,omitempty"`
SecretKey config.Secret `yaml:"secret_key,omitempty"`
Profile string `yaml:"profile,omitempty"`
RoleARN string `yaml:"role_arn,omitempty"`
Region string `yaml:"region,omitempty"`
AccessKey string `yaml:"access_key,omitempty"`
SecretKey config.Secret `yaml:"secret_key,omitempty"`
SecretKeyFile string `yaml:"secret_key_file,omitempty"`
Profile string `yaml:"profile,omitempty"`
RoleARN string `yaml:"role_arn,omitempty"`
}

func (c *SigV4Config) Validate() error {
Expand All @@ -43,5 +44,12 @@ func (c *SigV4Config) UnmarshalYAML(unmarshal func(interface{}) error) error {
if err := unmarshal((*plain)(c)); err != nil {
return err
}

if len(c.SecretKey) == 0 && len(c.SecretKeyFile) != 0 {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think c.SecretKey == "" is more idiomatic for Go string comparisons.

if err := c.SecretKey.LoadFromFile(c.SecretKeyFile); err != nil {
return fmt.Errorf("cannot read sigv4 secret key from %s: %w", c.SecretKeyFile, err)
}
}

return c.Validate()
}
7 changes: 5 additions & 2 deletions sigv4/sigv4_config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,12 @@ func testGoodConfig(t *testing.T, filename string) {
}

func TestGoodSigV4Configs(t *testing.T) {
filesToTest := []string{"testdata/sigv4_good.yaml", "testdata/sigv4_good.yaml"}
filesToTest := []string{"testdata/sigv4_good.yaml", "testdata/sigv4_good.yaml", "testdata/sigv4_good_secret_key_file.yaml"}

for _, filename := range filesToTest {
testGoodConfig(t, filename)
t.Run(filename, func(t *testing.T) {
testGoodConfig(t, filename)
})
}
}

Expand Down
1 change: 1 addition & 0 deletions sigv4/testdata/secret_key.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
SecretKey
5 changes: 5 additions & 0 deletions sigv4/testdata/sigv4_good_secret_key_file.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
region: us-east-2
access_key: AccessKey
secret_key_file: testdata/secret_key.txt
profile: profile
role_arn: blah:role/arn