Compare commits

...
Author SHA1 Message Date
Louis Ruch 7833b5df47 chore: bump deps (#56) 2024-12-10 14:49:04 -08:00
Louis Ruch 6bda6813aa Revert "feat: support dual stack requests for aws clients (#52)"
This reverts commit 899c62ce06.
2024-12-10 14:38:55 -08:00
Louis Ruch bdd27e2562 feat(storage): Add s3Client cache (#55)
* feat(storage): Add s3Client cache

* Update awsutil deps
2024-11-25 21:32:37 -08:00
Johan Brandhorst-Satzkorn f17f05ec82 Update CODEOWNERS (#54)
Make it effective with a wildcard
2024-11-18 16:23:19 -08:00
Damian Debkowski 899c62ce06 feat: support dual stack requests for aws clients (#52)
* feat: enable dual stack in aws clients

* refactor: optionally set custom endpoint resolver

* feat: update sts & iam client to utilize dualstack

* update aws dependencies to remove role policy bug
2024-10-28 11:50:18 -07:00
Louis Ruch ce22c1c46a Refactor error messages to include aws error details (#53)
* refactor error messages to include aws error details

* update deps
2024-10-21 09:55:51 -07:00
Hugo 2f9163ad0e docs(host): Add newly supported attributes 2024-10-03 18:19:49 +01:00
Damian Debkowski 7caff84c06 test: validate ipv6 compatibility (#50)
* test: validate ipv6 compatability

* test: update test to include checking against SBC state
2024-09-25 12:04:00 -07:00
Hugo 5f96422fbf chore(credential): Remove required arg from GetCredentialsConfig 2024-09-23 18:07:32 +01:00
Hugo 4dac4498d3 feat(service): Add support for host plugin AssumeRole
This commit also introduces a new dry run validation step when creating
or updating a host catalog. Additionally, it introduces new tests
related to using AssumeRole credentials, as well as more error and
success state cases.

service/host/plugin.go now closely follows service/storage/plugin.go.
This is by design as to bring both "halves" of the AWS plugin into
parity with each other.
2024-09-23 18:07:32 +01:00
hashicorp-copywrite[bot] 9af0110945 [COMPLIANCE] Add Copyright and License Headers (#47)
Co-authored-by: hashicorp-copywrite[bot] <110428419+hashicorp-copywrite[bot]@users.noreply.github.com>
2024-07-24 11:50:06 -04:00
Elim Tsiagbey c2e7c94f9c fix: Append list error for permission validation (#48)
* fix: Append list error for permission validation

Instead of returning the error right away, append the error when `ListObject` is successful but the key expected if not found. Set the `Read` permission state as `Unknown` if the response from the list calls does not find the expected key.

This can be caused if the credentials do not have `s3:PutObject` but have `s3:ListBucket`. Without `s3:PutObject`, the object will not be written to S3 so other calls to find the object will not be successful even if they have valid permissions.

This prevents us from returning a `write` error on Boundary because the list call will always fail. Without this, the  Permissions are not wrapped and the SBC states are all set to `unknown` even though we know certain permission failed.
2024-07-24 11:48:14 -04:00
26 changed files with 1896 additions and 631 deletions

No files matched your search

+6
View File
@@ -4,3 +4,9 @@ plan.tfplan
*.log *.log
*.out *.out
*.html *.html
# IntelliJ IDEA project files
.idea
*.iprg
.DS_Store
+1 -2
View File
@@ -1,5 +1,4 @@
# These owners will be the default owners for everything in # These owners will be the default owners for everything in
# the repo, unless a later match takes precedence. # the repo, unless a later match takes precedence.
@hashicorp/boundary * @hashicorp/boundary
+2 -2
View File
@@ -1,6 +1,6 @@
module github.com/hashicorp/boundary-plugin-aws module github.com/hashicorp/boundary-plugin-aws
go 1.21 go 1.23.3
require ( require (
github.com/aws/aws-sdk-go-v2 v1.20.1 github.com/aws/aws-sdk-go-v2 v1.20.1
@@ -11,7 +11,7 @@ require (
github.com/aws/smithy-go v1.14.1 github.com/aws/smithy-go v1.14.1
github.com/google/go-cmp v0.6.0 github.com/google/go-cmp v0.6.0
github.com/google/uuid v1.4.0 github.com/google/uuid v1.4.0
github.com/hashicorp/boundary/sdk v0.0.43-0.20240717182311-a20aae98794a github.com/hashicorp/boundary/sdk v0.0.49
github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-multierror v1.1.1
github.com/hashicorp/go-secure-stdlib/awsutil/v2 v2.0.0 github.com/hashicorp/go-secure-stdlib/awsutil/v2 v2.0.0
github.com/hashicorp/terraform-json v0.14.0 github.com/hashicorp/terraform-json v0.14.0
+2 -2
View File
@@ -78,8 +78,8 @@ github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
github.com/google/uuid v1.4.0 h1:MtMxsa51/r9yyhkyLsVeVt0B+BGQZzpQiTQ4eHZ8bc4= github.com/google/uuid v1.4.0 h1:MtMxsa51/r9yyhkyLsVeVt0B+BGQZzpQiTQ4eHZ8bc4=
github.com/google/uuid v1.4.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/google/uuid v1.4.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/hashicorp/boundary/sdk v0.0.43-0.20240717182311-a20aae98794a h1:SwVze6sYE5o+J9qdcgj29auY1k6O8oSo9DC2+2Gb9rw= github.com/hashicorp/boundary/sdk v0.0.49 h1:XOb6mSKyrU/wI20+5xTYBHQUP7eIeKcLxKSCpCs4yzM=
github.com/hashicorp/boundary/sdk v0.0.43-0.20240717182311-a20aae98794a/go.mod h1:9iOT7kDM6mYcSkKxNuZlv8rP7U5BG1kXoevjLLL8lNQ= github.com/hashicorp/boundary/sdk v0.0.49/go.mod h1:IHP79to8aIi22FiY58pgBqJL96/U9D8ZAUhS2DdC+Us=
github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
github.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDY2I= github.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDY2I=
github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
+3 -3
View File
@@ -37,7 +37,7 @@ type CredentialAttributes struct {
// CredentialsConfig used for configuring an AWS session. An status error is returned // CredentialsConfig used for configuring an AWS session. An status error is returned
// with an InvalidArgument code if any unrecognized fields are found in the protobuf // with an InvalidArgument code if any unrecognized fields are found in the protobuf
// struct input. // struct input.
func GetCredentialsConfig(secrets *structpb.Struct, attrs *CredentialAttributes, required bool) (*awsutil.CredentialsConfig, error) { func GetCredentialsConfig(secrets *structpb.Struct, attrs *CredentialAttributes) (*awsutil.CredentialsConfig, error) {
// initialize secrets if it is nil // initialize secrets if it is nil
// secrets can be nil because static credentials are optional // secrets can be nil because static credentials are optional
if secrets == nil { if secrets == nil {
@@ -49,13 +49,13 @@ func GetCredentialsConfig(secrets *structpb.Struct, attrs *CredentialAttributes,
unknownFields := values.StructFields(secrets) unknownFields := values.StructFields(secrets)
badFields := make(map[string]string) badFields := make(map[string]string)
accessKey, err := values.GetStringValue(secrets, ConstAccessKeyId, required) accessKey, err := values.GetStringValue(secrets, ConstAccessKeyId, false)
if err != nil { if err != nil {
badFields[fmt.Sprintf("secrets.%s", ConstAccessKeyId)] = err.Error() badFields[fmt.Sprintf("secrets.%s", ConstAccessKeyId)] = err.Error()
} }
delete(unknownFields, ConstAccessKeyId) delete(unknownFields, ConstAccessKeyId)
secretKey, err := values.GetStringValue(secrets, ConstSecretAccessKey, required) secretKey, err := values.GetStringValue(secrets, ConstSecretAccessKey, false)
if err != nil { if err != nil {
badFields[fmt.Sprintf("secrets.%s", ConstSecretAccessKey)] = err.Error() badFields[fmt.Sprintf("secrets.%s", ConstSecretAccessKey)] = err.Error()
} }
+1 -28
View File
@@ -105,7 +105,6 @@ func TestGetCredentialsConfig(t *testing.T) {
cases := []struct { cases := []struct {
name string name string
secrets *structpb.Struct secrets *structpb.Struct
required bool
attrs *CredentialAttributes attrs *CredentialAttributes
expected *awsutil.CredentialsConfig expected *awsutil.CredentialsConfig
expectedErrContains string expectedErrContains string
@@ -136,32 +135,6 @@ func TestGetCredentialsConfig(t *testing.T) {
Region: "us-west-2", Region: "us-west-2",
}, },
}, },
{
name: "missing access key",
secrets: &structpb.Struct{
Fields: map[string]*structpb.Value{
ConstSecretAccessKey: structpb.NewStringValue("bazqux"),
},
},
attrs: &CredentialAttributes{
Region: "us-west-2",
},
required: true,
expectedErrContains: "secrets.access_key_id: missing required value",
},
{
name: "missing secret key",
secrets: &structpb.Struct{
Fields: map[string]*structpb.Value{
ConstAccessKeyId: structpb.NewStringValue("AKIAfoobar"),
},
},
required: true,
attrs: &CredentialAttributes{
Region: "us-west-2",
},
expectedErrContains: "secrets.secret_access_key: missing required value",
},
{ {
name: "unknown fields", name: "unknown fields",
secrets: &structpb.Struct{ secrets: &structpb.Struct{
@@ -260,7 +233,7 @@ func TestGetCredentialsConfig(t *testing.T) {
t.Run(tc.name, func(t *testing.T) { t.Run(tc.name, func(t *testing.T) {
require := require.New(t) require := require.New(t)
actual, err := GetCredentialsConfig(tc.secrets, tc.attrs, tc.required) actual, err := GetCredentialsConfig(tc.secrets, tc.attrs)
if tc.expectedErrContains != "" { if tc.expectedErrContains != "" {
require.Error(err) require.Error(err)
require.Contains(err.Error(), tc.expectedErrContains) require.Contains(err.Error(), tc.expectedErrContains)
+6 -6
View File
@@ -114,7 +114,7 @@ func (s *AwsCredentialPersistedState) ValidateCreds(ctx context.Context) error {
return errors.BadRequestStatus("missing credentials config") return errors.BadRequestStatus("missing credentials config")
} }
if _, err := s.CredentialsConfig.GetCallerIdentity(ctx, s.testOpts...); err != nil { if _, err := s.CredentialsConfig.GetCallerIdentity(ctx, s.testOpts...); err != nil {
st, _ := errors.ParseAWSError(err, "validating credentials") st, _ := errors.ParseAWSError("validating credentials", err)
return st.Err() return st.Err()
} }
return nil return nil
@@ -135,7 +135,7 @@ func (s *AwsCredentialPersistedState) RotateCreds(ctx context.Context) error {
if err := s.CredentialsConfig.RotateKeys(ctx, append([]awsutil.Option{ if err := s.CredentialsConfig.RotateKeys(ctx, append([]awsutil.Option{
awsutil.WithValidityCheckTimeout(rotationWaitTimeout), awsutil.WithValidityCheckTimeout(rotationWaitTimeout),
}, s.testOpts...)...); err != nil { }, s.testOpts...)...); err != nil {
st, _ := errors.ParseAWSError(err, "error rotating credentials") st, _ := errors.ParseAWSError("rotating credentials", err)
return st.Err() return st.Err()
} }
s.CredsLastRotatedTime = time.Now() s.CredsLastRotatedTime = time.Now()
@@ -192,7 +192,7 @@ func (s *AwsCredentialPersistedState) DeleteCreds(ctx context.Context) error {
} }
// Otherwise treat it as an actual error. // Otherwise treat it as an actual error.
st, _ := errors.ParseAWSError(err, "failed to delete access key") st, _ := errors.ParseAWSError("deleting credentials", err)
return st.Err() return st.Err()
} }
@@ -252,17 +252,17 @@ func AwsCredentialPersistedStateFromProto(secrets *structpb.Struct, attrs *Crede
accessKeyId, err := values.GetStringValue(secrets, ConstAccessKeyId, false) accessKeyId, err := values.GetStringValue(secrets, ConstAccessKeyId, false)
if err != nil { if err != nil {
return nil, fmt.Errorf("persisted state integrity error: %w", err) return nil, fmt.Errorf("persisted state integrity: %w", err)
} }
secretAccessKey, err := values.GetStringValue(secrets, ConstSecretAccessKey, false) secretAccessKey, err := values.GetStringValue(secrets, ConstSecretAccessKey, false)
if err != nil { if err != nil {
return nil, fmt.Errorf("persisted state integrity error: %w", err) return nil, fmt.Errorf("persisted state integrity: %w", err)
} }
credsLastRotatedTime, err := values.GetTimeValue(secrets, ConstCredsLastRotatedTime) credsLastRotatedTime, err := values.GetTimeValue(secrets, ConstCredsLastRotatedTime)
if err != nil { if err != nil {
return nil, fmt.Errorf("persisted state integrity error: %w", err) return nil, fmt.Errorf("persisted state integrity: %w", err)
} }
s, err := NewAwsCredentialPersistedState(opts...) s, err := NewAwsCredentialPersistedState(opts...)
+4 -4
View File
@@ -186,7 +186,7 @@ func TestAwsCredentialPersistedStateFromProto(t *testing.T) {
attrs: &CredentialAttributes{ attrs: &CredentialAttributes{
Region: "us-west-2", Region: "us-west-2",
}, },
expectedErr: "persisted state integrity error: could not parse time in value \"creds_last_rotated_time\": parsing time \"notatime\" as \"2006-01-02T15:04:05.999999999Z07:00\": cannot parse \"notatime\" as \"2006\"", expectedErr: "persisted state integrity: could not parse time in value \"creds_last_rotated_time\": parsing time \"notatime\" as \"2006-01-02T15:04:05.999999999Z07:00\": cannot parse \"notatime\" as \"2006\"",
}, },
{ {
name: "option error", name: "option error",
@@ -458,7 +458,7 @@ func TestAwsCatalogPersistedState_RotateCreds(t *testing.T) {
), ),
}, },
}, },
expectedErr: "aws service unknown: unknown error: error rotating credentials", expectedErr: "aws service unknown: unknown error: rotating credentials",
expectedStatusCode: codes.Unknown, expectedStatusCode: codes.Unknown,
}, },
{ {
@@ -568,7 +568,7 @@ func TestAwsCatalogPersistedState_ReplaceCreds(t *testing.T) {
}, },
}, },
credentialConfig: &awsutil.CredentialsConfig{}, credentialConfig: &awsutil.CredentialsConfig{},
expectedErr: "aws service unknown: unknown error: failed to delete access key", expectedErr: "aws service unknown: unknown error: deleting credentials",
expectedStatusCode: codes.Unknown, expectedStatusCode: codes.Unknown,
}, },
{ {
@@ -693,7 +693,7 @@ func TestAwsCatalogPersistedState_DeleteCreds(t *testing.T) {
), ),
}, },
}, },
expectedErr: "aws service unknown: unknown error: failed to delete access key", expectedErr: "aws service unknown: unknown error: deleting credentials",
expectedStatusCode: codes.Unknown, expectedStatusCode: codes.Unknown,
}, },
{ {
+15 -14
View File
@@ -81,11 +81,12 @@ func InvalidArgumentError(msg string, f map[string]string) error {
// and credentials. This method will fallback to parsing the http status code // and credentials. This method will fallback to parsing the http status code
// when it cannot match an aws error code. This method does not handle specific // when it cannot match an aws error code. This method does not handle specific
// service type errors such as S3 or EC2. // service type errors such as S3 or EC2.
func ParseAWSError(err error, msg string) (st *status.Status, permission *pb.Permission) { func ParseAWSError(op string, err error) (st *status.Status, permission *pb.Permission) {
if err == nil { if err == nil {
return nil, nil return nil, nil
} }
msg := fmt.Sprintf("%s: %v", op, err)
// find the service name of the aws api // find the service name of the aws api
serviceName := "unknown" serviceName := "unknown"
var oe *smithy.OperationError var oe *smithy.OperationError
@@ -113,7 +114,7 @@ func ParseAWSError(err error, msg string) (st *status.Status, permission *pb.Per
Codes: retry.DefaultThrottleErrorCodes, Codes: retry.DefaultThrottleErrorCodes,
} }
if throttleErr.IsErrorThrottle(err).Bool() { if throttleErr.IsErrorThrottle(err).Bool() {
statusMsg := fmt.Sprintf("aws service %s: throttling error: %s", serviceName, msg) statusMsg := fmt.Sprintf("aws service %s: throttling: %s", serviceName, msg)
return status.New(codes.Unavailable, statusMsg), nil return status.New(codes.Unavailable, statusMsg), nil
} }
@@ -126,31 +127,31 @@ func ParseAWSError(err error, msg string) (st *status.Status, permission *pb.Per
case awsErrorInvalidAccessKeyId: case awsErrorInvalidAccessKeyId:
fallthrough fallthrough
case awsErrorExpiredToken: case awsErrorExpiredToken:
statusMsg := fmt.Sprintf("aws service %s: invalid credentials error: %s", serviceName, msg) statusMsg := fmt.Sprintf("aws service %s: invalid credentials: %s", serviceName, msg)
return status.New(codes.PermissionDenied, statusMsg), &pb.Permission{ return status.New(codes.PermissionDenied, statusMsg), &pb.Permission{
State: pb.StateType_STATE_TYPE_ERROR, State: pb.StateType_STATE_TYPE_ERROR,
ErrorDetails: apiErr.ErrorMessage(), ErrorDetails: apiErr.ErrorMessage(),
CheckedAt: timestamppb.Now(), CheckedAt: timestamppb.Now(),
} }
case awsErrorNoSuchBucket: case awsErrorNoSuchBucket:
statusMsg := fmt.Sprintf("aws %s error: %s", serviceName, msg) statusMsg := fmt.Sprintf("aws service %s: %s", serviceName, msg)
return status.New(codes.NotFound, statusMsg), &pb.Permission{ return status.New(codes.NotFound, statusMsg), &pb.Permission{
State: pb.StateType_STATE_TYPE_ERROR, State: pb.StateType_STATE_TYPE_ERROR,
ErrorDetails: apiErr.ErrorMessage(), ErrorDetails: apiErr.ErrorMessage(),
CheckedAt: timestamppb.Now(), CheckedAt: timestamppb.Now(),
} }
case awsErrorBadDigest: case awsErrorBadDigest:
statusMsg := fmt.Sprintf("aws %s error: %s", serviceName, msg) statusMsg := fmt.Sprintf("aws service %s: %s", serviceName, msg)
return status.New(codes.Aborted, statusMsg), nil return status.New(codes.Aborted, statusMsg), nil
case awsErrorNoSuchKey: case awsErrorNoSuchKey:
fallthrough fallthrough
case awsErrorInvalidObjectState: case awsErrorInvalidObjectState:
statusMsg := fmt.Sprintf("aws %s error: %s", serviceName, msg) statusMsg := fmt.Sprintf("aws service %s: %s", serviceName, msg)
return status.New(codes.NotFound, statusMsg), nil return status.New(codes.NotFound, statusMsg), nil
case awsErrorRequestTimeout: case awsErrorRequestTimeout:
fallthrough fallthrough
case awsErrorRequestTimeoutException: case awsErrorRequestTimeoutException:
statusMsg := fmt.Sprintf("aws %s error: %s", serviceName, msg) statusMsg := fmt.Sprintf("aws service %s: %s", serviceName, msg)
return status.New(codes.DeadlineExceeded, statusMsg), nil return status.New(codes.DeadlineExceeded, statusMsg), nil
} }
} }
@@ -165,39 +166,39 @@ func ParseAWSError(err error, msg string) (st *status.Status, permission *pb.Per
defer httpErr.Response.Body.Close() defer httpErr.Response.Body.Close()
switch httpErr.HTTPStatusCode() { switch httpErr.HTTPStatusCode() {
case http.StatusBadRequest: case http.StatusBadRequest:
statusMsg := fmt.Sprintf("aws service %s: bad request error: %s", serviceName, msg) statusMsg := fmt.Sprintf("aws service %s: bad request: %s", serviceName, msg)
return status.New(codes.InvalidArgument, statusMsg), nil return status.New(codes.InvalidArgument, statusMsg), nil
case http.StatusUnauthorized: case http.StatusUnauthorized:
statusMsg := fmt.Sprintf("aws service %s: invalid credentials error: %s", serviceName, msg) statusMsg := fmt.Sprintf("aws service %s: invalid credentials: %s", serviceName, msg)
return status.New(codes.PermissionDenied, statusMsg), &pb.Permission{ return status.New(codes.PermissionDenied, statusMsg), &pb.Permission{
State: pb.StateType_STATE_TYPE_ERROR, State: pb.StateType_STATE_TYPE_ERROR,
ErrorDetails: buf.String(), ErrorDetails: buf.String(),
CheckedAt: timestamppb.Now(), CheckedAt: timestamppb.Now(),
} }
case http.StatusForbidden: case http.StatusForbidden:
statusMsg := fmt.Sprintf("aws service %s: invalid credentials error: %s", serviceName, msg) statusMsg := fmt.Sprintf("aws service %s: invalid credentials: %s", serviceName, msg)
return status.New(codes.PermissionDenied, statusMsg), &pb.Permission{ return status.New(codes.PermissionDenied, statusMsg), &pb.Permission{
State: pb.StateType_STATE_TYPE_ERROR, State: pb.StateType_STATE_TYPE_ERROR,
ErrorDetails: buf.String(), ErrorDetails: buf.String(),
CheckedAt: timestamppb.Now(), CheckedAt: timestamppb.Now(),
} }
case http.StatusNotFound: case http.StatusNotFound:
statusMsg := fmt.Sprintf("aws service %s: resource not found error: %s", serviceName, msg) statusMsg := fmt.Sprintf("aws service %s: resource not found: %s", serviceName, msg)
return status.New(codes.NotFound, statusMsg), nil return status.New(codes.NotFound, statusMsg), nil
case http.StatusTooManyRequests: case http.StatusTooManyRequests:
statusMsg := fmt.Sprintf("aws service %s: throttling error: %s", serviceName, msg) statusMsg := fmt.Sprintf("aws service %s: throttling: %s", serviceName, msg)
return status.New(codes.Unavailable, statusMsg), nil return status.New(codes.Unavailable, statusMsg), nil
case http.StatusInternalServerError: case http.StatusInternalServerError:
fallthrough fallthrough
case http.StatusBadGateway: case http.StatusBadGateway:
fallthrough fallthrough
case http.StatusServiceUnavailable: case http.StatusServiceUnavailable:
statusMsg := fmt.Sprintf("aws service %s: connectivity error: %s", serviceName, msg) statusMsg := fmt.Sprintf("aws service %s: connectivity: %s", serviceName, msg)
return status.New(codes.Unavailable, statusMsg), nil return status.New(codes.Unavailable, statusMsg), nil
case http.StatusRequestTimeout: case http.StatusRequestTimeout:
fallthrough fallthrough
case http.StatusGatewayTimeout: case http.StatusGatewayTimeout:
statusMsg := fmt.Sprintf("aws service %s: timeout error: %s", serviceName, msg) statusMsg := fmt.Sprintf("aws service %s: timeout: %s", serviceName, msg)
return status.New(codes.DeadlineExceeded, statusMsg), nil return status.New(codes.DeadlineExceeded, statusMsg), nil
} }
} }
+34 -31
View File
@@ -1,3 +1,6 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
package errors package errors
import ( import (
@@ -41,7 +44,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "http-status-code-bad-request", name: "http-status-code-bad-request",
err: TestAwsHttpResponseError(http.StatusBadRequest, "bad request"), err: TestAwsHttpResponseError(http.StatusBadRequest, "bad request"),
expectedStatusCode: codes.InvalidArgument, expectedStatusCode: codes.InvalidArgument,
expectedStatusMsg: "aws service unknown: bad request error: test", expectedStatusMsg: "aws service unknown: bad request: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -50,7 +53,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "http-status-code-unauthorized", name: "http-status-code-unauthorized",
err: TestAwsHttpResponseError(http.StatusUnauthorized, "unauthorized request"), err: TestAwsHttpResponseError(http.StatusUnauthorized, "unauthorized request"),
expectedStatusCode: codes.PermissionDenied, expectedStatusCode: codes.PermissionDenied,
expectedStatusMsg: "aws service unknown: invalid credentials error: test", expectedStatusMsg: "aws service unknown: invalid credentials: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_ERROR, State: pb.StateType_STATE_TYPE_ERROR,
ErrorDetails: "unauthorized request", ErrorDetails: "unauthorized request",
@@ -61,7 +64,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "http-status-code-forbidden", name: "http-status-code-forbidden",
err: TestAwsHttpResponseError(http.StatusForbidden, "forbidden request"), err: TestAwsHttpResponseError(http.StatusForbidden, "forbidden request"),
expectedStatusCode: codes.PermissionDenied, expectedStatusCode: codes.PermissionDenied,
expectedStatusMsg: "aws service unknown: invalid credentials error: test", expectedStatusMsg: "aws service unknown: invalid credentials: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_ERROR, State: pb.StateType_STATE_TYPE_ERROR,
ErrorDetails: "forbidden request", ErrorDetails: "forbidden request",
@@ -72,7 +75,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "http-status-code-not-found", name: "http-status-code-not-found",
err: TestAwsHttpResponseError(http.StatusNotFound, "not found request"), err: TestAwsHttpResponseError(http.StatusNotFound, "not found request"),
expectedStatusCode: codes.NotFound, expectedStatusCode: codes.NotFound,
expectedStatusMsg: "aws service unknown: resource not found error: test", expectedStatusMsg: "aws service unknown: resource not found: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -81,7 +84,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "http-status-code-too-many-requests", name: "http-status-code-too-many-requests",
err: TestAwsHttpResponseError(http.StatusTooManyRequests, "too many requests"), err: TestAwsHttpResponseError(http.StatusTooManyRequests, "too many requests"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: throttling error: test", expectedStatusMsg: "aws service unknown: throttling: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -90,7 +93,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "http-status-code-request-timeout", name: "http-status-code-request-timeout",
err: TestAwsHttpResponseError(http.StatusRequestTimeout, "request timeout"), err: TestAwsHttpResponseError(http.StatusRequestTimeout, "request timeout"),
expectedStatusCode: codes.DeadlineExceeded, expectedStatusCode: codes.DeadlineExceeded,
expectedStatusMsg: "aws service unknown: timeout error: test", expectedStatusMsg: "aws service unknown: timeout: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -99,7 +102,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "http-status-code-internal-server-error", name: "http-status-code-internal-server-error",
err: TestAwsHttpResponseError(http.StatusInternalServerError, "internal server error"), err: TestAwsHttpResponseError(http.StatusInternalServerError, "internal server error"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: connectivity error: test", expectedStatusMsg: "aws service unknown: connectivity: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -108,7 +111,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "http-status-code-bad-gateway", name: "http-status-code-bad-gateway",
err: TestAwsHttpResponseError(http.StatusBadGateway, "bad gateway"), err: TestAwsHttpResponseError(http.StatusBadGateway, "bad gateway"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: connectivity error: test", expectedStatusMsg: "aws service unknown: connectivity: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -117,7 +120,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "http-status-code-service-unavailable", name: "http-status-code-service-unavailable",
err: TestAwsHttpResponseError(http.StatusServiceUnavailable, "service unavailable"), err: TestAwsHttpResponseError(http.StatusServiceUnavailable, "service unavailable"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: connectivity error: test", expectedStatusMsg: "aws service unknown: connectivity: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -126,7 +129,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "http-status-code-gateway-timeout", name: "http-status-code-gateway-timeout",
err: TestAwsHttpResponseError(http.StatusGatewayTimeout, "gateway timeout"), err: TestAwsHttpResponseError(http.StatusGatewayTimeout, "gateway timeout"),
expectedStatusCode: codes.DeadlineExceeded, expectedStatusCode: codes.DeadlineExceeded,
expectedStatusMsg: "aws service unknown: timeout error: test", expectedStatusMsg: "aws service unknown: timeout: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -135,7 +138,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-throttling", name: "aws-throttling",
err: TestAwsError("Throttling", "throttling error"), err: TestAwsError("Throttling", "throttling error"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: throttling error: test", expectedStatusMsg: "aws service unknown: throttling: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -144,7 +147,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-throttling-exception", name: "aws-throttling-exception",
err: TestAwsError("ThrottlingException", "throttling exception"), err: TestAwsError("ThrottlingException", "throttling exception"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: throttling error: test", expectedStatusMsg: "aws service unknown: throttling: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -153,7 +156,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-throttled-exception", name: "aws-throttled-exception",
err: TestAwsError("ThrottledException", "throttled exception"), err: TestAwsError("ThrottledException", "throttled exception"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: throttling error: test", expectedStatusMsg: "aws service unknown: throttling: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -162,7 +165,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-request-throttled-exception", name: "aws-request-throttled-exception",
err: TestAwsError("RequestThrottledException", "request throttled exception"), err: TestAwsError("RequestThrottledException", "request throttled exception"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: throttling error: test", expectedStatusMsg: "aws service unknown: throttling: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -171,7 +174,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-request-too-many-requests-exception", name: "aws-request-too-many-requests-exception",
err: TestAwsError("TooManyRequestsException", "too many requests exception"), err: TestAwsError("TooManyRequestsException", "too many requests exception"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: throttling error: test", expectedStatusMsg: "aws service unknown: throttling: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -180,7 +183,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-request-provisioned-throughput-exceeded-exception", name: "aws-request-provisioned-throughput-exceeded-exception",
err: TestAwsError("ProvisionedThroughputExceededException", "provisioned throughput exceeded exception"), err: TestAwsError("ProvisionedThroughputExceededException", "provisioned throughput exceeded exception"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: throttling error: test", expectedStatusMsg: "aws service unknown: throttling: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -189,7 +192,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-request-transaction-in-progress-exception", name: "aws-request-transaction-in-progress-exception",
err: TestAwsError("TransactionInProgressException", "transaction in progress exception"), err: TestAwsError("TransactionInProgressException", "transaction in progress exception"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: throttling error: test", expectedStatusMsg: "aws service unknown: throttling: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -198,7 +201,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-request-limit-exceeded", name: "aws-request-limit-exceeded",
err: TestAwsError("RequestLimitExceeded", "request limit exceeded"), err: TestAwsError("RequestLimitExceeded", "request limit exceeded"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: throttling error: test", expectedStatusMsg: "aws service unknown: throttling: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -207,7 +210,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-request-bandwidth-limit-exceeded", name: "aws-request-bandwidth-limit-exceeded",
err: TestAwsError("BandwidthLimitExceeded", "bandwidth limit exceeded"), err: TestAwsError("BandwidthLimitExceeded", "bandwidth limit exceeded"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: throttling error: test", expectedStatusMsg: "aws service unknown: throttling: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -216,7 +219,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-request-limit-exceeded-exception", name: "aws-request-limit-exceeded-exception",
err: TestAwsError("LimitExceededException", "limit exceeded exception"), err: TestAwsError("LimitExceededException", "limit exceeded exception"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: throttling error: test", expectedStatusMsg: "aws service unknown: throttling: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -225,7 +228,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-request-throttled", name: "aws-request-throttled",
err: TestAwsError("RequestThrottled", "request throttled"), err: TestAwsError("RequestThrottled", "request throttled"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: throttling error: test", expectedStatusMsg: "aws service unknown: throttling: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -234,7 +237,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-request-slow-down", name: "aws-request-slow-down",
err: TestAwsError("SlowDown", "slow down"), err: TestAwsError("SlowDown", "slow down"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: throttling error: test", expectedStatusMsg: "aws service unknown: throttling: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -243,7 +246,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-request-prior-request-not-complete", name: "aws-request-prior-request-not-complete",
err: TestAwsError("PriorRequestNotComplete", "prior request not complete"), err: TestAwsError("PriorRequestNotComplete", "prior request not complete"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: throttling error: test", expectedStatusMsg: "aws service unknown: throttling: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -252,7 +255,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-request-ec2-throttled-exception", name: "aws-request-ec2-throttled-exception",
err: TestAwsError("EC2ThrottledException", "ec2 throttled exception"), err: TestAwsError("EC2ThrottledException", "ec2 throttled exception"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service unknown: throttling error: test", expectedStatusMsg: "aws service unknown: throttling: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -261,7 +264,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-request-timeout", name: "aws-request-timeout",
err: TestAwsError("RequestTimeout", "request timeout"), err: TestAwsError("RequestTimeout", "request timeout"),
expectedStatusCode: codes.DeadlineExceeded, expectedStatusCode: codes.DeadlineExceeded,
expectedStatusMsg: "aws unknown error: test", expectedStatusMsg: "aws service unknown: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -270,7 +273,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-request-timeout-exception", name: "aws-request-timeout-exception",
err: TestAwsError("RequestTimeoutException", "request timeout exception"), err: TestAwsError("RequestTimeoutException", "request timeout exception"),
expectedStatusCode: codes.DeadlineExceeded, expectedStatusCode: codes.DeadlineExceeded,
expectedStatusMsg: "aws unknown error: test", expectedStatusMsg: "aws service unknown: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN, State: pb.StateType_STATE_TYPE_UNKNOWN,
}, },
@@ -279,7 +282,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-request-access-denied", name: "aws-request-access-denied",
err: TestAwsError(awsErrorAccessDenied, "not authorized to perform action"), err: TestAwsError(awsErrorAccessDenied, "not authorized to perform action"),
expectedStatusCode: codes.PermissionDenied, expectedStatusCode: codes.PermissionDenied,
expectedStatusMsg: "aws service unknown: invalid credentials error: test", expectedStatusMsg: "aws service unknown: invalid credentials: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_ERROR, State: pb.StateType_STATE_TYPE_ERROR,
ErrorDetails: "not authorized to perform action", ErrorDetails: "not authorized to perform action",
@@ -290,7 +293,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-request-invalid-access-key-id", name: "aws-request-invalid-access-key-id",
err: TestAwsError(awsErrorInvalidAccessKeyId, "The AWS Access Key Id you provided does not exist in our records."), err: TestAwsError(awsErrorInvalidAccessKeyId, "The AWS Access Key Id you provided does not exist in our records."),
expectedStatusCode: codes.PermissionDenied, expectedStatusCode: codes.PermissionDenied,
expectedStatusMsg: "aws service unknown: invalid credentials error: test", expectedStatusMsg: "aws service unknown: invalid credentials: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_ERROR, State: pb.StateType_STATE_TYPE_ERROR,
ErrorDetails: "The AWS Access Key Id you provided does not exist in our records.", ErrorDetails: "The AWS Access Key Id you provided does not exist in our records.",
@@ -301,7 +304,7 @@ func Test_ParseAWSError(t *testing.T) {
name: "aws-request-expired-token", name: "aws-request-expired-token",
err: TestAwsError(awsErrorExpiredToken, "The security token included in the request is expired."), err: TestAwsError(awsErrorExpiredToken, "The security token included in the request is expired."),
expectedStatusCode: codes.PermissionDenied, expectedStatusCode: codes.PermissionDenied,
expectedStatusMsg: "aws service unknown: invalid credentials error: test", expectedStatusMsg: "aws service unknown: invalid credentials: test",
expectedPermission: &pb.Permission{ expectedPermission: &pb.Permission{
State: pb.StateType_STATE_TYPE_ERROR, State: pb.StateType_STATE_TYPE_ERROR,
ErrorDetails: "The security token included in the request is expired.", ErrorDetails: "The security token included in the request is expired.",
@@ -313,14 +316,14 @@ func Test_ParseAWSError(t *testing.T) {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {
require, assert := require.New(t), assert.New(t) require, assert := require.New(t), assert.New(t)
actualStatus, permission := ParseAWSError(tt.err, "test") actualStatus, permission := ParseAWSError("test", tt.err)
if tt.expectedStatusCode == codes.OK { if tt.expectedStatusCode == codes.OK {
require.Nil(actualStatus) require.Nil(actualStatus)
return return
} }
require.Equal(tt.expectedStatusCode, actualStatus.Code()) require.Equal(tt.expectedStatusCode, actualStatus.Code())
require.Equal(tt.expectedStatusMsg, actualStatus.Message()) require.Contains(actualStatus.Message(), tt.expectedStatusMsg)
require.Len(actualStatus.Details(), 0) require.Len(actualStatus.Details(), 0)
CheckSimilarPermission(assert, tt.expectedPermission, permission, true) CheckSimilarPermission(assert, tt.expectedPermission, permission, true)
}) })
+3
View File
@@ -1,3 +1,6 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
package errors package errors
import ( import (
+1 -1
View File
@@ -32,6 +32,6 @@ type AwsPlugin struct {
func NewAwsPlugin() *AwsPlugin { func NewAwsPlugin() *AwsPlugin {
return &AwsPlugin{ return &AwsPlugin{
HostPlugin: &host.HostPlugin{}, HostPlugin: &host.HostPlugin{},
StoragePlugin: &storage.StoragePlugin{}, StoragePlugin: storage.New(),
} }
} }
+8
View File
@@ -108,6 +108,14 @@ The following `attributes` are valid on an AWS host catalog resource:
be performed. See the [Credential Rotation](../../../README.md#credential-rotation) readme for more information. be performed. See the [Credential Rotation](../../../README.md#credential-rotation) readme for more information.
- `region` (string): The region to configure the host catalog for. All host sets - `region` (string): The region to configure the host catalog for. All host sets
in this catalog will be configured for this region. in this catalog will be configured for this region.
- `role_arn` (string): The AWS Role ARN used for `AssumeRole` authentication. If
provided, `disable_credential_rotation` must be also set to `true.
- `role_external_id` (string): The external id configured for the `AssumeRole`
provider.
- `role_session_name` (string): The session name configured for the `AssumeRole`
provider.
- `role_tags` (object): The key-value pair tags configured for the `AssumeRole`
provider.
The following `secrets` are required on an AWS host catalog resource: The following `secrets` are required on an AWS host catalog resource:
+167 -150
View File
@@ -5,22 +5,19 @@ package host
import ( import (
"context" "context"
"errors"
"fmt" "fmt"
"strings" "strings"
"github.com/aws/aws-sdk-go-v2/aws" "github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/ec2" "github.com/aws/aws-sdk-go-v2/service/ec2"
"github.com/aws/aws-sdk-go-v2/service/ec2/types" "github.com/aws/aws-sdk-go-v2/service/ec2/types"
"github.com/aws/smithy-go" "github.com/hashicorp/boundary-plugin-aws/internal/credential"
"github.com/hashicorp/boundary-plugin-aws/internal/errors"
pb "github.com/hashicorp/boundary/sdk/pbs/plugin" pb "github.com/hashicorp/boundary/sdk/pbs/plugin"
"google.golang.org/grpc/codes" "google.golang.org/grpc/codes"
"google.golang.org/grpc/status" "google.golang.org/grpc/status"
"google.golang.org/protobuf/proto" "google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/known/structpb" "google.golang.org/protobuf/types/known/structpb"
"github.com/hashicorp/boundary-plugin-aws/internal/credential"
cred "github.com/hashicorp/boundary-plugin-aws/internal/credential"
) )
// HostPlugin implements the HostPluginServiceServer interface for the // HostPlugin implements the HostPluginServiceServer interface for the
@@ -42,24 +39,19 @@ var _ pb.HostPluginServiceServer = (*HostPlugin)(nil)
func (p *HostPlugin) OnCreateCatalog(ctx context.Context, req *pb.OnCreateCatalogRequest) (*pb.OnCreateCatalogResponse, error) { func (p *HostPlugin) OnCreateCatalog(ctx context.Context, req *pb.OnCreateCatalogRequest) (*pb.OnCreateCatalogResponse, error) {
catalog := req.GetCatalog() catalog := req.GetCatalog()
if catalog == nil { if catalog == nil {
return nil, status.Error(codes.InvalidArgument, "catalog is nil") return nil, errors.BadRequestStatus("catalog is required")
}
secrets := catalog.GetSecrets()
if secrets == nil {
return nil, status.Error(codes.InvalidArgument, "secrets are required")
} }
attrs := catalog.GetAttributes() attrs := catalog.GetAttributes()
if attrs == nil { if attrs == nil {
return nil, status.Error(codes.InvalidArgument, "attributes are required") return nil, errors.BadRequestStatus("attributes are required")
} }
catalogAttributes, err := getCatalogAttributes(attrs) catalogAttributes, err := getCatalogAttributes(attrs)
if err != nil { if err != nil {
return nil, err return nil, err
} }
credConfig, err := cred.GetCredentialsConfig(secrets, catalogAttributes.CredentialAttributes, true) credConfig, err := credential.GetCredentialsConfig(catalog.GetSecrets(), catalogAttributes.CredentialAttributes)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -71,7 +63,14 @@ func (p *HostPlugin) OnCreateCatalog(ctx context.Context, req *pb.OnCreateCatalo
}, p.testCredStateOpts...)..., }, p.testCredStateOpts...)...,
) )
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error setting up persisted state: %s", err) return nil, errors.BadRequestStatus("error setting up persisted state: %s", err)
}
// Try to rotate AWS static credentials
if credential.GetCredentialType(credState.CredentialsConfig) == credential.StaticAWS && !catalogAttributes.DisableCredentialRotation {
if err := credState.RotateCreds(ctx); err != nil {
return nil, err
}
} }
catalogState, err := newAwsCatalogPersistedState( catalogState, err := newAwsCatalogPersistedState(
@@ -80,25 +79,17 @@ func (p *HostPlugin) OnCreateCatalog(ctx context.Context, req *pb.OnCreateCatalo
}, p.testCatalogStateOpts...)..., }, p.testCatalogStateOpts...)...,
) )
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error setting up persisted state: %s", err) return nil, errors.BadRequestStatus("error setting up persisted state: %s", err)
} }
if cred.GetCredentialType(credState.CredentialsConfig) == cred.StaticAWS { // perform dry run to ensure we can interact with AWS as expected.
if !catalogAttributes.DisableCredentialRotation { if st := dryRunValidation(ctx, catalogState); st != nil {
if err := credState.RotateCreds(ctx); err != nil { return nil, st.Err()
return nil, status.Errorf(codes.InvalidArgument, "error during credential rotation: %s", err)
}
} else {
// Simply validate if we aren't rotating.
if err := credState.ValidateCreds(ctx); err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error during credential validation: %s", err)
}
}
} }
persistedProto, err := catalogState.toProto() persistedProto, err := catalogState.toProto()
if err != nil { if err != nil {
return nil, status.Error(codes.InvalidArgument, err.Error()) return nil, errors.BadRequestStatus(err.Error())
} }
return &pb.OnCreateCatalogResponse{ return &pb.OnCreateCatalogResponse{
@@ -111,43 +102,100 @@ func (p *HostPlugin) OnUpdateCatalog(ctx context.Context, req *pb.OnUpdateCatalo
// For host catalogs we only need to really validate what is // For host catalogs we only need to really validate what is
// currently in the new copy of the host catalog data, so skip // currently in the new copy of the host catalog data, so skip
// fetching the new copy to keep things a little less messy. // fetching the new copy to keep things a little less messy.
catalog := req.GetNewCatalog() currentCatalog := req.GetCurrentCatalog()
if catalog == nil { if currentCatalog == nil {
return nil, status.Error(codes.InvalidArgument, "new catalog is nil") return nil, errors.BadRequestStatus("current catalog is required")
}
newCatalog := req.GetNewCatalog()
if newCatalog == nil {
return nil, errors.BadRequestStatus("new catalog is required")
} }
var updateSecrets bool oldAttrs := currentCatalog.GetAttributes()
secrets := catalog.GetSecrets() if oldAttrs == nil {
if secrets != nil { return nil, errors.BadRequestStatus("current catalog attributes are required")
// We will be updating secrets this run, but what exactly that
// means will be determined later.
updateSecrets = true
} }
oldCatalogAttributes, err := getCatalogAttributes(oldAttrs)
attrs := catalog.GetAttributes() if err != nil {
if attrs == nil { return nil, err
return nil, status.Error(codes.InvalidArgument, "new catalog missing attributes")
} }
newAttrs := newCatalog.GetAttributes()
catalogAttributes, err := getCatalogAttributes(attrs) if newAttrs == nil {
return nil, errors.BadRequestStatus("new catalog attributes are required")
}
newCatalogAttributes, err := getCatalogAttributes(newAttrs)
if err != nil { if err != nil {
return nil, err return nil, err
} }
// Get the persisted data.
// NOTE: We might need to change this at a later time. I'm not too
// sure *exactly* what scenarios we might encounter that would
// ultimately mean that we would have to handle an empty or missing
// state in update, but what we are ultimately assuming here
// (implicitly through awsCatalogPersistedStateFromProto) is that
// the state will exist and be populated. Personally I think this
// is fine and important, but this may change in the future.
credState, err := credential.AwsCredentialPersistedStateFromProto( credState, err := credential.AwsCredentialPersistedStateFromProto(
req.GetPersisted().GetSecrets(), req.GetPersisted().GetSecrets(),
catalogAttributes.CredentialAttributes, oldCatalogAttributes.CredentialAttributes,
p.testCredStateOpts...) p.testCredStateOpts...)
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error loading persisted state: %s", err) return nil, errors.BadRequestStatus("error loading persisted state: %s", err)
}
// Verify the incoming credentials are valid and return any errors to the
// user if they're not. Note this doesn't validate the credentials against
// AWS - it only does logical validation on the fields.
updatedCredentials, err := credential.GetCredentialsConfig(newCatalog.GetSecrets(), newCatalogAttributes.CredentialAttributes)
if err != nil {
return nil, err
}
// We will be updating credentials when one of two changes occur:
// 1. the new catalog has secrets for static credentials, in which case we need to delete the old static credentials
// 2. the new catalog has a different roleARN value for dynamic credentials
if newCatalog.GetSecrets() != nil || newCatalogAttributes.RoleArn != oldCatalogAttributes.RoleArn {
// Ensure the incoming credentials are valid for interaction with the S3
// Bucket before replacing them.
newCredState, err := credential.NewAwsCredentialPersistedState(
append([]credential.AwsCredentialPersistedStateOption{
credential.WithCredentialsConfig(updatedCredentials),
}, p.testCredStateOpts...)...,
)
if err != nil {
return nil, errors.BadRequestStatus("error setting up new credential persisted state: %s", err)
}
newCatalogState, err := newAwsCatalogPersistedState(
append([]awsCatalogPersistedStateOption{
withCredentials(newCredState),
}, p.testCatalogStateOpts...)...,
)
if err != nil {
return nil, errors.BadRequestStatus("error loading persisted state: %s", err)
}
if st := dryRunValidation(ctx, newCatalogState); st != nil {
return nil, st.Err()
}
// Replace the existing credential state.
// This checks the timestamp on the last rotation time as well
// and deletes the credentials if we are managing them
// (ie: if we've rotated them before).
if err := credState.ReplaceCreds(ctx, updatedCredentials); err != nil {
return nil, err
}
}
if credential.GetCredentialType(credState.CredentialsConfig) == credential.StaticAWS {
// This is a validate check to make sure that we aren't disabling
// rotation for credentials currently being managed by rotation.
// This is not allowed.
if newCatalogAttributes.DisableCredentialRotation && newCatalog.GetSecrets() == nil {
if !credState.CredsLastRotatedTime.IsZero() {
return nil, errors.BadRequestStatus("cannot disable rotation for already-rotated credentials")
}
}
// If we're enabling rotation now but didn't before, or have
// freshly replaced credentials, we can rotate here.
if !newCatalogAttributes.DisableCredentialRotation && credState.CredsLastRotatedTime.IsZero() {
if err := credState.RotateCreds(ctx); err != nil {
return nil, err
}
}
} }
catalogState, err := newAwsCatalogPersistedState( catalogState, err := newAwsCatalogPersistedState(
@@ -156,45 +204,17 @@ func (p *HostPlugin) OnUpdateCatalog(ctx context.Context, req *pb.OnUpdateCatalo
}, p.testCatalogStateOpts...)..., }, p.testCatalogStateOpts...)...,
) )
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error loading persisted state: %s", err) return nil, errors.BadRequestStatus("error loading persisted state: %s", err)
} }
if cred.GetCredentialType(credState.CredentialsConfig) == cred.StaticAWS { // perform dry run to ensure we can interact with AWS as expected.
if catalogAttributes.DisableCredentialRotation && !updateSecrets { if st := dryRunValidation(ctx, catalogState); st != nil {
// This is a validate check to make sure that we aren't disabling return nil, st.Err()
// rotation for credentials currently being managed by rotation.
// This is not allowed.
if !credState.CredsLastRotatedTime.IsZero() {
return nil, status.Error(codes.FailedPrecondition, "cannot disable rotation for already-rotated credentials")
}
}
if updateSecrets {
catalogSecrets, err := credential.GetCredentialsConfig(secrets, catalogAttributes.CredentialAttributes, true)
if err != nil {
return nil, err
}
// Replace the credentials. This checks the timestamp on the last
// rotation time as well and deletes the credentials if we are
// managing them (ie: if we've rotated them before).
if err := credState.ReplaceCreds(ctx, catalogSecrets); err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error attempting to replace credentials: %s", err)
}
}
if !catalogAttributes.DisableCredentialRotation && credState.CredsLastRotatedTime.IsZero() {
// If we're enabling rotation now but didn't before, or have
// freshly replaced credentials, we can rotate here.
if err := credState.RotateCreds(ctx); err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error during credential rotation: %s", err)
}
}
} }
persistedProto, err := catalogState.toProto() persistedProto, err := catalogState.toProto()
if err != nil { if err != nil {
return nil, status.Error(codes.InvalidArgument, err.Error()) return nil, errors.BadRequestStatus(err.Error())
} }
return &pb.OnUpdateCatalogResponse{ return &pb.OnUpdateCatalogResponse{
@@ -206,12 +226,12 @@ func (p *HostPlugin) OnUpdateCatalog(ctx context.Context, req *pb.OnUpdateCatalo
func (p *HostPlugin) OnDeleteCatalog(ctx context.Context, req *pb.OnDeleteCatalogRequest) (*pb.OnDeleteCatalogResponse, error) { func (p *HostPlugin) OnDeleteCatalog(ctx context.Context, req *pb.OnDeleteCatalogRequest) (*pb.OnDeleteCatalogResponse, error) {
catalog := req.GetCatalog() catalog := req.GetCatalog()
if catalog == nil { if catalog == nil {
return nil, status.Error(codes.InvalidArgument, "new catalog is nil") return nil, errors.BadRequestStatus("catalog is required")
} }
attrs := catalog.GetAttributes() attrs := catalog.GetAttributes()
if attrs == nil { if attrs == nil {
return nil, status.Error(codes.InvalidArgument, "new catalog missing attributes") return nil, errors.BadRequestStatus("catalog attributes are required")
} }
catalogAttributes, err := getCatalogAttributes(attrs) catalogAttributes, err := getCatalogAttributes(attrs)
@@ -230,7 +250,7 @@ func (p *HostPlugin) OnDeleteCatalog(ctx context.Context, req *pb.OnDeleteCatalo
catalogAttributes.CredentialAttributes, catalogAttributes.CredentialAttributes,
p.testCredStateOpts...) p.testCredStateOpts...)
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error loading persisted state: %s", err) return nil, errors.BadRequestStatus("error loading persisted state: %s", err)
} }
_, err = newAwsCatalogPersistedState( _, err = newAwsCatalogPersistedState(
@@ -239,17 +259,17 @@ func (p *HostPlugin) OnDeleteCatalog(ctx context.Context, req *pb.OnDeleteCatalo
}, p.testCatalogStateOpts...)..., }, p.testCatalogStateOpts...)...,
) )
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error loading persisted state: %s", err) return nil, errors.BadRequestStatus("error loading persisted state: %s", err)
} }
// try to delete static credentials // try to delete static credentials
if cred.GetCredentialType(credState.CredentialsConfig) == cred.StaticAWS { if credential.GetCredentialType(credState.CredentialsConfig) == credential.StaticAWS {
if !credState.CredsLastRotatedTime.IsZero() { if !credState.CredsLastRotatedTime.IsZero() {
// Delete old/existing credentials. This is done with the same // Delete old/existing credentials. This is done with the same
// credentials to ensure that it has the proper permissions to do // credentials to ensure that it has the proper permissions to do
// it. // it.
if err := credState.DeleteCreds(ctx); err != nil { if err := credState.DeleteCreds(ctx); err != nil {
return nil, status.Errorf(codes.Aborted, "error removing rotated credentials during catalog deletion: %s", err) return nil, err
} }
} }
} }
@@ -288,12 +308,12 @@ func (p *HostPlugin) NormalizeSetData(ctx context.Context, req *pb.NormalizeSetD
func (p *HostPlugin) OnCreateSet(ctx context.Context, req *pb.OnCreateSetRequest) (*pb.OnCreateSetResponse, error) { func (p *HostPlugin) OnCreateSet(ctx context.Context, req *pb.OnCreateSetRequest) (*pb.OnCreateSetResponse, error) {
catalog := req.GetCatalog() catalog := req.GetCatalog()
if catalog == nil { if catalog == nil {
return nil, status.Error(codes.InvalidArgument, "catalog is nil") return nil, errors.BadRequestStatus("catalog is required")
} }
catalogAttrsRaw := catalog.GetAttributes() catalogAttrsRaw := catalog.GetAttributes()
if catalogAttrsRaw == nil { if catalogAttrsRaw == nil {
return nil, status.Error(codes.InvalidArgument, "catalog missing attributes") return nil, errors.BadRequestStatus("catalog attributes are required")
} }
catalogAttributes, err := getCatalogAttributes(catalogAttrsRaw) catalogAttributes, err := getCatalogAttributes(catalogAttrsRaw)
@@ -306,7 +326,7 @@ func (p *HostPlugin) OnCreateSet(ctx context.Context, req *pb.OnCreateSetRequest
catalogAttributes.CredentialAttributes, catalogAttributes.CredentialAttributes,
p.testCredStateOpts...) p.testCredStateOpts...)
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error loading persisted state: %s", err) return nil, errors.BadRequestStatus("error loading persisted state: %s", err)
} }
catalogState, err := newAwsCatalogPersistedState( catalogState, err := newAwsCatalogPersistedState(
@@ -315,56 +335,43 @@ func (p *HostPlugin) OnCreateSet(ctx context.Context, req *pb.OnCreateSetRequest
}, p.testCatalogStateOpts...)..., }, p.testCatalogStateOpts...)...,
) )
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error loading persisted state: %s", err) return nil, errors.BadRequestStatus("error loading persisted state: %s", err)
} }
set := req.GetSet() set := req.GetSet()
if set == nil { if set == nil {
return nil, status.Error(codes.InvalidArgument, "set is nil") return nil, errors.BadRequestStatus("set is required")
} }
if set.GetAttributes() == nil { if set.GetAttributes() == nil {
return nil, status.Error(codes.InvalidArgument, "set missing attributes") return nil, errors.BadRequestStatus("set attributes are required")
} }
setAttrs, err := getSetAttributes(set.GetAttributes()) setAttrs, err := getSetAttributes(set.GetAttributes())
if err != nil { if err != nil {
return nil, err return nil, err
} }
ec2Client, err := catalogState.EC2Client(ctx) describeInstanceFilters, err := buildFilters(setAttrs)
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error getting EC2 client: %s", err) return nil, errors.BadRequestStatus("error building set filters: %s", err)
} }
input, err := buildDescribeInstancesInput(setAttrs, true) if st := dryRunValidation(ctx, catalogState, describeInstanceFilters...); st != nil {
if err != nil { return nil, st.Err()
return nil, status.Errorf(codes.InvalidArgument, "error building DescribeInstances parameters: %s", err)
} }
return &pb.OnCreateSetResponse{}, nil
_, err = ec2Client.DescribeInstances(ctx, input)
if err == nil {
return nil, status.Error(codes.FailedPrecondition, "query error: DescribeInstances DryRun should have returned error, but none was found")
}
var apiErr smithy.APIError
if errors.As(err, &apiErr) && apiErr.ErrorCode() == "DryRunOperation" {
// Success
return &pb.OnCreateSetResponse{}, nil
}
return nil, status.Errorf(codes.InvalidArgument, "error performing dry run of DescribeInstances: %s", err)
} }
// OnUpdateSet is called when a dynamic host set is updated. // OnUpdateSet is called when a dynamic host set is updated.
func (p *HostPlugin) OnUpdateSet(ctx context.Context, req *pb.OnUpdateSetRequest) (*pb.OnUpdateSetResponse, error) { func (p *HostPlugin) OnUpdateSet(ctx context.Context, req *pb.OnUpdateSetRequest) (*pb.OnUpdateSetResponse, error) {
catalog := req.GetCatalog() catalog := req.GetCatalog()
if catalog == nil { if catalog == nil {
return nil, status.Error(codes.InvalidArgument, "catalog is nil") return nil, errors.BadRequestStatus("catalog is required")
} }
catalogAttrsRaw := catalog.GetAttributes() catalogAttrsRaw := catalog.GetAttributes()
if catalogAttrsRaw == nil { if catalogAttrsRaw == nil {
return nil, status.Error(codes.InvalidArgument, "catalog missing attributes") return nil, errors.BadRequestStatus("catalog attributes are required")
} }
catalogAttributes, err := getCatalogAttributes(catalogAttrsRaw) catalogAttributes, err := getCatalogAttributes(catalogAttrsRaw)
@@ -377,7 +384,7 @@ func (p *HostPlugin) OnUpdateSet(ctx context.Context, req *pb.OnUpdateSetRequest
catalogAttributes.CredentialAttributes, catalogAttributes.CredentialAttributes,
p.testCredStateOpts...) p.testCredStateOpts...)
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error loading persisted state: %s", err) return nil, errors.BadRequestStatus("error loading persisted state: %s", err)
} }
catalogState, err := newAwsCatalogPersistedState( catalogState, err := newAwsCatalogPersistedState(
@@ -386,46 +393,34 @@ func (p *HostPlugin) OnUpdateSet(ctx context.Context, req *pb.OnUpdateSetRequest
}, p.testCatalogStateOpts...)..., }, p.testCatalogStateOpts...)...,
) )
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error loading persisted state: %s", err) return nil, errors.BadRequestStatus("error loading persisted state: %s", err)
} }
// As with catalog, we don't need to really look at the old host // As with catalog, we don't need to really look at the old host
// set here, just need to work off of/validate the new set config // set here, just need to work off of/validate the new set config
set := req.GetNewSet() set := req.GetNewSet()
if set == nil { if set == nil {
return nil, status.Error(codes.InvalidArgument, "new set is nil") return nil, errors.BadRequestStatus("new set is required")
} }
if set.GetAttributes() == nil { if set.GetAttributes() == nil {
return nil, status.Error(codes.InvalidArgument, "new set missing attributes") return nil, errors.BadRequestStatus("new set attributes are required")
} }
setAttrs, err := getSetAttributes(set.GetAttributes()) setAttrs, err := getSetAttributes(set.GetAttributes())
if err != nil { if err != nil {
return nil, err return nil, err
} }
ec2Client, err := catalogState.EC2Client(ctx) describeInstanceFilters, err := buildFilters(setAttrs)
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error getting EC2 client: %s", err) return nil, errors.BadRequestStatus("error building set filters: %s", err)
} }
input, err := buildDescribeInstancesInput(setAttrs, true) if st := dryRunValidation(ctx, catalogState, describeInstanceFilters...); st != nil {
if err != nil { return nil, st.Err()
return nil, status.Errorf(codes.InvalidArgument, "error building DescribeInstances parameters: %s", err)
} }
_, err = ec2Client.DescribeInstances(ctx, input) return &pb.OnUpdateSetResponse{}, nil
if err == nil {
return nil, status.Error(codes.FailedPrecondition, "query error: DescribeInstances DryRun should have returned error, but none was found")
}
var apiErr smithy.APIError
if errors.As(err, &apiErr) && apiErr.ErrorCode() == "DryRunOperation" {
// Success
return &pb.OnUpdateSetResponse{}, nil
}
return nil, status.Errorf(codes.InvalidArgument, "error performing dry run of DescribeInstances: %s", err)
} }
// OnDeleteSet is called when a dynamic host set is deleted. // OnDeleteSet is called when a dynamic host set is deleted.
@@ -439,12 +434,12 @@ func (p *HostPlugin) OnDeleteSet(ctx context.Context, req *pb.OnDeleteSetRequest
func (p *HostPlugin) ListHosts(ctx context.Context, req *pb.ListHostsRequest) (*pb.ListHostsResponse, error) { func (p *HostPlugin) ListHosts(ctx context.Context, req *pb.ListHostsRequest) (*pb.ListHostsResponse, error) {
catalog := req.GetCatalog() catalog := req.GetCatalog()
if catalog == nil { if catalog == nil {
return nil, status.Error(codes.InvalidArgument, "catalog is nil") return nil, errors.BadRequestStatus("catalog is required")
} }
catalogAttrsRaw := catalog.GetAttributes() catalogAttrsRaw := catalog.GetAttributes()
if catalogAttrsRaw == nil { if catalogAttrsRaw == nil {
return nil, status.Error(codes.InvalidArgument, "catalog missing attributes") return nil, errors.BadRequestStatus("catalog attributes are required")
} }
catalogAttributes, err := getCatalogAttributes(catalogAttrsRaw) catalogAttributes, err := getCatalogAttributes(catalogAttrsRaw)
@@ -457,7 +452,7 @@ func (p *HostPlugin) ListHosts(ctx context.Context, req *pb.ListHostsRequest) (*
catalogAttributes.CredentialAttributes, catalogAttributes.CredentialAttributes,
p.testCredStateOpts...) p.testCredStateOpts...)
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error loading persisted state: %s", err) return nil, errors.BadRequestStatus("error loading persisted state: %s", err)
} }
catalogState, err := newAwsCatalogPersistedState( catalogState, err := newAwsCatalogPersistedState(
@@ -466,12 +461,12 @@ func (p *HostPlugin) ListHosts(ctx context.Context, req *pb.ListHostsRequest) (*
}, p.testCatalogStateOpts...)..., }, p.testCatalogStateOpts...)...,
) )
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error loading persisted state: %s", err) return nil, errors.BadRequestStatus("error loading persisted state: %s", err)
} }
sets := req.GetSets() sets := req.GetSets()
if sets == nil { if sets == nil {
return nil, status.Error(codes.InvalidArgument, "sets is nil") return nil, errors.BadRequestStatus("sets are required")
} }
// Build all the queries in advance. // Build all the queries in advance.
@@ -486,11 +481,11 @@ func (p *HostPlugin) ListHosts(ctx context.Context, req *pb.ListHostsRequest) (*
for i, set := range sets { for i, set := range sets {
// Validate Id since we use it in output // Validate Id since we use it in output
if set.GetId() == "" { if set.GetId() == "" {
return nil, status.Error(codes.InvalidArgument, "set missing id") return nil, errors.BadRequestStatus("set id is required")
} }
if set.GetAttributes() == nil { if set.GetAttributes() == nil {
return nil, status.Error(codes.InvalidArgument, "set missing attributes") return nil, errors.BadRequestStatus("set %s attributes are required", set.GetId())
} }
setAttrs, err := getSetAttributes(set.GetAttributes()) setAttrs, err := getSetAttributes(set.GetAttributes())
if err != nil { if err != nil {
@@ -499,7 +494,7 @@ func (p *HostPlugin) ListHosts(ctx context.Context, req *pb.ListHostsRequest) (*
input, err := buildDescribeInstancesInput(setAttrs, false) input, err := buildDescribeInstancesInput(setAttrs, false)
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error building DescribeInstances parameters for host set id %q: %s", set.GetId(), err) return nil, errors.BadRequestStatus("error building DescribeInstances parameters for host set id %q: %s", set.GetId(), err)
} }
queries[i] = hostSetQuery{ queries[i] = hostSetQuery{
Id: set.GetId(), Id: set.GetId(),
@@ -509,7 +504,7 @@ func (p *HostPlugin) ListHosts(ctx context.Context, req *pb.ListHostsRequest) (*
ec2Client, err := catalogState.EC2Client(ctx) ec2Client, err := catalogState.EC2Client(ctx)
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error getting EC2 client: %s", err) return nil, errors.BadRequestStatus("error getting EC2 client: %s", err)
} }
// Run all queries now and assemble output. // Run all queries now and assemble output.
@@ -517,7 +512,7 @@ func (p *HostPlugin) ListHosts(ctx context.Context, req *pb.ListHostsRequest) (*
for i, query := range queries { for i, query := range queries {
output, err := ec2Client.DescribeInstances(ctx, query.Input) output, err := ec2Client.DescribeInstances(ctx, query.Input)
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error running DescribeInstances for host set id %q: %s", query.Id, err) return nil, errors.BadRequestStatus("error running DescribeInstances for host set id %q: %s", query.Id, err)
} }
queries[i].Output = output queries[i].Output = output
@@ -528,7 +523,7 @@ func (p *HostPlugin) ListHosts(ctx context.Context, req *pb.ListHostsRequest) (*
for _, instance := range reservation.Instances { for _, instance := range reservation.Instances {
host, err := awsInstanceToHost(instance) host, err := awsInstanceToHost(instance)
if err != nil { if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "error processing host results for host set id %q: %s", query.Id, err) return nil, errors.BadRequestStatus("error processing host results for host set id %q: %s", query.Id, err)
} }
queries[i].OutputHosts = append(queries[i].OutputHosts, host) queries[i].OutputHosts = append(queries[i].OutputHosts, host)
@@ -626,7 +621,7 @@ func buildDescribeInstancesInput(attrs *SetAttributes, dryRun bool) (*ec2.Descri
// populated. // populated.
func awsInstanceToHost(instance types.Instance) (*pb.ListHostsResponseHost, error) { func awsInstanceToHost(instance types.Instance) (*pb.ListHostsResponseHost, error) {
if aws.ToString(instance.InstanceId) == "" { if aws.ToString(instance.InstanceId) == "" {
return nil, errors.New("response integrity error: missing instance id") return nil, fmt.Errorf("response integrity error: missing instance id")
} }
result := new(pb.ListHostsResponseHost) result := new(pb.ListHostsResponseHost)
@@ -674,6 +669,28 @@ func awsInstanceToHost(instance types.Instance) (*pb.ListHostsResponseHost, erro
return result, nil return result, nil
} }
// dryRunValidation performs an AWS DescribeInstances call to verify the state's
// credentials, the host listing functionality as well as the filters, if any
// are passed in. This function can therefore be used for both host catalog and
// host set validation.
func dryRunValidation(ctx context.Context, state *awsCatalogPersistedState, filters ...types.Filter) *status.Status {
if state == nil {
return status.New(codes.InvalidArgument, "persisted state is required")
}
ec2Client, err := state.EC2Client(ctx)
if err != nil {
return status.New(codes.InvalidArgument, fmt.Sprintf("error getting EC2 client: %s", err))
}
_, err = ec2Client.DescribeInstances(ctx, &ec2.DescribeInstancesInput{Filters: filters})
if err != nil {
return status.New(codes.FailedPrecondition, fmt.Sprintf("aws describe instances failed: %s", err))
}
return nil
}
// appendDistinct will append the elements to the slice // appendDistinct will append the elements to the slice
// if an element is not nil, empty, and does not exist in slice. // if an element is not nil, empty, and does not exist in slice.
func appendDistinct(slice []string, elems ...*string) []string { func appendDistinct(slice []string, elems ...*string) []string {
File diff suppressed because it is too large. Load diff
+5 -2
View File
@@ -1,3 +1,6 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
package storage package storage
import ( import (
@@ -47,12 +50,12 @@ func setStatePermission(req any, permission *pb.Permission) *pb.StorageBucketCre
// credentials, and connectivity error types. // credentials, and connectivity error types.
// //
// https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html // https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html
func parseS3Error(err error, msg string, req any) *status.Status { func parseS3Error(op string, err error, req any) *status.Status {
if err == nil { if err == nil {
return nil return nil
} }
st, p := errors.ParseAWSError(err, msg) st, p := errors.ParseAWSError(op, err)
if p != nil { if p != nil {
state := setStatePermission(req, p) state := setStatePermission(req, p)
if st, err = st.WithDetails(state); err != nil { if st, err = st.WithDetails(state); err != nil {
+13 -10
View File
@@ -1,3 +1,6 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
package storage package storage
import ( import (
@@ -31,7 +34,7 @@ func Test_ParseS3Error(t *testing.T) {
req: &pb.GetObjectRequest{}, req: &pb.GetObjectRequest{},
err: TestAwsS3Error("NoSuchBucket", "GetObject", "no such bucket"), err: TestAwsS3Error("NoSuchBucket", "GetObject", "no such bucket"),
expectedStatusCode: codes.NotFound, expectedStatusCode: codes.NotFound,
expectedStatusMsg: "aws s3 error: test", expectedStatusMsg: "aws service s3: test:",
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
Read: &pb.Permission{ Read: &pb.Permission{
@@ -47,7 +50,7 @@ func Test_ParseS3Error(t *testing.T) {
req: &pb.GetObjectRequest{}, req: &pb.GetObjectRequest{},
err: TestAwsS3Error("NoSuchKey", "GetObject", "no such key"), err: TestAwsS3Error("NoSuchKey", "GetObject", "no such key"),
expectedStatusCode: codes.NotFound, expectedStatusCode: codes.NotFound,
expectedStatusMsg: "aws s3 error: test", expectedStatusMsg: "aws service s3: test:",
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
Read: &pb.Permission{ Read: &pb.Permission{
@@ -63,7 +66,7 @@ func Test_ParseS3Error(t *testing.T) {
err: errors.TestAwsHttpResponseError(404, "not found"), err: errors.TestAwsHttpResponseError(404, "not found"),
expectedStatusCode: codes.NotFound, expectedStatusCode: codes.NotFound,
// cannot embed services within mock http errors, therefore unknown service // cannot embed services within mock http errors, therefore unknown service
expectedStatusMsg: "aws service unknown: resource not found error: test", expectedStatusMsg: "aws service unknown: resource not found: test:",
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
Read: &pb.Permission{ Read: &pb.Permission{
@@ -78,7 +81,7 @@ func Test_ParseS3Error(t *testing.T) {
req: &pb.GetObjectRequest{}, req: &pb.GetObjectRequest{},
err: TestAwsS3Error("InvalidObjectState", "GetObject", "invalid object state"), err: TestAwsS3Error("InvalidObjectState", "GetObject", "invalid object state"),
expectedStatusCode: codes.NotFound, expectedStatusCode: codes.NotFound,
expectedStatusMsg: "aws s3 error: test", expectedStatusMsg: "aws service s3: test:",
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
Read: &pb.Permission{ Read: &pb.Permission{
@@ -93,7 +96,7 @@ func Test_ParseS3Error(t *testing.T) {
req: &pb.PutObjectRequest{}, req: &pb.PutObjectRequest{},
err: TestAwsS3Error(s3ErrorBadDigest, "PutObject", "checksum mismatch"), err: TestAwsS3Error(s3ErrorBadDigest, "PutObject", "checksum mismatch"),
expectedStatusCode: codes.Aborted, expectedStatusCode: codes.Aborted,
expectedStatusMsg: "aws s3 error: test", expectedStatusMsg: "aws service s3: test:",
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
Write: &pb.Permission{ Write: &pb.Permission{
@@ -108,7 +111,7 @@ func Test_ParseS3Error(t *testing.T) {
req: &pb.GetObjectRequest{}, req: &pb.GetObjectRequest{},
err: TestAwsS3Error("Throttling", "action", "throttling exception"), err: TestAwsS3Error("Throttling", "action", "throttling exception"),
expectedStatusCode: codes.Unavailable, expectedStatusCode: codes.Unavailable,
expectedStatusMsg: "aws service s3: throttling error: test", expectedStatusMsg: "aws service s3: throttling: test:",
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
Read: &pb.Permission{ Read: &pb.Permission{
@@ -123,7 +126,7 @@ func Test_ParseS3Error(t *testing.T) {
req: &pb.GetObjectRequest{}, req: &pb.GetObjectRequest{},
err: TestAwsS3Error("RequestTimeout", "action", "request timeout"), err: TestAwsS3Error("RequestTimeout", "action", "request timeout"),
expectedStatusCode: codes.DeadlineExceeded, expectedStatusCode: codes.DeadlineExceeded,
expectedStatusMsg: "aws s3 error: test", expectedStatusMsg: "aws service s3: test:",
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
Read: &pb.Permission{ Read: &pb.Permission{
@@ -138,7 +141,7 @@ func Test_ParseS3Error(t *testing.T) {
req: &pb.GetObjectRequest{}, req: &pb.GetObjectRequest{},
err: TestAwsS3Error("AccessDenied", "action", "access denied"), err: TestAwsS3Error("AccessDenied", "action", "access denied"),
expectedStatusCode: codes.PermissionDenied, expectedStatusCode: codes.PermissionDenied,
expectedStatusMsg: "aws service s3: invalid credentials error: test", expectedStatusMsg: "aws service s3: invalid credentials: test:",
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
Read: &pb.Permission{ Read: &pb.Permission{
@@ -154,14 +157,14 @@ func Test_ParseS3Error(t *testing.T) {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {
require, assert := require.New(t), assert.New(t) require, assert := require.New(t), assert.New(t)
actualStatus := parseS3Error(tt.err, "test", tt.req) actualStatus := parseS3Error("test", tt.err, tt.req)
if tt.expectedStatusCode == codes.OK { if tt.expectedStatusCode == codes.OK {
require.Nil(actualStatus) require.Nil(actualStatus)
return return
} }
require.Equal(tt.expectedStatusCode, actualStatus.Code()) require.Equal(tt.expectedStatusCode, actualStatus.Code())
require.Equal(tt.expectedStatusMsg, actualStatus.Message()) require.Contains(actualStatus.Message(), tt.expectedStatusMsg)
require.Len(actualStatus.Details(), 1) require.Len(actualStatus.Details(), 1)
foundDetail := false foundDetail := false
+197 -61
View File
@@ -14,6 +14,7 @@ import (
"os" "os"
"path" "path"
"strings" "strings"
"sync"
"github.com/aws/aws-sdk-go-v2/aws" "github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/s3" "github.com/aws/aws-sdk-go-v2/service/s3"
@@ -32,6 +33,14 @@ import (
// Ensure that we are implementing StoragePluginServiceServer // Ensure that we are implementing StoragePluginServiceServer
var _ pb.StoragePluginServiceServer = (*StoragePlugin)(nil) var _ pb.StoragePluginServiceServer = (*StoragePlugin)(nil)
// clientCache caches previously initialized S3API clients created with a RoleARN attribute.
type clientCache struct {
// cache is a map of cached s3 clients. The key of the map
// is the public id of the storage bucket
cache map[string]S3API
sync.RWMutex
}
// StoragePlugin implements the StoragePluginServiceServer interface for the // StoragePlugin implements the StoragePluginServiceServer interface for the
// AWS storage service plugin. // AWS storage service plugin.
type StoragePlugin struct { type StoragePlugin struct {
@@ -42,6 +51,112 @@ type StoragePlugin struct {
// testStorageStateOpts are passed in to the stored state to control test behavior // testStorageStateOpts are passed in to the stored state to control test behavior
testStorageStateOpts []awsStoragePersistedStateOption testStorageStateOpts []awsStoragePersistedStateOption
clients *clientCache
}
// New creates a new StoragePlugin
func New() *StoragePlugin {
c := &clientCache{
cache: make(map[string]S3API),
}
return &StoragePlugin{
clients: c,
}
}
// getClient returns an S3API client for the given storage bucket id.
func (p *StoragePlugin) getClient(ctx context.Context,
storageBucketId string,
storageState *awsStoragePersistedState,
opt ...s3Option) (S3API, error) {
if storageBucketId == "" {
// No storage bucket ID to key cache on, create new client and return
client, err := storageState.s3Client(ctx, opt...)
if err != nil {
return nil, errors.BadRequestStatus("error creating S3 client: %s", err)
}
return client, nil
}
opts, err := getOpts(opt...)
if err != nil {
return nil, fmt.Errorf("error parsing options in cache: %w", err)
}
if opts.withCacheRefresh {
// Forced cache refresh
p.clients.Lock()
defer p.clients.Unlock()
client, err := storageState.s3Client(ctx, opt...)
if err != nil {
return nil, errors.BadRequestStatus("error creating S3 client: %s", err)
}
p.clients.cache[storageBucketId] = client
return client, nil
}
p.clients.RLock()
client, ok := p.clients.cache[storageBucketId]
p.clients.RUnlock()
if !ok || client.Credentials().Expired() {
// We got a cache miss or the credentials has expired, time to refresh
p.clients.Lock()
defer p.clients.Unlock()
// Check cache again in case another caller updated it since we got the lock
client, ok = p.clients.cache[storageBucketId]
if ok && !client.Credentials().Expired() {
// Got a cache hit with valid credentials, return cached client
return client, nil
}
// Create new client and cache it
var err error
client, err = storageState.s3Client(ctx, opt...)
if err != nil {
return nil, errors.BadRequestStatus("error creating S3 client: %s", err)
}
p.clients.cache[storageBucketId] = client
}
return client, nil
}
type s3Caller func(client S3API) (any, error)
// call gets the s3client and passes it to the s3caller function, if a permission error is returned
// it forces a cache refresh and tries again.
func (p *StoragePlugin) call(
ctx context.Context,
fn s3Caller,
storageBucketId string,
storageState *awsStoragePersistedState,
opts ...s3Option) (any, error) {
s3Client, err := p.getClient(ctx, storageBucketId, storageState, opts...)
if err != nil {
return nil, errors.BadRequestStatus("error getting S3 client: %s", err)
}
firstAttempt := true
for {
resp, err := fn(s3Client)
if err != nil {
st, _ := errors.ParseAWSError("", err)
if st.Code() == codes.PermissionDenied && firstAttempt {
// We got a permission error, this is the first time so refresh cache and try again
firstAttempt = false
opts = append(opts, WithCacheRefresh(true))
s3Client, err = p.getClient(ctx, storageBucketId, storageState, opts...)
if err != nil {
return nil, errors.BadRequestStatus("error refreshing S3 client: %s", err)
}
continue
}
return nil, err
}
return resp, nil
}
} }
// OnCreateStorageBucket is called when a storage bucket is created. // OnCreateStorageBucket is called when a storage bucket is created.
@@ -64,7 +179,7 @@ func (p *StoragePlugin) OnCreateStorageBucket(ctx context.Context, req *pb.OnCre
return nil, err return nil, err
} }
credConfig, err := cred.GetCredentialsConfig(bucket.GetSecrets(), storageAttributes.CredentialAttributes, false) credConfig, err := cred.GetCredentialsConfig(bucket.GetSecrets(), storageAttributes.CredentialAttributes)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -155,7 +270,7 @@ func (p *StoragePlugin) OnUpdateStorageBucket(ctx context.Context, req *pb.OnUpd
// Verify the incoming credentials are valid and return any errors to the // Verify the incoming credentials are valid and return any errors to the
// user if they're not. Note this doesn't validate the credentials against // user if they're not. Note this doesn't validate the credentials against
// AWS - it only does logical validation on the fields. // AWS - it only does logical validation on the fields.
updatedCredentials, err := cred.GetCredentialsConfig(newBucket.GetSecrets(), newStorageAttributes.CredentialAttributes, false) updatedCredentials, err := cred.GetCredentialsConfig(newBucket.GetSecrets(), newStorageAttributes.CredentialAttributes)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -318,7 +433,7 @@ func (p *StoragePlugin) HeadObject(ctx context.Context, req *pb.HeadObjectReques
return nil, err return nil, err
} }
credConfig, err := cred.GetCredentialsConfig(bucket.GetSecrets(), storageAttributes.CredentialAttributes, false) credConfig, err := cred.GetCredentialsConfig(bucket.GetSecrets(), storageAttributes.CredentialAttributes)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -346,19 +461,20 @@ func (p *StoragePlugin) HeadObject(ctx context.Context, req *pb.HeadObjectReques
if storageAttributes.EndpointUrl != "" { if storageAttributes.EndpointUrl != "" {
opts = append(opts, WithEndpoint(storageAttributes.EndpointUrl)) opts = append(opts, WithEndpoint(storageAttributes.EndpointUrl))
} }
s3Client, err := storageState.S3Client(ctx, opts...)
if err != nil {
return nil, errors.BadRequestStatus("error getting S3 client: %s", err)
}
objectKey := path.Join(bucket.GetBucketPrefix(), req.GetKey()) objectKey := path.Join(bucket.GetBucketPrefix(), req.GetKey())
resp, err := s3Client.HeadObject(ctx, &s3.HeadObjectInput{ headCall := func(s3Client S3API) (any, error) {
Bucket: aws.String(bucket.GetBucketName()), return s3Client.HeadObject(ctx, &s3.HeadObjectInput{
Key: aws.String(objectKey), Bucket: aws.String(bucket.GetBucketName()),
}) Key: aws.String(objectKey),
if err != nil { })
return nil, parseS3Error(err, "failed to head object", req).Err()
} }
headResp, err := p.call(ctx, headCall, bucket.GetId(), storageState, opts...)
if err != nil {
return nil, parseS3Error("head object", err, req).Err()
}
resp := headResp.(*s3.HeadObjectOutput)
return &pb.HeadObjectResponse{ return &pb.HeadObjectResponse{
ContentLength: resp.ContentLength, ContentLength: resp.ContentLength,
LastModified: timestamppb.New(*resp.LastModified), LastModified: timestamppb.New(*resp.LastModified),
@@ -386,7 +502,7 @@ func (p *StoragePlugin) ValidatePermissions(ctx context.Context, req *pb.Validat
return nil, err return nil, err
} }
credConfig, err := cred.GetCredentialsConfig(bucket.GetSecrets(), storageAttributes.CredentialAttributes, false) credConfig, err := cred.GetCredentialsConfig(bucket.GetSecrets(), storageAttributes.CredentialAttributes)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -444,7 +560,7 @@ func (p *StoragePlugin) GetObject(req *pb.GetObjectRequest, stream pb.StoragePlu
return err return err
} }
credConfig, err := cred.GetCredentialsConfig(bucket.GetSecrets(), storageAttributes.CredentialAttributes, false) credConfig, err := cred.GetCredentialsConfig(bucket.GetSecrets(), storageAttributes.CredentialAttributes)
if err != nil { if err != nil {
return err return err
} }
@@ -472,19 +588,19 @@ func (p *StoragePlugin) GetObject(req *pb.GetObjectRequest, stream pb.StoragePlu
if storageAttributes.EndpointUrl != "" { if storageAttributes.EndpointUrl != "" {
opts = append(opts, WithEndpoint(storageAttributes.EndpointUrl)) opts = append(opts, WithEndpoint(storageAttributes.EndpointUrl))
} }
s3Client, err := storageState.S3Client(stream.Context(), opts...)
if err != nil {
return errors.BadRequestStatus("error getting S3 client: %s", err)
}
objectKey := path.Join(bucket.GetBucketPrefix(), req.GetKey()) objectKey := path.Join(bucket.GetBucketPrefix(), req.GetKey())
resp, err := s3Client.GetObject(stream.Context(), &s3.GetObjectInput{ getCall := func(s3Client S3API) (any, error) {
Bucket: aws.String(bucket.GetBucketName()), return s3Client.GetObject(stream.Context(), &s3.GetObjectInput{
Key: aws.String(objectKey), Bucket: aws.String(bucket.GetBucketName()),
}) Key: aws.String(objectKey),
if err != nil { })
return parseS3Error(err, "failed to get object", req).Err()
} }
getResp, err := p.call(stream.Context(), getCall, bucket.GetId(), storageState, opts...)
if err != nil {
return parseS3Error("get object", err, req).Err()
}
resp := getResp.(*s3.GetObjectOutput)
defer resp.Body.Close() defer resp.Body.Close()
reader := bufio.NewReader(resp.Body) reader := bufio.NewReader(resp.Body)
@@ -555,7 +671,7 @@ func (p *StoragePlugin) PutObject(ctx context.Context, req *pb.PutObjectRequest)
return nil, err return nil, err
} }
credConfig, err := cred.GetCredentialsConfig(bucket.GetSecrets(), storageAttributes.CredentialAttributes, false) credConfig, err := cred.GetCredentialsConfig(bucket.GetSecrets(), storageAttributes.CredentialAttributes)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -583,10 +699,6 @@ func (p *StoragePlugin) PutObject(ctx context.Context, req *pb.PutObjectRequest)
if storageAttributes.EndpointUrl != "" { if storageAttributes.EndpointUrl != "" {
opts = append(opts, WithEndpoint(storageAttributes.EndpointUrl)) opts = append(opts, WithEndpoint(storageAttributes.EndpointUrl))
} }
s3Client, err := storageState.S3Client(ctx, opts...)
if err != nil {
return nil, errors.BadRequestStatus("error getting S3 client: %s", err)
}
hash := sha256.New() hash := sha256.New()
if _, err := io.Copy(hash, file); err != nil { if _, err := io.Copy(hash, file); err != nil {
@@ -598,18 +710,23 @@ func (p *StoragePlugin) PutObject(ctx context.Context, req *pb.PutObjectRequest)
if err != nil { if err != nil {
return nil, errors.UnknownStatus("failed to rewind file pointer") return nil, errors.UnknownStatus("failed to rewind file pointer")
} }
objectKey := path.Join(bucket.GetBucketPrefix(), req.GetKey()) objectKey := path.Join(bucket.GetBucketPrefix(), req.GetKey())
resp, err := s3Client.PutObject(ctx, &s3.PutObjectInput{
Bucket: aws.String(bucket.GetBucketName()), putCall := func(s3Client S3API) (any, error) {
Key: aws.String(objectKey), return s3Client.PutObject(ctx, &s3.PutObjectInput{
Body: file, Bucket: aws.String(bucket.GetBucketName()),
ChecksumAlgorithm: types.ChecksumAlgorithmSha256, Key: aws.String(objectKey),
ChecksumSHA256: aws.String(checksum), Body: file,
}) ChecksumAlgorithm: types.ChecksumAlgorithmSha256,
if err != nil { ChecksumSHA256: aws.String(checksum),
return nil, parseS3Error(err, "failed to put object", req).Err() })
} }
putResp, err := p.call(ctx, putCall, bucket.GetId(), storageState, opts...)
if err != nil {
return nil, parseS3Error("put object", err, req).Err()
}
resp := putResp.(*s3.PutObjectOutput)
if resp.ChecksumSHA256 == nil { if resp.ChecksumSHA256 == nil {
return nil, errors.UnknownStatus("missing checksum response from aws") return nil, errors.UnknownStatus("missing checksum response from aws")
} }
@@ -650,7 +767,7 @@ func (p *StoragePlugin) DeleteObjects(ctx context.Context, req *pb.DeleteObjects
return nil, err return nil, err
} }
credConfig, err := cred.GetCredentialsConfig(bucket.GetSecrets(), storageAttributes.CredentialAttributes, false) credConfig, err := cred.GetCredentialsConfig(bucket.GetSecrets(), storageAttributes.CredentialAttributes)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -678,10 +795,6 @@ func (p *StoragePlugin) DeleteObjects(ctx context.Context, req *pb.DeleteObjects
if storageAttributes.EndpointUrl != "" { if storageAttributes.EndpointUrl != "" {
opts = append(opts, WithEndpoint(storageAttributes.EndpointUrl)) opts = append(opts, WithEndpoint(storageAttributes.EndpointUrl))
} }
client, err := storageState.S3Client(ctx, opts...)
if err != nil {
return nil, errors.BadRequestStatus("error getting S3 client: %s", err)
}
prefix := path.Join(bucket.GetBucketPrefix(), req.GetKeyPrefix()) prefix := path.Join(bucket.GetBucketPrefix(), req.GetKeyPrefix())
if strings.HasSuffix(req.GetKeyPrefix(), "/") { if strings.HasSuffix(req.GetKeyPrefix(), "/") {
@@ -691,12 +804,19 @@ func (p *StoragePlugin) DeleteObjects(ctx context.Context, req *pb.DeleteObjects
} }
if !req.Recursive { if !req.Recursive {
_, err := client.DeleteObject(ctx, &s3.DeleteObjectInput{ deleteCall := func(s3Client S3API) (any, error) {
Bucket: aws.String(bucket.GetBucketName()), return s3Client.DeleteObject(ctx, &s3.DeleteObjectInput{
Key: aws.String(prefix), Bucket: aws.String(bucket.GetBucketName()),
}) Key: aws.String(prefix),
})
}
_, err := p.call(ctx, deleteCall, bucket.GetId(), storageState, opts...)
if err != nil { if err != nil {
return nil, parseS3Error(err, "failed to delete object", req).Err() return nil, parseS3Error("delete object", err, req).Err()
}
if err != nil {
return nil, parseS3Error("delete object", err, req).Err()
} }
return &pb.DeleteObjectsResponse{ return &pb.DeleteObjectsResponse{
ObjectsDeleted: uint32(1), ObjectsDeleted: uint32(1),
@@ -704,10 +824,13 @@ func (p *StoragePlugin) DeleteObjects(ctx context.Context, req *pb.DeleteObjects
} }
const maxkeys = 1000 const maxkeys = 1000
objects := []types.ObjectIdentifier{} objects := []types.ObjectIdentifier{}
client, err := p.getClient(ctx, bucket.GetId(), storageState, opts...)
if err != nil {
return nil, errors.BadRequestStatus("error getting S3 client: %s", err)
}
var conToken *string var conToken *string
truncated := true truncated, firstAttempt := true, true
for truncated { for truncated {
res, err := client.ListObjectsV2(ctx, &s3.ListObjectsV2Input{ res, err := client.ListObjectsV2(ctx, &s3.ListObjectsV2Input{
Bucket: aws.String(bucket.GetBucketName()), Bucket: aws.String(bucket.GetBucketName()),
@@ -716,7 +839,19 @@ func (p *StoragePlugin) DeleteObjects(ctx context.Context, req *pb.DeleteObjects
ContinuationToken: conToken, ContinuationToken: conToken,
}) })
if err != nil { if err != nil {
return nil, parseS3Error(err, "failed to list objects", req).Err() st, _ := errors.ParseAWSError("", err)
if st.Code() == codes.PermissionDenied && firstAttempt {
// This is first attempt and we get a permission error, refresh cache and try again
firstAttempt = false
opts = append(opts, WithCacheRefresh(true))
client, err = p.getClient(ctx, bucket.GetId(), storageState, opts...)
if err != nil {
return nil, errors.BadRequestStatus("error refreshing S3 client: %s", err)
}
continue
}
return nil, parseS3Error("list objects", err, req).Err()
} }
truncated = res.IsTruncated truncated = res.IsTruncated
conToken = res.NextContinuationToken conToken = res.NextContinuationToken
@@ -738,7 +873,7 @@ func (p *StoragePlugin) DeleteObjects(ctx context.Context, req *pb.DeleteObjects
}, },
}) })
if err != nil { if err != nil {
return nil, parseS3Error(err, "failed to delete objects", req).Err() return nil, parseS3Error("delete objects", err, req).Err()
} }
deleted += len(res.Deleted) deleted += len(res.Deleted)
} }
@@ -770,7 +905,7 @@ func dryRunValidation(ctx context.Context, state *awsStoragePersistedState, attr
opts = append(opts, WithEndpoint(attrs.EndpointUrl)) opts = append(opts, WithEndpoint(attrs.EndpointUrl))
} }
client, err := state.S3Client(ctx, opts...) client, err := state.s3Client(ctx, opts...)
if err != nil { if err != nil {
return status.New(codes.InvalidArgument, fmt.Sprintf("error getting S3 client: %s", err)) return status.New(codes.InvalidArgument, fmt.Sprintf("error getting S3 client: %s", err))
} }
@@ -786,7 +921,7 @@ func dryRunValidation(ctx context.Context, state *awsStoragePersistedState, attr
Body: bytes.NewReader([]byte("hashicorp boundary aws plugin access test")), Body: bytes.NewReader([]byte("hashicorp boundary aws plugin access test")),
}); err != nil { }); err != nil {
var st *status.Status var st *status.Status
st, permissions.Write = errors.ParseAWSError(err, "failed to put object") st, permissions.Write = errors.ParseAWSError("put object", err)
errs = multierror.Append(errs, st.Err()) errs = multierror.Append(errs, st.Err())
} else { } else {
permissions.Write = &pb.Permission{State: pb.StateType_STATE_TYPE_OK, CheckedAt: timestamppb.Now()} permissions.Write = &pb.Permission{State: pb.StateType_STATE_TYPE_OK, CheckedAt: timestamppb.Now()}
@@ -797,7 +932,7 @@ func dryRunValidation(ctx context.Context, state *awsStoragePersistedState, attr
Key: aws.String(objectKey), Key: aws.String(objectKey),
}); err != nil { }); err != nil {
var st *status.Status var st *status.Status
st, permissions.Read = errors.ParseAWSError(err, "failed to get object") st, permissions.Read = errors.ParseAWSError("get object", err)
errs = multierror.Append(errs, st.Err()) errs = multierror.Append(errs, st.Err())
} else { } else {
permissions.Read = &pb.Permission{State: pb.StateType_STATE_TYPE_OK, CheckedAt: timestamppb.Now()} permissions.Read = &pb.Permission{State: pb.StateType_STATE_TYPE_OK, CheckedAt: timestamppb.Now()}
@@ -808,7 +943,7 @@ func dryRunValidation(ctx context.Context, state *awsStoragePersistedState, attr
Key: aws.String(objectKey), Key: aws.String(objectKey),
}); err != nil { }); err != nil {
var st *status.Status var st *status.Status
st, permissions.Read = errors.ParseAWSError(err, "failed to head object") st, permissions.Read = errors.ParseAWSError("head object", err)
errs = multierror.Append(errs, st.Err()) errs = multierror.Append(errs, st.Err())
} }
@@ -817,10 +952,11 @@ func dryRunValidation(ctx context.Context, state *awsStoragePersistedState, attr
Prefix: aws.String(objectKey), Prefix: aws.String(objectKey),
}); err != nil { }); err != nil {
var st *status.Status var st *status.Status
st, permissions.Read = errors.ParseAWSError(err, "failed to list object") st, permissions.Read = errors.ParseAWSError("list object", err)
errs = multierror.Append(errs, st.Err()) errs = multierror.Append(errs, st.Err())
} else if res == nil || len(res.Contents) != 1 || *res.Contents[0].Key != objectKey { } else if res == nil || len(res.Contents) != 1 || *res.Contents[0].Key != objectKey {
return status.New(codes.Aborted, fmt.Sprintf("list response did not contain the expected key: %+v", res)) permissions.Read = &pb.Permission{State: pb.StateType_STATE_TYPE_UNKNOWN, CheckedAt: timestamppb.Now()}
errs = multierror.Append(errs, status.New(codes.Aborted, fmt.Sprintf("list response did not contain the expected key: %+v", res)).Err())
} }
if _, err := client.DeleteObject(ctx, &s3.DeleteObjectInput{ if _, err := client.DeleteObject(ctx, &s3.DeleteObjectInput{
@@ -828,7 +964,7 @@ func dryRunValidation(ctx context.Context, state *awsStoragePersistedState, attr
Key: aws.String(objectKey), Key: aws.String(objectKey),
}); err != nil { }); err != nil {
var st *status.Status var st *status.Status
st, permissions.Delete = errors.ParseAWSError(err, "failed to delete object") st, permissions.Delete = errors.ParseAWSError("delete object", err)
errs = multierror.Append(errs, st.Err()) errs = multierror.Append(errs, st.Err())
} else { } else {
permissions.Delete = &pb.Permission{State: pb.StateType_STATE_TYPE_OK, CheckedAt: timestamppb.Now()} permissions.Delete = &pb.Permission{State: pb.StateType_STATE_TYPE_OK, CheckedAt: timestamppb.Now()}
+168 -45
View File
@@ -153,7 +153,7 @@ func TestStoragePlugin_OnCreateStorageBucket(t *testing.T) {
), ),
}), }),
}, },
expectedErrContains: "aws service unknown: unknown error: error rotating credentials", expectedErrContains: "aws service unknown: unknown error: rotating credentials:",
expectedErrCode: codes.Unknown, expectedErrCode: codes.Unknown,
expectedDetails: nil, expectedDetails: nil,
}, },
@@ -178,7 +178,7 @@ func TestStoragePlugin_OnCreateStorageBucket(t *testing.T) {
}), }),
)), )),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to put object", expectedErrContains: "aws service s3: invalid credentials: put object:",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -211,7 +211,7 @@ func TestStoragePlugin_OnCreateStorageBucket(t *testing.T) {
}), }),
)), )),
}, },
expectedErrContains: "aws service s3: throttling error: failed to put object", expectedErrContains: "aws service s3: throttling: put object:",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -245,7 +245,7 @@ func TestStoragePlugin_OnCreateStorageBucket(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to get object", expectedErrContains: "aws service s3: invalid credentials: get object:",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -280,7 +280,7 @@ func TestStoragePlugin_OnCreateStorageBucket(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: throttling error: failed to get object", expectedErrContains: "aws service s3: throttling: get object:",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -314,7 +314,7 @@ func TestStoragePlugin_OnCreateStorageBucket(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to head object", expectedErrContains: "aws service s3: invalid credentials: head object:",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -349,7 +349,7 @@ func TestStoragePlugin_OnCreateStorageBucket(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: throttling error: failed to head object", expectedErrContains: "aws service s3: throttling: head object:",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -384,7 +384,7 @@ func TestStoragePlugin_OnCreateStorageBucket(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to delete object", expectedErrContains: "aws service s3: invalid credentials: delete object:",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -857,7 +857,7 @@ func TestStoragePlugin_OnUpdateStorageBucket(t *testing.T) {
), ),
}), }),
}, },
expectedErrContains: "aws service unknown: unknown error: failed to delete access key", expectedErrContains: "aws service unknown: unknown error: deleting credentials:",
expectedErrCode: codes.Unknown, expectedErrCode: codes.Unknown,
}, },
{ {
@@ -896,7 +896,7 @@ func TestStoragePlugin_OnUpdateStorageBucket(t *testing.T) {
), ),
}), }),
}, },
expectedErrContains: "aws service unknown: unknown error: error rotating credentials", expectedErrContains: "aws service unknown: unknown error: rotating credentials",
expectedErrCode: codes.Unknown, expectedErrCode: codes.Unknown,
}, },
{ {
@@ -920,7 +920,7 @@ func TestStoragePlugin_OnUpdateStorageBucket(t *testing.T) {
testMockS3WithPutObjectError(TestAwsS3Error("AccessDenied", "PutObject", "not authorized")), testMockS3WithPutObjectError(TestAwsS3Error("AccessDenied", "PutObject", "not authorized")),
)), )),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to put object", expectedErrContains: "aws service s3: invalid credentials: put object:",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -953,7 +953,7 @@ func TestStoragePlugin_OnUpdateStorageBucket(t *testing.T) {
testMockS3WithPutObjectError(TestAwsS3Error("ThrottlingException", "PutObject", "throttling exception")), testMockS3WithPutObjectError(TestAwsS3Error("ThrottlingException", "PutObject", "throttling exception")),
)), )),
}, },
expectedErrContains: "aws service s3: throttling error: failed to put object", expectedErrContains: "aws service s3: throttling: put object",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -987,7 +987,7 @@ func TestStoragePlugin_OnUpdateStorageBucket(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to get object", expectedErrContains: "aws service s3: invalid credentials: get object",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -1022,7 +1022,7 @@ func TestStoragePlugin_OnUpdateStorageBucket(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: throttling error: failed to get object", expectedErrContains: "aws service s3: throttling: get object",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -1056,7 +1056,7 @@ func TestStoragePlugin_OnUpdateStorageBucket(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to head object", expectedErrContains: "aws service s3: invalid credentials: head object",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -1091,7 +1091,7 @@ func TestStoragePlugin_OnUpdateStorageBucket(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: throttling error: failed to head object", expectedErrContains: "aws service s3: throttling: head object",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -1255,7 +1255,7 @@ func TestStoragePlugin_OnUpdateStorageBucket(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to head object", expectedErrContains: "aws service s3: invalid credentials: head object",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -1363,7 +1363,7 @@ func TestStoragePlugin_OnUpdateStorageBucket(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to put object", expectedErrContains: "aws service s3: invalid credentials: put object",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -1486,7 +1486,7 @@ func TestStoragePlugin_OnUpdateStorageBucket(t *testing.T) {
), ),
}), }),
}, },
expectedErrContains: "aws service unknown: unknown error: failed to delete access key", expectedErrContains: "aws service unknown: unknown error: deleting credentials",
expectedErrCode: codes.Unknown, expectedErrCode: codes.Unknown,
}, },
{ {
@@ -1599,7 +1599,7 @@ func TestStoragePlugin_OnUpdateStorageBucket(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to put object", expectedErrContains: "aws service s3: invalid credentials: put object",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -1738,7 +1738,7 @@ func TestStoragePlugin_OnUpdateStorageBucket(t *testing.T) {
), ),
}), }),
}, },
expectedErrContains: "aws service unknown: unknown error: error rotating credentials", expectedErrContains: "aws service unknown: unknown error: rotating credentials",
expectedErrCode: codes.Unknown, expectedErrCode: codes.Unknown,
}, },
{ {
@@ -1973,7 +1973,7 @@ func TestStoragePlugin_OnDeleteStorageBucket(t *testing.T) {
), ),
}), }),
}, },
expectedErrContains: "aws service unknown: unknown error: failed to delete access key", expectedErrContains: "aws service unknown: unknown error: deleting credentials",
expectedErrCode: codes.Unknown, expectedErrCode: codes.Unknown,
}, },
{ {
@@ -2172,7 +2172,7 @@ func TestStoragePlugin_HeadObject(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to head object", expectedErrContains: "aws service s3: invalid credentials: head object",
expectedErrCode: codes.PermissionDenied, expectedErrCode: codes.PermissionDenied,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -2196,7 +2196,7 @@ func TestStoragePlugin_HeadObject(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: throttling error: failed to head object", expectedErrContains: "aws service s3: throttling: head object",
expectedErrCode: codes.Unavailable, expectedErrCode: codes.Unavailable,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -2219,7 +2219,7 @@ func TestStoragePlugin_HeadObject(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws s3 error: failed to head object", expectedErrContains: "aws service s3: head object",
expectedErrCode: codes.NotFound, expectedErrCode: codes.NotFound,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -2425,7 +2425,7 @@ func TestStoragePlugin_ValidatePermissions(t *testing.T) {
}), }),
)), )),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to put object", expectedErrContains: "aws service s3: invalid credentials: put object",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -2458,7 +2458,7 @@ func TestStoragePlugin_ValidatePermissions(t *testing.T) {
}), }),
)), )),
}, },
expectedErrContains: "aws service s3: throttling error: failed to put object", expectedErrContains: "aws service s3: throttling: put object",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -2492,7 +2492,7 @@ func TestStoragePlugin_ValidatePermissions(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to get object", expectedErrContains: "aws service s3: invalid credentials: get object",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -2527,7 +2527,7 @@ func TestStoragePlugin_ValidatePermissions(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: throttling error: failed to get object", expectedErrContains: "aws service s3: throttling: get object",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -2561,7 +2561,7 @@ func TestStoragePlugin_ValidatePermissions(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to head object", expectedErrContains: "aws service s3: invalid credentials: head object",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -2596,7 +2596,7 @@ func TestStoragePlugin_ValidatePermissions(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: throttling error: failed to head object", expectedErrContains: "aws service s3: throttling: head object",
expectedErrCode: codes.FailedPrecondition, expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -2666,6 +2666,43 @@ func TestStoragePlugin_ValidatePermissions(t *testing.T) {
), ),
}, },
}, },
{
name: "dryRunValidation failed putObject with missing list expected key",
req: validRequest(),
credOpts: validSTSMock(),
storageOpts: []awsStoragePersistedStateOption{
withTestS3APIFunc(newTestMockS3(
nil,
testMockS3WithPutObjectError(TestAwsS3Error("AccessDenied", "PutObject", "not authorized")),
testMockS3WithGetObjectOutput(&s3.GetObjectOutput{}),
testMockS3WithHeadObjectOutput(&s3.HeadObjectOutput{}),
testMockS3WithListObjectsV2OutputFunc(func(i *s3.ListObjectsV2Input) *s3.ListObjectsV2Output {
return &s3.ListObjectsV2Output{
Contents: []s3types.Object{},
}
}),
)),
},
expectedErrContains: "aws service s3: invalid credentials: put object",
expectedErrCode: codes.FailedPrecondition,
expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{
Read: &pb.Permission{
State: pb.StateType_STATE_TYPE_UNKNOWN,
CheckedAt: timestamppb.Now(),
},
Write: &pb.Permission{
State: pb.StateType_STATE_TYPE_ERROR,
ErrorDetails: "not authorized",
CheckedAt: timestamppb.Now(),
},
Delete: &pb.Permission{
State: pb.StateType_STATE_TYPE_OK,
CheckedAt: timestamppb.Now(),
},
},
},
},
} }
for _, tc := range cases { for _, tc := range cases {
@@ -2814,7 +2851,7 @@ func TestStoragePlugin_GetObject(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to get object", expectedErrContains: "aws service s3: invalid credentials: get object",
expectedErrCode: codes.PermissionDenied, expectedErrCode: codes.PermissionDenied,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -2838,7 +2875,7 @@ func TestStoragePlugin_GetObject(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws s3 error: failed to get object", expectedErrContains: "aws service s3: get object",
expectedErrCode: codes.NotFound, expectedErrCode: codes.NotFound,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -2861,7 +2898,7 @@ func TestStoragePlugin_GetObject(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws s3 error: failed to get object", expectedErrContains: "aws service s3: get object",
expectedErrCode: codes.NotFound, expectedErrCode: codes.NotFound,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -2884,7 +2921,7 @@ func TestStoragePlugin_GetObject(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws s3 error: failed to get object", expectedErrContains: "aws service s3: get object",
expectedErrCode: codes.NotFound, expectedErrCode: codes.NotFound,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -2908,7 +2945,7 @@ func TestStoragePlugin_GetObject(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: throttling error: failed to get object", expectedErrContains: "aws service s3: throttling: get object",
expectedErrCode: codes.Unavailable, expectedErrCode: codes.Unavailable,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -3263,7 +3300,7 @@ func TestStoragePlugin_PutObject(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to put object", expectedErrContains: "aws service s3: invalid credentials: put object",
expectedErrCode: codes.PermissionDenied, expectedErrCode: codes.PermissionDenied,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -3287,7 +3324,7 @@ func TestStoragePlugin_PutObject(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws s3 error: failed to put object", expectedErrContains: "aws service s3: put object",
expectedErrCode: codes.NotFound, expectedErrCode: codes.NotFound,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -3311,7 +3348,7 @@ func TestStoragePlugin_PutObject(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: throttling error: failed to put object", expectedErrContains: "aws service s3: throttling: put object",
expectedErrCode: codes.Unavailable, expectedErrCode: codes.Unavailable,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -3603,7 +3640,7 @@ func TestStoragePlugin_DeleteObjects(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to delete object", expectedErrContains: "aws service s3: invalid credentials: delete object",
expectedErrCode: codes.PermissionDenied, expectedErrCode: codes.PermissionDenied,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -3627,7 +3664,7 @@ func TestStoragePlugin_DeleteObjects(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to list objects", expectedErrContains: "aws service s3: invalid credentials: list objects",
expectedErrCode: codes.PermissionDenied, expectedErrCode: codes.PermissionDenied,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -3659,7 +3696,7 @@ func TestStoragePlugin_DeleteObjects(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: invalid credentials error: failed to delete objects", expectedErrContains: "aws service s3: invalid credentials: delete objects",
expectedErrCode: codes.PermissionDenied, expectedErrCode: codes.PermissionDenied,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -3683,7 +3720,7 @@ func TestStoragePlugin_DeleteObjects(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: throttling error: failed to delete object", expectedErrContains: "aws service s3: throttling: delete object",
expectedErrCode: codes.Unavailable, expectedErrCode: codes.Unavailable,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -3706,7 +3743,7 @@ func TestStoragePlugin_DeleteObjects(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: throttling error: failed to list objects", expectedErrContains: "aws service s3: throttling: list objects",
expectedErrCode: codes.Unavailable, expectedErrCode: codes.Unavailable,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -3737,7 +3774,7 @@ func TestStoragePlugin_DeleteObjects(t *testing.T) {
), ),
), ),
}, },
expectedErrContains: "aws service s3: throttling error: failed to delete objects", expectedErrContains: "aws service s3: throttling: delete objects",
expectedErrCode: codes.Unavailable, expectedErrCode: codes.Unavailable,
expectedDetails: &pb.StorageBucketCredentialState{ expectedDetails: &pb.StorageBucketCredentialState{
State: &pb.Permissions{ State: &pb.Permissions{
@@ -3880,3 +3917,89 @@ func TestStoragePlugin_DeleteObjects(t *testing.T) {
}) })
} }
} }
func TestS3ClientCache(t *testing.T) {
ctx := context.Background()
assert, require := assert.New(t), require.New(t)
cred1, err := awsutil.NewCredentialsConfig(
awsutil.WithRegion("us-east-1"),
awsutil.WithAccessKey("cred1"),
awsutil.WithSecretKey("secret1"),
)
require.NoError(err)
cred2, err := awsutil.NewCredentialsConfig(
awsutil.WithRegion("us-east-1"),
awsutil.WithAccessKey("cred2"),
awsutil.WithSecretKey("secret2"),
)
require.NoError(err)
cred3, err := awsutil.NewCredentialsConfig(
awsutil.WithRegion("us-east-1"),
awsutil.WithAccessKey("cred3"),
awsutil.WithSecretKey("secret3"),
)
require.NoError(err)
p := New()
cred, err := credential.NewAwsCredentialPersistedState(
credential.WithCredentialsConfig(cred1),
)
require.NoError(err)
state, err := newAwsStoragePersistedState(withCredentials(cred))
require.NoError(err)
// Cache should be empty before first call
assert.Empty(p.clients.cache)
client, err := p.getClient(ctx, "id", state)
require.NoError(err)
require.NotNil(client)
assert.Equal(cred1.AccessKey, client.Credentials().AccessKeyID)
assert.Equal(cred1.SecretKey, client.Credentials().SecretAccessKey)
// Update state with new credentials
cred, err = credential.NewAwsCredentialPersistedState(
credential.WithCredentialsConfig(cred2),
)
require.NoError(err)
state, err = newAwsStoragePersistedState(withCredentials(cred))
require.NoError(err)
// Client is cached and creds valid so it should still grab initial client
client, err = p.getClient(ctx, "id", state)
require.NoError(err)
require.NotNil(client)
assert.Equal(cred1.AccessKey, client.Credentials().AccessKeyID)
assert.Equal(cred1.SecretKey, client.Credentials().SecretAccessKey)
// Force credentials to expire
c := client.(*s3Client)
c.creds.CanExpire = true
p.clients.Lock()
p.clients.cache["id"] = c
p.clients.Unlock()
// Getting client should now create new client on cred2 since the credentials have expired
client, err = p.getClient(ctx, "id", state)
require.NoError(err)
require.NotNil(client)
assert.Equal(cred2.AccessKey, client.Credentials().AccessKeyID)
assert.Equal(cred2.SecretKey, client.Credentials().SecretAccessKey)
// Update state with new credentials again
cred, err = credential.NewAwsCredentialPersistedState(
credential.WithCredentialsConfig(cred3),
)
require.NoError(err)
state, err = newAwsStoragePersistedState(withCredentials(cred))
require.NoError(err)
// Getting client and force cache refresh should return cred3 based client
client, err = p.getClient(ctx, "id", state, WithCacheRefresh(true))
require.NoError(err)
require.NotNil(client)
assert.Equal(cred3.AccessKey, client.Credentials().AccessKeyID)
assert.Equal(cred3.SecretKey, client.Credentials().SecretAccessKey)
}
+32 -4
View File
@@ -27,6 +27,16 @@ type S3API interface {
PutObject(ctx context.Context, params *s3.PutObjectInput, optFns ...func(*s3.Options)) (*s3.PutObjectOutput, error) PutObject(ctx context.Context, params *s3.PutObjectInput, optFns ...func(*s3.Options)) (*s3.PutObjectOutput, error)
DeleteObjects(ctx context.Context, params *s3.DeleteObjectsInput, optFns ...func(*s3.Options)) (*s3.DeleteObjectsOutput, error) DeleteObjects(ctx context.Context, params *s3.DeleteObjectsInput, optFns ...func(*s3.Options)) (*s3.DeleteObjectsOutput, error)
ListObjectsV2(ctx context.Context, params *s3.ListObjectsV2Input, optFns ...func(*s3.Options)) (*s3.ListObjectsV2Output, error) ListObjectsV2(ctx context.Context, params *s3.ListObjectsV2Input, optFns ...func(*s3.Options)) (*s3.ListObjectsV2Output, error)
Credentials() aws.Credentials
}
type s3Client struct {
*s3.Client
creds aws.Credentials
}
func (c *s3Client) Credentials() aws.Credentials {
return c.creds
} }
var customClient = &http.Client{ var customClient = &http.Client{
@@ -91,9 +101,9 @@ func (s *awsStoragePersistedState) toProto() (*storagebuckets.StorageBucketPersi
return &storagebuckets.StorageBucketPersisted{Data: data}, nil return &storagebuckets.StorageBucketPersisted{Data: data}, nil
} }
// S3Client returns a configured S3 client based on the session // s3Client returns a configured S3 client based on the session
// information stored in the state. // information stored in the state.
func (s *awsStoragePersistedState) S3Client(ctx context.Context, opt ...s3Option) (S3API, error) { func (s *awsStoragePersistedState) s3Client(ctx context.Context, opt ...s3Option) (S3API, error) {
opts, err := getOpts(opt...) opts, err := getOpts(opt...)
if err != nil { if err != nil {
return nil, fmt.Errorf("error parsing options when fetching S3 client: %w", err) return nil, fmt.Errorf("error parsing options when fetching S3 client: %w", err)
@@ -114,7 +124,16 @@ func (s *awsStoragePersistedState) S3Client(ctx context.Context, opt ...s3Option
if s.testS3APIFunc != nil { if s.testS3APIFunc != nil {
return s.testS3APIFunc(*awsCfg) return s.testS3APIFunc(*awsCfg)
} }
return s3.NewFromConfig(*awsCfg, s3Opts...), nil
// Retrieve the credentials provider from the client
credsProvider := awsCfg.Credentials
creds, err := credsProvider.Retrieve(ctx)
if err != nil {
return nil, fmt.Errorf("failed to retrieve credentials: %v\n", err)
}
c := s3.NewFromConfig(*awsCfg, s3Opts...)
return &s3Client{Client: c, creds: creds}, nil
} }
// getOpts iterates the inbound s3Options and returns a struct // getOpts iterates the inbound s3Options and returns a struct
@@ -136,13 +155,22 @@ type s3Option func(*s3Options) error
// options = how options are represented // options = how options are represented
type s3Options struct { type s3Options struct {
withEndpoint string withEndpoint string
withCacheRefresh bool
} }
func getDefaultS3Options() s3Options { func getDefaultS3Options() s3Options {
return s3Options{} return s3Options{}
} }
// WithCacheRefresh controls if the cache should be forced to refresh
func WithCacheRefresh(refresh bool) s3Option {
return func(o *s3Options) error {
o.withCacheRefresh = refresh
return nil
}
}
// WithEndpoint contains the endpoint to use // WithEndpoint contains the endpoint to use
func WithEndpoint(with string) s3Option { func WithEndpoint(with string) s3Option {
return func(o *s3Options) error { return func(o *s3Options) error {
+1 -1
View File
@@ -64,7 +64,7 @@ func TestAwsStoragePersistedStateS3Client(t *testing.T) {
) )
require.NoError(err) require.NoError(err)
clientRaw, err := state.S3Client(context.Background(), tc.s3Opts...) clientRaw, err := state.s3Client(context.Background(), tc.s3Opts...)
require.NoError(err) require.NoError(err)
require.NotNil(clientRaw) require.NotNil(clientRaw)
client, ok := clientRaw.(*testMockS3) client, ok := clientRaw.(*testMockS3)
+112 -7
View File
@@ -17,12 +17,16 @@ import (
"github.com/hashicorp/boundary-plugin-aws/plugin/service/storage" "github.com/hashicorp/boundary-plugin-aws/plugin/service/storage"
"github.com/hashicorp/boundary/sdk/pbs/controller/api/resources/storagebuckets" "github.com/hashicorp/boundary/sdk/pbs/controller/api/resources/storagebuckets"
pb "github.com/hashicorp/boundary/sdk/pbs/plugin" pb "github.com/hashicorp/boundary/sdk/pbs/plugin"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require" "github.com/stretchr/testify/require"
"google.golang.org/grpc" "google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure" "google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/types/known/structpb" "google.golang.org/protobuf/types/known/structpb"
) )
// NOTE: this test does not vaildate against dynamic credentials because
// this credential type can only be tested on an EC2 instance.
func TestStoragePlugin(t *testing.T) { func TestStoragePlugin(t *testing.T) {
region := os.Getenv("AWS_REGION") region := os.Getenv("AWS_REGION")
if region == "" { if region == "" {
@@ -75,6 +79,12 @@ func TestStoragePlugin(t *testing.T) {
iamSecretAccessKeyMissingPutObject, err := tf.GetOutputString("iam_secret_access_key_missing_put_obj") iamSecretAccessKeyMissingPutObject, err := tf.GetOutputString("iam_secret_access_key_missing_put_obj")
require.NoError(err) require.NoError(err)
iamAccessKeyMissingDeleteObject, err := tf.GetOutputString("iam_access_key_missing_delete_obj")
require.NoError(err)
iamSecretAccessKeyMissingDeleteObject, err := tf.GetOutputString("iam_secret_access_key_missing_delete_obj")
require.NoError(err)
// Start the workflow now. Set up the storage bucket. Note that this // Start the workflow now. Set up the storage bucket. Note that this
// will cause the state to go out of drift above in the sense that // will cause the state to go out of drift above in the sense that
// the access key ID/secret access key will no longer be valid. We // the access key ID/secret access key will no longer be valid. We
@@ -121,7 +131,7 @@ func TestStoragePlugin(t *testing.T) {
testPluginOnDeleteStorageBucket(ctx, t, p, bucketName, region, keyid, secret, true) testPluginOnDeleteStorageBucket(ctx, t, p, bucketName, region, keyid, secret, true)
// ******************** // ********************
// * Object Methods: PutObject, GetObject, HeadObject // * Object Methods: PutObject, GetObject, HeadObject, DeleteObjects
// ******************** // ********************
// //
// Reassign the keyid and secret first. // Reassign the keyid and secret first.
@@ -132,11 +142,59 @@ func TestStoragePlugin(t *testing.T) {
// * Validate Permissions // * Validate Permissions
// ******************** // ********************
// //
var expectedSBCState *pb.StorageBucketCredentialState
// Validate error is returned for missing get object permission // Validate error is returned for missing get object permission
testPluginValidatePermissions(ctx, t, p, bucketName, region, iamAccessKeyMissingGetObject, iamSecretAccessKeyMissingGetObject) expectedSBCState = &pb.StorageBucketCredentialState{
State: &pb.Permissions{
Write: &pb.Permission{
State: pb.StateType_STATE_TYPE_OK,
},
Read: &pb.Permission{
State: pb.StateType_STATE_TYPE_ERROR,
},
Delete: &pb.Permission{
State: pb.StateType_STATE_TYPE_OK,
},
},
}
testPluginValidatePermissions(ctx, t, p, bucketName, region, iamAccessKeyMissingGetObject, iamSecretAccessKeyMissingGetObject, expectedSBCState)
// Validate error is returned for missing put object permission // Validate error is returned for missing put object permission
testPluginValidatePermissions(ctx, t, p, bucketName, region, iamAccessKeyMissingPutObject, iamSecretAccessKeyMissingPutObject) expectedSBCState = &pb.StorageBucketCredentialState{
State: &pb.Permissions{
Write: &pb.Permission{
State: pb.StateType_STATE_TYPE_ERROR,
},
Read: &pb.Permission{
// Since we cannot write an object to S3,
// we cannot test against the ability to read from S3.
State: pb.StateType_STATE_TYPE_UNKNOWN,
},
Delete: &pb.Permission{
// We can still try deleting an object that does
// not exist in the S3 bucket to validate access.
State: pb.StateType_STATE_TYPE_OK,
},
},
}
testPluginValidatePermissions(ctx, t, p, bucketName, region, iamAccessKeyMissingPutObject, iamSecretAccessKeyMissingPutObject, expectedSBCState)
// Validate error is returned for missing delete object permission
expectedSBCState = &pb.StorageBucketCredentialState{
State: &pb.Permissions{
Write: &pb.Permission{
State: pb.StateType_STATE_TYPE_OK,
},
Read: &pb.Permission{
State: pb.StateType_STATE_TYPE_OK,
},
Delete: &pb.Permission{
State: pb.StateType_STATE_TYPE_ERROR,
},
},
}
testPluginValidatePermissions(ctx, t, p, bucketName, region, iamAccessKeyMissingDeleteObject, iamSecretAccessKeyMissingDeleteObject, expectedSBCState)
} }
func testPluginOnCreateStorageBucket(ctx context.Context, t *testing.T, p *storage.StoragePlugin, bucketName, region, accessKeyId, secretAccessKey string, rotate bool) (string, string) { func testPluginOnCreateStorageBucket(ctx context.Context, t *testing.T, p *storage.StoragePlugin, bucketName, region, accessKeyId, secretAccessKey string, rotate bool) (string, string) {
@@ -289,10 +347,12 @@ func testPluginOnDeleteStorageBucket(ctx context.Context, t *testing.T, p *stora
} }
} }
func testPluginValidatePermissions(ctx context.Context, t *testing.T, p *storage.StoragePlugin, bucketName, region, accessKeyId, secretAccessKey string) { func testPluginValidatePermissions(ctx context.Context, t *testing.T, p *storage.StoragePlugin, bucketName, region, accessKeyId, secretAccessKey string, expectedState *pb.StorageBucketCredentialState) {
t.Helper() t.Helper()
t.Logf("testing ValidatePermissions") t.Logf("testing ValidatePermissions")
require := require.New(t) require, assert := require.New(t), assert.New(t)
require.NotNil(expectedState)
reqAttrs, err := structpb.NewStruct(map[string]any{ reqAttrs, err := structpb.NewStruct(map[string]any{
credential.ConstRegion: region, credential.ConstRegion: region,
@@ -315,6 +375,51 @@ func testPluginValidatePermissions(ctx context.Context, t *testing.T, p *storage
_, err = p.ValidatePermissions(ctx, req) _, err = p.ValidatePermissions(ctx, req)
require.Error(err) require.Error(err)
var actualSBCState *pb.StorageBucketCredentialState
if st, ok := status.FromError(err); ok {
for _, detail := range st.Details() {
if statusDetail, ok := detail.(*pb.StorageBucketCredentialState); ok {
actualSBCState = statusDetail
break
}
}
}
require.NotNil(actualSBCState)
require.NotNil(actualSBCState.GetState())
expectedReadState := expectedState.GetState().GetRead()
if expectedReadState != nil {
actualReadState := actualSBCState.GetState().GetRead()
require.NotNil(actualReadState)
assert.Equal(expectedReadState.GetState(), actualReadState.GetState())
assert.NotEmpty(actualReadState.GetCheckedAt())
if expectedReadState.GetState() == pb.StateType_STATE_TYPE_ERROR {
assert.NotEmpty(actualReadState.GetErrorDetails())
}
}
expectedWriteState := expectedState.GetState().GetWrite()
if expectedWriteState != nil {
actualWriteState := actualSBCState.GetState().GetWrite()
require.NotNil(actualWriteState)
assert.Equal(expectedWriteState.GetState(), actualWriteState.GetState())
assert.NotEmpty(actualWriteState.GetCheckedAt())
if expectedWriteState.GetState() == pb.StateType_STATE_TYPE_ERROR {
assert.NotEmpty(actualWriteState.GetErrorDetails())
}
}
expectedDeleteState := expectedState.GetState().GetDelete()
if expectedDeleteState != nil {
actualDeleteState := actualSBCState.GetState().GetDelete()
require.NotNil(actualDeleteState)
assert.Equal(expectedDeleteState.GetState(), actualDeleteState.GetState())
assert.NotEmpty(actualDeleteState.GetCheckedAt())
if expectedDeleteState.GetState() == pb.StateType_STATE_TYPE_ERROR {
assert.NotEmpty(actualDeleteState.GetErrorDetails())
}
}
} }
func testPluginObjectMethods(ctx context.Context, t *testing.T, p *storage.StoragePlugin, bucketName, region, accessKeyId, secretAccessKey string) { func testPluginObjectMethods(ctx context.Context, t *testing.T, p *storage.StoragePlugin, bucketName, region, accessKeyId, secretAccessKey string) {
@@ -369,7 +474,7 @@ func testPluginObjectMethods(ctx context.Context, t *testing.T, p *storage.Stora
// Need to create a GRPC server to test GetObject // Need to create a GRPC server to test GetObject
t.Logf("testing GetObject") t.Logf("testing GetObject")
lis, err := net.Listen("tcp", "localhost:2030") lis, err := net.Listen("tcp", "[::1]:2030")
require.NoError(err) require.NoError(err)
grpcServer := grpc.NewServer() grpcServer := grpc.NewServer()
pb.RegisterStoragePluginServiceServer(grpcServer, &storage.StoragePlugin{}) pb.RegisterStoragePluginServiceServer(grpcServer, &storage.StoragePlugin{})
@@ -377,7 +482,7 @@ func testPluginObjectMethods(ctx context.Context, t *testing.T, p *storage.Stora
grpcServer.Serve(lis) grpcServer.Serve(lis)
}() }()
conn, err := grpc.Dial("localhost:2030", grpc.WithTransportCredentials(insecure.NewCredentials())) conn, err := grpc.Dial("[::1]:2030", grpc.WithTransportCredentials(insecure.NewCredentials()))
require.NoError(err) require.NoError(err)
defer conn.Close() defer conn.Close()
client := pb.NewStoragePluginServiceClient(conn) client := pb.NewStoragePluginServiceClient(conn)
+97 -12
View File
@@ -32,7 +32,9 @@ resource "aws_iam_policy" "valid" {
"Action": [ "Action": [
"s3:PutObject", "s3:PutObject",
"s3:GetObject", "s3:GetObject",
"s3:GetObjectAttributes" "s3:DeleteObject",
"s3:GetObjectAttributes",
"s3:ListBucket"
], ],
"Effect": "Allow", "Effect": "Allow",
"Resource": "${aws_s3_bucket.test.arn}*" "Resource": "${aws_s3_bucket.test.arn}*"
@@ -79,7 +81,9 @@ resource "aws_iam_policy" "missing_put_obj" {
{ {
"Action": [ "Action": [
"s3:GetObject", "s3:GetObject",
"s3:GetObjectAttributes" "s3:GetObjectAttributes",
"s3:ListBucket",
"s3:DeleteObject"
], ],
"Effect": "Allow", "Effect": "Allow",
"Resource": "${aws_s3_bucket.test.arn}*" "Resource": "${aws_s3_bucket.test.arn}*"
@@ -125,7 +129,7 @@ resource "aws_iam_policy" "missing_get_obj" {
{ {
"Action": [ "Action": [
"s3:PutObject", "s3:PutObject",
"s3:GetObjectAttributes" "s3:DeleteObject"
], ],
"Effect": "Allow", "Effect": "Allow",
"Resource": "${aws_s3_bucket.test.arn}*" "Resource": "${aws_s3_bucket.test.arn}*"
@@ -141,18 +145,69 @@ resource "aws_iam_role_policy_attachment" "missing_get_obj" {
policy_arn = aws_iam_policy.missing_get_obj.arn policy_arn = aws_iam_policy.missing_get_obj.arn
} }
resource "aws_iam_role" "missing_delete_obj" {
name = "${random_id.prefix.dec}-missing-delete-obj"
tags = local.tags
assume_role_policy = jsonencode({
Version = "2012-10-17"
Statement = [
{
Action = "sts:AssumeRole"
Effect = "Allow"
Sid = ""
Principal = {
AWS: data.aws_caller_identity.current.user_id
}
},
]
})
}
resource "aws_iam_policy" "missing_delete_obj" {
name = "${random_id.prefix.dec}-missing-delete-obj"
tags = local.tags
policy = <<EOT
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"s3:PutObject",
"s3:GetObject",
"s3:GetObjectAttributes",
"s3:ListBucket"
],
"Effect": "Allow",
"Resource": "${aws_s3_bucket.test.arn}*"
}
]
}
EOT
}
resource "aws_iam_role_policy_attachment" "missing_delete_obj" {
role = aws_iam_role.missing_delete_obj.name
policy_arn = aws_iam_policy.missing_delete_obj.arn
}
# Static Credential Testing # Static Credential Testing
resource "random_id" "user_name" { resource "random_id" "user_name" {
count = var.iam_user_count count = var.iam_user_count
prefix = random_id.prefix.dec prefix = "demo-${local.hashicorp_email}-boundary-iam-user"
byte_length = 4 byte_length = 4
} }
resource "aws_iam_user" "test" { resource "aws_iam_user" "test" {
count = var.iam_user_count count = var.iam_user_count
name = random_id.user_name[count.index].dec name = random_id.user_name[count.index].dec
force_destroy = true force_destroy = true
tags = local.tags permissions_boundary = "arn:aws:iam::${data.aws_caller_identity.current.account_id}:policy/DemoUser"
tags = {
"boundary-demo" = local.hashicorp_email
}
} }
resource "aws_iam_access_key" "test" { resource "aws_iam_access_key" "test" {
@@ -195,17 +250,44 @@ resource "aws_iam_user_policy_attachment" "test_credentials" {
policy_arn = aws_iam_policy.credentials[count.index].arn policy_arn = aws_iam_policy.credentials[count.index].arn
} }
# Edge case for missing DeleteObject permission
resource "random_id" "missing_delete_obj" {
prefix = "demo-${local.hashicorp_email}-boundary-iam-user"
byte_length = 4
}
resource "aws_iam_user" "missing_delete_obj" {
name = random_id.missing_delete_obj.dec
force_destroy = true
permissions_boundary = "arn:aws:iam::${data.aws_caller_identity.current.account_id}:policy/DemoUser"
tags = {
"boundary-demo" = local.hashicorp_email
}
}
resource "aws_iam_access_key" "missing_delete_obj" {
user = aws_iam_user.missing_delete_obj.name
}
resource "aws_iam_user_policy_attachment" "missing_delete_obj" {
user = aws_iam_user.missing_delete_obj.name
policy_arn = aws_iam_policy.missing_delete_obj.arn
}
# Edge case for missing GetObject permission # Edge case for missing GetObject permission
resource "random_id" "missing_get_obj" { resource "random_id" "missing_get_obj" {
prefix = random_id.prefix.dec prefix = "demo-${local.hashicorp_email}-boundary-iam-user"
byte_length = 4 byte_length = 4
} }
resource "aws_iam_user" "missing_get_obj" { resource "aws_iam_user" "missing_get_obj" {
name = random_id.missing_get_obj.dec name = random_id.missing_get_obj.dec
force_destroy = true force_destroy = true
tags = local.tags permissions_boundary = "arn:aws:iam::${data.aws_caller_identity.current.account_id}:policy/DemoUser"
tags = {
"boundary-demo" = local.hashicorp_email
}
} }
resource "aws_iam_access_key" "missing_get_obj" { resource "aws_iam_access_key" "missing_get_obj" {
@@ -220,14 +302,17 @@ resource "aws_iam_user_policy_attachment" "missing_get_obj" {
# Edge case for missing PutObject permission # Edge case for missing PutObject permission
resource "random_id" "missing_put_obj" { resource "random_id" "missing_put_obj" {
prefix = random_id.prefix.dec prefix = "demo-${local.hashicorp_email}-boundary-iam-user"
byte_length = 4 byte_length = 4
} }
resource "aws_iam_user" "missing_put_obj" { resource "aws_iam_user" "missing_put_obj" {
name = random_id.missing_put_obj.dec name = random_id.missing_put_obj.dec
force_destroy = true force_destroy = true
tags = local.tags permissions_boundary = "arn:aws:iam::${data.aws_caller_identity.current.account_id}:policy/DemoUser"
tags = {
"boundary-demo" = local.hashicorp_email
}
} }
resource "aws_iam_access_key" "missing_put_obj" { resource "aws_iam_access_key" "missing_put_obj" {
+15 -1
View File
@@ -13,10 +13,14 @@ output "missing_put_obj_policy_arn" {
value = aws_iam_role.missing_put_obj.arn value = aws_iam_role.missing_put_obj.arn
} }
output "missing_put_get_policy_arn" { output "missing_get_obj_policy_arn" {
value = aws_iam_role.missing_get_obj.arn value = aws_iam_role.missing_get_obj.arn
} }
output "missing_delete_obj_policy_arn" {
value = aws_iam_role.missing_delete_obj.arn
}
output "iam_user_names" { output "iam_user_names" {
value = aws_iam_user.test.*.name value = aws_iam_user.test.*.name
} }
@@ -54,3 +58,13 @@ output "iam_secret_access_key_missing_get_obj" {
value = aws_iam_access_key.missing_get_obj.secret value = aws_iam_access_key.missing_get_obj.secret
sensitive = true sensitive = true
} }
output "iam_access_key_missing_delete_obj" {
value = aws_iam_access_key.missing_delete_obj.id
sensitive = true
}
output "iam_secret_access_key_missing_delete_obj" {
value = aws_iam_access_key.missing_delete_obj.secret
sensitive = true
}
+9 -1
View File
@@ -4,6 +4,14 @@
resource "aws_s3_bucket" "test" { resource "aws_s3_bucket" "test" {
bucket = random_id.prefix.dec bucket = random_id.prefix.dec
force_destroy = true force_destroy = true
acl = "private"
tags = local.tags tags = local.tags
} }
resource "aws_s3_bucket_public_access_block" "secure_access" {
bucket = aws_s3_bucket.test.id
block_public_acls = true
block_public_policy = true
ignore_public_acls = true
restrict_public_buckets = true
}
+5 -3
View File
@@ -4,7 +4,7 @@
data "aws_caller_identity" "current" {} data "aws_caller_identity" "current" {}
resource "random_id" "prefix" { resource "random_id" "prefix" {
prefix = "storage-e2e-test" prefix = "aws-plugin-e2e-test"
byte_length = 4 byte_length = 4
} }
@@ -13,8 +13,10 @@ variable "iam_user_count" {
} }
locals { locals {
hashicorp_email = split(":", data.aws_caller_identity.current.user_id)[1]
tags = { tags = {
user_id = split(":", data.aws_caller_identity.current.user_id)[1] User = split(":", data.aws_caller_identity.current.user_id)[1]
repo = "boundary-plugin-aws" Repo = "boundary-plugin-aws"
Environment = "Demo"
} }
} }