token

Documentation

Index

• Variables
• type Kind
  • func (k Kind) String() string
• type Tokenizer
  • func New(salt string) (*Tokenizer, error)
  • func (t *Tokenizer) DecodeToken(token string) (Kind, int64, error)
  • func (t *Tokenizer) EncodeToken(kind Kind, id int64) (string, error)
  • func (t *Tokenizer) GetToken(o interface{}) string

Variables

var (
	// ErrInvalidLength is returned when a token's data is an invalid length.
	ErrInvalidLength = errors.New("invalid length")
	// ErrSaltEmpty is returned when a token's data is an invalid length.
	ErrSaltEmpty = errors.New("salt empty")
)

Types

type Kind

type Kind int64

Kind represents the kind of model to encode a token for.

const (
	// KindInstance is a token that represents an instance.
	KindInstance Kind = 1 + iota
	// KindAccount is a token that represents an account.
	KindAccount
	// KindTag is a token that represents a tag.
	KindTag
)

This order can not change else all external urls with tokens will become invalid.

func (Kind) String

func (k Kind) String() string

type Tokenizer

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

Tokenizer generates public tokens for database IDs to obfuscate the database IDs.

func New

func New(salt string) (*Tokenizer, error)

New returns a new tokenizer.

func (*Tokenizer) DecodeToken

func (t *Tokenizer) DecodeToken(token string) (Kind, int64, error)

DecodeToken returns the kind and id number of a provided token.

func (*Tokenizer) EncodeToken

func (t *Tokenizer) EncodeToken(kind Kind, id int64) (string, error)

EncodeToken turns a model kind and id into a token.

func (*Tokenizer) GetToken

func (t *Tokenizer) GetToken(o interface{}) string

GetToken returns a token for a known model type.