kaas

README

kaas (Krab As A Service)

kaas is intended to make it easy to use the krab keystore within projects that have multiple readers and writers for ipfs keystores. Due to the usage of badger, we can only have a single process that serves as a reader+writer, or multiple processes performing read-only tasks.

Documentation

Index

• func NewServer(cfg *config.TemporalConfig, ds datastore.Batching) error
• type Client
  • func NewClient(opts config.Services, fallback bool) (*Client, error)
  • func (kc *Client) Close() error
• type Server
  • func (s *Server) DeletePrivateKey(ctx context.Context, req *pb.KeyDelete) (*pb.Response, error)
  • func (s *Server) GetPrivateKey(ctx context.Context, req *pb.KeyGet) (*pb.Response, error)
  • func (s *Server) ListPrivateKeys(ctx context.Context, req *pb.KeyList) (*pb.Response, error)
  • func (s *Server) PutPrivateKey(ctx context.Context, req *pb.KeyPut) (*pb.Response, error)

Functions

func NewServer

func NewServer(cfg *config.TemporalConfig, ds datastore.Batching) error

NewServer is used to create, and run a krab keystore server

Types

type Client

type Client struct {
	pb.ServiceClient
	// contains filtered or unexported fields
}

Client is how we interface with the kaas grpc key manager

func NewClient

func NewClient(opts config.Services, fallback bool) (*Client, error)

NewClient is used to instantiate our kaas client in primary or fallback mode

func (*Client) Close

func (kc *Client) Close() error

Close shuts down the client's gRPC connection

type Server

type Server struct {
	pb.ServiceServer
	// contains filtered or unexported fields
}

Server is the backend for Krab

func (*Server) DeletePrivateKey

func (s *Server) DeletePrivateKey(ctx context.Context, req *pb.KeyDelete) (*pb.Response, error)

DeletePrivateKey is used to remove a private key from the keystore

func (*Server) GetPrivateKey

func (s *Server) GetPrivateKey(ctx context.Context, req *pb.KeyGet) (*pb.Response, error)

GetPrivateKey is used to retrieve a private key by searching for its name

func (*Server) ListPrivateKeys

func (s *Server) ListPrivateKeys(ctx context.Context, req *pb.KeyList) (*pb.Response, error)

ListPrivateKeys is used to return a list of private key ID's of all keys in our keystore

func (*Server) PutPrivateKey

func (s *Server) PutPrivateKey(ctx context.Context, req *pb.KeyPut) (*pb.Response, error)

PutPrivateKey is used to store a new private key