From 60af451dfaf1a06005ef96db533843826a73b61c Mon Sep 17 00:00:00 2001 From: Tib3rius <48113936+Tib3rius@users.noreply.github.com> Date: Mon, 30 Aug 2021 00:18:32 -0400 Subject: [PATCH] Updated API Documentation (markdown) --- API-Documentation.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/API-Documentation.md b/API-Documentation.md index a2f9230..65e5fe3 100644 --- a/API-Documentation.md +++ b/API-Documentation.md @@ -134,3 +134,26 @@ The `readline` method returns a single line from the CommandStream, or `None` if #### readlines() The `readlines` method returns all lines from the CommandStream, or an empty list if the stream has ended. This method will block until it can return something. +## Plugin + +The following attributes and methods are available to both PortScan and ServiceScan plugins. + +### Attributes + +#### disabled +The `disabled` attribute is a quick way to disable your plugin. Setting it to `True` means AutoRecon will not use it. + +#### name +The `name` attribute should be set to the name of the plugin (e.g. 'Nmap HTTP'). Simple is better. Must be unique. + +#### priority +The `priority` attribute is optional, and by default will be `1`. If set, it adjusts the priority of the plugin in the run sequence. A lower number means the plugin will be run before higher numbers. Negative and decimals are allowed. + +#### slug +The `slug` attribute is optional, as AutoRecon will generate a slug based on the `name` (e.g. 'Nmap HTTP' -> 'nmap-http'). If you don't like your slug, you can override it using this attribute. Simple is better. Must be unique. + +#### tags +The `tags` attribute is a list of tags that apply to the plugin. By default, the list is ['default']. If you want your plugin to run by default, you must include 'default' in the list if you override it. + +### Methods +