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.
38 Print version information.
40 Print warranty information (no warranty).
47 % nncp-bundle [options] -tx [-delete] NODE [NODE ...] > ...
48 % nncp-bundle [options] -rx -delete [-dryrun] [NODE ...] < ...
49 % nncp-bundle [options] -rx [-check] [-dryrun] [NODE ...] < ...
52 With @option{-tx} option, this command creates @ref{Bundles, bundle} of
53 @ref{Encrypted, encrypted packets} from the spool directory and writes
56 With @option{-rx} option, this command takes bundle from stdin and
57 copies all found packets for our node to the spool directory. Pay
58 attention that @strong{no} integrity checking is done by default. Modern
59 tape drives could easily provide too much throughput your CPU won't be
60 able to verify on the fly. So if you won't @ref{nncp-toss, toss}
61 received packets at the place, it is advisable either to run
62 @ref{nncp-check} utility for packets integrity verification, or to use
63 @option{-check} option to enable on the fly integrity check.
65 You can specify multiple @option{NODE} arguments, telling for what nodes
66 you want to create the stream, or take it from. If no nodes are
67 specified for @option{-rx} mode, then all packets aimed at us will be
70 When packets are sent through the stream, they are still kept in the
71 spool directory, because there is no assurance that they are transferred
72 to the media (media (CD-ROM, tape drive, raw hard drive) can end). If
73 you want to forcefully delete them (after they are successfully flushed
74 to stdout) anyway, use @option{-delete} option.
76 But you can verify produced stream after, by digesting it by yourself
77 with @option{-rx} and @option{-delete} options -- in that mode, stream
78 packets integrity will be checked and they will be deleted from the
79 spool if everything is good. So it is advisable to recheck your streams:
82 % nncp-bundle -tx ALICE BOB WHATEVER | cdrecord -tao -
83 % dd if=/dev/cd0 bs=2048 | nncp-bundle -rx -delete
86 @option{-dryrun} option prevents any writes to the spool. This is
87 useful when you need to see what packets will pass by and possibly check
100 NODE[:ADDR] [FORCEADDR]
103 Call (connect to) specified @option{NODE} and run @ref{Sync,
104 synchronization} protocol with the @ref{nncp-daemon, daemon} on the
105 remote side. Normally this command could be run any time you wish to
106 either check for incoming packets, or to send out queued ones.
107 Synchronization protocol allows resuming and bidirectional packets
110 If @option{-rx} option is specified then only inbound packets
111 transmission is performed. If @option{-tx} option is specified, then
112 only outbound transmission is performed. @option{-onlinedeadline}
113 overrides @ref{CfgOnlineDeadline, @emph{onlinedeadline}}.
114 @option{-maxonlinetime} overrides @ref{CfgMaxOnlineTime,
115 @emph{maxonlinetime}}. @option{-rxrate}/@option{-txrate} override
116 @ref{CfgXxRate, rxrate/txrate}.
122 % nncp-caller [options] [NODE ...]
125 Croned daemon that calls remote nodes from time to time, according to
126 their @ref{CfgCalls, @emph{calls}} configuration field.
128 Optional number of @option{NODE}s tells to ignore other ones.
129 Otherwise all nodes with specified @emph{calls} configuration
130 field will be called.
132 @option{-onlinedeadline} overrides @ref{CfgOnlineDeadline,
133 @emph{onlinedeadline}} configuration option.
135 Each @option{NODE} can contain several uniquely identified
136 @option{ADDR}esses in @ref{CfgAddrs, configuration} file. If you do
137 not specify the exact one, then all will be tried until the first
138 success. Optionally you can force @option{FORCEADDR} address usage,
139 instead of addresses taken from configuration file.
141 Pay attention that this command runs integrity check for each completely
142 received packet in the background. This can be time consuming.
143 Connection could be lost during that check and remote node won't be
144 notified that file is done. But after successful integrity check that
145 file is renamed from @file{.part} one and when you rerun
146 @command{nncp-call} again, remote node will receive completion
153 % nncp-cfgmin [options] [-s INT] [-t INT] [-p INT] cfg.yaml > cfg.yaml.eblob
154 % nncp-cfgmin [options] -d cfg.yaml.eblob > cfg.yaml
157 This command allows you to encrypt provided @file{cfg.yaml} file with
158 the passphrase, producing @ref{EBlob, eblob}, to safely keep your
159 configuration file with private keys. This utility was written for users
160 who do not want (or can not) to use either @url{https://gnupg.org/,
161 GnuPG} or similar tools. That @file{eblob} file can be used directly in
162 @option{-cfg} option of nearly all commands.
164 @option{-s}, @option{-t}, @option{-p} are used to tune @file{eblob}'s
165 password strengthening function. Space memory cost (@option{-s}),
166 specified in number of BLAKE2b-256 blocks (32 bytes), tells how many
167 memory must be used for hashing -- bigger values are better, but slower.
168 Time cost (@option{-t}) tells how many rounds/iterations must be
169 performed -- bigger is better, but slower. Number of parallel jobs
170 (@option{-p}) tells how many computation processes will be run: this is
171 the same as running that number of independent hashers and then joining
172 their result together.
174 When invoked for encryption, passphrase is entered manually twice. When
175 invoked for decryption (@option{-d} option), it is asked once and exits
176 if passphrase can not decrypt @file{eblob}.
178 @option{-dump} options parses @file{eblob} and prints parameters used
179 during its creation. For example:
181 % nncp-cfgenc -dump /usr/local/etc/nncp.yaml.eblob
182 Strengthening function: Balloon with BLAKE2b-256
183 Memory space cost: 1048576 bytes
185 Number of parallel jobs: 2
193 % nncp-cfgmin [options] > stripped.yaml
196 Print out stripped configuration version: only path to @ref{Spool,
197 spool}, path to log file, neighbours public keys are stayed. This is
198 useful mainly for usage with @ref{nncp-xfer} that has to know only
199 neighbours, without private keys involving.
205 % nncp-cfgnew [options] > new.yaml
208 Generate new node configuration: private keys, example configuration
209 file and print it to stdout. You must use this command when you setup
212 Pay attention that private keys generation consumes an entropy from your
219 % nncp-check [options]
222 Perform @ref{Spool, spool} directory integrity check. Read all files
223 that has Base32-encoded filenames and compare it with recalculated
224 BLAKE2b hash output of their contents. That supplementary command is
225 not used often in practice, if ever.
231 % nncp-daemon [options] [-maxconn INT] [-bind ADDR] [-inetd]
234 Start listening TCP daemon, wait for incoming connections and run
235 @ref{Sync, synchronization protocol} with each of them. You can run
236 @ref{nncp-toss} utility in background to process inbound packets from
239 @option{-maxconn} option specifies how many simultaneous clients daemon
240 can handle. @option{-bind} option specifies @option{addr:port} it must
243 It could be run as @command{inetd} service, by specifying
244 @option{-inetd} option. Example inetd-entry:
247 uucp stream tcp6 nowait nncpuser /usr/local/bin/nncp-daemon nncp-daemon -inetd
254 % nncp-exec [options] NODE HANDLE [ARG0 ARG1 ...]
257 Send execution command to @option{NODE} for specified @option{HANDLE}.
258 Body is read from stdin and compressed. After receiving, remote side
259 will execute specified @ref{CfgExec, handle} command with @option{ARG*}
260 appended and decompressed body fed to command's stdin.
262 For example, if remote side has following configuration file for your
267 sendmail: [/usr/sbin/sendmail, "-t"]
268 appender: ["/bin/sh", "-c", "cat >> /append"]
271 then executing @verb{|echo My message | nncp-exec -replynice 123 REMOTE
272 sendmail root@localhost|} will lead to executing of:
277 NNCP_SENDER=OurNodeId \
279 /usr/sbin/sendmail -t root@localhost
287 % nncp-file [options] [-chunked INT] SRC NODE:[DST]
290 Send @file{SRC} file to remote @option{NODE}. @file{DST} specifies
291 destination file name in remote's @ref{CfgIncoming, incoming}
292 directory. If this file already exists there, then counter will be
295 This command queues file in @ref{Spool, spool} directory immediately
296 (through the temporary file of course) -- so pay attention that sending
297 2 GiB file will create 2 GiB outbound encrypted packet.
299 If @file{SRC} equals to @file{-}, then create an encrypted temporary
300 file and copy everything taken from stdin to it and use for outbound
301 packet creation. Pay attention that if you want to send 1 GiB of data
302 taken from stdin, then you have to have more than 2 GiB of disk space
303 for that temporary file and resulting encrypted packet. You can control
304 where temporary file will be stored using @env{TMPDIR} environment
305 variable. Encryption is performed in AEAD mode with
306 @url{https://cr.yp.to/chacha.html, ChaCha20}-@url{https://en.wikipedia.org/wiki/Poly1305, Poly1305}
307 algorithms. Data is splitted on 128 KiB blocks. Each block is encrypted
308 with increasing nonce counter.
310 If @option{-chunked} is specified, then source file will be split
311 @ref{Chunked, on chunks}. @option{INT} is the desired chunk size in
312 KiBs. This mode is more CPU hungry. Pay attention that chunk is saved in
313 spool directory immediately and it is not deleted if any error occurs.
314 @option{-minsize} option is applied per each chunk. Do not forget about
315 @ref{ChunkedZFS, possible} ZFS deduplication issues.
317 If @ref{CfgNotify, notification} is enabled on the remote side for
318 file transmissions, then it will sent simple letter after successful
325 % nncp-freq [options] NODE:SRC [DST]
328 Send file request to @option{NODE}, asking it to send its @file{SRC}
329 file from @ref{CfgFreq, freq} directory to our node under @file{DST}
330 filename in our @ref{CfgIncoming, incoming} one. If @file{DST} is not
331 specified, then last element of @file{SRC} will be used.
333 If @ref{CfgNotify, notification} is enabled on the remote side for
334 file request, then it will sent simple letter after successful file
344 Parse @ref{Log, log} file and print out its records in human-readable form.
350 % nncp-pkt [options] < pkt
351 % nncp-pkt [options] [-decompress] -dump < pkt > payload
352 % nncp-pkt -overheads
355 Low level packet parser. Normally it should not be used, but can help in
358 By default it will print packet's type, for example:
360 Packet type: encrypted
362 Sender: 2WHBV3TPZHDOZGUJEH563ZEK7M33J4UESRFO4PDKWD5KZNPROABQ
365 If you specify @option{-dump} option and provide an @ref{Encrypted,
366 encrypted} packet, then it will verify and decrypt it to stdout.
367 Encrypted packets contain @ref{Plain, plain} ones, that also can be fed
368 to @command{nncp-pkt}:
372 Payload type: transitional
373 Path: VHMTRWDOXPLK7BR55ICZ5N32ZJUMRKZEMFNGGCEAXV66GG43PEBQ
377 Path: stargrave@stargrave.org
380 And with the @option{-dump} option it will give you the actual payload
381 (the whole file, mail message, and so on). @option{-decompress} option
382 tries to zlib-decompress the data from plain packet (useful for mail
385 @option{-overheads} options print encrypted, plain and size header overheads.
391 % nncp-reass [options] [-dryrun] [-keep] [-dump] [-stdout] FILE.nncp.meta
392 % nncp-reass [options] [-dryrun] [-keep] {-all | -node NODE}
395 Reassemble @ref{Chunked, chunked file} after @ref{nncp-toss, tossing}.
397 When called with @option{FILE} option, this command will reassemble only
398 it. When called with @option{-node} option, this command will try to
399 reassemble all @file{.nncp.meta} files found in @option{NODE}'s
400 @ref{CfgIncoming, incoming} directory. When called with @option{-all}
401 option, then cycle through all known nodes to do the same.
403 Reassembling process does the following:
406 @item Parses @ref{Chunked, @file{.nncp.meta}} file.
407 @item Checks existence and size of every @file{.nncp.chunkXXX}.
408 @item Verifies integrity of every chunk.
409 @item Concatenates all chunks, simultaneously removing them from filesystem.
412 That process reads the whole data twice. Be sure to have free disk
413 space for at least one chunk. Decrypted chunk files as a rule are saved
414 in pseudo-random order, so removing them during reassembly process will
415 likely lead to filesystem fragmentation. Reassembly process on
416 filesystems with deduplication capability should be rather lightweight.
418 If @option{-dryrun} option is specified, then only existence and
419 integrity checking are performed.
421 If @option{-keep} option is specified, then no
422 @file{.nncp.meta}/@file{.nncp.chunkXXX} files are deleted during
425 @option{-stdout} option outputs reassembled file to stdout, instead of
426 saving to temporary file with renaming after. This could be useful for
427 reassembling on separate filesystem to lower fragmentation effect,
428 and/or separate storage device for higher performance.
430 @option{-dump} option prints meta-file contents in human-friendly form.
431 It is useful mainly for debugging purposes. For example:
433 Original filename: testfile
434 File size: 3.8 MiB (3987795 bytes)
435 Chunk size: 1.0 MiB (1048576 bytes)
438 0: eac60d819edf40b8ecdacd0b9a5a8c62de2d15eef3c8ca719eafa0be9b894017
439 1: 013a07e659f2e353d0e4339c3375c96c7fffaa2fa00875635f440bbc4631052a
440 2: f4f883975a663f2252328707a30e71b2678f933b2f3103db8475b03293e4316e
441 3: 0e9e229501bf0ca42d4aa07393d19406d40b179f3922a3986ef12b41019b45a3
444 Do not forget about @ref{ChunkedZFS, possible} ZFS deduplication issues.
450 % nncp-rm [options] -tmp
451 % nncp-rm [options] -lock
452 % nncp-rm [options] -node NODE -part
453 % nncp-rm [options] -node NODE -seen
454 % nncp-rm [options] -node NODE [-rx] [-tx]
455 % nncp-rm [options] -node NODE -pkt PKT
458 This command is aimed to delete various files from your spool directory:
461 @item If @option{-tmp} option is specified, then it will delete all
462 temporary files in @file{spool/tmp} directory. Files may stay in it when
463 commands like @ref{nncp-file} fail for some reason.
464 @item If @option{-lock} option is specified, then all @file{.lock} files
465 will be deleted in your spool directory.
466 @item If @option{-pkt} option is specified, then @file{PKT} packet (its
467 Base32 name) will be deleted. This is useful when you see some packet
468 failing to be processed.
469 @item When either @option{-rx} or @option{-tx} options are specified
470 (maybe both of them), then delete all packets from that given queues. If
471 @option{-part} is given, then delete only @file{.part}ly downloaded
472 ones. If @option{-seen} option is specified, then delete only
480 % nncp-stat [options] [-node NODE]
483 Print current @ref{Spool, spool} statistics about unsent and unprocessed
484 packets. For each node (unless @option{-node} specified) and each
485 niceness level there will be printed how many packets (with the total
486 size) are in inbound (Rx) and outbound (Tx) queues.
492 % nncp-toss [options]
503 Perform "tossing" operation on all inbound packets. This is the tool
504 that decrypts all packets and processes all payload packets in them:
505 copies files, sends mails, sends out file requests and relays transition
506 packets. It should be run after each online/offline exchange.
508 @option{-dryrun} option does not perform any writing and sending, just
509 tells what it will do.
511 @option{-cycle} option tells not to quit, but to repeat tossing every
512 @option{INT} seconds in an infinite loop. That can be useful when
513 running this command as a daemon.
515 @option{-seen} option creates empty @file{XXX.seen} file after
516 successful tossing of @file{XXX} packet. @ref{nncp-xfer},
517 @ref{nncp-bundle}, @ref{nncp-daemon} and @ref{nncp-call} commands skip
518 inbound packets that has been already seen, processed and tossed. This
519 is helpful to prevent duplicates.
521 @option{-nofile}, @option{-nofreq}, @option{-noexec}, @option{-notrns}
522 options allow to disable any kind of packet types processing.
528 % nncp-xfer [options] [-node NODE] [-mkdir] [-keep] [-rx|-tx] DIR
531 Search for directory in @file{DIR} containing inbound packets for us and
532 move them to local @ref{Spool, spool} directory. Also search for known
533 neighbours directories and move locally queued outbound packets to them.
534 This command is used for offline packets transmission.
536 If @option{-mkdir} option is specified, then outbound neighbour(s)
537 directories will be created. This is useful for the first time usage,
538 when storage device does not have any directories tree.
540 If @option{-keep} option is specified, then keep copied files, do not
543 @option{-rx} option tells only to move inbound packets addressed to us.
544 @option{-tx} option tells exactly the opposite: move only outbound packets.
546 @ref{nncp-cfgmin} could be useful for creating stripped minimalistic
547 configuration file version without any private keys.
549 @file{DIR} directory has the following structure:
550 @file{RECIPIENT/SENDER/PACKET}, where @file{RECIPIENT} is Base32 encoded
551 destination node, @file{SENDER} is Base32 encoded sender node.
553 Also look for @ref{nncp-bundle}, especially if you deal with CD-ROM and