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
- API
  
  Reference documentation for the pkg.go.dev API
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

workloadapi

package

Go to main page

Versions in this module

v2

v2.2.2

Jul 29, 2024

v2.2.1

Jul 29, 2024

v2.2.0

Feb 28, 2023

Changes in this version

+ const SocketEnv

+ var ErrInvalidEndpointScheme = errors.New("workload endpoint socket URI must have a \"tcp\" or \"npipe\" scheme") — windows/amd64

+ var ErrInvalidEndpointScheme = errors.New("workload endpoint socket URI must have a \"tcp\" or \"unix\" scheme") — darwin/amd64, js/wasm, linux/amd64

+ func FetchJWTBundles(ctx context.Context, meta map[string]string, options ...ClientOption) (*jwtbundle.Set, error)

+ func FetchJWTSVID(ctx context.Context, params jwtsvid.Params, meta map[string]string, ...) (*jwtsvid.SVID, error)

+ func FetchJWTSVIDs(ctx context.Context, params jwtsvid.Params, meta map[string]string, ...) ([]*jwtsvid.SVID, error)

+ func FetchX509Bundles(ctx context.Context, meta map[string]string, options ...ClientOption) (*x509bundle.Set, error)

+ func FetchX509SVID(ctx context.Context, meta map[string]string, options ...ClientOption) (*x509svid.SVID, error)

+ func FetchX509SVIDs(ctx context.Context, meta map[string]string, options ...ClientOption) ([]*x509svid.SVID, error)

+ func GetDefaultAddress() (string, bool)

+ func ValidateAddress(addr string) error

+ func ValidateJWTSVID(ctx context.Context, token, audience string, meta map[string]string, ...) (*jwtsvid.SVID, error)

+ func WatchJWTBundles(ctx context.Context, watcher JWTBundleWatcher, meta map[string]string, ...) error

+ func WatchX509Bundles(ctx context.Context, watcher X509BundleWatcher, meta map[string]string, ...) error

+ func WatchX509Context(ctx context.Context, watcher X509ContextWatcher, meta map[string]string, ...) error

+ type BundleSource struct

+ func NewBundleSource(ctx context.Context, options ...BundleSourceOption) (_ *BundleSource, err error)

+ func (s *BundleSource) Close() error

+ func (s *BundleSource) GetBundleForTrustDomain(trustDomain spiffeid.TrustDomain) (*spiffebundle.Bundle, error)

+ func (s *BundleSource) GetJWTBundleForTrustDomain(trustDomain spiffeid.TrustDomain) (*jwtbundle.Bundle, error)

+ func (s *BundleSource) GetX509BundleForTrustDomain(trustDomain spiffeid.TrustDomain) (*x509bundle.Bundle, error)

+ func (s *BundleSource) Updated() <-chan struct{}

+ func (s *BundleSource) WaitUntilUpdated(ctx context.Context) error

+ type BundleSourceOption interface

+ type Client struct

+ func New(ctx context.Context, meta map[string]string, options ...ClientOption) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) FetchJWTBundles(ctx context.Context) (*jwtbundle.Set, error)

+ func (c *Client) FetchJWTSVID(ctx context.Context, params jwtsvid.Params) (*jwtsvid.SVID, error)

+ func (c *Client) FetchJWTSVIDs(ctx context.Context, params jwtsvid.Params) ([]*jwtsvid.SVID, error)

+ func (c *Client) FetchX509Bundles(ctx context.Context, meta map[string]string) (*x509bundle.Set, error)

+ func (c *Client) FetchX509Context(ctx context.Context) (*X509Context, error)

+ func (c *Client) FetchX509SVID(ctx context.Context, meta map[string]string) (*x509svid.SVID, error)

+ func (c *Client) FetchX509SVIDs(ctx context.Context, meta map[string]string) ([]*x509svid.SVID, error)

+ func (c *Client) ValidateJWTSVID(ctx context.Context, token, audience string) (*jwtsvid.SVID, error)

+ func (c *Client) WatchJWTBundles(ctx context.Context, watcher JWTBundleWatcher) error

+ func (c *Client) WatchX509Bundles(ctx context.Context, watcher X509BundleWatcher) error

+ func (c *Client) WatchX509Context(ctx context.Context, watcher X509ContextWatcher) error

+ type ClientOption interface

+ func WithAddr(addr string) ClientOption

+ func WithDialOptions(options ...grpc.DialOption) ClientOption

+ func WithLogger(logger logger.Logger) ClientOption

+ func WithNamedPipeName(pipeName string) ClientOption

+ type JWTBundleWatcher interface

+ OnJWTBundlesUpdate func(*jwtbundle.Set)

+ OnJWTBundlesWatchError func(error)

+ type JWTSource struct

+ func NewJWTSource(ctx context.Context, options ...JWTSourceOption) (_ *JWTSource, err error)

+ func (s *JWTSource) Close() error

+ func (s *JWTSource) FetchJWTSVID(ctx context.Context, params jwtsvid.Params) (*jwtsvid.SVID, error)

+ func (s *JWTSource) FetchJWTSVIDs(ctx context.Context, params jwtsvid.Params) ([]*jwtsvid.SVID, error)

+ func (s *JWTSource) GetJWTBundleForTrustDomain(trustDomain spiffeid.TrustDomain) (*jwtbundle.Bundle, error)

+ func (s *JWTSource) Updated() <-chan struct{}

+ func (s *JWTSource) WaitUntilUpdated(ctx context.Context) error

+ type JWTSourceOption interface

+ type SourceOption interface

+ func WithClient(client *Client) SourceOption

+ func WithClientOptions(options ...ClientOption) SourceOption

+ type X509BundleWatcher interface

+ OnX509BundlesUpdate func(*x509bundle.Set)

+ OnX509BundlesWatchError func(error)

+ type X509Context struct

+ Bundles *x509bundle.Set

+ SVIDs []*x509svid.SVID

+ func FetchX509Context(ctx context.Context, meta map[string]string, options ...ClientOption) (*X509Context, error)

+ func (x *X509Context) DefaultSVID() *x509svid.SVID

+ type X509ContextWatcher interface

+ OnX509ContextUpdate func(*X509Context)

+ OnX509ContextWatchError func(error)

+ type X509Source struct

+ func NewX509Source(ctx context.Context, meta map[string]string, options ...X509SourceOption) (_ *X509Source, err error)

+ func (s *X509Source) Close() (err error)

+ func (s *X509Source) GetX509BundleForTrustDomain(trustDomain spiffeid.TrustDomain) (*x509bundle.Bundle, error)

+ func (s *X509Source) GetX509SVID() (*x509svid.SVID, error)

+ func (s *X509Source) Updated() <-chan struct{}

+ func (s *X509Source) WaitUntilUpdated(ctx context.Context) error

+ type X509SourceOption interface

+ func WithDefaultX509SVIDPicker(picker func([]*x509svid.SVID) *x509svid.SVID) X509SourceOption