ed25519

package

v0.2.13 Latest Latest Go to latest Published: Jan 11, 2023 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation ¶

Index ¶

Constants
Variables
type PrivKey
- func GenPrivKey() *PrivKey
- func GenPrivKeyFromSecret(secret []byte) *PrivKey
type PubKey
- func FromTmEd25519(pubKey crypto.PubKey) (*PubKey, error)

Constants ¶

const (
	PrivKeyName = "cosmos/PrivKeyEd25519"
	PubKeyName  = "cosmos/PubKeyEd25519"
	// PubKeySize is is the size, in bytes, of public keys as used in this package.
	PubKeySize = 32
	// PrivKeySize is the size, in bytes, of private keys as used in this package.
	PrivKeySize = 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
)

Variables ¶

View Source

var (
	ErrInvalidLengthKeys        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowKeys          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupKeys = fmt.Errorf("proto: unexpected end of group")
)

Functions ¶

This section is empty.

Types ¶

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) Descriptor ¶

func (*PrivKey) Descriptor() ([]byte, []int)

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) GetKey ¶

func (m *PrivKey) GetKey() []byte

func (*PrivKey) Marshal ¶

func (m *PrivKey) Marshal() (dAtA []byte, err error)

func (PrivKey) MarshalAmino ¶

func (privKey PrivKey) MarshalAmino() ([]byte, error)

MarshalAmino overrides Amino binary marshalling.

func (PrivKey) MarshalAminoJSON ¶

func (privKey PrivKey) MarshalAminoJSON() ([]byte, error)

MarshalAminoJSON overrides Amino JSON marshalling.

func (*PrivKey) MarshalTo ¶

func (m *PrivKey) MarshalTo(dAtA []byte) (int, error)

func (*PrivKey) MarshalToSizedBuffer ¶

func (m *PrivKey) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*PrivKey) ProtoMessage ¶

func (*PrivKey) ProtoMessage()

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) Reset ¶

func (m *PrivKey) Reset()

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) Size ¶

func (m *PrivKey) Size() (n int)

func (*PrivKey) String ¶

func (m *PrivKey) String() string

func (*PrivKey) Type ¶

func (privKey *PrivKey) Type() string

func (*PrivKey) Unmarshal ¶

func (m *PrivKey) Unmarshal(dAtA []byte) error

func (*PrivKey) UnmarshalAmino ¶

func (privKey *PrivKey) UnmarshalAmino(bz []byte) error

UnmarshalAmino overrides Amino binary marshalling.

func (*PrivKey) UnmarshalAminoJSON ¶

func (privKey *PrivKey) UnmarshalAminoJSON(bz []byte) error

UnmarshalAminoJSON overrides Amino JSON marshalling.

func (*PrivKey) XXX_DiscardUnknown ¶

func (m *PrivKey) XXX_DiscardUnknown()

func (*PrivKey) XXX_Marshal ¶

func (m *PrivKey) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PrivKey) XXX_Merge ¶

func (m *PrivKey) XXX_Merge(src proto.Message)

func (*PrivKey) XXX_Size ¶

func (m *PrivKey) XXX_Size() int

func (*PrivKey) XXX_Unmarshal ¶

func (m *PrivKey) XXX_Unmarshal(b []byte) error

type PubKey ¶

type PubKey struct {
	Key []byte `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
}

PubKey defines a ed25519 public key Key is the compressed form of the pubkey. The first byte depends is a 0x02 byte if the y-coordinate is the lexicographically largest of the two associated with the x-coordinate. Otherwise the first byte is a 0x03. This prefix is followed with the x-coordinate.

func FromTmEd25519 ¶

func FromTmEd25519(pubKey crypto.PubKey) (*PubKey, error)

FromTmEd25519 converts a Tendermint ED25519 pubkey into our own ED25519 PubKey.

func (*PubKey) Address ¶

func (pubKey *PubKey) Address() crypto.Address

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

func (*PubKey) AsTmPubKey ¶

func (pubKey *PubKey) AsTmPubKey() crypto.PubKey

AsTmPubKey converts our own PubKey into a Tendermint ED25519 pubkey.

func (*PubKey) Bytes ¶

func (pubKey *PubKey) Bytes() []byte

Bytes returns the PubKey byte format.

func (*PubKey) Descriptor ¶

func (*PubKey) Descriptor() ([]byte, []int)

func (*PubKey) Equals ¶

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

func (*PubKey) GetKey ¶

func (m *PubKey) GetKey() []byte

func (*PubKey) Marshal ¶

func (m *PubKey) Marshal() (dAtA []byte, err error)

func (PubKey) MarshalAmino ¶

func (pubKey PubKey) MarshalAmino() ([]byte, error)