nonce

Documentation

Index

• type Store
  • func NewStore(ctx context.Context, db *sql.DB) (*Store, error)
  • func (s *Store) Consume(ctx context.Context, id [16]byte) (bool, error)
  • func (s *Store) New() [16]byte
  • func (s *Store) Shutdown(ctx context.Context) error

Types

type Store

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

Store allows generating and consuming nonce values.

func NewStore

func NewStore(ctx context.Context, db *sql.DB) (*Store, error)

NewStore prepares a new Store.

func (*Store) Consume

func (s *Store) Consume(ctx context.Context, id [16]byte) (bool, error)

Consume will record the use of a nonce value.

An error is returned if it is not possible to validate the nonce value. Otherwise true/false is returned to indicate if the id is valid.

The first call to Consume for a given ID will return true, subsequent calls for the same ID will return false.

func (*Store) New

func (s *Store) New() [16]byte

New will generate a new cryptographically random nonce value.

func (*Store) Shutdown

func (s *Store) Shutdown(ctx context.Context) error

Shutdown allows gracefully shutting down the nonce store.