secp256k1

Documentation

Index

• Constants
• type PrivKey
  • func GenPrivKey() PrivKey
  • func GenPrivKeySecp256k1(secret []byte) PrivKey
  • func (privKey PrivKey) Bytes() []byte
  • func (privKey PrivKey) Equals(other crypto.PrivKey) bool
  • func (privKey PrivKey) PubKey() crypto.PubKey
  • func (privKey PrivKey) Sign(msg []byte) ([]byte, error)
  • func (privKey PrivKey) SignDigest(msg []byte) ([]byte, error)
  • func (privKey PrivKey) Type() string
  • func (PrivKey) TypeTag() string
  • func (privKey PrivKey) TypeValue() crypto.KeyType
• type PubKey
  • func (pubKey PubKey) Address() crypto.Address
  • func (pubKey PubKey) AggregateSignatures(_sigSharesData [][]byte, _messages [][]byte) ([]byte, error)
  • func (pubKey PubKey) Bytes() []byte
  • func (pubKey PubKey) Equals(other crypto.PubKey) bool
  • func (pubKey PubKey) HexString() string
  • func (pubKey PubKey) String() string
  • func (pubKey PubKey) Type() string
  • func (PubKey) TypeTag() string
  • func (pubKey PubKey) TypeValue() crypto.KeyType
  • func (pubKey PubKey) VerifyAggregateSignature(_messages [][]byte, _sig []byte) bool
  • func (pubKey PubKey) VerifySignature(msg []byte, sigStr []byte) bool
  • func (pubKey PubKey) VerifySignatureDigest(_hash []byte, _sig []byte) bool

Constants

const (
	PrivKeyName = "tendermint/PrivKeySecp256k1"
	PubKeyName  = "tendermint/PubKeySecp256k1"

	KeyType     = "secp256k1"
	PrivKeySize = 32
)

-------------------------------------

const PubKeySize = 33

PubKeySize is comprised of 32 bytes for one field element (the x-coordinate), plus one byte for the parity of the y-coordinate.

Types

type PrivKey

type PrivKey []byte

PrivKey implements PrivKey.

func GenPrivKey

func GenPrivKey() PrivKey

GenPrivKey generates a new ECDSA private key on curve secp256k1 private key. It uses OS randomness to generate the private key.

func GenPrivKeySecp256k1

func GenPrivKeySecp256k1(secret []byte) PrivKey

GenPrivKeySecp256k1 hashes the secret with SHA2, and uses that 32 byte output to create the private key.

It makes sure the private key is a valid field element by setting:

c = sha256(secret) k = (c mod (n − 1)) + 1, where n = curve order.

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 marshalls the private key using amino encoding.

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 performs the point-scalar multiplication from the privKey on the generator point to get the pubkey.

func (PrivKey) Sign

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

Sign creates an ECDSA signature on curve Secp256k1, using SHA256 on the msg. The returned signature will be of the form R || S (in lower-S form).

func (PrivKey) SignDigest

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

SignDigest creates an ECDSA signature on curve Secp256k1. The returned signature will be of the form R || S (in lower-S form).

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. It 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 (PubKey) Address

func (pubKey PubKey) Address() crypto.Address

Address returns a Bitcoin style addresses: RIPEMD160(SHA256(pubkey))

func (PubKey) AggregateSignatures

func (pubKey PubKey) AggregateSignatures(_sigSharesData [][]byte, _messages [][]byte) ([]byte, error)

func (PubKey) Bytes

func (pubKey PubKey) Bytes() []byte

Bytes returns the pubkey marshaled with amino encoding.

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

func (pubKey PubKey) VerifyAggregateSignature(_messages [][]byte, _sig []byte) bool

func (PubKey) VerifySignature

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

VerifySignature verifies a signature of the form R || S. It rejects signatures which are not in lower-S form.

func (PubKey) VerifySignatureDigest

func (pubKey PubKey) VerifySignatureDigest(_hash []byte, _sig []byte) bool