openc2lib.profiles.slpf.results

SLPF Response extensions

This module defines SLPF-specific extensions to OpenC2 Response. See Sec. 2.2 of the SLPF Specification.

View Source

 1""" SLPF Response extensions
 2
 3	This module defines SLPF-specific extensions to OpenC2 Response.
 4	See Sec. 2.2 of the SLPF Specification.
 5"""
 6import openc2lib as oc2
 7
 8from openc2lib.profiles.slpf.profile import Profile
 9from openc2lib.profiles.slpf.targets import RuleID
10
11@oc2.extension(nsid=Profile.nsid)
12class Results(oc2.Results):
13	""" SLPF Results
14
15		Extensions to the base class `openc2lib.core.response.Results`.
16		See Sec. 2.2.2 of the SLPF Specification.
17		The extension mechanism is described in the 
18		[Developing extensions](https://github.com/mattereppe/openc2lib/blob/main/docs/developingextensions.md#developing-extensions) Section of the main documentation.
19
20		Note that the same name is used as the base class, to make it simpler to 
21		remember. The recommended way to use in the code is to import the whole
22		slpf module as `slpf` and refer to this class as `slpf.Results`.
23	"""
24	fieldtypes = {'rule_number': RuleID}
25	""" Extension with SLPF specific arguments (Sec. 2.2.2 of the SLPF Specification) """

@oc2.extension(nsid=Profile.nsid)

class Results(openc2lib.core.results.Results): View Source

12@oc2.extension(nsid=Profile.nsid)
13class Results(oc2.Results):
14	""" SLPF Results
15
16		Extensions to the base class `openc2lib.core.response.Results`.
17		See Sec. 2.2.2 of the SLPF Specification.
18		The extension mechanism is described in the 
19		[Developing extensions](https://github.com/mattereppe/openc2lib/blob/main/docs/developingextensions.md#developing-extensions) Section of the main documentation.
20
21		Note that the same name is used as the base class, to make it simpler to 
22		remember. The recommended way to use in the code is to import the whole
23		slpf module as `slpf` and refer to this class as `slpf.Results`.
24	"""
25	fieldtypes = {'rule_number': RuleID}
26	""" Extension with SLPF specific arguments (Sec. 2.2.2 of the SLPF Specification) """

SLPF Results

Extensions to the base class openc2lib.core.response.Results. See Sec. 2.2.2 of the SLPF Specification. The extension mechanism is described in the Developing extensions Section of the main documentation.

Note that the same name is used as the base class, to make it simpler to remember. The recommended way to use in the code is to import the whole slpf module as slpf and refer to this class as slpf.Results.

fieldtypes = {'rule_number': <class 'openc2lib.profiles.slpf.targets.rule_id.RuleID'>, 'versions': <class 'openc2lib.types.base.array_of.ArrayOf.__new__.<locals>.ArrayOf'>, 'profiles': <class 'openc2lib.types.base.array_of.ArrayOf.__new__.<locals>.ArrayOf'>, 'pairs': <class 'openc2lib.types.data.action_targets.ActionTargets'>, 'rate_limit': <class 'int'>}

Extension with SLPF specific arguments (Sec. 2.2.2 of the SLPF Specification)

base = <class 'openc2lib.core.results.Results'>

Base class

Data types defined in the Language Specification shall not set this field. Data types defined in Profiles that extends a Data Type defined in the Language Specification, must set this field to the corresponding class of the base Data Type.

Note: Extensions defined in the openc2lib context are recommended to use the same name of the base Data Type, and to distinguish them through appropriate usage of the namespacing mechanism.

nsid = 'slpf'

Inherited Members

openc2lib.core.results.Results: set; register
openc2lib.types.base.map.Map: todict; fromdict
builtins.dict: get; setdefault; pop; popitem; keys; items; values; update; fromkeys; clear; copy