First beta.

wolfmcnally · wolfmcnally · commit b61d34f5a847 · 2020-04-08T13:03:57.000-07:00
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -7,7 +7,7 @@
             "type": "lldb",
             "request": "launch",
             "program": "${workspaceFolder}/src/seedtool",
-            "args": ["--in", "slip39", "foobar"],
+            "args": ["--in", "hex", "--out", "bip39", "38a8aaa2d6caff920c67"],
             "cwd": "${workspaceFolder}/src",
             "preLaunchTask": "Build"
         }
diff --git a/MANUAL.md b/MANUAL.md
diff --git a/Makefile.in b/Makefile.in
@@ -52,14 +52,15 @@ $(distdir): FORCE
 	cp $(srcdir)/bootstrap.sh $(distdir)
 	cp $(srcdir)/configure.ac $(distdir)
 	cp $(srcdir)/configure $(distdir)
-	cp $(srcdir)/config.h.in $(distdir)
 	cp $(srcdir)/install-sh $(distdir)
 	cp $(srcdir)/Makefile.in $(distdir)
-	cp $(srcdir)/src/Makefile.in $(distdir)/src
 	cp $(srcdir)/.gitignore $(distdir)
+	cp $(srcdir)/src/Makefile.in $(distdir)/src
+	cp $(srcdir)/src/config.h.in $(distdir)/src
 	cp $(srcdir)/src/*.c $(distdir)/src
 	cp $(srcdir)/src/*.cpp $(distdir)/src
 	cp $(srcdir)/src/*.h $(distdir)/src
+	cp $(srcdir)/src/*.hpp $(distdir)/src
 
 .PHONY: distcheck
 distcheck: $(tarball)
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Blockchain Commons bc-seedtool-cli
+# 🌱 Blockchain Commons bc-seedtool-cli
 
 A tool for creating and transforming cryptographic seeds.
 
@@ -22,7 +22,22 @@ $ sudo make install
 
 ## Use
 
-See [`MANUAL.md`](MANUAL.md).
+```
+$ seedtool
+8935a8068526d84da555cdb741a3b8a8
+
+$ seedtool --in hex --out bip39 8935a8068526d84da555cdb741a3b8a8
+matrix pull accuse apart horn chat next rifle resemble artist until eye
+
+$ seedtool --in bip39 matrix pull accuse apart horn chat next rifle resemble artist until eye
+8935a8068526d84da555cdb741a3b8a8
+```
+
+```
+$ seedtool --help
+```
+
+See [`MANUAL.md`](MANUAL.md) for detail, examples, and version history.
 
 ## Notes for Maintainers
 
@@ -44,6 +59,10 @@ This table below also establishes provenance (repository of origin, permalink, a
 
 | File      | From                                                         | Commit                                                       | Authors & Copyright (c)                                | License                                                     |
 | --------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------ | ----------------------------------------------------------- |
+| hkdf.c | [rustyrussell/ccan](https://github.com/rustyrussell/ccan/blob/master/ccan/crypto/hkdf_sha256/hkdf_sha256.c) | [d07f742](https://github.com/rustyrussell/ccan/commit/d07f742c5925b97ed558eb07aae285616f5df823) | 2016 [Rusty Russell](https://github.com/rustyrussell)<br/>2020 Wolf McNally | [MIT](https://github.com/rustyrussell/ccan/blob/master/ccan/crypto/hkdf_sha256/LICENSE)
+| hkdf.h | [rustyrussell/ccan](https://github.com/rustyrussell/ccan/blob/master/ccan/crypto/hkdf_sha256/hkdf_sha256.h) | [d07f742](https://github.com/rustyrussell/ccan/commit/d07f742c5925b97ed558eb07aae285616f5df823) | 2016 [Rusty Russell](https://github.com/rustyrussell) | [MIT](https://github.com/rustyrussell/ccan/blob/master/ccan/crypto/hkdf_sha256/LICENSE)
+| randombytes.c | [dsprenkels/randombytes](https://github.com/dsprenkels/randombytes/blob/master/randombytes.c) | [6db39aa](https://github.com/dsprenkels/randombytes/commit/6db39aaae6bb9ab97beca00d81bcfe935c56c88d) | 2017-2019 [Daan Sprenkels](https://github.com/dsprenkels/) | [MIT](https://github.com/dsprenkels/randombytes/commit/73ae9b4fce2e62babdd6a480b53ad449dd745ed9) |
+| randombytes.h | [dsprenkels/randombytes](https://github.com/dsprenkels/randombytes/blob/master/randombytes.h) | [19fd002](https://github.com/dsprenkels/randombytes/commit/19fd002d9b7b001b333a671186a91231b60d821b) | 2017-2019 [Daan Sprenkels](https://github.com/dsprenkels/) | [MIT](https://github.com/dsprenkels/randombytes/commit/73ae9b4fce2e62babdd6a480b53ad449dd745ed9) |
 
 ### Dependencies
 
@@ -70,7 +89,7 @@ We want to keep all our software safe for everyone. If you have discovered a sec
 
 We do ask that you offer us good faith and use best efforts not to leak information or harm any user, their data, or our developer community. Please give us a reasonable amount of time to fix the issue before you publish it. Do not defraud our users or us in the process of discovery. We promise not to bring legal action against researchers who point out a problem provided they do their best to follow the these guidelines.
 
-### Reporting a Vulnerability
+## 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.
 
diff --git a/configure b/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.
+# Generated by GNU Autoconf 2.69 for bc-seedtool-cli 1.0.0b1.
 #
 #
 # 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'
-PACKAGE_STRING='bc-seedtool-cli 1.0'
+PACKAGE_VERSION='1.0.0b1'
+PACKAGE_STRING='bc-seedtool-cli 1.0.0b1'
 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 to adapt to many kinds of systems.
+\`configure' configures bc-seedtool-cli 1.0.0b1 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:";;
+     short | recursive ) echo "Configuration of bc-seedtool-cli 1.0.0b1:";;
    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
+bc-seedtool-cli configure 1.0.0b1
 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, which was
+It was created by bc-seedtool-cli $as_me 1.0.0b1, which was
 generated by GNU Autoconf 2.69.  Invocation command line was
 
   $ $0 $@
@@ -2234,7 +2234,7 @@ ac_compiler_gnu=$ac_cv_c_compiler_gnu
 
 
 
-ac_config_headers="$ac_config_headers config.h"
+ac_config_headers="$ac_config_headers src/config.h"
 
 
 # Checks for programs.
@@ -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, which was
+This file was extended by bc-seedtool-cli $as_me 1.0.0b1, 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
+bc-seedtool-cli config.status 1.0.0b1
 configured by $0, generated by GNU Autoconf 2.69,
   with options \\"\$ac_cs_config\\"
 
@@ -5052,7 +5052,7 @@ cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1
 for ac_config_target in $ac_config_targets
 do
   case $ac_config_target in
-    "config.h") CONFIG_HEADERS="$CONFIG_HEADERS config.h" ;;
+    "src/config.h") CONFIG_HEADERS="$CONFIG_HEADERS src/config.h" ;;
     "Makefile") CONFIG_FILES="$CONFIG_FILES Makefile" ;;
     "src/Makefile") CONFIG_FILES="$CONFIG_FILES src/Makefile" ;;
 
diff --git a/configure.ac b/configure.ac
@@ -2,9 +2,9 @@
 # Process this file with autoconf to produce a configure script.
 
 AC_PREREQ([2.69])
-AC_INIT([bc-seedtool-cli], [1.0])
+AC_INIT([bc-seedtool-cli], [1.0.0b1])
 AC_CONFIG_SRCDIR([src/seedtool.cpp])
-AC_CONFIG_HEADERS([config.h])
+AC_CONFIG_HEADERS([src/config.h])
 
 # Checks for programs.
 AC_PROG_CXX
diff --git a/src/Makefile.in b/src/Makefile.in
@@ -96,3 +96,4 @@ clean:
 .PHONY: distclean
 distclean: clean
 	rm -f Makefile
+	rm -f config.h
diff --git a/src/config.h.in b/src/config.h.in
@@ -1,4 +1,4 @@
-/* config.h.in.  Generated from configure.ac by autoheader.  */
+/* src/config.h.in.  Generated from configure.ac by autoheader.  */
 
 /* Define to 1 if you have the <fcntl.h> header file. */
 #undef HAVE_FCNTL_H
diff --git a/src/format-bip39.cpp b/src/format-bip39.cpp
@@ -35,7 +35,9 @@ void FormatBIP39::process_input(Params* p) {
 }
 
 void FormatBIP39::process_output(Params* p) {
-    if(!is_seed_length_valid(p->seed.size())) { return; }
+    if(!is_seed_length_valid(p->seed.size())) {
+        throw runtime_error("Invalid seed length for BIP39. Must be in [12-32] and even.");
+    }
 
     size_t max_mnemonics_len = 300;
     char mnemonics[max_mnemonics_len];
diff --git a/src/format-slip39.cpp b/src/format-slip39.cpp
@@ -52,7 +52,7 @@ static vector<uint8_t> combine(vector<string> shares) {
 
     auto combine_result = slip39_combine(
         (const uint16_t **)&shares_words_pointers[0], words_in_each_share, shares.size(),
-        "TREZOR", NULL, &result[0], result.size());
+        "", NULL, &result[0], result.size());
 
     for(auto v: shares_words) {
         delete v;
@@ -73,7 +73,9 @@ void FormatSLIP39::process_input(Params* p) {
 }
 
 void FormatSLIP39::process_output(Params* p) {
-    if(!is_seed_length_valid(p->seed.size())) { return; }
+    if(!is_seed_length_valid(p->seed.size())) {
+        throw runtime_error("Invalid seed length for SLIP39. Must be in [16-32] and even.");
+    }
 
     const char* password = "";
 
diff --git a/src/params.cpp b/src/params.cpp
@@ -16,6 +16,7 @@
 #include "params.hpp"
 #include "utils.hpp"
 #include "formats-all.hpp"
+#include "config.h"
 
 using namespace std;
 
@@ -153,6 +154,9 @@ group_descriptor Params::parse_group_spec(const string &string) {
     if(!(0 < threshold && threshold <= count && count <= 16)) {
         argp_error(state, "Invalid group specifier \"%s\": 1 <= N <= M <= 16", string.c_str());
     }
+    if(count > 1 && threshold == 1) {
+        argp_error(state, "Invalid group specifier. 1-of-M groups where M > 1 are not supported.");
+    }
     group_descriptor g;
     g.threshold = threshold;
     g.count = count;
@@ -221,10 +225,19 @@ void Params::validate_input() {
     }
 }
 
+void Params::validate_count_for_input_format() {
+    if (dynamic_cast<FormatHex*>(input_format) != NULL) {
+        if (!raw.count.empty()) {
+            argp_error(state, "The --count option is not available for hex input.");
+        }
+    }
+}
+
 void Params::validate() {
     validate_count();
     validate_deterministic();
     validate_input_format();
+    validate_count_for_input_format();
     validate_output_format();
     validate_output_for_input();
     validate_ints_specific();
@@ -279,20 +292,20 @@ struct argp_option options[] = {
     {"low < high", 0, 0, OPTION_DOC, 0},
 
     {0, 0, 0, 0, "SLIP39 Output Options:", 2},
-    {"group-threshold", 't', "1-16", 0, "The number of groups that must contribute (default: 1)"},
+    {"group-threshold", 't', "1-16", 0, "The number of groups that must meet their threshold (default: 1)"},
     {"group", 'g', "M-of-N", 0, "The group specification (default: 1-of-1)"},
     {"The --group option may appear more than once.", 0, 0, OPTION_DOC, 0},
     {"M < N", 0, 0, OPTION_DOC, 0},
     {"The group threshold must be <= the number of group specifications.", 0, 0, OPTION_DOC, 0},
 
     {0, 0, 0, 0, "Deterministic Random Numbers:", 3},
-    {"deterministic", 'd', "SEED", 0, "Use a deterministic random number generator with SEED"},
+    {"deterministic", 'd', "SEED", 0, "Use a deterministic random number generator with the given seed."},
 
     { 0 }
 };
 
-auto argp_program_version = "1.0";
-// const char* argp_program_bug_address = "who@dunnit.com";
+auto argp_program_version = PACKAGE_VERSION;
+const char* argp_program_bug_address = "ChristopherA@LifeWithAlacrity.com";
 
 auto doc = "Converts cryptographic seeds between various forms.";
 struct argp argp = { options, parse_opt, "INPUT", doc };
diff --git a/src/params.hpp b/src/params.hpp
@@ -76,10 +76,11 @@ class Params {
     void validate_count();
     void validate_deterministic();
     void validate_input_format();
+    void validate_count_for_input_format();
     void validate_output_format();
     void validate_output_for_input();
     void validate_ints_specific();
     void validate_bip39_specific();
     void validate_slip39_specific();
     void validate_input();
-};
+};

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`"type": "lldb",`
`8`	`8`	`"request": "launch",`
`9`	`9`	`"program": "${workspaceFolder}/src/seedtool",`
`10`		`- "args": ["--in", "slip39", "foobar"],`
	`10`	`+ "args": ["--in", "hex", "--out", "bip39", "38a8aaa2d6caff920c67"],`
`11`	`11`	`"cwd": "${workspaceFolder}/src",`
`12`	`12`	`"preLaunchTask": "Build"`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/* config.h.in. Generated from configure.ac by autoheader. */`
	`1`	`+/* src/config.h.in. Generated from configure.ac by autoheader. */`
`2`	`2`
`3`	`3`	`/* Define to 1 if you have the <fcntl.h> header file. */`
`4`	`4`	`#undef HAVE_FCNTL_H`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,9 @@ void FormatBIP39::process_input(Params* p) {`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`void FormatBIP39::process_output(Params* p) {`
`38`		`- if(!is_seed_length_valid(p->seed.size())) { return; }`
	`38`	`+ if(!is_seed_length_valid(p->seed.size())) {`
	`39`	`+ throw runtime_error("Invalid seed length for BIP39. Must be in [12-32] and even.");`
	`40`	`+ }`
`39`	`41`
`40`	`42`	`size_t max_mnemonics_len = 300;`
`41`	`43`	`char mnemonics[max_mnemonics_len];`