providers

Documentation

Overview

Package providers defines the APIs for providers to detect their relevance and register themselves to furnish OIDC tokens within a given environment.

Index

• func Enabled(ctx context.Context) bool
• func Provide(ctx context.Context, audience string) (string, error)
• func Register(name string, p Interface)
• type Interface

Functions

func Enabled

func Enabled(ctx context.Context) bool

Enabled checks whether any of the registered providers are enabled in this execution context.

func Provide

func Provide(ctx context.Context, audience string) (string, error)

Provide fetches an OIDC token from one of the active providers.

func Register

func Register(name string, p Interface)

Register is used by providers to participate in furnishing OIDC tokens.

Types

type Interface

type Interface interface {
	// Enabled returns true if the provider is enabled.
	Enabled(ctx context.Context) bool

	// Provide returns an OIDC token scoped to the provided audience.
	Provide(ctx context.Context, audience string) (string, error)
}

Interface is what providers need to implement to participate in furnishing OIDC tokens.