]> Cypherpunks.ru repositories - nncp.git/blob - doc/cmd/nncp-cfgenc.texi
Add various documentation indices
[nncp.git] / doc / cmd / nncp-cfgenc.texi
1 @node nncp-cfgenc
2 @pindex nncp-cfgenc
3 @section nncp-cfgenc
4
5 @example
6 $ nncp-cfgenc [options] [-s INT] [-t INT] [-p INT] cfg.hjson > cfg.hjson.eblob
7 $ nncp-cfgenc [options] -d cfg.hjson.eblob > cfg.hjson
8 @end example
9
10 This command allows you to encrypt provided @file{cfg.hjson} file with
11 the passphrase, producing @ref{EBlob, eblob}, to safely keep your
12 configuration file with private keys. This utility was written for users
13 who do not want (or can not) to use either @url{https://gnupg.org/,
14 GnuPG} or similar tools. That @file{eblob} file can be used directly in
15 @option{-cfg} option of nearly all commands.
16
17 @option{-s}, @option{-t}, @option{-p} are used to tune @file{eblob}'s
18 password strengthening function. Space memory cost (@option{-s}),
19 specified in number of BLAKE2b-256 blocks (32 bytes), tells how many
20 memory must be used for hashing -- bigger values are better, but slower.
21 Time cost (@option{-t}) tells how many rounds/iterations must be
22 performed -- bigger is better, but slower. Number of parallel jobs
23 (@option{-p}) tells how many computation processes will be run: this is
24 the same as running that number of independent hashers and then joining
25 their result together.
26
27 When invoked for encryption, passphrase is entered manually twice. When
28 invoked for decryption (@option{-d} option), it is asked once and exits
29 if passphrase can not decrypt @file{eblob}.
30
31 @option{-dump} options parses @file{eblob} and prints parameters used
32 during its creation. For example:
33 @example
34 $ nncp-cfgenc -dump /usr/local/etc/nncp.hjson.eblob
35 Strengthening function: Balloon with BLAKE2b-256
36 Memory space cost: 1048576 bytes
37 Number of rounds: 16
38 Number of parallel jobs: 2
39 Blob size: 2494
40 @end example