token

Documentation

Index

• func Generate(payload map[string]interface{}, privateKey *rsa.PrivateKey) []byte
• func IsUnexpectedError(err error) bool
• func ParseAndValidate(token []byte, publicKey *rsa.PublicKey) (map[string]interface{}, error)
• func UnmarshalDependingOnItemPlatform(store *database.DataStore, itemID int64, target interface{}, token []byte, ...) (err error)
• type Answer
  • func (tt *Answer) MarshalJSON() ([]byte, error)
  • func (tt *Answer) MarshalString() (string, error)
  • func (tt *Answer) Sign(privateKey *rsa.PrivateKey) (string, error)
  • func (tt *Answer) UnmarshalJSON(raw []byte) error
  • func (tt *Answer) UnmarshalString(raw string) error
• type Config
  • func Initialize(config *viper.Viper) (tokenConfig *Config, err error)
• type Hint
  • func (tt *Hint) MarshalJSON() ([]byte, error)
  • func (tt *Hint) MarshalString() (string, error)
  • func (tt *Hint) Sign(privateKey *rsa.PrivateKey) (string, error)
  • func (tt *Hint) UnmarshalJSON(raw []byte) error
  • func (tt *Hint) UnmarshalString(raw string) error
• type MarshalStringer
• type Score
  • func (tt *Score) MarshalJSON() ([]byte, error)
  • func (tt *Score) MarshalString() (string, error)
  • func (tt *Score) Sign(privateKey *rsa.PrivateKey) (string, error)
  • func (tt *Score) UnmarshalJSON(raw []byte) error
  • func (tt *Score) UnmarshalString(raw string) error
• type Signer
• type Task
  • func (tt *Task) MarshalJSON() ([]byte, error)
  • func (tt *Task) MarshalString() (string, error)
  • func (tt *Task) Sign(privateKey *rsa.PrivateKey) (string, error)
  • func (tt *Task) UnmarshalJSON(raw []byte) error
  • func (tt *Task) UnmarshalString(raw string) error
• type UnexpectedError
  • func (ue *UnexpectedError) Error() string
• type UnmarshalStringer

Functions

func Generate

func Generate(payload map[string]interface{}, privateKey *rsa.PrivateKey) []byte

Generate generates a signed token for a payload

func IsUnexpectedError

func IsUnexpectedError(err error) bool

IsUnexpectedError returns true if its argument is an unexpected error

func ParseAndValidate

func ParseAndValidate(token []byte, publicKey *rsa.PublicKey) (map[string]interface{}, error)

ParseAndValidate parses a token and validates its signature and date

func UnmarshalDependingOnItemPlatform

func UnmarshalDependingOnItemPlatform(store *database.DataStore, itemID int64,
	target interface{}, token []byte, tokenFieldName string) (err error)

UnmarshalDependingOnItemPlatform unmarshals a token from JSON representation using a platforms's public key for given itemID. The function returns if the platform doesn't use tokens.

Types

type Answer

type Answer payloads.AnswerToken

Answer represents an answer token

func (*Answer) MarshalJSON

func (tt *Answer) MarshalJSON() ([]byte, error)

MarshalJSON marshals the answer token into JSON

func (*Answer) MarshalString

func (tt *Answer) MarshalString() (string, error)

MarshalString marshals the answer token into a string

func (*Answer) Sign

func (tt *Answer) Sign(privateKey *rsa.PrivateKey) (string, error)

Sign returns a signed token as a string

func (*Answer) UnmarshalJSON

func (tt *Answer) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals the answer token from JSON

func (*Answer) UnmarshalString

func (tt *Answer) UnmarshalString(raw string) error

UnmarshalString unmarshals the task token from a string

type Config

type Config struct {
	PublicKey    *rsa.PublicKey
	PrivateKey   *rsa.PrivateKey
	PlatformName string
}

Config contains parsed keys and PlatformName

func Initialize

func Initialize(config *viper.Viper) (tokenConfig *Config, err error)

Initialize loads keys from the config and resolves the platform name

type Hint

type Hint payloads.HintToken

Hint represents a hint token

func (*Hint) MarshalJSON

func (tt *Hint) MarshalJSON() ([]byte, error)

MarshalJSON marshals the answer token into JSON

func (*Hint) MarshalString

func (tt *Hint) MarshalString() (string, error)

MarshalString marshals the hint token into a string

func (*Hint) Sign

func (tt *Hint) Sign(privateKey *rsa.PrivateKey) (string, error)

Sign returns a signed token as a string

func (*Hint) UnmarshalJSON

func (tt *Hint) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals the answer token from JSON

func (*Hint) UnmarshalString

func (tt *Hint) UnmarshalString(raw string) error

UnmarshalString unmarshals the task token from a string

type MarshalStringer

type MarshalStringer interface {
	MarshalString() (string, error)
}

MarshalStringer is the interface implemented by types that can marshal themselves into a string. For example, a token's string description is `{ENCODED_TOKEN}` while a token's JSON description is `"{ENCODED_TOKEN}"`

type Score

type Score payloads.ScoreToken

Score represents a score token

func (*Score) MarshalJSON

func (tt *Score) MarshalJSON() ([]byte, error)

MarshalJSON marshals the score token into JSON

func (*Score) MarshalString

func (tt *Score) MarshalString() (string, error)

MarshalString marshals the score token into a string

func (*Score) Sign

func (tt *Score) Sign(privateKey *rsa.PrivateKey) (string, error)

Sign returns a signed score token as a string

func (*Score) UnmarshalJSON

func (tt *Score) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals the score token from JSON

func (*Score) UnmarshalString

func (tt *Score) UnmarshalString(raw string) error

UnmarshalString unmarshals the score token from a string

type Signer

type Signer interface {
	Sign(*rsa.PrivateKey) (string, error)
}

Signer is the interface implemented by types that can sign themselves returning a token in a string.

type Task

type Task payloads.TaskToken

Task represents a task token

func (*Task) MarshalJSON

func (tt *Task) MarshalJSON() ([]byte, error)

MarshalJSON marshals the task token into JSON

func (*Task) MarshalString

func (tt *Task) MarshalString() (string, error)

MarshalString marshals the task token into a string

func (*Task) Sign

func (tt *Task) Sign(privateKey *rsa.PrivateKey) (string, error)

Sign returns a signed token as a string

func (*Task) UnmarshalJSON

func (tt *Task) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals the task token from JSON

func (*Task) UnmarshalString

func (tt *Task) UnmarshalString(raw string) error

UnmarshalString unmarshals the task token from a string

type UnexpectedError

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

UnexpectedError represents an unexpected error so that we could differentiate it from expected errors

func (*UnexpectedError) Error

func (ue *UnexpectedError) Error() string

Error returns a string representation for an unexpected error

type UnmarshalStringer

type UnmarshalStringer interface {
	UnmarshalString(string) error
}

UnmarshalStringer is the interface implemented by types that can unmarshal a string description of themselves. For example, a token's string description is `{ENCODED_TOKEN}` while a token's JSON description is `"{ENCODED_TOKEN}"`