Skip to content
A distributed key-value storage that's tolerant to Byzantine fault.
Branch: master
Clone or download
Latest commit 354ad56 Sep 14, 2018

README.md

BFTKV (to be changed)

BFTKV is a distributed key-value storage which is tolerant to Byzantine fault. See Abstract for details.

Additional documents:

Design Document (restricted)

Paper (draft)

HTTP-API

Implementation Notes

Test Notes

Setup

  1. Install Go 1.8.
  2. go get -u github.com/yahoo/bftkv
  3. Install GnuPG 2.x
  4. Install Docker (if you want to run BFTKV in a Docker container)
  5. Run setup.sh in scripts (setup.sh -host bftkv for Docker)
  6. If bftkv runs with KeyTransparency, run $GOPATH/src/github.com/google/keytranspreancy/scripts/gen_bftkv_keys.sh

Build

cd /github.com/yahoo/bftkv
go build -o bftkv cmd/main.go

Parameters

A list of parameters that can be supplied to bftkv is given below:

Flag     Purpose                               Default
-home    Path to PGP home directory,           ~/.gnupg
-sec     Secret key ring path,                 $home/secring.gpg
-pub     Public key ring path,                 $home/pubring.gpg
-rev     Revocation list path,                 $home/revocation.gpg
-db      Database path,                        db
-api     Http api address,                     localhost:5792
-ws      Web socket port,                      5001

Run Options

  1. Run a node bftkv -home gnupg.key

  2. Run a BFTKV cluster cd scripts/run; ../run.sh

  3. Run a BFTKV cluster in Docker

docker build -t bftkv .
docker run -d bftkv

Visualization

BFTKV includes a visualization tool (located in visual/) for observing the current system state. The tool can display

  • Trust graphs for the servers
  • Read, write and sign requests sent to the servers
  • Revoked and inaccessible servers

To show the graph, run run.sh and open visual/index.html.

Write in Action

Write

Revoke on Read in Action

Revoke on Read

License

Copyright 2017, Yahoo Holdings Inc.

Licensed under the terms of the Apache license. See LICENSE file in project root for terms.

You can’t perform that action at this time.