common

type Cap ¶

type Cap interface {
	Addr(addr []byte) MessageID
}

type MapRequest ¶

type MapRequest struct {
	// ID is the ID of the block which is a ed25519 PublicKey
	ID MessageID

	// Future version may wish to include the PublicKey
	// if PublicKeySize is
	// Signature is the signature over Payload with
	// The Read or Write capability keys for the entry
	// identified by ID
	Signature []byte

	// Payload is the contents to store or nil
	Payload []byte
}

func (m *MapRequest) Marshal() ([]byte, error)

func (m *MapRequest) Unmarshal(b []byte) error

type MapResponse ¶

type MapResponse struct {
	Status  MapStatus
	Payload []byte
}

func (m *MapResponse) Marshal() ([]byte, error)

func (m *MapResponse) Unmarshal(b []byte) error

type MapStatus ¶

type MapStatus uint8

const (
	StatusOK MapStatus = iota
	StatusNotFound
	StatusFailed
)

type MessageID ¶

type MessageID [ed25519.PublicKeySize]byte

MessageID represents a storage address with Read/Write capability

func (m MessageID) Bytes() []byte

func (m MessageID) ReadVerifier() *ed25519.PublicKey

func (m MessageID) WriteVerifier() *ed25519.PublicKey

type ROCap ¶

type ROCap struct {
	RootCap
	// Read capability keys
	CapRSk *ed25519.BlindedPrivateKey
	CapRPk *ed25519.PublicKey
}

ROCap holds the keys implementing Read Capabilities using blinded ed25519 keys

func NewROCap(pRoot *ed25519.PublicKey, rSk *ed25519.BlindedPrivateKey) *ROCap

func (s *ROCap) ReadKey(addr []byte) *ed25519.BlindedPrivateKey

type RWCap ¶

type RWCap struct {
	RootCap
	ROCap
	WOCap
	// capability root private key from which other keys are derived
	CapSk *ed25519.PrivateKey
}

RWCap holds the keys implementing Read/Write Capabilities using blinded ed25519 keys

func NewRWCap(root *ed25519.PrivateKey) *RWCap

func (s *RWCap) ReadOnly() *ROCap

func (s *RWCap) WriteOnly() *WOCap

type ReadOnlyCap ¶

type ReadOnlyCap interface {
	Cap
	ReadKey(addr []byte) *ed25519.BlindedPrivateKey
}

ReadOnlyCap describes a Capability that has Read capability only.

type ReadWriteCap ¶

type ReadWriteCap interface {
	Cap
	ReadOnlyCap
	WriteOnlyCap
	ReadOnly() ReadOnlyCap
	WriteOnly() WriteOnlyCap
}

ReadWriteCap describes a Capability that has Read and Write capabilities and can return ReadOnly and WriteOnly capabilities

type RootCap ¶

type RootCap struct {
	CapPk *ed25519.PublicKey
}

RootCap holds CapPk and implements the Addr method which other capability types inherit.

func (s *RootCap) Addr(addr []byte) MessageID

type WOCap ¶

type WOCap struct {
	RootCap
	// Write capability keys
	CapWSk *ed25519.BlindedPrivateKey
	CapWPk *ed25519.PublicKey
}

WOCap holds the keys implementing Write Capabilities using blinded ed25519 keys

func NewWOCap(pRoot *ed25519.PublicKey, wSk *ed25519.BlindedPrivateKey) *WOCap

func (s *WOCap) WriteKey(addr []byte) *ed25519.BlindedPrivateKey

type WriteOnlyCap ¶

type WriteOnlyCap interface {
	Cap
	WriteKey(addr []byte) *ed25519.BlindedPrivateKey
}

ReadOnlyCap describes a Capability that has Write capability only.