kafka

Documentation

Index

• Variables
• func ApplySaramaSASLFromParsed(pConf *service.ParsedConfig, mgr *service.Resources, conf *sarama.Config) error
• func NewKafkaWriterFromParsed(conf *service.ParsedConfig, mgr *service.Resources) (service.BatchOutput, error)
• func OSKConfigSpec() *service.ConfigSpec
• func SaramaSASLField() *service.ConfigField
• type XDGSCRAMClient
  • func (x *XDGSCRAMClient) Begin(userName, password, authzID string) (err error)
  • func (x *XDGSCRAMClient) Done() bool
  • func (x *XDGSCRAMClient) Step(challenge string) (response string, err error)

Variables

var AWSSASLFromConfigFn = notImportedAWSFn

AWSSASLFromConfigFn is populated with the child `aws` package when imported.

var (
	ErrUnsupportedSASLMechanism = errors.New("unsupported SASL mechanism")
)

SASL specific error types.

var SHA256 scram.HashGeneratorFcn = sha256.New

SHA256 generates the SHA256 hash.

var SHA512 scram.HashGeneratorFcn = sha512.New

SHA512 generates the SHA512 hash.

Functions

func ApplySaramaSASLFromParsed

func ApplySaramaSASLFromParsed(pConf *service.ParsedConfig, mgr *service.Resources, conf *sarama.Config) error

ApplySaramaSASLFromParsed applies a parsed config containing a SASL field to a sarama.Config.

func NewKafkaWriterFromParsed

func NewKafkaWriterFromParsed(conf *service.ParsedConfig, mgr *service.Resources) (service.BatchOutput, error)

NewKafkaWriteFromParsed returns a kafka output from a parsed config.

func OSKConfigSpec

func OSKConfigSpec() *service.ConfigSpec

OSKConfigSpec creates a new config spec for a kafka output.

func SaramaSASLField

func SaramaSASLField() *service.ConfigField

SaramaSASLField returns a field spec definition for SASL within the sarama components.

Types

type XDGSCRAMClient

type XDGSCRAMClient struct {
	*scram.Client
	*scram.ClientConversation
	scram.HashGeneratorFcn
}

XDGSCRAMClient represents struct to XDG Scram client to initialize conversation.

func (*XDGSCRAMClient) Begin

func (x *XDGSCRAMClient) Begin(userName, password, authzID string) (err error)

Begin initializes new client and conversation to securely transmit the provided credentials to Kafka.

func (*XDGSCRAMClient) Done

func (x *XDGSCRAMClient) Done() bool

Done returns true if the conversation is completed or has errored.

func (*XDGSCRAMClient) Step

func (x *XDGSCRAMClient) Step(challenge string) (response string, err error)

Step takes a string provided from a server (or just an empty string for the very first conversation step) and attempts to move the authentication conversation forward.