Merge pull request #2 from wolfmcnally/develop

Compatibility improvements.

Author: ChristopherA

.vscode/launch.json

@@ -7,7 +7,7 @@
             "type": "lldb",
             "request": "launch",
             "program": "${workspaceFolder}/src/seedtool",
-            "args": ["--in", "hex", "--out", "bip39", "38a8aaa2d6caff920c67"],
+            "args": [],
             "cwd": "${workspaceFolder}/src",
             "preLaunchTask": "Build"
         }

MANUAL.md

@@ -1,6 +1,6 @@
 # 🌱 Seedtool
 
-**Version 1.0.0b1**<br/>**April 8, 2020**
+**Version 0.1.1**<br/>**April 8, 2020**
 
 *Copyright © 2020 by Blockchain Commons, LLC*<br/>*Licensed under the "BSD-2-Clause Plus Patent License"*
 
@@ -230,7 +230,7 @@ $ seedtool --out bits
 #
 
 $ seedtool --in bits 1110110001110111
-ed8f723f8216781a047886244f6f75c0
+8d933e43b1bc8f2e3fc27adc98ad4534
 
 #
 # Construct the same seed from those bits, providing them via stdin.
@@ -239,7 +239,7 @@ ed8f723f8216781a047886244f6f75c0
 $ seedtool --in bits
 1110110001110111
 ^D
-ed8f723f8216781a047886244f6f75c0
+8d933e43b1bc8f2e3fc27adc98ad4534
 ```
 
 ```
@@ -257,14 +257,14 @@ $ seedtool --out cards
 #
 
 $ seedtool --in cards 6c9s8c7c9c4cah6c2sjs7d5c2s4c4dqs
-2bcd58e32a6fa0f55b6a2e24d77e706f
+7df301924511326d7350be14c9e7176d
 
 #
 # Construct a longer 32-byte seed from those same playing cards.
 #
 
 $ seedtool --count 32 --in cards 6c9s8c7c9c4cah6c2sjs7d5c2s4c4dqs
-2bcd58e32a6fa0f55b6a2e24d77e706fdd165482b36dcab10d271a262097bca4
+7df301924511326d7350be14c9e7176d98e945f9ad0ed034726ad4ee0de59c25
 ```
 
 ```
@@ -274,21 +274,21 @@ $ seedtool --count 32 --in cards 6c9s8c7c9c4cah6c2sjs7d5c2s4c4dqs
 #
 
 $ seedtool --in dice 3343462611234633
-d28e978aba2967adb66d4fec42ea6086
+77ae0de807d60367311eb040c70690d2
 
 #
 # Construct a 16-byte seed from any number of digits in [0-5].
 #
 
 $ seedtool --in base6 3242235101442242
-e57ff8f262fbeb623a2a86baa52935f0
+51621269b3a91fe6482ceb7779f0d1d1
 
 #
 # Construct a 16-byte seed from any number of digits in [0-9].
 #
 
 $ seedtool --in base10 3190125
-61cfda662ecb32294f508fdac513ed9d
+a0ca21e20db54b4df7479737c145f6db
 
 #
 # Construct a 16-byte seed from any number of integers in [0-255].
@@ -305,17 +305,17 @@ Output of one call to seedtool can be piped into another.
 #
 
 $ seedtool --out dice | seedtool --in dice --count 32
-838e8c1f73d06282d852733e564430afd0ce2162a734c506167e4cce0d54a3f6
+7bdf68608e30da4b9ec48af0cb48f2601b41d1bcc8859b4f625d6c0470f3a6dd
 
 #
 # Roll 16 dice saving them to a file, and create a 16-byte seed
 # from them.
 #
 
 $ seedtool --out dice | tee dice.asc | seedtool --in dice
-b67a2f937179e532821cfd9836aa56d4
+c13be193c8e3451a20b75e8dc0f69284
 $ cat dice.asc 
-4265544111216531
+4435442555226432
 ```
 
 If a smaller or larger seed is desired, the `--count` option specifies how many bytes it contains.
@@ -326,21 +326,21 @@ If a smaller or larger seed is desired, the `--count` option specifies how many
 #
 
 $ seedtool --in bits --count 8 0111100011000011
-1e4914918ce8f4dc
+1a4783f9e4e8eb68
 
 #
 # Create a 32-byte seed from any number of bits.
 #
 
 $ seedtool --in bits --count 32 0111100011000011
-1e4914918ce8f4dc08755e0b4f97fb6d4715ce9692a91ef600526543543f1af1
+1a4783f9e4e8eb6862cbd34acfe4f79ee8ee4e0e6f5726e589a36c7e8bf8a547
 
 #
 # Create a 20-byte seed from any number of playing cards.
 #
 
 $ seedtool --in cards --count 20 6c2c3hthacts6d4hkhtd2d7c6c3sqs6h
-f44c7708363d99857e60cb313a803902a5363336
+731e0a4c76189b2b55f4c705ccbb0105d3ee72c0
 ```
 
 `bip39` and `slip39` output formats can be combined with the `random` (default) input format. If the `--count N` option is used with the `hex` input format, it results in a seed of `N` bytes being generated and used.
@@ -506,36 +506,36 @@ $ seedtool --out dice
 #
 
 $ seedtool --in dice 5343553122555345
-122540402a49e1abb75c9d2754db1ce1
+5d1c30bbc6f3cfd070067b63c851ffe7
 
 #
 # Construct SLIP39 share from seed.
 #
 
-$ seedtool --in hex --out slip39 122540402a49e1abb75c9d2754db1ce1
-device aluminum academic academic crush engage exercise acquire genuine necklace radar twice tension photo float walnut remove lecture maximum biology
+$ seedtool --in hex --out slip39 5d1c30bbc6f3cfd070067b63c851ffe7
+edge enlarge academic academic body necklace surprise resident burden taxi painting slim research teammate peasant ivory weapon gesture voice flexible
 
 #
 # Recover the seed from the SLIP39 share.
 #
 
-$ seedtool --in slip39 "device aluminum academic academic crush engage exercise acquire genuine necklace radar twice tension photo float walnut remove lecture maximum biology"
-122540402a49e1abb75c9d2754db1ce1
+$ seedtool --in slip39 "edge enlarge academic academic body necklace surprise resident burden taxi painting slim research teammate peasant ivory weapon gesture voice flexible"
+5d1c30bbc6f3cfd070067b63c851ffe7
 
 #
 # Again construct SLIP39 share from the same seed. Notice the
 # share is different than last time.
 #
 
-$ seedtool --in hex --out slip39 122540402a49e1abb75c9d2754db1ce1
-aunt branch academic academic declare pajamas firefly costume wrote advocate payroll ting answer graduate helpful column dilemma realize cylinder stilt
+$ seedtool --in hex --out slip39 5d1c30bbc6f3cfd070067b63c851ffe7
+result leader academic academic apart length alcohol adult patrol military counter enjoy animal standard club facility belong rumor problem answer
 
 #
 # Recover the second share and notice that the seed is the same.
 #
 
-$ seedtool --in slip39 "aunt branch academic academic declare pajamas firefly costume wrote advocate payroll ting answer graduate helpful column dilemma realize cylinder stilt"
-122540402a49e1abb75c9d2754db1ce1
+$ seedtool --in slip39 "result leader academic academic apart length alcohol adult patrol military counter enjoy animal standard club facility belong rumor problem answer"
+5d1c30bbc6f3cfd070067b63c851ffe7
 ```
 
 
@@ -563,7 +563,7 @@ d551108c3e7831532beded6b29438683
 #
 
 $ seedtool --deterministic test2
-68b275e740cb5f89bb5444694aaa2dbc82ab6aa4d9869b3995cb6aa3c622e6d1
+a97770028023ece0f9307bf867b4c740
 ```
 
 In this example, the same entropy is used twice in producing a SLIP39 share, which would normally result in two different shares being produced. But by providing `--deterministic FOOBAR`, the same results are produced.
@@ -581,29 +581,58 @@ $ seedtool --deterministic FOOBAR --out dice
 #
 
 $ seedtool --in dice 1533324122434244
-b00248aedff06ea356a6f0e362ed8a07
+5cd271b50b98a869da1c26a526e1d3a8
 
 #
 # Display our seed as a SLIP39 2-of-3 shares, using
 # deterministic randomness.
 #
 
-$ seedtool --deterministic FOOBAR --in hex --out slip39 --group 2-of-3 b00248aedff06ea356a6f0e362ed8a07
-response lunch academic acid counter angel bucket trust guitar increase divorce stilt gasoline junk hearing crunch sprinkle sheriff pile salon
-response lunch academic agency buyer wisdom salary mason superior tracks glasses picture adult capacity ultimate pistol biology enjoy snake satisfy
-response lunch academic always alto wrap scroll music entrance easy lunch describe champion receiver artwork mouse false morning thunder video
+$ seedtool --deterministic FOOBAR --in hex --out slip39 --group 2-of-3 5cd271b50b98a869da1c26a526e1d3a8
+response lunch academic acid breathe ocean mixture traffic object sheriff rapids victim froth testify retreat patent prize human usual hobo
+response lunch academic agency activity fiber escape research earth pipeline prevent prepare activity erode grumpy problem justice vampire tension custody
+response lunch academic always crisis cards chemical expect muscle anxiety training thunder climate plan geology bulb scatter teacher gravity guilt
 
 #
 # Do all of the above on a single line, and note that because
 # of deterministic randomness, the same final output is produced.
 #
 
 $ seedtool --deterministic FOOBAR --out dice | seedtool --in dice | seedtool --deterministic FOOBAR --in hex --out slip39 --group 2-of-3
-response lunch academic acid counter angel bucket trust guitar increase divorce stilt gasoline junk hearing crunch sprinkle sheriff pile salon
-response lunch academic agency buyer wisdom salary mason superior tracks glasses picture adult capacity ultimate pistol biology enjoy snake satisfy
-response lunch academic always alto wrap scroll music entrance easy lunch describe champion receiver artwork mouse false morning thunder video
+response lunch academic acid breathe ocean mixture traffic object sheriff rapids victim froth testify retreat patent prize human usual hobo
+response lunch academic agency activity fiber escape research earth pipeline prevent prepare activity erode grumpy problem justice vampire tension custody
+response lunch academic always crisis cards chemical expect muscle anxiety training thunder climate plan geology bulb scatter teacher gravity guilt
+```
+
+## Compatibility
+
+* seedtool has been tested to give the same results as [Ian Coleman's BIP39 tool](https://iancoleman.io/bip39/) for the following input methods: `base6`, `base10`, `bits`, and `dice`.
+* `hex` as an input method is already compatible if used with his tool in "raw entropy" mode.
+* `cards` is not currently compatible.
+
+The example below can be replicated using Coleman's tool and selecting the following options:
+
+* Show entropy
+* Base: 10
+* Entropy: 123456
+* Mnemonic length: 12 words
+
+```
+$ seedtool --in base10 123456 | seedtool --in hex --out bip39
+mirror reject rookie talk pudding throw happy era myth already payment owner
 ```
 
 ## Version History
 
-**1.0.0b1, 4/8/2020:** First test release.
+### 0.1.1, 4/8/2020
+
+* Added compatibility with Ian Coleman's BIP39 tool for several input formats:
+    * `base6`, `base10`, `bits`, and `dice` are now compatible.
+    * `hex` as an input method is already compatible if used with his tool in "raw entropy" mode.
+    * `cards` is not compatible as his algorithm is complex and possibly not worth spending the time on.
+* Updated MANUAL.md examples to remain accurate.
+* Added a section on Compatibility with other tools to MANUAL.md.
+
+### 0.1.0, 4/8/2020
+
+* First test release.

README.md

@@ -91,7 +91,7 @@ We do ask that you offer us good faith and use best efforts not to leak informat
 
 ## Reporting a Vulnerability
 
-Please report suspected security vulnerabilities in private via email to ChristopherA@LifeWithAlacrity.com (do not use this email for support). Please do NOT create publicly viewable issues for suspected security vulnerabilities.
+Please report suspected security vulnerabilities in private via email to ChristopherA@BlockchainCommons.com (do not use this email for support). Please do NOT create publicly viewable issues for suspected security vulnerabilities.
 
 The following keys may be used to communicate sensitive information to developers:
 

configure

@@ -1,6 +1,6 @@
 #! /bin/sh
 # Guess values for system-dependent variables and create Makefiles.
-# Generated by GNU Autoconf 2.69 for bc-seedtool-cli 1.0.0b1.
+# Generated by GNU Autoconf 2.69 for bc-seedtool-cli 0.1.1.
 #
 #
 # Copyright (C) 1992-1996, 1998-2012 Free Software Foundation, Inc.
@@ -577,8 +577,8 @@ MAKEFLAGS=
 # Identity of this package.
 PACKAGE_NAME='bc-seedtool-cli'
 PACKAGE_TARNAME='bc-seedtool-cli'
-PACKAGE_VERSION='1.0.0b1'
-PACKAGE_STRING='bc-seedtool-cli 1.0.0b1'
+PACKAGE_VERSION='0.1.1'
+PACKAGE_STRING='bc-seedtool-cli 0.1.1'
 PACKAGE_BUGREPORT=''
 PACKAGE_URL=''
 
@@ -1231,7 +1231,7 @@ if test "$ac_init_help" = "long"; then
   # Omit some internal or obsolete options to make the list less imposing.
   # This message is too long to be a string in the A/UX 3.1 sh.
   cat <<_ACEOF
-\`configure' configures bc-seedtool-cli 1.0.0b1 to adapt to many kinds of systems.
+\`configure' configures bc-seedtool-cli 0.1.1 to adapt to many kinds of systems.
 
 Usage: $0 [OPTION]... [VAR=VALUE]...
 
@@ -1292,7 +1292,7 @@ fi
 
 if test -n "$ac_init_help"; then
   case $ac_init_help in
-     short | recursive ) echo "Configuration of bc-seedtool-cli 1.0.0b1:";;
+     short | recursive ) echo "Configuration of bc-seedtool-cli 0.1.1:";;
    esac
   cat <<\_ACEOF
 
@@ -1374,7 +1374,7 @@ fi
 test -n "$ac_init_help" && exit $ac_status
 if $ac_init_version; then
   cat <<\_ACEOF
-bc-seedtool-cli configure 1.0.0b1
+bc-seedtool-cli configure 0.1.1
 generated by GNU Autoconf 2.69
 
 Copyright (C) 2012 Free Software Foundation, Inc.
@@ -1885,7 +1885,7 @@ cat >config.log <<_ACEOF
 This file contains any messages produced by compilers while
 running configure, to aid debugging if configure makes a mistake.
 
-It was created by bc-seedtool-cli $as_me 1.0.0b1, which was
+It was created by bc-seedtool-cli $as_me 0.1.1, which was
 generated by GNU Autoconf 2.69.  Invocation command line was
 
   $ $0 $@
@@ -4868,7 +4868,7 @@ cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1
 # report actual input values of CONFIG_FILES etc. instead of their
 # values after options handling.
 ac_log="
-This file was extended by bc-seedtool-cli $as_me 1.0.0b1, which was
+This file was extended by bc-seedtool-cli $as_me 0.1.1, which was
 generated by GNU Autoconf 2.69.  Invocation command line was
 
   CONFIG_FILES    = $CONFIG_FILES
@@ -4930,7 +4930,7 @@ _ACEOF
 cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1
 ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`"
 ac_cs_version="\\
-bc-seedtool-cli config.status 1.0.0b1
+bc-seedtool-cli config.status 0.1.1
 configured by $0, generated by GNU Autoconf 2.69,
   with options \\"\$ac_cs_config\\"
 

configure.ac

@@ -2,7 +2,7 @@
 # Process this file with autoconf to produce a configure script.
 
 AC_PREREQ([2.69])
-AC_INIT([bc-seedtool-cli], [1.0.0b1])
+AC_INIT([bc-seedtool-cli], [0.1.1])
 AC_CONFIG_SRCDIR([src/seedtool.cpp])
 AC_CONFIG_HEADERS([src/config.h])
 

src/format-base10.cpp

@@ -15,8 +15,15 @@
 
 void FormatBase10::process_input(Params* p) {
     auto input = p->get_one_argument();
+    
+    #if 0
     auto entropy = digits_to_data(input, 0, 9);
     p->seed = deterministic_random(entropy, p->count);
+    #else
+    // Compatibility with https://iancoleman.io/bip39/
+    digits_to_data(input, 0, 9); // syntax check only
+    p->seed = sha256_deterministic_random(input, p->count);
+    #endif
 }
 
 void FormatBase10::process_output(Params* p) {

src/format-base6.cpp

@@ -15,8 +15,15 @@
 
 void FormatBase6::process_input(Params* p) {
     auto input = p->get_one_argument();
+
+    #if 0
     auto entropy = digits_to_data(input, 0, 5);
     p->seed = deterministic_random(entropy, p->count);
+    #else
+    // Compatibility with https://iancoleman.io/bip39/
+    digits_to_data(input, 0, 5); // syntax check only
+    p->seed = sha256_deterministic_random(input, p->count);
+    #endif
 }
 
 void FormatBase6::process_output(Params* p) {

src/format-bits.cpp

@@ -15,8 +15,15 @@
 
 void FormatBits::process_input(Params* p) {
     auto input = p->get_one_argument();
+
+    #if 0
     auto entropy = digits_to_data(input, 0, 1);
     p->seed = deterministic_random(entropy, p->count);
+    #else
+    // Compatibility with https://iancoleman.io/bip39/
+    digits_to_data(input, 0, 1); // syntax check only
+    p->seed = sha256_deterministic_random(input, p->count);
+    #endif
 }
 
 void FormatBits::process_output(Params* p) {