trestle.oscal.poam

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.poam.LocalDefinitions[LocalDefinitions]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.poam.LocalDefinitions
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.poam.LocalDefinitions href "" "trestle.oscal.poam.LocalDefinitions"
              click trestle.core.base_model.OscalBaseModel href "" "trestle.core.base_model.OscalBaseModel"
              click trestle.core.trestle_base_model.TrestleBaseModel href "" "trestle.core.trestle_base_model.TrestleBaseModel"
            

Allows components, and inventory-items to be defined within the POA&M for circumstances where no OSCAL-based SSP exists, or is not delivered with the POA&M.

45
46
47
48
49
50
51
52
53
54
55
56

class LocalDefinitions(OscalBaseModel):
    """
    Allows components, and inventory-items to be defined within the POA&M for circumstances where no OSCAL-based SSP exists, or is not delivered with the POA&M.
    """

    class Config:
        extra = Extra.forbid

    components: list[common.SystemComponent] | None = Field(None)
    inventory_items: list[common.InventoryItem] | None = Field(None, alias='inventory-items')
    assessment_assets: common.AssessmentAssets | None = Field(None, alias='assessment-assets')
    remarks: str | None = None

50
51

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.poam.Model[Model]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.poam.Model
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.poam.Model href "" "trestle.oscal.poam.Model"
              click trestle.core.base_model.OscalBaseModel href "" "trestle.core.base_model.OscalBaseModel"
              click trestle.core.trestle_base_model.TrestleBaseModel href "" "trestle.core.trestle_base_model.TrestleBaseModel"
            

122
123

class Model(OscalBaseModel):
    plan_of_action_and_milestones: PlanOfActionAndMilestones = Field(..., alias='plan-of-action-and-milestones')

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.poam.Origination[Origination]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.poam.Origination
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.poam.Origination href "" "trestle.oscal.poam.Origination"
              click trestle.core.base_model.OscalBaseModel href "" "trestle.core.base_model.OscalBaseModel"
              click trestle.core.trestle_base_model.TrestleBaseModel href "" "trestle.core.trestle_base_model.TrestleBaseModel"
            

Identifies the source of the finding, such as a tool or person.

59
60
61
62
63
64
65
66
67

class Origination(OscalBaseModel):
    """
    Identifies the source of the finding, such as a tool or person.
    """

    class Config:
        extra = Extra.forbid

    actors: list[common.OriginActor] = Field(...)

64
65

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.poam.PlanOfActionAndMilestones[PlanOfActionAndMilestones]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.poam.PlanOfActionAndMilestones
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.poam.PlanOfActionAndMilestones href "" "trestle.oscal.poam.PlanOfActionAndMilestones"
              click trestle.core.base_model.OscalBaseModel href "" "trestle.core.base_model.OscalBaseModel"
              click trestle.core.trestle_base_model.TrestleBaseModel href "" "trestle.core.trestle_base_model.TrestleBaseModel"
            

A plan of action and milestones which identifies initial and residual risks, deviations, and disposition, such as those required by FedRAMP.

102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

class PlanOfActionAndMilestones(OscalBaseModel):
    """
    A plan of action and milestones which identifies initial and residual risks, deviations, and disposition, such as those required by FedRAMP.
    """

    class Config:
        extra = Extra.forbid

    uuid: constr(regex=r'^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$') = Field(..., description='A machine-oriented, globally unique identifier with instancescope that can be used to reference this POA&M instance in this OSCAL instance. This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.', title='POA&M Universally Unique Identifier')
    metadata: common.Metadata
    import_ssp: common.ImportSsp | None = Field(None, alias='import-ssp')
    system_id: common.SystemId | None = Field(None, alias='system-id')
    local_definitions: LocalDefinitions | None = Field(None, alias='local-definitions')
    observations: list[common.Observation] | None = Field(None)
    risks: list[common.Risk] | None = Field(None)
    findings: list[common.Finding] | None = Field(None)
    poam_items: list[PoamItem] = Field(..., alias='poam-items')
    back_matter: common.BackMatter | None = Field(None, alias='back-matter')

107
108

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.poam.PoamItem[PoamItem]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.poam.PoamItem
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.poam.PoamItem href "" "trestle.oscal.poam.PoamItem"
              click trestle.core.base_model.OscalBaseModel href "" "trestle.core.base_model.OscalBaseModel"
              click trestle.core.trestle_base_model.TrestleBaseModel href "" "trestle.core.trestle_base_model.TrestleBaseModel"
            

Describes an individual POA&M item.

82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

class PoamItem(OscalBaseModel):
    """
    Describes an individual POA&M item.
    """

    class Config:
        extra = Extra.forbid

    uuid: constr(regex=r'^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$') | None = Field(None, description='A machine-oriented, globally unique identifier with instance scope that can be used to reference this POA&M item entry in this OSCAL instance. This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.', title='POA&M Item Universally Unique Identifier')
    title: constr(regex=r'^[^\n]+$') = Field(..., description='The title or name for this POA&M item .', title='POA&M Item Title')
    description: str = Field(..., description='A human-readable description of POA&M item.', title='POA&M Item Description')
    props: list[common.Property] | None = Field(None)
    links: list[common.Link] | None = Field(None)
    related_findings: list[RelatedFinding] | None = Field(None, alias='related-findings')
    related_observations: list[common.RelatedObservation] | None = Field(None, alias='related-observations')
    related_risks: list[common.AssociatedRisk] | None = Field(None, alias='related-risks')
    remarks: str | None = None
    origins: list[Origination] | None = Field(None)

87
88

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.poam.RelatedFinding[RelatedFinding]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.poam.RelatedFinding
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.poam.RelatedFinding href "" "trestle.oscal.poam.RelatedFinding"
              click trestle.core.base_model.OscalBaseModel href "" "trestle.core.base_model.OscalBaseModel"
              click trestle.core.trestle_base_model.TrestleBaseModel href "" "trestle.core.trestle_base_model.TrestleBaseModel"
            

Relates the finding to referenced finding(s).

70
71
72
73
74
75
76
77
78
79

class RelatedFinding(OscalBaseModel):
    """
    Relates the finding to referenced finding(s).
    """

    class Config:
        extra = Extra.forbid

    finding_uuid: constr(regex=r'^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[45][0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$') = Field(..., alias='finding-uuid', description='A machine-oriented identifier reference to a finding defined in the list of findings.', title='Finding Universally Unique Identifier Reference')
    remarks: str | None = None

75
76

class Config:
    extra = Extra.forbid