api

Documentation

Overview

Package api defines the key manager client API.

Index

• Constants
• type Client

Constants

const EnclaveRPCEndpoint = "key-manager"

EnclaveRPCEndpoint is the name of the key manager EnclaveRPC endpoint.

Types

type Client

type Client interface {
	// CallEnclave calls the key manager via remote EnclaveRPC.
	//
	// The node to which the call will be routed is chosen at random from the key manager committee
	// members. The latter can be restricted by specifying a non-empty list of allowed nodes.
	//
	// The provided peer feedback is optional feedback on the peer that handled the last EnclaveRPC
	// request (if any) which may be used to inform the routing decision.
	CallEnclave(ctx context.Context, data []byte, nodes []signature.PublicKey, kind enclaverpc.Kind, pf *enclaverpc.PeerFeedback) ([]byte, signature.PublicKey, error)
}

Client is the key manager client interface.