agents

Documentation

Index

• Variables
• func AddJob(agentID uuid.UUID, jobType string, jobArgs []string) (string, error)
• func FileTransfer(m messages.Base) error
• func GetAgentFieldValue(agentID uuid.UUID, field string) (string, error)
• func GetAgentList() func(string) []string
• func GetAgentStatus(agentID uuid.UUID) string
• func GetEncryptionKey(agentID uuid.UUID) []byte
• func GetLifetime(agentID uuid.UUID) (time.Duration, error)
• func GetMessageForJob(agentID uuid.UUID, job Job) (messages.Base, error)
• func JobResults(m messages.Base) error
• func KeyExchange(m messages.Base) (messages.Base, error)
• func Log(agentID uuid.UUID, logMessage string)
• func OPAQUEAuthenticateComplete(m messages.Base) (messages.Base, error)
• func OPAQUEAuthenticateInit(m messages.Base) (messages.Base, error)
• func OPAQUEReAuthenticate(agentID uuid.UUID) (messages.Base, error)
• func OPAQUERegistrationComplete(m messages.Base) (messages.Base, error)
• func OPAQUERegistrationInit(m messages.Base, opaqueServerKey kyber.Scalar) (messages.Base, error)
• func RemoveAgent(agentID uuid.UUID) error
• func ShowInfo(agentID uuid.UUID)
• func StatusCheckIn(m messages.Base) (messages.Base, error)
• func UpdateInfo(m messages.Base) error
• type Job

Variables

var Agents = make(map[uuid.UUID]*agent)

Agents contains all of the instantiated agent object that are accessed by other modules

Functions

func AddJob

func AddJob(agentID uuid.UUID, jobType string, jobArgs []string) (string, error)

AddJob creates a job and adds it to the specified agent's channel and returns the Job ID or an error

func FileTransfer

func FileTransfer(m messages.Base) error

FileTransfer handles file upload/download operations

func GetAgentFieldValue

func GetAgentFieldValue(agentID uuid.UUID, field string) (string, error)

GetAgentFieldValue returns a string value for the field value belonging to the specified Agent

func GetAgentList

func GetAgentList() func(string) []string

GetAgentList returns a list of agents that exist and is used for command line tab completion

func GetAgentStatus

func GetAgentStatus(agentID uuid.UUID) string

GetAgentStatus evaluates the agent's last check in time and max wait time to determine if it is active, delayed, or dead

func GetEncryptionKey

func GetEncryptionKey(agentID uuid.UUID) []byte

GetEncryptionKey retrieves the per-agent payload encryption key used to decrypt messages for any protocol

func GetLifetime

func GetLifetime(agentID uuid.UUID) (time.Duration, error)

GetLifetime returns the amount an agent could live without successfully communicating with the server

func GetMessageForJob

func GetMessageForJob(agentID uuid.UUID, job Job) (messages.Base, error)

GetMessageForJob returns a Message Base structure for the provided job type

func JobResults

func JobResults(m messages.Base) error

JobResults handles the response message sent by the agent

func KeyExchange

func KeyExchange(m messages.Base) (messages.Base, error)

KeyExchange is used to exchange public keys between the server and agent

func Log

func Log(agentID uuid.UUID, logMessage string)

Log is used to write log messages to the agent's log file

func OPAQUEAuthenticateComplete

func OPAQUEAuthenticateComplete(m messages.Base) (messages.Base, error)

OPAQUEAuthenticateComplete is used to receive the OPAQUE UserAuthComplete

func OPAQUEAuthenticateInit

func OPAQUEAuthenticateInit(m messages.Base) (messages.Base, error)

OPAQUEAuthenticateInit is used to authenticate an agent leveraging the OPAQUE Password Authenticated Key Exchange (PAKE) protocol and pre-shared key

func OPAQUEReAuthenticate

func OPAQUEReAuthenticate(agentID uuid.UUID) (messages.Base, error)

OPAQUEReAuthenticate is used when an agent has previously completed OPAQUE registration but needs to re-authenticate

func OPAQUERegistrationComplete

func OPAQUERegistrationComplete(m messages.Base) (messages.Base, error)

OPAQUERegistrationComplete is used to complete OPAQUE user registration and store the encrypted envelope EnvU

func OPAQUERegistrationInit

func OPAQUERegistrationInit(m messages.Base, opaqueServerKey kyber.Scalar) (messages.Base, error)

OPAQUERegistrationInit is used to register an agent leveraging the OPAQUE Password Authenticated Key Exchange (PAKE) protocol

func RemoveAgent

func RemoveAgent(agentID uuid.UUID) error

RemoveAgent deletes the agent object from Agents map by its ID

func ShowInfo

func ShowInfo(agentID uuid.UUID)

ShowInfo lists all of the agent's structure value in a table

func StatusCheckIn

func StatusCheckIn(m messages.Base) (messages.Base, error)

StatusCheckIn is the function that is run when an agent sends a message back to server, checking in for additional instructions

func UpdateInfo

func UpdateInfo(m messages.Base) error

UpdateInfo is used to update an agent's information with the passed in message data

Types

type Job

type Job struct {
	ID      string
	Type    string
	Status  string // Valid Statuses are created, sent, returned //TODO this might not be needed
	Args    []string
	Created time.Time
}

Job is a structure for holding data for single task assigned to a single agent