devices

package
v1.0.0-beta.2 Latest Latest
Warning

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

 Go to latest Published: Nov 8, 2024 License: Apache-2.0 Imports: 49 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	TypeWireless string = "Wireless"
	TypeTLS      string = "TLS"
	TypeWired    string = "Wired"
)
View Source 
const (
	HeaderByteSize             = 9
	ContentLengthPadding       = 8
	RedirectSessionLengthBytes = 13
	RedirectionSessionReply    = 4
)
View Source 
const (
	RedirectionCommandsStartRedirectionSession      = 16
	RedirectionCommandsStartRedirectionSessionReply = 17
	RedirectionCommandsEndRedirectionSession        = 18
	RedirectionCommandsAuthenticateSession          = 19
	RedirectionCommandsAuthenticateSessionReply     = 20
	StartRedirectionSessionReplyStatusSuccess       = 0
	StartRedirectionSessionReplyStatusUnknown       = 1
	StartRedirectionSessionReplyStatusBusy          = 2
	StartRedirectionSessionReplyStatusUnsupported   = 3
	StartRedirectionSessionReplyStatusError         = 0xFF
	AuthenticationTypeQuery                         = 0
	AuthenticationTypeUserPass                      = 1
	AuthenticationTypeKerberos                      = 2
	AuthenticationTypeBadDigest                     = 3
	AuthenticationTypeDigest                        = 4
	AuthenticationStatusSuccess                     = 0
	AuthenticationStatusFail                        = 1
	AuthenticationStatusNotSupported                = 2

	// MinAMTVersion - minimum AMT version required for certain features in power capabilities.
	MinAMTVersion = 9
)

Variables

View Source 
var (
	ErrDomainsUseCase = consoleerrors.CreateConsoleError("DevicesUseCase")
	ErrDatabase       = sqldb.DatabaseError{Console: consoleerrors.CreateConsoleError("DevicesUseCase")}
	ErrNotFound       = sqldb.NotFoundError{Console: consoleerrors.CreateConsoleError("DevicesUseCase")}
)
View Source 
var ErrAMT = AMTError{Console: consoleerrors.CreateConsoleError("DevicesUseCase")}
View Source 
var ErrLengthLimit = errors.New("calculated length exceeds uint32 limit")
View Source 
var UserConsentOptions = map[int]string{
	0:          "none",
	1:          "kvm",
	4294967295: "all",
}

Functions

func CertificatesToDTO 

func CertificatesToDTO(r *publickey.RefinedPullResponse) dto.CertificatePullResponse

func KeysToDTO 

func KeysToDTO(r *publicprivate.RefinedPullResponse) dto.KeyPullResponse

func ParseInterval 

func ParseInterval(duration string) (int, error)

func RandomValueHex 

func RandomValueHex(length int) (string, error)

Types

type AMTError 

type AMTError struct {
	Console consoleerrors.InternalError
}

func (AMTError) Error 

func (e AMTError) Error() string

func (AMTError) Wrap 

func (e AMTError) Wrap(call, function string, err error) error

type DeviceConnection 

type DeviceConnection struct {
	Conn WebSocketConn

	Device    entity.Device
	Direct    bool
	Mode      string
	Challenge client.AuthChallenge
	// contains filtered or unexported fields
}

type ExplorerError 

type ExplorerError struct {
	Console consoleerrors.InternalError
}

func (ExplorerError) Error 

func (e ExplorerError) Error() string

func (ExplorerError) Wrap 

func (e ExplorerError) Wrap(call, function string, err error) error

type Feature 

type Feature interface {
	// Repository/Database Calls
	GetCount(context.Context, string) (int, error)
	Get(ctx context.Context, top, skip int, tenantID string) ([]dto.Device, error)
	GetByID(ctx context.Context, guid, tenantID string) (*dto.Device, error)
	GetDistinctTags(ctx context.Context, tenantID string) ([]string, error)
	GetByTags(ctx context.Context, tags, method string, limit, offset int, tenantID string) ([]dto.Device, error)
	Delete(ctx context.Context, guid, tenantID string) error
	Update(ctx context.Context, d *dto.Device) (*dto.Device, error)
	Insert(ctx context.Context, d *dto.Device) (*dto.Device, error)
	GetByColumn(ctx context.Context, columnName, queryValue, tenantID string) ([]dto.Device, error)
	// Management Calls
	GetVersion(ctx context.Context, guid string) (dto.Version, dtov2.Version, error)
	GetFeatures(ctx context.Context, guid string) (dto.Features, dtov2.Features, error)
	SetFeatures(ctx context.Context, guid string, features dto.Features) (dto.Features, dtov2.Features, error)
	GetAlarmOccurrences(ctx context.Context, guid string) ([]dto.AlarmClockOccurrence, error)
	CreateAlarmOccurrences(ctx context.Context, guid string, alarm dto.AlarmClockOccurrenceInput) (dto.AddAlarmOutput, error)
	DeleteAlarmOccurrences(ctx context.Context, guid, instanceID string) error
	GetHardwareInfo(ctx context.Context, guid string) (interface{}, error)
	GetPowerState(ctx context.Context, guid string) (dto.PowerState, error)
	GetPowerCapabilities(ctx context.Context, guid string) (dto.PowerCapabilities, error)
	GetGeneralSettings(ctx context.Context, guid string) (interface{}, error)
	CancelUserConsent(ctx context.Context, guid string) (dto.UserConsentMessage, error)
	GetUserConsentCode(ctx context.Context, guid string) (dto.GetUserConsentMessage, error)
	SendConsentCode(ctx context.Context, code dto.UserConsentCode, guid string) (dto.UserConsentMessage, error)
	SendPowerAction(ctx context.Context, guid string, action int) (power.PowerActionResponse, error)
	SetBootOptions(ctx context.Context, guid string, bootSetting dto.BootSetting) (power.PowerActionResponse, error)
	GetAuditLog(ctx context.Context, startIndex int, guid string) (dto.AuditLog, error)
	GetEventLog(ctx context.Context, guid string) ([]dto.EventLog, error)
	Redirect(ctx context.Context, conn *websocket.Conn, guid, mode string) error
	GetNetworkSettings(c context.Context, guid string) (dto.NetworkSettings, error)
	GetCertificates(c context.Context, guid string) (dto.SecuritySettings, error)
	GetTLSSettingData(c context.Context, guid string) ([]dto.SettingDataResponse, error)
	GetDiskInfo(c context.Context, guid string) (interface{}, error)
	GetDeviceCertificate(c context.Context, guid string) (dto.Certificate, error)
}

type Redirection 

type Redirection interface {
	SetupWsmanClient(device entity.Device, isRedirection, logMessages bool) wsman.Messages
	RedirectConnect(ctx context.Context, deviceConnection *DeviceConnection) error
	RedirectClose(ctx context.Context, deviceConnection *DeviceConnection) error
	RedirectListen(ctx context.Context, deviceConnection *DeviceConnection) ([]byte, error)
	RedirectSend(ctx context.Context, deviceConnection *DeviceConnection, message []byte) error
}

type Redirector 

type Redirector struct {
	SafeRequirements security.Cryptor
}

func NewRedirector 

func NewRedirector(safeRequirements security.Cryptor) *Redirector

func (*Redirector) RedirectClose 

func (g *Redirector) RedirectClose(_ context.Context, deviceConnection *DeviceConnection) error

func (*Redirector) RedirectConnect 

func (g *Redirector) RedirectConnect(_ context.Context, deviceConnection *DeviceConnection) error

func (*Redirector) RedirectListen 

func (g *Redirector) RedirectListen(_ context.Context, deviceConnection *DeviceConnection) ([]byte, error)

func (*Redirector) RedirectSend 

func (g *Redirector) RedirectSend(_ context.Context, deviceConnection *DeviceConnection, data []byte) error

func (*Redirector) SetupWsmanClient 

func (g *Redirector) SetupWsmanClient(device entity.Device, isRedirection, logAMTMessages bool) wsman.Messages

type Repository 

type Repository interface {
	GetCount(context.Context, string) (int, error)
	Get(ctx context.Context, top, skip int, tenantID string) ([]entity.Device, error)
	GetByID(ctx context.Context, guid, tenantID string) (*entity.Device, error)
	GetDistinctTags(ctx context.Context, tenantID string) ([]string, error)
	GetByTags(ctx context.Context, tags []string, method string, limit, offset int, tenantID string) ([]entity.Device, error)
	Delete(ctx context.Context, guid, tenantID string) (bool, error)
	Update(ctx context.Context, d *entity.Device) (bool, error)
	Insert(ctx context.Context, d *entity.Device) (string, error)
	GetByColumn(ctx context.Context, columnName, queryValue, tenantID string) ([]entity.Device, error)
}

type UseCase 

type UseCase struct {
	// contains filtered or unexported fields
}

UseCase -.

func New 

func New(r Repository, d WSMAN, redirection Redirection, log logger.Interface, safeRequirements security.Cryptor) *UseCase

New -.

func (*UseCase) CancelUserConsent 

func (uc *UseCase) CancelUserConsent(c context.Context, guid string) (dto.UserConsentMessage, error)

func (*UseCase) CreateAlarmOccurrences 

func (uc *UseCase) CreateAlarmOccurrences(c context.Context, guid string, alarm dto.AlarmClockOccurrenceInput) (dto.AddAlarmOutput, error)

func (*UseCase) Delete 

func (uc *UseCase) Delete(ctx context.Context, guid, tenantID string) error

func (*UseCase) DeleteAlarmOccurrences 

func (uc *UseCase) DeleteAlarmOccurrences(c context.Context, guid, instanceID string) error

func (*UseCase) Get 

func (uc *UseCase) Get(ctx context.Context, top, skip int, tenantID string) ([]dto.Device, error)

func (*UseCase) GetAlarmOccurrences 

func (uc *UseCase) GetAlarmOccurrences(c context.Context, guid string) ([]dto.AlarmClockOccurrence, error)

func (*UseCase) GetAuditLog 

func (uc *UseCase) GetAuditLog(c context.Context, startIndex int, guid string) (dto.AuditLog, error)

func (*UseCase) GetByColumn 

func (uc *UseCase) GetByColumn(ctx context.Context, columnName, queryValue, tenantID string) ([]dto.Device, error)

func (*UseCase) GetByID 

func (uc *UseCase) GetByID(ctx context.Context, guid, tenantID string) (*dto.Device, error)

func (*UseCase) GetByTags 

func (uc *UseCase) GetByTags(ctx context.Context, tags, method string, limit, offset int, tenantID string) ([]dto.Device, error)

func (*UseCase) GetCertificates 

func (uc *UseCase) GetCertificates(c context.Context, guid string) (dto.SecuritySettings, error)

func (*UseCase) GetCount 

func (uc *UseCase) GetCount(ctx context.Context, tenantID string) (int, error)

History - getting translate history from store.

func (*UseCase) GetDeviceCertificate 

func (uc *UseCase) GetDeviceCertificate(c context.Context, guid string) (dto.Certificate, error)

func (*UseCase) GetDiskInfo 

func (uc *UseCase) GetDiskInfo(c context.Context, guid string) (interface{}, error)

func (*UseCase) GetDistinctTags 

func (uc *UseCase) GetDistinctTags(ctx context.Context, tenantID string) ([]string, error)

func (*UseCase) GetEventLog 

func (uc *UseCase) GetEventLog(c context.Context, guid string) ([]dto.EventLog, error)

func (*UseCase) GetFeatures 

func (uc *UseCase) GetFeatures(c context.Context, guid string) (settingsResults dto.Features, settingsResultsV2 dtov2.Features, err error)

func (*UseCase) GetGeneralSettings 

func (uc *UseCase) GetGeneralSettings(c context.Context, guid string) (interface{}, error)

func (*UseCase) GetHardwareInfo 

func (uc *UseCase) GetHardwareInfo(c context.Context, guid string) (interface{}, error)

func (*UseCase) GetNetworkSettings 

func (uc *UseCase) GetNetworkSettings(c context.Context, guid string) (dto.NetworkSettings, error)

func (*UseCase) GetPowerCapabilities 

func (uc *UseCase) GetPowerCapabilities(c context.Context, guid string) (dto.PowerCapabilities, error)

func (*UseCase) GetPowerState 

func (uc *UseCase) GetPowerState(c context.Context, guid string) (dto.PowerState, error)

func (*UseCase) GetTLSSettingData 

func (uc *UseCase) GetTLSSettingData(c context.Context, guid string) ([]dto.SettingDataResponse, error)

func (*UseCase) GetUserConsentCode 

func (uc *UseCase) GetUserConsentCode(c context.Context, guid string) (dto.GetUserConsentMessage, error)

func (*UseCase) GetVersion 

func (uc *UseCase) GetVersion(c context.Context, guid string) (v1 dto.Version, v2 dtov2.Version, err error)

func (*UseCase) Insert 

func (uc *UseCase) Insert(ctx context.Context, d *dto.Device) (*dto.Device, error)

func (*UseCase) ListenToBrowser 

func (uc *UseCase) ListenToBrowser(c context.Context, deviceConnection *DeviceConnection)

func (*UseCase) ListenToDevice 

func (uc *UseCase) ListenToDevice(c context.Context, deviceConnection *DeviceConnection)

func (*UseCase) Redirect 

func (uc *UseCase) Redirect(c context.Context, conn *websocket.Conn, guid, mode string) error

func (*UseCase) SendConsentCode 

func (uc *UseCase) SendConsentCode(c context.Context, userConsent dto.UserConsentCode, guid string) (dto.UserConsentMessage, error)

func (*UseCase) SendPowerAction 

func (uc *UseCase) SendPowerAction(c context.Context, guid string, action int) (power.PowerActionResponse, error)

func (*UseCase) SetBootOptions 

func (uc *UseCase) SetBootOptions(c context.Context, guid string, bootSetting dto.BootSetting) (power.PowerActionResponse, error)

func (*UseCase) SetFeatures 

func (uc *UseCase) SetFeatures(c context.Context, guid string, features dto.Features) (settingsResults dto.Features, settingsResultsV2 dtov2.Features, err error)

func (*UseCase) Update 

func (uc *UseCase) Update(ctx context.Context, d *dto.Device) (*dto.Device, error)

type WSMAN 

type WSMAN interface {
	SetupWsmanClient(device entity.Device, isRedirection, logMessages bool) wsmanAPI.Management
	DestroyWsmanClient(device dto.Device)
	Worker()
}

type WebSocketConn 

type WebSocketConn interface {
	ReadMessage() (int, []byte, error)
	WriteMessage(messageType int, data []byte) error
	Close() error
}

Source Files

View all Source files

Directories

Path Synopsis

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.