-rw-r--r-- 2394 libntruprime-20240910/doc/man/sntrup.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 "sntrup" "1" "" "" ""
.hy
.SS NAME
.PP
sntrup - command-line interface for the libntruprime implementation of
the Streamlined NTRU Prime cryptosystem
.SS SYNOPSIS
.PP
Key generation (for, e.g., \f[V]sntrup1277\f[R]):
.IP
.nf
\f[C]
sntrup1277-keypair 5>publickey 9>secretkey
\f[R]
.fi
.PP
Encapsulation (for, e.g., \f[V]sntrup1277\f[R]):
.IP
.nf
\f[C]
sntrup1277-enc >ciphertext 7>sessionkey 4<publickey
\f[R]
.fi
.PP
Decapsulation (for, e.g., \f[V]sntrup1277\f[R]):
.IP
.nf
\f[C]
sntrup1277-dec 7>sessionkey <ciphertext 8<secretkey
\f[R]
.fi
.SS DESCRIPTION
.PP
libntruprime is an implementation of the Streamlined NTRU
Prime (https://ntruprime.cr.yp.to) cryptosystem.
The command-line interface for libntruprime provides the following
command-line tools:
.IP
.nf
\f[C]
sntrup{653,761,857,953,1013,1277}-keypair
sntrup{653,761,857,953,1013,1277}-enc
sntrup{653,761,857,953,1013,1277}-dec
\f[R]
.fi
.PP
Each tool exits 0 on success, nonzero on failure.
.PP
These tools allow libntruprime to be easily used from shell scripts.
Other languages can also use libntruprime via these tools, but languages
typically have good support for FFI and can use the C interface
directly.
.PP
The details below use \f[V]sntrup1277\f[R] as an example.
.SS KEY GENERATION
.PP
Alice runs the \f[V]sntrup1277-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 ENCAPSULATION
.PP
Bob runs the \f[V]sntrup1277-enc\f[R] command.
This command reads Alice\[cq]s public key from file descriptor 4.
It randomly generates a ciphertext and the corresponding session key.
It writes the ciphertext to stdout, and then writes the session key to
file descriptor 7.
.SS DECAPSULATION
.PP
Alice runs the \f[V]sntrup1277-dec\f[R] command.
This command reads Alice\[cq]s secret key from file descriptor 8, and
then reads a ciphertext from stdin.
It computes the corresponding session key, which it writes to file
descriptor 7.
.SS SEE ALSO
.PP
\f[B]sntrup\f[R](3)