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}.
20 1-255 values are allowed.
22 Set desired reply packet @ref{Niceness, niceness level}. Only freq
23 and exec packets look at that niceness level. 1-255 values are
26 Process only single specified node.
28 Override @ref{CfgVia, via} configuration option for destination node.
29 Specified nodes must be separated with comma: @verb{|NODE1,NODE2|}.
30 With @verb{|-via -|} you can disable relaying at all.
32 Override path to spool directory. May be specified by
33 @env{NNCPSPOOL} environment variable.
35 Override path to logfile. May be specified by @env{NNCPLOG}
38 Print only errors, omit simple informational messages. In any case
39 those messages are logged, so you can reread them using
40 @ref{nncp-log} command.
42 Print version information.
44 Print warranty information (no warranty).
51 % nncp-bundle [options] -tx [-delete] NODE [NODE ...] > ...
52 % nncp-bundle [options] -rx -delete [-dryrun] [NODE ...] < ...
53 % nncp-bundle [options] -rx [-check] [-dryrun] [NODE ...] < ...
56 With @option{-tx} option, this command creates @ref{Bundles, bundle} of
57 @ref{Encrypted, encrypted packets} from the spool directory and writes
60 With @option{-rx} option, this command takes bundle from stdin and
61 copies all found packets for our node to the spool directory. Pay
62 attention that @strong{no} integrity checking is done by default. Modern
63 tape drives could easily provide too much throughput your CPU won't be
64 able to verify on the fly. So if you won't @ref{nncp-toss, toss}
65 received packets at the place, it is advisable either to run
66 @ref{nncp-check} utility for packets integrity verification, or to use
67 @option{-check} option to enable on the fly integrity check.
69 You can specify multiple @option{NODE} arguments, telling for what nodes
70 you want to create the stream, or take it from. If no nodes are
71 specified for @option{-rx} mode, then all packets aimed at us will be
74 When packets are sent through the stream, they are still kept in the
75 spool directory, because there is no assurance that they are transferred
76 to the media (media (CD-ROM, tape drive, raw hard drive) can end). If
77 you want to forcefully delete them (after they are successfully flushed
78 to stdout) anyway, use @option{-delete} option.
80 But you can verify produced stream after, by digesting it by yourself
81 with @option{-rx} and @option{-delete} options -- in that mode, stream
82 packets integrity will be checked and they will be deleted from the
83 spool if everything is good. So it is advisable to recheck your streams:
86 % nncp-bundle -tx ALICE BOB WHATEVER | cdrecord -tao -
87 % dd if=/dev/cd0 bs=2048 | nncp-bundle -rx -delete
90 @option{-dryrun} option prevents any writes to the spool. This is
91 useful when you need to see what packets will pass by and possibly check
104 NODE[:ADDR] [FORCEADDR]
107 Call (connect to) specified @option{NODE} and run @ref{Sync,
108 synchronization} protocol with the @ref{nncp-daemon, daemon} on the
109 remote side. Normally this command could be run any time you wish to
110 either check for incoming packets, or to send out queued ones.
111 Synchronization protocol allows resuming and bidirectional packets
114 If @option{-rx} option is specified then only inbound packets
115 transmission is performed. If @option{-tx} option is specified, then
116 only outbound transmission is performed. @option{-onlinedeadline}
117 overrides @ref{CfgOnlineDeadline, @emph{onlinedeadline}}.
118 @option{-maxonlinetime} overrides @ref{CfgMaxOnlineTime,
119 @emph{maxonlinetime}}. @option{-rxrate}/@option{-txrate} override
120 @ref{CfgXxRate, rxrate/txrate}.
126 % nncp-caller [options] [NODE ...]
129 Croned daemon that calls remote nodes from time to time, according to
130 their @ref{CfgCalls, @emph{calls}} configuration field.
132 Optional number of @option{NODE}s tells to ignore other ones.
133 Otherwise all nodes with specified @emph{calls} configuration
134 field will be called.
136 @option{-onlinedeadline} overrides @ref{CfgOnlineDeadline,
137 @emph{onlinedeadline}} configuration option.
139 Each @option{NODE} can contain several uniquely identified
140 @option{ADDR}esses in @ref{CfgAddrs, configuration} file. If you do
141 not specify the exact one, then all will be tried until the first
142 success. Optionally you can force @option{FORCEADDR} address usage,
143 instead of addresses taken from configuration file.
145 Pay attention that this command runs integrity check for each completely
146 received packet in the background. This can be time consuming.
147 Connection could be lost during that check and remote node won't be
148 notified that file is done. But after successful integrity check that
149 file is renamed from @file{.part} one and when you rerun
150 @command{nncp-call} again, remote node will receive completion
157 % nncp-cfgmin [options] [-s INT] [-t INT] [-p INT] cfg.yaml > cfg.yaml.eblob
158 % nncp-cfgmin [options] -d cfg.yaml.eblob > cfg.yaml
161 This command allows you to encrypt provided @file{cfg.yaml} file with
162 the passphrase, producing @ref{EBlob, eblob}, to safely keep your
163 configuration file with private keys. This utility was written for users
164 who do not want (or can not) to use either @url{https://gnupg.org/,
165 GnuPG} or similar tools. That @file{eblob} file can be used directly in
166 @option{-cfg} option of nearly all commands.
168 @option{-s}, @option{-t}, @option{-p} are used to tune @file{eblob}'s
169 password strengthening function. Space memory cost (@option{-s}),
170 specified in number of BLAKE2b-256 blocks (32 bytes), tells how many
171 memory must be used for hashing -- bigger values are better, but slower.
172 Time cost (@option{-t}) tells how many rounds/iterations must be
173 performed -- bigger is better, but slower. Number of parallel jobs
174 (@option{-p}) tells how many computation processes will be run: this is
175 the same as running that number of independent hashers and then joining
176 their result together.
178 When invoked for encryption, passphrase is entered manually twice. When
179 invoked for decryption (@option{-d} option), it is asked once and exits
180 if passphrase can not decrypt @file{eblob}.
182 @option{-dump} options parses @file{eblob} and prints parameters used
183 during its creation. For example:
185 % nncp-cfgenc -dump /usr/local/etc/nncp.yaml.eblob
186 Strengthening function: Balloon with BLAKE2b-256
187 Memory space cost: 1048576 bytes
189 Number of parallel jobs: 2
197 % nncp-cfgmin [options] > stripped.yaml
200 Print out stripped configuration version: only path to @ref{Spool,
201 spool}, path to log file, neighbours public keys are stayed. This is
202 useful mainly for usage with @ref{nncp-xfer} that has to know only
203 neighbours, without private keys involving.
209 % nncp-cfgnew [options] > new.yaml
212 Generate new node configuration: private keys, example configuration
213 file and print it to stdout. You must use this command when you setup
216 Pay attention that private keys generation consumes an entropy from your
223 % nncp-check [options]
226 Perform @ref{Spool, spool} directory integrity check. Read all files
227 that has Base32-encoded filenames and compare it with recalculated
228 BLAKE2b hash output of their contents. That supplementary command is
229 not used often in practice, if ever.
235 % nncp-daemon [options] [-maxconn INT] [-bind ADDR]
238 Start listening TCP daemon, wait for incoming connections and run
239 @ref{Sync, synchronization protocol} with each of them. You can run
240 @ref{nncp-toss} utility in background to process inbound packets from
243 @option{-maxconn} option specifies how many simultaneous clients daemon
244 can handle. @option{-bind} option specifies @option{addr:port} it must
251 % nncp-exec [options] NODE HANDLE [ARG0 ARG1 ...]
254 Send execution command to @option{NODE} for specified @option{HANDLE}.
255 Body is read from stdin and compressed. After receiving, remote side
256 will execute specified @ref{CfgExec, handle} command with @option{ARG*}
257 appended and decompressed body fed to command's stdin.
259 For example, if remote side has following configuration file for your
264 sendmail: [/usr/sbin/sendmail, "-t"]
265 appender: ["/bin/sh", "-c", "cat >> /append"]
268 then executing @verb{|echo My message | nncp-exec -replynice 123 REMOTE
269 sendmail root@localhost|} will lead to executing of:
274 NNCP_SENDER=OurNodeId \
276 /usr/sbin/sendmail -t root@localhost
284 % nncp-file [options] [-chunked INT] SRC NODE:[DST]
287 Send @file{SRC} file to remote @option{NODE}. @file{DST} specifies
288 destination file name in remote's @ref{CfgIncoming, incoming}
289 directory. If this file already exists there, then counter will be
292 This command queues file in @ref{Spool, spool} directory immediately
293 (through the temporary file of course) -- so pay attention that sending
294 2 GiB file will create 2 GiB outbound encrypted packet.
296 If @file{SRC} equals to @file{-}, then create an encrypted temporary
297 file and copy everything taken from stdin to it and use for outbound
298 packet creation. Pay attention that if you want to send 1 GiB of data
299 taken from stdin, then you have to have 2 GiB of disk space for that
300 temporary file and resulting encrypted packet. You can control where
301 temporary file will be stored using @env{TMPDIR} environment variable.
302 Encryption is performed with @url{https://cr.yp.to/chacha.html,
303 ChaCha20} algorithm. Data is splitted on 128 KiB blocks. Each block is
304 encrypted with increasing nonce counter.
306 If @option{-chunked} is specified, then source file will be split
307 @ref{Chunked, on chunks}. @option{INT} is the desired chunk size in
308 KiBs. This mode is more CPU hungry. Pay attention that chunk is saved in
309 spool directory immediately and it is not deleted if any error occurs.
310 @option{-minsize} option is applied per each chunk. Do not forget about
311 @ref{ChunkedZFS, possible} ZFS deduplication issues.
313 If @ref{CfgNotify, notification} is enabled on the remote side for
314 file transmissions, then it will sent simple letter after successful
321 % nncp-freq [options] NODE:SRC [DST]
324 Send file request to @option{NODE}, asking it to send its @file{SRC}
325 file from @ref{CfgFreq, freq} directory to our node under @file{DST}
326 filename in our @ref{CfgIncoming, incoming} one. If @file{DST} is not
327 specified, then last element of @file{SRC} will be used.
329 If @ref{CfgNotify, notification} is enabled on the remote side for
330 file request, then it will sent simple letter after successful file
340 Parse @ref{Log, log} file and print out its records in human-readable form.
346 % nncp-pkt [options] < pkt
347 % nncp-pkt [options] [-decompress] -dump < pkt > payload
350 Low level packet parser. Normally it should not be used, but can help in
353 By default it will print packet's type, for example:
355 Packet type: encrypted
357 Sender: 2WHBV3TPZHDOZGUJEH563ZEK7M33J4UESRFO4PDKWD5KZNPROABQ
360 If you specify @option{-dump} option and provide an @ref{Encrypted,
361 encrypted} packet, then it will verify and decrypt it to stdout.
362 Encrypted packets contain @ref{Plain, plain} ones, that also can be fed
363 to @command{nncp-pkt}:
367 Payload type: transitional
368 Path: VHMTRWDOXPLK7BR55ICZ5N32ZJUMRKZEMFNGGCEAXV66GG43PEBQ
372 Path: stargrave@stargrave.org
375 And with the @option{-dump} option it will give you the actual payload
376 (the whole file, mail message, and so on). @option{-decompress} option
377 tries to zlib-decompress the data from plain packet (useful for mail
384 % nncp-reass [options] [-dryrun] [-keep] [-dump] [-stdout] FILE.nncp.meta
385 % nncp-reass [options] [-dryrun] [-keep] {-all | -node NODE}
388 Reassemble @ref{Chunked, chunked file} after @ref{nncp-toss, tossing}.
390 When called with @option{FILE} option, this command will reassemble only
391 it. When called with @option{-node} option, this command will try to
392 reassemble all @file{.nncp.meta} files found in @option{NODE}'s
393 @ref{CfgIncoming, incoming} directory. When called with @option{-all}
394 option, then cycle through all known nodes to do the same.
396 Reassembling process does the following:
399 @item Parses @ref{Chunked, @file{.nncp.meta}} file.
400 @item Checks existence and size of every @file{.nncp.chunkXXX}.
401 @item Verifies integrity of every chunk.
402 @item Concatenates all chunks, simultaneously removing them from filesystem.
405 That process reads the whole data twice. Be sure to have free disk
406 space for at least one chunk. Decrypted chunk files as a rule are saved
407 in pseudo-random order, so removing them during reassembly process will
408 likely lead to filesystem fragmentation. Reassembly process on
409 filesystems with deduplication capability should be rather lightweight.
411 If @option{-dryrun} option is specified, then only existence and
412 integrity checking are performed.
414 If @option{-keep} option is specified, then no
415 @file{.nncp.meta}/@file{.nncp.chunkXXX} files are deleted during
418 @option{-stdout} option outputs reassembled file to stdout, instead of
419 saving to temporary file with renaming after. This could be useful for
420 reassembling on separate filesystem to lower fragmentation effect,
421 and/or separate storage device for higher performance.
423 @option{-dump} option prints meta-file contents in human-friendly form.
424 It is useful mainly for debugging purposes. For example:
426 Original filename: testfile
427 File size: 3.8 MiB (3987795 bytes)
428 Chunk size: 1.0 MiB (1048576 bytes)
431 0: eac60d819edf40b8ecdacd0b9a5a8c62de2d15eef3c8ca719eafa0be9b894017
432 1: 013a07e659f2e353d0e4339c3375c96c7fffaa2fa00875635f440bbc4631052a
433 2: f4f883975a663f2252328707a30e71b2678f933b2f3103db8475b03293e4316e
434 3: 0e9e229501bf0ca42d4aa07393d19406d40b179f3922a3986ef12b41019b45a3
437 Do not forget about @ref{ChunkedZFS, possible} ZFS deduplication issues.
443 % nncp-rm [options] -tmp
444 % nncp-rm [options] -lock
445 % nncp-rm [options] -node NODE -part
446 % nncp-rm [options] -node NODE -seen
447 % nncp-rm [options] -node NODE [-rx] [-tx]
448 % nncp-rm [options] -node NODE -pkt PKT
451 This command is aimed to delete various files from your spool directory:
454 @item If @option{-tmp} option is specified, then it will delete all
455 temporary files in @file{spool/tmp} directory. Files may stay in it when
456 commands like @ref{nncp-file} fail for some reason.
457 @item If @option{-lock} option is specified, then all @file{.lock} files
458 will be deleted in your spool directory.
459 @item If @option{-pkt} option is specified, then @file{PKT} packet (its
460 Base32 name) will be deleted. This is useful when you see some packet
461 failing to be processed.
462 @item When either @option{-rx} or @option{-tx} options are specified
463 (maybe both of them), then delete all packets from that given queues. If
464 @option{-part} is given, then delete only @file{.part}ly downloaded
465 ones. If @option{-seen} option is specified, then delete only
473 % nncp-stat [options]
476 Print current @ref{Spool, spool} statistics about unsent and unprocessed
477 packets. For each node and each niceness level there will be printed how
478 many packets (with the total size) are in inbound (Rx) and outbound (Tx)
485 % nncp-toss [options]
495 Perform "tossing" operation on all inbound packets. This is the tool
496 that decrypts all packets and processes all payload packets in them:
497 copies files, sends mails, sends out file requests and relays transition
498 packets. It should be run after each online/offline exchange.
500 @option{-dryrun} option does not perform any writing and sending, just
501 tells what it will do.
503 @option{-cycle} option tells not to quit, but to repeat tossing every
504 @option{INT} seconds in an infinite loop. That can be useful when
505 running this command as a daemon.
507 @option{-seen} option creates empty @file{XXX.seen} file after
508 successful tossing of @file{XXX} packet. @ref{nncp-xfer} and
509 @ref{nncp-bundle} commands skip inbound packets that has been already
510 seen, processed and tossed. This is helpful to defeat duplicates.
512 @option{-nofile}, @option{-nofreq}, @option{-nomail}, @option{-notrns}
513 options allow to disable any kind of packet types processing.
519 % nncp-xfer [options] [-mkdir] [-keep] [-rx|-tx] DIR
522 Search for directory in @file{DIR} containing inbound packets for us and
523 move them to local @ref{Spool, spool} directory. Also search for known
524 neighbours directories and move locally queued outbound packets to them.
525 This command is used for offline packets transmission.
527 If @option{-mkdir} option is specified, then outbound neighbour(s)
528 directories will be created. This is useful for the first time usage,
529 when storage device does not have any directories tree.
531 If @option{-keep} option is specified, then keep copied files, do not
534 @option{-rx} option tells only to move inbound packets addressed to us.
535 @option{-tx} option tells exactly the opposite: move only outbound packets.
537 @ref{nncp-cfgmin} could be useful for creating stripped minimalistic
538 configuration file version without any private keys.
540 @file{DIR} directory has the following structure:
541 @file{RECIPIENT/SENDER/PACKET}, where @file{RECIPIENT} is Base32 encoded
542 destination node, @file{SENDER} is Base32 encoded sender node.
544 Also look for @ref{nncp-bundle}, especially if you deal with CD-ROM and