secureagent

Documentation

Overview

nolint Package secureagent implements the secure agent

Package secureagent implements the secure agent

Package secureagent implements the secure agent

Package secureagent implements the secure agent

nolint Package secureagent implements the secure agent

Package secureagent implements the secure agent

Package secureagent implements the secure agent

Package secureagent implements the secure agent

Package secureagent implements the secure agent

Index

• Constants
• func GetSerialNumber(givenSerialNumber string) string
• func NewHTTPClient(bootstrapTrustAnchorCert string, deviceEndEntityCert string, ...) http.Client
• type Agent
  • func NewAgent(...) *Agent
  • func (a *Agent) GetBootstrapTrustAnchorCert() string
  • func (a *Agent) GetBootstrapURL() string
  • func (a *Agent) GetContentTypeReq() string
  • func (a *Agent) GetDeviceEndEntityCert() string
  • func (a *Agent) GetDevicePassword() string
  • func (a *Agent) GetDevicePrivateKey() string
  • func (a *Agent) GetInputJSONContent() string
  • func (a *Agent) GetProgressJSON() ProgressJSON
  • func (a *Agent) GetSerialNumber() string
  • func (a *Agent) RunCommand() error
  • func (a *Agent) RunCommandDaemon() error
  • func (a *Agent) RunCommandDisable() error
  • func (a *Agent) RunCommandEnable() error
  • func (a *Agent) RunCommandStatus() error
  • func (a *Agent) SetBootstrapTrustAnchorCert(cacert string)
  • func (a *Agent) SetBootstrapURL(url string)
  • func (a *Agent) SetContentTypeReq(ct string)
  • func (a *Agent) SetDeviceEndEntityCert(cert string)
  • func (a *Agent) SetDevicePassword(pass string)
  • func (a *Agent) SetDevicePrivateKey(key string)
  • func (a *Agent) SetProgressJSON(p ProgressJSON)
  • func (a *Agent) SetSerialNumber(serialNumber string)
• type BootstrapServerErrorOutput
• type BootstrapServerOnboardingInfo
• type BootstrapServerPostOutput
• type BootstrapServerRedirectInfo
• type HttpClient
• type InputJSON
• type ProgressJSON
• type ProgressType
  • func (s ProgressType) String() string

Constants

const (
	CONTENT_TYPE_YANG = "application/yang-data+json"
	OS_RELEASE_FILE   = "/etc/os-release"
	SZTP_REDIRECT_URL = "sztp-redirect-urls"
	ARTIFACTS_PATH    = "/tmp/"
)

const (
	// PRE nolint:var-naming
	PRE = "pre"
	// POST nolint:var-naming
	POST = "post"
)

Functions

func GetSerialNumber

func GetSerialNumber(givenSerialNumber string) string

GetSerialNumber returns the serial number of the device

func NewHTTPClient

func NewHTTPClient(bootstrapTrustAnchorCert string, deviceEndEntityCert string, devicePrivateKey string) http.Client

NewHTTPClient instantiate a new HTTP Client

Types

type Agent

type Agent struct {
	InputBootstrapURL             string                        // Bootstrap complete URL given by USER
	BootstrapURL                  string                        // Bootstrap complete URL
	SerialNumber                  string                        // Device's Serial Number
	DevicePassword                string                        // Device's Password
	DevicePrivateKey              string                        // Device's private key
	DeviceEndEntityCert           string                        // Device's end-entity cert
	BootstrapTrustAnchorCert      string                        // the trusted bootstrap server's trust-anchor certificate (PEM)
	ContentTypeReq                string                        // The content type for the request to the Server
	InputJSONContent              string                        // The input.json file serialized
	DhcpLeaseFile                 string                        // The dhcpfile
	ProgressJSON                  ProgressJSON                  // ProgressJson structure
	BootstrapServerOnboardingInfo BootstrapServerOnboardingInfo // BootstrapServerOnboardingInfo structure
	BootstrapServerRedirectInfo   BootstrapServerRedirectInfo   // BootstrapServerRedirectInfo structure
	HttpClient                    HttpClient
}

Agent is the basic structure to define an agent instance

func NewAgent

func NewAgent(bootstrapURL, serialNumber, dhcpLeaseFile, devicePassword, devicePrivateKey, deviceEndEntityCert, bootstrapTrustAnchorCert string, httpClient HttpClient) *Agent

func (*Agent) GetBootstrapTrustAnchorCert

func (a *Agent) GetBootstrapTrustAnchorCert() string

func (*Agent) GetBootstrapURL

func (a *Agent) GetBootstrapURL() string

func (*Agent) GetContentTypeReq

func (a *Agent) GetContentTypeReq() string

func (*Agent) GetDeviceEndEntityCert

func (a *Agent) GetDeviceEndEntityCert() string

func (*Agent) GetDevicePassword

func (a *Agent) GetDevicePassword() string

func (*Agent) GetDevicePrivateKey

func (a *Agent) GetDevicePrivateKey() string

func (*Agent) GetInputJSONContent

func (a *Agent) GetInputJSONContent() string

func (*Agent) GetProgressJSON

func (a *Agent) GetProgressJSON() ProgressJSON

func (*Agent) GetSerialNumber

func (a *Agent) GetSerialNumber() string

func (*Agent) RunCommand

func (a *Agent) RunCommand() error

RunCommand runs the command in the background

func (*Agent) RunCommandDaemon

func (a *Agent) RunCommandDaemon() error

RunCommandDaemon runs the command in the background

func (*Agent) RunCommandDisable

func (a *Agent) RunCommandDisable() error

RunCommandDisable runs the command in the background

func (*Agent) RunCommandEnable

func (a *Agent) RunCommandEnable() error

RunCommandEnable runs the command in the background

func (*Agent) RunCommandStatus

func (a *Agent) RunCommandStatus() error

RunCommandStatus runs the command in the background

func (*Agent) SetBootstrapTrustAnchorCert

func (a *Agent) SetBootstrapTrustAnchorCert(cacert string)

func (*Agent) SetBootstrapURL

func (a *Agent) SetBootstrapURL(url string)

func (*Agent) SetContentTypeReq

func (a *Agent) SetContentTypeReq(ct string)

func (*Agent) SetDeviceEndEntityCert

func (a *Agent) SetDeviceEndEntityCert(cert string)

func (*Agent) SetDevicePassword

func (a *Agent) SetDevicePassword(pass string)

func (*Agent) SetDevicePrivateKey

func (a *Agent) SetDevicePrivateKey(key string)

func (*Agent) SetProgressJSON

func (a *Agent) SetProgressJSON(p ProgressJSON)

func (*Agent) SetSerialNumber

func (a *Agent) SetSerialNumber(serialNumber string)

type BootstrapServerErrorOutput

type BootstrapServerErrorOutput struct {
	IetfRestconfErrors struct {
		Error []struct {
			ErrorType    string `json:"error-type"`
			ErrorTag     string `json:"error-tag"`
			ErrorMessage string `json:"error-message"`
		} `json:"error"`
	} `json:"ietf-restconf:errors"`
}

type BootstrapServerOnboardingInfo

type BootstrapServerOnboardingInfo struct {
	IetfSztpConveyedInfoOnboardingInformation struct {
		InfoTimestampReference string // [not received in json] This is the reference to know exactly the time file downloaded and reference to the artifacts of a specific request
		BootImage              struct {
			DownloadURI       []string `json:"download-uri"`
			ImageVerification []struct {
				HashAlgorithm string `json:"hash-algorithm"`
				HashValue     string `json:"hash-value"`
			} `json:"image-verification"`
		} `json:"boot-image"`
		PreConfigurationScript  string `json:"pre-configuration-script"`
		ConfigurationHandling   string `json:"configuration-handling"`
		Configuration           string `json:"configuration"`
		PostConfigurationScript string `json:"post-configuration-script"`
	} `json:"ietf-sztp-conveyed-info:onboarding-information"`
}

type BootstrapServerPostOutput

type BootstrapServerPostOutput struct {
	IetfSztpBootstrapServerOutput struct {
		ConveyedInformation string `json:"conveyed-information"`
	} `json:"ietf-sztp-bootstrap-server:output"`
}

type BootstrapServerRedirectInfo

type BootstrapServerRedirectInfo struct {
	IetfSztpConveyedInfoRedirectInformation struct {
		BootstrapServer []struct {
			Address     string `json:"address"`
			Port        int    `json:"port"`
			TrustAnchor string `json:"trust-anchor"`
		} `json:"bootstrap-server"`
	} `json:"ietf-sztp-conveyed-info:redirect-information"`
}

type HttpClient

type HttpClient interface {
	Get(uri string) (*http.Response, error)
	Do(req *http.Request) (*http.Response, error)
}

type InputJSON

type InputJSON struct {
	IetfSztpBootstrapServerInput struct {
		HwModel   string `json:"hw-model"`
		OsName    string `json:"os-name"`
		OsVersion string `json:"os-version"`
		Nonce     string `json:"nonce"`
	} `json:"ietf-sztp-bootstrap-server:input"`
}

type ProgressJSON

type ProgressJSON struct {
	IetfSztpBootstrapServerInput struct {
		ProgressType string `json:"progress-type"`
		Message      string `json:"message"`
		SSHHostKeys  struct {
			SSHHostKey []struct {
				Algorithm string `json:"algorithm"`
				KeyData   string `json:"key-data"`
			} `json:"ssh-host-key,omitempty"`
		} `json:"ssh-host-keys,omitempty"`
		TrustAnchorCerts struct {
			TrustAnchorCert []string `json:"trust-anchor-cert,omitempty"`
		} `json:"trust-anchor-certs,omitempty"`
	} `json:"ietf-sztp-bootstrap-server:input"`
}

type ProgressType

type ProgressType int64

const (
	ProgressTypeBootstrapInitiated ProgressType = iota
	ProgressTypeParsingInitiated
	ProgressTypeParsingWarning
	ProgressTypeParsingError
	ProgressTypeParsingComplete
	ProgressTypeBootImageInitiated
	ProgressTypeBootImageWarning
	ProgressTypeBootImageError
	ProgressTypeBootImageMismatch
	ProgressTypeBootImageInstalledRebooting
	ProgressTypeBootImageComplete
	ProgressTypePreScriptInitiated
	ProgressTypePreScriptWarning
	ProgressTypePreScriptError
	ProgressTypePreScriptComplete
	ProgressTypeConfigInitiated
	ProgressTypeConfigWarning
	ProgressTypeConfigError
	ProgressTypeConfigComplete
	ProgressTypePostScriptInitiated
	ProgressTypePostScriptWarning
	ProgressTypePostScriptError
	ProgressTypePostScriptComplete
	ProgressTypeBootstrapWarning
	ProgressTypeBootstrapError
	ProgressTypeBootstrapComplete
	ProgressTypeInformational
)

func (ProgressType) String

func (s ProgressType) String() string