package ed25519

Import Path
	crypto/ed25519 (on go.dev)

Dependency Relation
	imports 8 packages, and imported by 2 packages

Involved Source Files

	   #d ed25519.go
		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. This package refers to the RFC
		8032 private key as the “seed”.
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type PrivateKey ([]T)
		PrivateKey is the type of Ed25519 private keys. It implements crypto.Signer.

		Methods (total 4, all are exported)
			( T) Equal(x crypto.PrivateKey) bool
				Equal reports whether priv and x have the same value.

			( T) Public() crypto.PublicKey
				Public returns the PublicKey corresponding to priv.

			( T) Seed() []byte
				Seed returns the private key seed corresponding to priv. It is provided for
				interoperability with RFC 8032. RFC 8032's private keys correspond to seeds
				in this package.

			( T) Sign(rand io.Reader, message []byte, opts crypto.SignerOpts) (signature []byte, err error)
				Sign signs the given message with priv.
				Ed25519 performs two passes over messages to be signed and therefore cannot
				handle pre-hashed messages. Thus opts.HashFunc() must return zero to
				indicate the message hasn't been hashed. This can be achieved by passing
				crypto.Hash(0) as the value for opts.

		Implements (at least one exported)
			 T : crypto.Signer
		As Outputs Of (at least 2, both are exported)
			func GenerateKey(rand io.Reader) (PublicKey, PrivateKey, error)
			func NewKeyFromSeed(seed []byte) PrivateKey
		As Inputs Of (at least one exported)
			func Sign(privateKey PrivateKey, message []byte) []byte

	 type PublicKey ([]T)
		PublicKey is the type of Ed25519 public keys.

		Methods (only one, which is exported)
			( T) Equal(x crypto.PublicKey) bool
				Equal reports whether pub and x have the same value.

		As Outputs Of (at least one exported)
			func GenerateKey(rand io.Reader) (PublicKey, PrivateKey, error)
		As Inputs Of (at least one exported)
			func Verify(publicKey PublicKey, message, sig []byte) bool


Package-Level Functions (total 6, in which 4 are exported)

	 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 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.

	 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 Verify(publicKey PublicKey, message, sig []byte) bool
		Verify reports whether sig is a valid signature of message by publicKey. It
		will panic if len(publicKey) is not PublicKeySize.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func newKeyFromSeed(privateKey, seed []byte)
	 func sign(signature, privateKey, message []byte)
Package-Level Constants (total 4, all are exported)

	const PrivateKeySize = 64
		PrivateKeySize is the size, in bytes, of private keys as used in this package.

	const PublicKeySize = 32
		PublicKeySize is the size, in bytes, of public keys as used in this package.

	const SeedSize = 32
		SeedSize is the size, in bytes, of private key seeds. These are the private key representations used by RFC 8032.

	const SignatureSize = 64
		SignatureSize is the size, in bytes, of signatures generated and verified by this package.

The pages are generated with Golds v0.4.2. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.