otupy.profiles.ctxd.data.consumer.Consumer

class Consumer(host: str = None, port: int = None, protocol: int = None, endpoint: str = None, transfer: str = None, encoding: str = None, profile: str = 'x-ctxd', actuator=None)

Bases: Record

This class contains all mandatory and optional data to connect to an OpenC2 Consumer. Although a typical OpenC2 communication stack will likely use JSON/HTTPS, there are not default settings for this class.

Methods

fromdict	Builds instance from dictionary
todict	Converts to dictionary
validate_fields

Attributes

actuator	actuator specifiers
encoding	encoding format used to connect to the actuator
endpoint	path to the endpoint (.../.well-known/openc2)
host	Hostname or IP address
port	port used to connect to the actuator
profile	profile implemented by this Consumer.
protocol	protocol used to connect to the actuator
transfer	transfer protocol used to connect to the actuator

__init__(host: str = None, port: int = None, protocol: int = None, endpoint: str = None, transfer: str = None, encoding: str = None, profile: str = 'x-ctxd', actuator=None)

actuator: dict = None

actuator specifiers

encoding: str = None

encoding format used to connect to the actuator

endpoint: str = None

path to the endpoint (…/.well-known/openc2)

classmethod fromdict(dic, e)

Builds instance from dictionary

It is used during deserialization to create an otupy instance from the text message. It takes an Encoder instance that is used to recursively build instances of the inner objects (the Encoder provides standard methods to create instances of base objects like strings, integers, boolean).

Parameters:

• dic – The intermediary dictionary representation from which the object is built.

• e – The Encoder that is being used.

Returns:

An instance of this class initialized from the dictionary values.

host: str = None

Hostname or IP address

port: int = None

port used to connect to the actuator

profile: str = None

profile implemented by this Consumer. Default to the context discovery profile.

protocol: L4Protocol = None

protocol used to connect to the actuator

todict(e)

Converts to dictionary

It is used to convert this object to an intermediary representation during serialization. It takes an Encoder argument that is used to recursively serialize inner data and structures (the Encoder provides standard methods for converting base types to dictionaries)..

Parameters:

e – The Encoder that is being used.

Returns:

A dictionary compliants to the Language Specification’s serialization rules.

transfer: str = None

transfer protocol used to connect to the actuator