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 multiple port support #108

Merged
merged 8 commits into from
Mar 27, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
13 changes: 6 additions & 7 deletions cli/consts.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,16 @@ var (
ServerAddress string
Version = "TBD"
BuildTimestamp = "BuildTimestamp is not set"
DownloadURL = "URL not set yet"
// CallbackPorts is a list of ports that will be attempted in no particular order for hosting an Oauth2 callback web server.
// This cannot be set using -ldflags='-X ..' because -X requires that this be a string literal or uninitialized.
//
// These ports are chosen somewhat arbitrarily
CallbackPorts = []string{"57468", "47512", "57123", "61232", "48231", "49757", "59834", "54293"}
)

const (
// DefaultTTL for requested credentials in hours
DefaultTTL uint = 1
// DefaultTimeRemaining for new key requests in minutes
DefaultTimeRemaining uint = 5
LinuxAmd64BinaryName string = "keyconjurer-linux-amd64"
LinuxArm64BinaryName string = "keyconjurer-linux-arm64"
WindowsBinaryName string = "keyconjurer-windows.exe"
DarwinArm64BinaryName string = "keyconjurer-darwin-arm64"
DarwinAmd64BinaryName string = "keyconjurer-darwin-amd64"
DefaultTimeRemaining uint = 5
)
20 changes: 14 additions & 6 deletions cli/get.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,13 @@ func init() {
getCmd.Flags().String(FlagRoleSessionName, "KeyConjurer-AssumeRole", "the name of the role session name that will show up in CloudTrail logs")
getCmd.Flags().StringP(FlagOutputType, "o", outputTypeEnvironmentVariable, "Format to save new credentials in. Supported outputs: env, awscli,tencentcli")
getCmd.Flags().String(FlagShellType, shellTypeInfer, "If output type is env, determines which format to output credentials in - by default, the format is inferred based on the execution environment. WSL users may wish to overwrite this to `bash`")
getCmd.Flags().String(FlagAWSCLIPath, "~/.aws/", "Path for directory used by the aws-cli tool. Default is \"~/.aws\".")
getCmd.Flags().String(FlagTencentCLIPath, "~/.tencent/", "Path for directory used by the tencent-cli tool. Default is \"~/.tencent\".")
getCmd.Flags().String(FlagCloudType, "aws", "Choose a cloud vendor. Default is aws. Can choose aws or tencent")
getCmd.Flags().Bool(FlagBypassCache, false, "Do not check the cache for accounts and send the application ID as-is to Okta. This is useful if you have an ID you know is an Okta application ID and it is not stored in your local account cache.")
getCmd.Flags().Bool(FlagLogin, false, "Login to Okta before running the command")
getCmd.Flags().String(FlagAWSCLIPath, "~/.aws/", "Path for directory used by the aws CLI")
getCmd.Flags().BoolP(FlagURLOnly, "u", false, "Print only the URL to visit rather than a user-friendly message")
getCmd.Flags().BoolP(FlagNoBrowser, "b", false, "Do not open a browser window, printing the URL instead")
Comment on lines +47 to +48
Copy link
Member

Choose a reason for hiding this comment

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

What would be the use cases for these options? Is it supposed to be used by users or dev for debugging purposes? Can you give a few examples?

Copy link
Member Author

@punmechanic punmechanic Mar 26, 2024

Choose a reason for hiding this comment

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

These options are mirroring the options in keyconjurer login and are meant to be used with keyconjurer get --login account-name.

The main use-case for these is that if you specify the --login flag. The --login flag in keyconjurer get prompts keyconjurer to log you in if you're not logged in already, rather than erroring out. With these flags, you can control the behavior of keyconjurer, where keyconjurer either:

  • opens a browser (default)
  • displays a url only (not the most user intuitive)
  • displays a human-friendly message on opening a browser with a given url (default if -b specified)

}

func isMemberOfSlice(slice []string, val string) bool {
Expand Down Expand Up @@ -74,16 +76,22 @@ A role must be specified when using this command through the --role flag. You ma
ctx := cmd.Context()
oidcDomain, _ := cmd.Flags().GetString(FlagOIDCDomain)
clientID, _ := cmd.Flags().GetString(FlagClientID)

if HasTokenExpired(config.Tokens) {
if ok, _ := cmd.Flags().GetBool(FlagLogin); ok {
token, err := Login(ctx, oidcDomain, clientID, LoginOutputModeBrowser{})
if err != nil {
return err
urlOnly, _ := cmd.Flags().GetBool(FlagURLOnly)
noBrowser, _ := cmd.Flags().GetBool(FlagNoBrowser)
login := LoginCommand{
Config: config,
OIDCDomain: oidcDomain,
ClientID: clientID,
MachineOutput: ShouldUseMachineOutput(cmd.Flags()) || urlOnly,
NoBrowser: noBrowser,
}
if err := config.SaveOAuthToken(token); err != nil {

if err := login.Execute(cmd.Context()); err != nil {
return err
}

} else {
return ErrTokensExpiredOrAbsent
}
Expand Down
84 changes: 43 additions & 41 deletions cli/login.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import (
"github.com/spf13/cobra"
"github.com/spf13/pflag"
"golang.org/x/exp/slog"
"golang.org/x/oauth2"
)

var (
Expand Down Expand Up @@ -45,65 +44,68 @@ var loginCmd = &cobra.Command{
oidcDomain, _ := cmd.Flags().GetString(FlagOIDCDomain)
clientID, _ := cmd.Flags().GetString(FlagClientID)
urlOnly, _ := cmd.Flags().GetBool(FlagURLOnly)

var outputMode LoginOutputMode = LoginOutputModeBrowser{}
if noBrowser, _ := cmd.Flags().GetBool(FlagNoBrowser); noBrowser {
if ShouldUseMachineOutput(cmd.Flags()) || urlOnly {
outputMode = LoginOutputModeURLOnly{}
} else {
outputMode = LoginOutputModeHumanFriendlyMessage{}
}
}

token, err := Login(cmd.Context(), oidcDomain, clientID, outputMode)
if err != nil {
return err
noBrowser, _ := cmd.Flags().GetBool(FlagNoBrowser)
command := LoginCommand{
Config: config,
OIDCDomain: oidcDomain,
ClientID: clientID,
MachineOutput: ShouldUseMachineOutput(cmd.Flags()) || urlOnly,
NoBrowser: noBrowser,
}

return config.SaveOAuthToken(token)
return command.Execute(cmd.Context())
},
}

func Login(ctx context.Context, domain, clientID string, outputMode LoginOutputMode) (*oauth2.Token, error) {
oauthCfg, err := DiscoverOAuth2Config(ctx, domain, clientID)
if err != nil {
return nil, err
}
type LoginCommand struct {
Config *Config
OIDCDomain string
ClientID string
MachineOutput bool
NoBrowser bool
}

state, err := GenerateState()
func (c LoginCommand) Execute(ctx context.Context) error {
oauthCfg, err := DiscoverOAuth2Config(ctx, c.OIDCDomain, c.ClientID)
if err != nil {
return nil, err
return err
}

codeVerifier, codeChallenge, err := GenerateCodeVerifierAndChallenge()
if err != nil {
return nil, err
handler := RedirectionFlowHandler{
Config: oauthCfg,
Listen: ListenAnyPort("127.0.0.1", CallbackPorts),
OnDisplayURL: openBrowserToURL,
}

return RedirectionFlow(ctx, oauthCfg, state, codeChallenge, codeVerifier, outputMode)
}

type LoginOutputMode interface {
PrintURL(url string) error
}
if c.NoBrowser {
if c.MachineOutput {
handler.OnDisplayURL = printURLToConsole
} else {
handler.OnDisplayURL = friendlyPrintURLToConsole
}
}

type LoginOutputModeBrowser struct{}
state := GenerateState()
challenge := GeneratePkceChallenge()
token, err := handler.HandlePendingSession(ctx, challenge, state)
if err != nil {
return err
}

func (LoginOutputModeBrowser) PrintURL(url string) error {
slog.Debug("trying to open browser window", slog.String("url", url))
return browser.OpenURL(url)
return c.Config.SaveOAuthToken(token)
}

type LoginOutputModeURLOnly struct{}

func (LoginOutputModeURLOnly) PrintURL(url string) error {
func printURLToConsole(url string) error {
fmt.Fprintln(os.Stdout, url)
return nil
}

type LoginOutputModeHumanFriendlyMessage struct{}

func (LoginOutputModeHumanFriendlyMessage) PrintURL(url string) error {
func friendlyPrintURLToConsole(url string) error {
fmt.Printf("Visit the following link in your terminal: %s\n", url)
return nil
}

func openBrowserToURL(url string) error {
slog.Debug("trying to open browser window", slog.String("url", url))
return browser.OpenURL(url)
}
Loading
Loading