Crate malwaredb

Malware DB Python Client

This is a Python module for interacting with an instance of Malware DB.

Installation

Assuming you already have Malware DB checked out:

1. python3 -m venv mdb-venv
2. source mdb-venv/bin/activate
3. pip install maturin
4. cd client-py
5. maturin develop

Features

If using this crate with another library, be sure to use the rust_lib feature flag to avoid creating the Malware DB client module type. This could be useful for reusing the functions defined in this crate with another Python module.

Use

1. Import the module: from malwaredb import MalwareDBClient
2. Create a client object from one of three ways:
   • MalwareDBClient.from_file() to use a configuration file
   • MalwareDBClient() to have the client library find a configuration file
   • MalwareDBClient.connect(url, api_key, [cert_path]) to provide the URL, API key, and optional path for a certificate for encrypted communication
   • MalwareDBClient.login(url, username, password, save, [cert_path]) to provide the URL, user name, password, whether to save the configuration, and optional path for a certificate for encrypted communication
3. Client functionality:
   • .get_file_bytes() get a file from Malware DB
   • .server_info() get server information
   • .submit_file() submit a file to Malware DB
   • .labels() get available labels for samples
   • .whoami() get information about the user’s account
4. CaRT functionality:
   • malwaredb.cart.create_cart() encodes bytes into a CaRT bytes
   • malwaredb.cart.decode_cart() decodes CaRT bytes back into the original binary long with header and footer data. See client-py/py_test/cart.py.
   • Current limitations:
     • create_cart() doesn’t allow setting custom fields.
     • decode_cart() will not be able to return fields which aren’t plain float, integer, or string types.
   • See cart as an alternative CaRT module which is probably more feature-rich.

Modules

cart

CaRT file I/O

types

Python wrapper types for some Malware DB API types

Constants

MDB_VERSION

MDB version

VERSION