api

Documentation

Overview

Package api implements the key manager management API and common data types.

Index

• Constants
• Variables
• func RegisterService(server *grpc.Server, service Backend)
• type Backend
• type Client
  • func NewClient(c *grpc.ClientConn) *Client
  • func (c *Client) Churp() churp.Backend
  • func (c *Client) Secrets() secrets.Backend
  • func (c *Client) StateToGenesis(context.Context, int64) (*Genesis, error)
• type Genesis

Constants

const (
	// ModuleName is a unique module name for the keymanager module.
	ModuleName = "keymanager"
)

Variables

var (
	// InsecureRAK is the insecure hardcoded key manager public key, used
	// in insecure builds when a RAK is unavailable.
	InsecureRAK signature.PublicKey

	// InsecureREK is the insecure hardcoded key manager public key, used
	// in insecure builds when a REK is unavailable.
	InsecureREK x25519.PublicKey

	// TestSigners contains a list of signers with corresponding test keys, used
	// in insecure builds when a RAK is unavailable.
	TestSigners []signature.Signer

	// RPCMethodConnect is the name of the method used to establish a Noise session.
	RPCMethodConnect = ""
)

Functions

func RegisterService

func RegisterService(server *grpc.Server, service Backend)

RegisterService registers a new keymanager backend service with the given gRPC server.

Types

type Backend

type Backend interface {
	// StateToGenesis returns the genesis state at specified block height.
	StateToGenesis(ctx context.Context, height int64) (*Genesis, error)

	// Secrets returns the key manager secrets management implementation.
	Secrets() secrets.Backend

	// Churp returns the key manager CHURP management implementation.
	Churp() churp.Backend
}

Backend is a key manager management implementation.

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a gRPC key manager client.

func NewClient

func NewClient(c *grpc.ClientConn) *Client

NewClient creates a new gRPC key manager client.

func (*Client) Churp

func (c *Client) Churp() churp.Backend

func (*Client) Secrets

func (c *Client) Secrets() secrets.Backend

func (*Client) StateToGenesis

func (c *Client) StateToGenesis(context.Context, int64) (*Genesis, error)

type Genesis

type Genesis struct {
	// Genesis is the secret genesis state.
	//
	// Embedded to ensure backward compatibility.
	secrets.Genesis

	// Churp is the optional CHURP genesis state.
	Churp *churp.Genesis `json:"churp,omitempty"`
}

Genesis is the key manager management genesis state.