trestle.oscal.assessment_results

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.assessment_results.AssessmentLog[AssessmentLog]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.assessment_results.AssessmentLog
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.assessment_results.AssessmentLog href "" "trestle.oscal.assessment_results.AssessmentLog"
              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 log of all assessment-related actions taken.

123
124
125
126
127
128
129
130
131

class AssessmentLog(OscalBaseModel):
    """
    A log of all assessment-related actions taken.
    """

    class Config:
        extra = Extra.forbid

    entries: list[Entry1] = Field(...)

128
129

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.assessment_results.AssessmentResults[AssessmentResults]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.assessment_results.AssessmentResults
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.assessment_results.AssessmentResults href "" "trestle.oscal.assessment_results.AssessmentResults"
              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"
            

Security assessment results, such as those provided by a FedRAMP assessor in the FedRAMP Security Assessment Report.

163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

class AssessmentResults(OscalBaseModel):
    """
    Security assessment results, such as those provided by a FedRAMP assessor in the FedRAMP Security Assessment Report.
    """

    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 cross-instance scope that can be used to reference this assessment results instance in this or other OSCAL instances. The locally defined UUID of the assessment result can be used to reference the data item locally or globally (e.g., in an imported 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='Assessment Results Universally Unique Identifier',
    )
    metadata: common.Metadata
    import_ap: ImportAp = Field(..., alias='import-ap')
    local_definitions: LocalDefinitions | None = Field(None, alias='local-definitions', description='Used to define data objects that are used in the assessment plan, that do not appear in the referenced SSP.', title='Local Definitions')
    results: list[Result] = Field(...)
    back_matter: common.BackMatter | None = Field(None, alias='back-matter')

168
169

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.assessment_results.Attestation[Attestation]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.assessment_results.Attestation
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.assessment_results.Attestation href "" "trestle.oscal.assessment_results.Attestation"
              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 set of textual statements, typically written by the assessor.

47
48
49
50
51
52
53
54
55
56

class Attestation(OscalBaseModel):
    """
    A set of textual statements, typically written by the assessor.
    """

    class Config:
        extra = Extra.forbid

    responsible_parties: list[common.ResponsibleParty] | None = Field(None, alias='responsible-parties')
    parts: list[common.AssessmentPart] = Field(...)

52
53

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.assessment_results.Entry1[Entry1]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.assessment_results.Entry1
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.assessment_results.Entry1 href "" "trestle.oscal.assessment_results.Entry1"
              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 result of an action and/or task that occurred as part of executing an assessment plan or an assessment event that occurred in producing the assessment results.

59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

class Entry1(OscalBaseModel):
    """
    Identifies the result of an action and/or task that occurred as part of executing an assessment plan or an assessment event that occurred in producing the assessment results.
    """

    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 cross-instance scope that can be used to reference an assessment event in this or other OSCAL instances. The locally defined UUID of the assessment log entry can be used to reference the data item locally or globally (e.g., in an imported 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='Assessment Log Entry Universally Unique Identifier',
    )
    title: constr(regex=r'^[^\n]+$') | None = Field(None, description='The title for this event.', title='Action Title')
    description: str | None = Field(None, description='A human-readable description of this event.', title='Action Description')
    start: datetime = Field(..., description='Identifies the start date and time of an event.', title='Start')
    end: datetime | None = Field(None, description='Identifies the end date and time of an event. If the event is a point in time, the start and end will be the same date and time.', title='End')
    props: list[common.Property] | None = Field(None)
    links: list[common.Link] | None = Field(None)
    logged_by: list[common.LoggedBy] | None = Field(None, alias='logged-by')
    related_tasks: list[common.RelatedTask] | None = Field(None, alias='related-tasks')
    remarks: str | None = None

64
65

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.assessment_results.ImportAp[ImportAp]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.assessment_results.ImportAp
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.assessment_results.ImportAp href "" "trestle.oscal.assessment_results.ImportAp"
              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"
            

Used by assessment-results to import information about the original plan for assessing the system.

83
84
85
86
87
88
89
90
91
92

class ImportAp(OscalBaseModel):
    """
    Used by assessment-results to import information about the original plan for assessing the system.
    """

    class Config:
        extra = Extra.forbid

    href: str = Field(..., description='A resolvable URL reference to the assessment plan governing the assessment activities.', title='Assessment Plan Reference')
    remarks: str | None = None

88
89

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

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

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



              click trestle.oscal.assessment_results.LocalDefinitions href "" "trestle.oscal.assessment_results.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"
            

Used to define data objects that are used in the assessment plan, that do not appear in the referenced SSP.

 95
 96
 97
 98
 99
100
101
102
103
104
105

class LocalDefinitions(OscalBaseModel):
    """
    Used to define data objects that are used in the assessment plan, that do not appear in the referenced SSP.
    """

    class Config:
        extra = Extra.forbid

    objectives_and_methods: list[common.LocalObjective] | None = Field(None, alias='objectives-and-methods')
    activities: list[common.Activity] | None = Field(None)
    remarks: str | None = None

100
101

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.assessment_results.LocalDefinitions1[LocalDefinitions1]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.assessment_results.LocalDefinitions1
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.assessment_results.LocalDefinitions1 href "" "trestle.oscal.assessment_results.LocalDefinitions1"
              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"
            

Used to define data objects that are used in the assessment plan, that do not appear in the referenced SSP.

108
109
110
111
112
113
114
115
116
117
118
119
120

class LocalDefinitions1(OscalBaseModel):
    """
    Used to define data objects that are used in the assessment plan, that do not appear in the referenced SSP.
    """

    class Config:
        extra = Extra.forbid

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

113
114

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

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

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



              click trestle.oscal.assessment_results.Model href "" "trestle.oscal.assessment_results.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"
            

183
184

class Model(OscalBaseModel):
    assessment_results: AssessmentResults = Field(..., alias='assessment-results')

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.assessment_results.Result[Result]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.assessment_results.Result
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.assessment_results.Result href "" "trestle.oscal.assessment_results.Result"
              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"
            

Used by the assessment results and POA&M. In the assessment results, this identifies all of the assessment observations and findings, initial and residual risks, deviations, and disposition. In the POA&M, this identifies initial and residual risks, deviations, and disposition.

134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

class Result(OscalBaseModel):
    """
    Used by the assessment results and POA&M. In the assessment results, this identifies all of the assessment observations and findings, initial and residual risks, deviations, and disposition. In the POA&M, this identifies initial and residual risks, deviations, and disposition.
    """

    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 cross-instance scope that can be used to reference this set of results in this or other OSCAL instances. The locally defined UUID of the assessment result can be used to reference the data item locally or globally (e.g., in an imported 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='Results Universally Unique Identifier',
    )
    title: constr(regex=r'^[^\n]+$') = Field(..., description='The title for this set of results.', title='Results Title')
    description: str = Field(..., description='A human-readable description of this set of test results.', title='Results Description')
    start: datetime = Field(..., description='Date/time stamp identifying the start of the evidence collection reflected in these results.', title='start field')
    end: datetime | None = Field(None, description='Date/time stamp identifying the end of the evidence collection reflected in these results. In a continuous motoring scenario, this may contain the same value as start if appropriate.', title='end field')
    props: list[common.Property] | None = Field(None)
    links: list[common.Link] | None = Field(None)
    local_definitions: LocalDefinitions1 | None = Field(None, alias='local-definitions', description='Used to define data objects that are used in the assessment plan, that do not appear in the referenced SSP.', title='Local Definitions')
    reviewed_controls: common.ReviewedControls = Field(..., alias='reviewed-controls')
    attestations: list[Attestation] | None = Field(None)
    assessment_log: AssessmentLog | None = Field(None, alias='assessment-log', description='A log of all assessment-related actions taken.', title='Assessment Log')
    observations: list[common.Observation] | None = Field(None)
    risks: list[common.Risk] | None = Field(None)
    findings: list[common.Finding] | None = Field(None)
    remarks: str | None = None

139
140

class Config:
    extra = Extra.forbid