README
¶
ed25519
A drop-in replacement for crypto/ed25519 (godoc, github) with additional functionality. Uses SHA-512 and ECDSA signing algorithm.
Motivation
In order to verify the validity of a given signature, the validator should posses the public key of the signer. It can be sent along with the message and its signature, which means that the overall data being sent includes 256 bits of the public key. Our function allows to extract the public key from the signature (and the message), thus the public key may not be sent, resulting in a smaller transferred data. Note: there's a computational cost for extracting the public key, so one should consider the trade-off between computations and data size.
Usage
import "github.com/spacemeshos/ed25519"
Import package ed25519 from github.com/spacemeshos/ed25519 instead of crypto/ed25519.
Sign2
Sign2 signs the message with privateKey and returns a signature. The signature may be verified using Verify2(), if the signer's public key is known. The signature returned by this method can be used together with the message to extract the public key using ExtractPublicKey() It will panic if len(privateKey) is not PrivateKeySize.
func Sign2(privateKey PrivateKey, message []byte) []byte
ExtractPublicKey
ExtractPublicKey extracts the signer's public key given a message and its signature. It will panic if len(sig) is not SignatureSize.
func ExtractPublicKey(message, sig []byte) PublicKey
Verify2
Verify2 verifies a signature created with Sign2(), assuming the verifier possesses the public key.
func Verify2(publicKey PublicKey, message, sig []byte) bool
Building
go build
Testing
go test ./... -v
Benchmarking
go test -bench=.
go test -bench . github.com/spacemeshos/ed25519/internal/edwards25519
BenchmarkPublicKeyExtraction-12 3000 447515 ns/op
BenchmarkSigning-12 30000 46100 ns/op
BenchmarkSigningExt-12 30000 45357 ns/op
BenchmarkKeyGeneration-12 30000 44649 ns/op
BenchmarkVerification-12 10000 120082 ns/op
BenchmarkVerificationExt-12 10000 118761 ns/op
Client Example
Documentation
¶
Overview ¶
Package ed25519 implements the Ed25519 signature algorithm. See https://ed25519.cr.yp.to/.
These functions are also compatible with the “Ed25519” function defined in RFC 8032. However, unlike RFC 8032's formulation, this package's private key representation includes a public key suffix to make multiple signing operations with the same key more efficient.
Index ¶
- Constants
- func GenerateKey(rand io.Reader) (PublicKey, PrivateKey, error)
- func Sign(privateKey PrivateKey, message []byte) []byte
- func Sign2(privateKey PrivateKey, message []byte) []byte
- func Verify(publicKey PublicKey, message, sig []byte) bool
- func Verify2(publicKey PublicKey, message, sig []byte) bool
- type PrivateKey
- type PublicKey
Constants ¶
const ( // PublicKeySize is the size, in bytes, of public keys as used in this package. PublicKeySize = ed25519.PublicKeySize // PrivateKeySize is the size, in bytes, of private keys as used in this package. PrivateKeySize = ed25519.PrivateKeySize // SignatureSize is the size, in bytes, of signatures generated and verified by this package. SignatureSize = ed25519.SignatureSize // SeedSize is the size, in bytes, of private key seeds. These are the private key representations used by RFC 8032. SeedSize = ed25519.SeedSize )
Variables ¶
This section is empty.
Functions ¶
func GenerateKey ¶
func GenerateKey(rand io.Reader) (PublicKey, PrivateKey, error)
GenerateKey generates a public/private key pair using entropy from rand. If rand is nil, crypto/rand.Reader will be used.
func Sign ¶
func Sign(privateKey PrivateKey, message []byte) []byte
Sign signs the message with privateKey and returns a signature. It will panic if len(privateKey) is not PrivateKeySize.
func Sign2 ¶
func Sign2(privateKey PrivateKey, message []byte) []byte
Sign2 signs the message with privateKey and returns a signature. The signature may be verified using Verify2(), if the signer's public key is known. The signature returned by this method can be used together with the message to extract the public key using ExtractPublicKey() It will panic if len(privateKey) is not PrivateKeySize.
Types ¶
type PrivateKey ¶
type PrivateKey = ed25519.PrivateKey
PrivateKey is the type of Ed25519 private keys. It implements crypto.Signer.
func NewDerivedKeyFromSeed ¶
func NewDerivedKeyFromSeed(seed []byte, index uint64, salt []byte) PrivateKey
NewDerivedKeyFromSeed calculates a private key from a 32 bytes random seed, an integer index and salt
func NewKeyFromSeed ¶
func NewKeyFromSeed(seed []byte) PrivateKey
NewKeyFromSeed calculates a private key from a seed. It will panic if len(seed) is not SeedSize. This function is provided for interoperability with RFC 8032. RFC 8032's private keys correspond to seeds in this package.
type PublicKey ¶
PublicKey is the type of Ed25519 public keys.
func ExtractPublicKey ¶
ExtractPublicKey extracts the signer's public key given a message and its signature. Note that signature must be created using Sign2() and NOT using Sign(). It will panic if len(sig) is not SignatureSize.
Source Files
Directories