Merge pull request #7 from wolfmcnally/develop

Bech32 format support

Author: ChristopherA

.vscode/launch.json

@@ -12,4 +12,4 @@
             "preLaunchTask": "Build"
         }
     ]
-}
+}

MANUAL.md

@@ -44,7 +44,25 @@ $ seedtool --in random --out hex
 06799f71d16fad08ec5407d32d670147
 ```
 
-An output format `--out` and count `--count` may be specified. Count may be in [1-64] and the default `count` is 16. For the `hex` output format, the count is the number of bytes generated. For other output formats, `count` is the number of "output units" (e.g., bits, cards, die rolls, etc.)
+The `bech32` format can be used in place of `hex`. Bech32 is recognizable by the first 5 characters being `seed1`. Unlike hex, where every possible input is a seed, Bech32 includes error detection.
+
+```
+#
+# Generate a 16-byte random seed and display it as Bech32.
+#
+
+$ seedtool --out bech32
+seed1ee2mukxh95k4tyjv875aka5xwqc59ge0
+
+#
+# Convert the Bech32-encoded seed to hex.
+#
+
+$ seedtool --in bech32 seed1ee2mukxh95k4tyjv875aka5xwqc59ge0
+ce55be58d72d2d55924c3fa9db768670
+```
+
+An output format `--out` and count `--count` may be specified. Count may be in [1-64] and the default `count` is 16. For the `hex` and `bech32` output formats, the count is the number of bytes generated. For other output formats, `count` is the number of "output units" (e.g., bits, cards, die rolls, etc.)
 
 ```
 #
@@ -200,7 +218,7 @@ crucial enlarge ceramic method custody maximum campus earth ordinary twice adequ
 
 When the `--in` option is used, seedtool takes one or more arguments and uses them to construct the seed. If no arguments are given on the command line, it reads input from stdin and uses what it reads to construct the seed. In the examples below, the end of input to stdin is marked by `^D` on its own line.
 
-When the input format is `hex`, the construction is the identity function (passthrough.)
+When the input format is `hex` or `bech32`, the construction is the identity function (passthrough.)
 
 ```
 #
@@ -211,6 +229,15 @@ $ seedtool --in hex
 3d1d142cd016cf8a393a1b477891c5e594fb7c9479b175a0db653067d6de0b17
 ^D
 3d1d142cd016cf8a393a1b477891c5e594fb7c9479b175a0db653067d6de0b17
+
+#
+# Input a Bech32 seed via stdin, receive the same seed back in hex.
+#
+
+$ seedtool --in bech32
+seed1gv0pq3wv5733vyzs6de2tjn7vc677gcm
+^D
+431e1045cca7a3161050d372a5ca7e66
 ```
 
 For the other input formats, each "unit" of the input (bit, digit, card, etc.) is converted to a byte and placed in an array. The SHA256 is then taken of the resulting array, yielding a deterministic seed. This seed is then used to generate a cryptographic seed of `count` bytes.
@@ -343,7 +370,7 @@ $ seedtool --in cards --count 20 6c2c3hthacts6d4hkhtd2d7c6c3sqs6h
 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.
+`bip39` and `slip39` output formats can be combined with the `random` (default) input format. If the `--count N` option is used with the `hex` or `bech32` input formats, it results in a seed of `N` bytes being generated and used.
 
 ```
 #
@@ -362,7 +389,7 @@ $ seedtool --in random --out slip39 --count 32
 pumps guest academic academic analysis election admit harvest very webcam acquire answer primary viral venture declare have short bucket pickup pistol squeeze script racism western alarm depend depart lilac zero capacity capture warn
 ```
 
-`bip39` and `slip39` output formats can be combined with the `hex` input format. The `--count` option is not allowed and the whole hex seed is used. For `bip39` the seed must be 12-32 bytes and even. For `slip39` the seed must be 16-32 bytes and even.
+`bip39` and `slip39` output formats can be combined with the `hex` or `bech32` input formats. The `--count` option is not allowed and the whole hex seed is used. For `bip39` the seed must be 12-32 bytes and even. For `slip39` the seed must be 16-32 bytes and even.
 
 ```
 #
@@ -379,6 +406,20 @@ $ seedtool --out hex
 $ seedtool --in hex --out bip39 8a3796240f6a9606a577c887f2e5c83a
 mechanic royal math burst practice addict noise weekend margin now improve invest
 
+#
+# Convert the seed above to Bech32.
+#
+
+$ seedtool --in hex --out bech32 8a3796240f6a9606a577c887f2e5c83a
+seed13gmevfq0d2tqdfthezrl9ewg8g4fq0wc
+
+#
+# Display the Bech32-encoded seed as BIP39.
+#
+
+$ seedtool --in bech32 --out bip39 seed13gmevfq0d2tqdfthezrl9ewg8g4fq0wc
+mechanic royal math burst practice addict noise weekend margin now improve invest
+
 #
 # The --count option is not available when providing the
 # seed yourself.
@@ -387,6 +428,9 @@ mechanic royal math burst practice addict noise weekend margin now improve inves
 $ seedtool --count 12 --in hex --out bip39 8a3796240f6a9606a577c887f2e5c83a
 seedtool: The --count option is not available for hex input.
 
+$ seedtool --count 5 --in bech32 seed1gv0pq3wv5733vyzs6de2tjn7vc677gcm
+seedtool: The --count option is not available for bech32 input.
+
 #
 # The seed you provide must conform to the output format constraints.
 #
@@ -423,6 +467,16 @@ $ seedtool --in bip39
 mechanic royal math burst practice addict noise weekend margin now improve invest
 ^D
 8a3796240f6a9606a577c887f2e5c83a
+
+#
+# Recover from the same BIP39 mnemonic sequence, providing all
+# the words via stdin, and displaying the result as Bech32.
+#
+
+$ seedtool --in bip39 --out bech32
+mechanic royal math burst practice addict noise weekend margin now improve invest
+^D
+seed13gmevfq0d2tqdfthezrl9ewg8g4fq0wc
 ```
 
 `slip39` can be used as an input format, in which case the original seed is recovered. The SLIP39 shares may be passed on the command line or entered via stdin. If passed on the command line, the shares must each be a single argument (i.e., quoted). If passed via stdin, each share must appear by itself on one line.
@@ -624,6 +678,10 @@ mirror reject rookie talk pudding throw happy era myth already payment owner
 
 ## Version History
 
+### 0.2.0, 4/22/2020
+
+* Added "bech32" input and output formats.
+
 ### 0.1.1, 4/8/2020
 
 * Added compatibility with Ian Coleman's BIP39 tool for several input formats:

README.md

@@ -10,6 +10,7 @@ If any of the following prerequisites are not installed, the `configure` step be
 * [`bc-shamir`](https://github.com/blockchaincommons/bc-shamir)
 * [`bc-slip39`](https://github.com/blockchaincommons/bc-slip39)
 * [`bc-bip39`](https://github.com/blockchaincommons/bc-bip39)
+* [`bc-bech32`](https://github.com/blockchaincommons/bc-bech32)
 * [`GNU argp`](https://www.gnu.org/software/libc/manual/html_node/Argp.html) This may be installed via `brew install argp-standalone`.
 
 ## Installation

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 0.1.1.
+# Generated by GNU Autoconf 2.69 for bc-seedtool-cli 0.2.0.
 #
 #
 # 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='0.1.1'
-PACKAGE_STRING='bc-seedtool-cli 0.1.1'
+PACKAGE_VERSION='0.2.0'
+PACKAGE_STRING='bc-seedtool-cli 0.2.0'
 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 0.1.1 to adapt to many kinds of systems.
+\`configure' configures bc-seedtool-cli 0.2.0 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 0.1.1:";;
+     short | recursive ) echo "Configuration of bc-seedtool-cli 0.2.0:";;
    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 0.1.1
+bc-seedtool-cli configure 0.2.0
 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 0.1.1, which was
+It was created by bc-seedtool-cli $as_me 0.2.0, which was
 generated by GNU Autoconf 2.69.  Invocation command line was
 
   $ $0 $@
@@ -3609,6 +3609,56 @@ else
 
 fi
 
+{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for bech32_seed_encode in -lbc-bech32" >&5
+$as_echo_n "checking for bech32_seed_encode in -lbc-bech32... " >&6; }
+if ${ac_cv_lib_bc_bech32_bech32_seed_encode+:} false; then :
+  $as_echo_n "(cached) " >&6
+else
+  ac_check_lib_save_LIBS=$LIBS
+LIBS="-lbc-bech32  $LIBS"
+cat confdefs.h - <<_ACEOF >conftest.$ac_ext
+/* end confdefs.h.  */
+
+/* Override any GCC internal prototype to avoid an error.
+   Use char because int might match the return type of a GCC
+   builtin and then its argument prototype would still apply.  */
+#ifdef __cplusplus
+extern "C"
+#endif
+char bech32_seed_encode ();
+int
+main ()
+{
+return bech32_seed_encode ();
+  ;
+  return 0;
+}
+_ACEOF
+if ac_fn_c_try_link "$LINENO"; then :
+  ac_cv_lib_bc_bech32_bech32_seed_encode=yes
+else
+  ac_cv_lib_bc_bech32_bech32_seed_encode=no
+fi
+rm -f core conftest.err conftest.$ac_objext \
+    conftest$ac_exeext conftest.$ac_ext
+LIBS=$ac_check_lib_save_LIBS
+fi
+{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_lib_bc_bech32_bech32_seed_encode" >&5
+$as_echo "$ac_cv_lib_bc_bech32_bech32_seed_encode" >&6; }
+if test "x$ac_cv_lib_bc_bech32_bech32_seed_encode" = xyes; then :
+  cat >>confdefs.h <<_ACEOF
+#define HAVE_LIBBC_BECH32 1
+_ACEOF
+
+  LIBS="-lbc-bech32 $LIBS"
+
+else
+
+  echo "### Error! libbc-bech32 must be installed first."
+  exit -1
+
+fi
+
 { $as_echo "$as_me:${as_lineno-$LINENO}: checking for argp_parse in -largp" >&5
 $as_echo_n "checking for argp_parse in -largp... " >&6; }
 if ${ac_cv_lib_argp_argp_parse+:} false; then :
@@ -4868,7 +4918,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 0.1.1, which was
+This file was extended by bc-seedtool-cli $as_me 0.2.0, which was
 generated by GNU Autoconf 2.69.  Invocation command line was
 
   CONFIG_FILES    = $CONFIG_FILES
@@ -4930,7 +4980,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 0.1.1
+bc-seedtool-cli config.status 0.2.0
 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], [0.1.1])
+AC_INIT([bc-seedtool-cli], [0.2.0])
 AC_CONFIG_SRCDIR([src/seedtool.cpp])
 AC_CONFIG_HEADERS([src/config.h])
 
@@ -28,6 +28,10 @@ AC_CHECK_LIB([bc-bip39], [bip39_mnemonic_from_word], [], [
   echo "### Error! libbc-bip39 must be installed first."
   exit -1
   ])
+AC_CHECK_LIB([bc-bech32], [bech32_seed_encode], [], [
+  echo "### Error! libbc-bech32 must be installed first."
+  exit -1
+  ])
 AC_CHECK_LIB([argp], [argp_parse], [], [
   echo "### Error! argp must be installed first. Try 'brew install argp-standalone'."
   exit -1

src/Makefile.in

@@ -51,10 +51,11 @@ OBJS = \
 	format-ints.o \
 	format-random.o \
 	format-slip39.o \
+	format-bech32.o \
 	randombytes.o \
 	hkdf.o
 
-LDFLAGS = -lstdc++ -lbc-crypto-base -lbc-shamir -lbc-slip39 -lbc-bip39 -largp
+LDFLAGS = -lstdc++ -lbc-crypto-base -lbc-shamir -lbc-slip39 -lbc-bip39 -lbc-bech32 -largp
 
 $(toolname): $(OBJS)
 
@@ -65,7 +66,7 @@ random.o: random.hpp randombytes.h hkdf.h utils.hpp
 randombytes.o: randombytes.h
 hkdf.o: hkdf.h
 format.o: format.hpp utils.hpp
-formats-all.hpp: format-base6.hpp format-base10.hpp format-bip39.hpp format-bits.hpp format-cards.hpp format-dice.hpp format-hex.hpp format-ints.hpp format-random.hpp format-slip39.hpp
+formats-all.hpp: format-base6.hpp format-base10.hpp format-bip39.hpp format-bits.hpp format-cards.hpp format-dice.hpp format-hex.hpp format-ints.hpp format-random.hpp format-slip39.hpp format-bech32.hpp
 format-base6.o: format-base6.hpp format.hpp params.hpp random.hpp
 format-base10.o: format-base10.hpp format.hpp params.hpp random.hpp
 format-bip39.o: format-bip39.hpp format.hpp params.hpp random.hpp
@@ -76,6 +77,7 @@ format-hex.o: format-hex.hpp format.hpp params.hpp random.hpp
 format-ints.o: format-ints.hpp format.hpp params.hpp random.hpp
 format-random.o: format-random.hpp format.hpp params.hpp random.hpp
 format-slip39.o: format-slip39.hpp format.hpp params.hpp random.hpp
+format-bech32.o: format-bech32.hpp format.hpp params.hpp random.hpp
 
 bindir = $(DESTDIR)/$(prefix)/bin
 

src/config.h.in

@@ -9,6 +9,9 @@
 /* Define to 1 if you have the `argp' library (-largp). */
 #undef HAVE_LIBARGP
 
+/* Define to 1 if you have the `bc-bech32' library (-lbc-bech32). */
+#undef HAVE_LIBBC_BECH32
+
 /* Define to 1 if you have the `bc-bip39' library (-lbc-bip39). */
 #undef HAVE_LIBBC_BIP39
 

src/format-bech32.cpp

@@ -0,0 +1,42 @@
+//
+//  format-bech32.cpp
+//
+//  Copyright © 2020 by Blockchain Commons, LLC
+//  Licensed under the "BSD-2-Clause Plus Patent License"
+//
+
+#include "format-bech32.hpp"
+
+#include <stdexcept>
+#include <bc-bech32/bc-bech32.h>
+
+#include "params.hpp"
+
+using namespace std;
+
+bool FormatBech32::is_seed_length_valid(size_t seed_len) {
+    if(!(1 <= seed_len && seed_len <= 64)) { return false; }
+    return true;
+}
+
+void FormatBech32::process_input(Params* p) {
+    auto input = p->get_one_argument();
+    vector<uint8_t> seed;
+    seed.resize(300);
+    size_t seed_len = 0;
+    if(bech32_seed_decode(&seed[0], &seed_len, input.c_str()) == 0) {
+        throw runtime_error("Invalid bech32 seed.");
+    }
+    seed.resize(seed_len);
+    p->seed = seed;
+}
+
+void FormatBech32::process_output(Params* p) {
+    auto data_len = p->seed.size();
+    char output[200];
+    auto data = &p->seed[0];
+    if(bech32_seed_encode(output, data, data_len) == 0) {
+        throw runtime_error("Bech32 seed encoding failed.");
+    }
+    p->output = output;
+}

src/format-bech32.hpp

@@ -0,0 +1,20 @@
+//
+//  format-bech32.hpp
+//
+//  Copyright © 2020 by Blockchain Commons, LLC
+//  Licensed under the "BSD-2-Clause Plus Patent License"
+//
+
+#pragma once
+
+#include "format.hpp"
+
+class FormatBech32 : public Format {
+   public:
+    FormatBech32() : Format(Format::Key::bech32, "bech32") {}
+
+    virtual void process_input(Params* p) override;
+    virtual void process_output(Params* p) override;
+
+    static bool is_seed_length_valid(size_t seed_len);
+};