Skip to content

Commit

Permalink
for granted sso command, add storing parameters in input config #650 (#…
Browse files Browse the repository at this point in the history 
…651)

* for granted sso command, add storing parameters in input config

This reverts commit 00d95e1.

* remove println

* support multiple section names and remove deprecated source from config

* remove println

* For profile-template with a default, check IsSet instead of having a value

* simplify referencing cfgSSO

* add glag to populate

* Update pkg/config/config.go

* Update pkg/granted/sso.go

---------

Co-authored-by: ibottamike <[email protected]>
Co-authored-by: Chris Norman <[email protected]>
  • Loading branch information
@mikesarver @ibottamike @chrnorm
3 people authored May 3, 2024
1 parent e20b6e2 commit 6efc360
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 15 deletions.
10 changes: 10 additions & 0 deletions pkg/config/config.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ type Config struct {
Variables map[string]string `toml:",omitempty"`
Registries []Registry `toml:",omitempty"`
} `toml:",omitempty"`

SSO map[string]AWSSSOConfiguration `toml:",omitempty"`
}

type KeyringConfig struct {
Expand All @@ -75,6 +77,14 @@ type Registry struct {
PrefixAllProfiles bool `toml:"prefixAllProfiles,omitempty"`
}

type AWSSSOConfiguration struct {
StartURL string
SSORegion string
Prefix string
NoCredentialProcess bool
ProfileTemplate string
}

// NewDefaultConfig returns a config with OS specific defaults populated
func NewDefaultConfig() Config {
// macos devices should default to the keychain backend
Expand Down
82 changes: 67 additions & 15 deletions pkg/granted/sso.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (
cfconfig "github.com/common-fate/glide-cli/pkg/config"
"github.com/common-fate/glide-cli/pkg/profilesource"
"github.com/common-fate/granted/pkg/cfaws"
grantedconfig "github.com/common-fate/granted/pkg/config"
"github.com/common-fate/granted/pkg/idclogin"
"github.com/common-fate/granted/pkg/securestorage"
"github.com/common-fate/granted/pkg/testable"
Expand All @@ -47,6 +48,7 @@ var GenerateCommand = cli.Command{
Usage: "Prints an AWS configuration file to stdout with profiles from accounts and roles available in AWS SSO",
UsageText: "granted [global options] sso generate [command options] [sso-start-url]",
Flags: []cli.Flag{
&cli.StringFlag{Name: "config", Usage: "Specify the SSO config section in the Granted config file ([SSO.name])", Value: "default"},
&cli.StringFlag{Name: "prefix", Usage: "Specify a prefix for all generated profile names"},
&cli.StringFlag{Name: "sso-region", Usage: "Specify the SSO region"},
&cli.StringSliceFlag{Name: "source", Usage: "The sources to load AWS profiles from (valid values are: 'aws-sso', 'commonfate')", Value: cli.NewStringSlice("aws-sso")},
Expand All @@ -56,32 +58,52 @@ var GenerateCommand = cli.Command{
ctx := c.Context
fullCommand := fmt.Sprintf("%s %s", c.App.Name, c.Command.FullName()) // e.g. 'granted sso populate'

startURL := c.Args().First()
// load config to load defaults
cfg, err := grantedconfig.Load()
if err != nil {
clio.Errorf("Error reading default config (~/.granted/config)")
return nil
}

cfgSSO := cfg.SSO[c.String("config")]
startURL := coalesceString(c.Args().First(), cfgSSO.StartURL)
if startURL == "" {
return clierr.New(fmt.Sprintf("Usage: %s [sso-start-url]", fullCommand), clierr.Infof("For example, %s https://example.awsapps.com/start", fullCommand))
}

// if --sso-region is not set, display that is it required
if !c.IsSet("sso-region") {
ssoRegion := coalesceString(c.String("sso-region"), cfgSSO.SSORegion)
if ssoRegion == "" {
clio.Errorf("Please specify the --sso-region flag: '%s --sso-region us-east-1 %s'", fullCommand, startURL)
return nil
}

sso_region := c.String("sso-region")
// Since `profile-template` has a default value, need to check IsSet instead of having a value
var profileNameTemplate string
if c.IsSet("profile-template") {
// when not set, use config when it has a value
profileNameTemplate = c.String("profile-template")
} else {
// prefer config over default
profileNameTemplate = coalesceString(cfgSSO.ProfileTemplate, c.String("profile-template"))
}

prefix := coalesceString(c.String("prefix"), cfgSSO.Prefix)
noCredentialProcess := c.Bool("no-credential-process") || cfgSSO.NoCredentialProcess

g := awsconfigfile.Generator{
Config: ini.Empty(),
ProfileNameTemplate: c.String("profile-template"),
NoCredentialProcess: c.Bool("no-credential-process"),
Prefix: c.String("prefix"),
ProfileNameTemplate: profileNameTemplate,
NoCredentialProcess: noCredentialProcess,
Prefix: prefix,
}

for _, s := range c.StringSlice("source") {
switch s {
case "aws-sso":
g.AddSource(AWSSSOSource{SSORegion: sso_region, StartURL: startURL})
g.AddSource(AWSSSOSource{SSORegion: ssoRegion, StartURL: startURL})
case "commonfate", "common-fate", "cf":
ps, err := getCFProfileSource(c, sso_region, startURL)
ps, err := getCFProfileSource(c, ssoRegion, startURL)
if err != nil {
return err
}
Expand All @@ -91,7 +113,7 @@ var GenerateCommand = cli.Command{
}
}

err := g.Generate(ctx)
err = g.Generate(ctx)
if err != nil {
return err
}
Expand All @@ -110,6 +132,7 @@ var PopulateCommand = cli.Command{
Usage: "Populate your local AWS configuration file with profiles from accounts and roles available in AWS SSO",
UsageText: "granted [global options] sso populate [command options] [sso-start-url]",
Flags: []cli.Flag{
&cli.StringFlag{Name: "config", Usage: "Specify the SSO config section ([SSO.name])", Value: "default"},
&cli.StringFlag{Name: "prefix", Usage: "Specify a prefix for all generated profile names"},
&cli.StringFlag{Name: "sso-region", Usage: "Specify the SSO region"},
&cli.StringSliceFlag{Name: "sso-scope", Usage: "Specify the SSO scopes"},
Expand All @@ -122,17 +145,39 @@ var PopulateCommand = cli.Command{
ctx := c.Context
fullCommand := fmt.Sprintf("%s %s", c.App.Name, c.Command.FullName()) // e.g. 'granted sso populate'

startURL := c.Args().First()
cfg, err := grantedconfig.Load()
if err != nil {
clio.Errorf("Error reading default config (~/.granted/config)")
return nil
}

cfgSSO := cfg.SSO[c.String("config")]

startURL := coalesceString(c.Args().First(), cfgSSO.StartURL)
if startURL == "" {
return clierr.New(fmt.Sprintf("Usage: %s [sso-start-url]", fullCommand), clierr.Infof("For example, %s https://example.awsapps.com/start", fullCommand))
}

// if --sso-region is not set, display that is it required
if !c.IsSet("sso-region") {
ssoRegion := coalesceString(c.String("sso-region"), cfgSSO.SSORegion)
if ssoRegion == "" {
clio.Errorf("Please specify the --sso-region flag: '%s --sso-region us-east-1 %s'", fullCommand, startURL)
return nil
}
ssoRegion := c.String("sso-region")

// Since `profile-template` has a default value, need to check IsSet instead of having a value
var profileNameTemplate string
if c.IsSet("profile-template") {
// when not set, use config when it has a value
profileNameTemplate = c.String("profile-template")
} else {
// prefer config over default
profileNameTemplate = coalesceString(cfgSSO.ProfileTemplate, c.String("profile-template"))
}

prefix := coalesceString(c.String("prefix"), cfgSSO.Prefix)
noCredentialProcess := c.Bool("no-credential-process") || cfgSSO.NoCredentialProcess

configFilename := cfaws.GetAWSConfigPath()

config, err := ini.LoadSources(ini.LoadOptions{
Expand All @@ -155,9 +200,9 @@ var PopulateCommand = cli.Command{

g := awsconfigfile.Generator{
Config: config,
ProfileNameTemplate: c.String("profile-template"),
NoCredentialProcess: c.Bool("no-credential-process"),
Prefix: c.String("prefix"),
ProfileNameTemplate: profileNameTemplate,
NoCredentialProcess: noCredentialProcess,
Prefix: prefix,
PruneStartURLs: pruneStartURLs,
}

Expand Down Expand Up @@ -440,3 +485,10 @@ func (s AWSSSOSource) GetProfiles(ctx context.Context) ([]awsconfigfile.SSOProfi
}
return ssoProfiles, nil
}

func coalesceString(s1, s2 string) string {
if s1 != "" {
return s1
}
return s2
}

0 comments on commit 6efc360

Please sign in to comment.