JakeHillion/storj
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

uplink: use output formats for 'uplink access register' instead of writing to AWS file

Browse Source 
The current uplink access register method has the ability to write to AWS credential files.
This is caused issues with repeat usage in recent AWS CLI code, and there was concern that
it was an unstable solution.  This version instead specifies various output formats "env"
and "aws". "env" formats the text so that it can be used with 'export'.  "Aws" generates
"aws configure" commands to persist the credentials to the AWS credential files as the
previous version could.

Example usages:

Setting ephemeral evironment variables in bash:
export $(uplink access register $(storj-sim network env GATEWAY_0_ACCESS)
--auth-service http://localhost:8000 --format env)

Setting persistant configs via AWS CLI in bash:
source <(uplink access register $(storj-sim network env GATEWAY_0_ACCESS)
--auth-service http://localhost:8000 --format aws --aws-profile storjsim)

Change-Id: I5d78d6462a3537780af3717a298bb2bebf9c2799
This commit is contained in:
Bill Thorp 2020-12-27 09:21:48 -05:00 committed by Bill Thorp
parent 825dc71227
commit f65a1e8c1c
1 changed files with 22 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
cmd/uplink/cmd/access.go
View File

@ -9,14 +9,11 @@ import (
"fmt"
"io/ioutil"
"net/http"
"os"
"path/filepath"
"github.com/btcsuite/btcutil/base58"
"github.com/spf13/cobra"
"github.com/zeebo/errs"
"storj.io/common/fpath"
"storj.io/common/pb"
"storj.io/private/cfgstruct"
"storj.io/private/process"
@ -26,7 +23,8 @@ import (
type registerConfig struct {
AuthService string `help:"the address to the service you wish to register your access with" default:"" basic-help:"true"`
Public bool `help:"if the access should be public" default:"false" basic-help:"true"`
AWSProfile string `help:"update AWS credentials file, appending the credentials using this profile name" default:"" basic-help:"true"`
Format string `help:"format of credentials, use 'env' or 'aws' for using in scripts" default:""`
AWSProfile string `help:"if using --format=aws, output the --profile tag using this profile" default:""`
AccessConfig
}
@ -143,22 +141,27 @@ func accessRegister(cmd *cobra.Command, args []string) (err error) {
if err != nil {
return err
}
fmt.Println("========== CREDENTIALS ===================================================================")
fmt.Println("Access Key ID: ", accessKey)
fmt.Println("Secret Key : ", secretKey)
fmt.Println("Endpoint : ", endpoint)
// update AWS credential file if requested
if registerCfg.AWSProfile != "" {
credentialsPath, err := getAwsCredentialsPath()
if err != nil {
return err
}
err = writeAWSCredentials(credentialsPath, registerCfg.AWSProfile, accessKey, secretKey)
if err != nil {
return err
switch registerCfg.Format {
case "env": // export / set compatible format
fmt.Printf("AWS_ACCESS_KEY_ID=%s\n", accessKey)
fmt.Printf("AWS_SECRET_ACCESS_KEY=%s\n", secretKey)
// note that AWS_ENDPOINT configuration is not natively utilized by the AWS CLI
fmt.Printf("AWS_ENDPOINT=%s\n", endpoint)
case "aws": // aws configuration commands
profile := ""
if registerCfg.AWSProfile != "" {
profile = " --profile " + registerCfg.AWSProfile
fmt.Printf("aws configure %s\n", profile)
}
fmt.Printf("aws configure %s set aws_access_key_id %s\n", profile, accessKey)
fmt.Printf("aws configure %s set aws_secret_access_key %s\n", profile, secretKey)
// note that this configuration is not natively utilized by the AWS CLI
fmt.Printf("aws configure %s set s3.endpoint_url %s\n", profile, endpoint)
default: // plain text
fmt.Println("========== CREDENTIALS ===================================================================")
fmt.Println("Access Key ID: ", accessKey)
fmt.Println("Secret Key : ", secretKey)
fmt.Println("Endpoint : ", endpoint)
}
return nil
}
@ -220,39 +223,3 @@ func RegisterAccess(access *uplink.Access, authService string, public bool) (acc
}
return accessKey, secretKey, respBody["endpoint"], nil
}
// getAwsCredentialsPath returns the expected AWS credentials path.
func getAwsCredentialsPath() (string, error) {
if credentialsPath, found := os.LookupEnv("AWS_SHARED_CREDENTIALS_FILE"); found {
return credentialsPath, nil
}
homeDir, err := os.UserHomeDir()
if err != nil {
return "", errs.Wrap(err)
}
return filepath.Join(homeDir, ".aws", "credentials"), nil
}
// writeAWSCredentials appends to credentialsPath using an AWS compliant credential formatting.
func writeAWSCredentials(credentialsPath, profileName, accessKey, secretKey string) error {
oldCredentials, err := ioutil.ReadFile(credentialsPath)
if err != nil && !os.IsNotExist(err) {
return errs.Wrap(err)
}
const format = "\n[%s]\naws_access_key_id = %s\naws_secret_access_key = %s\n"
newCredentials := fmt.Sprintf(format, profileName, accessKey, secretKey)
var fileMode os.FileMode
fileInfo, err := os.Stat(credentialsPath)
if err == nil {
fileMode = fileInfo.Mode()
} else {
fileMode = 0644
}
err = fpath.AtomicWriteFile(credentialsPath, append(oldCredentials, newCredentials...), fileMode)
if err != nil {
return errs.Wrap(err)
}
fmt.Printf("Updated AWS credential file %s with profile '%s'\n", credentialsPath, profileName)
return nil
}