auth

README

auth

Opinionated token based authentication

• ed25519 (EdDSA) based verification
• Body is encoded using msgpack
• TTL enforced to expire tokens
• Optional AES encryption, thanks to https://github.com/gtank/cryptopasta

Documentation

Overview

Provides symmetric authenticated encryption using 256-bit AES-GCM with a random nonce.

Index

• Variables
• func NewEncryptionKey() *[32]byte
• type Authenticator
  • func (this *Authenticator[A]) Decode(token []byte, ttl int64) (*A, error)
  • func (this *Authenticator[A]) Generate(src *A) ([]byte, error)
  • func (this *Authenticator[A]) GenerateStr(src *A) (string, error)
  • func (this *Authenticator[A]) Parse(token []byte, dst *A, ttl int64) error

Variables

var (
	ErrExpired  = errors.New("authentication expired")
	ErrModified = errors.New("payload or signature was modified")
)

Functions

func NewEncryptionKey

func NewEncryptionKey() *[32]byte

NewEncryptionKey generates a random 256-bit key for Encrypt() and Decrypt(). It panics if the source of randomness fails.

Types

type Authenticator

type Authenticator[A any] struct {
	// Required
	Public  ed25519.PublicKey
	Private ed25519.PrivateKey

	// Optional
	EncryptionKey *[32]byte
}

func (*Authenticator[A]) Decode

func (this *Authenticator[A]) Decode(token []byte, ttl int64) (*A, error)

func (*Authenticator[A]) Generate

func (this *Authenticator[A]) Generate(src *A) ([]byte, error)

func (*Authenticator[A]) GenerateStr

func (this *Authenticator[A]) GenerateStr(src *A) (string, error)

func (*Authenticator[A]) Parse

func (this *Authenticator[A]) Parse(token []byte, dst *A, ttl int64) error