auth

Documentation

Index

• type Provider
  • func NewAuthDisabled() Provider
  • func NewAuthenticationTLS(certificatePath string, privateKeyPath string) Provider
  • func NewAuthenticationTLSWithParams(params map[string]string) Provider
  • func NewAuthenticationToken(token string) Provider
  • func NewAuthenticationTokenFromFile(tokenFilePath string) Provider
  • func NewAuthenticationTokenFromSupplier(tokenSupplier func() (string, error)) Provider
  • func NewAuthenticationTokenWithParams(params map[string]string) (Provider, error)
  • func NewProvider(name string, params string) (Provider, error)

Types

type Provider

type Provider interface {
	// Init the authentication provider.
	Init() error

	// Name func returns the identifier for this authentication method.
	Name() string

	// return a client certificate chain, or nil if the data are not available
	GetTLSCertificate() (*tls.Certificate, error)

	// GetData returns the authentication data identifying this client that will be sent to the broker.
	GetData() ([]byte, error)

	io.Closer
}

Provider is a interface of authentication providers.

func NewAuthDisabled

func NewAuthDisabled() Provider

NewAuthDisabled return a interface of Provider

func NewAuthenticationTLS

func NewAuthenticationTLS(certificatePath string, privateKeyPath string) Provider

NewAuthenticationTLS initialize the authentication provider

func NewAuthenticationTLSWithParams

func NewAuthenticationTLSWithParams(params map[string]string) Provider

NewAuthenticationTLSWithParams initialize the authentication provider with map param.

func NewAuthenticationToken

func NewAuthenticationToken(token string) Provider

NewAuthenticationToken returns a token auth provider that will use the specified token to talk with Pulsar brokers

func NewAuthenticationTokenFromFile

func NewAuthenticationTokenFromFile(tokenFilePath string) Provider

NewAuthenticationTokenFromFile return a interface of a Provider with a string token file path.

func NewAuthenticationTokenFromSupplier

func NewAuthenticationTokenFromSupplier(tokenSupplier func() (string, error)) Provider

NewAuthenticationTokenFromSupplier returns a token auth provider that get the token data from a user supplied function. The function is invoked each time the client library needs to use a token in talking with Pulsar brokers

func NewAuthenticationTokenWithParams

func NewAuthenticationTokenWithParams(params map[string]string) (Provider, error)

NewAuthenticationTokenWithParams return a interface of Provider with string map.

func NewProvider

func NewProvider(name string, params string) (Provider, error)

NewProvider get/create an authentication data provider which provides the data that this client will be sent to the broker. Some authentication method need to auth between each client channel. So it need the broker, who it will talk to.