api

package
v0.0.0-...-7fa21a5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 9, 2023 License: MPL-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	PathNonce             = "nonce"
	PathAuthCheck         = "authCheck"
	PathPeerRegistration  = "peerRegister"
	PathConfigUpdate      = "configUpdate"
	PathConfigReload      = "configReload"
	PathIdentifyPublisher = "identifyPublisher"
)
View Source 
const (
	PathPeerNonce   = "peerNonce"
	PathUptime      = "uptime"
	PathPing        = "ping"
	PathConfigChain = "configChain"
	PathConfigFetch = "configFetch"
)
View Source 
const (
	NonceSize = 128
)

Variables

This section is empty.

Functions

func EncryptResponse 

func EncryptResponse(authKey *jose.JSONWebKey, response Message) ([]byte, error)

Types

type AuthCheck 

type AuthCheck []byte

both the request for /authCheck, and the response for /nonce

func (AuthCheck) Endpoint 

func (AuthCheck) Endpoint() string

func (AuthCheck) Marshal 

func (ac AuthCheck) Marshal() ([]byte, error)

func (AuthCheck) New 

func (AuthCheck) New() Request

func (AuthCheck) Nonce 

func (ac AuthCheck) Nonce() string

func (AuthCheck) Response 

func (AuthCheck) Response() Message

func (AuthCheck) SetNonce 

func (ac AuthCheck) SetNonce(nonce []byte) error

func (AuthCheck) Unmarshal 

func (ac AuthCheck) Unmarshal(byt []byte) error

type ConfigChainRequest 

type ConfigChainRequest struct {
	NonceValue []byte `json:"nonce"`
}

func (*ConfigChainRequest) Endpoint 

func (*ConfigChainRequest) Endpoint() string

func (*ConfigChainRequest) Marshal 

func (cr *ConfigChainRequest) Marshal() ([]byte, error)

func (*ConfigChainRequest) New 

func (*ConfigChainRequest) New() Request

func (*ConfigChainRequest) Nonce 

func (cr *ConfigChainRequest) Nonce() string

func (*ConfigChainRequest) Response 

func (*ConfigChainRequest) Response() Message

func (*ConfigChainRequest) SetNonce 

func (cr *ConfigChainRequest) SetNonce(nonce []byte) error

func (*ConfigChainRequest) Unmarshal 

func (cr *ConfigChainRequest) Unmarshal(byt []byte) error

type ConfigChainResponse 

type ConfigChainResponse struct {
	NonceValue []byte   `json:"nonce"`
	Chain      []string `json:"chain"`
}

func (*ConfigChainResponse) Marshal 

func (cr *ConfigChainResponse) Marshal() ([]byte, error)

func (*ConfigChainResponse) Unmarshal 

func (cr *ConfigChainResponse) Unmarshal(byt []byte) error

type ConfigFetchRequest 

type ConfigFetchRequest struct {
	NonceValue []byte `json:"nonce"`
}

func (*ConfigFetchRequest) Endpoint 

func (*ConfigFetchRequest) Endpoint() string

func (*ConfigFetchRequest) Marshal 

func (cr *ConfigFetchRequest) Marshal() ([]byte, error)

func (*ConfigFetchRequest) New 

func (*ConfigFetchRequest) New() Request

func (*ConfigFetchRequest) Nonce 

func (cr *ConfigFetchRequest) Nonce() string

func (*ConfigFetchRequest) Response 

func (*ConfigFetchRequest) Response() Message

func (*ConfigFetchRequest) SetNonce 

func (cr *ConfigFetchRequest) SetNonce(nonce []byte) error

func (*ConfigFetchRequest) Unmarshal 

func (cr *ConfigFetchRequest) Unmarshal(byt []byte) error

type ConfigFetchResponse 

type ConfigFetchResponse struct {
	NonceValue []byte         `json:"nonce"`
	Config     *config.Config `json:"config"`
	Chain      []string       `json:"chain"`
}

func (*ConfigFetchResponse) Marshal 

func (cr *ConfigFetchResponse) Marshal() ([]byte, error)

func (*ConfigFetchResponse) Unmarshal 

func (cr *ConfigFetchResponse) Unmarshal(byt []byte) error

type ConfigReloadRequest 

type ConfigReloadRequest struct {
	NonceValue []byte `json:"nonce"`
}

func (*ConfigReloadRequest) Endpoint 

func (*ConfigReloadRequest) Endpoint() string

func (*ConfigReloadRequest) Marshal 

func (crr *ConfigReloadRequest) Marshal() ([]byte, error)

func (*ConfigReloadRequest) New 

func (*ConfigReloadRequest) New() Request

func (*ConfigReloadRequest) Nonce 

func (crr *ConfigReloadRequest) Nonce() string

func (*ConfigReloadRequest) Response 

func (*ConfigReloadRequest) Response() Message

func (*ConfigReloadRequest) SetNonce 

func (crr *ConfigReloadRequest) SetNonce(nonce []byte) error

func (*ConfigReloadRequest) Unmarshal 

func (crr *ConfigReloadRequest) Unmarshal(byt []byte) error

type ConfigUpdateRequest 

type ConfigUpdateRequest struct {
	NonceValue []byte         `json:"nonce"`
	Config     *config.Config `json:"config"`
}

func (*ConfigUpdateRequest) Endpoint 

func (*ConfigUpdateRequest) Endpoint() string

func (*ConfigUpdateRequest) Marshal 

func (cur *ConfigUpdateRequest) Marshal() ([]byte, error)

func (*ConfigUpdateRequest) New 

func (*ConfigUpdateRequest) New() Request

func (*ConfigUpdateRequest) Nonce 

func (cur *ConfigUpdateRequest) Nonce() string

func (*ConfigUpdateRequest) Response 

func (*ConfigUpdateRequest) Response() Message

func (*ConfigUpdateRequest) SetNonce 

func (cur *ConfigUpdateRequest) SetNonce(nonce []byte) error

func (*ConfigUpdateRequest) Unmarshal 

func (cur *ConfigUpdateRequest) Unmarshal(byt []byte) error

type IdentifyPublisherRequest 

type IdentifyPublisherRequest struct {
	NonceValue []byte `json:"nonce"`
}

func (*IdentifyPublisherRequest) Endpoint 

func (*IdentifyPublisherRequest) Endpoint() string

func (*IdentifyPublisherRequest) Marshal 

func (ipr *IdentifyPublisherRequest) Marshal() ([]byte, error)

func (*IdentifyPublisherRequest) New 

func (*IdentifyPublisherRequest) New() Request

func (*IdentifyPublisherRequest) Nonce 

func (ipr *IdentifyPublisherRequest) Nonce() string

func (*IdentifyPublisherRequest) Response 

func (*IdentifyPublisherRequest) Response() Message

func (*IdentifyPublisherRequest) SetNonce 

func (ipr *IdentifyPublisherRequest) SetNonce(nonce []byte) error

func (*IdentifyPublisherRequest) Unmarshal 

func (ipr *IdentifyPublisherRequest) Unmarshal(byt []byte) error

type IdentifyPublisherResponse 

type IdentifyPublisherResponse struct {
	NonceValue []byte `json:"nonce"`
	Publisher  string `json:"publisher"`
}

func (*IdentifyPublisherResponse) Marshal 

func (ipr *IdentifyPublisherResponse) Marshal() ([]byte, error)

func (*IdentifyPublisherResponse) Unmarshal 

func (ipr *IdentifyPublisherResponse) Unmarshal(byt []byte) error

type Message 

type Message interface {
	Unmarshal([]byte) error
	Marshal() ([]byte, error)
}

type NilResponse 

type NilResponse struct{}

func (*NilResponse) Marshal 

func (nr *NilResponse) Marshal() ([]byte, error)

func (*NilResponse) Unmarshal 

func (nr *NilResponse) Unmarshal(byt []byte) error

type NonceRequest 

type NonceRequest struct{}

func (*NonceRequest) Endpoint 

func (*NonceRequest) Endpoint() string

func (*NonceRequest) Marshal 

func (*NonceRequest) Marshal() ([]byte, error)

func (*NonceRequest) New 

func (*NonceRequest) New() Request

func (*NonceRequest) Nonce 

func (*NonceRequest) Nonce() string

func (*NonceRequest) Response 

func (*NonceRequest) Response() Message

func (*NonceRequest) SetNonce 

func (*NonceRequest) SetNonce(nonce []byte) error

func (*NonceRequest) Unmarshal 

func (*NonceRequest) Unmarshal(byt []byte) error

type PeerNonceRequest 

type PeerNonceRequest struct{}

func (*PeerNonceRequest) Endpoint 

func (*PeerNonceRequest) Endpoint() string

func (*PeerNonceRequest) Marshal 

func (*PeerNonceRequest) Marshal() ([]byte, error)

func (*PeerNonceRequest) New 

func (*PeerNonceRequest) New() Request

func (*PeerNonceRequest) Nonce 

func (*PeerNonceRequest) Nonce() string

func (*PeerNonceRequest) Response 

func (*PeerNonceRequest) Response() Message

func (*PeerNonceRequest) SetNonce 

func (*PeerNonceRequest) SetNonce(nonce []byte) error

func (*PeerNonceRequest) Unmarshal 

func (*PeerNonceRequest) Unmarshal(byt []byte) error

type PeerRegistrationRequest 

type PeerRegistrationRequest struct {
	NonceValue []byte       `json:"nonce"`
	Peer       *config.Peer `json:"peer"`
}

func (*PeerRegistrationRequest) Endpoint 

func (*PeerRegistrationRequest) Endpoint() string

func (*PeerRegistrationRequest) Marshal 

func (peer *PeerRegistrationRequest) Marshal() ([]byte, error)

func (*PeerRegistrationRequest) New 

func (*PeerRegistrationRequest) New() Request

func (*PeerRegistrationRequest) Nonce 

func (peer *PeerRegistrationRequest) Nonce() string

func (*PeerRegistrationRequest) Response 

func (*PeerRegistrationRequest) Response() Message

func (*PeerRegistrationRequest) SetNonce 

func (peer *PeerRegistrationRequest) SetNonce(nonce []byte) error

func (*PeerRegistrationRequest) Unmarshal 

func (peer *PeerRegistrationRequest) Unmarshal(byt []byte) error

type PingRequest 

type PingRequest struct {
	NonceValue []byte `json:"nonce"`
}

func (*PingRequest) Endpoint 

func (*PingRequest) Endpoint() string

func (*PingRequest) Marshal 

func (pr *PingRequest) Marshal() ([]byte, error)

func (*PingRequest) New 

func (*PingRequest) New() Request

func (*PingRequest) Nonce 

func (pr *PingRequest) Nonce() string

func (*PingRequest) Response 

func (*PingRequest) Response() Message

func (*PingRequest) SetNonce 

func (pr *PingRequest) SetNonce(nonce []byte) error

func (*PingRequest) Unmarshal 

func (pr *PingRequest) Unmarshal(byt []byte) error

type Request 

type Request interface {
	Message

	New() Request
	Response() Message
	Endpoint() string
	SetNonce([]byte) error
	Nonce() string
}

type UptimeRequest 

type UptimeRequest struct {
	NonceValue []byte `json:"nonce"`
}

func (*UptimeRequest) Endpoint 

func (*UptimeRequest) Endpoint() string

func (*UptimeRequest) Marshal 

func (ur *UptimeRequest) Marshal() ([]byte, error)

func (*UptimeRequest) New 

func (*UptimeRequest) New() Request

func (*UptimeRequest) Nonce 

func (ur *UptimeRequest) Nonce() string

func (*UptimeRequest) Response 

func (*UptimeRequest) Response() Message

func (*UptimeRequest) SetNonce 

func (ur *UptimeRequest) SetNonce(nonce []byte) error

func (*UptimeRequest) Unmarshal 

func (ur *UptimeRequest) Unmarshal(byt []byte) error

type UptimeResponse 

type UptimeResponse struct {
	Uptime time.Duration `json:"uptime"`
}

func (*UptimeResponse) Marshal 

func (ur *UptimeResponse) Marshal() ([]byte, error)

func (*UptimeResponse) Unmarshal 

func (ur *UptimeResponse) Unmarshal(byt []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.