api

Documentation

Index

• type ArchAndOS
• type Service
  • func NewService() *Service
  • func (svc *Service) HealthHandler(ginCtx *gin.Context)
  • func (svc *Service) IsHealthy() bool
  • func (svc *Service) PatchUpdateHandler(ginCtx *gin.Context)
  • func (svc *Service) RegisterShutdown()
  • func (svc *Service) RootHandler(ginCtx *gin.Context)
  • func (svc *Service) Run(config *ServiceConfig) error
  • func (svc *Service) SignedPatchUpdateHandler(ginCtx *gin.Context)
  • func (svc *Service) SignedUpdateHandler(ginCtx *gin.Context)
  • func (svc *Service) UpdateHandler(ginCtx *gin.Context)
  • func (svc *Service) UploadHandler(ginCtx *gin.Context)
• type ServiceConfig
• type Update
  • func (u *Update) Clone() *Update
  • func (u *Update) GetFilepath() string
  • func (u *Update) GetLatestVersion() string
  • func (u *Update) GetReader(filepath string) (io.ReadCloser, error)
  • func (u *Update) String() string
• type UploadData
  • func (ud *UploadData) Save(application string) error
  • func (ud *UploadData) Write(filepath string, data []byte) error

Types

type ArchAndOS

type ArchAndOS struct {
	Arch string // GOARCH
	OS   string // GOOS
}

type Service

type Service struct {
	Healthy bool
	// contains filtered or unexported fields
}

Service is the main struct

func NewService

func NewService() *Service

func (*Service) HealthHandler

func (svc *Service) HealthHandler(ginCtx *gin.Context)

HealthHandler handles /healthz endpoint

func (*Service) IsHealthy

func (svc *Service) IsHealthy() bool

IsHealthy returns the health status of the running service.

func (*Service) PatchUpdateHandler

func (svc *Service) PatchUpdateHandler(ginCtx *gin.Context)

PatchUpdateHandler handles /patch-update/:name endpoint TODO: use file cache to read and store binarydiff

func (*Service) RegisterShutdown

func (svc *Service) RegisterShutdown()

func (*Service) RootHandler

func (svc *Service) RootHandler(ginCtx *gin.Context)

RootHandler handles / endpoint

func (*Service) Run

func (svc *Service) Run(config *ServiceConfig) error

Run is the main function of the server. It bootstraps the service and creates the route endpoints.

func (*Service) SignedPatchUpdateHandler

func (svc *Service) SignedPatchUpdateHandler(ginCtx *gin.Context)

SignedPatchUpdateHandler handles /signed-patch-update/:name endpoint

func (*Service) SignedUpdateHandler

func (svc *Service) SignedUpdateHandler(ginCtx *gin.Context)

SignedUpdateHandler handles /signed-update/:name endpoint

func (*Service) UpdateHandler

func (svc *Service) UpdateHandler(ginCtx *gin.Context)

UpdateHandler handles /update/:name endpoint

func (*Service) UploadHandler

func (svc *Service) UploadHandler(ginCtx *gin.Context)

UploadHandler handles /upload/:name endpoint

type ServiceConfig

type ServiceConfig struct {
	Config          *conf.Config
	OAuth2Endpoints oauth2.Endpoint
	CertKeyPair     tls.Certificate
	Httponly        bool
}

ServiceConfig contains everything configurable for the service endpoint.

type Update

type Update struct {
	Name    string
	Version string
	System  ArchAndOS
}

func (*Update) Clone

func (u *Update) Clone() *Update

func (*Update) GetFilepath

func (u *Update) GetFilepath() string

func (*Update) GetLatestVersion

func (u *Update) GetLatestVersion() string

func (*Update) GetReader

func (u *Update) GetReader(filepath string) (io.ReadCloser, error)

func (*Update) String

func (u *Update) String() string

type UploadData

type UploadData struct {
	Data          []byte `json:"data"`                     // the new binary version
	Version       string `json:"version"`                  // version string
	Architecture  string `json:"arch"`                     // architecture, p.e. amd64
	OS            string `json:"os"`                       // operating system, p.e. linux
	Signature     []byte `json:"signature,omitempty"`      // DER encoded signature
	SignatureType string `json:"signature-type,omitempty"` // ecdsa
}

UploadData represents all the data needed to provide update, patch update, signed update or signed patch update. You need to sign your data if you want to provide signed updates.

func (*UploadData) Save

func (ud *UploadData) Save(application string) error

func (*UploadData) Write

func (ud *UploadData) Write(filepath string, data []byte) error