signing

Documentation

Index

• Constants
• func Public(priv PrivateKey) ed25519.PublicKey
• func VRFVerify(nodeID types.NodeID, msg []byte, sig types.VrfSignature) bool
• type Domain
  • func (d Domain) String() string
• type EdSigner
  • func NewEdSigner(opts ...EdSignerOptionFunc) (*EdSigner, error)
  • func (es *EdSigner) NodeID() types.NodeID
  • func (es *EdSigner) Prefix() []byte
  • func (es *EdSigner) PrivateKey() PrivateKey
  • func (es *EdSigner) PublicKey() *PublicKey
  • func (es *EdSigner) Sign(d Domain, m []byte) types.EdSignature
  • func (es *EdSigner) VRFSigner() *VRFSigner
• type EdSignerOptionFunc
  • func WithKeyFromRand(rand io.Reader) EdSignerOptionFunc
  • func WithPrefix(prefix []byte) EdSignerOptionFunc
  • func WithPrivateKey(priv PrivateKey) EdSignerOptionFunc
• type EdVerifier
  • func NewEdVerifier(opts ...VerifierOptionFunc) (*EdVerifier, error)
  • func (es *EdVerifier) Verify(d Domain, nodeID types.NodeID, m []byte, sig types.EdSignature) bool
• type PrivateKey
• type PublicKey
  • func NewPublicKey(pub []byte) *PublicKey
  • func (p *PublicKey) Bytes() []byte
  • func (p *PublicKey) Equals(o *PublicKey) bool
  • func (p *PublicKey) Field() log.Field
  • func (p *PublicKey) ShortString() string
  • func (p *PublicKey) String() string
• type VRFSigner
  • func (s VRFSigner) LittleEndian() bool
  • func (s VRFSigner) NodeID() types.NodeID
  • func (s VRFSigner) PublicKey() *PublicKey
  • func (s VRFSigner) Sign(msg []byte) types.VrfSignature
• type VRFVerifier
  • func NewVRFVerifier() VRFVerifier
  • func (v VRFVerifier) Verify(nodeID types.NodeID, msg []byte, sig types.VrfSignature) bool
• type VerifierOptionFunc
  • func WithVerifierPrefix(prefix []byte) VerifierOptionFunc

Constants

const (
	ATX Domain = 0

	PROPOSAL = 1
	BALLOT   = 2
	HARE     = 3
	POET     = 4

	BEACON_FIRST_MSG    = 10
	BEACON_FOLLOWUP_MSG = 11
)

const PrivateKeySize = ed25519.PrivateKeySize

PrivateKeySize size of the private key in bytes.

Functions

func Public

func Public(priv PrivateKey) ed25519.PublicKey

func VRFVerify

func VRFVerify(nodeID types.NodeID, msg []byte, sig types.VrfSignature) bool

VRFVerify verifies that a signature matches public key and message.

Types

type Domain

type Domain byte

func (Domain) String

func (d Domain) String() string

String returns the string representation of a domain.

type EdSigner

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

EdSigner represents an ED25519 signer.

func NewEdSigner

func NewEdSigner(opts ...EdSignerOptionFunc) (*EdSigner, error)

NewEdSigner returns an auto-generated ed signer.

func (*EdSigner) NodeID

func (es *EdSigner) NodeID() types.NodeID

NodeID returns the node ID of the signer.

func (*EdSigner) Prefix

func (es *EdSigner) Prefix() []byte

func (*EdSigner) PrivateKey

func (es *EdSigner) PrivateKey() PrivateKey

PrivateKey returns private key.

func (*EdSigner) PublicKey

func (es *EdSigner) PublicKey() *PublicKey

PublicKey returns the public key of the signer.

func (*EdSigner) Sign

func (es *EdSigner) Sign(d Domain, m []byte) types.EdSignature

Sign signs the provided message.

func (*EdSigner) VRFSigner

func (es *EdSigner) VRFSigner() *VRFSigner

VRFSigner wraps same ed25519 key to provide ecvrf.

type EdSignerOptionFunc

type EdSignerOptionFunc func(*edSignerOption) error

EdSignerOptionFunc modifies EdSigner.

func WithKeyFromRand

func WithKeyFromRand(rand io.Reader) EdSignerOptionFunc

WithKeyFromRand sets the private key used by EdSigner using predictable randomness source.

func WithPrefix

func WithPrefix(prefix []byte) EdSignerOptionFunc

WithPrefix sets the prefix used by EdSigner. This usually is the Network ID.

func WithPrivateKey

func WithPrivateKey(priv PrivateKey) EdSignerOptionFunc

WithPrivateKey sets the private key used by EdSigner.

type EdVerifier

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

EdVerifier extracts public keys from signatures.

func NewEdVerifier

func NewEdVerifier(opts ...VerifierOptionFunc) (*EdVerifier, error)

func (*EdVerifier) Verify

func (es *EdVerifier) Verify(d Domain, nodeID types.NodeID, m []byte, sig types.EdSignature) bool

Verify verifies that a signature matches public key and message.

type PrivateKey

type PrivateKey = ed25519.PrivateKey

PrivateKey is an alias to ed25519.PrivateKey.

type PublicKey

type PublicKey struct {
	ed25519.PublicKey
}

PublicKey is the type describing a public key.

func NewPublicKey

func NewPublicKey(pub []byte) *PublicKey

NewPublicKey constructs a new public key instance from a byte array.

func (*PublicKey) Bytes

func (p *PublicKey) Bytes() []byte

Bytes returns the public key as byte array.

func (*PublicKey) Equals

func (p *PublicKey) Equals(o *PublicKey) bool

Equals returns true iff the public keys are equal.

func (*PublicKey) Field

func (p *PublicKey) Field() log.Field

Field returns a log field. Implements the LoggableField interface.

func (*PublicKey) ShortString

func (p *PublicKey) ShortString() string

ShortString returns a representative sub string.

func (*PublicKey) String

func (p *PublicKey) String() string

String returns the public key as a hex representation string.

type VRFSigner

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

VRFSigner is a signer for VRF purposes.

func (VRFSigner) LittleEndian

func (s VRFSigner) LittleEndian() bool

LittleEndian indicates whether byte order in a signature is little-endian.

func (VRFSigner) NodeID

func (s VRFSigner) NodeID() types.NodeID

NodeID of the signer.

func (VRFSigner) PublicKey

func (s VRFSigner) PublicKey() *PublicKey

PublicKey of the signer.

func (VRFSigner) Sign

func (s VRFSigner) Sign(msg []byte) types.VrfSignature

Sign signs a message for VRF purposes.

type VRFVerifier

type VRFVerifier func(types.NodeID, []byte, types.VrfSignature) bool

func NewVRFVerifier

func NewVRFVerifier() VRFVerifier

func (VRFVerifier) Verify

func (v VRFVerifier) Verify(nodeID types.NodeID, msg []byte, sig types.VrfSignature) bool

Verify verifies that a signature matches public key and message.

type VerifierOptionFunc

type VerifierOptionFunc func(*edVerifierOption) error

VerifierOptionFunc to modify verifier.

func WithVerifierPrefix

func WithVerifierPrefix(prefix []byte) VerifierOptionFunc

WithVerifierPrefix sets the prefix used by PubKeyVerifier. This usually is the Network ID.