Implementation of Shamir Secret Sharing for use in Blockchain Commons Software Projects
- If
bc-crypto-baseis not installed, theconfigurestep below will fail.
$ ./configure
$ make check
$ sudo make installThis sequence runs the module's unit tests.
- Link against
libbc-shamir.aandlibbc-crypto-base.a. - Include the umbrella header in your code:
#include <bc-shamir/bc-shamir.h>Before accepting a PR that can affect build or unit tests, make sure the following sequence of commands succeeds:
$ ./configure
$ make distcheck
$ make distcleanmake 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.
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.
| File | From | Commit | Authors & Copyright (c) | License | Notes |
|---|---|---|---|---|---|
| hazmat.c | dsprenkels/sss | b613717 | Copyright 2017 Daan Sprenkels [email protected] | MIT | We have commented out sss_create_keyshares & sss_combine_keyshares. |
| hazmat.h | dsprenkels/sss | b613717 | Copyright 2017 Daan Sprenkels [email protected] | MIT | |
| shamir.c | dsprenkels/sss | Copyright 2017 Daan Sprenkels [email protected] | MIT | We have commented out sss_create_keyshares & sss_combine_keyshares. | |
| shamir.h | dsprenkels/sss | Copyright 2017 Daan Sprenkels [email protected] | MIT |
These are other projects that work with or leverage $projectname:
- bc-slip39 — Blockchain Common's SLIP39 implementation.
The Blockchain Commons Shamir project is either derived from or was inspired by:
- Portions of this source code comes from dsprenkels/sss by Daan Sprenkels @dspenkels [email protected] licensed MIT.
- autotools - Gnu Build System from Free Software Foundation (intro).
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.
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.
| Name | Role | Github | GPG Fingerprint | |
|---|---|---|---|---|
| Christopher Allen | Principal Architect | @ChristopherA | <[email protected]> | FDFE 14A5 4ECB 30FC 5D22 74EF F8D3 6C91 3574 05ED |
| Wolf McNally | Project Lead | @WolfMcNally | <[email protected]> | 9436 52EE 3844 1760 C3DC 3536 4B6C 2FCF 8947 80AE |
| Chris Howe | Occasional Contributor | @howech | <[email protected]> | 7C3D D38E 16D0 0275 5C0B 82B4 709C 6DA6 EAD3 99A7 |
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.
Please report suspected security vulnerabilities in private via email to [email protected] (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:
| Name | Fingerprint |
|---|---|
| Christopher Allen | FDFE 14A5 4ECB 30FC 5D22 74EF F8D3 6C91 3574 05ED |
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.