better karton docstrings (#215)

artemis/modules/bruter.py

@@ -100,7 +100,8 @@ class BruterResult:
 
 class Bruter(ArtemisBase):
     """
-    Tries to find common URLs
+    Brute-forces common paths such as /index.php.bak. Tries commonly found paths on each target and experiments with random other paths
+    to dynamically update the common paths list.
     """
 
     identity = "bruter"

artemis/modules/crtsh.py

@@ -16,7 +16,7 @@
 class CrtshScanner(ArtemisBase):
     """
     Consumes `type: domain` and adds subdomains fetched from crt.sh
-    Produces `type: new`
+    Produces `type: domain`.
     """
 
     identity = "crtsh"

artemis/modules/directory_index.py

@@ -23,7 +23,7 @@
 
 class DirectoryIndex(ArtemisBase):
     """
-    Detects directory index enabled on the server
+    Detects directory index enabled on the server by checking paths mentioned in the home page source (e.g. with <link href="/styles/..." ...>).
     """
 
     identity = "directory_index"

artemis/modules/dns_scanner.py

@@ -17,7 +17,7 @@
 
 class DnsScanner(ArtemisBase):
     """
-    Check for AXFR and known bad nameservers
+    Check for domain transfer and known bad nameservers.
     """
 
     identity = "dns_scanner"

artemis/modules/ftp_bruter.py

@@ -30,7 +30,7 @@ class FTPBruterResult(BaseModel):
 
 class FTPBruter(ArtemisBase):
     """
-    Performs a brute force attack on FTP servers to guess login and password
+    Performs a brute force attack on FTP servers to guess login and password.
     """
 
     identity = "ftp_bruter"

artemis/modules/http_service_to_url.py

@@ -9,7 +9,8 @@
 
 class HTTPServiceToURL(ArtemisBase):
     """
-    Converts HTTP SERVICE tasks to URL tasks for the service root URL.
+    Converts HTTP SERVICE tasks to URL tasks for the service root URL so that the URLs can be consumed by other kartons
+    that expect URLs (e.g. Nuclei).
     """
 
     identity = "http_service_to_url"

artemis/modules/ip_lookup.py

@@ -8,7 +8,7 @@
 
 class IPLookup(ArtemisBase):
     """
-    Collects `type: domain`, performs IP lookup and produces `type: NEW`
+    Collects `type: domain`, performs IP lookup and produces `type: NEW`.
     """
 
     identity = "IPLookup"

artemis/modules/joomla_scanner.py

@@ -14,7 +14,7 @@
 
 class JoomlaScanner(ArtemisBase):
     """
-    Joomla scanner
+    Joomla scanner - checks whether the version is old or registration is enabled.
     """
 
     identity = "joomla_scanner"

artemis/modules/mail_dns_scanner.py

@@ -23,7 +23,7 @@ class MailDNSScannerResult(BaseModel):
 
 class MailDNSScanner(ArtemisBase):
     """
-    Checks if there is a mail server associated with the current domain and checks if SPF and DMARC records are present
+    Checks whether there is a mail server associated with the current domain and checks if SPF and DMARC records are present.
     """
 
     identity = "mail_dns_scanner"

artemis/modules/mysql_bruter.py

@@ -23,7 +23,7 @@ class MySQLBruterResult(BaseModel):
 
 class MySQLBruter(ArtemisBase):
     """
-    Performs a brute force attack on MySQL servers to guess login and password
+    Performs a brute force attack on MySQL servers to guess login and password.
     """
 
     identity = "mysql_bruter"

artemis/modules/php_lfi.py

@@ -33,7 +33,7 @@ def get_lfi_candidates(url: str, response_text: str) -> List[LFICandidate]:
 
 class PHPLFIScanner(ArtemisBase):
     """
-    Tries to detect and verify PHP LFI
+    Tries to detect and verify PHP LFI vulnerabilities.
     """
 
     identity = "php_lfi"

artemis/modules/port_scanner.py

@@ -68,8 +68,8 @@
 
 class PortScanner(ArtemisBase):
     """
-    Consumes `type: IP`, scans them with naabu and fingerprintx and produces
-    tasks separated into services (eg. `type: http`)
+    Consumes `type: IP` or `type: DOMAIN`, scans them with naabu and fingerprintx and produces
+    SERVICE tasks for each service detected on a port (eg. `type: http`).
     """
 
     # We want to scan domains (but maybe using cached results for given IP) so that if there

artemis/modules/postgresql_bruter.py

@@ -23,7 +23,7 @@ class PostgreSQLBruterResult(BaseModel):
 
 class PostgreSQLBruter(ArtemisBase):
     """
-    Performs a brute force attack on PostgreSQL servers to guess login and password
+    Performs a brute force attack on PostgreSQL servers to guess login and password.
     """
 
     identity = "postgresql_bruter"

artemis/modules/postman.py

@@ -26,8 +26,8 @@ class PostmanResult(BaseModel):
 
 class Postman(ArtemisBase):
     """
-    Collects `service: SMTP` and tests if it verifies credentials,
-    as well as trying out open relay.
+    Consumes `service: SMTP` tasks and tests if the server verifies credentials,
+    as well as whether it is an open relay.
     """
 
     identity = "postman"

artemis/modules/reverse_dns_lookup.py

@@ -12,7 +12,7 @@
 
 class ReverseDNSLookup(ArtemisBase):
     """
-    Collects `type: IP`, performs reverse DNS lookup and produces `type: NEW`
+    Collects `type: IP`, performs reverse DNS lookup and produces `type: NEW` tasks.
     """
 
     identity = "ReverseDNSLookup"

artemis/modules/robots.py

@@ -39,7 +39,7 @@ class RobotsResult:
 
 class RobotsScanner(ArtemisBase):
     """
-    Looks for robots.txt file and finds disallowed and allowed paths
+    Looks for robots.txt file, emits a URL task for each found path and checks whether the paths have a directory index enabled.
     """
 
     identity = "robots"

artemis/modules/shodan_vulns.py

@@ -55,7 +55,7 @@ class ShodanVulnsResult(BaseModel):
 
 class ShodanVulns(ArtemisBase):
     """
-    Lists vulns from shodan
+    Lists vulnerabilities from Shodan.
     """
 
     identity = "shodan_vulns"

artemis/modules/vcs.py

@@ -33,7 +33,7 @@ class VCSConfig(NamedTuple):
 
 class VCSScanner(ArtemisBase):
     """
-    Tries to find open git/svm/hg repositories
+    Tries to find exposed git/SVN/Mercurial repositories.
     """
 
     identity = "vcs"

artemis/modules/webapp_identifier.py

@@ -24,7 +24,7 @@
 
 class WebappIdentifier(ArtemisBase):
     """
-    Tries to identify the webapp
+    Tries to identify the web application and produces a WEBAPP task with proper type (e.g. WebApplication.WORDPRESS).
     """
 
     identity = "webapp_identifier"

artemis/modules/wordpress_bruter.py

@@ -25,7 +25,7 @@
 
 class WordPressBruter(ArtemisBase):
     """
-    Performs a brute force attack on WordPress credentials
+    Performs a brute-force attack on WordPress credentials.
     """
 
     identity = "wordpress_bruter"

artemis/modules/wp_scanner.py

@@ -12,7 +12,7 @@
 
 class WordPressScanner(ArtemisBase):
     """
-    WordPress scanner
+    WordPress scanner - checks e.g. whether the verson is secure or whether registration is enabled.
     """
 
     identity = "wp_scanner"