Skip to content

C Implementation of SLIP-39 Shamir Secret Sharing Standard.

License

Notifications You must be signed in to change notification settings

shannona/bc-slip39

 
 

Repository files navigation

Implementation of SLIP-39 Shamir Secret Sharing standard for use in Blockchain Commons Software Projects

Prerequisites

  • If bc-crypto-base is not installed, the configure step below will fail.
  • If bc-shamir is not installed, the configure step below will fail.

Installation

$ ./configure
$ make check
$ sudo make install

This sequence runs the module's unit tests.

Use

  1. Link against libbc-slip39.a, libbc-shamir.a and libbc-crypto-base.a.
  2. Include the umbrella header in your code:
#include <bc-slip39/bc-slip39.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 distcheck
$ make distclean

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.

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.

File From Commit Authors & Copyright (c) License
exception-to-the-rule.c or exception-folder https://github.com/community/repo-name/PERMALINK https://github.com/community/repo-name/commit/COMMITHASH 2020 Exception Author MIT

Used with…

These are other projects that work with or leverage $projectname:

Derived from…

This $projectname project is either derived from or was inspired by:

Dependencies

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

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

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.

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.

Name Role Github Email GPG Fingerprint
Christopher Allen Principal Architect @ChristopherA <ChristopherA@LifeWithAlacrity.com> FDFE 14A5 4ECB 30FC 5D22 74EF F8D3 6C91 3574 05ED
Wolf McNally Project Lead @WolfMcNally <Wolf@WolfMcNally.com> 9436 52EE 3844 1760 C3DC  3536 4B6C 2FCF 8947 80AE
Chris Howe Occasional Contributor @howech <chris@howeville.com> 7C3D D38E 16D0 0275 5C0B 82B4 709C 6DA6 EAD3 99A7

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:

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.

About

C Implementation of SLIP-39 Shamir Secret Sharing Standard.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C 79.6%
  • Shell 14.6%
  • Makefile 4.9%
  • M4 0.9%