cecrets

Documentation

Index

• Constants
• func Conceal(a any) string
• func ConcealWith(alg hashAlg, s string) string
• func Hide(a any) secret
• func HideAll(a ...any) []secret
• func Mask(a any) secret
• func SetHasher(sc HashCfg)
• type Concealer
• type HashCfg
  • func DefaultHash() HashCfg
  • func NoHash() HashCfg

Constants

const (
	SHA256 hashAlg = iota
	HMAC_SHA256
	Plaintext
	Flatmask
)

Functions

func Conceal

func Conceal(a any) string

Conceal runs the currently configured hashing algorithm on the parameterized value.

func ConcealWith

func ConcealWith(alg hashAlg, s string) string

Conceal runs one of clues' hashing algorithms on the provided string.

func Hide

func Hide(a any) secret

Hide embeds the value in a secret struct where the Conceal() call contains a truncated hash of value. The hash function defaults to SHA256, but can be changed through configuration.

func HideAll

func HideAll(a ...any) []secret

HideAll is a quality-of-life wrapper for transforming multiple values to secret structs.

func Mask

func Mask(a any) secret

Mask embeds the value in a secret struct where the Conceal() call always returns a flat string: "***"

func SetHasher

func SetHasher(sc HashCfg)

SetHasher sets the hashing configuration used in all concealer structs, and Conceal() and Hash() calls.

Types

type Concealer

type Concealer interface {
	// Conceal produces an obfuscated representation of the value.
	Conceal() string
	// Concealers also need to comply with Format.
	// Complying with Conceal() alone doesn't guarantee that
	// the variable won't pass into fmt.Printf("%v") and skip
	// the whole conceal process.
	Format(fs fmt.State, verb rune)
	// PlainStringer is the opposite of conceal.
	// Useful for if you want to retrieve the raw value of a secret.
	PlainString() string
}

type HashCfg

type HashCfg struct {
	HashAlg hashAlg
	HMACKey []byte
}

func DefaultHash

func DefaultHash() HashCfg

DefaultHash creates a secrets configuration using the HMAC_SHA256 hash with a random key. This value is already set upon initialization of the package.

func NoHash

func NoHash() HashCfg

NoHash provides a secrets configuration with no hashing or masking of values.