trestle.oscal.common
trestle.oscal.common
¤
Attributes¤
HowMany = HowManyValidValues
module-attribute
¤
Classes¤
Action
¤
Bases: OscalBaseModel
An action applied by a role within a given party to the content.
Source code in trestle/oscal/common.py
2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 |
|
Attributes¤
date = Field(None, description='The date and time when the action occurred.', title='Action Occurrence Date')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
responsible_parties = Field(None, alias='responsible-parties')
class-attribute
instance-attribute
¤
system = Field(..., description='Specifies the action type system used.', title='Action Type System')
class-attribute
instance-attribute
¤
type = Field(..., description='The type of action documented by the assembly, such as an approval.', title='Action Type')
class-attribute
instance-attribute
¤
uuid = 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')
class-attribute
instance-attribute
¤
Classes¤
Activity
¤
Bases: 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.
Source code in trestle/oscal/common.py
2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 |
|
Attributes¤
description = Field(..., description='A human-readable description of this included activity.', title='Included Activity Description')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
related_controls = Field(None, alias='related-controls')
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
responsible_roles = Field(None, alias='responsible-roles')
class-attribute
instance-attribute
¤
steps = Field(None)
class-attribute
instance-attribute
¤
title = Field(None, description='The title for this included activity.', title='Included Activity Title')
class-attribute
instance-attribute
¤
uuid = 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')
class-attribute
instance-attribute
¤
Classes¤
AddrLine
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
1143 1144 |
|
Address
¤
Bases: OscalBaseModel
A postal address for the location.
Source code in trestle/oscal/common.py
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 |
|
Attributes¤
addr_lines = Field(None, alias='addr-lines')
class-attribute
instance-attribute
¤
city = Field(None, description='City, town or geographical region for the mailing address.', title='City')
class-attribute
instance-attribute
¤
country = Field(None, description='The ISO 3166-1 alpha-2 country code for the mailing address.', title='Country Code')
class-attribute
instance-attribute
¤
postal_code = Field(None, alias='postal-code', description='Postal or ZIP code for mailing address.', title='Postal Code')
class-attribute
instance-attribute
¤
state = Field(None, description='State, province or analogous geographical region for a mailing address.', title='State')
class-attribute
instance-attribute
¤
type = Field(None, description='Indicates the type of address.', title='Address Type')
class-attribute
instance-attribute
¤
Classes¤
AddressTypeValidValues
¤
Algorithm
¤
Bases: Enum
The digest method by which a hash is derived.
Source code in trestle/oscal/common.py
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 |
|
Attributes¤
SHA3_224 = 'SHA3-224'
class-attribute
instance-attribute
¤
SHA3_256 = 'SHA3-256'
class-attribute
instance-attribute
¤
SHA3_384 = 'SHA3-384'
class-attribute
instance-attribute
¤
SHA3_512 = 'SHA3-512'
class-attribute
instance-attribute
¤
SHA_224 = 'SHA-224'
class-attribute
instance-attribute
¤
SHA_256 = 'SHA-256'
class-attribute
instance-attribute
¤
SHA_384 = 'SHA-384'
class-attribute
instance-attribute
¤
SHA_512 = 'SHA-512'
class-attribute
instance-attribute
¤
AssessmentAssets
¤
Bases: OscalBaseModel
Identifies the assets used to perform this assessment, such as the assessment team, scanning tools, and assumptions.
Source code in trestle/oscal/common.py
2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 |
|
AssessmentPart
¤
Bases: OscalBaseModel
A partition of an assessment plan or results or a child of another part.
Source code in trestle/oscal/common.py
1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 |
|
Attributes¤
class_ = 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')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
name = Field(..., description="A textual label that uniquely identifies the part's semantic type.", title='Part Name')
class-attribute
instance-attribute
¤
ns = 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-attribute
instance-attribute
¤
parts = None
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
prose = Field(None, description='Permits multiple paragraphs, lists, tables etc.', title='Part Text')
class-attribute
instance-attribute
¤
title = Field(None, description='A name given to the part, which may be used by a tool for display and navigation.', title='Part Title')
class-attribute
instance-attribute
¤
uuid = 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')
class-attribute
instance-attribute
¤
Classes¤
AssessmentPlatform
¤
Bases: OscalBaseModel
Used to represent the toolset used to perform aspects of the assessment.
Source code in trestle/oscal/common.py
2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 |
|
Attributes¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
title = Field(None, description='The title or name for the assessment platform.', title='Assessment Platform Title')
class-attribute
instance-attribute
¤
uses_components = Field(None, alias='uses-components')
class-attribute
instance-attribute
¤
uuid = 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')
class-attribute
instance-attribute
¤
Classes¤
AssessmentSubject
¤
Bases: 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.
Source code in trestle/oscal/common.py
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 |
|
Attributes¤
description = Field(None, description='A human-readable description of the collection of subjects being included in this assessment.', title='Include Subjects Description')
class-attribute
instance-attribute
¤
exclude_subjects = Field(None, alias='exclude-subjects')
class-attribute
instance-attribute
¤
include_all = Field(None, alias='include-all')
class-attribute
instance-attribute
¤
include_subjects = Field(None, alias='include-subjects')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
type = Field(..., description='Indicates the type of assessment subject, such as a component, inventory, item, location, or party represented by this selection statement.', title='Subject Type')
class-attribute
instance-attribute
¤
Classes¤
AssessmentSubjectPlaceholder
¤
Bases: 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.
Source code in trestle/oscal/common.py
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 |
|
Attributes¤
description = Field(None, description='A human-readable description of intent of this assessment subject placeholder.', title='Assessment Subject Placeholder Description')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
sources = Field(...)
class-attribute
instance-attribute
¤
uuid = 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')
class-attribute
instance-attribute
¤
Classes¤
AssessmentSubjectValidValues
¤
Bases: Enum
Source code in trestle/oscal/common.py
1010 1011 1012 1013 1014 1015 |
|
Attributes¤
component = 'component'
class-attribute
instance-attribute
¤
inventory_item = 'inventory-item'
class-attribute
instance-attribute
¤
location = 'location'
class-attribute
instance-attribute
¤
party = 'party'
class-attribute
instance-attribute
¤
user = 'user'
class-attribute
instance-attribute
¤
AssociatedActivity
¤
Bases: OscalBaseModel
Identifies an individual activity to be performed as part of a task.
Source code in trestle/oscal/common.py
2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 |
|
Attributes¤
activity_uuid = 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')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
responsible_roles = Field(None, alias='responsible-roles')
class-attribute
instance-attribute
¤
subjects = Field(...)
class-attribute
instance-attribute
¤
Classes¤
AtFrequency
¤
Bases: OscalBaseModel
The task is intended to occur at the specified frequency.
Source code in trestle/oscal/common.py
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 |
|
AuthorizedPrivilege
¤
Bases: OscalBaseModel
Identifies a specific system privilege held by the user, along with an associated description and/or rationale for the privilege.
Source code in trestle/oscal/common.py
981 982 983 984 985 986 987 988 989 990 991 992 993 |
|
Attributes¤
description = Field(None, description="A summary of the privilege's purpose within the system.", title='Privilege Description')
class-attribute
instance-attribute
¤
functions_performed = Field(..., alias='functions-performed')
class-attribute
instance-attribute
¤
title = Field(..., description='A human readable name for the privilege.', title='Privilege Title')
class-attribute
instance-attribute
¤
Classes¤
BackMatter
¤
Bases: OscalBaseModel
A collection of resources that may be referenced from within the OSCAL document instance.
Source code in trestle/oscal/common.py
2051 2052 2053 2054 2055 2056 2057 2058 2059 |
|
Base64
¤
Bases: OscalBaseModel
A resource encoded using the Base64 alphabet defined by RFC 2045.
Source code in trestle/oscal/common.py
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 |
|
Attributes¤
filename = 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')
class-attribute
instance-attribute
¤
media_type = Field(None, alias='media-type', description='A label that indicates the nature of a resource, as a data serialization or format.', title='Media Type')
class-attribute
instance-attribute
¤
value
instance-attribute
¤
Classes¤
Base64Datatype
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
949 950 951 952 |
|
Characterization
¤
Bases: OscalBaseModel
A collection of descriptive data about the containing object from a specific origin.
Source code in trestle/oscal/common.py
2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 |
|
Citation
¤
Bases: OscalBaseModel
An optional citation consisting of end note text using structured markup.
Source code in trestle/oscal/common.py
936 937 938 939 940 941 942 943 944 945 946 |
|
ControlObjectiveSelection
¤
Bases: 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.
Source code in trestle/oscal/common.py
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 |
|
Attributes¤
description = Field(None, description='A human-readable description of this collection of control objectives.', title='Control Objectives Description')
class-attribute
instance-attribute
¤
exclude_objectives = Field(None, alias='exclude-objectives')
class-attribute
instance-attribute
¤
include_all = Field(None, alias='include-all')
class-attribute
instance-attribute
¤
include_objectives = Field(None, alias='include-objectives')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
Classes¤
ControlSelection
¤
Bases: 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.
Source code in trestle/oscal/common.py
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 |
|
Attributes¤
description = Field(None, description='A human-readable description of in-scope controls specified for assessment.', title='Assessed Controls Description')
class-attribute
instance-attribute
¤
exclude_controls = Field(None, alias='exclude-controls')
class-attribute
instance-attribute
¤
include_all = Field(None, alias='include-all')
class-attribute
instance-attribute
¤
include_controls = Field(None, alias='include-controls')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
Classes¤
DateTimeWithTimezoneDatatype
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
890 891 |
|
Dependency
¤
Bases: OscalBaseModel
Used to indicate that a task is dependent on another task.
Source code in trestle/oscal/common.py
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 |
|
DocumentId
¤
Bases: OscalBaseModel
A document identifier qualified by an identifier scheme.
Source code in trestle/oscal/common.py
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 |
|
Attributes¤
identifier
instance-attribute
¤
scheme = 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')
class-attribute
instance-attribute
¤
Classes¤
DocumentSchemeValidValues
¤
EmailAddress
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
844 845 846 847 |
|
EmailAddressDatatype
¤
Bases: OscalBaseModel
An email address string formatted according to RFC 6531.
Source code in trestle/oscal/common.py
838 839 840 841 |
|
Entry
¤
Bases: OscalBaseModel
Identifies an individual risk response that occurred as part of managing an identified risk.
Source code in trestle/oscal/common.py
2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 |
|
Attributes¤
description = Field(None, description='A human-readable description of what was done regarding the risk.', title='Risk Task Description')
class-attribute
instance-attribute
¤
end = 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')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
logged_by = Field(None, alias='logged-by')
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
related_responses = Field(None, alias='related-responses')
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
start = Field(..., description='Identifies the start date and time of the event.', title='Start')
class-attribute
instance-attribute
¤
status_change = Field(None, alias='status-change')
class-attribute
instance-attribute
¤
title = Field(None, description='The title for this risk log entry.', title='Title')
class-attribute
instance-attribute
¤
uuid = 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')
class-attribute
instance-attribute
¤
Classes¤
ExternalId
¤
Bases: OscalBaseModel
An identifier for a person or organization using a designated scheme. e.g. an Open Researcher and Contributor ID (ORCID).
Source code in trestle/oscal/common.py
824 825 826 827 828 829 830 831 832 833 834 835 |
|
ExternalSchemeValidValues
¤
Facet
¤
Bases: OscalBaseModel
An individual characteristic that is part of a larger set produced by the same actor.
Source code in trestle/oscal/common.py
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 |
|
Attributes¤
links = Field(None)
class-attribute
instance-attribute
¤
name = Field(..., description='The name of the risk metric within the specified system.', title='Facet Name')
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
system = Field(..., description='Specifies the naming system under which this risk metric is organized, which allows for the same names to be used in different systems controlled by different parties. This avoids the potential of a name clash.', title='Naming System')
class-attribute
instance-attribute
¤
value = Field(..., description='Indicates the value of the facet.', title='Facet Value')
class-attribute
instance-attribute
¤
Classes¤
Finding
¤
Bases: OscalBaseModel
Describes an individual finding.
Source code in trestle/oscal/common.py
2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 |
|
Attributes¤
description = Field(..., description='A human-readable description of this finding.', title='Finding Description')
class-attribute
instance-attribute
¤
implementation_statement_uuid = Field(None, alias='implementation-statement-uuid', description='A machine-oriented identifier reference to the implementation statement in the SSP to which this finding is related.', title='Implementation Statement UUID')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
origins = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
related_observations = Field(None, alias='related-observations')
class-attribute
instance-attribute
¤
related_risks = Field(None, alias='related-risks')
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
target
instance-attribute
¤
title = Field(..., description='The title for this finding.', title='Finding Title')
class-attribute
instance-attribute
¤
uuid = Field(..., description='A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this finding in this or other OSCAL instances. The locally defined UUID of the finding 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='Finding Universally Unique Identifier')
class-attribute
instance-attribute
¤
Classes¤
FindingTarget
¤
Bases: OscalBaseModel
Captures an assessor's conclusions regarding the degree to which an objective is satisfied.
Source code in trestle/oscal/common.py
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 |
|
Attributes¤
description = Field(None, description="A human-readable description of the assessor's conclusions regarding the degree to which an objective is satisfied.", title='Objective Status Description')
class-attribute
instance-attribute
¤
implementation_status = Field(None, alias='implementation-status')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
status = Field(None, description='A determination of if the objective is satisfied or not within a given system.', title='Objective Status')
class-attribute
instance-attribute
¤
target_id = Field(..., alias='target-id', description='A machine-oriented identifier reference for a specific target qualified by the type.', title='Finding Target Identifier Reference')
class-attribute
instance-attribute
¤
title = Field(None, description='The title for this objective status.', title='Objective Status Title')
class-attribute
instance-attribute
¤
type = Field(..., description='Identifies the type of the target.', title='Finding Target Type')
class-attribute
instance-attribute
¤
Classes¤
FindingTargetTypeValidValues
¤
Bases: Enum
Source code in trestle/oscal/common.py
750 751 752 |
|
FunctionPerformed
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
742 743 744 745 746 747 |
|
Hash
¤
Bases: OscalBaseModel
A representation of a cryptographic digest generated over a resource using a specified hash algorithm.
Source code in trestle/oscal/common.py
1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 |
|
HowManyValidValues
¤
IdentifiedSubject
¤
Bases: OscalBaseModel
Used to detail assessment subjects that were identfied by this task.
Source code in trestle/oscal/common.py
1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 |
|
Attributes¤
subject_placeholder_uuid = Field(..., alias='subject-placeholder-uuid', description='A machine-oriented identifier reference to a unique assessment subject placeholder defined by this task.', title='Assessment Subject Placeholder Universally Unique Identifier Reference')
class-attribute
instance-attribute
¤
subjects = Field(...)
class-attribute
instance-attribute
¤
Classes¤
IdentifierType
¤
Bases: Enum
Identifies the identification system from which the provided identifier was assigned.
Source code in trestle/oscal/common.py
723 724 725 726 727 728 729 730 731 |
|
Attributes¤
http___fedramp_gov_ns_oscal = 'http://fedramp.gov/ns/oscal'
class-attribute
instance-attribute
¤
http___ietf_org_rfc_rfc4122 = 'http://ietf.org/rfc/rfc4122'
class-attribute
instance-attribute
¤
https___fedramp_gov = 'https://fedramp.gov'
class-attribute
instance-attribute
¤
https___ietf_org_rfc_rfc4122 = 'https://ietf.org/rfc/rfc4122'
class-attribute
instance-attribute
¤
ImplementationStatus
¤
Bases: OscalBaseModel
Indicates the degree to which the a given control is implemented.
Source code in trestle/oscal/common.py
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 |
|
ImplementedComponent
¤
Bases: OscalBaseModel
The set of components that are implemented in a given system inventory item.
Source code in trestle/oscal/common.py
1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 |
|
Attributes¤
component_uuid = Field(..., alias='component-uuid', description='A machine-oriented identifier reference to a component that is implemented as part of an inventory item.', title='Component Universally Unique Identifier Reference')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
responsible_parties = Field(None, alias='responsible-parties')
class-attribute
instance-attribute
¤
Classes¤
ImportSsp
¤
Bases: OscalBaseModel
Used by the assessment plan and POA&M to import information about the system.
Source code in trestle/oscal/common.py
687 688 689 690 691 692 693 694 695 696 697 698 699 700 |
|
IncludeAll
¤
Bases: OscalBaseModel
Include all controls from the imported catalog or profile resources.
Source code in trestle/oscal/common.py
678 679 680 681 682 683 684 |
|
IntegerDatatype
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
674 675 |
|
InventoryItem
¤
Bases: OscalBaseModel
A single managed inventory item within the system.
Source code in trestle/oscal/common.py
1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 |
|
Attributes¤
description = Field(..., description='A summary of the inventory item stating its purpose within the system.', title='Inventory Item Description')
class-attribute
instance-attribute
¤
implemented_components = Field(None, alias='implemented-components')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
responsible_parties = Field(None, alias='responsible-parties')
class-attribute
instance-attribute
¤
uuid = Field(..., description='A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this inventory item elsewhere in this or other OSCAL instances. The locally defined UUID of the inventory item 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='Inventory Item Universally Unique Identifier')
class-attribute
instance-attribute
¤
Classes¤
JsonSchemaDirective
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
666 667 668 669 670 671 |
|
LastModified
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
1864 1865 1866 1867 1868 1869 |
|
Lifecycle
¤
Bases: Enum
Identifies whether this is a recommendation, such as from an assessor or tool, or an actual plan accepted by the system owner.
Source code in trestle/oscal/common.py
656 657 658 659 660 661 662 663 |
|
Link
¤
Bases: OscalBaseModel
A reference to a local or remote resource, that has a specific relation to the containing object.
Source code in trestle/oscal/common.py
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 |
|
Attributes¤
href = Field(..., description='A resolvable URL reference to a resource.', title='Hypertext Reference')
class-attribute
instance-attribute
¤
media_type = Field(None, alias='media-type', description='A label that indicates the nature of a resource, as a data serialization or format.', title='Media Type')
class-attribute
instance-attribute
¤
rel = Field(None, description="Describes the type of relationship provided by the link's hypertext reference. This can be an indicator of the link's purpose.", title='Link Relation Type')
class-attribute
instance-attribute
¤
resource_fragment = Field(None, alias='resource-fragment', description='In case where the href points to a back-matter/resource, this value will indicate the URI fragment to append to any rlink associated with the resource. This value MUST be URI encoded.', title='Resource Fragment')
class-attribute
instance-attribute
¤
text = Field(None, description='A textual label to associate with the link, which may be used for presentation in a tool.', title='Link Text')
class-attribute
instance-attribute
¤
Classes¤
LocalObjective
¤
Bases: OscalBaseModel
A local definition of a control objective for this assessment. Uses catalog syntax for control objective and assessment actions.
Source code in trestle/oscal/common.py
1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 |
|
Attributes¤
control_id = Field(..., alias='control-id', description='A reference to a control with a corresponding id value. When referencing an externally defined control, the Control Identifier Reference must be used in the context of the external / imported OSCAL instance (e.g., uri-reference).', title='Control Identifier Reference')
class-attribute
instance-attribute
¤
description = Field(None, description='A human-readable description of this control objective.', title='Objective Description')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
parts = Field(...)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
Classes¤
Location
¤
Bases: OscalBaseModel
A physical point of presence, which may be associated with people, organizations, or other concepts within the current or linked OSCAL document.
Source code in trestle/oscal/common.py
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 |
|
Attributes¤
address = None
class-attribute
instance-attribute
¤
email_addresses = Field(None, alias='email-addresses')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
telephone_numbers = Field(None, alias='telephone-numbers')
class-attribute
instance-attribute
¤
title = Field(None, description='A name given to the location, which may be used by a tool for display and navigation.', title='Location Title')
class-attribute
instance-attribute
¤
urls = Field(None)
class-attribute
instance-attribute
¤
uuid = Field(..., description='A unique ID for the location, for reference.', title='Location Universally Unique Identifier')
class-attribute
instance-attribute
¤
Classes¤
LocationUuid
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
609 610 611 612 |
|
LoggedBy
¤
Bases: OscalBaseModel
Used to indicate who created a log entry in what role.
Source code in trestle/oscal/common.py
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 |
|
Attributes¤
party_uuid = Field(..., alias='party-uuid', description='A machine-oriented identifier reference to the party who is making the log entry.', title='Party UUID Reference')
class-attribute
instance-attribute
¤
role_id = Field(None, alias='role-id', description='A point to the role-id of the role in which the party is making the log entry.', title='Actor Role')
class-attribute
instance-attribute
¤
Classes¤
Metadata
¤
Bases: OscalBaseModel
Provides information about the containing document, and defines concepts that are shared across the document.
Source code in trestle/oscal/common.py
2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 |
|
Attributes¤
actions = Field(None)
class-attribute
instance-attribute
¤
document_ids = Field(None, alias='document-ids')
class-attribute
instance-attribute
¤
last_modified = Field(..., alias='last-modified')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
locations = Field(None)
class-attribute
instance-attribute
¤
oscal_version = Field(..., alias='oscal-version')
class-attribute
instance-attribute
¤
parties = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
published = None
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
responsible_parties = Field(None, alias='responsible-parties')
class-attribute
instance-attribute
¤
revisions = Field(None)
class-attribute
instance-attribute
¤
roles = Field(None)
class-attribute
instance-attribute
¤
title = Field(..., description='A name given to the document, which may be used by a tool for display and navigation.', title='Document Title')
class-attribute
instance-attribute
¤
version
instance-attribute
¤
Classes¤
Methods
¤
Bases: Enum
Identifies how the observation was made.
Source code in trestle/oscal/common.py
571 572 573 574 575 576 577 578 579 |
|
MitigatingFactor
¤
Bases: OscalBaseModel
Describes an existing mitigating factor that may affect the overall determination of the risk, with an optional link to an implementation statement in the SSP.
Source code in trestle/oscal/common.py
1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 |
|
Attributes¤
description = Field(..., description='A human-readable description of this mitigating factor.', title='Mitigating Factor Description')
class-attribute
instance-attribute
¤
implementation_uuid = Field(None, alias='implementation-uuid', description='A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this implementation statement elsewhere in this or other OSCAL instancess. The locally defined UUID of the implementation statement 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='Implementation UUID')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
subjects = Field(None)
class-attribute
instance-attribute
¤
uuid = Field(..., description='A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this mitigating factor elsewhere in this or other OSCAL instances. The locally defined UUID of the mitigating factor 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='Mitigating Factor Universally Unique Identifier')
class-attribute
instance-attribute
¤
Classes¤
Name
¤
Bases: Enum
A textual label that uniquely identifies the part's semantic type.
Source code in trestle/oscal/common.py
561 562 563 564 565 566 567 568 |
|
NamingSystemValidValues
¤
Bases: Enum
Source code in trestle/oscal/common.py
550 551 552 553 554 555 556 557 558 |
|
Attributes¤
http___csrc_nist_gov_ns_oscal = 'http://csrc.nist.gov/ns/oscal'
class-attribute
instance-attribute
¤
http___csrc_nist_gov_ns_oscal_unknown = 'http://csrc.nist.gov/ns/oscal/unknown'
class-attribute
instance-attribute
¤
http___cve_mitre_org = 'http://cve.mitre.org'
class-attribute
instance-attribute
¤
http___fedramp_gov = 'http://fedramp.gov'
class-attribute
instance-attribute
¤
http___fedramp_gov_ns_oscal = 'http://fedramp.gov/ns/oscal'
class-attribute
instance-attribute
¤
http___www_first_org_cvss_v2_0 = 'http://www.first.org/cvss/v2.0'
class-attribute
instance-attribute
¤
http___www_first_org_cvss_v3_0 = 'http://www.first.org/cvss/v3.0'
class-attribute
instance-attribute
¤
http___www_first_org_cvss_v3_1 = 'http://www.first.org/cvss/v3.1'
class-attribute
instance-attribute
¤
NonNegativeIntegerDatatype
¤
Bases: OscalBaseModel
An integer value that is equal to or greater than 0.
Source code in trestle/oscal/common.py
544 545 546 547 |
|
ObjectiveStatus
¤
Bases: OscalBaseModel
A determination of if the objective is satisfied or not within a given system.
Source code in trestle/oscal/common.py
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 |
|
Attributes¤
reason = Field(None, description="The reason the objective was given it's status.", title='Objective Status Reason')
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
state = Field(..., description='An indication as to whether the objective is satisfied or not.', title='Objective Status State')
class-attribute
instance-attribute
¤
Classes¤
ObjectiveStatusStateValidValues
¤
Bases: Enum
Source code in trestle/oscal/common.py
514 515 516 |
|
Observation
¤
Bases: OscalBaseModel
Describes an individual observation.
Source code in trestle/oscal/common.py
2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 |
|
Attributes¤
collected = Field(..., description='Date/time stamp identifying when the finding information was collected.', title='Collected Field')
class-attribute
instance-attribute
¤
description = Field(..., description='A human-readable description of this assessment observation.', title='Observation Description')
class-attribute
instance-attribute
¤
expires = Field(None, description='Date/time identifying when the finding information is out-of-date and no longer valid. Typically used with continuous assessment scenarios.', title='Expires Field')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
methods = Field(...)
class-attribute
instance-attribute
¤
origins = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
relevant_evidence = Field(None, alias='relevant-evidence')
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
subjects = Field(None)
class-attribute
instance-attribute
¤
title = Field(None, description='The title for this observation.', title='Observation Title')
class-attribute
instance-attribute
¤
types = Field(None)
class-attribute
instance-attribute
¤
uuid = Field(..., description='A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this observation elsewhere in this or other OSCAL instances. The locally defined UUID of the observation can be used to reference the data item locally or globally (e.g., in an imorted 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='Observation Universally Unique Identifier')
class-attribute
instance-attribute
¤
Classes¤
ObservationTypeValidValues
¤
Bases: Enum
Source code in trestle/oscal/common.py
506 507 508 509 510 511 |
|
Attributes¤
control_objective = 'control-objective'
class-attribute
instance-attribute
¤
finding = 'finding'
class-attribute
instance-attribute
¤
historic = 'historic'
class-attribute
instance-attribute
¤
mitigation = 'mitigation'
class-attribute
instance-attribute
¤
ssp_statement_issue = 'ssp-statement-issue'
class-attribute
instance-attribute
¤
OnDate
¤
Bases: OscalBaseModel
The task is intended to occur on the specified date.
Source code in trestle/oscal/common.py
495 496 497 498 499 500 501 502 503 |
|
Origin
¤
Bases: OscalBaseModel
Identifies the source of the finding, such as a tool, interviewed person, or activity.
Source code in trestle/oscal/common.py
1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 |
|
OriginActor
¤
Bases: OscalBaseModel
The actor that produces an observation, a finding, or a risk. One or more actor type can be used to specify a person that is using a tool.
Source code in trestle/oscal/common.py
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 |
|
Attributes¤
actor_uuid = Field(..., alias='actor-uuid', description='A machine-oriented identifier reference to the tool or person based on the associated type.', title='Actor Universally Unique Identifier Reference')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
role_id = Field(None, alias='role-id', description='For a party, this can optionally be used to specify the role the actor was performing.', title='Actor Role')
class-attribute
instance-attribute
¤
type = Field(..., description='The kind of actor.', title='Actor Type')
class-attribute
instance-attribute
¤
Classes¤
OriginActorValidValues
¤
Bases: Enum
Source code in trestle/oscal/common.py
489 490 491 492 |
|
OscalVersion
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 |
|
Attributes¤
__root__ = Field(..., description='The OSCAL model version the document was authored against and will conform to as valid.', title='OSCAL Version')
class-attribute
instance-attribute
¤
Functions¤
oscal_version_is_valid(v)
¤
Source code in trestle/oscal/common.py
477 478 479 480 481 482 483 484 485 486 |
|
Parameter
¤
Bases: OscalBaseModel
Parameters provide a mechanism for the dynamic assignment of value(s) in a control.
Source code in trestle/oscal/common.py
1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 |
|
Attributes¤
class_ = Field(None, alias='class', description='A textual label that provides a characterization of the type, purpose, use or scope of the parameter.', title='Parameter Class')
class-attribute
instance-attribute
¤
constraints = Field(None)
class-attribute
instance-attribute
¤
depends_on = Field(None, alias='depends-on', description='(deprecated) Another parameter invoking this one. This construct has been deprecated and should not be used.', title='Depends on')
class-attribute
instance-attribute
¤
guidelines = Field(None)
class-attribute
instance-attribute
¤
id = Field(..., description='A unique identifier for the parameter.', title='Parameter Identifier')
class-attribute
instance-attribute
¤
label = Field(None, description='A short, placeholder name for the parameter, which can be used as a substitute for a value if no value is assigned.', title='Parameter Label')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
select = None
class-attribute
instance-attribute
¤
usage = Field(None, description='Describes the purpose and use of a parameter.', title='Parameter Usage Description')
class-attribute
instance-attribute
¤
values = Field(None)
class-attribute
instance-attribute
¤
Classes¤
ParameterConstraint
¤
Bases: OscalBaseModel
A formal or informal expression of a constraint or test.
Source code in trestle/oscal/common.py
456 457 458 459 460 461 462 463 464 465 466 467 |
|
ParameterGuideline
¤
Bases: OscalBaseModel
A prose statement that provides a recommendation for the use of a parameter.
Source code in trestle/oscal/common.py
445 446 447 448 449 450 451 452 453 |
|
ParameterSelection
¤
Bases: OscalBaseModel
Presenting a choice among alternatives.
Source code in trestle/oscal/common.py
1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 |
|
Attributes¤
choice = Field(None)
class-attribute
instance-attribute
¤
how_many = Field(None, alias='how-many', description='Describes the number of selections that must occur. Without this setting, only one value should be assumed to be permitted.', title='Parameter Cardinality')
class-attribute
instance-attribute
¤
Classes¤
ParameterValue
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
441 442 |
|
Part
¤
Bases: OscalBaseModel
An annotated, markup-based textual element of a control's or catalog group's definition, or a child of another part.
Source code in trestle/oscal/common.py
1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 |
|
Attributes¤
class_ = Field(None, alias='class', description="An optional textual providing a sub-type or characterization of the part's name, or a category to which the part belongs.", title='Part Class')
class-attribute
instance-attribute
¤
id = Field(None, description='A unique identifier for the part.', title='Part Identifier')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
name = Field(..., description="A textual label that uniquely identifies the part's semantic type, which exists in a value space qualified by the ns.", title='Part Name')
class-attribute
instance-attribute
¤
ns = Field(None, description="An optional namespace qualifying the part's name. This allows different organizations to associate distinct semantics with the same name.", title='Part Namespace')
class-attribute
instance-attribute
¤
parts = None
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
prose = Field(None, description='Permits multiple paragraphs, lists, tables etc.', title='Part Text')
class-attribute
instance-attribute
¤
title = Field(None, description='An optional name given to the part, which may be used by a tool for display and navigation.', title='Part Title')
class-attribute
instance-attribute
¤
Classes¤
Party
¤
Bases: OscalBaseModel
An organization or person, which may be associated with roles or other concepts within the current or linked OSCAL document.
Source code in trestle/oscal/common.py
1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 |
|
Attributes¤
addresses = Field(None)
class-attribute
instance-attribute
¤
email_addresses = Field(None, alias='email-addresses')
class-attribute
instance-attribute
¤
external_ids = Field(None, alias='external-ids')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
location_uuids = Field(None, alias='location-uuids')
class-attribute
instance-attribute
¤
member_of_organizations = Field(None, alias='member-of-organizations')
class-attribute
instance-attribute
¤
name = Field(None, description='The full name of the party. This is typically the legal name associated with the party.', title='Party Name')
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
short_name = Field(None, alias='short-name', description='A short common name, abbreviation, or acronym for the party.', title='Party Short Name')
class-attribute
instance-attribute
¤
telephone_numbers = Field(None, alias='telephone-numbers')
class-attribute
instance-attribute
¤
type = Field(..., description='A category describing the kind of party the object describes.', title='Party Type')
class-attribute
instance-attribute
¤
uuid = Field(..., description='A unique identifier for the party.', title='Party Universally Unique Identifier')
class-attribute
instance-attribute
¤
Classes¤
PartyTypeValidValues
¤
PartyUuid
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
430 431 432 433 |
|
PortRange
¤
Bases: OscalBaseModel
Where applicable this is the IPv4 port range on which the service operates.
Source code in trestle/oscal/common.py
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 |
|
Attributes¤
end = Field(None, description='Indicates the ending port number in a port range', title='End')
class-attribute
instance-attribute
¤
start = Field(None, description='Indicates the starting port number in a port range', title='Start')
class-attribute
instance-attribute
¤
transport = Field(None, description='Indicates the transport type.', title='Transport')
class-attribute
instance-attribute
¤
Classes¤
PortRangeValidValues
¤
PositiveIntegerDatatype
¤
Bases: OscalBaseModel
An integer value that is greater than 0.
Source code in trestle/oscal/common.py
400 401 402 403 |
|
Property
¤
Bases: OscalBaseModel
An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.
Source code in trestle/oscal/common.py
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 |
|
Attributes¤
class_ = Field(None, alias='class', description="A textual label that provides a sub-type or characterization of the property's name.", title='Property Class')
class-attribute
instance-attribute
¤
group = Field(None, description='An identifier for relating distinct sets of properties.', title='Property Group')
class-attribute
instance-attribute
¤
name = Field(..., description="A textual label, within a namespace, that uniquely identifies a specific attribute, characteristic, or quality of the property's containing object.", title='Property Name')
class-attribute
instance-attribute
¤
ns = Field(None, description="A namespace qualifying the property's name. This allows different organizations to associate distinct semantics with the same name.", title='Property Namespace')
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
uuid = Field(None, description='A unique identifier for a property.', title='Property Universally Unique Identifier')
class-attribute
instance-attribute
¤
value = Field(..., description='Indicates the value of the attribute, characteristic, or quality.', title='Property Value')
class-attribute
instance-attribute
¤
Classes¤
Protocol
¤
Bases: OscalBaseModel
Information about the protocol used to provide a service.
Source code in trestle/oscal/common.py
1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 |
|
Attributes¤
name = Field(..., description='The common name of the protocol, which should be the appropriate "service name" from the IANA Service Name and Transport Protocol Port Number Registry.', title='Protocol Name')
class-attribute
instance-attribute
¤
port_ranges = Field(None, alias='port-ranges')
class-attribute
instance-attribute
¤
title = Field(None, description='A human readable name for the protocol (e.g., Transport Layer Security).', title='Protocol Title')
class-attribute
instance-attribute
¤
uuid = Field(None, description='A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this service protocol information elsewhere in this or other OSCAL instances. The locally defined UUID of the service protocol 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='Service Protocol Information Universally Unique Identifier')
class-attribute
instance-attribute
¤
Classes¤
Published
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
1573 1574 1575 1576 |
|
Reason
¤
Bases: Enum
The reason the objective was given it's status.
Source code in trestle/oscal/common.py
341 342 343 344 345 346 347 348 |
|
Rel
¤
Bases: Enum
Describes the type of relationship provided by the link's hypertext reference. This can be an indicator of the link's purpose.
Source code in trestle/oscal/common.py
333 334 335 336 337 338 |
|
RelatedObservation
¤
Bases: OscalBaseModel
Relates the finding to a set of referenced observations that were used to determine the finding.
Source code in trestle/oscal/common.py
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 |
|
RelatedResponse
¤
Bases: OscalBaseModel
Identifies an individual risk response that this log entry is for.
Source code in trestle/oscal/common.py
2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 |
|
Attributes¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
related_tasks = Field(None, alias='related-tasks')
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
response_uuid = Field(..., alias='response-uuid', description='A machine-oriented identifier reference to a unique risk response.', title='Response Universally Unique Identifier Reference')
class-attribute
instance-attribute
¤
Classes¤
RelatedRisk
¤
Bases: OscalBaseModel
Relates the finding to a set of referenced risks that were used to determine the finding.
Source code in trestle/oscal/common.py
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 |
|
RelatedTask
¤
Bases: OscalBaseModel
Identifies an individual task for which the containing object is a consequence of.
Source code in trestle/oscal/common.py
1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 |
|
Attributes¤
identified_subject = Field(None, alias='identified-subject', description='Used to detail assessment subjects that were identfied by this task.', title='Identified Subject')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
responsible_parties = Field(None, alias='responsible-parties')
class-attribute
instance-attribute
¤
subjects = Field(None)
class-attribute
instance-attribute
¤
task_uuid = Field(..., alias='task-uuid', description='A machine-oriented identifier reference to a unique task.', title='Task Universally Unique Identifier Reference')
class-attribute
instance-attribute
¤
Classes¤
RelevantEvidence
¤
Bases: OscalBaseModel
Links this observation to relevant evidence.
Source code in trestle/oscal/common.py
1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 |
|
Attributes¤
description = Field(..., description='A human-readable description of this evidence.', title='Relevant Evidence Description')
class-attribute
instance-attribute
¤
href = Field(None, description='A resolvable URL reference to relevant evidence.', title='Relevant Evidence Reference')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
Classes¤
Remarks
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
293 294 |
|
RequiredAsset
¤
Bases: OscalBaseModel
Identifies an asset required to achieve remediation.
Source code in trestle/oscal/common.py
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 |
|
Attributes¤
description = Field(..., description='A human-readable description of this required asset.', title='Description of Required Asset')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
subjects = Field(None)
class-attribute
instance-attribute
¤
title = Field(None, description='The title for this required asset.', title='Title for Required Asset')
class-attribute
instance-attribute
¤
uuid = Field(..., description='A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this required asset elsewhere in this or other OSCAL instances. The locally defined UUID of the asset 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='Required Universally Unique Identifier')
class-attribute
instance-attribute
¤
Classes¤
Resource
¤
Bases: OscalBaseModel
A resource associated with content in the containing document instance. A resource may be directly included in the document using base64 encoding or may point to one or more equivalent internet resources.
Source code in trestle/oscal/common.py
2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 |
|
Attributes¤
base64 = Field(None, description='A resource encoded using the Base64 alphabet defined by RFC 2045.', title='Base64')
class-attribute
instance-attribute
¤
citation = Field(None, description='An optional citation consisting of end note text using structured markup.', title='Citation')
class-attribute
instance-attribute
¤
description = Field(None, description='An optional short summary of the resource used to indicate the purpose of the resource.', title='Resource Description')
class-attribute
instance-attribute
¤
document_ids = Field(None, alias='document-ids')
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
rlinks = Field(None)
class-attribute
instance-attribute
¤
title = Field(None, description='An optional name given to the resource, which may be used by a tool for display and navigation.', title='Resource Title')
class-attribute
instance-attribute
¤
uuid = Field(..., description='A unique identifier for a resource.', title='Resource Universally Unique Identifier')
class-attribute
instance-attribute
¤
Classes¤
Response
¤
Bases: OscalBaseModel
Describes either recommended or an actual plan for addressing the risk.
Source code in trestle/oscal/common.py
2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 |
|
Attributes¤
description = Field(..., description='A human-readable description of this response plan.', title='Response Description')
class-attribute
instance-attribute
¤
lifecycle = Field(..., description='Identifies whether this is a recommendation, such as from an assessor or tool, or an actual plan accepted by the system owner.', title='Remediation Intent')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
origins = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
required_assets = Field(None, alias='required-assets')
class-attribute
instance-attribute
¤
tasks = Field(None)
class-attribute
instance-attribute
¤
title = Field(..., description='The title for this response activity.', title='Response Title')
class-attribute
instance-attribute
¤
uuid = Field(..., description='A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this remediation elsewhere in this or other OSCAL instances. The locally defined UUID of the risk response 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='Remediation Universally Unique Identifier')
class-attribute
instance-attribute
¤
Classes¤
ResponsibleParty
¤
Bases: OscalBaseModel
A reference to a set of persons and/or organizations that have responsibility for performing the referenced role in the context of the containing object.
Source code in trestle/oscal/common.py
1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 |
|
Attributes¤
links = Field(None)
class-attribute
instance-attribute
¤
party_uuids = Field(..., alias='party-uuids')
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
role_id = Field(..., alias='role-id', description='A reference to a role performed by a party.', title='Responsible Role')
class-attribute
instance-attribute
¤
Classes¤
ResponsibleRole
¤
Bases: OscalBaseModel
A reference to a role with responsibility for performing a function relative to the containing object, optionally associated with a set of persons and/or organizations that perform that role.
Source code in trestle/oscal/common.py
1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 |
|
Attributes¤
links = Field(None)
class-attribute
instance-attribute
¤
party_uuids = Field(None, alias='party-uuids')
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
role_id = Field(..., alias='role-id', description='A human-oriented identifier reference to a role performed.', title='Responsible Role ID')
class-attribute
instance-attribute
¤
Classes¤
ReviewedControls
¤
Bases: OscalBaseModel
Identifies the controls being assessed and their control objectives.
Source code in trestle/oscal/common.py
1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 |
|
Attributes¤
control_objective_selections = Field(None, alias='control-objective-selections')
class-attribute
instance-attribute
¤
control_selections = Field(..., alias='control-selections')
class-attribute
instance-attribute
¤
description = Field(None, description='A human-readable description of control objectives.', title='Control Objective Description')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
Classes¤
Revision
¤
Bases: OscalBaseModel
An entry in a sequential list of revisions to the containing document, expected to be in reverse chronological order (i.e. latest first).
Source code in trestle/oscal/common.py
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 |
|
Attributes¤
last_modified = Field(None, alias='last-modified')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
oscal_version = Field(None, alias='oscal-version')
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
published = None
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
title = Field(None, description='A name given to the document revision, which may be used by a tool for display and navigation.', title='Document Title')
class-attribute
instance-attribute
¤
version
instance-attribute
¤
Classes¤
Risk
¤
Bases: OscalBaseModel
An identified risk.
Source code in trestle/oscal/common.py
2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 |
|
Attributes¤
characterizations = Field(None)
class-attribute
instance-attribute
¤
deadline = Field(None, description='The date/time by which the risk must be resolved.', title='Risk Resolution Deadline')
class-attribute
instance-attribute
¤
description = Field(..., description='A human-readable summary of the identified risk, to include a statement of how the risk impacts the system.', title='Risk Description')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
mitigating_factors = Field(None, alias='mitigating-factors')
class-attribute
instance-attribute
¤
origins = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
related_observations = Field(None, alias='related-observations')
class-attribute
instance-attribute
¤
remediations = Field(None)
class-attribute
instance-attribute
¤
risk_log = Field(None, alias='risk-log', description='A log of all risk-related tasks taken.', title='Risk Log')
class-attribute
instance-attribute
¤
statement = Field(..., description='An summary of impact for how the risk affects the system.', title='Risk Statement')
class-attribute
instance-attribute
¤
status
instance-attribute
¤
threat_ids = Field(None, alias='threat-ids')
class-attribute
instance-attribute
¤
title = Field(..., description='The title for this risk.', title='Risk Title')
class-attribute
instance-attribute
¤
uuid = Field(..., description='A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this risk elsewhere in this or other OSCAL instances. The locally defined UUID of the risk 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 Universally Unique Identifier')
class-attribute
instance-attribute
¤
Classes¤
RiskLog
¤
Bases: OscalBaseModel
A log of all risk-related tasks taken.
Source code in trestle/oscal/common.py
2495 2496 2497 2498 2499 2500 2501 2502 2503 |
|
RiskStatus
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
287 288 289 290 |
|
RiskStatusValidValues
¤
Bases: Enum
Source code in trestle/oscal/common.py
278 279 280 281 282 283 284 |
|
Attributes¤
closed = 'closed'
class-attribute
instance-attribute
¤
deviation_approved = 'deviation-approved'
class-attribute
instance-attribute
¤
deviation_requested = 'deviation-requested'
class-attribute
instance-attribute
¤
investigating = 'investigating'
class-attribute
instance-attribute
¤
open = 'open'
class-attribute
instance-attribute
¤
remediating = 'remediating'
class-attribute
instance-attribute
¤
Rlink
¤
Bases: OscalBaseModel
A URL-based pointer to an external resource with an optional hash for verification and change detection.
Source code in trestle/oscal/common.py
1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 |
|
Attributes¤
hashes = Field(None)
class-attribute
instance-attribute
¤
href = Field(..., description='A resolvable URL pointing to the referenced resource.', title='Hypertext Reference')
class-attribute
instance-attribute
¤
media_type = Field(None, alias='media-type', description='A label that indicates the nature of a resource, as a data serialization or format.', title='Media Type')
class-attribute
instance-attribute
¤
Classes¤
Role
¤
Bases: OscalBaseModel
Defines a function, which might be assigned to a party in a specific situation.
Source code in trestle/oscal/common.py
1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 |
|
Attributes¤
description = Field(None, description="A summary of the role's purpose and associated responsibilities.", title='Role Description')
class-attribute
instance-attribute
¤
id = Field(..., description='A unique identifier for the role.', title='Role Identifier')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
short_name = Field(None, alias='short-name', description='A short common name, abbreviation, or acronym for the role.', title='Role Short Name')
class-attribute
instance-attribute
¤
title = Field(..., description='A name given to the role, which may be used by a tool for display and navigation.', title='Role Title')
class-attribute
instance-attribute
¤
Classes¤
RoleId
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
274 275 |
|
SelectControlById
¤
Bases: OscalBaseModel
Used to select a control for inclusion/exclusion based on one or more control identifiers. A set of statement identifiers can be used to target the inclusion/exclusion to only specific control statements providing more granularity over the specific statements that are within the asessment scope.
Source code in trestle/oscal/common.py
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 |
|
Attributes¤
control_id = Field(..., alias='control-id', description='A reference to a control with a corresponding id value. When referencing an externally defined control, the Control Identifier Reference must be used in the context of the external / imported OSCAL instance (e.g., uri-reference).', title='Control Identifier Reference')
class-attribute
instance-attribute
¤
statement_ids = Field(None, alias='statement-ids')
class-attribute
instance-attribute
¤
Classes¤
SelectObjectiveById
¤
Bases: OscalBaseModel
Used to select a control objective for inclusion/exclusion based on the control objective's identifier.
Source code in trestle/oscal/common.py
234 235 236 237 238 239 240 241 242 243 244 245 |
|
SelectSubjectById
¤
Bases: OscalBaseModel
Identifies a set of assessment subjects to include/exclude by UUID.
Source code in trestle/oscal/common.py
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 |
|
Attributes¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
subject_uuid = Field(..., alias='subject-uuid', description="A machine-oriented identifier reference to a component, inventory-item, location, party, user, or resource using it's UUID.", title='Subject Universally Unique Identifier Reference')
class-attribute
instance-attribute
¤
type = Field(..., description='Used to indicate the type of object pointed to by the uuid-ref within a subject.', title='Subject Universally Unique Identifier Reference Type')
class-attribute
instance-attribute
¤
Classes¤
SelectSubjectByIdValidValues
¤
Bases: Enum
Source code in trestle/oscal/common.py
225 226 227 228 229 230 231 |
|
Attributes¤
component = 'component'
class-attribute
instance-attribute
¤
inventory_item = 'inventory-item'
class-attribute
instance-attribute
¤
location = 'location'
class-attribute
instance-attribute
¤
party = 'party'
class-attribute
instance-attribute
¤
resource = 'resource'
class-attribute
instance-attribute
¤
user = 'user'
class-attribute
instance-attribute
¤
Source
¤
Bases: OscalBaseModel
Assessment subjects will be identified while conducting the referenced activity-instance.
Source code in trestle/oscal/common.py
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
|
Attributes¤
task_uuid = Field(..., alias='task-uuid', description='A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference (in this or other OSCAL instances) an assessment activity to be performed as part of the event. The locally defined UUID of the task 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='Task Universally Unique Identifier')
class-attribute
instance-attribute
¤
Classes¤
State
¤
Bases: Enum
Identifies the implementation status of the control or control objective.
Source code in trestle/oscal/common.py
194 195 196 197 198 199 200 201 202 203 |
|
Attributes¤
alternative = 'alternative'
class-attribute
instance-attribute
¤
implemented = 'implemented'
class-attribute
instance-attribute
¤
not_applicable = 'not-applicable'
class-attribute
instance-attribute
¤
partial = 'partial'
class-attribute
instance-attribute
¤
planned = 'planned'
class-attribute
instance-attribute
¤
Status
¤
Bases: OscalBaseModel
Describes the operational status of the system component.
Source code in trestle/oscal/common.py
182 183 184 185 186 187 188 189 190 191 |
|
Step
¤
Bases: OscalBaseModel
Identifies an individual step in a series of steps related to an activity, such as an assessment test or examination procedure.
Source code in trestle/oscal/common.py
2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 |
|
Attributes¤
description = Field(..., description='A human-readable description of this step.', title='Step Description')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
responsible_roles = Field(None, alias='responsible-roles')
class-attribute
instance-attribute
¤
reviewed_controls = Field(None, alias='reviewed-controls')
class-attribute
instance-attribute
¤
title = Field(None, description='The title for this step.', title='Step Title')
class-attribute
instance-attribute
¤
uuid = Field(..., description='A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this step elsewhere in this or other OSCAL instances. The locally defined UUID of the step (in a series of steps) 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='Step Universally Unique Identifier')
class-attribute
instance-attribute
¤
Classes¤
StringDatatype
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
174 175 176 177 178 179 |
|
SubjectReference
¤
Bases: OscalBaseModel
A human-oriented identifier reference to a resource. Use type to indicate whether the identified resource is a component, inventory item, location, user, or something else.
Source code in trestle/oscal/common.py
1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 |
|
Attributes¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
subject_uuid = Field(..., alias='subject-uuid', description="A machine-oriented identifier reference to a component, inventory-item, location, party, user, or resource using it's UUID.", title='Subject Universally Unique Identifier Reference')
class-attribute
instance-attribute
¤
title = Field(None, description='The title or name for the referenced subject.', title='Subject Reference Title')
class-attribute
instance-attribute
¤
type = Field(..., description='Used to indicate the type of object pointed to by the uuid-ref within a subject.', title='Subject Universally Unique Identifier Reference Type')
class-attribute
instance-attribute
¤
Classes¤
SubjectReferenceValidValues
¤
Bases: Enum
Source code in trestle/oscal/common.py
165 166 167 168 169 170 171 |
|
Attributes¤
component = 'component'
class-attribute
instance-attribute
¤
inventory_item = 'inventory-item'
class-attribute
instance-attribute
¤
location = 'location'
class-attribute
instance-attribute
¤
party = 'party'
class-attribute
instance-attribute
¤
resource = 'resource'
class-attribute
instance-attribute
¤
user = 'user'
class-attribute
instance-attribute
¤
SystemComponent
¤
Bases: OscalBaseModel
A defined component that can be part of an implemented system.
Source code in trestle/oscal/common.py
1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 |
|
Attributes¤
description = Field(..., description='A description of the component, including information about its function.', title='Component Description')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
protocols = Field(None)
class-attribute
instance-attribute
¤
purpose = Field(None, description='A summary of the technological or business purpose of the component.', title='Purpose')
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
responsible_roles = Field(None, alias='responsible-roles')
class-attribute
instance-attribute
¤
status = Field(..., description='Describes the operational status of the system component.', title='Status')
class-attribute
instance-attribute
¤
title = Field(..., description='A human readable name for the system component.', title='Component Title')
class-attribute
instance-attribute
¤
type = Field(..., description='A category describing the purpose of the component.', title='Component Type')
class-attribute
instance-attribute
¤
uuid = Field(..., description='A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this component elsewhere in this or other OSCAL instances. The locally defined UUID of the component 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='Component Identifier')
class-attribute
instance-attribute
¤
Classes¤
SystemComponentOperationalStateValidValues
¤
Bases: Enum
Source code in trestle/oscal/common.py
158 159 160 161 162 |
|
SystemComponentTypeValidValues
¤
Bases: Enum
Source code in trestle/oscal/common.py
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
|
Attributes¤
guidance = 'guidance'
class-attribute
instance-attribute
¤
hardware = 'hardware'
class-attribute
instance-attribute
¤
interconnection = 'interconnection'
class-attribute
instance-attribute
¤
network = 'network'
class-attribute
instance-attribute
¤
physical = 'physical'
class-attribute
instance-attribute
¤
plan = 'plan'
class-attribute
instance-attribute
¤
policy = 'policy'
class-attribute
instance-attribute
¤
process_procedure = 'process-procedure'
class-attribute
instance-attribute
¤
service = 'service'
class-attribute
instance-attribute
¤
software = 'software'
class-attribute
instance-attribute
¤
standard = 'standard'
class-attribute
instance-attribute
¤
system = 'system'
class-attribute
instance-attribute
¤
this_system = 'this-system'
class-attribute
instance-attribute
¤
validation = 'validation'
class-attribute
instance-attribute
¤
SystemId
¤
Bases: OscalBaseModel
A human-oriented, globally unique identifier with cross-instance scope that can be used to reference this system identification property elsewhere in this or other OSCAL instances. When referencing an externally defined system identification, the system identification must be used in the context of the external / imported OSCAL instance (e.g., uri-reference). This string should be assigned per-subject, which means it should be consistently used to identify the same system across revisions of the document.
Source code in trestle/oscal/common.py
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 |
|
SystemUser
¤
Bases: OscalBaseModel
A type of user that interacts with the system based on an associated role.
Source code in trestle/oscal/common.py
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 |
|
Attributes¤
authorized_privileges = Field(None, alias='authorized-privileges')
class-attribute
instance-attribute
¤
description = Field(None, description="A summary of the user's purpose within the system.", title='User Description')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
role_ids = Field(None, alias='role-ids')
class-attribute
instance-attribute
¤
short_name = Field(None, alias='short-name', description='A short common name, abbreviation, or acronym for the user.', title='User Short Name')
class-attribute
instance-attribute
¤
title = Field(None, description='A name given to the user, which may be used by a tool for display and navigation.', title='User Title')
class-attribute
instance-attribute
¤
uuid = Field(..., description='A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this user class elsewhere in this or other OSCAL instances. The locally defined UUID of the system user 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='User Universally Unique Identifier')
class-attribute
instance-attribute
¤
Classes¤
Task
¤
Bases: OscalBaseModel
Represents a scheduled event or milestone, which may be associated with a series of assessment actions.
Source code in trestle/oscal/common.py
2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 |
|
Attributes¤
associated_activities = Field(None, alias='associated-activities')
class-attribute
instance-attribute
¤
dependencies = Field(None)
class-attribute
instance-attribute
¤
description = Field(None, description='A human-readable description of this task.', title='Task Description')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
responsible_roles = Field(None, alias='responsible-roles')
class-attribute
instance-attribute
¤
subjects = Field(None)
class-attribute
instance-attribute
¤
tasks = None
class-attribute
instance-attribute
¤
timing = Field(None, description='The timing under which the task is intended to occur.', title='Event Timing')
class-attribute
instance-attribute
¤
title = Field(..., description='The title for this task.', title='Task Title')
class-attribute
instance-attribute
¤
type = Field(..., description='The type of task.', title='Task Type')
class-attribute
instance-attribute
¤
uuid = Field(..., description='A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this task elsewhere in this or other OSCAL instances. The locally defined UUID of the task 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='Task Universally Unique Identifier')
class-attribute
instance-attribute
¤
Classes¤
TaskValidValues
¤
TelephoneNumber
¤
Bases: OscalBaseModel
A telephone service number as defined by ITU-T E.164.
Source code in trestle/oscal/common.py
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 |
|
TelephoneTypeValidValues
¤
Bases: Enum
Source code in trestle/oscal/common.py
130 131 132 133 |
|
Test
¤
Bases: OscalBaseModel
A test expression which is expected to be evaluated by a tool.
Source code in trestle/oscal/common.py
116 117 118 119 120 121 122 123 124 125 126 127 |
|
ThreatId
¤
Bases: OscalBaseModel
A pointer, by ID, to an externally-defined threat.
Source code in trestle/oscal/common.py
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
|
Attributes¤
href = Field(None, description='An optional location for the threat data, from which this ID originates.', title='Threat Information Resource Reference')
class-attribute
instance-attribute
¤
id
instance-attribute
¤
system = Field(..., description='Specifies the source of the threat information.', title='Threat Type Identification System')
class-attribute
instance-attribute
¤
Classes¤
ThreatIdValidValues
¤
Bases: Enum
Source code in trestle/oscal/common.py
92 93 94 |
|
TimeUnitValidValues
¤
Bases: Enum
Source code in trestle/oscal/common.py
83 84 85 86 87 88 89 |
|
Attributes¤
days = 'days'
class-attribute
instance-attribute
¤
hours = 'hours'
class-attribute
instance-attribute
¤
minutes = 'minutes'
class-attribute
instance-attribute
¤
months = 'months'
class-attribute
instance-attribute
¤
seconds = 'seconds'
class-attribute
instance-attribute
¤
years = 'years'
class-attribute
instance-attribute
¤
Timing
¤
Bases: OscalBaseModel
The timing under which the task is intended to occur.
Source code in trestle/oscal/common.py
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 |
|
Attributes¤
at_frequency = Field(None, alias='at-frequency', description='The task is intended to occur at the specified frequency.', title='Frequency Condition')
class-attribute
instance-attribute
¤
on_date = Field(None, alias='on-date', description='The task is intended to occur on the specified date.', title='On Date Condition')
class-attribute
instance-attribute
¤
within_date_range = Field(None, alias='within-date-range', description='The task is intended to occur within the specified date range.', title='On Date Range Condition')
class-attribute
instance-attribute
¤
Classes¤
TokenDatatype
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
72 73 74 75 76 77 78 79 80 |
|
URIDatatype
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
68 69 |
|
URIReferenceDatatype
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
60 61 62 63 64 65 |
|
UUIDDatatype
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
54 55 56 57 |
|
UsesComponent
¤
Bases: OscalBaseModel
The set of components that are used by the assessment platform.
Source code in trestle/oscal/common.py
2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 |
|
Attributes¤
component_uuid = Field(..., alias='component-uuid', description='A machine-oriented identifier reference to a component that is implemented as part of an inventory item.', title='Component Universally Unique Identifier Reference')
class-attribute
instance-attribute
¤
links = Field(None)
class-attribute
instance-attribute
¤
props = Field(None)
class-attribute
instance-attribute
¤
remarks = None
class-attribute
instance-attribute
¤
responsible_parties = Field(None, alias='responsible-parties')
class-attribute
instance-attribute
¤
Classes¤
Version
¤
Bases: OscalBaseModel
Source code in trestle/oscal/common.py
1147 1148 1149 1150 1151 1152 1153 |
|
WithinDateRange
¤
Bases: OscalBaseModel
The task is intended to occur within the specified date range.
Source code in trestle/oscal/common.py
38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
|
Attributes¤
end = Field(..., description='The task must occur on or before the specified date.', title='End Date Condition')
class-attribute
instance-attribute
¤
start = Field(..., description='The task must occur on or after the specified date.', title='Start Date Condition')
class-attribute
instance-attribute
¤
Classes¤
handler: python