Categorygithub.com/xdg/scram
modulepackage
1.0.5
Repository: https://github.com/xdg/scram.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
13
Dependents
212
Files
623 SLOC

# README

DON'T USE THIS PACKAGE - use xdg-go/scram instead!

I renamed this to xdg-go/scram in October 2018. This didn't break dependencies at the time because Github redirected requests. In March 2021, I made xdg-go/scram a module, which can't be used as xdg/scram with Github redirects. This repository has been recreated to support legacy dependencies.

See my article How I broke the MongoDB Go driver ecosystem for more details.

# Variables

SHA1 is a function that returns a crypto/sha1 hasher and should be used to create Client objects configured for SHA-1 hashing.
SHA256 is a function that returns a crypto/sha256 hasher and should be used to create Client objects configured for SHA-256 hashing.

# Structs

Client implements the client side of SCRAM authentication.
ClientConversation implements the client-side of an authentication conversation with a server.
KeyFactors represent the two server-provided factors needed to compute client credentials for authentication.
Server implements the server side of SCRAM authentication.
ServerConversation implements the server-side of an authentication conversation with a client.
StoredCredentials are the values that a server must store for a given username to allow authentication.

# Type aliases

CredentialLookup is a callback to provide StoredCredentials for a given username.
HashGeneratorFcn abstracts a factory function that returns a hash.Hash value to be used for SCRAM operations.
NonceGeneratorFcn defines a function that returns a string of high-quality random printable ASCII characters EXCLUDING the comma (',') character.