model

Documentation

Overview

ENGMODEL-OWNER-UNIT: FU-MODEL-LOADER

ENGMODEL-OWNER-UNIT: FU-MODEL-LOADER

Index

• type Actor
• type Allocation
• type ArchitectureDocument
• type AttackVector
• type AuthoredArchitecture
• type Bundle
  • func LoadBundle(architecturePath string) (Bundle, error)
• type CatalogDocument
• type CatalogEntry
• type CatalogGroups
• type ComplianceMapping
• type ComplianceModel
• type ComplianceProfile
• type CompositionModel
• type ContractEntry
• type ContractModel
• type Control
• type ControlEvidence
• type ControlVerification
• type ControlVerificationEvidence
• type DataObject
• type Decision
• type DecisionsDocument
• type DeploymentTarget
• type DesignDocument
  • func LoadDesign(path string) (DesignDocument, error)
• type DesignFunctionalGroup
• type DesignFunctionalUnit
• type DesignModel
• type DesignView
• type Event
• type Expected
• type Flow
• type FlowStep
• type FunctionalGroup
• type FunctionalUnit
• type HardwareInterface
• type HardwareItem
• type InferenceHints
• type Interface
• type LintRun
• type Mapping
• type ModelMeta
• type POAMArtifact
• type POAMItem
• type ReferencedElement
• type Requirement
• type RequirementsDocument
  • func LoadRequirements(path string) (RequirementsDocument, error)
• type Risk
• type RiskEvidence
• type Satisfaction
• type State
• type Subsystem
• type ThreatAssumption
• type ThreatAssumptionEvidence
• type ThreatMitigation
• type ThreatMitigationEvidence
• type ThreatOutOfScope
• type ThreatOutOfScopeEvidence
• type ThreatScenario
• type ThreatScenarioEvidence
• type TrustBoundary
• type View

Types

type Actor

type Actor struct {
	ID          string `yaml:"id"`
	Name        string `yaml:"name"`
	Description string `yaml:"description"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type Allocation

type Allocation struct {
	Requirement string `yaml:"requirement"` // this system's requirement id
	To          string `yaml:"to"`          // subsystem id or hardware item id
	Target      string `yaml:"target"`      // public id within the subsystem (provided contract id)
	Rationale   string `yaml:"rationale"`
}

Allocation binds a parent requirement onto a subsystem's published (provided) identifier. ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type ArchitectureDocument

type ArchitectureDocument struct {
	Model                ModelMeta            `yaml:"model"`
	Decisions            []Decision           `yaml:"-"`
	AuthoredArchitecture AuthoredArchitecture `yaml:"authoredArchitecture"`
	Compliance           ComplianceModel      `yaml:"compliance"`
	Contract             ContractModel        `yaml:"contract"`
	Composition          CompositionModel     `yaml:"composition"`
	InferenceHints       InferenceHints       `yaml:"inferenceHints"`
	Views                []View               `yaml:"views"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type AttackVector

type AttackVector struct {
	ID          string `yaml:"id"`
	Name        string `yaml:"name"`
	Description string `yaml:"description"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, FU-THREAT-EXPORTER

type AuthoredArchitecture

type AuthoredArchitecture struct {
	FunctionalGroups     []FunctionalGroup     `yaml:"functionalGroups"`
	FunctionalUnits      []FunctionalUnit      `yaml:"functionalUnits"`
	Actors               []Actor               `yaml:"actors"`
	AttackVectors        []AttackVector        `yaml:"attackVectors"`
	ReferencedElements   []ReferencedElement   `yaml:"referencedElements"`
	Interfaces           []Interface           `yaml:"interfaces"`
	DataObjects          []DataObject          `yaml:"dataObjects"`
	DeploymentTargets    []DeploymentTarget    `yaml:"deploymentTargets"`
	HardwareItems        []HardwareItem        `yaml:"hardwareItems"`
	HardwareInterfaces   []HardwareInterface   `yaml:"hardwareInterfaces"`
	Controls             []Control             `yaml:"controls"`
	Risks                []Risk                `yaml:"risks"`
	POAMItems            []POAMItem            `yaml:"poamItems"`
	TrustBoundaries      []TrustBoundary       `yaml:"trustBoundaries"`
	States               []State               `yaml:"states"`
	Events               []Event               `yaml:"events"`
	Flows                []Flow                `yaml:"flows"`
	ThreatScenarios      []ThreatScenario      `yaml:"threatScenarios"`
	ThreatAssumptions    []ThreatAssumption    `yaml:"threatAssumptions"`
	ThreatOutOfScope     []ThreatOutOfScope    `yaml:"threatOutOfScope"`
	ThreatMitigations    []ThreatMitigation    `yaml:"threatMitigations"`
	ControlVerifications []ControlVerification `yaml:"controlVerifications"`
	Mappings             []Mapping             `yaml:"mappings"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type Bundle

type Bundle struct {
	ArchitecturePath string
	CatalogPath      string
	DecisionsPath    string

	Architecture ArchitectureDocument
	Catalog      CatalogDocument
	Decisions    DecisionsDocument
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

func LoadBundle

func LoadBundle(architecturePath string) (Bundle, error)

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL TRLC-LINKS: REQ-EMG-001

type CatalogDocument

type CatalogDocument struct {
	Catalog CatalogGroups `yaml:"catalog"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type CatalogEntry

type CatalogEntry struct {
	ID         string   `yaml:"id"`
	Name       string   `yaml:"name"`
	Definition string   `yaml:"definition"`
	Aliases    []string `yaml:"aliases"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL TRLC-LINKS: REQ-EMG-001

type CatalogGroups

type CatalogGroups struct {
	Systems            []CatalogEntry `yaml:"systems"`
	FunctionalGroups   []CatalogEntry `yaml:"functionalGroups"`
	FunctionalUnits    []CatalogEntry `yaml:"functionalUnits"`
	ReferencedElements []CatalogEntry `yaml:"referencedElements"`
	Actors             []CatalogEntry `yaml:"actors"`
	AttackVectors      []CatalogEntry `yaml:"attackVectors"`
	Events             []CatalogEntry `yaml:"events"`
	States             []CatalogEntry `yaml:"states"`
	Features           []CatalogEntry `yaml:"features"`
	Modes              []CatalogEntry `yaml:"modes"`
	Conditions         []CatalogEntry `yaml:"conditions"`
	DataTerms          []CatalogEntry `yaml:"dataTerms"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type ComplianceMapping

type ComplianceMapping struct {
	ID                   string            `yaml:"id"`
	ProfileRef           string            `yaml:"profileRef"`
	ControlIDs           []string          `yaml:"controlIds"`
	ModelControlRef      string            `yaml:"modelControlRef"`
	AppliesTo            []string          `yaml:"appliesTo"`
	ImplementationType   string            `yaml:"implementationType"`
	ImplementationStatus string            `yaml:"implementationStatus"`
	Status               string            `yaml:"status"`
	Narrative            string            `yaml:"narrative"`
	Rationale            string            `yaml:"rationale"`
	Evidence             []ControlEvidence `yaml:"evidence"`
	InheritedFrom        []string          `yaml:"inheritedFrom"`
	ResponsibleRoles     []string          `yaml:"responsibleRoles"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, CTRL-TRACEABILITY-COVERAGE, FU-OSCAL-EXPORTER

type ComplianceModel

type ComplianceModel struct {
	Profiles []ComplianceProfile `yaml:"profiles"`
	Mappings []ComplianceMapping `yaml:"mappings"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, CTRL-TRACEABILITY-COVERAGE, FU-OSCAL-EXPORTER

type ComplianceProfile

type ComplianceProfile struct {
	ID          string `yaml:"id"`
	Href        string `yaml:"href"`
	CatalogHref string `yaml:"catalogHref"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, CTRL-TRACEABILITY-COVERAGE, FU-OSCAL-EXPORTER

type CompositionModel

type CompositionModel struct {
	Subsystems    []Subsystem    `yaml:"subsystems"`
	Allocations   []Allocation   `yaml:"allocations"`
	Satisfactions []Satisfaction `yaml:"satisfactions"`
}

CompositionModel holds parent-only composition data: referenced subsystems and the allocation of this system's requirements onto them. Absent in a leaf system. ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type ContractEntry

type ContractEntry struct {
	ID   string `yaml:"id"`
	Kind string `yaml:"kind"` // interface|capability|assumption
	Ref  string `yaml:"ref"`  // optional local id this contract entry exposes
	Note string `yaml:"note"`
}

ContractEntry is a single provided or required interface/capability/assumption. ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type ContractModel

type ContractModel struct {
	Provides []ContractEntry `yaml:"provides"` // the public surface a parent may allocate onto
	Requires []ContractEntry `yaml:"requires"` // what the system needs from its environment
}

ContractModel is a system's published, parent-agnostic boundary: what it provides and requires. ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type Control

type Control struct {
	ID          string `yaml:"id"`
	Name        string `yaml:"name"`
	Category    string `yaml:"category"`
	Description string `yaml:"description"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, CTRL-TRACEABILITY-COVERAGE

type ControlEvidence

type ControlEvidence struct {
	Path        string `yaml:"path"`
	Description string `yaml:"description"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, CTRL-TRACEABILITY-COVERAGE

type ControlVerification

type ControlVerification struct {
	ID                 string                        `yaml:"id"`
	ControlRef         string                        `yaml:"controlRef"`
	ThreatScenarioRefs []string                      `yaml:"threatScenarioRefs"`
	RiskRefs           []string                      `yaml:"riskRefs"`
	Method             string                        `yaml:"method"`
	Status             string                        `yaml:"status"`
	Owner              string                        `yaml:"owner"`
	LastTested         string                        `yaml:"lastTested"`
	Findings           []string                      `yaml:"findings"`
	Evidence           []ControlVerificationEvidence `yaml:"evidence"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, CTRL-TRACEABILITY-COVERAGE

type ControlVerificationEvidence

type ControlVerificationEvidence struct {
	Path        string `yaml:"path"`
	Description string `yaml:"description"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, CTRL-TRACEABILITY-COVERAGE

type DataObject

type DataObject struct {
	ID              string   `yaml:"id"`
	Name            string   `yaml:"name"`
	TermRef         string   `yaml:"termRef"`
	SchemaRef       string   `yaml:"schemaRef"`
	Sensitivity     string   `yaml:"sensitivity"`
	Classification  string   `yaml:"classification"`
	RegulatoryTags  []string `yaml:"regulatoryTags"`
	Retention       string   `yaml:"retention"`
	Confidentiality string   `yaml:"confidentiality"`
	Integrity       string   `yaml:"integrity"`
	Availability    string   `yaml:"availability"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type Decision

type Decision struct {
	ID           string   `yaml:"id"`
	Title        string   `yaml:"title"`
	Status       string   `yaml:"status"`
	Date         string   `yaml:"date"`
	Context      string   `yaml:"context"`
	Decision     string   `yaml:"decision"`
	Consequences []string `yaml:"consequences"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type DecisionsDocument

type DecisionsDocument struct {
	Decisions []Decision `yaml:"decisions"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type DeploymentTarget

type DeploymentTarget struct {
	ID          string `yaml:"id"`
	Name        string `yaml:"name"`
	Environment string `yaml:"environment"`
	Region      string `yaml:"region"`
	Account     string `yaml:"account"`
	Cluster     string `yaml:"cluster"`
	Namespace   string `yaml:"namespace"`
	TrustZone   string `yaml:"trustZone"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, DEP-LOCAL-WORKSPACE, DEP-CI-PIPELINE

type DesignDocument

type DesignDocument struct {
	Design DesignModel `yaml:"design"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

func LoadDesign

func LoadDesign(path string) (DesignDocument, error)

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL TRLC-LINKS: REQ-EMG-001

type DesignFunctionalGroup

type DesignFunctionalGroup struct {
	ID    string                `yaml:"id"`
	Views map[string]DesignView `yaml:"views"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type DesignFunctionalUnit

type DesignFunctionalUnit struct {
	ID    string                `yaml:"id"`
	Group string                `yaml:"group"`
	Views map[string]DesignView `yaml:"views"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type DesignModel

type DesignModel struct {
	ID               string                  `yaml:"id"`
	Title            string                  `yaml:"title"`
	FunctionalGroups []DesignFunctionalGroup `yaml:"functionalGroups"`
	FunctionalUnits  []DesignFunctionalUnit  `yaml:"functionalUnits"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type DesignView

type DesignView struct {
	Title     string `yaml:"title"`
	Narrative string `yaml:"narrative"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, FU-VIEW-PROJECTION

type Event

type Event struct {
	ID          string `yaml:"id"`
	Name        string `yaml:"name"`
	Description string `yaml:"description"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, EVT-MODEL-UPDATED, EVT-GENERATION-RUN-REQUESTED, EVT-VALIDATION-FAILED, EVT-ARTIFACT-GENERATED

type Expected

type Expected struct {
	ID      string `yaml:"id"`
	Pattern string `yaml:"pattern"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type Flow

type Flow struct {
	ID                  string            `yaml:"id"`
	Title               string            `yaml:"title"`
	Kind                string            `yaml:"kind"`
	Methodology         string            `yaml:"methodology"`
	Direction           string            `yaml:"direction"`
	Frequency           string            `yaml:"frequency"`
	SourceRef           string            `yaml:"sourceRef"`
	DestinationRef      string            `yaml:"destinationRef"`
	Protocol            string            `yaml:"protocol"`
	Channel             string            `yaml:"channel"`
	Authentication      string            `yaml:"authentication"`
	EncryptionInTransit string            `yaml:"encryptionInTransit"`
	IntegrityProtection string            `yaml:"integrityProtection"`
	DataRefs            []string          `yaml:"dataRefs"`
	Description         string            `yaml:"description"`
	Criticality         string            `yaml:"criticality"`
	Threats             []string          `yaml:"threats"`
	Entry               []string          `yaml:"entry"`
	Exits               []string          `yaml:"exits"`
	Steps               []FlowStep        `yaml:"steps"`
	Properties          map[string]string `yaml:"properties"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type FlowStep

type FlowStep struct {
	ID                  string   `yaml:"id"`
	Ref                 string   `yaml:"ref"`
	Kind                string   `yaml:"kind"`
	FlowType            string   `yaml:"flowType"`
	Direction           string   `yaml:"direction"`
	Frequency           string   `yaml:"frequency"`
	SourceRef           string   `yaml:"sourceRef"`
	DestinationRef      string   `yaml:"destinationRef"`
	Action              string   `yaml:"action"`
	Channel             string   `yaml:"channel"`
	Protocol            string   `yaml:"protocol"`
	DataIn              []string `yaml:"dataIn"`
	DataOut             []string `yaml:"dataOut"`
	DataRefs            []string `yaml:"dataRefs"`
	InterfaceRef        string   `yaml:"interfaceRef"`
	TrustBoundaryRef    string   `yaml:"trustBoundaryRef"`
	BoundaryCrossing    bool     `yaml:"boundaryCrossing"`
	Authentication      string   `yaml:"authentication"`
	EncryptionInTransit string   `yaml:"encryptionInTransit"`
	IntegrityProtection string   `yaml:"integrityProtection"`
	Next                []string `yaml:"next"`
	OnError             []string `yaml:"onError"`
	Async               bool     `yaml:"async"`
	Optional            bool     `yaml:"optional"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type FunctionalGroup

type FunctionalGroup struct {
	ID          string   `yaml:"id"`
	Name        string   `yaml:"name"`
	Description string   `yaml:"description"`
	Prose       string   `yaml:"prose"`
	Tags        []string `yaml:"tags"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type FunctionalUnit

type FunctionalUnit struct {
	ID    string   `yaml:"id"`
	Name  string   `yaml:"name"`
	Group string   `yaml:"group"`
	Tags  []string `yaml:"tags"`
	Prose string   `yaml:"prose"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type HardwareInterface

type HardwareInterface struct {
	ID                   string `yaml:"id"`
	Name                 string `yaml:"name"`
	BusType              string `yaml:"busType"` // ARINC429|CAN|SPI|I2C|ethernet|cellular|discrete|analog
	From                 string `yaml:"from"`    // hardware item id
	To                   string `yaml:"to"`      // hardware item id
	Direction            string `yaml:"direction"`
	SoftwareInterfaceRef string `yaml:"softwareInterfaceRef"`
	Description          string `yaml:"description"`
}

HardwareInterface represents a physical connection between hardware items (ICD/IRS data). ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type HardwareItem

type HardwareItem struct {
	ID          string   `yaml:"id"`
	Name        string   `yaml:"name"`
	Kind        string   `yaml:"kind"` // processor|board|lru|sensor|actuator|bus|fpga|gateway|cloud
	PartNumber  string   `yaml:"partNumber"`
	Supplier    string   `yaml:"supplier"`
	SafetyLevel string   `yaml:"safetyLevel"` // DO-254 design assurance level (optional)
	Description string   `yaml:"description"`
	Hosts       []string `yaml:"hosts"` // functional unit or subsystem ids hosted on this item
}

HardwareItem represents a physical platform element (the DO-254 side of the HW/SW boundary). ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type InferenceHints

type InferenceHints struct {
	RuntimeSources           []string `yaml:"runtimeSources"`
	CodeSources              []string `yaml:"codeSources"`
	ExpectedRuntimeKinds     []string `yaml:"expectedRuntimeKinds"`
	OwnershipResolutionOrder []string `yaml:"ownershipResolutionOrder"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, FU-CODEMAP-INFERENCE, CTRL-TRACEABILITY-COVERAGE, DEP-LOCAL-WORKSPACE

type Interface

type Interface struct {
	ID        string `yaml:"id"`
	Name      string `yaml:"name"`
	Protocol  string `yaml:"protocol"`
	Endpoint  string `yaml:"endpoint"`
	SchemaRef string `yaml:"schemaRef"`
	Owner     string `yaml:"owner"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type LintRun

type LintRun struct {
	ID         string `yaml:"id"`
	Mode       string `yaml:"mode"`
	CommaAsAnd bool   `yaml:"commaAsAnd"`
	CatalogRef string `yaml:"catalogRef"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, FU-VALIDATION-ENGINE, CTRL-TRACEABILITY-COVERAGE, STATE-MODEL-INVALID, EVT-VALIDATION-FAILED

type Mapping

type Mapping struct {
	Type        string `yaml:"type"`
	From        string `yaml:"from"`
	To          string `yaml:"to"`
	Description string `yaml:"description"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type ModelMeta

type ModelMeta struct {
	ID             string `yaml:"id"`
	Title          string `yaml:"title"`
	Introduction   string `yaml:"introduction"`
	BaseCatalogRef string `yaml:"baseCatalogRef"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type POAMArtifact

type POAMArtifact struct {
	Path        string `yaml:"path"`
	Description string `yaml:"description"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type POAMItem

type POAMItem struct {
	ID              string         `yaml:"id"`
	RiskRef         string         `yaml:"riskRef"`
	Milestone       string         `yaml:"milestone"`
	DueDate         string         `yaml:"dueDate"`
	Status          string         `yaml:"status"`
	ResponsibleRole string         `yaml:"responsibleRole"`
	Artifacts       []POAMArtifact `yaml:"artifacts"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, FU-THREAT-EXPORTER

type ReferencedElement

type ReferencedElement struct {
	ID    string `yaml:"id"`
	Kind  string `yaml:"kind"`
	Layer string `yaml:"layer"`
	Name  string `yaml:"name"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type Requirement

type Requirement struct {
	ID        string   `yaml:"id"`
	Text      string   `yaml:"text"`
	Notes     string   `yaml:"notes"`
	AppliesTo []string `yaml:"appliesTo"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type RequirementsDocument

type RequirementsDocument struct {
	LintRun      LintRun       `yaml:"lintRun"`
	Requirements []Requirement `yaml:"requirements"`
	Expected     []Expected    `yaml:"expected"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

func LoadRequirements

func LoadRequirements(path string) (RequirementsDocument, error)

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL TRLC-LINKS: REQ-EMG-001

type Risk

type Risk struct {
	ID              string         `yaml:"id"`
	Title           string         `yaml:"title"`
	Statement       string         `yaml:"statement"`
	Status          string         `yaml:"status"`
	Likelihood      string         `yaml:"likelihood"`
	Impact          string         `yaml:"impact"`
	Response        string         `yaml:"response"`
	Owner           string         `yaml:"owner"`
	AppliesTo       []string       `yaml:"appliesTo"`
	RelatedControls []string       `yaml:"relatedControls"`
	AttackVectors   []string       `yaml:"attackVectors"`
	ThreatScenarios []string       `yaml:"threatScenarios"`
	Evidence        []RiskEvidence `yaml:"evidence"`
	ResidualRisk    string         `yaml:"residualRisk"`
	Rationale       string         `yaml:"rationale"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, FU-THREAT-EXPORTER

type RiskEvidence

type RiskEvidence struct {
	Path        string `yaml:"path"`
	Description string `yaml:"description"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, FU-THREAT-EXPORTER

type Satisfaction

type Satisfaction struct {
	Need string `yaml:"need"` // subsystem-qualified required id (SUBSYS/needId)
	By   string `yaml:"by"`   // provider: subsystem-qualified provided id or hardware item id
}

Satisfaction records how a subsystem's required interface is satisfied by a provider. ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type State

type State struct {
	ID          string `yaml:"id"`
	Name        string `yaml:"name"`
	Description string `yaml:"description"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, STATE-MODEL-VALID, STATE-MODEL-INVALID, STATE-ARTIFACTS-FRESH

type Subsystem

type Subsystem struct {
	ID          string `yaml:"id"`
	Name        string `yaml:"name"`
	Ref         string `yaml:"ref"`  // local subdirectory path to the child model
	Git         string `yaml:"git"`  // external git repository URL; cloned into .engmod/subsystems/<id>
	Rev         string `yaml:"rev"`  // optional branch, tag, or commit to check out after clone
	Path        string `yaml:"path"` // optional subdirectory within the repository containing the model
	Description string `yaml:"description"`
}

Subsystem is a downward reference to a child system model, resolved either from a local subdirectory (ref) or an external git repository (git) cloned into .engmod. ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL

type ThreatAssumption

type ThreatAssumption struct {
	ID        string                     `yaml:"id"`
	Title     string                     `yaml:"title"`
	Statement string                     `yaml:"statement"`
	Status    string                     `yaml:"status"`
	Owner     string                     `yaml:"owner"`
	AppliesTo []string                   `yaml:"appliesTo"`
	Rationale string                     `yaml:"rationale"`
	Evidence  []ThreatAssumptionEvidence `yaml:"evidence"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, FU-THREAT-EXPORTER

type ThreatAssumptionEvidence

type ThreatAssumptionEvidence struct {
	Path        string `yaml:"path"`
	Description string `yaml:"description"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, FU-THREAT-EXPORTER

type ThreatMitigation

type ThreatMitigation struct {
	ID                string                     `yaml:"id"`
	ThreatScenarioRef string                     `yaml:"threatScenarioRef"`
	ControlRef        string                     `yaml:"controlRef"`
	Status            string                     `yaml:"status"`
	Effectiveness     string                     `yaml:"effectiveness"`
	Owner             string                     `yaml:"owner"`
	Notes             string                     `yaml:"notes"`
	VerificationRefs  []string                   `yaml:"verificationRefs"`
	Evidence          []ThreatMitigationEvidence `yaml:"evidence"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, FU-THREAT-EXPORTER, CTRL-TRACEABILITY-COVERAGE

type ThreatMitigationEvidence

type ThreatMitigationEvidence struct {
	Path        string `yaml:"path"`
	Description string `yaml:"description"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, FU-THREAT-EXPORTER

type ThreatOutOfScope

type ThreatOutOfScope struct {
	ID        string                     `yaml:"id"`
	Title     string                     `yaml:"title"`
	Reason    string                     `yaml:"reason"`
	Status    string                     `yaml:"status"`
	Owner     string                     `yaml:"owner"`
	AppliesTo []string                   `yaml:"appliesTo"`
	ExpiresOn string                     `yaml:"expiresOn"`
	Evidence  []ThreatOutOfScopeEvidence `yaml:"evidence"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, FU-THREAT-EXPORTER

type ThreatOutOfScopeEvidence

type ThreatOutOfScopeEvidence struct {
	Path        string `yaml:"path"`
	Description string `yaml:"description"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, FU-THREAT-EXPORTER

type ThreatScenario

type ThreatScenario struct {
	ID               string                   `yaml:"id"`
	Title            string                   `yaml:"title"`
	Summary          string                   `yaml:"summary"`
	Category         string                   `yaml:"category"`
	Stride           string                   `yaml:"stride"`
	CWE              []string                 `yaml:"cwe"`
	AttackVectorRef  string                   `yaml:"attackVectorRef"`
	AppliesTo        []string                 `yaml:"appliesTo"`
	FlowRefs         []string                 `yaml:"flowRefs"`
	EntryPoint       string                   `yaml:"entryPoint"`
	Preconditions    []string                 `yaml:"preconditions"`
	ExploitPath      []string                 `yaml:"exploitPath"`
	Likelihood       string                   `yaml:"likelihood"`
	Impact           string                   `yaml:"impact"`
	Severity         string                   `yaml:"severity"`
	Status           string                   `yaml:"status"`
	Owner            string                   `yaml:"owner"`
	RiskRef          string                   `yaml:"riskRef"`
	RelatedControls  []string                 `yaml:"relatedControls"`
	AssumptionRefs   []string                 `yaml:"assumptionRefs"`
	OutOfScopeRefs   []string                 `yaml:"outOfScopeRefs"`
	MitigationRefs   []string                 `yaml:"mitigationRefs"`
	VerificationRefs []string                 `yaml:"verificationRefs"`
	Detection        []string                 `yaml:"detection"`
	Evidence         []ThreatScenarioEvidence `yaml:"evidence"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, FU-THREAT-EXPORTER

type ThreatScenarioEvidence

type ThreatScenarioEvidence struct {
	Path        string `yaml:"path"`
	Description string `yaml:"description"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, FU-THREAT-EXPORTER

type TrustBoundary

type TrustBoundary struct {
	ID           string   `yaml:"id"`
	Name         string   `yaml:"name"`
	Description  string   `yaml:"description"`
	BoundaryType string   `yaml:"boundaryType"`
	ParentRef    string   `yaml:"parentRef"`
	Members      []string `yaml:"members"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, TB-REPO-WORKSPACE, TB-EXTERNAL-VALIDATION-TOOLS

type View

type View struct {
	ID                        string   `yaml:"id"`
	Kind                      string   `yaml:"kind"`
	Roots                     []string `yaml:"roots"`
	AuthoredStatus            string   `yaml:"authoredStatus"`
	AuthoredStatusExplanation string   `yaml:"authoredStatusExplanation"`
	IncludeKinds              []string `yaml:"includeKinds"`
	ExcludeKinds              []string `yaml:"excludeKinds"`
	IncludeMappings           []string `yaml:"includeMappings"`
	ExcludeMappings           []string `yaml:"excludeMappings"`
	MaxDepth                  int      `yaml:"maxDepth"`
	Audience                  string   `yaml:"audience"`
	Abstraction               string   `yaml:"abstraction"`
}

ENGMODEL-LINKS: FU-MODEL-LOADER, DO-ARCHITECTURE-MODEL, FU-VIEW-PROJECTION