Skip to main content

Builder for Agent Plugins.

Project description

Agent Plugin Builder

A package which with a help of infectionmonkey/agent-builder and infectionmonkey/plugin-builder Docker images, builds an Agent Plugin archive which can be installed in Monkey Island and used in the simulation over your network.

It uses an Python Docker API client to connect to your local Docker environment and run with the mentioned Docker Images needed docker commands.

Getting started

Installation

Install Agent Plugin Builder with pip install .

Running Agent Plugin Builder

After installation, if pip installed it somewhere in your $PATH Agent Plugin Builder can be started by simply invoking:

build_agent_plugin <PLUGIN_PATH>

where:

Required:
    PLUGIN_PATH: The path where you have the Agent Plugin code.

Optional:
    -b/--build-dir-path: The path where all needed build artifacts will be stored.
    If the directory is not empty, it will delete it using `shutil.rmtree`
    Default: <current_working_directory>/build

    -d/--dist-dir-path: The path where resulting Agent Plugin archive will be stored.
    Default: <current_working_directory>/dist

    -s/--source-dir-name: The name of the source directory.
    Default: <plugin_name>_<plugin_type>

    -pd/--platform-dependencies: The platform dependencies for the Agent Plugin.
    Options:
    common: All dependencies are packaged once, and shared across all platforms. This
        should only be used if all dependencies are known to be platform-independent.
    separate: Some or all dependencies are platform-dependent, and are therefore packaged
        separately for each supported platform. This is the most reliable option,
        however it results in a larger plugin file, since dependencies are
        duplicated for each platform.
    autodetect: The plugin builder will attempt to detect the best method to use.
    Default: autodetect

    -ver/--verify/--no-verify: Specify whether to verify the plugin's dependencies.
    --verify: Verify the integrity of the plugin's dependencies. (Recommended, default)
    --no-hverify: Do not verify the integrity of the plugin's dependencies. (Not recommended)
    not specified: Same as --verify.

    -v/--verbose: Multiple occurrences increases the logging level of the console logging.
    Example: -v means CRITICAL, -vvvvv means DEBUG.
    Default: if not specific, the logging level will be INFO.

Using Poetry

Alternatively one may use Agent Plugin Builder without installing it by cloning this repository and invoking:

poetry install
poetry run build_agent_plugin <PLUGIN_PATH>

Development

Setting up your development environment

Run the following commands to install the necessary prerequisites:

pip install poetry pre-commit
poetry install
pre-commit install -t pre-commit -t prepare-commit-msg

Running unit tests

To run all automated tests, invoke:

poetry run pytest

There are also integration tests which are slow and can be skipped by invoking:

poetry run pytest --skip-integration

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agent_plugin_builder-0.6.0.tar.gz (24.4 kB view details)

Uploaded Source

Built Distribution

agent_plugin_builder-0.6.0-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

Details for the file agent_plugin_builder-0.6.0.tar.gz.

File metadata

  • Download URL: agent_plugin_builder-0.6.0.tar.gz
  • Upload date:
  • Size: 24.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.3 Linux/6.8.0-45-generic

File hashes

Hashes for agent_plugin_builder-0.6.0.tar.gz
Algorithm Hash digest
SHA256 c89a73c454e8a4e297429c58e487560f13b32b17d3bfa46d449f385bebe1eb5a
MD5 f11f5cb211132f2abac49546963cd5b9
BLAKE2b-256 882dacb11f31d333edc45e76783f70d35ec54802b35a85a477152c7a831a89da

See more details on using hashes here.

Provenance

File details

Details for the file agent_plugin_builder-0.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for agent_plugin_builder-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 af3a848623385890af45ae2bf152d696c36b70d7813184e4e88bbceae44c550d
MD5 d5bcf8d9c5bf18e9e1b2fce2dd84603a
BLAKE2b-256 f7a717a07e6bc07fb5fde612b59300cdb18cf6035ba68cef8e910c892bbd4aa7

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page