register

Documentation

Index

• Constants
• func SendJSONData(conn *websocket.Conn, msgType MessageType, data interface{}) error
• func WriteMessage(conn *websocket.Conn, msgType MessageType, data []byte) error
• type Client
  • func NewClient() Client
• type ErrorMessage
  • func NewErrorMessage(err error) ErrorMessage
• type MessageType
  • func ReadMessage(conn *websocket.Conn) (MessageType, []byte, error)
  • func (mt MessageType) String() string
• type State
  • func (s *State) HasLastUpdateElapsed(suppress time.Duration) bool
  • func (s *State) IsUpdatable() bool
• type StateHandler
  • func NewFileStateHandler(fs vfs.FS) StateHandler

Constants

const RegistrationDeadlineSeconds = 10

Functions

func SendJSONData

func SendJSONData(conn *websocket.Conn, msgType MessageType, data interface{}) error

SendJSONData transmits json encoded data to the websocket connection, attaching to it msgType. It needs a `MsgReady` reply on the websocket channel in order to report a successful transmission

func WriteMessage

func WriteMessage(conn *websocket.Conn, msgType MessageType, data []byte) error

WriteMessage attaches msgType to the actual data before sending it to the websocket connection

Types

type Client

type Client interface {
	Register(reg elementalv1.Registration, caCert []byte, state *State) ([]byte, error)
}

func NewClient

func NewClient() Client

type ErrorMessage

type ErrorMessage struct {
	Message string `json:"message,omitempty" yaml:"message"`
}

func NewErrorMessage

func NewErrorMessage(err error) ErrorMessage

type MessageType

type MessageType byte

const (
	MsgUndefined MessageType = iota
	MsgReady
	MsgSmbios
	MsgLabels
	MsgGet
	MsgVersion                 // v1.1.0
	MsgSystemData              // v1.1.1
	MsgConfig                  // v1.1.1
	MsgError                   // v1.1.1
	MsgAnnotations             // v1.1.4
	MsgUpdate                  // v1.2.6
	MsgLast        = MsgUpdate // MsgLast must point to the last message
)

func ReadMessage

func ReadMessage(conn *websocket.Conn) (MessageType, []byte, error)

ReadMessage reads from the websocket connection returning the MessageType and the actual data

func (MessageType) String

func (mt MessageType) String() string

type State

type State struct {
	InitialRegistration time.Time `yaml:"initialRegistration,omitempty"`
	LastUpdate          time.Time `yaml:"lastUpdate,omitempty"`
	EmulatedTPM         bool      `yaml:"emulatedTPM,omitempty"`
	EmulatedTPMSeed     int64     `yaml:"emulatedTPMSeed,omitempty"`
}

func (*State) HasLastUpdateElapsed

func (s *State) HasLastUpdateElapsed(suppress time.Duration) bool

func (*State) IsUpdatable

func (s *State) IsUpdatable() bool

type StateHandler

type StateHandler interface {
	Init(location string) error
	Load() (State, error)
	Save(State) error
}

func NewFileStateHandler

func NewFileStateHandler(fs vfs.FS) StateHandler