]> Cypherpunks.ru repositories - nncp.git/blobdiff - doc/cmds.texi
AEAD encryption mode and new encrypted packet format
[nncp.git] / doc / cmds.texi
index 757f528a4626bdec1d39030d2141cfe3741412fb..9628fa0b2f2a7a41d62afce76acc35f4c30ee076 100644 (file)
@@ -299,12 +299,13 @@ This command queues file in @ref{Spool, spool} directory immediately
 If @file{SRC} equals to @file{-}, then create an encrypted temporary
 file and copy everything taken from stdin to it and use for outbound
 packet creation. Pay attention that if you want to send 1 GiB of data
-taken from stdin, then you have to have 2 GiB of disk space for that
-temporary file and resulting encrypted packet. You can control where
-temporary file will be stored using @env{TMPDIR} environment variable.
-Encryption is performed with @url{https://cr.yp.to/chacha.html,
-ChaCha20} algorithm. Data is splitted on 128 KiB blocks. Each block is
-encrypted with increasing nonce counter.
+taken from stdin, then you have to have more than 2 GiB of disk space
+for that temporary file and resulting encrypted packet. You can control
+where temporary file will be stored using @env{TMPDIR} environment
+variable. Encryption is performed in AEAD mode with
+@url{https://cr.yp.to/chacha.html, ChaCha20}-@url{https://en.wikipedia.org/wiki/Poly1305, Poly1305}
+algorithms. Data is splitted on 128 KiB blocks. Each block is encrypted
+with increasing nonce counter.
 
 If @option{-chunked} is specified, then source file will be split
 @ref{Chunked, on chunks}. @option{INT} is the desired chunk size in
@@ -348,6 +349,7 @@ Parse @ref{Log, log} file and print out its records in human-readable form.
 @verbatim
 % nncp-pkt [options] < pkt
 % nncp-pkt [options] [-decompress] -dump < pkt > payload
+% nncp-pkt -overheads
 @end verbatim
 
 Low level packet parser. Normally it should not be used, but can help in
@@ -380,6 +382,8 @@ And with the @option{-dump} option it will give you the actual payload
 tries to zlib-decompress the data from plain packet (useful for mail
 packets).
 
+@option{-overheads} options print encrypted, plain and size header overheads.
+
 @node nncp-reass
 @section nncp-reass
 
@@ -492,7 +496,7 @@ size) are in inbound (Rx) and outbound (Tx) queues.
     [-seen]
     [-nofile]
     [-nofreq]
-    [-nomail]
+    [-noexec]
     [-notrns]
 @end verbatim
 
@@ -514,7 +518,7 @@ successful tossing of @file{XXX} packet. @ref{nncp-xfer},
 inbound packets that has been already seen, processed and tossed. This
 is helpful to prevent duplicates.
 
-@option{-nofile}, @option{-nofreq}, @option{-nomail}, @option{-notrns}
+@option{-nofile}, @option{-nofreq}, @option{-noexec}, @option{-notrns}
 options allow to disable any kind of packet types processing.
 
 @node nncp-xfer