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 Process only single specified node.
24 Override path to spool directory. May be specified by
25 @env{NNCPSPOOL} environment variable.
27 Override path to logfile. May be specified by @env{NNCPLOG}
30 Print only errors, omit simple informational messages. In any case
31 those messages are logged, so you can reread them using
32 @ref{nncp-log} command.
34 Print version information.
36 Print warranty information (no warranty).
43 % nncp-bundle [options] -tx [-delete] NODE [NODE ...] > ...
44 % nncp-bundle [options] -rx -delete [-dryrun] [NODE ...] < ...
45 % nncp-bundle [options] -rx [-check] [-dryrun] [NODE ...] < ...
48 With @option{-tx} option, this command creates @ref{Bundles, bundle} of
49 @ref{Encrypted, encrypted packets} from the spool directory and writes
52 With @option{-rx} option, this command takes bundle from stdin and
53 copies all found packets for our node to the spool directory. Pay
54 attention that @strong{no} integrity checking is done by default. Modern
55 tape drives could easily provide too much throughput your CPU won't be
56 able to verify on the fly. So if you won't @ref{nncp-toss, toss}
57 received packets at the place, it is advisable either to run
58 @ref{nncp-check} utility for packets integrity verification, or to use
59 @option{-check} option to enable on the fly integrity check.
61 You can specify multiple @option{NODE} arguments, telling for what nodes
62 you want to create the stream, or take it from. If no nodes are
63 specified for @option{-rx} mode, then all packets aimed at us will be
66 When packets are sent through the stream, they are still kept in the
67 spool directory, because there is no assurance that they are transferred
68 to the media (media (CD-ROM, tape drive, raw hard drive) can end). If
69 you want to forcefully delete them (after they are successfully flushed
70 to stdout) anyway, use @option{-delete} option.
72 But you can verify produced stream after, by digesting it by yourself
73 with @option{-rx} and @option{-delete} options -- in that mode, stream
74 packets integrity will be checked and they will be deleted from the
75 spool if everything is good. So it is advisable to recheck your streams:
78 % nncp-bundle -tx ALICE BOB WHATEVER | cdrecord -tao -
79 % dd if=/dev/cd0 bs=2048 | nncp-bundle -rx -delete
82 @option{-dryrun} option prevents any writing to the spool. This is
83 useful when you need to see what packets will pass by and possibly check
90 % nncp-call [options] [-onlinedeadline INT] [-maxonlinetime INT] [-rx|-tx]
91 NODE[:ADDR] [FORCEADDR]
94 Call (connect to) specified @option{NODE} and run @ref{Sync,
95 synchronization} protocol with the @ref{nncp-daemon, daemon} on the
96 remote side. Normally this command could be run any time you wish to
97 either check for incoming packets, or to send out queued ones.
98 Synchronization protocol allows resuming and bidirectional packets
101 If @option{-rx} option is specified then only inbound packets
102 transmission is performed. If @option{-tx} option is specified, then
103 only outbound transmission is performed. @option{-onlinedeadline}
104 overrides @ref{CfgOnlineDeadline, @emph{onlinedeadline}}.
105 @option{-maxonlinetime} overrides @ref{CfgMaxOnlineTime,
106 @emph{maxonlinetime}}.
112 % nncp-caller [options] [NODE ...]
115 Croned daemon that calls remote nodes from time to time, according to
116 their @ref{CfgCalls, @emph{calls}} configuration field.
118 Optional number of @option{NODE}s tells to ignore other ones.
119 Otherwise all nodes with specified @emph{calls} configuration
120 field will be called.
122 @option{-onlinedeadline} overrides @ref{CfgOnlineDeadline,
123 @emph{onlinedeadline}} configuration option.
125 Each @option{NODE} can contain several uniquely identified
126 @option{ADDR}esses in @ref{CfgAddrs, configuration} file. If you do
127 not specify the exact one, then all will be tried until the first
128 success. Optionally you can force @option{FORCEADDR} address usage,
129 instead of addresses taken from configuration file.
131 Pay attention that this command runs integrity check for each completely
132 received packet in the background. This can be time consuming.
133 Connection could be lost during that check and remote node won't be
134 notified that file is done. But after successful integrity check that
135 file is renamed from @file{.part} one and when you rerun
136 @command{nncp-call} again, remote node will receive completion
143 % nncp-cfgmin [options] [-s INT] [-t INT] [-p INT] cfg.yaml > cfg.yaml.eblob
144 % nncp-cfgmin [options] -d cfg.yaml.eblob > cfg.yaml
147 This command allows you to encrypt provided @file{cfg.yaml} file with
148 the passphrase, producing @ref{EBlob, eblob}, to safely keep your
149 configuration file with private keys. This utility was written for users
150 who do not want (or can not) to use either @url{https://gnupg.org/,
151 GnuPG} or similar tools. That @file{eblob} file can be used directly in
152 @option{-cfg} option of nearly all commands.
154 @option{-s}, @option{-t}, @option{-p} are used to tune @file{eblob}'s
155 password strengthening function. Space memory cost (@option{-s}),
156 specified in number of BLAKE2b-256 blocks (32 bytes), tells how many
157 memory must be used for hashing -- bigger values are better, but slower.
158 Time cost (@option{-t}) tells how many rounds/iterations must be
159 performed -- bigger is better, but slower. Number of parallel jobs
160 (@option{-p}) tells how many computation processes will be run: this is
161 the same as running that number of independent hashers and then joining
162 their result together.
164 When invoked for encryption, passphrase is entered manually twice. When
165 invoked for decryption (@option{-d} option), it is asked once and exits
166 if passphrase can not decrypt @file{eblob}.
168 @option{-dump} options parses @file{eblob} and prints parameters used
169 during its creation. For example:
171 % nncp-cfgenc -dump /usr/local/etc/nncp.yaml.eblob
172 Strengthening function: Balloon with BLAKE2b-256
173 Memory space cost: 1048576 bytes
175 Number of parallel jobs: 2
183 % nncp-cfgmin [options] > stripped.yaml
186 Print out stripped configuration version: only path to @ref{Spool,
187 spool}, path to log file, neighbours public keys are stayed. This is
188 useful mainly for usage with @ref{nncp-xfer} that has to know only
189 neighbours, without private keys involving.
195 % nncp-cfgnew [options] > new.yaml
198 Generate new node configuration: private keys, example configuration
199 file and print it to stdout. You must use this command when you setup
202 Pay attention that private keys generation consumes an entropy from your
209 % nncp-check [options]
212 Perform @ref{Spool, spool} directory integrity check. Read all files
213 that has Base32-encoded filenames and compare it with recalculated
214 BLAKE2b hash output of their contents. That supplementary command is
215 not used often in practice, if ever.
221 % nncp-daemon [options] [-maxconn INT] [-bind ADDR]
224 Start listening TCP daemon, wait for incoming connections and run
225 @ref{Sync, synchronization protocol} with each of them. You can run
226 @ref{nncp-toss} utility in background to process inbound packets from
229 @option{-maxconn} option specifies how many simultaneous clients daemon
230 can handle. @option{-bind} option specifies @option{addr:port} it must
237 % nncp-file [options] [-chunked INT] SRC NODE:[DST]
240 Send @file{SRC} file to remote @option{NODE}. @file{DST} specifies
241 destination file name in remote's @ref{CfgIncoming, incoming}
242 directory. If this file already exists there, then counter will be
245 This command queues file in @ref{Spool, spool} directory immediately
246 (through the temporary file of course) -- so pay attention that sending
247 2 GiB file will create 2 GiB outbound encrypted packet.
249 If @file{SRC} equals to @file{-}, then create an encrypted temporary
250 file and copy everything taken from stdin to it and use for outbound
251 packet creation. Pay attention that if you want to send 1 GiB of data
252 taken from stdin, then you have to have 2 GiB of disk space for that
253 temporary file and resulting encrypted packet. You can control where
254 temporary file will be stored using @env{TMPDIR} environment variable.
255 Encryption is performed with @url{https://cr.yp.to/chacha.html,
256 ChaCha20} algorithm. Data is splitted on 128 KiB blocks. Each block is
257 encrypted with increasing nonce counter.
259 If @option{-chunked} is specified, then source file will be split
260 @ref{Chunked, on chunks}. @option{INT} is the desired chunk size in
261 KiBs. This mode is more CPU hungry. Pay attention that chunk is saved in
262 spool directory immediately and it is not deleted if any error occurs.
263 @option{-minsize} option is applied per each chunk.
265 If @ref{CfgNotify, notification} is enabled on the remote side for
266 file transmissions, then it will sent simple letter after successful
273 % nncp-freq [options] NODE:SRC [DST]
276 Send file request to @option{NODE}, asking it to send its @file{SRC}
277 file from @ref{CfgFreq, freq} directory to our node under @file{DST}
278 filename in our @ref{CfgIncoming, incoming} one. If @file{DST} is not
279 specified, then last element of @file{SRC} will be used.
281 If @ref{CfgNotify, notification} is enabled on the remote side for
282 file request, then it will sent simple letter after successful file
292 Parse @ref{Log, log} file and print out its records in human-readable form.
298 % nncp-mail [options] NODE USER ...
301 Send mail, that is read from stdin, to @option{NODE} and specified
302 @option{USER}s. Mail message will be compressed. After receiving, remote
303 side will execute specified @ref{CfgSendmail, sendmail} command with
304 @option{USER}s appended as a command line argument and feed decompressed
305 mail body to that command's stdin.
311 % nncp-pkt [options] < pkt
312 % nncp-pkt [options] [-decompress] -dump < pkt > payload
315 Low level packet parser. Normally it should not be used, but can help in
318 By default it will print packet's type, for example:
320 Packet type: encrypted
322 Sender: 2WHBV3TPZHDOZGUJEH563ZEK7M33J4UESRFO4PDKWD5KZNPROABQ
325 If you specify @option{-dump} option and provide an @ref{Encrypted,
326 encrypted} packet, then it will verify and decrypt it to stdout.
327 Encrypted packets contain @ref{Plain, plain} ones, that also can be fed
328 to @command{nncp-pkt}:
332 Payload type: transitional
333 Path: VHMTRWDOXPLK7BR55ICZ5N32ZJUMRKZEMFNGGCEAXV66GG43PEBQ
337 Path: stargrave@stargrave.org
340 And with the @option{-dump} option it will give you the actual payload
341 (the whole file, mail message, and so on). @option{-decompress} option
342 tries to zlib-decompress the data from plain packet (useful for mail
349 % nncp-reass [options] [-dryrun] [-keep] [-dump] [-stdout] FILE.nncp.meta
350 % nncp-reass [options] [-dryrun] [-keep] {-all | -node NODE}
353 Reassemble @ref{Chunked, chunked file} after @ref{nncp-toss, tossing}.
355 When called with @option{FILE} option, this command will reassemble only
356 it. When called with @option{-node} option, this command will try to
357 reassemble all @file{.nncp.meta} files found in @option{NODE}'s
358 @ref{CfgIncoming, incoming} directory. When called with @option{-all}
359 option, then cycle through all known nodes to do the same.
361 Reassembling process does the following:
364 @item Parses @ref{Chunked, @file{.nncp.meta}} file.
365 @item Checks existence and size of every @file{.nncp.chunkXXX}.
366 @item Verifies integrity of every chunk.
367 @item Concatenates all chunks, simultaneously removing them from filesystem.
370 That process reads the whole data twice. Be sure to have free disk
371 space for at least one chunk. Decrypted chunk files as a rule are saved
372 in pseudo-random order, so removing them during reassembly process will
373 likely lead to filesystem fragmentation. Reassembly process on
374 filesystems with deduplication capability should be rather lightweight.
376 If @option{-dryrun} option is specified, then only existence and
377 integrity checking are performed.
379 If @option{-keep} option is specified, then no
380 @file{.nncp.meta}/@file{.nncp.chunkXXX} files are deleted during
383 @option{-stdout} option outputs reassembled file to stdout, instead of
384 saving to temporary file with renaming after. This could be useful for
385 reassembling on separate filesystem to lower fragmentation effect,
386 and/or separate storage device for higher performance.
388 @option{-dump} option prints meta-file contents in human-friendly form.
389 It is useful mainly for debugging purposes. For example:
391 Original filename: testfile
392 File size: 3.8 MiB (3987795 bytes)
393 Chunk size: 1.0 MiB (1048576 bytes)
396 0: eac60d819edf40b8ecdacd0b9a5a8c62de2d15eef3c8ca719eafa0be9b894017
397 1: 013a07e659f2e353d0e4339c3375c96c7fffaa2fa00875635f440bbc4631052a
398 2: f4f883975a663f2252328707a30e71b2678f933b2f3103db8475b03293e4316e
399 3: 0e9e229501bf0ca42d4aa07393d19406d40b179f3922a3986ef12b41019b45a3
406 % nncp-rm [options] -tmp
407 % nncp-rm [options] -lock
408 % nncp-rm [options] -node NODE -part
409 % nncp-rm [options] -node NODE -seen
410 % nncp-rm [options] -node NODE [-rx] [-tx]
411 % nncp-rm [options] -node NODE -pkt PKT
414 This command is aimed to delete various files from your spool directory:
417 @item If @option{-tmp} option is specified, then it will delete all
418 temporary files in @file{spool/tmp} directory. Files may stay in it when
419 commands like @ref{nncp-file} fail for some reason.
420 @item If @option{-lock} option is specified, then all @file{.lock} files
421 will be deleted in your spool directory.
422 @item If @option{-pkt} option is specified, then @file{PKT} packet (its
423 Base32 name) will be deleted. This is useful when you see some packet
424 failing to be processed.
425 @item When either @option{-rx} or @option{-tx} options are specified
426 (maybe both of them), then delete all packets from that given queues. If
427 @option{-part} is given, then delete only @file{.part}ly downloaded
428 ones. If @option{-seen} option is specified, then delete only
436 % nncp-stat [options]
439 Print current @ref{Spool, spool} statistics about unsent and unprocessed
440 packets. For each node and each niceness level there will be printed how
441 many packets (with the total size) are in inbound (Rx) and outbound (Tx)
448 % nncp-toss [options] [-dryrun] [-cycle INT] [-seen]
451 Perform "tossing" operation on all inbound packets. This is the tool
452 that decrypts all packets and processes all payload packets in them:
453 copies files, sends mails, sends out file requests and relays transition
454 packets. It should be run after each online/offline exchange.
456 @option{-dryrun} option does not perform any writing and sending, just
457 tells what it will do.
459 @option{-cycle} option tells not to quit, but to repeat tossing every
460 @option{INT} seconds in an infinite loop. That can be useful when
461 running this command as a daemon.
463 @option{-seen} option creates empty @file{XXX.seen} file after
464 successful tossing of @file{XXX} packet. @ref{nncp-xfer} and
465 @ref{nncp-bundle} commands skip inbound packets that has been already
466 seen, processed and tossed. This is helpful to defeat duplicates.
472 % nncp-xfer [options] [-mkdir] [-keep] [-rx|-tx] DIR
475 Search for directory in @file{DIR} containing inbound packets for us and
476 move them to local @ref{Spool, spool} directory. Also search for known
477 neighbours directories and move locally queued outbound packets to them.
478 This command is used for offline packets transmission.
480 If @option{-mkdir} option is specified, then outbound neighbour(s)
481 directories will be created. This is useful for the first time usage,
482 when storage device does not have any directories tree.
484 If @option{-keep} option is specified, then keep copied files, do not
487 @option{-rx} option tells only to move inbound packets addressed to us.
488 @option{-tx} option tells exactly the opposite: move only outbound packets.
490 @ref{nncp-cfgmin} could be useful for creating stripped minimalistic
491 configuration file version without any private keys.
493 @file{DIR} directory has the following structure:
494 @file{RECIPIENT/SENDER/PACKET}, where @file{RECIPIENT} is Base32 encoded
495 destination node, @file{SENDER} is Base32 encoded sender node.
497 Also look for @ref{nncp-bundle}, especially if you deal with CD-ROM and