diff --git a/docs/dev/helpers/command.md b/docs/dev/helpers/command.md new file mode 100644 index 000000000..a3da89c08 --- /dev/null +++ b/docs/dev/helpers/command.md @@ -0,0 +1,13 @@ +# Command Helpers + +These are helpers related to executing shell commands. They are used throughout BBOT and its modules for executing various binaries such as `nmap`, `nuclei`, etc. + +Note that these helpers can be invoked directly from `self.helpers`, e.g.: + +```python +self.helpers.run("ls", "-l") +``` + +::: bbot.core.helpers.command + options: + show_root_heading: false diff --git a/docs/dev/helpers/dns.md b/docs/dev/helpers/dns.md new file mode 100644 index 000000000..5a51d6116 --- /dev/null +++ b/docs/dev/helpers/dns.md @@ -0,0 +1,19 @@ +# DNS + +These are helpers related to DNS resolution. They are used throughout BBOT and its modules for performing DNS lookups and detecting DNS wildcards, etc. + +Note that these helpers can be invoked directly from `self.helpers`, e.g.: + +```python +self.helpers.resolve("evilcorp.com") +``` + +::: bbot.core.helpers.dns.DNSHelper + handler: python + options: + members: + - resolve + - resolve_batch + - resolve_raw + - is_wildcard + - is_wildcard_domain diff --git a/docs/dev/helpers/interactsh.md b/docs/dev/helpers/interactsh.md new file mode 100644 index 000000000..5431e6337 --- /dev/null +++ b/docs/dev/helpers/interactsh.md @@ -0,0 +1,5 @@ +# Interact.sh + +::: bbot.core.helpers.interactsh.Interactsh + options: + show_root_heading: false diff --git a/docs/dev/helpers/web.md b/docs/dev/helpers/web.md new file mode 100644 index 000000000..b25f0e7ca --- /dev/null +++ b/docs/dev/helpers/web.md @@ -0,0 +1,15 @@ +# Web + +These are helpers for making various web requests. + +Note that these helpers can be invoked directly from `self.helpers`, e.g.: + +```python +self.helpers.request("https://www.evilcorp.com") +``` + +::: bbot.core.helpers.web + options: + show_root_heading: false + members: + - WebHelper diff --git a/docs/dev/helpers/wordcloud.md b/docs/dev/helpers/wordcloud.md new file mode 100644 index 000000000..cc2d6671c --- /dev/null +++ b/docs/dev/helpers/wordcloud.md @@ -0,0 +1,13 @@ +# Word Cloud + +These are helpers related to BBOT's Word Cloud, a mechanism for storing target-specific keywords that are useful for custom wordlists, etc. + +Note that these helpers can be invoked directly from `self.helpers`, e.g.: + +```python +self.helpers.word_cloud +``` + +::: bbot.core.helpers.wordcloud + options: + show_root_heading: false