expliot.plugins.firmware.gencdxbom

Sample test/plugin as demo.

Attributes

VER14

LOGNO

LOGPRETTY

DEFAULT_PORT

Classes

CycloneDXBOM

CycloneDX BOM Object.

TCategory

Representation of Test Category.

Test

Representation of Test.

TLog

Representation of a Test Log.

TTarget

Representation of Test Target class.

GenCDXBom

Test class for the sample.

Module Contents

expliot.plugins.firmware.gencdxbom.VER14 = '1.4'
class expliot.plugins.firmware.gencdxbom.CycloneDXBOM

CycloneDX BOM Object.

It implements a callback for DirEnumerator for creating the SBOM.

EXPLIoT CycloneDX Property Taxonomy

Property

Description

expliot:file:path

The path of the file in the paxkage (software, firmware etc)

expliot:file:mode

The file mode string as on a Linux system (rwx)

expliot:file:size

The size of the file in bytes

initbom(specversion, rootdir=None)

Create a new BOM Object and fill it with all file data.

Only if rootdir is specified.

Args:

specversion (str): The CycloneDX Specification Version

Returns:

Nothing

Raises:

ValueError - if specversion is not supported

enumcb(rootdir, currentdir, filedata)

Callback for DirEnumerator.enumerate().

Return the component data about the file

generate_from_dir(rootdir)

Generate CycloneDX BOM from the contents of a directory.

Args:
rootdir (str): The root directory to start enumerating

and generating the BOM data

Returns:

Nothing

validate()

Validate the format with the json schema of the initialized spec version.

Returns:

Nothing

Raises:

ValidationError (https://python-jsonschema.readthedocs.io/en/stable/validate/)

getbom(validate=True, jsonfmt=False)

Returns the CycloneDX BOM in Dict or JSON format.

Args:

validate(bool): Validate the format with the schema. Default is True jsonfmt(bool): Return BOM in JSON format or Dict object. Default is False

Returns:

BOM in JSON string

writebom(file, validate=True, indent=4)

Write BOM in JSON format to a file.

Args:

file(str): File path to write the JSON to validate(bool): Validate the format with the schema. Default is True indent(int): Indentation limit to improve readability. Default is 4

Returns:

Nothing

total_files()

Returns the total number of files in the root dir.

Args:

Nothing

returns

(int) Total number of files or -1 if BOM not generated

total_dirs()

Returns the total number of dirs in the root dir.

Args:

Nothing

returns

(int) Total number of dirs or -1 if BOM not generated

total_hiddenfiles()

Returns the total number of hidden files in the root dir.

Args:

Nothing

returns

(int) Total number of hidden files or -1 if BOM not generated

total_hiddendirs()

Returns the total number of hidden dirs in the root dir.

Args:

Nothing

returns

(int) Total number of hidden dirs or -1 if BOM not generated

Returns the total number of symlinks in the dir.

Args:

Nothing

returns

(int) Total number of symlinks or -1 if BOM not generated

expliot.plugins.firmware.gencdxbom.LOGNO = 0
expliot.plugins.firmware.gencdxbom.LOGPRETTY = 1
class expliot.plugins.firmware.gencdxbom.TCategory(tech, iface, action)

Bases: namedtuple('TCategory', 'tech, iface, action')

Representation of Test Category.

The class that defines the category of the test case. It is part of the Test class member _category. It can be used to identify the type of test or search for a specific category. It is a namedtuple that defines three attributes (for categorizing test cases).

  1. tech: What technology does the test use

  2. iface: Interface of the test i.e. whether it is for software or hardware

  3. action: What action does the test perform i.e. is it an exploit or a

    recon test for example.

COAP = 'coap'
DICOM = 'dicom'
HTTP = 'http'
MDNS = 'mdns'
MODBUS = 'modbus'
MQTT = 'mqtt'
TCP = 'tcp'
TLS = 'tls'
UDP = 'udp'
UPNP = 'upnp'
BLE = 'ble'
IEEE802154 = '802154'
ZIGBEE = 'zigbee'
CAN = 'can'
I2C = 'i2c'
JTAG = 'jtag'
SPI = 'spi'
UART = 'uart'
CRYPTO = 'crypto'
FW = 'firmware'
DISCLOSURE = 'disclosure'
ZB_AUDITOR = 'zbauditor'
BUS_AUDITOR = 'busauditor'
FW_AUDITOR = 'fwauditor'
NMAP = 'nmap'
_tech
HW = 'hardware'
RD = 'radio'
SW = 'software'
_interfaces
ANALYSIS = 'analysis'
COMPLIANCE = 'compliance'
DISCOVERY = 'discovery'
EXPLOIT = 'exploit'
FUZZ = 'fuzz'
RECON = 'recon'
_actions
class expliot.plugins.firmware.gencdxbom.Test(**kwargs)

Representation of Test.

The Base class for test cases (plugins). It defines the basic interface and basic implementation for the test cases. All test case plugins need to inherit from a test class derived from this class or this class itself depending on the purpose of the test case.

pre()

Action to take before the test.

post()

Action to take after the test.

execute()

Execute the test.

intro()

Show the intro for test.

output_dict_iter(cblog, robj, rlevel, key=None, value=None)

Callback method for recurse_list_dict().

It iterates over the dict

output passed from a plugin to output_handler(). It performs two operations on the dict

  1. If the output data is to be TLog(ged) (LOGPRETTY) on the console, then log the data recursively from the dict.

  2. Convert any bytes or bytearray objects in the dict to binary string and update the original dict object itself.

Args:
cblog (dict): Contains logging information i.e. to log the data or not?

and the Log prefix type.

robj (list or dict): The list or dict object at the specified recursion

level. This is updated by this callback i.e. bytes and bytearray objects found are converted to binary strings.

rlevel (int): The current recursion level at which this callback

instance is called.

key (str): The key if the robj is a dict. value (can be any type): 1. The value of the key if robj is a dict or

  1. A value from the robj if it is a list

Returns:

Nothing

output_handler(tlogtype=TLog.SUCCESS, msg=None, logkwargs=LOGPRETTY, **kwargs)

Handle the Test execution output data.

  • Add(append) data (dict) as an item in the TResult output (list).

  • And/or Log (print) the output

Args:
tlogtype (int): TLog prefix type to use i.e. Success, fail etc.

Check TLog class for prefix details.

msg (str): Specify a message to be logged, if any, apart from

output data.

logkwargs=LOGPRETTY(int): There are three options for kwargs logging

LOGPRETTY(0) - formatted logging for dict or list. LOGNORMAL(1) - Direct print of dict or list as is. LOGNO(2) - Do not log kwargs.

**kwargs: plugin output keyword arguments (or a **dictObject)

Returns:

Nothing.

run(arglist)

Run the test.

Args:

arglist (list): The argument list of the plugin.

Returns:
dict: The plugin result (status and output) on success,

or an empty dict in case of any error.

_assertpriv()

Raise an exception if the plugin needs root privileges.

Only if program is not executing as root.

Args:

None

Returns:

Nothing

_setid()

Set the Unique Test ID.

The ID is the plugin class name in lowercase.

Args:

None

Returns:

Nothing

_logstatus()

Handle the log status.

Args:

None

Returns:

Nothing

class expliot.plugins.firmware.gencdxbom.TLog

Representation of a Test Log.

Logger class for logging test case output. By default log to sys.stdout Must not instantiate. Use class methods. The logger needs to be initialized with the output file using init() class method

SUCCESS = 0
FAIL = 1
TRYDO = 2
GENERIC = 3
_prefix = ['[+]', '[-]', '[?]', '[*]']
_errprefix = '[.]'
_file
classmethod init(file=None)

Initialize the file object.

This method should be called in the beginning of the application to open the log output file.

Parameters:

file – The file where to log the test output

Returns:

classmethod close()

Close the file object if it is not sys.stdout.

Returns:

classmethod print(prefixtype, message)

The actual print methods.

Write the formatted message to the _file file.

Args:

prefixtype(int): the prefix type to be used for the message (defined above) message(str): The actual message from the Test object

Returns:

Nothing

classmethod success(message)

Write a message with success prefix to the file.

Parameters:

message – The message to be written

Returns:

classmethod fail(message)

Write a message with fail prefix to the file.

Parameters:

message – The message to be written

Returns:

classmethod trydo(message)

Write a message with try prefix to the file.

Parameters:

message – The message to be written

Returns:

void

classmethod generic(message)

Write a message with success prefix to the file.

Parameters:

message – The message to be written

Returns:

void

class expliot.plugins.firmware.gencdxbom.TTarget(name, version, vendor)

Bases: namedtuple('TTarget', 'name, version, vendor')

Representation of Test Target class.

Class that hold details about the target of the test. It is a namedtuple and holds the below details:

  1. name - Target/product name

  2. version - Version of the product

  3. vendor - Vendor that owns the product

Please note, in case it is a generic test case that can be used for multiple products use Target.GENERIC for all attributes.

GENERIC = 'generic'
LINUX = 'linux'
AWS = 'aws'
_name
AMAZON = 'amazon'
_vendor
expliot.plugins.firmware.gencdxbom.DEFAULT_PORT = 80
class expliot.plugins.firmware.gencdxbom.GenCDXBom

Bases: expliot.core.tests.test.Test

Test class for the sample.

Output Format: [

{

“files”: 7, # Total number of files (including normal, hidden and symlinks) “dirs”: 4, # Total number of directories “hiddenfiles”: 2, # Total number of hidden files “hiddentdirs”: 1, # Total number of hidden directories “symlinks”: 1 # Total number of symlinks

}, # Below is the JSON format as per CycloneDX JSON Specification {

“bomFormat”: “CycloneDX”, … …

}

]

execute()

Execute the test.