openc2lib.core.results

 1""" OpenC2 Response Results
 2
 3	This class defines the basic structure for Results carried in a Response.
 4	This class can be extended by profiles definitions with additional fields.
 5	See the main project documentation to learn more about extensions.
 6"""
 7
 8from openc2lib.types.base import Map, ArrayOf
 9from openc2lib.types.data import Version, ActionTargets, Nsid
10from openc2lib.core.extensions import extensible
11
12
13@extensible
14class Results(Map):
15	""" OpenC2 Response Results
16
17		This class implements the definition in Sec. 3.3.2.2 of the Language Specification. The `Results` carry
18		the output of an OpenC2 Command. This definition only includes basic fields and it is expected to
19		be extended for each `Profile`.
20
21		Extensions must be declared with the `@extension` decorator, including the Namespace Identifier.
22		Extensions must define the additional fields envisioned by the Profile specification in the `fieldtypes` 
23		dictionary.
24	"""
25	fieldtypes = dict(versions= ArrayOf(Version), profiles= ArrayOf(Nsid), pairs= ActionTargets, rate_limit= int)
26	""" Field types
27	
28		This is the definition of the fields beard by the `Results`. This definition is for internal use only,
29		to parse OpenC2 messages. Extensions must include these fields and add additional definitions.
30	"""
31
32	def set(self, versions=None, profiles=None, pairs=None, rate_limit=None):
33		""" Set values
34
35			This function may be used to set specific values of the `Results`, with a key=value syntax.
36			:param version: List of OpenC2 Versions supported by the Actuator.
37			:param profiles: List of OpenC2 Profiles supported by the Actuator.
38			:param pairs: List of `Targets` applicable to each supported `Action`.
39			:param rate_limit: Maximum number of requests per minute supported by design or policy.
40			:return: None
41		"""
42		self['versions']=versions
43		self['profiles']=profiles
44		self['pairs']=pairs
45		self['rate_limit']=rate_limit