RomanNum3ral
/
AutoRecon
mirror of https://github.com/Tib3rius/AutoRecon.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated API Documentation (markdown)

Tib3rius 2021-08-30 00:18:32 -04:00
parent 7d5cea4f16
commit 60af451dfa
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
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