4 Nearly all commands have the following common options:
8 Path to configuration file. May be overridden by @env{NNCPCFG}
9 environment variable. If file file is an encrypted @ref{EBlob,
10 eblob}, then ask for passphrase to decrypt it first.
12 Print debug messages. Normally this option should not be used.
15 Minimal required resulting packet size, in KiBs. For example if you
16 send 2 KiB file and set @option{-minsize 4}, then resulting packet
17 will be 4 KiB (containing file itself and some junk).
19 Set desired outgoing packet @ref{Niceness, niceness level}.
21 Set desired reply packet @ref{Niceness, niceness level}. Only freq
22 and exec packets look at that niceness level.
24 Override @ref{CfgVia, via} configuration option for destination node.
25 Specified nodes must be separated with comma: @verb{|NODE1,NODE2|}.
26 With @verb{|-via -|} you can disable relaying at all.
28 Override path to spool directory. May be specified by
29 @env{NNCPSPOOL} environment variable.
31 Override path to logfile. May be specified by @env{NNCPLOG}
34 Print only errors, omit simple informational messages. In any case
35 those messages are logged, so you can reread them using
36 @ref{nncp-log} command.
37 @item -progress, -noprogress
38 Either force progress showing, or disable it.
40 Print version information.
42 Print warranty information (no warranty).
49 $ nncp-bundle [options] -tx [-delete] NODE [NODE ...] > ...
50 $ nncp-bundle [options] -rx -delete [-dryrun] [NODE ...] < ...
51 $ nncp-bundle [options] -rx [-check] [-dryrun] [NODE ...] < ...
54 With @option{-tx} option, this command creates @ref{Bundles, bundle} of
55 @ref{Encrypted, encrypted packets} from the spool directory and writes
58 With @option{-rx} option, this command takes bundle from @code{stdin}
59 and copies all found packets for our node to the spool directory. Pay
60 attention that @strong{no} integrity checking is done by default. Modern
61 tape drives could easily provide too much throughput your CPU won't be
62 able to verify on the fly. So if you won't @ref{nncp-toss, toss}
63 received packets at the place, it is advisable either to run
64 @ref{nncp-check} utility for packets integrity verification, or to use
65 @option{-check} option to enable on the fly integrity check.
67 You can specify multiple @option{NODE} arguments, telling for what nodes
68 you want to create the stream, or take it from. If no nodes are
69 specified for @option{-rx} mode, then all packets aimed at us will be
72 When packets are sent through the stream, they are still kept in the
73 spool directory, because there is no assurance that they are transferred
74 to the media (media (CD-ROM, tape drive, raw hard drive) can end). If
75 you want to forcefully delete them (after they are successfully flushed
76 to @code{stdout}) anyway, use @option{-delete} option.
78 But you can verify produced stream after, by digesting it by yourself
79 with @option{-rx} and @option{-delete} options -- in that mode, stream
80 packets integrity will be checked and they will be deleted from the
81 spool if everything is good. So it is advisable to recheck your streams:
84 $ nncp-bundle -tx ALICE BOB WHATEVER | cdrecord -tao -
85 $ dd if=/dev/cd0 bs=2048 | nncp-bundle -rx -delete
88 @option{-dryrun} option prevents any writes to the spool. This is
89 useful when you need to see what packets will pass by and possibly check
105 NODE[:ADDR] [FORCEADDR]
108 Call (connect to) specified @option{NODE} and run @ref{Sync,
109 synchronization} protocol with the @ref{nncp-daemon, daemon} on the
110 remote side. Normally this command could be run any time you wish to
111 either check for incoming packets, or to send out queued ones.
112 Synchronization protocol allows resuming and bidirectional packets
115 If @option{-rx} option is specified then only inbound packets
116 transmission is performed. If @option{-tx} option is specified, then
117 only outbound transmission is performed. @option{-onlinedeadline}
118 overrides @ref{CfgOnlineDeadline, @emph{onlinedeadline}}.
119 @option{-maxonlinetime} overrides @ref{CfgMaxOnlineTime,
120 @emph{maxonlinetime}}. @option{-rxrate}/@option{-txrate} override
121 @ref{CfgXxRate, rxrate/txrate}. @option{-list} option allows you to list
122 packets of remote node, without any transmission.
124 You can specify what packets your want to download, by specifying
125 @option{-pkts} option with comma-separated list of packets identifiers.
127 Each @option{NODE} can contain several uniquely identified
128 @option{ADDR}esses in @ref{CfgAddrs, configuration} file. If you do
129 not specify the exact one, then all will be tried until the first
130 success. Optionally you can force @option{FORCEADDR} address usage,
131 instead of addresses taken from configuration file. You can specify both
132 @verb{|host:port|} and @verb{#|some command#} formats.
134 Pay attention that this command runs integrity check for each completely
135 received packet in the background. This can be time consuming.
136 Connection could be lost during that check and remote node won't be
137 notified that file is done. But after successful integrity check that
138 file is renamed from @file{.part} one and when you rerun
139 @command{nncp-call} again, remote node will receive completion
142 @option{-autotoss} option runs tosser on node's spool every second
143 during the call. All @option{-autotoss-*} options is the same as in
144 @ref{nncp-toss} command.
150 $ nncp-caller [options] [NODE ...]
153 Croned daemon that calls remote nodes from time to time, according to
154 their @ref{CfgCalls, @emph{calls}} configuration field.
156 Optional number of @option{NODE}s tells to ignore other ones.
157 Otherwise all nodes with specified @emph{calls} configuration
158 field will be called.
160 Look at @ref{nncp-call} for more information.
166 $ nncp-cfgenc [options] [-s INT] [-t INT] [-p INT] cfg.hjson > cfg.hjson.eblob
167 $ nncp-cfgenc [options] -d cfg.hjson.eblob > cfg.hjson
170 This command allows you to encrypt provided @file{cfg.hjson} file with
171 the passphrase, producing @ref{EBlob, eblob}, to safely keep your
172 configuration file with private keys. This utility was written for users
173 who do not want (or can not) to use either @url{https://gnupg.org/,
174 GnuPG} or similar tools. That @file{eblob} file can be used directly in
175 @option{-cfg} option of nearly all commands.
177 @option{-s}, @option{-t}, @option{-p} are used to tune @file{eblob}'s
178 password strengthening function. Space memory cost (@option{-s}),
179 specified in number of BLAKE2b-256 blocks (32 bytes), tells how many
180 memory must be used for hashing -- bigger values are better, but slower.
181 Time cost (@option{-t}) tells how many rounds/iterations must be
182 performed -- bigger is better, but slower. Number of parallel jobs
183 (@option{-p}) tells how many computation processes will be run: this is
184 the same as running that number of independent hashers and then joining
185 their result together.
187 When invoked for encryption, passphrase is entered manually twice. When
188 invoked for decryption (@option{-d} option), it is asked once and exits
189 if passphrase can not decrypt @file{eblob}.
191 @option{-dump} options parses @file{eblob} and prints parameters used
192 during its creation. For example:
194 $ nncp-cfgenc -dump /usr/local/etc/nncp.hjson.eblob
195 Strengthening function: Balloon with BLAKE2b-256
196 Memory space cost: 1048576 bytes
198 Number of parallel jobs: 2
206 $ nncp-cfgmin [options] > stripped.hjson
209 Print out stripped configuration version: only path to @ref{Spool,
210 spool}, path to log file, neighbours public keys are stayed. This is
211 useful mainly for usage with @ref{nncp-xfer} that has to know only
212 neighbours, without private keys involving.
218 $ nncp-cfgnew [options] [-nocomments] > new.hjson
221 Generate new node configuration: private keys, example configuration
222 file and print it to @code{stdout}. You must use this command when you
223 setup the new node. @option{-nocomments} will create configuration file
224 without descriptive huge comments -- useful for advanced users.
226 Pay attention that private keys generation consumes an entropy from your
233 $ nncp-check [options]
236 Perform @ref{Spool, spool} directory integrity check. Read all files
237 that has Base32-encoded filenames and compare it with recalculated
238 BLAKE2b hash output of their contents. That supplementary command is
239 not used often in practice, if ever.
245 $ nncp-daemon [options] [-maxconn INT] [-bind ADDR] [-inetd] [-autotoss*]
248 Start listening TCP daemon, wait for incoming connections and run
249 @ref{Sync, synchronization protocol} with each of them. You can run
250 @ref{nncp-toss} utility in background to process inbound packets from
253 @option{-maxconn} option specifies how many simultaneous clients daemon
254 can handle. @option{-bind} option specifies @option{addr:port} it must
257 It could be run as @command{inetd} service, by specifying
258 @option{-inetd} option. Pay attention that because it uses
259 @code{stdin}/@code{stdout}, it can not effectively work with IO timeouts
260 and connection closing can propagate up to 5 minutes in practice.
264 uucp stream tcp6 nowait nncpuser /usr/local/bin/nncp-daemon nncp-daemon -quiet -inetd
267 @option{-autotoss} option runs tosser on node's spool every second
268 during the call. All @option{-autotoss-*} options is the same as in
269 @ref{nncp-toss} command.
275 $ nncp-exec [options] [-use-tmp] [-nocompress] NODE HANDLE [ARG0 ARG1 ...]
278 Send execution command to @option{NODE} for specified @option{HANDLE}.
279 Body is read from @code{stdin} into memory and compressed (unless
280 @option{-nocompress} is specified). After receiving, remote side will
281 execute specified @ref{CfgExec, handle} command with @option{ARG*}
282 appended and decompressed body fed to command's @code{stdin}.
284 If @option{-use-tmp} option is specified, then @code{stdin} data is read
285 into temporary file first, requiring twice more disk space, but no
286 memory requirements. @ref{StdinTmpFile, Same temporary file} rules
287 applies as with @ref{nncp-file, nncp-file -} command.
289 For example, if remote side has following configuration file for your
294 sendmail: [/usr/sbin/sendmail, "-t"]
295 appender: ["/bin/sh", "-c", "cat >> /append"]
299 then executing @verb{|echo My message | nncp-exec -replynice 123 REMOTE
300 sendmail root@localhost|} will lead to execution of:
305 NNCP_SENDER=OurNodeId \
307 /usr/sbin/sendmail -t root@@localhost
310 If @ref{CfgNotify, notification} is enabled on the remote side for exec
311 handles, then it will sent simple letter after successful command
312 execution with its output in message body.
314 @strong{Pay attention} that packet generated with this command won't be
321 $ nncp-file [options] [-chunked INT] SRC NODE:[DST]
324 Send @file{SRC} file to remote @option{NODE}. @file{DST} specifies
325 destination file name in remote's @ref{CfgIncoming, incoming}
326 directory. If this file already exists there, then counter will be
329 This command queues file in @ref{Spool, spool} directory immediately
330 (through the temporary file of course) -- so pay attention that sending
331 2 GiB file will create 2 GiB outbound encrypted packet.
333 @anchor{StdinTmpFile}
334 If @file{SRC} equals to @file{-}, then create an encrypted temporary
335 file and copy everything taken from @code{stdin} to it and use for outbound
336 packet creation. Pay attention that if you want to send 1 GiB of data
337 taken from @code{stdin}, then you have to have more than 2 GiB of disk space
338 for that temporary file and resulting encrypted packet. You can control
339 temporary file location directory with @env{TMPDIR} environment
340 variable. Encryption is performed in AEAD mode with
341 @url{https://cr.yp.to/chacha.html, ChaCha20}-@url{https://en.wikipedia.org/wiki/Poly1305, Poly1305}
342 algorithms. Data is splitted on 128 KiB blocks. Each block is encrypted
343 with increasing nonce counter. File is deletes immediately after
344 creation, so even if program crashes -- disk space will be reclaimed, no
345 need in cleaning it up later.
347 If @file{SRC} points to directory, then
348 @url{https://pubs.opengroup.org/onlinepubs/9699919799/utilities/pax.html#tag_20_92_13_01, pax archive}
349 will be created on the fly with directory contents and destination
350 filename @file{.tar} appended. It @strong{won't} contain any entities
351 metainformation, but modification time with the names. UID/GID are set
352 to zero. Directories have 777 permissions, files have 666, for being
353 friendly with @command{umask}. Also each entity will have comment like
354 @verb{|Autogenerated by NNCP version X.Y.Z built with goXXX|}.
356 If @option{-chunked} is specified, then source file will be split
357 @ref{Chunked, on chunks}. @option{INT} is the desired chunk size in
358 KiBs. This mode is more CPU hungry. Pay attention that chunk is saved in
359 spool directory immediately and it is not deleted if any error occurs.
360 @option{-minsize} option is applied per each chunk. Do not forget about
361 @ref{ChunkedZFS, possible} ZFS deduplication issues. Zero
362 @option{-chunked} disables chunked transmission.
364 If @ref{CfgNotify, notification} is enabled on the remote side for
365 file transmissions, then it will sent simple letter after successful
372 $ nncp-freq [options] NODE:SRC [DST]
375 Send file request to @option{NODE}, asking it to send its @file{SRC}
376 file from @ref{CfgFreq, freq.path} directory to our node under @file{DST}
377 filename in our @ref{CfgIncoming, incoming} one. If @file{DST} is not
378 specified, then last element of @file{SRC} will be used.
380 If @ref{CfgNotify, notification} is enabled on the remote side for
381 file request, then it will sent simple letter after successful file
391 Parse @ref{Log, log} file and print out its records in human-readable form.
397 $ nncp-pkt [options] < pkt
398 $ nncp-pkt [options] [-decompress] -dump < pkt > payload
399 $ nncp-pkt -overheads
402 Low level packet parser. Normally it should not be used, but can help in
405 By default it will print packet's type, for example:
407 Packet type: encrypted
409 Sender: 2WHBV3TPZHDOZGUJEH563ZEK7M33J4UESRFO4PDKWD5KZNPROABQ
412 If you specify @option{-dump} option and provide an @ref{Encrypted,
413 encrypted} packet, then it will verify and decrypt it to @code{stdout}.
414 Encrypted packets contain @ref{Plain, plain} ones, that also can be fed
415 to @command{nncp-pkt}:
419 Payload type: transitional
420 Path: VHMTRWDOXPLK7BR55ICZ5N32ZJUMRKZEMFNGGCEAXV66GG43PEBQ
424 Path: stargrave@@stargrave.org
427 And with the @option{-dump} option it will give you the actual payload
428 (the whole file, mail message, and so on). @option{-decompress} option
429 tries to zstd-decompress the data from plain packet (useful for mail
432 @option{-overheads} options print encrypted, plain and size header overheads.
438 $ nncp-reass [options] [-dryrun] [-keep] [-dump] [-stdout] FILE.nncp.meta
439 $ nncp-reass [options] [-dryrun] [-keep] @{-all | -node NODE@}
442 Reassemble @ref{Chunked, chunked file} after @ref{nncp-toss, tossing}.
444 When called with @option{FILE} option, this command will reassemble only
445 it. When called with @option{-node} option, this command will try to
446 reassemble all @file{.nncp.meta} files found in @option{NODE}'s
447 @ref{CfgIncoming, incoming} directory. When called with @option{-all}
448 option, then cycle through all known nodes to do the same.
450 Reassembling process does the following:
453 @item Parses @ref{Chunked, @file{.nncp.meta}} file.
454 @item Checks existence and size of every @file{.nncp.chunkXXX}.
455 @item Verifies integrity of every chunk.
456 @item Concatenates all chunks, simultaneously removing them from filesystem.
459 That process reads the whole data twice. Be sure to have free disk
460 space for at least one chunk. Decrypted chunk files as a rule are saved
461 in pseudo-random order, so removing them during reassembly process will
462 likely lead to filesystem fragmentation. Reassembly process on
463 filesystems with deduplication capability should be rather lightweight.
465 If @option{-dryrun} option is specified, then only existence and
466 integrity checking are performed.
468 If @option{-keep} option is specified, then no
469 @file{.nncp.meta}/@file{.nncp.chunkXXX} files are deleted during
472 @option{-stdout} option outputs reassembled file to @code{stdout},
473 instead of saving to temporary file with renaming after. This could be
474 useful for reassembling on separate filesystem to lower fragmentation
475 effect, and/or separate storage device for higher performance.
477 @option{-dump} option prints meta-file contents in human-friendly form.
478 It is useful mainly for debugging purposes. For example:
480 Original filename: testfile
481 File size: 3.8 MiB (3987795 bytes)
482 Chunk size: 1.0 MiB (1048576 bytes)
485 0: eac60d819edf40b8ecdacd0b9a5a8c62de2d15eef3c8ca719eafa0be9b894017
486 1: 013a07e659f2e353d0e4339c3375c96c7fffaa2fa00875635f440bbc4631052a
487 2: f4f883975a663f2252328707a30e71b2678f933b2f3103db8475b03293e4316e
488 3: 0e9e229501bf0ca42d4aa07393d19406d40b179f3922a3986ef12b41019b45a3
491 Do not forget about @ref{ChunkedZFS, possible} ZFS deduplication issues.
497 $ nncp-rm [options] -tmp
498 $ nncp-rm [options] -lock
499 $ nncp-rm [options] -node NODE -part
500 $ nncp-rm [options] -node NODE -seen
501 $ nncp-rm [options] -node NODE [-rx] [-tx]
502 $ nncp-rm [options] -node NODE -pkt PKT
505 This command is aimed to delete various files from your spool directory:
509 @item If @option{-tmp} option is specified, then it will delete all
510 temporary files in @file{spool/tmp} directory. Files may stay in it when
511 commands like @ref{nncp-file} fail for some reason.
513 @item If @option{-lock} option is specified, then all @file{.lock} files
514 will be deleted in your spool directory.
516 @item If @option{-pkt} option is specified, then @file{PKT} packet (its
517 Base32 name) will be deleted. This is useful when you see some packet
518 failing to be processed.
520 @item When either @option{-rx} or @option{-tx} options are specified
521 (maybe both of them), then delete all packets from that given queues. If
522 @option{-part} is given, then delete only @file{.part}ly downloaded
523 ones. If @option{-seen} option is specified, then delete only
526 @item @option{-dryrun} option just prints what will be deleted.
528 @item You can also select files that only have modification date older
529 than specified @option{-older} time units (@code{10s} (10 seconds),
530 @code{5m} (5 minutes), @code{12h} (12 hours), @code{2d} (2 days)).
538 $ nncp-stat [options] [-pkt] [-node NODE]
541 Print current @ref{Spool, spool} statistics about unsent and unprocessed
542 packets. For each node (unless @option{-node} specified) and each
543 niceness level there will be printed how many packets (with the total
544 size) are in inbound (Rx) and outbound (Tx) queues. @option{-pkt} option
545 show information about each packet.
551 $ nncp-toss [options]
562 Perform "tossing" operation on all inbound packets. This is the tool
563 that decrypts all packets and processes all payload packets in them:
564 copies files, sends mails, sends out file requests and relays transition
565 packets. It should be run after each online/offline exchange.
567 @option{-dryrun} option does not perform any writing and sending, just
568 tells what it will do.
570 @option{-cycle} option tells not to quit, but to repeat tossing every
571 @option{INT} seconds in an infinite loop. That can be useful when
572 running this command as a daemon.
574 @option{-seen} option creates empty @file{XXX.seen} file after
575 successful tossing of @file{XXX} packet. @ref{nncp-xfer},
576 @ref{nncp-bundle}, @ref{nncp-daemon} and @ref{nncp-call} commands skip
577 inbound packets that has been already seen, processed and tossed. This
578 is helpful to prevent duplicates.
580 @option{-nofile}, @option{-nofreq}, @option{-noexec}, @option{-notrns}
581 options allow to disable any kind of packet types processing.
587 $ nncp-xfer [options] [-node NODE] [-mkdir] [-keep] [-rx|-tx] DIR
590 Search for directory in @file{DIR} containing inbound packets for us and
591 move them to local @ref{Spool, spool} directory. Also search for known
592 neighbours directories and move locally queued outbound packets to them.
593 This command is used for offline packets transmission.
595 If @option{-mkdir} option is specified, then outbound neighbour(s)
596 directories will be created. This is useful for the first time usage,
597 when storage device does not have any directories tree.
599 If @option{-keep} option is specified, then keep copied files, do not
602 @option{-rx} option tells only to move inbound packets addressed to us.
603 @option{-tx} option tells exactly the opposite: move only outbound packets.
605 @ref{nncp-cfgmin} could be useful for creating stripped minimalistic
606 configuration file version without any private keys.
608 @file{DIR} directory has the following structure:
609 @file{RECIPIENT/SENDER/PACKET}, where @file{RECIPIENT} is Base32 encoded
610 destination node, @file{SENDER} is Base32 encoded sender node.
612 Also look for @ref{nncp-bundle}, especially if you deal with CD-ROM and