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.

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

add shared path to SSM parameters #8687

Merged
merged 1 commit into from
Nov 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion atc/api/info_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ var _ = Describe("Pipelines API", func() {
fakeAccess.IsAuthenticatedReturns(true)
fakeAccess.IsAdminReturns(true)

ssmAccess := ssm.NewSsm(lager.NewLogger("ssm_test"), &mockService, nil)
ssmAccess := ssm.NewSsm(lager.NewLogger("ssm_test"), &mockService, nil, "")
ssmManager := &ssm.SsmManager{
AwsAccessKeyID: "",
AwsSecretAccessKey: "",
Expand Down Expand Up @@ -140,6 +140,7 @@ var _ = Describe("Pipelines API", func() {
"method": "GetParameter"
},
"pipeline_secret_template": "pipeline-secret-template",
"shared_path": "",
"team_secret_template": "team-secret-template"
}
}`))
Expand All @@ -165,6 +166,7 @@ var _ = Describe("Pipelines API", func() {
"method": "GetParameter"
},
"pipeline_secret_template": "pipeline-secret-template",
"shared_path": "",
"team_secret_template": "team-secret-template"
}
}`))
Expand Down
4 changes: 3 additions & 1 deletion atc/creds/ssm/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ type SsmManager struct {
AwsRegion string `mapstructure:"region" long:"region" description:"AWS region to send requests to"`
PipelineSecretTemplate string `mapstructure:"pipeline_secret_template" long:"pipeline-secret-template" description:"AWS SSM parameter name template used for pipeline specific parameter" default:"/concourse/{{.Team}}/{{.Pipeline}}/{{.Secret}}"`
TeamSecretTemplate string `mapstructure:"team_secret_template" long:"team-secret-template" description:"AWS SSM parameter name template used for team specific parameter" default:"/concourse/{{.Team}}/{{.Secret}}"`
SharedPath string `mapstructure:"shared_path" long:"shared-path" description:"AWS SSM parameter path used for shared parameters"`
Ssm *Ssm
}

Expand All @@ -37,6 +38,7 @@ func (manager *SsmManager) MarshalJSON() ([]byte, error) {
"aws_region": manager.AwsRegion,
"pipeline_secret_template": manager.PipelineSecretTemplate,
"team_secret_template": manager.TeamSecretTemplate,
"shared_path": manager.SharedPath,
"health": health,
})
}
Expand Down Expand Up @@ -139,7 +141,7 @@ func (manager *SsmManager) NewSecretsFactory(log lager.Logger) (creds.SecretsFac
return nil, err
}

return NewSsmFactory(log, session, []*creds.SecretTemplate{pipelineSecretTemplate, teamSecretTemplate}), nil
return NewSsmFactory(log, session, []*creds.SecretTemplate{pipelineSecretTemplate, teamSecretTemplate}, manager.SharedPath), nil
}

func (manager *SsmManager) Close(logger lager.Logger) {
Expand Down
7 changes: 6 additions & 1 deletion atc/creds/ssm/ssm.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,15 @@ type Ssm struct {
log lager.Logger
api ssmiface.SSMAPI
secretTemplates []*creds.SecretTemplate
sharedPath string
}

func NewSsm(log lager.Logger, api ssmiface.SSMAPI, secretTemplates []*creds.SecretTemplate) *Ssm {
func NewSsm(log lager.Logger, api ssmiface.SSMAPI, secretTemplates []*creds.SecretTemplate, sharedPath string) *Ssm {
return &Ssm{
log: log,
api: api,
secretTemplates: secretTemplates,
sharedPath: sharedPath,
}
}

Expand All @@ -35,6 +37,9 @@ func (s *Ssm) NewSecretLookupPaths(teamName string, pipelineName string, allowRo
lookupPaths = append(lookupPaths, lPath)
}
}
if s.sharedPath != "" {
lookupPaths = append(lookupPaths, creds.NewSecretLookupWithPrefix(s.sharedPath+"/"))
}
return lookupPaths
}

Expand Down
6 changes: 4 additions & 2 deletions atc/creds/ssm/ssm_factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,18 @@ type ssmFactory struct {
log lager.Logger
api *ssm.SSM
secretTemplates []*creds.SecretTemplate
sharedPath string
}

func NewSsmFactory(log lager.Logger, session *session.Session, secretTemplates []*creds.SecretTemplate) *ssmFactory {
func NewSsmFactory(log lager.Logger, session *session.Session, secretTemplates []*creds.SecretTemplate, sharedPath string) *ssmFactory {
return &ssmFactory{
log: log,
api: ssm.New(session),
secretTemplates: secretTemplates,
sharedPath: sharedPath,
}
}

func (factory *ssmFactory) NewSecrets() creds.Secrets {
return NewSsm(factory.log, factory.api, factory.secretTemplates)
return NewSsm(factory.log, factory.api, factory.secretTemplates, factory.sharedPath)
}
17 changes: 15 additions & 2 deletions atc/creds/ssm/ssm_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ var _ = Describe("Ssm", func() {
t2, err := creds.BuildSecretTemplate("t2", DefaultTeamSecretTemplate)
Expect(t2).NotTo(BeNil())
Expect(err).To(BeNil())
ssmAccess = NewSsm(lagertest.NewTestLogger("ssm_test"), &mockService, []*creds.SecretTemplate{t1, t2})
ssmAccess = NewSsm(lagertest.NewTestLogger("ssm_test"), &mockService, []*creds.SecretTemplate{t1, t2}, "/concourse/shared")
variables = creds.NewVariables(ssmAccess, "alpha", "bogus", false)
Expect(ssmAccess).NotTo(BeNil())
mockService.stubGetParameter = func(input string) (string, error) {
Expand All @@ -120,7 +120,7 @@ var _ = Describe("Ssm", func() {
Expect(err).To(BeNil())
})

It("should get complex paramter", func() {
It("should get complex parameter", func() {
mockService.stubGetParametersByPathPages = func(path string) []mockPathResultPage {
return []mockPathResultPage{
{
Expand Down Expand Up @@ -164,6 +164,19 @@ var _ = Describe("Ssm", func() {
Expect(err).To(BeNil())
})

It("should get shared parameter if exists", func() {
mockService.stubGetParameter = func(input string) (string, error) {
if input != "/concourse/shared/cheery" {
return "", awserr.New(ssm.ErrCodeParameterNotFound, "", nil)
}
return "shared decrypted value", nil
}
value, found, err := variables.Get(varRef)
Expect(value).To(BeEquivalentTo("shared decrypted value"))
Expect(found).To(BeTrue())
Expect(err).To(BeNil())
})

It("should return not found on error", func() {
mockService.stubGetParameter = nil
value, found, err := variables.Get(varRef)
Expand Down