signing

Documentation

Index

• Constants
• Variables
• func ExtractPublicKey(msg, sig []byte) (ed25519.PublicKey, error)
• func Public(priv PrivateKey) ed25519.PublicKey
• func VRFVerify(pub, msg, sig []byte) bool
• type EDVerifier
  • func NewEDVerifier(opts ...VerifierOpt) EDVerifier
  • func (e EDVerifier) Extract(msg, sig []byte) (*PublicKey, error)
• type EdSigner
  • func NewEdSigner(opts ...SignerOpt) *EdSigner
  • func NewEdSignerFromBuffer(buff []byte, opts ...SignerOpt) (*EdSigner, error)
  • func NewEdSignerFromRand(rand io.Reader) *EdSigner
  • func (es *EdSigner) LittleEndian() bool
  • func (es *EdSigner) PrivateKey() PrivateKey
  • func (es *EdSigner) PublicKey() *PublicKey
  • func (es *EdSigner) Sign(m []byte) []byte
  • func (es *EdSigner) ToBuffer() []byte
  • func (es *EdSigner) VRFSigner() *VRFSigner
• 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 Signer
• type SignerOpt
  • func WithSignerPrefix(prefix []byte) SignerOpt
• type VRFSigner
  • func (s VRFSigner) LittleEndian() bool
  • func (s VRFSigner) PublicKey() *PublicKey
  • func (s VRFSigner) Sign(msg []byte) []byte
• type VRFVerifier
  • func (VRFVerifier) Verify(pub *PublicKey, msg, sig []byte) bool
• type Verifier
• type VerifierOpt
  • func WithVerifierPrefix(prefix []byte) VerifierOpt
• type VerifyExtractor

Constants

const PrivateKeySize = ed25519.PrivateKeySize

PrivateKeySize size of the private key in bytes.

Variables

var DefaultVerifier = EDVerifier{}

DefaultVerifier used by ExtractPublicKey.

Functions

func ExtractPublicKey

func ExtractPublicKey(msg, sig []byte) (ed25519.PublicKey, error)

ExtractPublicKey using DefaultVerifier Extract method.

func Public

func Public(priv PrivateKey) ed25519.PublicKey

Public returns public key part from ed25519 private key.

func VRFVerify

func VRFVerify(pub, msg, sig []byte) bool

VRFVerify verifies a message and signature, given a public key.

Types

type EDVerifier

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

EDVerifier is a verifier for ED purposes.

func NewEDVerifier

func NewEDVerifier(opts ...VerifierOpt) EDVerifier

NewEDVerifier returns a new EDVerifier.

func (EDVerifier) Extract

func (e EDVerifier) Extract(msg, sig []byte) (*PublicKey, error)

Extract public key from signature.

type EdSigner

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

EdSigner represents an ED25519 signer.

func NewEdSigner

func NewEdSigner(opts ...SignerOpt) *EdSigner

NewEdSigner returns an auto-generated ed signer.

func NewEdSignerFromBuffer

func NewEdSignerFromBuffer(buff []byte, opts ...SignerOpt) (*EdSigner, error)

NewEdSignerFromBuffer builds a signer from a private key as byte buffer.

func NewEdSignerFromRand

func NewEdSignerFromRand(rand io.Reader) *EdSigner

NewEdSignerFromRand generate signer using predictable randomness source.

func (*EdSigner) LittleEndian

func (es *EdSigner) LittleEndian() bool

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

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(m []byte) []byte

Sign signs the provided message.

func (*EdSigner) ToBuffer

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

ToBuffer returns the private key as a byte buffer.

func (*EdSigner) VRFSigner

func (es *EdSigner) VRFSigner() *VRFSigner

VRFSigner wraps same ed25519 key to provide ecvrf.

type PrivateKey

type PrivateKey = ed25519.PrivateKey

PrivateKey is an alias to spacemeshos/ed25519.PrivateKey.

type PublicKey

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

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 Signer

type Signer interface {
	Sign([]byte) []byte
	PublicKey() *PublicKey
	LittleEndian() bool
}

Signer is a common interface for signature generation.

type SignerOpt

type SignerOpt func(*EdSigner)

SignerOpt modifies EdSigner.

func WithSignerPrefix

func WithSignerPrefix(prefix []byte) SignerOpt

WithSignerPrefix sets used by EdSigner.

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) PublicKey

func (s VRFSigner) PublicKey() *PublicKey

PublicKey of the signer.

func (VRFSigner) Sign

func (s VRFSigner) Sign(msg []byte) []byte

Sign signs a message for VRF purposes.

type VRFVerifier

type VRFVerifier struct{}

VRFVerifier is a verifier for VRF purposes.

func (VRFVerifier) Verify

func (VRFVerifier) Verify(pub *PublicKey, msg, sig []byte) bool

Verify that signature matches public key.

type Verifier

type Verifier interface {
	Verify(pub *PublicKey, msg, sig []byte) bool
}

Verifier is a common interface for signature verification.

type VerifierOpt

type VerifierOpt func(*EDVerifier)

VerifierOpt to modify verifier.

func WithVerifierPrefix

func WithVerifierPrefix(prefix []byte) VerifierOpt

WithVerifierPrefix ...

type VerifyExtractor

type VerifyExtractor interface {
	Extract(msg, sig []byte) (*PublicKey, error)
}

VerifyExtractor is a common interface for signature verification with support of public key extraction.