deal

Documentation

Index

• Variables
• func CreateTocs(note, secret string, players []*Player, threshold int) (map[string]string, error)
• type EncryptFunc
  • func EncryptWithAge(playerKeys ...age.Recipient) EncryptFunc
• type Player
  • func NewPlayer(address string, encryptionFunc EncryptFunc) (*Player, error)
  • func (p *Player) EncryptToc(toc *api.Toc) (string, error)

Variables

var ErrHighThreshold = errors.New("threshold cannot be higher than the number of players")

ErrHighThreshold is returned when the number of players is lower than the threshold

var ErrInvalidTOTPSecret = errors.New("the provided value is not a valid TOTP secret key")

ErrInvalidTOTPSecret is returned when testing the given secret against the TOTP algorithm unsuccessfully

var ErrLowThreshold = errors.New("threshold cannot be lower than 2")

ErrLowThreshold is returned when the provided threshold makes no sense: if less than 2, there's no reason to use farMFA

Functions

func CreateTocs

func CreateTocs(note, secret string, players []*Player, threshold int) (map[string]string, error)

CreateTocs generates encrypted len(players) encrypted Tocs from secret; note is a message to remind the purpose of these Tocs

Types

type EncryptFunc

type EncryptFunc func(toc *api.Toc) (string, error)

EncryptFunc turns a Toc into an encrypted string

func EncryptWithAge

func EncryptWithAge(playerKeys ...age.Recipient) EncryptFunc

EncryptWithAge is used to encrypt a JSON-marshalled Toc with Age for a certain player

type Player

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

Player represents an individual who receives an encrypted Toc

func NewPlayer

func NewPlayer(address string, encryptionFunc EncryptFunc) (*Player, error)

func (*Player) EncryptToc

func (p *Player) EncryptToc(toc *api.Toc) (string, error)

EncryptToc simply encrypts a Toc for the intended player