Awesome

Blockchain Commons bc-bytewords

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

Bytewords is a method for encoding binary objects as a sequence of four-letter English words. bc-bytewords is a C implementation of a Bytewords codec.

The Bytewords specification is fully described here.

Prerequisites

• If bc-crypto-base is not installed, the configure step below will fail.
• If on Debian Linux make sure you have build-essential package installed: $ sudo apt-get install build-essential

Installation Instructions

$ ./configure
$ make check
$ sudo make install

This sequence runs the module's unit tests.

Usage Instructions

1. Link against libbc-bytewords.a.
2. Include the umbrella header in your code:

#include <bc-bytewords/bc-bytewords.h>

Notes for Maintainers

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

$ ./configure
$ make lint
$ make distcheck
$ make distclean

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

make distcheck builds a distribution tarball, unpacks it, then configures, builds, and runs unit tests from it, then performs an install and uninstall from a non-system directory and makes sure the uninstall leaves it clean. make distclean removes all known byproduct files, and unless you've added files of your own, should leave the directory in a state that could be tarballed for distribution. After a make distclean you'll have to run ./configure again.

Status - Late Alpha

Bytewords is currently under active development and in the late alpha testing phase. It should not be used for production tasks until it has had further testing and auditing.

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.

The authors, copyright, and license for each file reside in header comments in the source code.

Dependencies

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

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

Used with…

These are other projects that work with or leverage Bytewords:

• lethekit — Open source DIY hardware box for offline cryptographic tools by Blockchain Commons.

Financial Support

Bytewords 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 Bytewords 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.

Wallet Standard Discussions. For standards and open-source developers who want to talk about wallet standards, please use the Discussions area of the Airgapped Signing repo. This is where you can talk about projects like our LetheKit and command line tools such as seedtool, both of which are intended to testbed wallet technologies, plus the libraries that we've built to support your own deployment of wallet technology such as bc-bip39, bc-slip39, bc-shamir, Sharded Secret Key Reconstruction, bc-ur, and the bc-crypto-base. If it's a wallet-focused technology or a more general discussion of wallet standards,discuss it here.

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 the Gordian System or the wallet standards, each of which have their own discussion areas.

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 learning how to contribute from our CONTRIBUTING.md documentation.

Responsible Disclosure

We want to keep all of 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.

Version History

0.2.0, 10/4/2020

• Fix for [https://github.com/BlockchainCommons/Research/issues/45](wordlist alphabetization error).

0.1.1, 7/1/2020

• Moved to depending on bc-crypto-base for calculation of CRC32 checksum.

0.1.0, 6/3/2020

• Initial release.