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 the option to set a persistent storage for the browser provider #786

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
2 changes: 1 addition & 1 deletion cmd/saml2aws/commands/login.go
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ func resolveLoginDetails(account *cfg.IDPAccount, loginFlags *flags.LoginExecFla
return loginDetails, nil
}

if account.Provider != "Shell" {
if account.Provider != "Shell" && account.Provider != "Browser" {
err = saml2aws.PromptForLoginDetails(loginDetails, account.Provider)
if err != nil {
return nil, errors.Wrap(err, "Error occurred accepting input.")
Expand Down
1 change: 1 addition & 0 deletions cmd/saml2aws/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ func main() {
cmdConfigure.Flag("cache-file", "The location of the SAML cache file (env: SAML2AWS_SAML_CACHE_FILE)").Envar("SAML2AWS_SAML_CACHE_FILE").StringVar(&commonFlags.SAMLCacheFile)
cmdConfigure.Flag("disable-sessions", "Do not use Okta sessions. Uses Okta sessions by default. (env: SAML2AWS_OKTA_DISABLE_SESSIONS)").Envar("SAML2AWS_OKTA_DISABLE_SESSIONS").BoolVar(&commonFlags.DisableSessions)
cmdConfigure.Flag("disable-remember-device", "Do not remember Okta MFA device. Remembers MFA device by default. (env: SAML2AWS_OKTA_DISABLE_REMEMBER_DEVICE)").Envar("SAML2AWS_OKTA_DISABLE_REMEMBER_DEVICE").BoolVar(&commonFlags.DisableRememberDevice)
cmdConfigure.Flag("persistent-data-dir", "Persistent storage for the browser provider. Allows saving passwords and sessions between uses. (env: SAML2AWS_PERSISTENT_DATA_DIR)").Envar("SAML2AWS_PERSISTENT_DATA_DIR").StringVar(&commonFlags.PersistentDataDir)
configFlags := commonFlags

// `login` command and settings
Expand Down
1 change: 1 addition & 0 deletions pkg/cfg/cfg.go
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ type IDPAccount struct {
DisableRememberDevice bool `ini:"disable_remember_device"` // used by Okta
DisableSessions bool `ini:"disable_sessions"` // used by Okta
Prompter string `ini:"prompter"`
PersistentDataDir string `ini:"persistent_data_dir"` // Used by browser
}

func (ia IDPAccount) String() string {
Expand Down
4 changes: 4 additions & 0 deletions pkg/flags/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ type CommonFlags struct {
DisableRememberDevice bool
DisableSessions bool
Prompter string
PersistentDataDir string
}

// LoginExecFlags flags for the Login / Exec commands
Expand Down Expand Up @@ -118,6 +119,9 @@ func ApplyFlagOverrides(commonFlags *CommonFlags, account *cfg.IDPAccount) {
if commonFlags.Prompter != "" {
account.Prompter = commonFlags.Prompter
}
if commonFlags.PersistentDataDir != "" {
account.PersistentDataDir = commonFlags.PersistentDataDir
}

// select the prompter
if commonFlags.Prompter != "" {
Expand Down
38 changes: 30 additions & 8 deletions pkg/provider/browser/browser.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,51 @@ var logger = logrus.WithField("provider", "browser")

// Client client for browser based Identity Provider
type Client struct {
persistentDataDir string
}

// New create new browser based client
func New(idpAccount *cfg.IDPAccount) (*Client, error) {
return &Client{}, nil
return &Client{
persistentDataDir: idpAccount.PersistentDataDir,
}, nil
}

func (cl *Client) Authenticate(loginDetails *creds.LoginDetails) (string, error) {

pw, err := playwright.Run()
pw, err := playwright.Run(&playwright.RunOptions{
Browsers: []string{"chromium"},
})
if err != nil {
return "", err
}

// TODO: provide some overrides for this window
launchOptions := playwright.BrowserTypeLaunchOptions{
Headless: playwright.Bool(false),
}

// currently using Chromium as it is widely supported for Identity providers
//
// this is a sandboxed browser window so password managers and addons are separate
browser, err := pw.Chromium.Launch(launchOptions)
var browser playwright.BrowserContext

if cl.persistentDataDir != "" {
// TODO: provide some overrides for this window
launchOptions := playwright.BrowserTypeLaunchPersistentContextOptions{
Headless: playwright.Bool(false),
}

browser, err = pw.Chromium.LaunchPersistentContext(cl.persistentDataDir, launchOptions)
} else {
// TODO: provide some overrides for this window
launchOptions := playwright.BrowserTypeLaunchOptions{
Headless: playwright.Bool(false),
}

browserNoCtx, err := pw.Chromium.Launch(launchOptions)
if err != nil {
return "", err
}

browser, err = browserNoCtx.NewContext()
}

if err != nil {
return "", err
}
Expand Down