Refresh module docs

blacklanternsecurity · May 11, 2024 · faa7bd5 · faa7bd5
1 parent eb9c4bc
commit faa7bd5
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 49 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/modules/list_of_modules.md b/docs/modules/list_of_modules.md
@@ -73,6 +73,7 @@
 | git_clone            | scan     | No              | Clone code github repositories                                                                                                          | passive, safe, slow                                                            | CODE_REPOSITORY                                                                                                                         | FILESYSTEM                                                  |
 | github_codesearch    | scan     | Yes             | Query Github's API for code containing the target domain name                                                                           | passive, safe, subdomain-enum                                                  | DNS_NAME                                                                                                                                | CODE_REPOSITORY, URL_UNVERIFIED                             |
 | github_org           | scan     | No              | Query Github's API for organization and member repositories                                                                             | passive, safe, subdomain-enum                                                  | ORG_STUB, SOCIAL                                                                                                                        | CODE_REPOSITORY                                             |
+| github_workflows     | scan     | No              | Download a github repositories workflow logs                                                                                            | passive, safe                                                                  | CODE_REPOSITORY                                                                                                                         | FILESYSTEM                                                  |
 | hackertarget         | scan     | No              | Query the hackertarget.com API for subdomains                                                                                           | passive, safe, subdomain-enum                                                  | DNS_NAME                                                                                                                                | DNS_NAME                                                    |
 | hunterio             | scan     | Yes             | Query hunter.io for emails                                                                                                              | email-enum, passive, safe, subdomain-enum                                      | DNS_NAME                                                                                                                                | DNS_NAME, EMAIL_ADDRESS, URL_UNVERIFIED                     |
 | internetdb           | scan     | No              | Query Shodan's InternetDB for open ports, hostnames, technologies, and vulnerabilities                                                  | passive, portscan, safe, subdomain-enum                                        | DNS_NAME, IP_ADDRESS                                                                                                                    | DNS_NAME, FINDING, OPEN_TCP_PORT, TECHNOLOGY, VULNERABILITY |

diff --git a/docs/scanning/advanced.md b/docs/scanning/advanced.md
@@ -61,7 +61,7 @@ Target:
 
 Modules:
   -m MODULE [MODULE ...], --modules MODULE [MODULE ...]
-                        Modules to enable. Choices: affiliates,ajaxpro,anubisdb,asn,azure_realm,azure_tenant,baddns,baddns_zone,badsecrets,bevigil,binaryedge,bucket_amazon,bucket_azure,bucket_digitalocean,bucket_file_enum,bucket_firebase,bucket_google,builtwith,bypass403,c99,censys,certspotter,chaos,columbus,credshed,crobat,crt,dastardly,dehashed,digitorus,dnscommonsrv,dnsdumpster,docker_pull,dockerhub,dotnetnuke,emailformat,ffuf,ffuf_shortnames,filedownload,fingerprintx,fullhunt,generic_ssrf,git,git_clone,github_codesearch,github_org,gitlab,gowitness,hackertarget,host_header,httpx,hunt,hunterio,iis_shortnames,internetdb,ip2location,ipneighbor,ipstack,leakix,masscan,massdns,myssl,newsletters,nmap,ntlm,nuclei,oauth,otx,paramminer_cookies,paramminer_getparams,paramminer_headers,passivetotal,pgp,postman,rapiddns,riddler,robots,secretsdb,securitytrails,shodan_dns,sitedossier,skymem,smuggler,social,sslcert,subdomaincenter,sublist3r,telerik,threatminer,trufflehog,url_manipulation,urlscan,vhost,viewdns,virustotal,wafw00f,wappalyzer,wayback,zoomeye
+                        Modules to enable. Choices: affiliates,ajaxpro,anubisdb,asn,azure_realm,azure_tenant,baddns,baddns_zone,badsecrets,bevigil,binaryedge,bucket_amazon,bucket_azure,bucket_digitalocean,bucket_file_enum,bucket_firebase,bucket_google,builtwith,bypass403,c99,censys,certspotter,chaos,columbus,credshed,crobat,crt,dastardly,dehashed,digitorus,dnscommonsrv,dnsdumpster,docker_pull,dockerhub,dotnetnuke,emailformat,ffuf,ffuf_shortnames,filedownload,fingerprintx,fullhunt,generic_ssrf,git,git_clone,github_codesearch,github_org,github_workflows,gitlab,gowitness,hackertarget,host_header,httpx,hunt,hunterio,iis_shortnames,internetdb,ip2location,ipneighbor,ipstack,leakix,masscan,massdns,myssl,newsletters,nmap,ntlm,nuclei,oauth,otx,paramminer_cookies,paramminer_getparams,paramminer_headers,passivetotal,pgp,postman,rapiddns,riddler,robots,secretsdb,securitytrails,shodan_dns,sitedossier,skymem,smuggler,social,sslcert,subdomaincenter,sublist3r,telerik,threatminer,trufflehog,url_manipulation,urlscan,vhost,viewdns,virustotal,wafw00f,wappalyzer,wayback,zoomeye
   -l, --list-modules    List available modules.
   -em MODULE [MODULE ...], --exclude-modules MODULE [MODULE ...]
                         Exclude these modules.

diff --git a/docs/scanning/configuration.md b/docs/scanning/configuration.md
@@ -329,6 +329,8 @@ Many modules accept their own configuration options. These options have the abil
 | modules.github_org.api_key                     | str    | Github token                                                                                                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                   |
 | modules.github_org.include_member_repos        | bool   | Also enumerate organization members' repositories                                                                                                                                                                                                                                                                              | False                                                                                                                                                                                                                                                                                                                                                                             |
 | modules.github_org.include_members             | bool   | Enumerate organization members                                                                                                                                                                                                                                                                                                 | True                                                                                                                                                                                                                                                                                                                                                                              |
+| modules.github_workflows.api_key               | str    | Github token                                                                                                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                   |
+| modules.github_workflows.num_logs              | int    | For each workflow fetch the last N successful runs logs (max 100)                                                                                                                                                                                                                                                              | 1                                                                                                                                                                                                                                                                                                                                                                                 |
 | modules.hunterio.api_key                       | str    | Hunter.IO API key                                                                                                                                                                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                                                   |
 | modules.ip2location.api_key                    | str    | IP2location.io API Key                                                                                                                                                                                                                                                                                                         |                                                                                                                                                                                                                                                                                                                                                                                   |
 | modules.ip2location.lang                       | str    | Translation information(ISO639-1). The translation is only applicable for continent, country, region and city name.                                                                                                                                                                                                            |                                                                                                                                                                                                                                                                                                                                                                                   |