.\" Automatically generated by Pandoc 2.17.1.1
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "ed25519-cli" "1" "" "" ""
.hy
.SS NAME
.PP
ed25519-cli - command-line interface for the lib25519 implementation of
the Ed25519 signature system
.SS SYNOPSIS
.PP
Key generation:
.IP
.nf
\f[C]
ed25519-keypair 5>publickey 9>secretkey
\f[R]
.fi
.PP
Signature generation:
.IP
.nf
\f[C]
ed25519-sign 8<secretkey <message >signedmessage
\f[R]
.fi
.PP
Signature verification and message recovery:
.IP
.nf
\f[C]
ed25519-open 4<publickey <signedmessage >message
\f[R]
.fi
.SS DESCRIPTION
.PP
lib25519 is an implementation of the X25519 encryption system and the
Ed25519 signature system.
The command-line interface for lib25519 provides three Ed25519 tools,
documented here, and two X25519 tools, documented separately.
.PP
Each tool exits nonzero on failure (e.g., running out of memory), 0 on
success.
.PP
These tools allow lib25519 to be easily used from shell scripts.
Other languages can also use lib25519 via these tools, but languages
typically have good support for FFI and can use the C interface
directly.
.SS KEY GENERATION
.PP
Alice runs the \f[V]ed25519-keypair\f[R] command.
This command randomly generates Alice\[cq]s secret key and Alice\[cq]s
corresponding public key.
It writes the public key to file descriptor 5, and then writes the
secret key to file descriptor 9.
.SS SIGNATURE GENERATION
.PP
Alice runs the \f[V]ed25519-sign\f[R] command.
This command reads Alice\[cq]s secret key from file descriptor 8.
It then reads a message (into memory) from standard input (file
descriptor 0).
It signs the message using Alice\[cq]s secret key, and then writes the
signed message to standard output (file descriptor 1).
.SS SIGNATURE VERIFICATION AND MESSAGE RECOVERY
.PP
Bob runs the \f[V]ed25519-open\f[R] command.
This command reads Alice\[cq]s public key from file descriptor 4.
It then reads a signed message (into memory) from standard input (file
descriptor 0).
It verifies the signed message using Alice\[cq]s public key, and then
writes the verified message to standard output (file descriptor 1).
.PP
For \f[V]ed25519-open\f[R], exit code 100 specifically indicates an
invalid signature; retrying on the same input will then always fail.
In this case, \f[V]ed25519-open\f[R] produces an empty output.
.SS SEE ALSO
.PP
\f[B]x25519-cli\f[R](1), \f[B]lib25519\f[R](3)