utils

package

v2.0.0 Latest Latest Go to latest Published: Jan 15, 2025 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/rsdmike/rpc-go

Documentation ¶

Overview ¶

********************************************************************

Copyright (c) Intel Corporation 2021
SPDX-License-Identifier: Apache-2.0 *********************************************************************

********************************************************************

Copyright (c) Intel Corporation 2021
SPDX-License-Identifier: Apache-2.0 *********************************************************************

********************************************************************

Copyright (c) Intel Corporation 2021
SPDX-License-Identifier: Apache-2.0 *********************************************************************

Index ¶

Constants
Variables
func InterpretAMTNetworkConnectionStatus(status int) string
func InterpretControlMode(mode int) string
func InterpretHashAlgorithm(hashAlgorithm int) (hashSize int, algorithm string)
func InterpretRemoteAccessConnectionStatus(status int) string
func InterpretRemoteAccessTrigger(status int) string
type CustomError
- func (e CustomError) Error() string
type PasswordReader
type RealPasswordReader
- func (pr *RealPasswordReader) ReadPassword() (string, error)
type ReturnCode

Constants ¶

View Source

const (
	// ProjectName is the name of the executable
	ProjectName = "rpc"
	// ProjectVersion is the full version of this executable
	ProtocolVersion = "4.0.0"
	// ClientName is the name of the exectable
	ClientName = "RPC"

	// LMSAddress is used for determing what address to connect to LMS on
	LMSAddress = "localhost"
	// LMSPort is used for determining what port to connect to LMS on
	LMSPort = "16992"

	AMTUserName = "admin"

	// MPSServerMaxLength is the max length of the servername
	MPSServerMaxLength = 256

	CommandActivate    = "activate"
	CommandAMTInfo     = "amtinfo"
	CommandDeactivate  = "deactivate"
	CommandMaintenance = "maintenance"
	CommandVersion     = "version"
	CommandConfigure   = "configure"

	SubCommandAddWifiSettings     = "addwifisettings"
	SubCommandWireless            = "wireless"
	SubCommandAddEthernetSettings = "wiredsettings"
	SubCommandWired               = "wired"
	SubCommandEnableWifiPort      = "enablewifiport"
	SubCommandSetMEBx             = "mebx"
	SubCommandConfigureTLS        = "tls"
	SubCommandChangePassword      = "changepassword"
	SubCommandChangeAMTPassword   = "amtpassword"
	SubCommandSyncDeviceInfo      = "syncdeviceinfo"
	SubCommandSyncClock           = "syncclock"
	SubCommandSyncHostname        = "synchostname"
	SubCommandSyncIP              = "syncip"
	SubCommandSetAMTFeatures      = "amtfeatures"

	// Return Codes
	Success ReturnCode = 0
)

View Source

const TestPassword = "test-password"

Variables ¶

View Source

var AMTAuthenticationFailed = CustomError{Code: 100, Message: "AMTAuthenticationFailed"}

(100-149) Activation, and configuration errors

View Source

var AMTConnectionFailed = CustomError{Code: 71, Message: "AMTConnectionFailed"}

View Source

var AMTFeaturesConfigurationFailed = CustomError{Code: 107, Message: "AMTFeaturesConfigurationFailed"}

View Source

var ActivationFailed = CustomError{Code: 102, Message: "ActivationFailed"}

View Source

var ActivationFailedAddCert = CustomError{Code: 131, Message: "ActivationFailed", Details: "wsman message error, failed to add certificate to AMT"}

View Source

var ActivationFailedControlMode = CustomError{Code: 135, Message: "ActivationFailed", Details: "recieved invalid control mode"}

View Source

var ActivationFailedDecode64 = CustomError{Code: 121, Message: "ActivationFailed", Details: "failed to decode the certificate from Base64 format"}

View Source

var ActivationFailedGeneralSettings = CustomError{Code: 129, Message: "ActivationFailed", Details: "wsman message error, failed to get general settings"}

View Source

var ActivationFailedGenerateNonce = CustomError{Code: 132, Message: "ActivationFailed", Details: "failed to generate nonce"}

View Source

var ActivationFailedGetCertHash = CustomError{Code: 127, Message: "ActivationFailed", Details: "failed to get certificate hashes"}

View Source

var ActivationFailedGetControlMode = CustomError{Code: 134, Message: "ActivationFailed", Details: "failed to get control mode"}

View Source

var ActivationFailedInvalidProvCert = CustomError{Code: 123, Message: "ActivationFailed", Details: "invalid provisioning certificate"}

View Source

var ActivationFailedNoCertFound = CustomError{Code: 124, Message: "ActivationFailed", Details: "no certificates found"}

View Source

var ActivationFailedNoPrivKeys = CustomError{Code: 125, Message: "ActivationFailed", Details: "no private keys found"}

View Source

var ActivationFailedNoRootCertFound = CustomError{Code: 126, Message: "ActivationFailed", Details: "root certificate not found in the pfx"}

View Source

var ActivationFailedProvCertNoMatch = CustomError{Code: 128, Message: "ActivationFailed", Details: "the root of the provisioning certificate does not match any of the trusted roots in AMT"}

View Source

var ActivationFailedSetupService = CustomError{Code: 130, Message: "ActivationFailed", Details: "wsman message error, failed to get host based setup service response"}

View Source

var ActivationFailedSignString = CustomError{Code: 133, Message: "ActivationFailed", Details: "failed to create signed string"}

View Source

var ActivationFailedWrongCertPass = CustomError{Code: 122, Message: "ActivationFailed", Details: "provisioning cert password incorrect"}

View Source

var AmtNotDetected = CustomError{Code: 3, Message: "AmtNotDetected"}

View Source

var AmtNotReady = CustomError{Code: 4, Message: "AmtNotReady"}

View Source

var AmtPtStatusCodeBase = CustomError{Code: 1000, Message: "AmtPtStatusCodeBase"}

(1000 - 3000) Amt PT Status Code Block

View Source

var CIRAConfigurationFailed = CustomError{Code: 104, Message: "CIRAConfigurationFailed"}

View Source

var ChangeAMTPasswordFailed = CustomError{Code: 119, Message: "ChangeAMTPasswordFailed"}

View Source

var ChangePasswordFailed = CustomError{Code: 153, Message: "ChangePasswordFailed"}

View Source

var DeactivationFailed = CustomError{Code: 110, Message: "DeactivationFailed"}

View Source

var DeleteConfigsFailed = CustomError{Code: 114, Message: "DeleteConfigsFailed"}

View Source

var DuplicateKey = CustomError{Code: 136, Message: "DuplicateKey", Details: "Key pair already exists"}

View Source

var FailedReadingConfiguration = CustomError{Code: 34, Message: "FailedReadingConfiguration"}

View Source

var GenericFailure = CustomError{Code: 10, Message: "GenericFailure"}

View Source

var HECIDriverNotDetected = CustomError{Code: 2, Message: "HECIDriverNotDetected"}

View Source

var HelpRequested = CustomError{Code: 5, Message: "flag: help requested"}

View Source

var Ieee8021xConfigurationFailed = CustomError{Code: 108, Message: "Ieee8021xConfigurationFailed"}

View Source

var IncorrectCommandLineParameters = CustomError{Code: 28, Message: "IncorrectCommandLineParameters"}

View Source

var IncorrectPermissions = CustomError{Code: 1, Message: "IncorrectPermissions"}

(1-19) Basic errors outside of Open AMT Cloud Toolkit

View Source

var InvalidParameterCombination = CustomError{Code: 33, Message: "InvalidParameterCombination"}

View Source

var InvalidUUID = CustomError{Code: 37, Message: "InvalidUUID"}

View Source

var InvalidUserInput = CustomError{Code: 36, Message: "InvalidUserInput"}

View Source

var MissingDNSSuffix = CustomError{Code: 24, Message: "MissingDNSSuffix"}

View Source

var MissingHostname = CustomError{Code: 25, Message: "MissingHostname"}

View Source

var MissingIeee8021xConfiguration = CustomError{Code: 117, Message: "MissingIeee8021xConfiguration"}

View Source

var MissingOrIncorrectGateway = CustomError{Code: 30, Message: "MissingOrIncorrectGateway"}

View Source

var MissingOrIncorrectNetworkMask = CustomError{Code: 29, Message: "MissingOrIncorrectNetworkMask"}

View Source

var MissingOrIncorrectPassword = CustomError{Code: 23, Message: "MissingOrIncorrectPassword"}

View Source

var MissingOrIncorrectPrimaryDNS = CustomError{Code: 31, Message: "MissingOrIncorrectPrimaryDNS"}

View Source

var MissingOrIncorrectProfile = CustomError{Code: 21, Message: "MissingOrIncorrectProfile"}

View Source

var MissingOrIncorrectSecondaryDNS = CustomError{Code: 32, Message: "MissingOrIncorrectSecondaryDNS"}

View Source

var MissingOrIncorrectStaticIP = CustomError{Code: 27, Message: "MissingOrIncorrectStaticIP"}

View Source

var MissingOrIncorrectURL = CustomError{Code: 20, Message: "MissingOrIncorrectURL"}

(20-69) Input errors to RPC

View Source

var MissingOrIncorrectWifiProfileName = CustomError{Code: 116, Message: "MissingOrIncorrectWifiProfileName"}

View Source

var MissingOrInvalidConfiguration = CustomError{Code: 35, Message: "MissingOrInvalidConfiguration"}

View Source

var MissingProxyAddressAndPort = CustomError{Code: 26, Message: "MissingProxyAddressAndPort"}

View Source

var NetworkConfigurationFailed = CustomError{Code: 103, Message: "NetworkConfigurationFailed"}

View Source

var OSNetworkInterfacesLookupFailed = CustomError{Code: 72, Message: "OSNetworkInterfacesLookupFailed"}

View Source

var PR = new(RealPasswordReader)

View Source

var PasswordsDoNotMatch = CustomError{Code: 38, Message: "PasswordsDoNotMatch"}

View Source

var ProjectVersion string = "Development Build"

View Source

var RPSAuthenticationFailed = CustomError{Code: 70, Message: "RPSAuthenticationFailed"}

(70-99) Connection Errors

View Source

var ServerCerificateVerificationFailed = CustomError{Code: 22, Message: "ServerCerificateVerificationFailed"}

View Source

var SetMEBXPasswordFailed = CustomError{Code: 118, Message: "SetMEBXPasswordFailed"}

View Source

var SyncClockFailed = CustomError{Code: 150, Message: "SyncClockFailed"}

(150-199) Maintenance Errors

View Source

var SyncDeviceInfoFailed = CustomError{Code: 154, Message: "SyncDeviceInfoFailed"}

View Source

var SyncHostnameFailed = CustomError{Code: 151, Message: "SyncHostnameFailed"}

View Source

var SyncIpFailed = CustomError{Code: 152, Message: "SyncIpFailed"}

View Source

var TLSConfigurationFailed = CustomError{Code: 105, Message: "TLSConfigurationFailed"}

View Source

var UnableToActivate = CustomError{Code: 111, Message: "UnableToActivate"}

View Source

var UnableToConfigure = CustomError{Code: 120, Message: "UnableToConfigure"}

View Source

var UnableToDeactivate = CustomError{Code: 109, Message: "UnableToDeactivate"}

View Source

var UnmarshalMessageFailed = CustomError{Code: 113, Message: "UnmarshalMessageFailed"}

View Source

var UnsupportedAMTVersion = CustomError{Code: 138, Message: "UnsupportedAMTVersion"}

View Source

var WSMANMessageError = CustomError{Code: 101, Message: "WSMANMessageError"}

View Source

var WiFiConfigurationFailed = CustomError{Code: 106, Message: "WiFiConfigurationFailed"}

View Source

var WifiConfigurationWithWarnings = CustomError{Code: 112, Message: "WifiConfigurationWithWarnings"}

View Source

var WiredConfigurationFailed = CustomError{Code: 137, Message: "WiredConfigurationFailed"}

Functions ¶

func InterpretAMTNetworkConnectionStatus ¶

func InterpretAMTNetworkConnectionStatus(status int) string

func InterpretControlMode ¶

func InterpretControlMode(mode int) string

func InterpretHashAlgorithm ¶

func InterpretHashAlgorithm(hashAlgorithm int) (hashSize int, algorithm string)

func InterpretRemoteAccessConnectionStatus ¶

func InterpretRemoteAccessConnectionStatus(status int) string

func InterpretRemoteAccessTrigger ¶

func InterpretRemoteAccessTrigger(status int) string

Types ¶

type CustomError ¶

type CustomError struct {
	Code    int
	Message string
	Details string
}

CustomError defines a custom error type with an integer code and a message.

func (CustomError) Error ¶

func (e CustomError) Error() string

Error implements the error interface for CustomError.

type PasswordReader ¶

type PasswordReader interface {
	ReadPassword() (string, error)
}

type RealPasswordReader ¶

type RealPasswordReader struct{}

func (*RealPasswordReader) ReadPassword ¶

func (pr *RealPasswordReader) ReadPassword() (string, error)

type ReturnCode ¶

type ReturnCode int

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL