openc2lib.core.target

 1""" OpenC2 Target
 2
 3	This module implements the Target types defined in Sec. 3.4.1 [OpenC2 Languate specification].
 4"""
 5
 6import aenum
 7
 8from openc2lib.types.basetypes import Choice
 9from openc2lib.types.datatypes import TargetEnum
10from openc2lib.core.register import Register
11
12
13class TargetRegister(Register):
14	""" Target registration
15	
16		This class registers all available `Target`s, both provided by the openc2lib and by Profiles.
17		The extension of the base class `Register` is necessary to add the nsid prefix in front of the
18		`Target` name.
19	"""
20	
21	def add(self, name: str, target, identifier=None, nsid=None):
22		""" Add a new `Target`
23	
24			Register a new `Target` and make it available within the system. This method is expected to
25			be called by any `Profile` that defines additional `Target`s. Additionally, the name is added 
26			to the Target enumeration `TargetEnum`.
27			
28			This method throw an Exception if the `Target` is already registered.
29
30			:param name: The name used for the `Target`.
31			:param target: The class that defines the `Target`.
32			:param identifier: A numeric value associated to the standard by the Specification.
33			:param nsid: The Namespace Identifier where the `Target` is defined. It is prepended to the target `name`.
34			:return: None
35		"""
36		if nsid is not None:
37			name = nsid + ':' + name
38		try:
39			list(self.keys())[list(self.values()).index(target)]
40		except ValueError:
41			# The item is not in the list
42			self[name] = target
43			aenum.extend_enum(TargetEnum, name, identifier)
44			return
45		raise ValueError("Target already registered")
46
47Targets = TargetRegister()
48""" List of available `Target`s
49
50	Include base Targets defined by the Language Specification and additional Targets defined by Profiles.
51"""
52
53class Target(Choice):
54	""" OpenC2 Target in `Command`
55
56		This is the definition of the `target` carried in OpenC2 `Command`.
57	"""
58	register = Targets
59	""" Keeps the list of registered `Target`s """
60
61	def getName(self):
62		""" Returns the identifier associated to the Target type."""
63		return self.choice