layer4

type ApplyFunc func(interface{}) (interface{}, error)

type Assessment struct {
	// RequirementId is the unique identifier for the requirement being tested.
	RequirementId string `json:"requirement-id" yaml:"requirement-id"`

	// Procedures defines possible testing procedures to evaluate the requirement.
	Procedures []AssessmentProcedure `json:"procedures" yaml:"procedures"`
}

type AssessmentLog struct {
	// RequirementID is the unique identifier for the requirement being tested
	RequirementId string `yaml:"requirement-id"`
	// ProcedureId uniquely identifies the assessment procedure associated with the log
	ProcedureId string `json:"procedure-id,omitempty"`
	// Applicability is a slice of identifier strings to determine when this test is applicable
	Applicability []string `yaml:"applicability"`
	// Description is a human-readable description of the test
	Description string `yaml:"description"`
	// Result is true if the test passed
	Result Result `yaml:"result"`
	// Message is the human-readable result of the test
	Message string `yaml:"message"`
	// Steps is a slice of steps that were executed during the test
	Steps []AssessmentStep `yaml:"steps"`
	// StepsExecuted is the number of steps that were executed during the test
	StepsExecuted int `yaml:"steps-executed,omitempty"`
	// Start is the time the assessment run began.
	Start string `yaml:"start"`
	// End is the time the assessment run finished.
	// This is omitted if the assessment was interrupted or did not complete.
	End string `yaml:"end,omitempty"`
	// Value is the object that was returned during the test
	Value interface{} `yaml:"value,omitempty"`
	// Changes is a slice of changes that were made during the test
	Changes map[string]*Change `yaml:"changes,omitempty"`
	// Recommendation is a string to aid users in remediation, such as the text from a layer 2 assessment requirement
	Recommendation string `yaml:"recommendation,omitempty"`
}

type AssessmentPlan struct {
	ControlId string `json:"control-id" yaml:"control-id"`

	Assessments []Assessment `json:"assessments" yaml:"assessments"`
}

type AssessmentProcedure struct {
	// Id uniquely identifies the assessment procedure being executed
	Id string `json:"id" yaml:"id"`

	// Name provides a summary of the procedure
	Name string `json:"name" yaml:"name"`

	// Description provides a detailed explanation of the procedure
	Description string `json:"description" yaml:"description"`

	// Documentation provides a URL to documentation that describes how the assessment procedure evaluates the control requirement
	Documentation string `json:"documentation,omitempty" yaml:"documentation,omitempty"`
}

type AssessmentStep func(payload interface{}, c map[string]*Change) (Result, string)

type Change struct {
	// TargetName is the name or ID of the resource or configuration that is to be changed
	TargetName string `yaml:"target-name"`
	// Description is a human-readable description of the change
	Description string `yaml:"description"`

	// TargetObject is supplemental data describing the object that was changed
	TargetObject interface{} `yaml:"target-object,omitempty"`
	// Applied is true if the change was successfully applied at least once
	Applied bool `yaml:"applied,omitempty"`
	// Reverted is true if the change was successfully reverted and not applied again
	Reverted bool `yaml:"reverted,omitempty"`
	// Error is used if any error occurred during the change
	Error error `yaml:"error,omitempty"`
	// Allowed may be disabled to prevent the change from being applied
	Allowed bool `yaml:"allowed,omitempty"`
	// contains filtered or unexported fields
}

type Contact struct {
	// The contact person's name.
	Name string `json:"name" yaml:"name"`

	// Indicates whether this admin is the first point of contact for inquiries. Only one entry should be marked as primary.
	Primary bool `json:"primary" yaml:"primary"`

	// The entity with which the contact is affiliated, such as a school or employer.
	Affiliation *string `json:"affiliation,omitempty" yaml:"affiliation,omitempty"`

	// A preferred email address to reach the contact.
	Email *string `json:"email,omitempty" yaml:"email,omitempty"`

	// A social media handle or profile for the contact.
	Social *string `json:"social,omitempty" yaml:"social,omitempty"`
}

type ControlEvaluation struct {
	// Name is the name of the control being evaluated
	Name string `yaml:"name"`
	// ControlID is the unique identifier for the control being evaluated
	ControlID string `yaml:"control-id"`
	// Result is the overall result of the control evaluation
	Result Result `yaml:"result"`
	// Message is the human-readable result of the final assessment to run in this evaluation
	Message string `yaml:"message"`
	// CorruptedState is true if the control evaluation was interrupted and changes were not reverted
	CorruptedState bool `yaml:"corrupted-state"`
	// AssessmentLogs is a map of pointers to AssessmentLog objects to establish idempotency
	AssessmentLogs []*AssessmentLog `yaml:"assessmentlogs"`
}

type EvaluationPlan struct {
	Metadata Metadata `json:"metadata" yaml:"metadata"`

	Plans []AssessmentPlan `json:"plans" yaml:"plans"`
}

type Metadata struct {
	Id string `json:"id" yaml:"id"`

	Version string `json:"version,omitempty" yaml:"version,omitempty"`

	Author Contact `json:"author" yaml:"author"`
}

type Result int

type RevertFunc func(interface{}) error