Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Add a check for permission to createVolume for EBS and creds validation for aws #1339

Merged
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion pkg/aws/aws.go
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,6 @@ func GetCredentials(ctx context.Context, config map[string]string) (*credentials
if err != nil {
return nil, err
}

// check if role switching is needed, then return creds
return switchAWSRole(ctx, creds, config[ConfigRole], assumedRole, assumeRoleDuration)
}
Expand Down Expand Up @@ -148,3 +147,21 @@ func GetConfig(ctx context.Context, config map[string]string) (awsConfig *aws.Co
}
return &aws.Config{Credentials: creds}, region, nil
}

func IsAwsCredsValid(ctx context.Context, config map[string]string) (bool, error) {
Copy link
Contributor Author

@leuyentran leuyentran Mar 29, 2022

Choose a reason for hiding this comment

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

It is a conscious decision here to pass config map[string]string as input , as opposed to *aws.Config. This design is to minimize kanister calls on caller side. All that is needed to validate creds is the the creds itself, without having to call another kanister func beforehand (such as GetConfig())

var maxRetries int = 10
awsConfig, region, err := GetConfig(ctx, config)
if err != nil {
return false, errors.Wrap(err, "Failed to get config for AWS creds")
}
s, err := session.NewSession(awsConfig)
if err != nil {
return false, errors.Wrap(err, "Failed to create session with provided creds")
}
stsCli := sts.New(s, aws.NewConfig().WithRegion(region).WithMaxRetries(maxRetries))
_, err = stsCli.GetCallerIdentity(&sts.GetCallerIdentityInput{})
if err != nil {
return false, errors.Wrap(err, "Failed to get user with provided creds")
}
return true, nil
}
49 changes: 49 additions & 0 deletions pkg/aws/aws_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
// Copyright 2022 The Kanister Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package aws

import (
"context"
"testing"

"gopkg.in/check.v1"

envconfig "github.com/kanisterio/kanister/pkg/config"
)

// Hook up gocheck into the "go test" runner.
func Test(t *testing.T) { check.TestingT(t) }

type AWSSuite struct{}

var _ = check.Suite(&AWSSuite{})

func (s AWSSuite) TestValidCreds(c *check.C) {
ctx := context.Background()
config := map[string]string{}

config[AccessKeyID] = envconfig.GetEnvOrSkip(c, AccessKeyID)
config[SecretAccessKey] = envconfig.GetEnvOrSkip(c, SecretAccessKey)
config[ConfigRegion] = "us-west-2"

res, err := IsAwsCredsValid(ctx, config)
c.Assert(err, check.IsNil)
c.Assert(res, check.Equals, true)

config[AccessKeyID] = "fake-access-id"
res, err = IsAwsCredsValid(ctx, config)
c.Assert(err, check.NotNil)
c.Assert(res, check.Equals, false)
}
34 changes: 34 additions & 0 deletions pkg/blockstorage/awsebs/awsebs.go
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,40 @@ func (s *EbsStorage) VolumeCreate(ctx context.Context, volume blockstorage.Volum
return s.VolumeGet(ctx, volID, volume.Az)
}

// CheckVolumeCreate checks if client as permission to create volumes
func (s *EbsStorage) CheckVolumeCreate(ctx context.Context) (bool, error) {
var zoneName *string
var err error
var size int64 = 1
var dryRun bool = true

ec2Cli, err := newEC2Client(*s.config.Region, s.config)
if err != nil {
return false, errors.Wrapf(err, "Could not get EC2 client")
}
dai := &ec2.DescribeAvailabilityZonesInput{}
az, err := ec2Cli.DescribeAvailabilityZones(dai)
if err != nil {
return false, err
}
if az != nil {
zoneName = az.AvailabilityZones[1].ZoneName
} else {
return false, errors.New("No zone avaialble for EC2 client")
}

cvi := &ec2.CreateVolumeInput{
AvailabilityZone: zoneName,
Size: &size,
DryRun: &dryRun,
}
_, err = s.Ec2Cli.CreateVolume(cvi)
if isDryRunErr(err) {
return true, nil
}
return false, errors.Wrapf(err, "Could not create volume with EC2 client")
}

// VolumeGet is part of blockstorage.Provider
func (s *EbsStorage) VolumeGet(ctx context.Context, id string, zone string) (*blockstorage.Volume, error) {
volIDs := []*string{aws.String(id)}
Expand Down