1
0
Fork 0
mirror of https://github.com/external-secrets/external-secrets.git synced 2024-12-14 11:57:59 +00:00
external-secrets/pkg/provider/aws/auth/auth_test.go
Moritz Johner 26f9c3f1f4
chore: refactor/centralise secretKeyRef usage (#3022)
* chore: refactor/centralise secretKeyRef usage

Signed-off-by: Moritz Johner <beller.moritz@googlemail.com>
2024-01-21 08:19:57 +01:00

624 lines
18 KiB
Go

/*
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package auth
import (
"context"
"strings"
"testing"
"time"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/credentials"
awssess "github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/sts"
"github.com/aws/aws-sdk-go/service/sts/stsiface"
"github.com/stretchr/testify/assert"
authv1 "k8s.io/api/authentication/v1"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
clientfake "sigs.k8s.io/controller-runtime/pkg/client/fake"
esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
fakesess "github.com/external-secrets/external-secrets/pkg/provider/aws/auth/fake"
)
const (
esNamespaceKey = "es-namespace"
platformTeamNsKey = "platform-team-ns"
myServiceAccountKey = "my-service-account"
otherNsName = "other-ns"
)
func TestNewSession(t *testing.T) {
rows := []TestSessionRow{
{
name: "nil store",
expectErr: "found nil store",
store: nil,
},
{
name: "not store spec",
expectErr: "storeSpec is missing provider",
store: &esv1beta1.SecretStore{},
},
{
name: "store spec has no provider",
expectErr: "storeSpec is missing provider",
store: &esv1beta1.SecretStore{
Spec: esv1beta1.SecretStoreSpec{},
},
},
{
name: "spec has no awssm field",
expectErr: "Missing AWS field",
store: &esv1beta1.SecretStore{
Spec: esv1beta1.SecretStoreSpec{
Provider: &esv1beta1.SecretStoreProvider{},
},
},
},
{
name: "configure aws using environment variables",
store: &esv1beta1.SecretStore{
Spec: esv1beta1.SecretStoreSpec{
Provider: &esv1beta1.SecretStoreProvider{
AWS: &esv1beta1.AWSProvider{},
},
},
},
env: map[string]string{
"AWS_ACCESS_KEY_ID": "1111",
"AWS_SECRET_ACCESS_KEY": "2222",
},
expectProvider: true,
expectedKeyID: "1111",
expectedSecretKey: "2222",
},
{
name: "configure aws using environment variables + assume role",
stsProvider: func(*awssess.Session) stsiface.STSAPI {
return &fakesess.AssumeRoler{
AssumeRoleFunc: func(input *sts.AssumeRoleInput) (*sts.AssumeRoleOutput, error) {
assert.Equal(t, *input.RoleArn, "foo-bar-baz")
return &sts.AssumeRoleOutput{
AssumedRoleUser: &sts.AssumedRoleUser{
Arn: aws.String("1123132"),
AssumedRoleId: aws.String("xxxxx"),
},
Credentials: &sts.Credentials{
AccessKeyId: aws.String("3333"),
SecretAccessKey: aws.String("4444"),
Expiration: aws.Time(time.Now().Add(time.Hour)),
SessionToken: aws.String("6666"),
},
}, nil
},
}
},
store: &esv1beta1.SecretStore{
Spec: esv1beta1.SecretStoreSpec{
Provider: &esv1beta1.SecretStoreProvider{
AWS: &esv1beta1.AWSProvider{
Role: "foo-bar-baz",
},
},
},
},
env: map[string]string{
"AWS_ACCESS_KEY_ID": "1111",
"AWS_SECRET_ACCESS_KEY": "2222",
},
expectProvider: true,
expectedKeyID: "3333",
expectedSecretKey: "4444",
},
{
name: "error out when secret with credentials does not exist",
namespace: "foo",
store: &esv1beta1.SecretStore{
Spec: esv1beta1.SecretStoreSpec{
Provider: &esv1beta1.SecretStoreProvider{
AWS: &esv1beta1.AWSProvider{
Auth: esv1beta1.AWSAuth{
SecretRef: &esv1beta1.AWSAuthSecretRef{
AccessKeyID: esmeta.SecretKeySelector{
Name: "othersecret",
Key: "one",
},
SecretAccessKey: esmeta.SecretKeySelector{
Name: "othersecret",
Key: "two",
},
},
},
},
},
},
},
expectErr: `secrets "othersecret" not found`,
},
{
name: "use credentials from secret to configure aws",
namespace: "foo",
store: &esv1beta1.SecretStore{
Spec: esv1beta1.SecretStoreSpec{
Provider: &esv1beta1.SecretStoreProvider{
AWS: &esv1beta1.AWSProvider{
Auth: esv1beta1.AWSAuth{
SecretRef: &esv1beta1.AWSAuthSecretRef{
AccessKeyID: esmeta.SecretKeySelector{
Name: "onesecret",
// Namespace is not set
Key: "one",
},
SecretAccessKey: esmeta.SecretKeySelector{
Name: "onesecret",
// Namespace is not set
Key: "two",
},
},
},
},
},
},
},
secrets: []v1.Secret{
{
ObjectMeta: metav1.ObjectMeta{
Name: "onesecret",
Namespace: "foo",
},
Data: map[string][]byte{
"one": []byte("1111"),
"two": []byte("2222"),
},
},
},
expectProvider: true,
expectedKeyID: "1111",
expectedSecretKey: "2222",
},
{
name: "error out when secret key does not exist",
namespace: "foo",
store: &esv1beta1.SecretStore{
Spec: esv1beta1.SecretStoreSpec{
Provider: &esv1beta1.SecretStoreProvider{
AWS: &esv1beta1.AWSProvider{
Auth: esv1beta1.AWSAuth{
SecretRef: &esv1beta1.AWSAuthSecretRef{
AccessKeyID: esmeta.SecretKeySelector{
Name: "brokensecret",
Key: "one",
},
SecretAccessKey: esmeta.SecretKeySelector{
Name: "brokensecret",
Key: "two",
},
},
},
},
},
},
},
secrets: []v1.Secret{
{
ObjectMeta: metav1.ObjectMeta{
Name: "brokensecret",
Namespace: "foo",
},
Data: map[string][]byte{},
},
},
expectErr: "could not fetch SecretAccessKey secret: cannot find secret data for key: \"two\"",
},
{
name: "should not be able to access secrets from different namespace",
namespace: "foo",
store: &esv1beta1.SecretStore{
Spec: esv1beta1.SecretStoreSpec{
Provider: &esv1beta1.SecretStoreProvider{
AWS: &esv1beta1.AWSProvider{
Auth: esv1beta1.AWSAuth{
SecretRef: &esv1beta1.AWSAuthSecretRef{
AccessKeyID: esmeta.SecretKeySelector{
Name: "onesecret",
Namespace: aws.String("evil"), // this should not be possible!
Key: "one",
},
SecretAccessKey: esmeta.SecretKeySelector{
Name: "onesecret",
Namespace: aws.String("evil"),
Key: "two",
},
},
},
},
},
},
},
secrets: []v1.Secret{
{
ObjectMeta: metav1.ObjectMeta{
Name: "onesecret",
Namespace: "evil",
},
Data: map[string][]byte{
"one": []byte("1111"),
"two": []byte("2222"),
},
},
},
expectErr: `secrets "onesecret" not found`,
},
{
name: "ClusterStore should use credentials from a specific namespace",
namespace: esNamespaceKey,
store: &esv1beta1.ClusterSecretStore{
TypeMeta: metav1.TypeMeta{
APIVersion: esv1beta1.ClusterSecretStoreKindAPIVersion,
Kind: esv1beta1.ClusterSecretStoreKind,
},
Spec: esv1beta1.SecretStoreSpec{
Provider: &esv1beta1.SecretStoreProvider{
AWS: &esv1beta1.AWSProvider{
Auth: esv1beta1.AWSAuth{
SecretRef: &esv1beta1.AWSAuthSecretRef{
AccessKeyID: esmeta.SecretKeySelector{
Name: "onesecret",
Namespace: aws.String(platformTeamNsKey),
Key: "one",
},
SecretAccessKey: esmeta.SecretKeySelector{
Name: "onesecret",
Namespace: aws.String(platformTeamNsKey),
Key: "two",
},
},
},
},
},
},
},
secrets: []v1.Secret{
{
ObjectMeta: metav1.ObjectMeta{
Name: "onesecret",
Namespace: platformTeamNsKey,
},
Data: map[string][]byte{
"one": []byte("1111"),
"two": []byte("2222"),
},
},
},
expectProvider: true,
expectedKeyID: "1111",
expectedSecretKey: "2222",
},
{
name: "ClusterStore should use credentials from a ExternalSecret namespace (referentAuth)",
namespace: esNamespaceKey,
store: &esv1beta1.ClusterSecretStore{
TypeMeta: metav1.TypeMeta{
APIVersion: esv1beta1.ClusterSecretStoreKindAPIVersion,
Kind: esv1beta1.ClusterSecretStoreKind,
},
Spec: esv1beta1.SecretStoreSpec{
Provider: &esv1beta1.SecretStoreProvider{
AWS: &esv1beta1.AWSProvider{
Auth: esv1beta1.AWSAuth{
SecretRef: &esv1beta1.AWSAuthSecretRef{
AccessKeyID: esmeta.SecretKeySelector{
Name: "onesecret",
Key: "one",
},
SecretAccessKey: esmeta.SecretKeySelector{
Name: "onesecret",
Key: "two",
},
},
},
},
},
},
},
secrets: []v1.Secret{
{
ObjectMeta: metav1.ObjectMeta{
Name: "onesecret",
Namespace: esNamespaceKey,
},
Data: map[string][]byte{
"one": []byte("7777"),
"two": []byte("4444"),
},
},
},
expectProvider: true,
expectedKeyID: "7777",
expectedSecretKey: "4444",
},
{
name: "jwt auth via cluster secret store",
namespace: esNamespaceKey,
sa: &v1.ServiceAccount{
ObjectMeta: metav1.ObjectMeta{
Name: myServiceAccountKey,
Namespace: otherNsName,
Annotations: map[string]string{
roleARNAnnotation: "my-sa-role",
},
},
},
jwtProvider: func(name, namespace, roleArn string, aud []string, region string) (credentials.Provider, error) {
assert.Equal(t, myServiceAccountKey, name)
assert.Equal(t, otherNsName, namespace)
assert.Equal(t, "my-sa-role", roleArn)
return fakesess.CredentialsProvider{
RetrieveFunc: func() (credentials.Value, error) {
return credentials.Value{
AccessKeyID: "3333",
SecretAccessKey: "4444",
SessionToken: "1234",
ProviderName: "fake",
}, nil
},
IsExpiredFunc: func() bool { return false },
}, nil
},
store: &esv1beta1.ClusterSecretStore{
TypeMeta: metav1.TypeMeta{
APIVersion: esv1beta1.ClusterSecretStoreKindAPIVersion,
Kind: esv1beta1.ClusterSecretStoreKind,
},
Spec: esv1beta1.SecretStoreSpec{
Provider: &esv1beta1.SecretStoreProvider{
AWS: &esv1beta1.AWSProvider{
Auth: esv1beta1.AWSAuth{
JWTAuth: &esv1beta1.AWSJWTAuth{
ServiceAccountRef: &esmeta.ServiceAccountSelector{
Name: myServiceAccountKey,
Namespace: aws.String(otherNsName),
},
},
},
},
},
},
},
expectProvider: true,
expectedKeyID: "3333",
expectedSecretKey: "4444",
},
{
name: "configure aws using environment variables + assume role + check external id",
stsProvider: func(*awssess.Session) stsiface.STSAPI {
return &fakesess.AssumeRoler{
AssumeRoleFunc: func(input *sts.AssumeRoleInput) (*sts.AssumeRoleOutput, error) {
assert.Equal(t, *input.ExternalId, "12345678")
return &sts.AssumeRoleOutput{
AssumedRoleUser: &sts.AssumedRoleUser{
Arn: aws.String("1123132"),
AssumedRoleId: aws.String("xxxxx"),
},
Credentials: &sts.Credentials{
AccessKeyId: aws.String("3333"),
SecretAccessKey: aws.String("4444"),
Expiration: aws.Time(time.Now().Add(time.Hour)),
SessionToken: aws.String("6666"),
},
}, nil
},
}
},
store: &esv1beta1.SecretStore{
Spec: esv1beta1.SecretStoreSpec{
Provider: &esv1beta1.SecretStoreProvider{
AWS: &esv1beta1.AWSProvider{
Role: "foo-bar-baz",
ExternalID: "12345678",
},
},
},
},
env: map[string]string{
"AWS_ACCESS_KEY_ID": "1111",
"AWS_SECRET_ACCESS_KEY": "2222",
},
expectProvider: true,
expectedKeyID: "3333",
expectedSecretKey: "4444",
},
}
for i := range rows {
row := rows[i]
t.Run(row.name, func(t *testing.T) {
testRow(t, row)
})
}
}
type TestSessionRow struct {
name string
store esv1beta1.GenericStore
secrets []v1.Secret
sa *v1.ServiceAccount
jwtProvider jwtProviderFactory
namespace string
stsProvider STSProvider
expectProvider bool
expectErr string
expectedKeyID string
expectedSecretKey string
env map[string]string
}
func testRow(t *testing.T, row TestSessionRow) {
kc := clientfake.NewClientBuilder().Build()
for i := range row.secrets {
err := kc.Create(context.Background(), &row.secrets[i])
assert.Nil(t, err)
}
for k, v := range row.env {
t.Setenv(k, v)
}
if row.sa != nil {
err := kc.Create(context.Background(), row.sa)
assert.Nil(t, err)
}
err := kc.Create(context.Background(), &authv1.TokenRequest{
ObjectMeta: metav1.ObjectMeta{
Name: myServiceAccountKey,
Namespace: otherNsName,
},
})
assert.Nil(t, err)
s, err := New(context.Background(), row.store, kc, row.namespace, row.stsProvider, row.jwtProvider)
if !ErrorContains(err, row.expectErr) {
t.Errorf("expected error %s but found %s", row.expectErr, err.Error())
}
// pass test on expected error
if err != nil {
return
}
if row.expectProvider && s == nil {
t.Errorf("expected provider object, found nil")
return
}
creds, _ := s.Config.Credentials.Get()
assert.Equal(t, row.expectedKeyID, creds.AccessKeyID)
assert.Equal(t, row.expectedSecretKey, creds.SecretAccessKey)
}
func TestSMEnvCredentials(t *testing.T) {
k8sClient := clientfake.NewClientBuilder().Build()
t.Setenv("AWS_SECRET_ACCESS_KEY", "1111")
t.Setenv("AWS_ACCESS_KEY_ID", "2222")
s, err := New(context.Background(), &esv1beta1.SecretStore{
Spec: esv1beta1.SecretStoreSpec{
Provider: &esv1beta1.SecretStoreProvider{
// defaults
AWS: &esv1beta1.AWSProvider{},
},
},
}, k8sClient, "example-ns", DefaultSTSProvider, nil)
assert.Nil(t, err)
assert.NotNil(t, s)
creds, err := s.Config.Credentials.Get()
assert.Nil(t, err)
assert.Equal(t, creds.AccessKeyID, "2222")
assert.Equal(t, creds.SecretAccessKey, "1111")
}
func TestSMAssumeRole(t *testing.T) {
k8sClient := clientfake.NewClientBuilder().Build()
sts := &fakesess.AssumeRoler{
AssumeRoleFunc: func(input *sts.AssumeRoleInput) (*sts.AssumeRoleOutput, error) {
if *input.RoleArn == "chained-role-1" {
return &sts.AssumeRoleOutput{
AssumedRoleUser: &sts.AssumedRoleUser{
Arn: aws.String("1111111"),
AssumedRoleId: aws.String("yyyyy1"),
},
Credentials: &sts.Credentials{
AccessKeyId: aws.String("77771"),
SecretAccessKey: aws.String("88881"),
Expiration: aws.Time(time.Now().Add(time.Hour)),
SessionToken: aws.String("99991"),
},
}, nil
} else if *input.RoleArn == "chained-role-2" {
return &sts.AssumeRoleOutput{
AssumedRoleUser: &sts.AssumedRoleUser{
Arn: aws.String("2222222"),
AssumedRoleId: aws.String("yyyyy2"),
},
Credentials: &sts.Credentials{
AccessKeyId: aws.String("77772"),
SecretAccessKey: aws.String("88882"),
Expiration: aws.Time(time.Now().Add(time.Hour)),
SessionToken: aws.String("99992"),
},
}, nil
} else {
// make sure the correct role is passed in
assert.Equal(t, *input.RoleArn, "my-awesome-role")
return &sts.AssumeRoleOutput{
AssumedRoleUser: &sts.AssumedRoleUser{
Arn: aws.String("1123132"),
AssumedRoleId: aws.String("xxxxx"),
},
Credentials: &sts.Credentials{
AccessKeyId: aws.String("3333"),
SecretAccessKey: aws.String("4444"),
Expiration: aws.Time(time.Now().Add(time.Hour)),
SessionToken: aws.String("6666"),
},
}, nil
}
},
}
t.Setenv("AWS_SECRET_ACCESS_KEY", "1111")
t.Setenv("AWS_ACCESS_KEY_ID", "2222")
s, err := New(context.Background(), &esv1beta1.SecretStore{
Spec: esv1beta1.SecretStoreSpec{
Provider: &esv1beta1.SecretStoreProvider{
// do assume role!
AWS: &esv1beta1.AWSProvider{
Role: "my-awesome-role",
AdditionalRoles: []string{"chained-role-1", "chained-role-2"},
},
},
},
}, k8sClient, "example-ns", func(se *awssess.Session) stsiface.STSAPI {
// check if the correct temporary credentials were used
creds, err := se.Config.Credentials.Get()
assert.Nil(t, err)
if creds.SessionToken == "" {
// called with credentials from envvars
assert.Equal(t, creds.AccessKeyID, "2222")
assert.Equal(t, creds.SecretAccessKey, "1111")
} else if creds.SessionToken == "99991" {
// called with chained role 1's credentials
assert.Equal(t, creds.AccessKeyID, "77771")
assert.Equal(t, creds.SecretAccessKey, "88881")
} else {
// called with chained role 2's credentials
assert.Equal(t, creds.AccessKeyID, "77772")
assert.Equal(t, creds.SecretAccessKey, "88882")
}
return sts
}, nil)
assert.Nil(t, err)
assert.NotNil(t, s)
creds, err := s.Config.Credentials.Get()
assert.Nil(t, err)
assert.Equal(t, creds.AccessKeyID, "3333")
assert.Equal(t, creds.SecretAccessKey, "4444")
}
func ErrorContains(out error, want string) bool {
if out == nil {
return want == ""
}
if want == "" {
return false
}
return strings.Contains(out.Error(), want)
}