api

Documentation

Overview

Package api defines the EnclaveRPC interface.

Index

• type Body
• type Frame
• type Kind
• type Message
• type PeerFeedback
  • func (pf PeerFeedback) String() string
• type Request
• type Response

Types

type Body

type Body struct {
	Success cbor.RawMessage `json:",omitempty"`
	Error   *string         `json:",omitempty"`
}

Body is an EnclaveRPC response body.

type Frame

type Frame struct {
	Session            []byte `json:"session,omitempty"`
	UntrustedPlaintext string `json:"untrusted_plaintext,omitempty"`
	Payload            []byte `json:"payload,omitempty"`
}

Frame is an EnclaveRPC frame.

It is the Go analog of the Rust RPC frame defined in runtime/src/enclave_rpc/types.rs.

type Kind

type Kind uint8

Kind is the RPC call kind.

const (
	KindNoiseSession  Kind = 0
	KindInsecureQuery Kind = 1
	KindLocalQuery    Kind = 2
)

Supported RPC call kinds.

type Message

type Message struct {
	Response *Response `json:"response"`
}

Message is an EnclaveRPC protocol message.

type PeerFeedback

type PeerFeedback uint8

PeerFeedback is the feedback on the peer that handled the last RPC call.

const (
	PeerFeedbackSuccess PeerFeedback = 0
	PeerFeedbackFailure PeerFeedback = 1
	PeerFeedbackBadPeer PeerFeedback = 2
)

func (PeerFeedback) String

func (pf PeerFeedback) String() string

String returns a string representation of peer feedback.

type Request

type Request struct {
	Method string      `json:"method"`
	Args   interface{} `json:"args"`
}

Request is an EnclaveRPC request.

type Response

type Response struct {
	Body Body `json:"body"`
}

Response is an EnclaveRPC response.