trestle.oscal.common

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.Action[Action]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.Action
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.Action href "" "trestle.oscal.common.Action"
              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"
            

An action applied by a role within a given party to the content.

1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157

class Action(OscalBaseModel):
    """
    An action applied by a role within a given party to the content.
    """

    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 unique identifier that can be used to reference this defined action elsewhere in an OSCAL document. A UUID should be consistently used for a given location across revisions of the document.', title='Action Universally Unique Identifier')
    date: datetime | None = Field(None, description='The date and time when the action occurred.', title='Action Occurrence Date')
    type: constr(regex=r'^[_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD][_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\-\.0-9\u00B7\u0300-\u036F\u203F-\u2040]*$') = Field(..., description='The type of action documented by the assembly, such as an approval.', title='Action Type')
    system: AnyUrl = Field(..., description='Specifies the action type system used.', title='Action Type System')
    props: list[Property] | None = Field(None)
    links: list[Link] | None = Field(None)
    responsible_parties: list[ResponsibleParty] | None = Field(None, alias='responsible-parties')
    remarks: str | None = None

1147
1148

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.Activity[Activity]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.Activity
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.Activity href "" "trestle.oscal.common.Activity"
              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 an assessment or related process that can be performed. In the assessment plan, this is an intended activity which may be associated with an assessment task. In the assessment results, this an activity that was actually performed as part of an assessment.

1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531

class Activity(OscalBaseModel):
    """
    Identifies an assessment or related process that can be performed. In the assessment plan, this is an intended activity which may be associated with an assessment task. In the assessment results, this an activity that was actually performed as part of an assessment.
    """

    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 activity elsewhere in this or other OSCAL instances. The locally defined UUID of the activity 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 Activity Universally Unique Identifier',
    )
    title: constr(regex=r'^[^\n]+$') | None = Field(None, description='The title for this included activity.', title='Included Activity Title')
    description: str = Field(..., description='A human-readable description of this included activity.', title='Included Activity Description')
    props: list[Property] | None = Field(None)
    links: list[Link] | None = Field(None)
    steps: list[Step] | None = Field(None)
    related_controls: ReviewedControls | None = Field(None, alias='related-controls')
    responsible_roles: list[ResponsibleRole] | None = Field(None, alias='responsible-roles')
    remarks: str | None = None

1516
1517

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.AddrLine[AddrLine]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.AddrLine
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.AddrLine href "" "trestle.oscal.common.AddrLine"
              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"
            

586
587

class AddrLine(OscalBaseModel):
    __root__: StringDatatype = Field(..., description='A single line of an address.', title='Address line')

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.Address[Address]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.Address
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.Address href "" "trestle.oscal.common.Address"
              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 postal address for the location.

590
591
592
593
594
595
596
597
598
599
600
601
602
603

class Address(OscalBaseModel):
    """
    A postal address for the location.
    """

    class Config:
        extra = Extra.forbid

    type: TokenDatatype | AddressTypeValidValues | None = Field(None, description='Indicates the type of address.', title='Address Type')
    addr_lines: list[constr(regex=r'^\S(.*\S)?$')] | None = Field(None, alias='addr-lines')
    city: constr(regex=r'^\S(.*\S)?$') | None = Field(None, description='City, town or geographical region for the mailing address.', title='City')
    state: constr(regex=r'^\S(.*\S)?$') | None = Field(None, description='State, province or analogous geographical region for a mailing address.', title='State')
    postal_code: constr(regex=r'^\S(.*\S)?$') | None = Field(None, alias='postal-code', description='Postal or ZIP code for mailing address.', title='Postal Code')
    country: constr(regex=r'^\S(.*\S)?$') | None = Field(None, description='The ISO 3166-1 alpha-2 country code for the mailing address.', title='Country Code')

595
596

class Config:
    extra = Extra.forbid

Bases: Enum

              flowchart TD
              trestle.oscal.common.AddressTypeValidValues[AddressTypeValidValues]

              

              click trestle.oscal.common.AddressTypeValidValues href "" "trestle.oscal.common.AddressTypeValidValues"
            

39
40
41

class AddressTypeValidValues(Enum):
    home = 'home'
    work = 'work'

Bases: Enum

              flowchart TD
              trestle.oscal.common.Algorithm[Algorithm]

              

              click trestle.oscal.common.Algorithm href "" "trestle.oscal.common.Algorithm"
            

The digest method by which a hash is derived.

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

class Algorithm(Enum):
    """
    The digest method by which a hash is derived.
    """

    SHA_224 = 'SHA-224'
    SHA_256 = 'SHA-256'
    SHA_384 = 'SHA-384'
    SHA_512 = 'SHA-512'
    SHA3_224 = 'SHA3-224'
    SHA3_256 = 'SHA3-256'
    SHA3_384 = 'SHA3-384'
    SHA3_512 = 'SHA3-512'

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.AssessmentAssets[AssessmentAssets]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.AssessmentAssets
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.AssessmentAssets href "" "trestle.oscal.common.AssessmentAssets"
              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 assets used to perform this assessment, such as the assessment team, scanning tools, and assumptions.

1949
1950
1951
1952
1953
1954
1955
1956
1957
1958

class AssessmentAssets(OscalBaseModel):
    """
    Identifies the assets used to perform this assessment, such as the assessment team, scanning tools, and assumptions.
    """

    class Config:
        extra = Extra.forbid

    components: list[SystemComponent] | None = Field(None)
    assessment_platforms: list[AssessmentPlatform] = Field(..., alias='assessment-platforms')

1954
1955

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.AssessmentPart[AssessmentPart]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.AssessmentPart
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.AssessmentPart href "" "trestle.oscal.common.AssessmentPart"
              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 partition of an assessment plan or results or a child of another part.

804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822

class AssessmentPart(OscalBaseModel):
    """
    A partition of an assessment plan or results or a child of another part.
    """

    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 cross-instance scope that can be used to reference this part elsewhere in this or other OSCAL instances. The locally defined UUID of the part can be used to reference the data item locally or globally (e.g., in an ported 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='Part Identifier'
    )
    name: constr(regex=r'^[_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD][_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\-\.0-9\u00B7\u0300-\u036F\u203F-\u2040]*$') | Name = Field(..., description="A textual label that uniquely identifies the part's semantic type.", title='Part Name')
    ns: AnyUrl | None = Field(None, description="A namespace qualifying the part's name. This allows different organizations to associate distinct semantics with the same name.", title='Part Namespace')
    class_: constr(regex=r'^[_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD][_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\-\.0-9\u00B7\u0300-\u036F\u203F-\u2040]*$') | None = Field(None, alias='class', description="A textual label that provides a sub-type or characterization of the part's name. This can be used to further distinguish or discriminate between the semantics of multiple parts of the same control with the same name and ns.", title='Part Class')
    title: constr(regex=r'^[^\n]+$') | None = Field(None, description='A name given to the part, which may be used by a tool for display and navigation.', title='Part Title')
    props: list[Property] | None = Field(None)
    prose: str | None = Field(None, description='Permits multiple paragraphs, lists, tables etc.', title='Part Text')
    parts: list[AssessmentPart] | None = None
    links: list[Link] | None = Field(None)

809
810

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.AssessmentPlatform[AssessmentPlatform]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.AssessmentPlatform
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.AssessmentPlatform href "" "trestle.oscal.common.AssessmentPlatform"
              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 represent the toolset used to perform aspects of the assessment.

1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946

class AssessmentPlatform(OscalBaseModel):
    """
    Used to represent the toolset used to perform aspects of the assessment.
    """

    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 platform elsewhere in this or other OSCAL instances. The locally defined UUID of the assessment platform 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 Platform Universally Unique Identifier',
    )
    title: constr(regex=r'^[^\n]+$') | None = Field(None, description='The title or name for the assessment platform.', title='Assessment Platform Title')
    props: list[Property] | None = Field(None)
    links: list[Link] | None = Field(None)
    uses_components: list[UsesComponent] | None = Field(None, alias='uses-components')
    remarks: str | None = None

1934
1935

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.AssessmentSubject[AssessmentSubject]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.AssessmentSubject
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.AssessmentSubject href "" "trestle.oscal.common.AssessmentSubject"
              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"
            

1326
1327

class AssessmentSubject(OscalBaseModel):
    __root__: AssessmentSubjectAll | AssessmentSubjectSpecific

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.AssessmentSubjectAll[AssessmentSubjectAll]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.AssessmentSubjectAll
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.AssessmentSubjectAll href "" "trestle.oscal.common.AssessmentSubjectAll"
              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 system elements being assessed, such as components, inventory items, and locations. In the assessment plan, this identifies a planned assessment subject. In the assessment results this is an actual assessment subject, and reflects any changes from the plan. exactly what will be the focus of this assessment. Any subjects not identified in this way are out-of-scope.

1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323

class AssessmentSubjectAll(OscalBaseModel):
    """
    Identifies system elements being assessed, such as components, inventory items, and locations. In the assessment plan, this identifies a planned assessment subject. In the assessment results this is an actual assessment subject, and reflects any changes from the plan. exactly what will be the focus of this assessment. Any subjects not identified in this way are out-of-scope.
    """

    class Config:
        extra = Extra.forbid

    type: constr(regex=r'^[_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD][_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\-\.0-9\u00B7\u0300-\u036F\u203F-\u2040]*$') | Type | None = Field(None, description='Indicates the type of assessment subject, such as a component, inventory, item, location, or party represented by this selection statement.', title='Subject Type')
    description: str | None = Field(None, description='A human-readable description of the collection of subjects being included in this assessment.', title='Include Subjects Description')
    props: list[Property] | None = Field(None)
    links: list[Link] | None = Field(None)
    include_all: IncludeAll = Field(..., alias='include-all')
    exclude_subjects: list[SelectSubjectById] | None = Field(None, alias='exclude-subjects')
    remarks: str | None = None

1314
1315

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.AssessmentSubjectPlaceholder[AssessmentSubjectPlaceholder]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.AssessmentSubjectPlaceholder
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.AssessmentSubjectPlaceholder href "" "trestle.oscal.common.AssessmentSubjectPlaceholder"
              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 when the assessment subjects will be determined as part of one or more other assessment activities. These assessment subjects will be recorded in the assessment results in the assessment log.

784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801

class AssessmentSubjectPlaceholder(OscalBaseModel):
    """
    Used when the assessment subjects will be determined as part of one or more other assessment activities. These assessment subjects will be recorded in the assessment results in the assessment log.
    """

    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 for a set of assessment subjects that will be identified by a task or an activity that is part of a task. The locally defined UUID of the assessment subject placeholder 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 Subject Placeholder Universally Unique Identifier',
    )
    description: str | None = Field(None, description='A human-readable description of intent of this assessment subject placeholder.', title='Assessment Subject Placeholder Description')
    sources: list[Source] = Field(...)
    props: list[Property] | None = Field(None)
    links: list[Link] | None = Field(None)
    remarks: str | None = None

789
790

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.AssessmentSubjectSpecific[AssessmentSubjectSpecific]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.AssessmentSubjectSpecific
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.AssessmentSubjectSpecific href "" "trestle.oscal.common.AssessmentSubjectSpecific"
              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 system elements being assessed, such as components, inventory items, and locations. In the assessment plan, this identifies a planned assessment subject. In the assessment results this is an actual assessment subject, and reflects any changes from the plan. exactly what will be the focus of this assessment. Any subjects not identified in this way are out-of-scope.

1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306

class AssessmentSubjectSpecific(OscalBaseModel):
    """
    Identifies system elements being assessed, such as components, inventory items, and locations. In the assessment plan, this identifies a planned assessment subject. In the assessment results this is an actual assessment subject, and reflects any changes from the plan. exactly what will be the focus of this assessment. Any subjects not identified in this way are out-of-scope.
    """

    class Config:
        extra = Extra.forbid

    type: constr(regex=r'^[_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD][_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\-\.0-9\u00B7\u0300-\u036F\u203F-\u2040]*$') | Type | None = Field(None, description='Indicates the type of assessment subject, such as a component, inventory, item, location, or party represented by this selection statement.', title='Subject Type')
    description: str | None = Field(None, description='A human-readable description of the collection of subjects being included in this assessment.', title='Include Subjects Description')
    props: list[Property] | None = Field(None)
    links: list[Link] | None = Field(None)
    include_subjects: list[SelectSubjectById] = Field(..., alias='include-subjects')
    exclude_subjects: list[SelectSubjectById] | None = Field(None, alias='exclude-subjects')
    remarks: str | None = None

1297
1298

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.AssociatedActivity[AssociatedActivity]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.AssociatedActivity
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.AssociatedActivity href "" "trestle.oscal.common.AssociatedActivity"
              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 an individual activity to be performed as part of a task.

1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474

class AssociatedActivity(OscalBaseModel):
    """
    Identifies an individual activity to be performed as part of a task.
    """

    class Config:
        extra = Extra.forbid

    activity_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='activity-uuid', description='A machine-oriented identifier reference to an activity defined in the list of activities.', title='Activity Universally Unique Identifier Reference')
    props: list[Property] | None = Field(None)
    links: list[Link] | None = Field(None)
    responsible_roles: list[ResponsibleRole] | None = Field(None, alias='responsible-roles')
    subjects: list[AssessmentSubject] = Field(...)
    remarks: str | None = None

1466
1467

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.AssociatedRisk[AssociatedRisk]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.AssociatedRisk
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.AssociatedRisk href "" "trestle.oscal.common.AssociatedRisk"
              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 a set of referenced risks that were used to determine the finding.

59
60
61
62
63
64
65
66
67
68

class AssociatedRisk(OscalBaseModel):
    """
    Relates the finding to a set of referenced risks that were used to determine the finding.
    """

    class Config:
        extra = Extra.forbid

    risk_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='risk-uuid', description='A machine-oriented identifier reference to a risk defined in the list of risks.', title='Risk Universally Unique Identifier Reference')
    remarks: str | None = None

64
65

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.AtFrequency[AtFrequency]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.AtFrequency
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.AtFrequency href "" "trestle.oscal.common.AtFrequency"
              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"
            

The task is intended to occur at the specified frequency.

71
72
73
74
75
76
77
78
79
80
81

class AtFrequency(OscalBaseModel):
    """
    The task is intended to occur at the specified frequency.
    """

    class Config:
        extra = Extra.forbid

    period: conint(ge=1, multiple_of=1) = Field(..., description='The task must occur after the specified period has elapsed.', title='Period')
    unit: constr(regex=r'^\S(.*\S)?$') = Field(..., description='The unit of time for the period.', title='Time Unit')
    remarks: str | None = None

76
77

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.AuthorizedPrivilege[AuthorizedPrivilege]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.AuthorizedPrivilege
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.AuthorizedPrivilege href "" "trestle.oscal.common.AuthorizedPrivilege"
              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 a specific system privilege held by the user, along with an associated description and/or rationale for the privilege.

84
85
86
87
88
89
90
91
92
93
94

class AuthorizedPrivilege(OscalBaseModel):
    """
    Identifies a specific system privilege held by the user, along with an associated description and/or rationale for the privilege.
    """

    class Config:
        extra = Extra.forbid

    title: constr(regex=r'^[^\n]+$') = Field(..., description='A human readable name for the privilege.', title='Privilege Title')
    description: str | None = Field(None, description="A summary of the privilege's purpose within the system.", title='Privilege Description')
    functions_performed: list[constr(regex=r'^\S(.*\S)?$')] = Field(..., alias='functions-performed')

89
90

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.BackMatter[BackMatter]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.BackMatter
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.BackMatter href "" "trestle.oscal.common.BackMatter"
              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 collection of resources that may be referenced from within the OSCAL document instance.

1245
1246
1247
1248
1249
1250
1251
1252
1253

class BackMatter(OscalBaseModel):
    """
    A collection of resources that may be referenced from within the OSCAL document instance.
    """

    class Config:
        extra = Extra.forbid

    resources: list[Resource] | None = Field(None)

1250
1251

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.Base64[Base64]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.Base64
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.Base64 href "" "trestle.oscal.common.Base64"
              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 resource encoded using the Base64 alphabet defined by RFC 2045.

 97
 98
 99
100
101
102
103
104
105
106
107

class Base64(OscalBaseModel):
    """
    A resource encoded using the Base64 alphabet defined by RFC 2045.
    """

    class Config:
        extra = Extra.forbid

    filename: constr(regex=r'^[_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD][_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\-\.0-9\u00B7\u0300-\u036F\u203F-\u2040]*$') | None = Field(None, description='Name of the file before it was encoded as Base64 to be embedded in a resource. This is the name that will be assigned to the file when the file is decoded.', title='File Name')
    media_type: constr(regex=r'^\S(.*\S)?$') | None = Field(None, alias='media-type', description='A label that indicates the nature of a resource, as a data serialization or format.', title='Media Type')
    value: constr(regex=r'^[0-9A-Za-z+/]+={0,2}$')

102
103

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.Base64Datatype[Base64Datatype]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.Base64Datatype
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.Base64Datatype href "" "trestle.oscal.common.Base64Datatype"
              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"
            

110
111

class Base64Datatype(OscalBaseModel):
    __root__: constr(regex=r'^[0-9A-Za-z+/]+={0,2}$') = Field(..., description='Binary data encoded using the Base 64 encoding algorithm as defined by RFC4648.')

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.Characterization[Characterization]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.Characterization
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.Characterization href "" "trestle.oscal.common.Characterization"
              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 collection of descriptive data about the containing object from a specific origin.

1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407

class Characterization(OscalBaseModel):
    """
    A collection of descriptive data about the containing object from a specific origin.
    """

    class Config:
        extra = Extra.forbid

    props: list[Property] | None = Field(None)
    links: list[Link] | None = Field(None)
    origin: Origin
    facets: list[Facet] = Field(...)

1401
1402

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.Citation[Citation]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.Citation
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.Citation href "" "trestle.oscal.common.Citation"
              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"
            

An optional citation consisting of end note text using structured markup.

771
772
773
774
775
776
777
778
779
780
781

class Citation(OscalBaseModel):
    """
    An optional citation consisting of end note text using structured markup.
    """

    class Config:
        extra = Extra.forbid

    text: constr(regex=r'^[^\n]+$') = Field(..., description='A line of citation text.', title='Citation Text')
    props: list[Property] | None = Field(None)
    links: list[Link] | None = Field(None)

776
777

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.ControlObjectiveSelections[ControlObjectiveSelections]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.ControlObjectiveSelections
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.ControlObjectiveSelections href "" "trestle.oscal.common.ControlObjectiveSelections"
              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 control objectives of the assessment. In the assessment plan, these are the planned objectives. In the assessment results, these are the assessed objectives, and reflects any changes from the plan.

755
756
757
758
759
760
761
762
763
764
765
766
767
768

class ControlObjectiveSelections(OscalBaseModel):
    """
    Identifies the control objectives of the assessment. In the assessment plan, these are the planned objectives. In the assessment results, these are the assessed objectives, and reflects any changes from the plan.
    """

    class Config:
        extra = Extra.forbid

    description: str | None = Field(None, description='A human-readable description of this collection of control objectives.', title='Control Objectives Description')
    props: list[Property] | None = Field(None)
    links: list[Link] | None = Field(None)
    include_objectives: list[SelectObjectiveById] = Field(..., alias='include-objectives')
    exclude_objectives: list[SelectObjectiveById] | None = Field(None, alias='exclude-objectives')
    remarks: str | None = None

760
761

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.ControlObjectiveSelectionsAll[ControlObjectiveSelectionsAll]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.ControlObjectiveSelectionsAll
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.ControlObjectiveSelectionsAll href "" "trestle.oscal.common.ControlObjectiveSelectionsAll"
              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 control objectives of the assessment. In the assessment plan, these are the planned objectives. In the assessment results, these are the assessed objectives, and reflects any changes from the plan.

734
735
736
737
738
739
740
741
742
743
744
745
746
747

class ControlObjectiveSelectionsAll(OscalBaseModel):
    """
    Identifies the control objectives of the assessment. In the assessment plan, these are the planned objectives. In the assessment results, these are the assessed objectives, and reflects any changes from the plan.
    """

    class Config:
        extra = Extra.forbid

    description: str | None = Field(None, description='A human-readable description of this collection of control objectives.', title='Control Objectives Description')
    props: list[Property] | None = Field(None)
    links: list[Link] | None = Field(None)
    include_all: IncludeAll = Field(..., alias='include-all')
    exclude_objectives: list[SelectObjectiveById] | None = Field(None, alias='exclude-objectives')
    remarks: str | None = None

739
740

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.ControlSelections[ControlSelections]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.ControlSelections
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.ControlSelections href "" "trestle.oscal.common.ControlSelections"
              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 controls being assessed. In the assessment plan, these are the planned controls. In the assessment results, these are the actual controls, and reflects any changes from the plan.

718
719
720
721
722
723
724
725
726
727
728
729
730
731

class ControlSelections(OscalBaseModel):
    """
    Identifies the controls being assessed. In the assessment plan, these are the planned controls. In the assessment results, these are the actual controls, and reflects any changes from the plan.
    """

    class Config:
        extra = Extra.forbid

    description: str | None = Field(None, description='A human-readable description of in-scope controls specified for assessment.', title='Assessed Controls Description')
    props: list[Property] | None = Field(None)
    links: list[Link] | None = Field(None)
    include_controls: list[SelectControlById] = Field(..., alias='include-controls')
    exclude_controls: list[SelectControlById] | None = Field(None, alias='exclude-controls')
    remarks: str | None = None

723
724

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.ControlSelectionsAll[ControlSelectionsAll]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.ControlSelectionsAll
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.ControlSelectionsAll href "" "trestle.oscal.common.ControlSelectionsAll"
              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 controls being assessed. In the assessment plan, these are the planned controls. In the assessment results, these are the actual controls, and reflects any changes from the plan.

697
698
699
700
701
702
703
704
705
706
707
708
709
710

class ControlSelectionsAll(OscalBaseModel):
    """
    Identifies the controls being assessed. In the assessment plan, these are the planned controls. In the assessment results, these are the actual controls, and reflects any changes from the plan.
    """

    class Config:
        extra = Extra.forbid

    description: str | None = Field(None, description='A human-readable description of in-scope controls specified for assessment.', title='Assessed Controls Description')
    props: list[Property] | None = Field(None)
    links: list[Link] | None = Field(None)
    include_all: IncludeAll = Field(..., alias='include-all')
    exclude_controls: list[SelectControlById] | None = Field(None, alias='exclude-controls')
    remarks: str | None = None

702
703

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.DateTimeWithTimezoneDatatype[DateTimeWithTimezoneDatatype]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.DateTimeWithTimezoneDatatype
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.DateTimeWithTimezoneDatatype href "" "trestle.oscal.common.DateTimeWithTimezoneDatatype"
              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"
            

114
115

class DateTimeWithTimezoneDatatype(OscalBaseModel):
    __root__: datetime = Field(..., description='A string representing a point in time with a required timezone.')

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.Dependency[Dependency]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.Dependency
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.Dependency href "" "trestle.oscal.common.Dependency"
              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 indicate that a task is dependent on another task.

118
119
120
121
122
123
124
125
126
127

class Dependency(OscalBaseModel):
    """
    Used to indicate that a task is dependent on another task.
    """

    class Config:
        extra = Extra.forbid

    task_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='task-uuid', description='A machine-oriented identifier reference to a unique task.', title='Task Universally Unique Identifier Reference')
    remarks: str | None = None

123
124

class Config:
    extra = Extra.forbid

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.DocumentId[DocumentId]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.DocumentId
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.DocumentId href "" "trestle.oscal.common.DocumentId"
              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 document identifier qualified by an identifier scheme.

606
607
608
609
610
611
612
613
614
615

class DocumentId(OscalBaseModel):
    """
    A document identifier qualified by an identifier scheme.
    """

    class Config:
        extra = Extra.forbid

    scheme: URIDatatype | DocumentSchemeValidValues | None = Field(None, description='Qualifies the kind of document identifier using a URI. If the scheme is not provided the value of the element will be interpreted as a string of characters.', title='Document Identification Scheme')
    identifier: constr(regex=r'^\S(.*\S)?$')

611
612

class Config:
    extra = Extra.forbid

Bases: Enum

              flowchart TD
              trestle.oscal.common.DocumentSchemeValidValues[DocumentSchemeValidValues]

              

              click trestle.oscal.common.DocumentSchemeValidValues href "" "trestle.oscal.common.DocumentSchemeValidValues"
            

130
131

class DocumentSchemeValidValues(Enum):
    http___www_doi_org_ = 'http://www.doi.org/'

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.EmailAddress[EmailAddress]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.EmailAddress
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.EmailAddress href "" "trestle.oscal.common.EmailAddress"
              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"
            

134
135

class EmailAddress(OscalBaseModel):
    __root__: EmailStr = Field(..., description='An email address as defined by RFC 5322 Section 3.4.1.', title='Email Address')

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.EmailAddressDatatype[EmailAddressDatatype]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.EmailAddressDatatype
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.EmailAddressDatatype href "" "trestle.oscal.common.EmailAddressDatatype"
              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"
            

138
139

class EmailAddressDatatype(OscalBaseModel):
    __root__: EmailStr = Field(..., description='An email address string formatted according to RFC 6531.')

Bases: OscalBaseModel

              flowchart TD
              trestle.oscal.common.Entry[Entry]
              trestle.core.base_model.OscalBaseModel[OscalBaseModel]
              trestle.core.trestle_base_model.TrestleBaseModel[TrestleBaseModel]

                              trestle.core.base_model.OscalBaseModel --> trestle.oscal.common.Entry
                                trestle.core.trestle_base_model.TrestleBaseModel --> trestle.core.base_model.OscalBaseModel
                



              click trestle.oscal.common.Entry href "" "trestle.oscal.common.Entry"
              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 an individual risk response that occurred as part of managing an identified risk.

1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447

class Entry(OscalBaseModel):
    """
    Identifies an individual risk response that occurred as part of managing an identified risk.
    """

    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 risk log entry elsewhere in this or other OSCAL instances. The locally defined UUID of the risk 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='Risk Log Entry Universally Unique Identifier',
    )
    title: constr(regex=r'^[^\n]+$') | None = Field(None, description='The title for this risk log entry.', title='Title')
    description: str | None = Field(None, description='A human-readable description of what was done regarding the risk.', title='Risk Task Description')
    start: datetime = Field(..., description='Identifies the start date and time of the event.', title='Start')
    end: datetime | None = Field(None, description='Identifies the end date and time of the event. If the event is a point in time, the start and end will be the same date and time.', title='End')
    props: list[Property] | None = Field(None)
    links: list[Link] | None = Field(None)
    logged_by: list[LoggedBy] | None = Field(None, alias='logged-by')
    status_change: RiskStatus | None = Field(None, alias='status-change')
    related_responses: list[RelatedResponse] | None = Field(None, alias='related-responses')
    remarks: str | None = None