Documentation
¶
Index ¶
- func TokenSource(src oidc.TokenSource, issuer, audience string, opts ...TokenSourceOpt) oidc.TokenSource
- type CredentialCache
- type EncryptedFileCredentialCache
- func (e *EncryptedFileCredentialCache) Available() bool
- func (e *EncryptedFileCredentialCache) Get(issuer string, clientID string, scopes []string, acrValues []string) (*oidc.Token, error)
- func (e *EncryptedFileCredentialCache) Set(issuer string, clientID string, scopes []string, acrValues []string, ...) error
- type KeychainCredentialCache
- type MemoryWriteThroughCredentialCache
- func (c *MemoryWriteThroughCredentialCache) Available() bool
- func (c *MemoryWriteThroughCredentialCache) Get(issuer string, clientID string, scopes []string, acrValues []string) (*oidc.Token, error)
- func (c *MemoryWriteThroughCredentialCache) Set(issuer string, clientID string, scopes []string, acrValues []string, ...) error
- type NullCredentialCache
- type PassphrasePromptFunc
- type TokenSourceOpt
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func TokenSource ¶
func TokenSource(src oidc.TokenSource, issuer, audience string, opts ...TokenSourceOpt) oidc.TokenSource
TokenSource wraps an oidc.TokenSource, caching the token results locally so they survive cross-process execution. The result of BestCredentialCache is used for the cache, this can be overridden with the WithCache option. Items are stored in the cache keyed by their issuer and audience, WithScopes and WithACRValues can be used to further refine the keying where differentiation is required on these values.
Types ¶
type CredentialCache ¶
type CredentialCache interface {
// Get returns a token from cache for the given issuer, clientID, scopes
// and ACR values. Cache misses are _not_ considered an error, so a
// cache miss will be returned as `(nil, nil)`
Get(issuer string, clientID string, scopes []string, acrValues []string) (*oidc.Token, error)
// Set sets a token in the cache for the given issuer, clientID, scopes
// and ACR values.
Set(issuer string, clientID string, scopes []string, acrValues []string, token *oidc.Token) error
// Available returns true if the credential cache is supported on this
// platform or environment.
Available() bool
}
CredentialCache is capable of caching and retrieving OpenID Connect tokens. At this time, CredentialCache implementations are not required to be goroutine safe. Code that uses a CredentialCache should synchronize access to the caches if goroutine safety is needed.
func BestCredentialCache ¶
func BestCredentialCache() CredentialCache
BestCredentialCache returns the most preferred available credential client for the platform and environment.
type EncryptedFileCredentialCache ¶
type EncryptedFileCredentialCache struct {
// Dir is the path where encrypted cache files will be stored.
// If empty, defaults to ~/.oidc-cache/
Dir string
// PassphrasePromptFunc is a function that prompts the user to enter a
// passphrase used to encrypt and decrypt a file.
PassphrasePromptFunc
}
func (*EncryptedFileCredentialCache) Available ¶
func (e *EncryptedFileCredentialCache) Available() bool
type KeychainCredentialCache ¶
type KeychainCredentialCache struct{}
func (*KeychainCredentialCache) Available ¶
func (k *KeychainCredentialCache) Available() bool
type MemoryWriteThroughCredentialCache ¶
type MemoryWriteThroughCredentialCache struct {
CredentialCache
// contains filtered or unexported fields
}
MemoryWriteThroughCredentialCache is a write-through cache for another underlying CredentialCache. If a credential has been previously requested from the underlying store, it is read from memory the next time it is requested.
MemoryWriteThroughCredentialCache is useful when the underlying store requires user input (e.g., a passphrase) or is otherwise expensive.
func (*MemoryWriteThroughCredentialCache) Available ¶
func (c *MemoryWriteThroughCredentialCache) Available() bool
type NullCredentialCache ¶
type NullCredentialCache struct{}
NullCredentialCache will not cache tokens. Used it to opt out of caching.
func (*NullCredentialCache) Available ¶
func (c *NullCredentialCache) Available() bool
type PassphrasePromptFunc ¶
type TokenSourceOpt ¶
type TokenSourceOpt func(*cachingTokenSource)
func WithACRValues ¶
func WithACRValues(acrValues []string) TokenSourceOpt
WithACRValues keys the cache with the ACR values. Used where tokens of different ACR values are tracked.
func WithRefreshClient ¶
func WithRefreshClient(client *oidc.Client) TokenSourceOpt
WithRefreshClient will add a configured client to the source. This will be used to fetch a new token if the cached token is expired and has a RefreshToken
func WithScopes ¶
func WithScopes(scopes []string) TokenSourceOpt
WithScopes keys the cache with the additional scopes. Used where tokens need to be differed for different scopes.
Source Files