Skip to content

Latest commit

 

History

History
87 lines (60 loc) · 3.05 KB

CLI.md

File metadata and controls

87 lines (60 loc) · 3.05 KB

Navigation: DEDIS :: Cothority :: Building Blocks :: Fault Tolerant Collective Signing :: ftCoSi CLI

ftCoSi CLI

To use the code of this package you need to:

  • Install Golang
  • Optional: Set $GOPATH to point to your workspace directory
  • Put $GOPATH/bin in your PATH: export PATH=$PATH:$(go env GOPATH)/bin

To build and install the ftCoSi application, execute:

go get -u github.com/dedis/cothority/ftcosi

Functionality Overview

NAME:
   ftcosi - collectively sign or verify a file; run a server for collective signing

USAGE:
   ftcosi [global options] command [command options] [arguments...]

VERSION:
   1.00

COMMANDS:
     sign, s    Request a collectively signature for a 'file'; signature is written to STDOUT by default
     verify, v  Verify a collective signature of a 'file'; signature is read from STDIN by default
     check, c   Check if the servers in the group definition are up and running
     server     Start ftcosi server
     help, h    Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --debug value, -d value  debug-level: 1 for terse, 5 for maximal (default: 0)
   --help, -h               show help
   --version, -v            print the version

Using the ftCoSi Client

Configuration

To tell the client which existing cothority (public key) it should use for signing requests (signature verification), you need to specify a configuration file. For example, you could use the DEDIS cothority configuration file which is included in this repository. To have a shortcut for later on, set:

export COTHORITY=$(go env GOPATH)/src/github.com/dedis/cothority/dedis-cothority.toml

Usage

To request a collective (Schnorr) signature file.sig on a file from the DEDIS cothority, use:

ftcosi sign -g $COTHORITY -o file.sig file

To verify a collective (Schnorr) signature file.sig of the file, use:

ftcosi verify -g $COTHORITY -s file.sig file

To check the status of a collective signing group, use:

ftcosi check -g $COTHORITY

This will first contact each server individually and then check a few random collective signing group constellations. If there are connectivity problems, due to firewalls or bad connections, for example, you will see a "Timeout on signing" or similar error message.

References

Further Information

For more details, e.g., to learn how you can run your own CoSi server or cothority, see the wiki. The same applies to ftCoSi.