openc2lib.encoders.json

 1""" JSON Encoding
 2
 3	This module provides the code for encoding OpenC2 messages with JSON.
 4"""
 5import json
 6
 7from openc2lib import Encoder, register_encoder
 8
 9
10@register_encoder
11class JSONEncoder(Encoder):
12	""" JSON Encoder
13	
14		This class implements the `Encoder` interface for the JSON format. It leverages
15		the intermediary dictionary representation.
16
17		The `JSONEncoder` can be used to create an OpenC2 stack in `Consumer` and `Producer`.
18	"""
19	encoder_type = 'json'
20	""" The label that is used to identify this `Encoder` in OpenC2 messages. """
21
22	@staticmethod
23	def encode(obj):
24		""" Encode an OpenC2 object
25
26			This method is used to encode an openc2lib object, which usually is a `Command` or `Message`. 
27			The implementation leverages the intermediary dictionary representation and it is
28			therefore agnostic of openc2lib clases.
29
30			:param obj: A valid openc2lib object.
31			:return: A string with the json representation of the `obj`.
32
33		"""
34		return json.dumps(Encoder.todict(obj))
35
36	@staticmethod
37	def decode(msg, msgtype=None):
38		""" Decode an OpenC2 message
39
40			This method is used to create an openc2lib object of type `msgtype` from a json record. 
41			The openc2lib class `msgtype` corresponding to the json record `msg` must be explicitly provided,
42			since parsing and automatically inferring the `msgtype` is not currently implemented.
43
44			The implementation leverages the intermediary dictionary representation and it is
45			therefore agnostic of openc2lib classes.
46
47			:param msg: The json record to decode.
48			:param msgtype: The openc2lib class to convert the json to.
49			:return: An `msgtype` class initialized according to the json content.
50		"""
51		if msgtype == None:
52			return json.loads(msg)
53
54		if isinstance(msg, str):
55			return Encoder.decode(msgtype, json.loads(msg))
56		else:
57			return Encoder.decode(msgtype, msg)