plugins.md

Plugins

Security Monkey can be extended by writing own Account Managers, Watchers and Auditors. To do this you need to create a subclass of either security_monkey.account_manager.AccountManager, security_monkey.watcher.Watcher or security_monkey.auditor.Auditor.

To make extension available to Security Monkey it should have entry point under group security_monkey.plugins.

Sample AccountManager plugin

Assume we have a file account.py in directory my_sm_plugins/my_sm_plugins/account.py:

from security_monkey.account_manager import AccountManager

class MyAccountManager(AccountManager):
    pass

NOTE: there also shoule be file my_sm_plugins/my_sm_plugins/__init__.py

And we have a file setup.py in directory my_sm_plugins:

from setuptools import setup, find_packages

setup(
    name="my_sm_plugins",
    version="0.1-dev0",
    packages=find_packages(),
    include_package_data=True,
    install_requires=["security_monkey"],
    entry_points={
        "security_monkey.plugins": [
            "my_sm_plugins.account = my_sm_plugins.account",
        ]
    }
)

Then we can install my_sm_plugins package and have security_monkey with our plugin available.