The highest tagged major version is v3.

auth

package

v1.20.4 Latest Latest Go to latest Published: May 13, 2019 License: MIT Imports: 9 Imported by: 6

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Jeffail/benthos

Links

Open Source Insights

Documentation ¶

Overview ¶

Package auth provides configuration fields and implementations of HTTP request authentication strategies.

Index ¶

type BasicAuthConfig
- func NewBasicAuthConfig() BasicAuthConfig
- func (basic BasicAuthConfig) Sign(req *http.Request) error
type Config
- func NewConfig() Config
- func (c Config) Sign(req *http.Request) error
type OAuthConfig
- func NewOAuthConfig() OAuthConfig
- func (oauth OAuthConfig) Sign(req *http.Request) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type BasicAuthConfig ¶

type BasicAuthConfig struct {
	Enabled  bool   `json:"enabled" yaml:"enabled"`
	Username string `json:"username" yaml:"username"`
	Password string `json:"password" yaml:"password"`
}

BasicAuthConfig contains fields for setting basic authentication in HTTP requests.

func NewBasicAuthConfig ¶

func NewBasicAuthConfig() BasicAuthConfig

NewBasicAuthConfig returns a default configuration for basic authentication in HTTP client requests.

func (BasicAuthConfig) Sign ¶

func (basic BasicAuthConfig) Sign(req *http.Request) error

Sign method to sign an HTTP request for an OAuth exchange.

type Config ¶

type Config struct {
	OAuth     OAuthConfig     `json:"oauth" yaml:"oauth"`
	BasicAuth BasicAuthConfig `json:"basic_auth" yaml:"basic_auth"`
}

Config contains configuration params for various HTTP auth strategies.

func NewConfig ¶

func NewConfig() Config

NewConfig creates a new Config with default values.

func (Config) Sign ¶

func (c Config) Sign(req *http.Request) error

Sign method to sign an HTTP request for configured auth strategies.

type OAuthConfig ¶

type OAuthConfig struct {
	Enabled           bool   `json:"enabled" yaml:"enabled"`
	ConsumerKey       string `json:"consumer_key" yaml:"consumer_key"`
	ConsumerSecret    string `json:"consumer_secret" yaml:"consumer_secret"`
	AccessToken       string `json:"access_token" yaml:"access_token"`
	AccessTokenSecret string `json:"access_token_secret" yaml:"access_token_secret"`
	RequestURL        string `json:"request_url" yaml:"request_url"`
}

OAuthConfig holds the configuration parameters for an OAuth exchange.

func NewOAuthConfig ¶

func NewOAuthConfig() OAuthConfig

NewOAuthConfig returns a new OAuthConfig with default values.

func (OAuthConfig) Sign ¶

func (oauth OAuthConfig) Sign(req *http.Request) error

Sign method to sign an HTTP request for an OAuth exchange.

Source Files ¶

View all Source files

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