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 Process only single specified node.
26 Override @ref{CfgVia, via} configuration option for destination node.
27 Specified nodes must be separated with comma: @verb{|NODE1,NODE2|}.
28 With @verb{|-via -|} you can disable relaying at all.
30 Override path to spool directory. May be specified by
31 @env{NNCPSPOOL} environment variable.
33 Override path to logfile. May be specified by @env{NNCPLOG}
36 Print only errors, omit simple informational messages. In any case
37 those messages are logged, so you can reread them using
38 @ref{nncp-log} command.
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 stdin and
59 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 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
102 NODE[:ADDR] [FORCEADDR]
105 Call (connect to) specified @option{NODE} and run @ref{Sync,
106 synchronization} protocol with the @ref{nncp-daemon, daemon} on the
107 remote side. Normally this command could be run any time you wish to
108 either check for incoming packets, or to send out queued ones.
109 Synchronization protocol allows resuming and bidirectional packets
112 If @option{-rx} option is specified then only inbound packets
113 transmission is performed. If @option{-tx} option is specified, then
114 only outbound transmission is performed. @option{-onlinedeadline}
115 overrides @ref{CfgOnlineDeadline, @emph{onlinedeadline}}.
116 @option{-maxonlinetime} overrides @ref{CfgMaxOnlineTime,
117 @emph{maxonlinetime}}. @option{-rxrate}/@option{-txrate} override
118 @ref{CfgXxRate, rxrate/txrate}.
124 % nncp-caller [options] [NODE ...]
127 Croned daemon that calls remote nodes from time to time, according to
128 their @ref{CfgCalls, @emph{calls}} configuration field.
130 Optional number of @option{NODE}s tells to ignore other ones.
131 Otherwise all nodes with specified @emph{calls} configuration
132 field will be called.
134 @option{-onlinedeadline} overrides @ref{CfgOnlineDeadline,
135 @emph{onlinedeadline}} configuration option.
137 Each @option{NODE} can contain several uniquely identified
138 @option{ADDR}esses in @ref{CfgAddrs, configuration} file. If you do
139 not specify the exact one, then all will be tried until the first
140 success. Optionally you can force @option{FORCEADDR} address usage,
141 instead of addresses taken from configuration file.
143 Pay attention that this command runs integrity check for each completely
144 received packet in the background. This can be time consuming.
145 Connection could be lost during that check and remote node won't be
146 notified that file is done. But after successful integrity check that
147 file is renamed from @file{.part} one and when you rerun
148 @command{nncp-call} again, remote node will receive completion
155 % nncp-cfgmin [options] [-s INT] [-t INT] [-p INT] cfg.yaml > cfg.yaml.eblob
156 % nncp-cfgmin [options] -d cfg.yaml.eblob > cfg.yaml
159 This command allows you to encrypt provided @file{cfg.yaml} file with
160 the passphrase, producing @ref{EBlob, eblob}, to safely keep your
161 configuration file with private keys. This utility was written for users
162 who do not want (or can not) to use either @url{https://gnupg.org/,
163 GnuPG} or similar tools. That @file{eblob} file can be used directly in
164 @option{-cfg} option of nearly all commands.
166 @option{-s}, @option{-t}, @option{-p} are used to tune @file{eblob}'s
167 password strengthening function. Space memory cost (@option{-s}),
168 specified in number of BLAKE2b-256 blocks (32 bytes), tells how many
169 memory must be used for hashing -- bigger values are better, but slower.
170 Time cost (@option{-t}) tells how many rounds/iterations must be
171 performed -- bigger is better, but slower. Number of parallel jobs
172 (@option{-p}) tells how many computation processes will be run: this is
173 the same as running that number of independent hashers and then joining
174 their result together.
176 When invoked for encryption, passphrase is entered manually twice. When
177 invoked for decryption (@option{-d} option), it is asked once and exits
178 if passphrase can not decrypt @file{eblob}.
180 @option{-dump} options parses @file{eblob} and prints parameters used
181 during its creation. For example:
183 % nncp-cfgenc -dump /usr/local/etc/nncp.yaml.eblob
184 Strengthening function: Balloon with BLAKE2b-256
185 Memory space cost: 1048576 bytes
187 Number of parallel jobs: 2
195 % nncp-cfgmin [options] > stripped.yaml
198 Print out stripped configuration version: only path to @ref{Spool,
199 spool}, path to log file, neighbours public keys are stayed. This is
200 useful mainly for usage with @ref{nncp-xfer} that has to know only
201 neighbours, without private keys involving.
207 % nncp-cfgnew [options] > new.yaml
210 Generate new node configuration: private keys, example configuration
211 file and print it to stdout. You must use this command when you setup
214 Pay attention that private keys generation consumes an entropy from your
221 % nncp-check [options]
224 Perform @ref{Spool, spool} directory integrity check. Read all files
225 that has Base32-encoded filenames and compare it with recalculated
226 BLAKE2b hash output of their contents. That supplementary command is
227 not used often in practice, if ever.
233 % nncp-daemon [options] [-maxconn INT] [-bind ADDR]
236 Start listening TCP daemon, wait for incoming connections and run
237 @ref{Sync, synchronization protocol} with each of them. You can run
238 @ref{nncp-toss} utility in background to process inbound packets from
241 @option{-maxconn} option specifies how many simultaneous clients daemon
242 can handle. @option{-bind} option specifies @option{addr:port} it must
249 % nncp-exec [options] NODE HANDLE [ARG0 ARG1 ...]
252 Send execution command to @option{NODE} for specified @option{HANDLE}.
253 Body is read from stdin and compressed. After receiving, remote side
254 will execute specified @ref{CfgExec, handle} command with @option{ARG*}
255 appended and decompressed body fed to command's stdin.
257 For example, if remote side has following configuration file for your
262 sendmail: [/usr/sbin/sendmail, "-t"]
263 appender: ["/bin/sh", "-c", "cat >> /append"]
266 then executing @verb{|echo My message | nncp-exec -replynice 123 REMOTE
267 sendmail root@localhost|} will lead to executing of:
272 NNCP_SENDER=OurNodeId \
274 /usr/sbin/sendmail -t root@localhost
282 % nncp-file [options] [-chunked INT] SRC NODE:[DST]
285 Send @file{SRC} file to remote @option{NODE}. @file{DST} specifies
286 destination file name in remote's @ref{CfgIncoming, incoming}
287 directory. If this file already exists there, then counter will be
290 This command queues file in @ref{Spool, spool} directory immediately
291 (through the temporary file of course) -- so pay attention that sending
292 2 GiB file will create 2 GiB outbound encrypted packet.
294 If @file{SRC} equals to @file{-}, then create an encrypted temporary
295 file and copy everything taken from stdin to it and use for outbound
296 packet creation. Pay attention that if you want to send 1 GiB of data
297 taken from stdin, then you have to have 2 GiB of disk space for that
298 temporary file and resulting encrypted packet. You can control where
299 temporary file will be stored using @env{TMPDIR} environment variable.
300 Encryption is performed with @url{https://cr.yp.to/chacha.html,
301 ChaCha20} algorithm. Data is splitted on 128 KiB blocks. Each block is
302 encrypted with increasing nonce counter.
304 If @option{-chunked} is specified, then source file will be split
305 @ref{Chunked, on chunks}. @option{INT} is the desired chunk size in
306 KiBs. This mode is more CPU hungry. Pay attention that chunk is saved in
307 spool directory immediately and it is not deleted if any error occurs.
308 @option{-minsize} option is applied per each chunk. Do not forget about
309 @ref{ChunkedZFS, possible} ZFS deduplication issues.
311 If @ref{CfgNotify, notification} is enabled on the remote side for
312 file transmissions, then it will sent simple letter after successful
319 % nncp-freq [options] NODE:SRC [DST]
322 Send file request to @option{NODE}, asking it to send its @file{SRC}
323 file from @ref{CfgFreq, freq} directory to our node under @file{DST}
324 filename in our @ref{CfgIncoming, incoming} one. If @file{DST} is not
325 specified, then last element of @file{SRC} will be used.
327 If @ref{CfgNotify, notification} is enabled on the remote side for
328 file request, then it will sent simple letter after successful file
338 Parse @ref{Log, log} file and print out its records in human-readable form.
344 % nncp-pkt [options] < pkt
345 % nncp-pkt [options] [-decompress] -dump < pkt > payload
348 Low level packet parser. Normally it should not be used, but can help in
351 By default it will print packet's type, for example:
353 Packet type: encrypted
355 Sender: 2WHBV3TPZHDOZGUJEH563ZEK7M33J4UESRFO4PDKWD5KZNPROABQ
358 If you specify @option{-dump} option and provide an @ref{Encrypted,
359 encrypted} packet, then it will verify and decrypt it to stdout.
360 Encrypted packets contain @ref{Plain, plain} ones, that also can be fed
361 to @command{nncp-pkt}:
365 Payload type: transitional
366 Path: VHMTRWDOXPLK7BR55ICZ5N32ZJUMRKZEMFNGGCEAXV66GG43PEBQ
370 Path: stargrave@stargrave.org
373 And with the @option{-dump} option it will give you the actual payload
374 (the whole file, mail message, and so on). @option{-decompress} option
375 tries to zlib-decompress the data from plain packet (useful for mail
382 % nncp-reass [options] [-dryrun] [-keep] [-dump] [-stdout] FILE.nncp.meta
383 % nncp-reass [options] [-dryrun] [-keep] {-all | -node NODE}
386 Reassemble @ref{Chunked, chunked file} after @ref{nncp-toss, tossing}.
388 When called with @option{FILE} option, this command will reassemble only
389 it. When called with @option{-node} option, this command will try to
390 reassemble all @file{.nncp.meta} files found in @option{NODE}'s
391 @ref{CfgIncoming, incoming} directory. When called with @option{-all}
392 option, then cycle through all known nodes to do the same.
394 Reassembling process does the following:
397 @item Parses @ref{Chunked, @file{.nncp.meta}} file.
398 @item Checks existence and size of every @file{.nncp.chunkXXX}.
399 @item Verifies integrity of every chunk.
400 @item Concatenates all chunks, simultaneously removing them from filesystem.
403 That process reads the whole data twice. Be sure to have free disk
404 space for at least one chunk. Decrypted chunk files as a rule are saved
405 in pseudo-random order, so removing them during reassembly process will
406 likely lead to filesystem fragmentation. Reassembly process on
407 filesystems with deduplication capability should be rather lightweight.
409 If @option{-dryrun} option is specified, then only existence and
410 integrity checking are performed.
412 If @option{-keep} option is specified, then no
413 @file{.nncp.meta}/@file{.nncp.chunkXXX} files are deleted during
416 @option{-stdout} option outputs reassembled file to stdout, instead of
417 saving to temporary file with renaming after. This could be useful for
418 reassembling on separate filesystem to lower fragmentation effect,
419 and/or separate storage device for higher performance.
421 @option{-dump} option prints meta-file contents in human-friendly form.
422 It is useful mainly for debugging purposes. For example:
424 Original filename: testfile
425 File size: 3.8 MiB (3987795 bytes)
426 Chunk size: 1.0 MiB (1048576 bytes)
429 0: eac60d819edf40b8ecdacd0b9a5a8c62de2d15eef3c8ca719eafa0be9b894017
430 1: 013a07e659f2e353d0e4339c3375c96c7fffaa2fa00875635f440bbc4631052a
431 2: f4f883975a663f2252328707a30e71b2678f933b2f3103db8475b03293e4316e
432 3: 0e9e229501bf0ca42d4aa07393d19406d40b179f3922a3986ef12b41019b45a3
435 Do not forget about @ref{ChunkedZFS, possible} ZFS deduplication issues.
441 % nncp-rm [options] -tmp
442 % nncp-rm [options] -lock
443 % nncp-rm [options] -node NODE -part
444 % nncp-rm [options] -node NODE -seen
445 % nncp-rm [options] -node NODE [-rx] [-tx]
446 % nncp-rm [options] -node NODE -pkt PKT
449 This command is aimed to delete various files from your spool directory:
452 @item If @option{-tmp} option is specified, then it will delete all
453 temporary files in @file{spool/tmp} directory. Files may stay in it when
454 commands like @ref{nncp-file} fail for some reason.
455 @item If @option{-lock} option is specified, then all @file{.lock} files
456 will be deleted in your spool directory.
457 @item If @option{-pkt} option is specified, then @file{PKT} packet (its
458 Base32 name) will be deleted. This is useful when you see some packet
459 failing to be processed.
460 @item When either @option{-rx} or @option{-tx} options are specified
461 (maybe both of them), then delete all packets from that given queues. If
462 @option{-part} is given, then delete only @file{.part}ly downloaded
463 ones. If @option{-seen} option is specified, then delete only
471 % nncp-stat [options]
474 Print current @ref{Spool, spool} statistics about unsent and unprocessed
475 packets. For each node and each niceness level there will be printed how
476 many packets (with the total size) are in inbound (Rx) and outbound (Tx)
483 % nncp-toss [options]
493 Perform "tossing" operation on all inbound packets. This is the tool
494 that decrypts all packets and processes all payload packets in them:
495 copies files, sends mails, sends out file requests and relays transition
496 packets. It should be run after each online/offline exchange.
498 @option{-dryrun} option does not perform any writing and sending, just
499 tells what it will do.
501 @option{-cycle} option tells not to quit, but to repeat tossing every
502 @option{INT} seconds in an infinite loop. That can be useful when
503 running this command as a daemon.
505 @option{-seen} option creates empty @file{XXX.seen} file after
506 successful tossing of @file{XXX} packet. @ref{nncp-xfer} and
507 @ref{nncp-bundle} commands skip inbound packets that has been already
508 seen, processed and tossed. This is helpful to defeat duplicates.
510 @option{-nofile}, @option{-nofreq}, @option{-nomail}, @option{-notrns}
511 options allow to disable any kind of packet types processing.
517 % nncp-xfer [options] [-mkdir] [-keep] [-rx|-tx] DIR
520 Search for directory in @file{DIR} containing inbound packets for us and
521 move them to local @ref{Spool, spool} directory. Also search for known
522 neighbours directories and move locally queued outbound packets to them.
523 This command is used for offline packets transmission.
525 If @option{-mkdir} option is specified, then outbound neighbour(s)
526 directories will be created. This is useful for the first time usage,
527 when storage device does not have any directories tree.
529 If @option{-keep} option is specified, then keep copied files, do not
532 @option{-rx} option tells only to move inbound packets addressed to us.
533 @option{-tx} option tells exactly the opposite: move only outbound packets.
535 @ref{nncp-cfgmin} could be useful for creating stripped minimalistic
536 configuration file version without any private keys.
538 @file{DIR} directory has the following structure:
539 @file{RECIPIENT/SENDER/PACKET}, where @file{RECIPIENT} is Base32 encoded
540 destination node, @file{SENDER} is Base32 encoded sender node.
542 Also look for @ref{nncp-bundle}, especially if you deal with CD-ROM and