mtls

Documentation

Overview

Package mtls is an authentication plugin that uses mTLS.

Index

• type Config
  • func (c *Config) AsMapStructure() map[string]any
  • func (c *Config) BindFlags(prefix string, fs *pflag.FlagSet)
  • func (c *Config) DefaultOptions() *Config
  • func (c *Config) SetMapStructure(in map[string]any)
• type Plugin
  • func (p *Plugin) Authenticate(ctx context.Context, req *v1.AuthenticationRequest) (*v1.AuthenticationResponse, error)
  • func (p *Plugin) Close(ctx context.Context, req *emptypb.Empty) (*emptypb.Empty, error)
  • func (p *Plugin) Configure(ctx context.Context, req *v1.PluginConfiguration) (*emptypb.Empty, error)
  • func (p *Plugin) GetInfo(context.Context, *emptypb.Empty) (*v1.PluginInfo, error)

Types

type Config

type Config struct {
	// CAFile is the path to a CA file to use to verify client certificates.
	// If not provided, the system pool and any intermediate chains provided
	// in the authentication request will be used.
	CAFile string `koanf:"ca-file" mapstructure:"ca-file"`
	// CAData is the base64 encoded PEM CA data to use to verify client certificates.
	// If not provided, the system pool and any intermediate chains provided
	// in the authentication request will be used.
	CAData string `koanf:"ca-data" mapstructure:"ca-data"`
}

Config is the configuration for the mTLS plugin.

func (*Config) AsMapStructure

func (c *Config) AsMapStructure() map[string]any

func (*Config) BindFlags

func (c *Config) BindFlags(prefix string, fs *pflag.FlagSet)

BindFlags binds the plugin flags to the given flag set.

func (*Config) DefaultOptions

func (c *Config) DefaultOptions() *Config

DefaultOptions returns the default options for the plugin.

func (*Config) SetMapStructure

func (c *Config) SetMapStructure(in map[string]any)

type Plugin

type Plugin struct {
	v1.UnimplementedPluginServer
	v1.UnimplementedAuthPluginServer
	// contains filtered or unexported fields
}

Plugin is the mTLS plugin.

func (*Plugin) Authenticate

func (p *Plugin) Authenticate(ctx context.Context, req *v1.AuthenticationRequest) (*v1.AuthenticationResponse, error)

func (*Plugin) Close

func (p *Plugin) Close(ctx context.Context, req *emptypb.Empty) (*emptypb.Empty, error)

func (*Plugin) Configure

func (p *Plugin) Configure(ctx context.Context, req *v1.PluginConfiguration) (*emptypb.Empty, error)

func (*Plugin) GetInfo

func (p *Plugin) GetInfo(context.Context, *emptypb.Empty) (*v1.PluginInfo, error)