basculehash

type Bcrypt struct {
	// Cost is the cost parameter for bcrypt.  If unset, the internal
	// bcrypt cost is used.  If this value is higher than the max,
	// Hash will return an error.
	//
	// See: https://pkg.go.dev/golang.org/x/crypto/bcrypt#pkg-constants
	Cost int
}

type Comparer interface {
	// Matches tests if the given plaintext matches the given hash.
	// For example, this method can test if a password matches the
	// one-way hashed password from a config file or database.
	Matches(plaintext []byte, d Digest) error
}

type Credentials interface {
	// Get returns the Digest associated with the given Principal.
	// This method returns false if the principal did not exist.
	Get(ctx context.Context, principal string) (d Digest, exists bool)

	// Set associates a principal with a Digest.  If the principal already
	// exists, its digest is replaced.
	Set(ctx context.Context, principal string, d Digest)

	// Delete removes one or more principals from this set.
	Delete(ctx context.Context, principals ...string)

	// Update performs a bulk update of these credentials. Any existing
	// principals are replaced.
	Update(ctx context.Context, p Principals)
}

type Digest []byte

type Hasher interface {
	// Hash returns a digest of the given plaintext.  The returned Digest
	// must be recognizable to a Comparer in order to be validated.
	//
	// If this method returns a nil error, it MUST return a valid Digest.
	// If this method returns an error, the Digest is not guaranteed to have
	// any particular value and should be discarded.
	//
	// The format of the digest must be ASCII. The recommended format is
	// the PHC format documented at:
	//
	// https://github.com/P-H-C/phc-string-format/blob/master/phc-sf-spec.md
	Hash(plaintext []byte) (Digest, error)
}

type HasherComparer interface {
	Hasher
	Comparer
}

type Principals map[string]Digest

type Store struct {
	// contains filtered or unexported fields
}