dxlvtapiservice.app module

class dxlvtapiservice.app.VirusTotalApiService(config_dir)

Bases: dxlbootstrap.app.Application

The "VirusTotal DXL" service class.

Constructor parameters:

Parameters:config_dir -- The location of the configuration files for the application
GENERAL_API_KEY_CONFIG_PROP = 'apiKey'

The property used to specify the VirusTotal API Key in the application configuration file

GENERAL_CONFIG_SECTION = 'General'

The name of the "General" section within the application configuration file

REQ_TOPIC_DOMAIN_REPORT = '/opendxl-virustotal/service/vtapi/domain/report'

The "domain report" DXL request topic

REQ_TOPIC_FILE_REPORT = '/opendxl-virustotal/service/vtapi/file/report'

The "file report" DXL request topic

REQ_TOPIC_FILE_RESCAN = '/opendxl-virustotal/service/vtapi/file/rescan'

The "file rescan" DXL request topic

REQ_TOPIC_IP_ADDRESS_REPORT = '/opendxl-virustotal/service/vtapi/ip-address/report'

The "ip address report" DXL request topic

REQ_TOPIC_URL_REPORT = '/opendxl-virustotal/service/vtapi/url/report'

The "url report" DXL request topic

REQ_TOPIC_URL_SCAN = '/opendxl-virustotal/service/vtapi/url/scan'

The "url scan" DXL request topic

SERVICE_TYPE = '/opendxl-virustotal/service/vtapi'

The DXL service type for the VirusTotal API

SERVICE_TYPE_LENGTH = 33

The length of the DXL service type string

VTAPI_URL_FORMAT = 'https://www.virustotal.com/vtapi/v2{0}'

The URL format for VirusTotal API invocations

api_key

The VirusTotal API key

client

The DXL client used by the application to communicate with the DXL fabric

config

The application configuration (as read from the "dxlvtapiservice.config" file)

on_dxl_connect()

Invoked after the client associated with the application has connected to the DXL fabric.

on_load_configuration(config)

Invoked after the application-specific configuration has been loaded

This callback provides the opportunity for the application to parse additional configuration properties.

Parameters:config -- The application configuration
on_register_services()

Invoked when services should be registered with the application

on_run()

Invoked when the application has started running.