scram

package

v0.4.48 Latest Latest Go to latest Published: May 14, 2025 License: MIT Imports: 6 Imported by: 211

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/segmentio/kafka-go

Links

Open Source Insights

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Mechanism ¶

func Mechanism(algo Algorithm, username, password string) (sasl.Mechanism, error)

Mechanism returns a new sasl.Mechanism that will use SCRAM with the provided Algorithm to securely transmit the provided credentials to Kafka.

SCRAM-SHA-256 and SCRAM-SHA-512 were added to Kafka in 0.10.2.0. These mechanisms will not work with older versions.

Types ¶

type Algorithm ¶

type Algorithm interface {
	// Name returns the algorithm's name, e.g. "SCRAM-SHA-256"
	Name() string

	// Hash returns a new hash.Hash.
	Hash() hash.Hash
}

Algorithm determines the hash function used by SCRAM to protect the user's credentials.

var (
	SHA256 Algorithm = sha256Algo{}
	SHA512 Algorithm = sha512Algo{}
)

Source Files ¶

View all Source files

scram.go

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