Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

credentialexchange

package

Go to main page

Versions in this module

v0

v0.15.7

Sep 22, 2025

v0.15.6

Sep 22, 2025

v0.15.5

Sep 22, 2025

v0.15.4

Sep 22, 2025

v0.15.3

Sep 22, 2025

v0.15.2

Mar 31, 2025

v0.15.1

Mar 31, 2025

Changes in this version

+ const AWS_ROLE_ARN

+ const INI_CONF_SECTION

+ const SELF_NAME

+ const WEB_ID_TOKEN_VAR

+ var ErrCannotLockDir = errors.New("unable to create lock dir")

+ var ErrConfigFailure = errors.New("config error")

+ var ErrFailedToClearSecretStorage = errors.New("failed to clear secret storage on OS")

+ var ErrMissingEnvVar = errors.New("missing env var")

+ var ErrSectionNotFound = errors.New("section not found")

+ var ErrTokenExpired = errors.New("token expired")

+ var ErrUnableAssume = errors.New("unable to assume")

+ var ErrUnableSessionCreate = errors.New("unable to create a sesion")

+ var ErrUnableToAcquireLock = errors.New("cannot acquire lock")

+ var ErrUnableToLoadAWSCred = errors.New("unable to laod AWS credential")

+ var ErrUnableToLoadDueToLock = errors.New("cannot load secret due to lock error")

+ var ErrUnableToRetrieveSections = errors.New("unable to retrieve sections")

+ var ErrUnmarshalCred = errors.New("unable to unmarshal credential from string")

+ var ErrUnmarshallingSecret = errors.New("cannot unmarshal secret")

+ func ConfigIniFile(basePath string) string

+ func GetWebIdTokenFileContents() (string, error)

+ func HomeDir() string

+ func IsValid(ctx context.Context, currentCreds *AWSCredentials, reloadBeforeTime int, ...) (bool, error)

+ func KeyRoleConverter(key string) string

+ func MergeRoleChain(role string, roleChain []string, insertRoleIntoChain bool) []string

+ func ReloadBeforeExpiry(expiry time.Time, reloadBeforeSeconds int) bool

+ func RoleKeyConverter(role string) string

+ func SessionName(username, selfName string) string

+ func SetCredentials(creds *AWSCredentials, config CredentialConfig) error

+ func WriteIniSection(role string) error

+ type AWSCredentials struct

+ AWSAccessKey string

+ AWSSecretKey string

+ AWSSessionToken string

+ Expires time.Time

+ PrincipalARN string

+ Version int

+ func AssumeRoleInChain(ctx context.Context, baseCreds *AWSCredentials, svc AuthSamlApi, ...) (*AWSCredentials, error)

+ func LoginAwsWebToken(ctx context.Context, username string, svc authWebTokenApi) (*AWSCredentials, error)

+ func LoginStsSaml(ctx context.Context, samlResponse string, role AWSRole, svc AuthSamlApi) (*AWSCredentials, error)

+ func (a *AWSCredentials) FromRoleCredString(cred string) (*AWSCredentials, error)

+ type AWSRole struct

+ Duration int

+ Name string

+ PrincipalARN string

+ RoleARN string

+ type AWSRoleConfig struct

+ Name string

+ PrincipalARN string

+ RoleARN string

+ type AuthSamlApi interface

+ AssumeRole func(ctx context.Context, params *sts.AssumeRoleInput, optFns ...func(*sts.Options)) (*sts.AssumeRoleOutput, error)

+ AssumeRoleWithSAML func(ctx context.Context, params *sts.AssumeRoleWithSAMLInput, ...) (*sts.AssumeRoleWithSAMLOutput, error)

+ GetCallerIdentity func(ctx context.Context, params *sts.GetCallerIdentityInput, ...) (*sts.GetCallerIdentityOutput, error)

+ type BaseConfig struct

+ CfgSectionName string

+ DoKillHangingProcess bool

+ ReloadBeforeTime int

+ Role string

+ RoleChain []string

+ StoreInProfile bool

+ Username string

+ type CredentialConfig struct

+ AcsUrl string

+ BaseConfig BaseConfig

+ Duration int

+ IsSso bool

+ PrincipalArn string

+ ProviderUrl string

+ SsoCredFedEndpoint string

+ SsoRegion string

+ SsoRole string

+ SsoUserEndpoint string

+ type SecretStore struct

+ AWSCredJson string

+ AWSCredentials *AWSCredentials

+ func NewSecretStore(roleArn, namer, baseDir, username string) (*SecretStore, error)

+ func (s *SecretStore) AWSCredential() (*AWSCredentials, error)

+ func (s *SecretStore) Clear() error

+ func (s *SecretStore) ClearAll() error

+ func (s *SecretStore) SaveAWSCredential(cred *AWSCredentials) error

+ func (s *SecretStore) WithKeyring(keyring keyring.Keyring) *SecretStore

+ func (s *SecretStore) WithLocker(locker lockgate.Locker) *SecretStore