config

package
v1.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 27, 2023 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// Version app version
	Version = "1.0.2"

	// AWSCredentialsFormat format const
	AWSCredentialsFormat = "aws-credentials"
	// EnvVarFormat format const
	EnvVarFormat = "env-var"

	// AWSAcctFedAppIDFlag cli flag const
	AWSAcctFedAppIDFlag = "aws-acct-fed-app-id"
	// AWSCredentialsFlag cli flag const
	AWSCredentialsFlag = "aws-credentials"
	// AWSIAMIdPFlag cli flag const
	AWSIAMIdPFlag = "aws-iam-idp"
	// AWSIAMRoleFlag cli flag const
	AWSIAMRoleFlag = "aws-iam-role"
	// DebugAPICallsFlag cli flag const
	DebugAPICallsFlag = "debug-api-calls"
	// DebugConfigFlag cli flag const
	DebugConfigFlag = "debug-config"
	// FormatFlag cli flag const
	FormatFlag = "format"
	// OIDCClientIDFlag cli flag const
	OIDCClientIDFlag = "oidc-client-id"
	// OpenBrowserFlag cli flag const
	OpenBrowserFlag = "open-browser"
	// OrgDomainFlag cli flag const
	OrgDomainFlag = "org-domain"
	// ProfileFlag cli flag const
	ProfileFlag = "profile"
	// QRCodeFlag cli flag const
	QRCodeFlag = "qr-code"
	// SessionDurationFlag cli flag const
	SessionDurationFlag = "session-duration"
	// WriteAWSCredentialsFlag cli flag const
	WriteAWSCredentialsFlag = "write-aws-credentials"
	// LegacyAWSVariablesFlag cli flag const
	LegacyAWSVariablesFlag = "legacy-aws-variables"
	// ExpiryAWSVariablesFlag cli flag const
	ExpiryAWSVariablesFlag = "expiry-aws-variables"
	// CacheAccessTokenFlag cli flag const
	CacheAccessTokenFlag = "cache-access-token"

	// AWSCredentialsEnvVar env var const
	AWSCredentialsEnvVar = "OKTA_AWSCLI_AWS_CREDENTIALS"
	// AWSIAMIdPEnvVar env var const
	AWSIAMIdPEnvVar = "OKTA_AWSCLI_IAM_IDP"
	// AWSIAMRoleEnvVar env var const
	AWSIAMRoleEnvVar = "OKTA_AWSCLI_IAM_ROLE"
	// AWSSessionDurationEnvVar env var const
	AWSSessionDurationEnvVar = "OKTA_AWSCLI_SESSION_DURATION"
	// FormatEnvVar env var const
	FormatEnvVar = "OKTA_AWSCLI_FORMAT"
	// OktaOIDCClientIDEnvVar env var const
	OktaOIDCClientIDEnvVar = "OKTA_OIDC_CLIENT_ID"
	// OktaOrgDomainEnvVar env var const
	OktaOrgDomainEnvVar = "OKTA_ORG_DOMAIN"
	// OktaAWSAccountFederationAppIDEnvVar env var const
	OktaAWSAccountFederationAppIDEnvVar = "OKTA_AWS_ACCOUNT_FEDERATION_APP_ID"
	// OpenBrowserEnvVar env var const
	OpenBrowserEnvVar = "OKTA_AWSCLI_OPEN_BROWSER"
	// ProfileEnvVar env var const
	ProfileEnvVar = "OKTA_AWSCLI_PROFILE"
	// QRCodeEnvVar env var const
	QRCodeEnvVar = "OKTA_AWSCLI_QR_CODE"
	// WriteAWSCredentialsEnvVar env var const
	WriteAWSCredentialsEnvVar = "OKTA_AWSCLI_WRITE_AWS_CREDENTIALS"
	// DebugAPICallsEnvVar env var const
	DebugAPICallsEnvVar = "OKTA_AWSCLI_DEBUG_API_CALLS"
	// DebugConfigEnvVar env var const
	DebugConfigEnvVar = "OKTA_AWSCLI_DEBUG_CONFIG"
	// LegacyAWSVariablesEnvVar env var const
	LegacyAWSVariablesEnvVar = "OKTA_AWSCLI_LEGACY_AWS_VARIABLES"
	// ExpiryAWSVariablesEnvVar env var const
	ExpiryAWSVariablesEnvVar = "OKTA_AWSCLI_EXPIRY_AWS_VARIABLES"
	// CacheAccessTokenEnvVar env var const
	CacheAccessTokenEnvVar = "OKTA_AWSCLI_CACHE_ACCESS_TOKEN"

	// CannotBeBlankErrMsg error message const
	CannotBeBlankErrMsg = "cannot be blank"
	// OrgDomainMsg error message const
	OrgDomainMsg = "Org Domain"

	// DotOkta string const
	DotOkta = ".okta"
	// OktaYaml string const
	OktaYaml = "okta.yaml"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Attributes added in v1.0.0 

type Attributes struct {
	OrgDomain           string
	OIDCAppID           string
	FedAppID            string
	AWSIAMIdP           string
	AWSIAMRole          string
	AWSSessionDuration  int64
	Format              string
	Profile             string
	QRCode              bool
	AWSCredentials      string
	WriteAWSCredentials bool
	OpenBrowser         bool
	DebugAPICalls       bool
	DebugConfig         bool
	LegacyAWSVariables  bool
	ExpiryAWSVariables  bool
	CacheAccessToken    bool
}

Attributes config construction

type Config 

type Config struct {
	// contains filtered or unexported fields
}

Config A config object for the CLI

func CreateConfig added in v1.0.0 

func CreateConfig() (*Config, error)

CreateConfig Creates a new config gathering values in this order of precedence:

  1. CLI flags
  2. ENV variables
  3. .env file

func NewConfig 

func NewConfig(attrs Attributes) (*Config, error)

NewConfig create config from attributes

func (*Config) AWSCredentials 

func (c *Config) AWSCredentials() string

AWSCredentials --

func (*Config) AWSIAMIdP 

func (c *Config) AWSIAMIdP() string

AWSIAMIdP --

func (*Config) AWSIAMRole 

func (c *Config) AWSIAMRole() string

AWSIAMRole --

func (*Config) AWSSessionDuration added in v0.0.4 

func (c *Config) AWSSessionDuration() int64

AWSSessionDuration --

func (*Config) CacheAccessToken added in v1.0.0 

func (c *Config) CacheAccessToken() bool

CacheAccessToken --

func (*Config) DebugAPICalls added in v0.2.0 

func (c *Config) DebugAPICalls() bool

DebugAPICalls --

func (*Config) DebugConfig added in v1.0.2 

func (c *Config) DebugConfig() bool

DebugConfig --

func (*Config) ExpiryAWSVariables added in v1.0.0 

func (c *Config) ExpiryAWSVariables() bool

ExpiryAWSVariables --

func (*Config) FedAppID 

func (c *Config) FedAppID() string

FedAppID --

func (*Config) Format 

func (c *Config) Format() string

Format --

func (*Config) HTTPClient 

func (c *Config) HTTPClient() *http.Client

HTTPClient --

func (*Config) LegacyAWSVariables added in v0.3.0 

func (c *Config) LegacyAWSVariables() bool

LegacyAWSVariables --

func (*Config) OIDCAppID 

func (c *Config) OIDCAppID() string

OIDCAppID --

func (*Config) OktaConfig added in v1.0.2 

func (c *Config) OktaConfig() (config *OktaYamlConfig, err error)

OktaConfig returns an Okta YAML Config object representation of $HOME/.okta/okta.yaml

func (*Config) OpenBrowser added in v0.1.0 

func (c *Config) OpenBrowser() bool

OpenBrowser --

func (*Config) OrgDomain 

func (c *Config) OrgDomain() string

OrgDomain --

func (*Config) Profile 

func (c *Config) Profile() string

Profile --

func (*Config) QRCode 

func (c *Config) QRCode() bool

QRCode --

func (*Config) RunConfigChecks added in v1.0.2 

func (c *Config) RunConfigChecks() (err error)

RunConfigChecks runs a series of checks on the okta.yaml config file

func (*Config) SetAWSCredentials added in v1.0.0 

func (c *Config) SetAWSCredentials(credentials string) error

SetAWSCredentials --

func (*Config) SetAWSIAMIdP added in v1.0.0 

func (c *Config) SetAWSIAMIdP(idp string) error

SetAWSIAMIdP --

func (*Config) SetAWSIAMRole added in v1.0.0 

func (c *Config) SetAWSIAMRole(role string) error

SetAWSIAMRole --

func (*Config) SetAWSSessionDuration added in v1.0.0 

func (c *Config) SetAWSSessionDuration(duration int64) error

SetAWSSessionDuration --

func (*Config) SetCacheAccessToken added in v1.0.0 

func (c *Config) SetCacheAccessToken(cacheAccessToken bool) error

SetCacheAccessToken --

func (*Config) SetDebugAPICalls added in v1.0.0 

func (c *Config) SetDebugAPICalls(debugAPICalls bool) error

SetDebugAPICalls --

func (*Config) SetDebugConfig added in v1.0.2 

func (c *Config) SetDebugConfig(debugConfig bool) error

SetDebugConfig --

func (*Config) SetExpiryAWSVariables added in v1.0.0 

func (c *Config) SetExpiryAWSVariables(expiryAWSVariables bool) error

SetExpiryAWSVariables --

func (*Config) SetFedAppID added in v1.0.0 

func (c *Config) SetFedAppID(appID string) error

SetFedAppID --

func (*Config) SetFormat added in v1.0.0 

func (c *Config) SetFormat(format string) error

SetFormat --

func (*Config) SetHTTPClient added in v1.0.0 

func (c *Config) SetHTTPClient(client *http.Client) error

SetHTTPClient --

func (*Config) SetLegacyAWSVariables added in v1.0.0 

func (c *Config) SetLegacyAWSVariables(legacyAWSVariables bool) error

SetLegacyAWSVariables --

func (*Config) SetOIDCAppID added in v1.0.0 

func (c *Config) SetOIDCAppID(appID string) error

SetOIDCAppID --

func (*Config) SetOpenBrowser added in v1.0.0 

func (c *Config) SetOpenBrowser(openBrowser bool) error

SetOpenBrowser --

func (*Config) SetOrgDomain added in v1.0.0 

func (c *Config) SetOrgDomain(domain string) error

SetOrgDomain --

func (*Config) SetProfile added in v1.0.0 

func (c *Config) SetProfile(profile string) error

SetProfile --

func (*Config) SetQRCode added in v1.0.0 

func (c *Config) SetQRCode(qrCode bool) error

SetQRCode --

func (*Config) SetWriteAWSCredentials added in v1.0.0 

func (c *Config) SetWriteAWSCredentials(writeCredentials bool) error

SetWriteAWSCredentials --

func (*Config) WriteAWSCredentials added in v0.1.0 

func (c *Config) WriteAWSCredentials() bool

WriteAWSCredentials --

type OktaYamlConfig added in v1.0.0 

type OktaYamlConfig struct {
	AWSCLI struct {
		IDPS map[string]string `yaml:"idps"`
	} `yaml:"awscli"`
}

OktaYamlConfig represents config settings from $HOME/.okta/okta.yaml

type ValidationError added in v1.0.0 

type ValidationError struct {
	Field   string
	Message string
}

ValidationError --

func NewValidationError added in v1.0.0 

func NewValidationError(field, msg string) *ValidationError

NewValidationError --

func (*ValidationError) Error added in v1.0.0 

func (e *ValidationError) Error() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.