ecdsa

Documentation

Overview

Package ecdsa provides a crypto implementation for HotStuff using Go's 'crypto/ecdsa' package.

Index

• Constants
• func New() consensus.CryptoImpl
• type Signature
  • func RestoreSignature(r, s *big.Int, signer hotstuff.ID) *Signature
  • func (sig Signature) R() *big.Int
  • func (sig Signature) S() *big.Int
  • func (sig Signature) Signer() hotstuff.ID
  • func (sig Signature) ToBytes() []byte
• type ThresholdSignature
  • func RestoreThresholdSignature(signatures []*Signature) ThresholdSignature
  • func (sig ThresholdSignature) Add(id hotstuff.ID)
  • func (sig ThresholdSignature) Contains(id hotstuff.ID) bool
  • func (sig ThresholdSignature) ForEach(f func(hotstuff.ID))
  • func (sig ThresholdSignature) Participants() consensus.IDSet
  • func (sig ThresholdSignature) ToBytes() []byte

Constants

const (
	// PrivateKeyFileType is the PEM type for a private key.
	PrivateKeyFileType = "ECDSA PRIVATE KEY"

	// PublicKeyFileType is the PEM type for a public key.
	PublicKeyFileType = "ECDSA PUBLIC KEY"
)

Functions

func New

func New() consensus.CryptoImpl

New returns a new signer and a new verifier.

Types

type Signature

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

Signature is an ECDSA signature

func RestoreSignature

func RestoreSignature(r, s *big.Int, signer hotstuff.ID) *Signature

RestoreSignature restores an existing signature. It should not be used to create new signatures, use Sign instead.

func (Signature) R

func (sig Signature) R() *big.Int

R returns the r value of the signature

func (Signature) S

func (sig Signature) S() *big.Int

S returns the s value of the signature

func (Signature) Signer

func (sig Signature) Signer() hotstuff.ID

Signer returns the ID of the replica that generated the signature.

func (Signature) ToBytes

func (sig Signature) ToBytes() []byte

ToBytes returns a raw byte string representation of the signature

type ThresholdSignature

type ThresholdSignature map[hotstuff.ID]*Signature

ThresholdSignature is a set of (partial) signatures that form a valid threshold signature when there are a quorum of valid (partial) signatures.

func RestoreThresholdSignature

func RestoreThresholdSignature(signatures []*Signature) ThresholdSignature

RestoreThresholdSignature should only be used to restore an existing threshold signature from a set of signatures. To create a new verifiable threshold signature, use CreateThresholdSignature instead.

func (ThresholdSignature) Add

func (sig ThresholdSignature) Add(id hotstuff.ID)

Add adds an ID to the set.

func (ThresholdSignature) Contains

func (sig ThresholdSignature) Contains(id hotstuff.ID) bool

Contains returns true if the set contains the ID.

func (ThresholdSignature) ForEach

func (sig ThresholdSignature) ForEach(f func(hotstuff.ID))

ForEach calls f for each ID in the set.

func (ThresholdSignature) Participants

func (sig ThresholdSignature) Participants() consensus.IDSet

Participants returns the IDs of replicas who participated in the threshold signature.

func (ThresholdSignature) ToBytes

func (sig ThresholdSignature) ToBytes() []byte

ToBytes returns the object as bytes.