ed25519

package
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 29, 2024 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

View Source
const (
	PrivKeyName = "tendermint/PrivKeyEd25519"
	PubKeyName  = "tendermint/PubKeyEd25519"
	// PubKeySize is is the size, in bytes, of public keys as used in this package.
	PubKeySize = 32
	// PrivateKeySize is the size, in bytes, of private keys as used in this package.
	PrivateKeySize = 64
	// Size of an Edwards25519 signature. Namely the size of a compressed
	// Edwards25519 point, and a field element. Both of which are 32 bytes.
	SignatureSize = 64
	// SeedSize is the size, in bytes, of private key seeds. These are the
	// private key representations used by RFC 8032.
	SeedSize = 32

	KeyType = "ed25519"
)

Variables

This section is empty.

Functions

func NewBatchVerifier

func NewBatchVerifier() crypto.BatchVerifier

Types

type BatchVerifier

type BatchVerifier struct {
	*ed25519.BatchVerifier
}

BatchVerifier implements batch verification for ed25519.

func (*BatchVerifier) Add

func (b *BatchVerifier) Add(key crypto.PubKey, msg, signature []byte) error

func (*BatchVerifier) Verify

func (b *BatchVerifier) Verify() (bool, []bool)

type PrivKey

type PrivKey []byte

PrivKey implements crypto.PrivKey.

func FromBip39Mnemonic

func FromBip39Mnemonic(mnemonic, passphrase, path string) (PrivKey, error)

FromBip39Mnemonic derives an ed25519 key from BIP39 mnemonic, following SLIP10 specification.

func FromDER

func FromDER(der []byte) (PrivKey, error)

FromDER loads ed25519 private key from DER-encoded buffer

func GenPrivKey

func GenPrivKey() PrivKey

GenPrivKey generates a new ed25519 private key. It uses OS randomness in conjunction with the current global random seed in tendermint/libs/common to generate the private key.

func GenPrivKeyFromSecret

func GenPrivKeyFromSecret(secret []byte) PrivKey

GenPrivKeyFromSecret hashes the secret with SHA2, and uses that 32 byte output to create the private key. NOTE: secret should be the output of a KDF like bcrypt, if it's derived from user input.

func (PrivKey) Bytes

func (privKey PrivKey) Bytes() []byte

Bytes returns the privkey byte format.

func (PrivKey) Equals

func (privKey PrivKey) Equals(other crypto.PrivKey) bool

Equals - you probably don't need to use this. Runs in constant time based on length of the keys.

func (PrivKey) PubKey

func (privKey PrivKey) PubKey() crypto.PubKey

PubKey gets the corresponding public key from the private key.

Panics if the private key is not initialized.

func (PrivKey) Sign

func (privKey PrivKey) Sign(msg []byte) ([]byte, error)

Sign produces a signature on the provided message. This assumes the privkey is wellformed in the golang format. The first 32 bytes should be random, corresponding to the normal ed25519 private key. The latter 32 bytes should be the compressed public key. If these conditions aren't met, Sign will panic or produce an incorrect signature.

func (PrivKey) SignDigest

func (privKey PrivKey) SignDigest(msg []byte) ([]byte, error)

Sign produces a signature on the provided message. This assumes the privkey is wellformed in the golang format. The first 32 bytes should be random, corresponding to the normal ed25519 private key. The latter 32 bytes should be the compressed public key. If these conditions aren't met, Sign will panic or produce an incorrect signature.

func (PrivKey) Type

func (privKey PrivKey) Type() string

func (PrivKey) TypeTag

func (PrivKey) TypeTag() string

TypeTag satisfies the jsontypes.Tagged interface.

func (PrivKey) TypeValue

func (privKey PrivKey) TypeValue() crypto.KeyType

type PubKey

type PubKey []byte

PubKey implements crypto.PubKey for the Ed25519 signature scheme.

func (PubKey) Address

func (pubKey PubKey) Address() crypto.Address

Address is the SHA256-20 of the raw pubkey bytes.

func (PubKey) Bytes

func (pubKey PubKey) Bytes() []byte

Bytes returns the PubKey byte format.

func (PubKey) Equals

func (pubKey PubKey) Equals(other crypto.PubKey) bool

func (PubKey) HexString

func (pubKey PubKey) HexString() string

HexString returns hex-string representation of pubkey

func (PubKey) String

func (pubKey PubKey) String() string

func (PubKey) Type

func (pubKey PubKey) Type() string

func (PubKey) TypeTag

func (PubKey) TypeTag() string

TypeTag satisfies the jsontypes.Tagged interface.

func (PubKey) TypeValue

func (pubKey PubKey) TypeValue() crypto.KeyType

func (PubKey) VerifySignature

func (pubKey PubKey) VerifySignature(msg []byte, sig []byte) bool

func (PubKey) VerifySignatureDigest

func (pubKey PubKey) VerifySignatureDigest(hash []byte, sig []byte) bool

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL