Awesome

🌱 Blockchain Commons seedtool-cli

by Wolf McNally and Christopher Allen

• <img src="https://github.com/BlockchainCommons/crypto-commons/blob/master/images/logos/crypto-commons-super-simple.png" width=16 valign="bottom">   part of the crypto commons technology family
• <img src="https://github.com/BlockchainCommons/Gordian/blob/master/Images/logos/gordian-icon.png" width=16 valign="bottom"> part of the gordian technology family

Deprecation of C++ SeedTool

This repo contains the original SeedTool written in C++, and is now deprecated. The new SeedTool is written in Rust and is a complete rewrite. The new SeedTool's inputs and outputs are compatible with the old SeedTool, and most of the same command line options are supported. The new SeedTool is more flexible and extensible, and is designed to support additional functionality.

Introduction

seedtool is a command-line tool for creating and transforming cryptographic seeds of the sort commonly used by blockchain applications.

It exercises the various cryptographic C libraries created by Blockchain Commons, as described in the Dependencies section.

Status - Feature-Complete Beta

Seedtool is now considered feature-complete and is entering beta-level testing.

Dependencies

Seedtool exercises the following Blockchain Commons libraries:

• bc-crypto-base
• bc-shamir
• bc-sskr
• bc-bip39
• bc-ur

It also requires the following additional programs:

• GNU argp
• CBOR Lite

Tool Dependencies

To build seedtool you'll need to use the following tools:

• autotools - Gnu Build System from Free Software Foundation (intro).

Recommended Installation instructions

The dependencies will be automatically installed as submodules when you run the build script. This is the recommended way to install.

Build with Docker

Install docker and run:

# Build the image
$ docker build -t seedtool-cli .
# Run the container
$ docker run --rm -it seedtool-cli --help

Build on MacOS

$ brew install autoconf automake libtool

You must then download or clone this repo. Afterward, cd into the repo directory and:

$ ./build.sh
$ sudo make install

Build on Linux

Make sure you have llvm/clang, libc++ and libc++abi installed, all with a minimum recommended version 10.

Build on Ubuntu and Debian

$ sudo apt install build-essential

$ wget https://apt.llvm.org/llvm.sh
$ chmod +x llvm.sh
$ sudo apt install lsb-release wget software-properties-common
$ sudo ./llvm.sh 10  # version 10

$ sudo apt-get install libc++-10-dev libc++abi-10-dev

$ sudo apt-get install git
$ git clone https://github.com/BlockchainCommons/seedtool-cli.git
$ cd seedtool-cli/
$ export CC="clang-10" && export CXX="clang++-10" && ./build.sh
$ sudo make install

Build on Windows

See instructions here.

Alternative Installation Instructions

The following sequence does not install the dependencies from submodules; instead they must be installed in the usual places on the build system, otherwise the ./configure step below will fail.

$ ./configure
$ make
$ sudo make install

Note: On Linux the first step is ./configure CC=clang-10 CXX=clang++-10

Incremental Build Instructions

If you wish to make changes to the source code and rebuild:

# Make source changes
$ source set_build_paths.sh # sets shell variables used by make
$ make clean # If you want a clean build
$ make

Usage Instructions

See usage examples for examples of using seedtool.

Full Documentation

See MANUAL.md for details, many more examples, and version history.

Notes for Maintainers

Before accepting a PR that can affect build or unit tests, make sure the following sequence of commands succeeds:

$ ./build.sh
$ make lint
$ make check
$ make distclean

make lint uses Cppcheck to perform static analysis on the code. All PRs should pass with no warnings.

Related Projects

• LetheKit is a parallel project that uses many of the same libraries, but in hardware.
• URKit is another example of our bc-ur universal-reference library.

Origin, Authors, Copyright & Licenses

Unless otherwise noted (either in this /README.md or in the file's header comments) the contents of this repository are Copyright © 2020 by Blockchain Commons, LLC, and are licensed under the spdx:BSD-2-Clause Plus Patent License.

In most cases, the authors, copyright, and license for each file reside in header comments in the source code. When it does not we have attempted to attribute it accurately in the table below.

This table below also establishes provenance (repository of origin, permalink, and commit id) for files included from repositories that are outside of this repository. Contributors to these files are listed in the commit history for each repository, first with changes found in the commit history of this repo, then in changes in the commit history of their repo of their origin.

Tool Dependencies

To build seedtool you'll need to use the following tools:

• autotools - Gnu Build System from Free Software Foundation (intro).

Financial Support

Seedtool is a project of Blockchain Commons. We are proudly a "not-for-profit" social benefit corporation committed to open source & open development. Our work is funded entirely by donations and collaborative partnerships with people like you. Every contribution will be spent on building open tools, technologies, and techniques that sustain and advance blockchain and internet security infrastructure and promote an open web.

To financially support further development of Seedtool and other projects, please consider becoming a Patron of Blockchain Commons through ongoing monthly patronage as a GitHub Sponsor. You can also support Blockchain Commons with bitcoins at our BTCPay Server.

Contributing

We encourage public contributions through issues and pull-requests! Please review CONTRIBUTING.md for details on our development process. All contributions to this repository require a GPG signed Contributor License Agreement.

Discussions

The best place to talk about Blockchain Commons and its projects is in our GitHub Discussions areas.

Gordian User Community. For users of the Gordian reference apps, including Gordian Coordinator, Gordian Seed Tool, Gordian Server, Gordian Wallet, and SpotBit as well as our whole series of CLI apps. This is a place to talk about bug reports and feature requests as well as to explore how our reference apps embody the Gordian Principles.

Blockchain Commons Discussions. For developers, interns, and patrons of Blockchain Commons, please use the discussions area of the Community repo to talk about general Blockchain Commons issues, the intern program, or topics other than those covered by the Gordian Developer Community or the Gordian User Community.

Other Questions & Problems

As an open-source, open-development community, Blockchain Commons does not have the resources to provide direct support of our projects. Please consider the discussions area as a locale where you might get answers to questions. Alternatively, please use this repository's issues feature. Unfortunately, we can not make any promises on response time.

If your company requires support to use our projects, please feel free to contact us directly about options. We may be able to offer you a contract for support from one of our contributors, or we might be able to point you to another entity who can offer the contractual support that you need.

Credits

The following people directly contributed to this repository. You can add your name here by getting involved — the first step is to learn how to contribute from our CONTRIBUTING.md documentation.

Responsible Disclosure

We want to keep all our software safe for everyone. If you have discovered a security vulnerability, we appreciate your help in disclosing it to us in a responsible manner. We are unfortunately not able to offer bug bounties at this time.

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

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:

You can import a key by running the following command with that individual’s fingerprint: gpg --recv-keys "<fingerprint>" Ensure that you put quotes around fingerprints that contain spaces.