README.md

Quorum Key Manager

Quorum Key Manager (QKM) is a key management service developed under the BSL 1.1 license and written in Go.

Quorum Key Manager is no longer actively maintained by Consensys and is provided as-is. It is an open-source project and contributions are welcome. See the license for more details.

The documentation can now be found here within this repo.

Quorum Key Manager exposes an HTTP API service to manage your secrets, keys and Ethereum accounts. QKM supports the integration with AWS Key Management Service, Azure Key Vault and HashiCorp Vault.

In addition, using the JSON-RPC interface of the QKM, you can connect to your Ethereum nodes to sign your transaction using the Ethereum account stored in your secure key vault.

Useful links

• Product page
• User documentation
• REST API reference documentation
• GitHub Project
• issues
• Changelog
• HashiCorp Vault plugin
• Helm Charts
• Kubernetes deployment example

Run QKM

First, define your Quorum Key Manager environment setup using manifest files. Examples can be found at ./deps/config/manifests. More information about how to set up service can be found in documentation.

Now launch Quorum Key Manager service using docker-compose with the following command:

docker-compose up

Build from source

Prerequisites

To build binary locally requires Go (version 1.15 or later) and C compiler.

Build

After downloading dependencies (ie go mod download) you can run following command to compile the binary

go build -o ./build/bin/key-manager

Binary will be located in ./build/bin/key-manager

License

Orchestrate is licensed under Apache-2.0.

Please refer to the LICENSE file for a detailed description of the license.