token

package

v0.1.0-alpha.1 Latest Latest Go to latest Published: Jun 5, 2026 License: MIT Imports: 6 Imported by: 0

Details

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

Repository

github.com/lechefran/auth

Links

Open Source Insights

Documentation ¶

Overview ¶

Package token provides secure opaque token generation and lookup hashing.

Index ¶

Constants
Variables
func GenerateAPIKeySecret() (string, error)
func GenerateOpaque(byteLength int) (string, error)
func GeneratePublicID() (string, error)
func HMACLookupHash(value string, key []byte) ([]byte, error)
func LookupHash(value string) ([]byte, error)

Constants ¶

View Source

const (

	// MinLookupKeyBytes is the minimum application-controlled HMAC key length
	// for token lookup hashes.
	MinLookupKeyBytes = 32
)

Variables ¶

View Source

var (
	// ErrInvalidLength reports an unsafe token byte length.
	ErrInvalidLength = errors.New("token: invalid length")

	// ErrEmptyToken reports that a token value was empty.
	ErrEmptyToken = errors.New("token: empty token")

	// ErrWeakLookupKey reports that an HMAC lookup key is too short.
	ErrWeakLookupKey = errors.New("token: weak lookup key")
)

Functions ¶

func GenerateAPIKeySecret ¶

func GenerateAPIKeySecret() (string, error)

GenerateAPIKeySecret returns a URL-safe opaque API key secret.

func GenerateOpaque ¶

func GenerateOpaque(byteLength int) (string, error)

GenerateOpaque returns a URL-safe opaque value with at least 128 bits of entropy.

func GeneratePublicID ¶

func GeneratePublicID() (string, error)

GeneratePublicID returns a URL-safe public identifier.

func HMACLookupHash ¶

func HMACLookupHash(value string, key []byte) ([]byte, error)

HMACLookupHash returns an HMAC-SHA-256 lookup hash for a high-entropy random token using an application-controlled lookup key.

func LookupHash ¶

func LookupHash(value string) ([]byte, error)

LookupHash returns a SHA-256 lookup hash for a high-entropy random token.

This is appropriate for high-entropy API keys generated by this package. It is not suitable for human passwords.

Types ¶

This section is empty.

Source Files ¶

View all Source files

generate.go

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