plugin

package

Go to main page

Versions in this module

v0

v0.13.0

Apr 30, 2026

v0.12.0

Apr 28, 2026

v0.11.0

Apr 27, 2026

v0.10.1

Apr 24, 2026

v0.10.0

Apr 20, 2026

v0.9.0

Apr 19, 2026

v0.8.0

Apr 16, 2026

Changes in this version

+ const PluginProtocolVersion

+ var ErrStreamingNotSupported = sdkplugin.ErrStreamingNotSupported

+ func KillAll(clients []*Client)

+ func KillAllAuthHandlers(clients []*AuthHandlerClient)

type AuthHandlerClient

+ func (c *AuthHandlerClient) ConfigureAuthHandler(ctx context.Context, handlerName string, cfg ProviderConfig) error

+ func (c *AuthHandlerClient) HostServiceID() uint32

+ func (c *AuthHandlerClient) StopAuthHandler(ctx context.Context, handlerName string) error

type AuthHandlerGRPCClient

+ func (c *AuthHandlerGRPCClient) ConfigureAuthHandler(ctx context.Context, handlerName string, cfg ProviderConfig) error

+ func (c *AuthHandlerGRPCClient) StopAuthHandler(ctx context.Context, handlerName string) error

type AuthHandlerGRPCPlugin

+ HostDeps *HostServiceDeps

type AuthHandlerGRPCServer

+ func (s *AuthHandlerGRPCServer) ConfigureAuthHandler(ctx context.Context, req *proto.ConfigureAuthHandlerRequest) (*proto.ConfigureAuthHandlerResponse, error)

+ func (s *AuthHandlerGRPCServer) StopAuthHandler(ctx context.Context, req *proto.StopAuthHandlerRequest) (*proto.StopAuthHandlerResponse, error)

type Client

+ func (c *Client) ConfigureProvider(ctx context.Context, providerName string, cfg ProviderConfig) error

+ func (c *Client) ExecuteProviderStream(ctx context.Context, providerName string, input map[string]any, ...) error

+ func (c *Client) ExtractDependencies(ctx context.Context, providerName string, inputs map[string]any) ([]string, error)

+ type ClientOption func(*clientOptions)

+ func WithHostDeps(deps *HostServiceDeps) ClientOption

type GRPCClient

+ func (c *GRPCClient) ConfigureProvider(ctx context.Context, providerName string, cfg ProviderConfig) error

+ func (c *GRPCClient) ExecuteProviderStream(ctx context.Context, providerName string, input map[string]any, ...) error

+ func (c *GRPCClient) ExtractDependencies(ctx context.Context, providerName string, inputs map[string]any) ([]string, error)

+ func (c *GRPCClient) HostServiceID() uint32

+ func (c *GRPCClient) StopProvider(ctx context.Context, providerName string) error

type GRPCPlugin

+ HostDeps *HostServiceDeps

type GRPCServer

+ func (s *GRPCServer) ConfigureProvider(ctx context.Context, req *proto.ConfigureProviderRequest) (*proto.ConfigureProviderResponse, error)

+ func (s *GRPCServer) ExecuteProviderStream(req *proto.ExecuteProviderRequest, ...) error

+ func (s *GRPCServer) ExtractDependencies(ctx context.Context, req *proto.ExtractDependenciesRequest) (*proto.ExtractDependenciesResponse, error)

+ func (s *GRPCServer) StopProvider(ctx context.Context, req *proto.StopProviderRequest) (*proto.StopProviderResponse, error)

+ type HostServiceClient struct

+ func NewHostServiceClient(conn *grpc.ClientConn) *HostServiceClient

+ func (c *HostServiceClient) DeleteSecret(ctx context.Context, name string) error

+ func (c *HostServiceClient) GetAuthIdentity(ctx context.Context, handler, scope string) (*proto.Claims, error)

+ func (c *HostServiceClient) GetAuthToken(ctx context.Context, handler, scope string, minValidFor int64, ...) (*proto.GetAuthTokenResponse, error)

+ func (c *HostServiceClient) GetSecret(ctx context.Context, name string) (string, bool, error)

+ func (c *HostServiceClient) ListAuthHandlers(ctx context.Context) (handlers []string, defaultHandler string, err error)

+ func (c *HostServiceClient) ListSecrets(ctx context.Context, pattern string) ([]string, error)

+ func (c *HostServiceClient) SetSecret(ctx context.Context, name, value string) error

+ type HostServiceDeps struct

+ AllowedAuthHandlers []string

+ AllowedSecretPrefix string

+ AuthHandlersFunc func(ctx context.Context) (handlers []string, defaultHandler string, err error)

+ AuthIdentityFunc func(ctx context.Context, handler, scope string) (*proto.Claims, error)

+ AuthTokenFunc func(ctx context.Context, handler, scope string, minValidFor int64, ...) (*proto.GetAuthTokenResponse, error)

+ SecretStore secrets.Store

+ type HostServiceServer struct

+ Deps HostServiceDeps

+ func (h *HostServiceServer) DeleteSecret(ctx context.Context, req *proto.DeleteSecretRequest) (*proto.DeleteSecretResponse, error)

+ func (h *HostServiceServer) GetAuthIdentity(ctx context.Context, req *proto.GetAuthIdentityRequest) (*proto.GetAuthIdentityResponse, error)

+ func (h *HostServiceServer) GetAuthToken(ctx context.Context, req *proto.GetAuthTokenRequest) (*proto.GetAuthTokenResponse, error)

+ func (h *HostServiceServer) GetSecret(ctx context.Context, req *proto.GetSecretRequest) (*proto.GetSecretResponse, error)

+ func (h *HostServiceServer) ListAuthHandlers(ctx context.Context, _ *proto.ListAuthHandlersRequest) (*proto.ListAuthHandlersResponse, error)

+ func (h *HostServiceServer) ListSecrets(ctx context.Context, req *proto.ListSecretsRequest) (*proto.ListSecretsResponse, error)

+ func (h *HostServiceServer) SetSecret(ctx context.Context, req *proto.SetSecretRequest) (*proto.SetSecretResponse, error)

+ type ProviderConfig = sdkplugin.ProviderConfig

type ProviderWrapper

+ func (w *ProviderWrapper) Configure(ctx context.Context, cfg ProviderConfig) error

+ func (w *ProviderWrapper) ExecuteStream(ctx context.Context, input any, cb func(StreamChunk)) error

+ type StreamChunk = sdkplugin.StreamChunk

+ type WrapperOption func(*wrapperConfig)

+ func WithContext(ctx context.Context) WrapperOption

v0.7.1

Apr 6, 2026

v0.7.0

Apr 6, 2026

v0.6.0

Mar 19, 2026

Changes in this version

type Client

+ func (c *Client) DescribeWhatIf(ctx context.Context, providerName string, input map[string]any) (string, error)

type GRPCClient

+ func (c *GRPCClient) DescribeWhatIf(ctx context.Context, providerName string, input map[string]any) (string, error)

type GRPCServer

+ func (s *GRPCServer) DescribeWhatIf(ctx context.Context, req *proto.DescribeWhatIfRequest) (*proto.DescribeWhatIfResponse, error)

type ProviderPlugin

+ DescribeWhatIf func(ctx context.Context, providerName string, input map[string]any) (string, error)

v0.5.0

Feb 25, 2026

Changes in this version

+ const AuthHandlerPluginName

+ var AuthHandlerHandshakeConfig = &HandshakeConfigData

+ func CurrentPlatform() string

+ func ParsePlatform(platform string) (os, arch string, err error)

+ func Paths(results []FetchResult) []string

+ func PlatformCacheKey(platform string) string

+ func RegisterAuthHandlerPlugins(registry *auth.Registry, pluginDirs []string) error

+ func ServeAuthHandler(impl AuthHandlerPlugin)

+ type AuthHandlerClient struct

+ func DiscoverAuthHandlers(pluginDirs []string) ([]*AuthHandlerClient, error)

+ func NewAuthHandlerClient(pluginPath string) (*AuthHandlerClient, error)

+ func RegisterFetchedAuthHandlerPlugins(ctx context.Context, registry *auth.Registry, results []FetchResult) ([]*AuthHandlerClient, error)

+ func (c *AuthHandlerClient) GetAuthHandlers(ctx context.Context) ([]AuthHandlerInfo, error)

+ func (c *AuthHandlerClient) GetStatus(ctx context.Context, handlerName string) (*auth.Status, error)

+ func (c *AuthHandlerClient) GetToken(ctx context.Context, handlerName string, req TokenRequest) (*TokenResponse, error)

+ func (c *AuthHandlerClient) Kill()

+ func (c *AuthHandlerClient) Login(ctx context.Context, handlerName string, req LoginRequest, ...) (*LoginResponse, error)

+ func (c *AuthHandlerClient) Logout(ctx context.Context, handlerName string) error

+ func (c *AuthHandlerClient) Name() string

+ func (c *AuthHandlerClient) Path() string

+ type AuthHandlerGRPCClient struct

+ func (c *AuthHandlerGRPCClient) GetAuthHandlers(ctx context.Context) ([]AuthHandlerInfo, error)

+ func (c *AuthHandlerGRPCClient) GetStatus(ctx context.Context, handlerName string) (*auth.Status, error)

+ func (c *AuthHandlerGRPCClient) GetToken(ctx context.Context, handlerName string, req TokenRequest) (*TokenResponse, error)

+ func (c *AuthHandlerGRPCClient) ListCachedTokens(ctx context.Context, handlerName string) ([]*auth.CachedTokenInfo, error)

+ func (c *AuthHandlerGRPCClient) Login(ctx context.Context, handlerName string, req LoginRequest, ...) (*LoginResponse, error)

+ func (c *AuthHandlerGRPCClient) Logout(ctx context.Context, handlerName string) error

+ func (c *AuthHandlerGRPCClient) PurgeExpiredTokens(ctx context.Context, handlerName string) (int, error)

+ type AuthHandlerGRPCPlugin struct

+ Impl AuthHandlerPlugin

+ func (p *AuthHandlerGRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (any, error)

+ func (p *AuthHandlerGRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

+ type AuthHandlerGRPCServer struct

+ Impl AuthHandlerPlugin

+ func (s *AuthHandlerGRPCServer) GetAuthHandlers(ctx context.Context, _ *proto.GetAuthHandlersRequest) (*proto.GetAuthHandlersResponse, error)

+ func (s *AuthHandlerGRPCServer) GetStatus(ctx context.Context, req *proto.GetStatusRequest) (*proto.GetStatusResponse, error)

+ func (s *AuthHandlerGRPCServer) GetToken(ctx context.Context, req *proto.GetTokenRequest) (*proto.GetTokenResponse, error)

+ func (s *AuthHandlerGRPCServer) ListCachedTokens(ctx context.Context, req *proto.ListCachedTokensRequest) (*proto.ListCachedTokensResponse, error)

+ func (s *AuthHandlerGRPCServer) Login(req *proto.LoginRequest, ...) error

+ func (s *AuthHandlerGRPCServer) Logout(ctx context.Context, req *proto.LogoutRequest) (*proto.LogoutResponse, error)

+ func (s *AuthHandlerGRPCServer) PurgeExpiredTokens(ctx context.Context, req *proto.PurgeExpiredTokensRequest) (*proto.PurgeExpiredTokensResponse, error)

+ type AuthHandlerInfo struct

+ Capabilities []auth.Capability

+ DisplayName string

+ Flows []auth.Flow

+ Name string

+ type AuthHandlerPlugin interface

+ GetAuthHandlers func(ctx context.Context) ([]AuthHandlerInfo, error)

+ GetStatus func(ctx context.Context, handlerName string) (*auth.Status, error)

+ GetToken func(ctx context.Context, handlerName string, req TokenRequest) (*TokenResponse, error)

+ ListCachedTokens func(ctx context.Context, handlerName string) ([]*auth.CachedTokenInfo, error)

+ Login func(ctx context.Context, handlerName string, req LoginRequest, ...) (*LoginResponse, error)

+ Logout func(ctx context.Context, handlerName string) error

+ PurgeExpiredTokens func(ctx context.Context, handlerName string) (int, error)

+ type AuthHandlerWrapper struct

+ func NewAuthHandlerWrapper(client *AuthHandlerClient, info AuthHandlerInfo) *AuthHandlerWrapper

+ func (w *AuthHandlerWrapper) Capabilities() []auth.Capability

+ func (w *AuthHandlerWrapper) Client() *AuthHandlerClient

+ func (w *AuthHandlerWrapper) DisplayName() string

+ func (w *AuthHandlerWrapper) GetToken(ctx context.Context, opts auth.TokenOptions) (*auth.Token, error)

+ func (w *AuthHandlerWrapper) InjectAuth(ctx context.Context, req *http.Request, opts auth.TokenOptions) error

+ func (w *AuthHandlerWrapper) ListCachedTokens(ctx context.Context) ([]*auth.CachedTokenInfo, error)

+ func (w *AuthHandlerWrapper) Login(ctx context.Context, opts auth.LoginOptions) (*auth.Result, error)

+ func (w *AuthHandlerWrapper) Logout(ctx context.Context) error

+ func (w *AuthHandlerWrapper) Name() string

+ func (w *AuthHandlerWrapper) PurgeExpiredTokens(ctx context.Context) (int, error)

+ func (w *AuthHandlerWrapper) Status(ctx context.Context) (*auth.Status, error)

+ func (w *AuthHandlerWrapper) SupportedFlows() []auth.Flow

+ type Cache struct

+ func NewCache(cacheDir string) *Cache

+ func (c *Cache) Digest(name, version, platform string) (string, error)

+ func (c *Cache) Dir() string

+ func (c *Cache) Get(name, version, platform, expectedDigest string) (string, bool)

+ func (c *Cache) List() ([]CachedPlugin, error)

+ func (c *Cache) Put(name, version, platform string, data []byte) (string, error)

+ func (c *Cache) Remove(name, version, platform string) error

+ type CachedPlugin struct

+ Name string

+ Path string

+ Platform string

+ Size int64

+ Version string

type Client

+ func RegisterFetchedPlugins(ctx context.Context, registry *provider.Registry, results []FetchResult) ([]*Client, error)

+ type DeviceCodePrompt struct

+ Message string

+ UserCode string

+ VerificationURI string

+ type FetchResult struct

+ Catalog string

+ Digest string

+ FromCache bool

+ Kind solution.PluginKind

+ Name string

+ Path string

+ Version string

+ type Fetcher struct

+ func NewFetcher(cfg FetcherConfig) *Fetcher

+ func (f *Fetcher) FetchPlugins(ctx context.Context, plugins []solution.PluginDependency, ...) ([]FetchResult, error)

+ type FetcherConfig struct

+ Cache *Cache

+ Catalog catalog.Catalog

+ Logger logr.Logger

+ Platform string

+ type LoginRequest struct

+ Flow auth.Flow

+ Scopes []string

+ TenantID string

+ Timeout time.Duration

+ type LoginResponse struct

+ Claims *auth.Claims

+ ExpiresAt time.Time

+ type LoginStreamMessage struct

+ DeviceCodePrompt *DeviceCodePrompt

+ Error string

+ Result *LoginResponse

+ type TokenRequest struct

+ ForceRefresh bool

+ MinValidFor time.Duration

+ Scope string

+ type TokenResponse struct

+ AccessToken string

+ CachedAt time.Time

+ ExpiresAt time.Time

+ Flow auth.Flow

+ Scope string

+ SessionID string

+ TokenType string

v0.4.0

Feb 17, 2026

v0.3.0

Feb 16, 2026

v0.2.0

Feb 12, 2026

v0.1.0

Feb 10, 2026

Changes in this version

+ const PluginName

+ var HandshakeConfig = &HandshakeConfigData

+ func RegisterPluginProviders(registry *provider.Registry, pluginDirs []string) error

+ func Serve(impl ProviderPlugin)

+ type Client struct

+ func Discover(pluginDirs []string) ([]*Client, error)

+ func NewClient(pluginPath string) (*Client, error)

+ func (c *Client) ExecuteProvider(ctx context.Context, providerName string, input map[string]any) (*provider.Output, error)

+ func (c *Client) GetProviderDescriptor(ctx context.Context, providerName string) (*provider.Descriptor, error)

+ func (c *Client) GetProviders(ctx context.Context) ([]string, error)

+ func (c *Client) Kill()

+ func (c *Client) Name() string

+ func (c *Client) Path() string

+ type GRPCClient struct

+ func (c *GRPCClient) ExecuteProvider(ctx context.Context, providerName string, input map[string]any) (*provider.Output, error)

+ func (c *GRPCClient) GetProviderDescriptor(ctx context.Context, providerName string) (*provider.Descriptor, error)

+ func (c *GRPCClient) GetProviders(ctx context.Context) ([]string, error)

+ type GRPCPlugin struct

+ Impl ProviderPlugin

+ func (p *GRPCPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (any, error)

+ func (p *GRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

+ type GRPCServer struct

+ Impl ProviderPlugin

+ func (s *GRPCServer) ExecuteProvider(ctx context.Context, req *proto.ExecuteProviderRequest) (*proto.ExecuteProviderResponse, error)

+ func (s *GRPCServer) GetProviderDescriptor(ctx context.Context, req *proto.GetProviderDescriptorRequest) (*proto.GetProviderDescriptorResponse, error)

+ func (s *GRPCServer) GetProviders(ctx context.Context, _ *proto.GetProvidersRequest) (*proto.GetProvidersResponse, error)

+ type HandshakeConfigData struct

+ MagicCookieKey string

+ MagicCookieValue string

+ ProtocolVersion uint

+ type ProviderPlugin interface

+ ExecuteProvider func(ctx context.Context, providerName string, input map[string]any) (*provider.Output, error)

+ GetProviderDescriptor func(ctx context.Context, providerName string) (*provider.Descriptor, error)

+ GetProviders func(ctx context.Context) ([]string, error)

+ type ProviderWrapper struct

+ func NewProviderWrapper(client *Client, providerName string) (*ProviderWrapper, error)

+ func (w *ProviderWrapper) Client() *Client

+ func (w *ProviderWrapper) Descriptor() *provider.Descriptor

+ func (w *ProviderWrapper) Execute(ctx context.Context, input any) (*provider.Output, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL