consensys/quorum-key-manager repository overview

⁠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 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 QKM, you can connect to your Ethereum nodes to sign your transaction using the Ethereum account stored in your secure key vault.

⁠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 setup service can be found in documentation⁠.

Once you manifests are written, specify where quorum-key-manager can find them on your filesystem with the following environment variable:

export HOST_MANIFEST_PATH={your_manifests_folder}

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

⁠Documentation

Quorum Key Manager documentation website https://docs.quorum-key-manager.consensys.net/⁠

⁠License

Orchestrate is licensed under the BSL 1.1. Please refer to the LICENSE file⁠ for a detailed description of the license.

Please contact [email protected]⁠ if you need to purchase a license for a production use-case.