suites

Documentation

Overview

Package suites allows callers to look up Kyber suites by name.

Currently, only the "ed25519" suite is available by default. To have access to "curve25519" and the NIST suites (i.e. "P256"), one needs to call the "go" tool with the tag "vartime", such as:

go build -tags vartime
go install -tags vartime
go test -tags vartime

Index

• Variables
• type Suite
  • func Find(name string) (Suite, error)
  • func MustFind(name string) Suite

Variables

var ErrUnknownSuite = errors.New("unknown suite")

ErrUnknownSuite indicates that the suite was not one of the registered suites.

Types

type Suite

type Suite interface {
	G1() kyber.Group
	G2() kyber.Group
	GT() kyber.Group
	Pair(p1, p2 kyber.Point) kyber.Point
	PairingCheck(a []kyber.Point, b []kyber.Point) bool
	kyber.Group
	kyber.Encoding
	kyber.HashFactory
	kyber.XOFFactory
	kyber.Random
}

Suite is the sum of all suites mix-ins in Kyber.

func Find

func Find(name string) (Suite, error)

Find looks up a suite by name.

func MustFind

func MustFind(name string) Suite

MustFind looks up a suite by name and panics if it is not found.