config

package
v1.50.6 Latest Latest
Warning

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

 Go to latest Published: Aug 26, 2026 License: Apache-2.0 Imports: 24 Imported by: 0

Documentation

Overview

Package config manages CLI configuration and profiles.

Index

Constants

View Source 
const (
	// PluginConfigGlobalScope is used as the scope when a setting applies to all plugins.
	PluginConfigGlobalScope = "__global"

	// PluginConfigUpdatesField is the config field name controlling automatic updates.
	PluginConfigUpdatesField = "updates"
)
View Source 
const (
	AccountIDName              = "account_id"
	UserIDName                 = "user_id"
	DeviceNameName             = "device_name"
	DisplayNameName            = "display_name"
	IsTermsAcceptanceValidName = "is_terms_acceptance_valid"
	TestModeAPIKeyName         = "test_mode_api_key"
	TestModePubKeyName         = "test_mode_pub_key"
	TestModeKeyExpiresAtName   = "test_mode_key_expires_at"
	LiveModeAPIKeyName         = "live_mode_api_key"
	LiveModePubKeyName         = "live_mode_pub_key"
	LiveModeKeyExpiresAtName   = "live_mode_key_expires_at"
	SandboxClaimURLName        = "sandbox_claim_url"
	SandboxExpiresAtName       = "sandbox_expires_at"
	UserInfoName               = "user_info" // TODO: remove with legacy RAK/OIDC flow
)

config key names

View Source 
const (
	// DateStringFormat is the format for expiredAt date
	DateStringFormat = "2006-01-02"

	// KeyValidInDays is the number of days the API key is valid for
	KeyValidInDays = 90

	// KeyManagementService is the key management service name
	KeyManagementService = "StripeCLI"
)
View Source 
const ColorAuto = "auto"

ColorAuto represents the auto-state for colors

View Source 
const ColorOff = "off"

ColorOff represents the off-state for colors

View Source 
const ColorOn = "on"

ColorOn represnets the on-state for colors

View Source 
const OAuthActiveContextKeychainKey = "oauth_active_context"

OAuthActiveContextKeychainKey is the keyring key for the active OAuth context.

View Source 
const OAuthRefreshTokenKeychainKey = "oauth_refresh_token"

OAuthRefreshTokenKeychainKey is the keyring key for the OAuth refresh token.

View Source 
const OAuthUATExpiresAtKeychainKey = "oauth_uat_expires_at"

OAuthUATExpiresAtKeychainKey is the keyring key for the UAT expiry time (RFC3339).

View Source 
const UATKeychainItemKey = "uat"

Variables

View Source 
var ErrProfileNotFound = errorcategory.New(errorcategory.UserInput, "profile not found")

ErrProfileNotFound is returned when no profile matches the requested name.

View Source 
var KeyRing keyring.SecureStore

KeyRing is the global secure credential store.

View Source 
var OAuthTokenRefresher func(p *Profile) error

OAuthTokenRefresher is called by ResolveCredentials when an OAK token is expired or about to expire. It refreshes the token and updates p in-place. Set by the login package via init().

Functions

func CredentialsFilePath added in v1.43.0 

func CredentialsFilePath() string

CredentialsFilePath returns the path of the plain-text credentials file used by the file fallback store when the OS keyring is unavailable.

func GetUATExpiresAt added in v1.45.3 

func GetUATExpiresAt() (time.Time, error)

GetUATExpiresAt retrieves the stored UAT expiry time from the keyring. Returns ErrKeyNotFound (wrapped) when no expiry has been saved.

func PluginConfigKey added in v1.40.1 

func PluginConfigKey(scope, field string) string

PluginConfigKey returns the key for a plugin config field. Use PluginConfigGlobalScope as scope to target all plugins. Use the plugin name as scope to target a specific plugin. Example: PluginConfigKey("__global", "updates") to read or set the global updates setting Example: PluginConfigKey("apps", "updates") to read or set the updates setting for the "apps" plugin

func RedactAPIKey added in v1.10.4 

func RedactAPIKey(apiKey string) string

RedactAPIKey returns a redacted version of API keys. The first 8 and last 4 characters are not redacted, everything else is replaced by "*" characters.

It panics if the provided string has less than 12 characters.

func SaveActiveContext added in v1.45.3 

func SaveActiveContext(accountID string, livemode bool) error

SaveActiveContext persists the active OAuth context (account ID + livemode) in the keyring so that ResolveCredentials can build the Stripe-Context header.

func SaveUATExpiresAt added in v1.45.3 

func SaveUATExpiresAt(t time.Time) error

SaveUATExpiresAt persists the UAT expiry time in the keyring.

Types

type ActiveContext added in v1.45.3 

type ActiveContext struct {
	AccountID string `json:"account_id"`
	Livemode  bool   `json:"livemode"`
}

ActiveContext identifies the account and mode that is currently selected.

func GetActiveContext added in v1.45.3 

func GetActiveContext() (*ActiveContext, error)

GetActiveContext reads the stored OAuth active context from the keyring. Returns nil, nil when no active context has been saved yet.

type ActiveContextLivemodeMismatchError added in v1.45.3 

type ActiveContextLivemodeMismatchError struct {
	RequestedLivemode bool
	ActiveLivemode    bool
}

ActiveContextLivemodeMismatchError indicates that the requested livemode does not match the OAuth active context's livemode. Callers that expose their own mode selection (e.g. a --live flag) can catch this with errors.As and explain how to reconcile it; callers that don't care which mode is used can retry ResolveCredentials(err.ActiveLivemode) to get credentials for whichever mode is actually active.

func (*ActiveContextLivemodeMismatchError) Error added in v1.45.3 

func (e *ActiveContextLivemodeMismatchError) Error() string

type AuthorizedAccount added in v1.45.3 

type AuthorizedAccount struct {
	ID    string   `json:"id"`
	Name  string   `json:"name"`
	Modes []string `json:"modes"`
}

AuthorizedAccount represents a Stripe account accessible to an OAuth token.

type Compartment added in v1.42.12 

type Compartment struct {
	CompartmentID string `json:"compartment_id" mapstructure:"compartment_id" toml:"compartment_id"`
	Livemode      bool   `json:"livemode"        mapstructure:"livemode"        toml:"livemode"`
}

Compartment represents a Stripe workspace from the OIDC userinfo response. TODO: remove with legacy RAK/OIDC flow.

type Config 

type Config struct {
	Color            string
	LogLevel         string
	Profile          Profile
	ProfilesFile     string
	InstalledPlugins []string
}

Config handles all overall configuration for the CLI

func (*Config) CopyProfile added in v1.38.0 

func (c *Config) CopyProfile(source string, target string) error

func (*Config) EditConfig added in v0.3.0 

func (c *Config) EditConfig() error

EditConfig opens the configuration file in the default editor.

func (*Config) GetConfigFolder added in v0.6.0 

func (c *Config) GetConfigFolder(xdgPath string) string

func (*Config) GetInstalledPlugins added in v1.9.0 

func (c *Config) GetInstalledPlugins() []string

GetInstalledPlugins returns a list of locally installed plugins. This does not vary by profile

func (*Config) GetMachineUUID added in v1.44.1 

func (c *Config) GetMachineUUID() string

GetMachineUUID returns the persistent machine UUID from config, generating and saving one if it doesn't exist.

func (*Config) GetProfile added in v1.8.0 

func (c *Config) GetProfile() *Profile

GetProfile returns the Profile of the config

func (*Config) InitConfig 

func (c *Config) InitConfig()

InitConfig reads in profiles file and ENV variables if set.

func (*Config) ListProfiles added in v1.38.0 

func (c *Config) ListProfiles() error

func (*Config) PrintConfig added in v0.3.0 

func (c *Config) PrintConfig() error

PrintConfig outputs the contents of the configuration file.

func (*Config) RemoveAllAuthFields added in v1.40.1 

func (c *Config) RemoveAllAuthFields() error

RemoveAllAuthFields removes only auth-related fields from all profiles, preserving non-auth settings like color.

func (*Config) RemoveAllProfiles added in v1.4.0 

func (c *Config) RemoveAllProfiles() error

RemoveAllProfiles removes all the profiles from the config file.

func (*Config) RemoveAuthFields added in v1.40.1 

func (c *Config) RemoveAuthFields(profileName string) error

RemoveAuthFields removes only auth-related fields for the named profile, preserving non-auth settings like color.

func (*Config) RemoveProfile added in v1.4.0 

func (c *Config) RemoveProfile(profileName string) error

RemoveProfile removes the profile whose name matches the provided profileName from the config file.

It returns ErrProfileNotFound when there is nothing to remove, so a caller acting on a name a user typed can tell the difference between a removal and a no-op. Callers that treat removal as best effort can ignore it.

func (*Config) SwitchProfile added in v1.38.0 

func (c *Config) SwitchProfile(profileName string) error

func (*Config) WriteConfigField added in v1.8.2 

func (c *Config) WriteConfigField(field string, value interface{}) error

WriteConfigField updates a configuration field and writes the updated configuration to disk.

type IConfig added in v1.8.0 

type IConfig interface {
	GetProfile() *Profile
	GetConfigFolder(xdgPath string) string
	InitConfig()
	EditConfig() error
	PrintConfig() error
	CopyProfile(source string, target string) error
	ListProfiles() error
	SwitchProfile(targetProfileName string) error
	RemoveProfile(profileName string) error
	RemoveAllProfiles() error
	RemoveAuthFields(profileName string) error
	RemoveAllAuthFields() error
	WriteConfigField(field string, value interface{}) error
	GetInstalledPlugins() []string
	GetMachineUUID() string
}

IConfig allows us to add more implementations, such as ones for unit tests

type Profile 

type Profile struct {
	DeviceName             string
	ProfileName            string
	APIKey                 string
	LiveModeAPIKey         string
	LiveModePublishableKey string
	TestModeAPIKey         string
	TestModePublishableKey string
	TerminalPOSDeviceID    string
	DisplayName            string
	AccountID              string
	UserID                 string
	SandboxClaimURL        string
	SandboxExpiresAt       string
	UAT                    string
	UserInfo               *UserInfo // TODO: remove with legacy RAK/OIDC flow

	// OAuthAccessBaseURL is the access-srv base URL to use for token refresh
	// and revocation. Set at startup from the --access-base flag; not persisted.
	OAuthAccessBaseURL string
}

Profile handles all things related to managing the project specific configurations

func (*Profile) CreateProfile 

func (p *Profile) CreateProfile() error

CreateProfile creates a profile when logging in

func (*Profile) DeleteConfigField added in v0.3.0 

func (p *Profile) DeleteConfigField(field string) error

DeleteConfigField deletes a configuration field.

func (*Profile) GetAPIKey added in v0.3.0 

func (p *Profile) GetAPIKey(livemode bool) (string, error)

GetAPIKey will return the existing key for the given profile

func (*Profile) GetAccountID added in v1.7.4 

func (p *Profile) GetAccountID() (string, error)

GetAccountID returns the accountId for the given profile.

func (*Profile) GetColor added in v0.5.2 

func (p *Profile) GetColor() (string, error)

GetColor gets the color setting for the user based on the flag or the persisted color stored in the config file

func (*Profile) GetCompartmentID added in v1.45.0 

func (p *Profile) GetCompartmentID(livemode bool) (string, error)

GetCompartmentID returns the account ID for the given livemode from the legacy OIDC UserInfo stored in the config file. TODO: remove with legacy RAK/OIDC flow.

func (*Profile) GetConfigField 

func (p *Profile) GetConfigField(field string) string

GetConfigField returns the configuration field for the specific profile

func (*Profile) GetDeviceName 

func (p *Profile) GetDeviceName() (string, error)

GetDeviceName returns the configured device name

func (*Profile) GetDisplayName added in v1.5.6 

func (p *Profile) GetDisplayName() string

GetDisplayName returns the account display name of the user

func (*Profile) GetExpiresAt added in v1.10.4 

func (p *Profile) GetExpiresAt(livemode bool) (time.Time, error)

GetExpiresAt returns the API key expirary date

func (*Profile) GetPublishableKey added in v0.6.0 

func (p *Profile) GetPublishableKey(livemode bool) (string, error)

GetPublishableKey returns the publishable key for the user

func (*Profile) GetSessionCredentials added in v1.14.2 

func (p *Profile) GetSessionCredentials() (*SessionCredentials, error)

GetSessionCredentials retrieves the session credentials from the keyring

func (*Profile) GetTerminalPOSDeviceID added in v1.4.0 

func (p *Profile) GetTerminalPOSDeviceID() string

GetTerminalPOSDeviceID returns the device id from the config for Terminal quickstart to use

func (*Profile) GetUAT added in v1.45.0 

func (p *Profile) GetUAT() (string, error)

GetUAT retrieves the user access token from the keyring. Returns an empty string if no UAT is stored.

func (*Profile) GetUserID added in v1.44.0 

func (p *Profile) GetUserID() (string, error)

GetUserID returns the user ID for the given profile.

func (*Profile) GetUserInfo added in v1.42.12 

func (p *Profile) GetUserInfo() (*UserInfo, error)

GetUserInfo reads the stored UserInfo from the profile config. Returns nil, nil when no user_info has been saved yet. TODO: remove with legacy RAK/OIDC flow.

func (*Profile) HasAPIKey added in v1.42.2 

func (p *Profile) HasAPIKey(livemode bool) bool

HasAPIKey reports whether an API key is available for the given mode without reading its value. For live mode this checks the keyring key list only, avoiding OS-level auth prompts (e.g. macOS Keychain) that would be required to access the secret data.

func (*Profile) HasOverrideAPIKey added in v1.42.2 

func (p *Profile) HasOverrideAPIKey() bool

HasOverrideAPIKey reports whether an in-memory API key override is active (via STRIPE_API_KEY env var or --api-key flag).

func (*Profile) PrintActiveContextBanner added in v1.45.3 

func (p *Profile) PrintActiveContextBanner()

PrintActiveContextBanner prints the active context to stderr once per process. Call this at the start of commands that make user-visible Stripe API requests (resource commands, raw HTTP, fixtures, triggers).

func (*Profile) RegisterAlias added in v0.3.0 

func (p *Profile) RegisterAlias(alias, key string)

RegisterAlias registers an alias for a given key.

func (*Profile) ResolveCredentials added in v1.44.1 

func (p *Profile) ResolveCredentials(livemode bool) (stripe.Credentials, error)

ResolveCredentials returns the credentials for the given mode. If an OAK token (prefix "oak_") is stored in the keyring and no explicit override is active, it is preferred over the configured API key. For OAK tokens the active context stored in the keyring sets both Stripe-Context and Stripe-Livemode; the livemode parameter is used only for the legacy OIDC fallback and plain API key path. If the active context's livemode differs from the requested livemode, it returns an *ActiveContextLivemodeMismatchError.

func (*Profile) ResolveCredentialsForAnyMode added in v1.50.1 

func (p *Profile) ResolveCredentialsForAnyMode(livemode bool) (stripe.Credentials, error)

ResolveCredentialsForAnyMode resolves credentials for specified mode, but if that doesn't match the OAuth active context, resolves credentials for whichever mode is actually active instead of failing.

func (*Profile) WarnIfLegacyProfileName added in v1.50.2 

func (p *Profile) WarnIfLegacyProfileName()

WarnIfLegacyProfileName tells the user when the active profile has a period in its name.

Profile fields are addressed as <profile>.<field> keys in viper, which uses "." as its path separator. A profile name containing a period is therefore indistinguishable from a nested table: viper reads ["a.b"] back as a -> b, so the profile becomes invisible to every operation that enumerates top-level tables, even though reads against it keep working. That makes this warning the only signal the user gets that the profile cannot be listed by name.

It only fires for a profile that is actually in the config file, so that a period in a name nobody is using stays silent.

func (*Profile) WriteConfigField added in v0.3.0 

func (p *Profile) WriteConfigField(field, value string) error

WriteConfigField updates a configuration field and writes the updated configuration to disk.

type SessionCredentials added in v1.14.2 

type SessionCredentials struct {
	UAT        string `json:"uat"`
	PrivateKey string `json:"private_key"`
	AccountID  string `json:"account_id"`
}

SessionCredentials are the credentials needed for this session

type UserInfo added in v1.42.12 

type UserInfo struct {
	Compartments []Compartment `json:"https://stripe.com/compartments" mapstructure:"compartments" toml:"compartments"`
}

UserInfo mirrors the OIDC userinfo endpoint response and is persisted as a nested table in the profile config. TODO: remove with legacy RAK/OIDC flow.

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.