auth

Documentation

Index

• Constants
• func ConfigureBasicAuthPlugin(config interface{}, _ string) (core.PluginInstance, error)
• func ConfigureGithubWebhook(config interface{}, _ string) (core.PluginInstance, error)
• func ConfigureGitlabWebhook(config interface{}, _ string) (core.PluginInstance, error)
• func ConfigureKeyAuthPlugin(config interface{}, _ string) (core.PluginInstance, error)
• func ConfigureSlackWebhook(config interface{}, _ string) (core.PluginInstance, error)
• type BasicAuthConfig
• type BasicAuthPlugin
  • func (ba *BasicAuthPlugin) Config() interface{}
  • func (ba *BasicAuthPlugin) ExecutePlugin(c *core.ConsumerFile, w http.ResponseWriter, r *http.Request) bool
  • func (ba *BasicAuthPlugin) Type() string
• type GithubWebhookPlugin
  • func (p *GithubWebhookPlugin) Config() interface{}
  • func (p *GithubWebhookPlugin) ExecutePlugin(c *core.ConsumerFile, _ http.ResponseWriter, r *http.Request) bool
  • func (*GithubWebhookPlugin) Type() string
• type GithubWebhookPluginConfig
• type GitlabWebhookPlugin
  • func (p *GitlabWebhookPlugin) Config() interface{}
  • func (p *GitlabWebhookPlugin) ExecutePlugin(c *core.ConsumerFile, _ http.ResponseWriter, r *http.Request) bool
  • func (*GitlabWebhookPlugin) Type() string
• type GitlabWebhookPluginConfig
• type KeyAuthConfig
• type KeyAuthPlugin
  • func (ka *KeyAuthPlugin) Config() interface{}
  • func (ka *KeyAuthPlugin) ExecutePlugin(c *core.ConsumerFile, w http.ResponseWriter, r *http.Request) bool
  • func (ka *KeyAuthPlugin) Type() string
• type SlackWebhookPlugin
  • func (p *SlackWebhookPlugin) Config() interface{}
  • func (p *SlackWebhookPlugin) ExecutePlugin(c *core.ConsumerFile, _ http.ResponseWriter, r *http.Request) bool
  • func (*SlackWebhookPlugin) Type() string
• type SlackWebhookPluginConfig

Constants

const (
	GitlabWebhookPluginName = "gitlab-webhook-auth"
	GitlabHeaderName        = "X-Gitlab-Token"
)

const (
	KeyAuthPluginName = "key-auth"
	KeyName           = "API-Token"
)

const (
	BasicAuthPluginName = "basic-auth"
)

const (
	GithubWebhookPluginName = "github-webhook-auth"
)

const (
	SlackWebhookPluginName = "slack-webhook-auth"
)

Functions

func ConfigureBasicAuthPlugin

func ConfigureBasicAuthPlugin(config interface{}, _ string) (core.PluginInstance, error)

func ConfigureGithubWebhook

func ConfigureGithubWebhook(config interface{}, _ string) (core.PluginInstance, error)

func ConfigureGitlabWebhook

func ConfigureGitlabWebhook(config interface{}, _ string) (core.PluginInstance, error)

func ConfigureKeyAuthPlugin

func ConfigureKeyAuthPlugin(config interface{}, _ string) (core.PluginInstance, error)

func ConfigureSlackWebhook

func ConfigureSlackWebhook(config interface{}, _ string) (core.PluginInstance, error)

Types

type BasicAuthConfig

type BasicAuthConfig struct {
	AddUsernameHeader bool `mapstructure:"add_username_header" yaml:"add_username_header"`
	AddTagsHeader     bool `mapstructure:"add_tags_header"     yaml:"add_tags_header"`
	AddGroupsHeader   bool `mapstructure:"add_groups_header"   yaml:"add_groups_header"`
}

BasicAuthConfig configures a basic-auth plugin instance. The plugin can be configured to set consumer information (name, groups, tags).

type BasicAuthPlugin

type BasicAuthPlugin struct {
	// contains filtered or unexported fields
}

func (*BasicAuthPlugin) Config

func (ba *BasicAuthPlugin) Config() interface{}

func (*BasicAuthPlugin) ExecutePlugin

func (ba *BasicAuthPlugin) ExecutePlugin(c *core.ConsumerFile,
	w http.ResponseWriter, r *http.Request,
) bool

func (*BasicAuthPlugin) Type

func (ba *BasicAuthPlugin) Type() string

type GithubWebhookPlugin

type GithubWebhookPlugin struct {
	// contains filtered or unexported fields
}

func (*GithubWebhookPlugin) Config

func (p *GithubWebhookPlugin) Config() interface{}

func (*GithubWebhookPlugin) ExecutePlugin

func (p *GithubWebhookPlugin) ExecutePlugin(c *core.ConsumerFile, _ http.ResponseWriter, r *http.Request) bool

func (*GithubWebhookPlugin) Type

func (*GithubWebhookPlugin) Type() string

type GithubWebhookPluginConfig

type GithubWebhookPluginConfig struct {
	Secret string `mapstructure:"secret" yaml:"secret"`
}

type GitlabWebhookPlugin

type GitlabWebhookPlugin struct {
	// contains filtered or unexported fields
}

func (*GitlabWebhookPlugin) Config

func (p *GitlabWebhookPlugin) Config() interface{}

func (*GitlabWebhookPlugin) ExecutePlugin

func (p *GitlabWebhookPlugin) ExecutePlugin(c *core.ConsumerFile, _ http.ResponseWriter, r *http.Request) bool

func (*GitlabWebhookPlugin) Type

func (*GitlabWebhookPlugin) Type() string

type GitlabWebhookPluginConfig

type GitlabWebhookPluginConfig struct {
	Secret string `mapstructure:"secret" yaml:"secret"`
}

type KeyAuthConfig

type KeyAuthConfig struct {
	AddUsernameHeader bool `mapstructure:"add_username_header" yaml:"add_username_header"`
	AddTagsHeader     bool `mapstructure:"add_tags_header"     yaml:"add_tags_header"`
	AddGroupsHeader   bool `mapstructure:"add_groups_header"   yaml:"add_groups_header"`

	// KeyName defines the header for the key
	KeyName string `mapstructure:"key_name" yaml:"key_name"`
}

KeyAuthConfig configures a key-auth plugin instance. The plugin can be configured to set consumer information (name, groups, tags) and the name of the header for the api key.

type KeyAuthPlugin

type KeyAuthPlugin struct {
	// contains filtered or unexported fields
}

func (*KeyAuthPlugin) Config

func (ka *KeyAuthPlugin) Config() interface{}

func (*KeyAuthPlugin) ExecutePlugin

func (ka *KeyAuthPlugin) ExecutePlugin(c *core.ConsumerFile,
	w http.ResponseWriter, r *http.Request,
) bool

func (*KeyAuthPlugin) Type

func (ka *KeyAuthPlugin) Type() string

type SlackWebhookPlugin

type SlackWebhookPlugin struct {
	// contains filtered or unexported fields
}

func (*SlackWebhookPlugin) Config

func (p *SlackWebhookPlugin) Config() interface{}

func (*SlackWebhookPlugin) ExecutePlugin

func (p *SlackWebhookPlugin) ExecutePlugin(c *core.ConsumerFile, _ http.ResponseWriter, r *http.Request) bool

func (*SlackWebhookPlugin) Type

func (*SlackWebhookPlugin) Type() string

type SlackWebhookPluginConfig

type SlackWebhookPluginConfig struct {
	Secret string `mapstructure:"secret" yaml:"secret"`
}