-rw-r--r-- 1806 lib25519-20241004/doc/man/x25519.1 raw
.\" 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 "x25519-cli" "1" "" "" ""
.hy
.SS NAME
.PP
x25519-cli - command-line interface for the lib25519 implementation of
the X25519 encryption system
.SS SYNOPSIS
.PP
Key generation:
.IP
.nf
\f[C]
x25519-keypair 5>publickey 9>secretkey
\f[R]
.fi
.PP
Shared-secret generation for Alice:
.IP
.nf
\f[C]
x25519-dh 8<alicesecret 4<bobpublic 7>sharedsecret
\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 two X25519 tools,
documented here, and three Ed25519 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]x25519-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 SHARED-SECRET GENERATION
.PP
Alice runs the \f[V]x25519-dh\f[R] command.
This command reads Alice\[cq]s secret key from file descriptor 8.
It then reads Bob\[cq]s public key from file descriptor 4.
It then writes a secret shared between Alice and Bob to file descriptor
7.
.SS SEE ALSO
.PP
\f[B]ed25519-cli\f[R](1), \f[B]lib25519\f[R](3)