From b908beb3cff97a4b84141817077871a77fa75913 Mon Sep 17 00:00:00 2001 From: stephanie0x00 <9821756+stephanie0x00@users.noreply.github.com> Date: Thu, 26 Sep 2024 11:56:16 +0200 Subject: [PATCH] Add descriptions to katalogus (#3545) Co-authored-by: Jan Klopper Co-authored-by: ammar92 --- boefjes/boefjes/plugins/kat_adr_validator/normalizer.json | 2 +- boefjes/boefjes/plugins/kat_answer_parser/normalizer.json | 2 +- .../boefjes/plugins/kat_binaryedge/containers/normalizer.json | 1 + .../boefjes/plugins/kat_binaryedge/databases/normalizer.json | 1 + .../boefjes/plugins/kat_binaryedge/http_web/normalizer.json | 1 + .../plugins/kat_binaryedge/message_queues/normalizer.json | 1 + .../boefjes/plugins/kat_binaryedge/protocols/normalizer.json | 3 ++- .../plugins/kat_binaryedge/remote_desktop/normalizer.json | 1 + .../kat_binaryedge/service_identification/normalizer.json | 1 + .../boefjes/plugins/kat_binaryedge/services/normalizer.json | 1 + boefjes/boefjes/plugins/kat_censys/boefje.json | 2 +- boefjes/boefjes/plugins/kat_censys/normalizer.json | 1 + boefjes/boefjes/plugins/kat_cve_finding_types/boefje.json | 2 +- boefjes/boefjes/plugins/kat_cve_finding_types/normalizer.json | 2 +- boefjes/boefjes/plugins/kat_cwe_finding_types/boefje.json | 2 +- boefjes/boefjes/plugins/kat_cwe_finding_types/normalizer.json | 2 +- boefjes/boefjes/plugins/kat_dicom/normalizer.json | 2 +- boefjes/boefjes/plugins/kat_dns/normalizer.json | 2 +- boefjes/boefjes/plugins/kat_dns_version/normalizer.json | 1 + boefjes/boefjes/plugins/kat_dns_zone/boefje.json | 2 +- boefjes/boefjes/plugins/kat_dnssec/boefje.json | 2 +- boefjes/boefjes/plugins/kat_external_db/boefje.json | 2 +- boefjes/boefjes/plugins/kat_external_db/normalizer.json | 2 +- boefjes/boefjes/plugins/kat_fierce/boefje.json | 2 +- boefjes/boefjes/plugins/kat_finding_normalizer/normalizer.json | 1 + boefjes/boefjes/plugins/kat_kat_finding_types/boefje.json | 2 +- boefjes/boefjes/plugins/kat_manual/csv/normalizer.json | 1 + boefjes/boefjes/plugins/kat_masscan/boefje.json | 2 +- boefjes/boefjes/plugins/kat_nmap_ip_range/boefje.json | 2 +- boefjes/boefjes/plugins/kat_nmap_ports/boefje.json | 2 +- boefjes/boefjes/plugins/kat_nmap_tcp/normalizer.json | 1 + boefjes/boefjes/plugins/kat_nuclei_cve/boefje.json | 2 +- boefjes/boefjes/plugins/kat_nuclei_cve/normalizer.json | 1 + boefjes/boefjes/plugins/kat_nuclei_exposed_panels/boefje.json | 2 +- .../boefjes/plugins/kat_nuclei_exposed_panels/normalizer.json | 1 + boefjes/boefjes/plugins/kat_nuclei_take_over/boefje.json | 2 +- boefjes/boefjes/plugins/kat_nuclei_take_over/normalizer.json | 1 + boefjes/boefjes/plugins/kat_rdns/boefje.json | 2 +- boefjes/boefjes/plugins/kat_rdns/normalizer.json | 3 ++- boefjes/boefjes/plugins/kat_report_data/normalizer.json | 1 + boefjes/boefjes/plugins/kat_retirejs_finding_types/boefje.json | 2 +- .../boefjes/plugins/kat_retirejs_finding_types/normalizer.json | 1 + boefjes/boefjes/plugins/kat_rpki/boefje.json | 2 +- boefjes/boefjes/plugins/kat_rpki/normalizer.json | 1 + .../boefjes/plugins/kat_security_txt_downloader/boefje.json | 2 +- .../plugins/kat_security_txt_downloader/normalizer.json | 1 + boefjes/boefjes/plugins/kat_service_banner/boefje.json | 2 +- boefjes/boefjes/plugins/kat_shodan/boefje.json | 2 +- boefjes/boefjes/plugins/kat_shodan/normalizer.json | 1 + boefjes/boefjes/plugins/kat_snyk/boefje.json | 2 +- boefjes/boefjes/plugins/kat_snyk/normalizer.json | 1 + boefjes/boefjes/plugins/kat_snyk_finding_types/boefje.json | 2 +- boefjes/boefjes/plugins/kat_snyk_finding_types/normalizer.json | 1 + boefjes/boefjes/plugins/kat_ssl_certificates/boefje.json | 2 +- boefjes/boefjes/plugins/kat_ssl_certificates/normalizer.json | 1 + boefjes/boefjes/plugins/kat_ssl_scan/boefje.json | 2 +- boefjes/boefjes/plugins/kat_ssl_scan/normalizer.json | 1 + boefjes/boefjes/plugins/kat_testssl_sh_ciphers/boefje.json | 2 +- boefjes/boefjes/plugins/kat_testssl_sh_ciphers/normalizer.json | 1 + boefjes/boefjes/plugins/kat_wappalyzer/normalizer.json | 1 + .../plugins/kat_webpage_analysis/check_images/normalizer.json | 3 ++- .../kat_webpage_analysis/find_images_in_html/normalizer.json | 1 + .../plugins/kat_webpage_analysis/headers/normalizer.json | 1 + boefjes/boefjes/plugins/kat_webpage_capture/boefje.json | 2 +- boefjes/boefjes/plugins/kat_wpscan/boefje.json | 2 +- boefjes/boefjes/plugins/kat_wpscan/normalizer.json | 1 + 66 files changed, 69 insertions(+), 37 deletions(-) diff --git a/boefjes/boefjes/plugins/kat_adr_validator/normalizer.json b/boefjes/boefjes/plugins/kat_adr_validator/normalizer.json index f840cded2ad..d342474d1e8 100644 --- a/boefjes/boefjes/plugins/kat_adr_validator/normalizer.json +++ b/boefjes/boefjes/plugins/kat_adr_validator/normalizer.json @@ -1,7 +1,7 @@ { "id": "adr-validator-normalize", "name": "API Design Rules validator", - "description": "TODO", + "description": "Parses and validates the API Design Rules (ADR). https://www.forumstandaardisatie.nl/open-standaarden/rest-api-design-rules", "consumes": [ "boefje/adr-validator" ], diff --git a/boefjes/boefjes/plugins/kat_answer_parser/normalizer.json b/boefjes/boefjes/plugins/kat_answer_parser/normalizer.json index 922b333697f..e10ab9a92c6 100644 --- a/boefjes/boefjes/plugins/kat_answer_parser/normalizer.json +++ b/boefjes/boefjes/plugins/kat_answer_parser/normalizer.json @@ -1,7 +1,7 @@ { "id": "kat_answer_parser", "name": "Answer Parser", - "description": "Parses the answers from Config objects.", + "description": "Parses the answers from 'Config' objects. Config OOIs are used when your policies and objects need different treatment from the usual setup.", "consumes": [ "answer" ], diff --git a/boefjes/boefjes/plugins/kat_binaryedge/containers/normalizer.json b/boefjes/boefjes/plugins/kat_binaryedge/containers/normalizer.json index 086ce350160..288b50127c7 100644 --- a/boefjes/boefjes/plugins/kat_binaryedge/containers/normalizer.json +++ b/boefjes/boefjes/plugins/kat_binaryedge/containers/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_binaryedge_containers", "name": "BinaryEdge containers", + "description": "Parse BinaryEdge data to check if Kubernetes hosts have any vulnerabilities. Creates 'VERIFIED-VULNERABILITY' findings.", "consumes": [ "boefje/binaryedge" ], diff --git a/boefjes/boefjes/plugins/kat_binaryedge/databases/normalizer.json b/boefjes/boefjes/plugins/kat_binaryedge/databases/normalizer.json index 2af3f47f891..d2336234281 100644 --- a/boefjes/boefjes/plugins/kat_binaryedge/databases/normalizer.json +++ b/boefjes/boefjes/plugins/kat_binaryedge/databases/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_binaryedge_databases", "name": "BinaryEdge databases", + "description": "Parses BinaryEdge data to check if any Cassandra, ElasticSearch, Memcached, MongoDB and Redis servers are identified and parses the version number. Create 'EXPOSED-SOFTWARE' findings.", "consumes": [ "boefje/binaryedge" ], diff --git a/boefjes/boefjes/plugins/kat_binaryedge/http_web/normalizer.json b/boefjes/boefjes/plugins/kat_binaryedge/http_web/normalizer.json index f5cafc7560a..03f77c3fe73 100644 --- a/boefjes/boefjes/plugins/kat_binaryedge/http_web/normalizer.json +++ b/boefjes/boefjes/plugins/kat_binaryedge/http_web/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_binaryedge_http_web", "name": "BinaryEdge Websites", + "description": "Parses BinaryEdge data to check for AWS secrets, F5 BIG IP loadbalancers and Citrix NetScaler.", "consumes": [ "boefje/binaryedge" ], diff --git a/boefjes/boefjes/plugins/kat_binaryedge/message_queues/normalizer.json b/boefjes/boefjes/plugins/kat_binaryedge/message_queues/normalizer.json index caa59b56f4b..3953e6f9b13 100644 --- a/boefjes/boefjes/plugins/kat_binaryedge/message_queues/normalizer.json +++ b/boefjes/boefjes/plugins/kat_binaryedge/message_queues/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_binaryedge_message_queues", "name": "BinaryEdge message queues", + "description": "Parses BinaryEdge data to check for message queues (mqtt) servers. Creates the finding 'EXPOSED-SOFTWARE' if mqtt servers are found.", "consumes": [ "boefje/binaryedge" ], diff --git a/boefjes/boefjes/plugins/kat_binaryedge/protocols/normalizer.json b/boefjes/boefjes/plugins/kat_binaryedge/protocols/normalizer.json index 30d0f02963e..f6e89f9fb3d 100644 --- a/boefjes/boefjes/plugins/kat_binaryedge/protocols/normalizer.json +++ b/boefjes/boefjes/plugins/kat_binaryedge/protocols/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_binaryedge_protocols", - "name": "BinaryEdge protocols", + "name": "BinaryEdge SSL/TLS protocols", + "description": "Parses BinaryEdge data to check for various vulnerabilities within SSL/TLS protocols, such as Heartbleed, Secure Renegotiation and SSL Compression.", "consumes": [ "boefje/binaryedge" ], diff --git a/boefjes/boefjes/plugins/kat_binaryedge/remote_desktop/normalizer.json b/boefjes/boefjes/plugins/kat_binaryedge/remote_desktop/normalizer.json index 80e1837a499..5cc15031b65 100644 --- a/boefjes/boefjes/plugins/kat_binaryedge/remote_desktop/normalizer.json +++ b/boefjes/boefjes/plugins/kat_binaryedge/remote_desktop/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_binaryedge_remote_desktop", "name": "Binary Edge remote desktop", + "description": "Parses BinaryEdge data to check for remote desktop services such as RDP, VNC and X11. Creates 'EXPOSED-SOFTWARE' findings.", "consumes": [ "boefje/binaryedge" ], diff --git a/boefjes/boefjes/plugins/kat_binaryedge/service_identification/normalizer.json b/boefjes/boefjes/plugins/kat_binaryedge/service_identification/normalizer.json index d451a79b150..dc92d458b6c 100644 --- a/boefjes/boefjes/plugins/kat_binaryedge/service_identification/normalizer.json +++ b/boefjes/boefjes/plugins/kat_binaryedge/service_identification/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_binaryedge_service_identification", "name": "BinaryEdge service identification", + "description": "Parses BinaryEdge data to check if Software is present that is known for malware.", "consumes": [ "boefje/binaryedge" ], diff --git a/boefjes/boefjes/plugins/kat_binaryedge/services/normalizer.json b/boefjes/boefjes/plugins/kat_binaryedge/services/normalizer.json index 57a0f8dac16..89b0b22c057 100644 --- a/boefjes/boefjes/plugins/kat_binaryedge/services/normalizer.json +++ b/boefjes/boefjes/plugins/kat_binaryedge/services/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_binaryedge_services", "name": "BinaryEdge services", + "description": "Parses BinaryEdge data to check for services such as SSH, rsync, FTP, telnet and SMB.", "consumes": [ "boefje/binaryedge" ], diff --git a/boefjes/boefjes/plugins/kat_censys/boefje.json b/boefjes/boefjes/plugins/kat_censys/boefje.json index ef6c3ab9a67..034d79a0034 100644 --- a/boefjes/boefjes/plugins/kat_censys/boefje.json +++ b/boefjes/boefjes/plugins/kat_censys/boefje.json @@ -1,7 +1,7 @@ { "id": "censys", "name": "Censys", - "description": "Use Censys to discover open ports, services and certificates. Requires and API key.", + "description": "Use Censys to discover open ports, services and certificates. Requires an API key.", "consumes": [ "IPAddressV4", "IPAddressV6" diff --git a/boefjes/boefjes/plugins/kat_censys/normalizer.json b/boefjes/boefjes/plugins/kat_censys/normalizer.json index 809fc7d7174..c160577458c 100644 --- a/boefjes/boefjes/plugins/kat_censys/normalizer.json +++ b/boefjes/boefjes/plugins/kat_censys/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_censys_normalize", "name": "Censys", + "description": "Parses Cencys data into objects that can be used by other boefjes and normalizers. Can create ports, certificates, software, websites and headers. Doesn't create findings.", "consumes": [ "boefje/censys" ], diff --git a/boefjes/boefjes/plugins/kat_cve_finding_types/boefje.json b/boefjes/boefjes/plugins/kat_cve_finding_types/boefje.json index f1315d93c33..ee0be42b6e5 100644 --- a/boefjes/boefjes/plugins/kat_cve_finding_types/boefje.json +++ b/boefjes/boefjes/plugins/kat_cve_finding_types/boefje.json @@ -1,7 +1,7 @@ { "id": "cve-finding-types", "name": "CVE Finding Types", - "description": "Hydrate information of Common Vulnerabilities and Exposures (CVE) finding types from the CVE API", + "description": "Hydrate information of Common Vulnerabilities and Exposures (CVE) finding types from the CVE API.", "consumes": [ "CVEFindingType" ], diff --git a/boefjes/boefjes/plugins/kat_cve_finding_types/normalizer.json b/boefjes/boefjes/plugins/kat_cve_finding_types/normalizer.json index 6ae5590562d..31d217e7658 100644 --- a/boefjes/boefjes/plugins/kat_cve_finding_types/normalizer.json +++ b/boefjes/boefjes/plugins/kat_cve_finding_types/normalizer.json @@ -1,7 +1,7 @@ { "id": "kat_cve_finding_types_normalize", "name": "CVE finding types", - "description": "Parses CVE findings.", + "description": "Parses Common Vulnerability Exposures (CVE) into findings.", "consumes": [ "boefje/cve-finding-types" ], diff --git a/boefjes/boefjes/plugins/kat_cwe_finding_types/boefje.json b/boefjes/boefjes/plugins/kat_cwe_finding_types/boefje.json index abeeaa7d9d0..edcc6cae7c7 100644 --- a/boefjes/boefjes/plugins/kat_cwe_finding_types/boefje.json +++ b/boefjes/boefjes/plugins/kat_cwe_finding_types/boefje.json @@ -1,7 +1,7 @@ { "id": "cwe-finding-types", "name": "CWE Finding Types", - "description": "Hydrate information of Common Weakness Enumeration (CWE) finding types", + "description": "Hydrate information of Common Weakness Enumeration (CWE) finding types.", "consumes": [ "CWEFindingType" ], diff --git a/boefjes/boefjes/plugins/kat_cwe_finding_types/normalizer.json b/boefjes/boefjes/plugins/kat_cwe_finding_types/normalizer.json index 9b939d07df5..2b97ac2d404 100644 --- a/boefjes/boefjes/plugins/kat_cwe_finding_types/normalizer.json +++ b/boefjes/boefjes/plugins/kat_cwe_finding_types/normalizer.json @@ -1,7 +1,7 @@ { "id": "kat_cwe_finding_types_normalize", "name": "CWE finding", - "description": "Parses CWE findings.", + "description": "Parses Common Weakness Enumeration (CWE) into findings.", "consumes": [ "boefje/cwe-finding-types" ], diff --git a/boefjes/boefjes/plugins/kat_dicom/normalizer.json b/boefjes/boefjes/plugins/kat_dicom/normalizer.json index 74519e6e96c..f829c80bced 100644 --- a/boefjes/boefjes/plugins/kat_dicom/normalizer.json +++ b/boefjes/boefjes/plugins/kat_dicom/normalizer.json @@ -1,7 +1,7 @@ { "id": "kat_dicom_normalize", "name": "DICOM servers", - "description": "Parses DICOM output into findings and identified software.", + "description": "Parses medical imaging data (DICOM) into findings and identified software.", "consumes": [ "boefje/dicom" ], diff --git a/boefjes/boefjes/plugins/kat_dns/normalizer.json b/boefjes/boefjes/plugins/kat_dns/normalizer.json index fa9c8a73fa6..a534d08e04b 100644 --- a/boefjes/boefjes/plugins/kat_dns/normalizer.json +++ b/boefjes/boefjes/plugins/kat_dns/normalizer.json @@ -1,7 +1,7 @@ { "id": "kat_dns_normalize", "name": "DNS records", - "description": "Parses the DNS records.", + "description": "Parses DNS records. Can parse A, AAAA, CAA, CNAME, MX, NS, SOA, TXT, DKIM and DMARC data.", "consumes": [ "boefje/dns-records" ], diff --git a/boefjes/boefjes/plugins/kat_dns_version/normalizer.json b/boefjes/boefjes/plugins/kat_dns_version/normalizer.json index 4bd2cad202f..1ee372c81f5 100644 --- a/boefjes/boefjes/plugins/kat_dns_version/normalizer.json +++ b/boefjes/boefjes/plugins/kat_dns_version/normalizer.json @@ -1,6 +1,7 @@ { "id": "dns-bind-version-normalize", "name": "DNS bind version normalizer", + "description": "Parses DNS Bind data into Software version objects.", "consumes": [ "boefje/dns-bind-version" ], diff --git a/boefjes/boefjes/plugins/kat_dns_zone/boefje.json b/boefjes/boefjes/plugins/kat_dns_zone/boefje.json index cc03e079bd1..04fd37c4826 100644 --- a/boefjes/boefjes/plugins/kat_dns_zone/boefje.json +++ b/boefjes/boefjes/plugins/kat_dns_zone/boefje.json @@ -1,7 +1,7 @@ { "id": "dns-zone", "name": "DNS zone", - "description": "Fetch the parent DNS zone of a DNS zone", + "description": "Fetch the parent DNS zone of a DNS zone.", "consumes": [ "DNSZone" ], diff --git a/boefjes/boefjes/plugins/kat_dnssec/boefje.json b/boefjes/boefjes/plugins/kat_dnssec/boefje.json index 8b4d156396e..a772cbb6cf0 100644 --- a/boefjes/boefjes/plugins/kat_dnssec/boefje.json +++ b/boefjes/boefjes/plugins/kat_dnssec/boefje.json @@ -1,7 +1,7 @@ { "id": "dns-sec", "name": "DNSSEC", - "description": "Validates DNSSec of a hostname", + "description": "Validates DNSSEC of a hostname by checking the cryptographic signatures.", "consumes": [ "Hostname" ], diff --git a/boefjes/boefjes/plugins/kat_external_db/boefje.json b/boefjes/boefjes/plugins/kat_external_db/boefje.json index cbf7ee0c927..da2043f7db9 100644 --- a/boefjes/boefjes/plugins/kat_external_db/boefje.json +++ b/boefjes/boefjes/plugins/kat_external_db/boefje.json @@ -1,7 +1,7 @@ { "id": "external_db", "name": "External database host fetcher", - "description": "Fetch hostnames and IP addresses/netblocks from an external database with API. See `description.md` for more information. Useful if you have a large network.", + "description": "Fetch hostnames and IP addresses/netblocks from an external database with API. See `description.md` for more information. Useful if you have a large network and wish to add all your hosts. You can also upload hosts through the CSV upload functionality.", "consumes": [ "Network" ], diff --git a/boefjes/boefjes/plugins/kat_external_db/normalizer.json b/boefjes/boefjes/plugins/kat_external_db/normalizer.json index 2d9e72d56e9..9988c541f68 100644 --- a/boefjes/boefjes/plugins/kat_external_db/normalizer.json +++ b/boefjes/boefjes/plugins/kat_external_db/normalizer.json @@ -1,7 +1,7 @@ { "id": "kat_external_db_normalize", "name": "External database hosts fetcher", - "description": "Parse data the fetched host data from the external database into hostnames and IP-addresses.", + "description": "Parse the fetched host data from the external database into hostnames and IP-addresses.", "consumes": [ "boefje/external_db" ], diff --git a/boefjes/boefjes/plugins/kat_fierce/boefje.json b/boefjes/boefjes/plugins/kat_fierce/boefje.json index 1f7d5c677db..9e1ab8182ef 100644 --- a/boefjes/boefjes/plugins/kat_fierce/boefje.json +++ b/boefjes/boefjes/plugins/kat_fierce/boefje.json @@ -1,7 +1,7 @@ { "id": "fierce", "name": "Fierce", - "description": "Perform DNS reconnaissance using Fierce, to help locate non-contiguous IP space and hostnames against specified hostnames. No exploitation is performed.", + "description": "Perform DNS reconnaissance using Fierce. Helps to locate non-contiguous IP space and hostnames against specified hostnames. No exploitation is performed.", "consumes": [ "Hostname" ], diff --git a/boefjes/boefjes/plugins/kat_finding_normalizer/normalizer.json b/boefjes/boefjes/plugins/kat_finding_normalizer/normalizer.json index 70adfd46c47..2acc3c9c210 100644 --- a/boefjes/boefjes/plugins/kat_finding_normalizer/normalizer.json +++ b/boefjes/boefjes/plugins/kat_finding_normalizer/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_generic_finding_normalize", "name": "Finding types", + "description": "Parses data to create (CVE) Findings.", "consumes": [ "openkat/finding" ], diff --git a/boefjes/boefjes/plugins/kat_kat_finding_types/boefje.json b/boefjes/boefjes/plugins/kat_kat_finding_types/boefje.json index 559724289f9..e653f45622d 100644 --- a/boefjes/boefjes/plugins/kat_kat_finding_types/boefje.json +++ b/boefjes/boefjes/plugins/kat_kat_finding_types/boefje.json @@ -1,7 +1,7 @@ { "id": "kat-finding-types", "name": "KAT Finding Types", - "description": "Hydrate information of KAT finding types", + "description": "Hydrate information of KAT finding types.", "consumes": [ "KATFindingType" ], diff --git a/boefjes/boefjes/plugins/kat_manual/csv/normalizer.json b/boefjes/boefjes/plugins/kat_manual/csv/normalizer.json index e20641f2459..fa44dd9b9d5 100644 --- a/boefjes/boefjes/plugins/kat_manual/csv/normalizer.json +++ b/boefjes/boefjes/plugins/kat_manual/csv/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_manual_csv", "name": "Manual CSV", + "description": "Parses uploaded CSV files into objects.", "consumes": [ "manual/csv" ], diff --git a/boefjes/boefjes/plugins/kat_masscan/boefje.json b/boefjes/boefjes/plugins/kat_masscan/boefje.json index fbdc03a6093..6456bb5d8bf 100644 --- a/boefjes/boefjes/plugins/kat_masscan/boefje.json +++ b/boefjes/boefjes/plugins/kat_masscan/boefje.json @@ -1,7 +1,7 @@ { "id": "masscan", "name": "masscan", - "description": "Quickly scan large amounts of IPs.", + "description": "Quickly scan large amounts of IPs. Due to the quick scanning it may not always show accurate results.", "consumes": [ "IPV4NetBlock" ], diff --git a/boefjes/boefjes/plugins/kat_nmap_ip_range/boefje.json b/boefjes/boefjes/plugins/kat_nmap_ip_range/boefje.json index fe3baf38eb7..a266db549ae 100644 --- a/boefjes/boefjes/plugins/kat_nmap_ip_range/boefje.json +++ b/boefjes/boefjes/plugins/kat_nmap_ip_range/boefje.json @@ -1,7 +1,7 @@ { "id": "nmap-ip-range", "name": "Nmap IP range", - "description": "Scan an IP range and store found IPs. Defaults to top-250 TCP and top-10 UDP on ranges with 1024 addresses or less. Larger ranges are skipped by default.", + "description": "Scan an IP range and store found IPs. Defaults to top-250 TCP and top-10 UDP on ranges with 1024 addresses or less (max is a /22). Larger ranges are skipped by default.", "consumes": [ "IPV6NetBlock", "IPV4NetBlock" diff --git a/boefjes/boefjes/plugins/kat_nmap_ports/boefje.json b/boefjes/boefjes/plugins/kat_nmap_ports/boefje.json index 87fdb592a06..667852d2be2 100644 --- a/boefjes/boefjes/plugins/kat_nmap_ports/boefje.json +++ b/boefjes/boefjes/plugins/kat_nmap_ports/boefje.json @@ -1,7 +1,7 @@ { "id": "nmap-ports", "name": "Nmap Ports", - "description": "Scan a specific set of ports including service detection", + "description": "Scan a specific set of ports including service detection.", "consumes": [ "IPAddressV4", "IPAddressV6" diff --git a/boefjes/boefjes/plugins/kat_nmap_tcp/normalizer.json b/boefjes/boefjes/plugins/kat_nmap_tcp/normalizer.json index ae7e2db0145..a5167131d2c 100644 --- a/boefjes/boefjes/plugins/kat_nmap_tcp/normalizer.json +++ b/boefjes/boefjes/plugins/kat_nmap_tcp/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_nmap_normalize", "name": "nmap", + "description": "Parses data from all nmap variants into IP-addresses, ports and services.", "consumes": [ "boefje/nmap", "boefje/nmap-udp", diff --git a/boefjes/boefjes/plugins/kat_nuclei_cve/boefje.json b/boefjes/boefjes/plugins/kat_nuclei_cve/boefje.json index d547b8c5359..2b37e26d6a5 100644 --- a/boefjes/boefjes/plugins/kat_nuclei_cve/boefje.json +++ b/boefjes/boefjes/plugins/kat_nuclei_cve/boefje.json @@ -1,7 +1,7 @@ { "id": "nuclei-cve", "name": "Nuclei CVE scan", - "description": "Nuclei is used to send requests across targets based on a template, providing fast scanning. (CVE scanning)", + "description": "Nuclei is used to send requests across targets based on a template, providing fast scanning. (CVE scanning).", "consumes": [ "Hostname", "HostnameHTTPURL" diff --git a/boefjes/boefjes/plugins/kat_nuclei_cve/normalizer.json b/boefjes/boefjes/plugins/kat_nuclei_cve/normalizer.json index e096426fa1f..035bcd3eef5 100644 --- a/boefjes/boefjes/plugins/kat_nuclei_cve/normalizer.json +++ b/boefjes/boefjes/plugins/kat_nuclei_cve/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_nuclei_cve_normalize", "name": "Nuclei CVE", + "description": "Parses Nuclei CVE data into findings.", "consumes": [ "boefje/nuclei-cve" ], diff --git a/boefjes/boefjes/plugins/kat_nuclei_exposed_panels/boefje.json b/boefjes/boefjes/plugins/kat_nuclei_exposed_panels/boefje.json index 1b5f62387bf..f4c2c5061df 100644 --- a/boefjes/boefjes/plugins/kat_nuclei_exposed_panels/boefje.json +++ b/boefjes/boefjes/plugins/kat_nuclei_exposed_panels/boefje.json @@ -1,7 +1,7 @@ { "id": "nuclei-exposed-panels", "name": "Nuclei Exposed panels", - "description": "Nuclei is used to send requests across targets based on a template, providing fast scanning. (Exposed panels)", + "description": "Nuclei is used to send requests across targets based on a template, providing fast scanning. Can be used to find specific exposed administrative panels in your network.", "consumes": [ "Hostname", "HostnameHTTPURL" diff --git a/boefjes/boefjes/plugins/kat_nuclei_exposed_panels/normalizer.json b/boefjes/boefjes/plugins/kat_nuclei_exposed_panels/normalizer.json index d26c4f40239..addf8888438 100644 --- a/boefjes/boefjes/plugins/kat_nuclei_exposed_panels/normalizer.json +++ b/boefjes/boefjes/plugins/kat_nuclei_exposed_panels/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_nuclei_exposed_panels_normalize", "name": "Nuclei exposed admin panels", + "description": "Parses Nuclei of exposed panels into findings.", "consumes": [ "boefje/nuclei-exposed-panels" ], diff --git a/boefjes/boefjes/plugins/kat_nuclei_take_over/boefje.json b/boefjes/boefjes/plugins/kat_nuclei_take_over/boefje.json index d1bb332eb93..c420b0a1554 100644 --- a/boefjes/boefjes/plugins/kat_nuclei_take_over/boefje.json +++ b/boefjes/boefjes/plugins/kat_nuclei_take_over/boefje.json @@ -1,7 +1,7 @@ { "id": "nuclei-takeover", "name": "Nuclei takeover scan", - "description": "Nuclei is used to send requests across targets based on a template, providing fast scanning.(sub-domain takeover)", + "description": "Nuclei is used to send requests across targets based on a template, providing fast scanning. This will try to perform a sub sub-domain takeover.", "consumes": [ "Hostname", "HostnameHTTPURL" diff --git a/boefjes/boefjes/plugins/kat_nuclei_take_over/normalizer.json b/boefjes/boefjes/plugins/kat_nuclei_take_over/normalizer.json index c9937b46e50..ff067686f4f 100644 --- a/boefjes/boefjes/plugins/kat_nuclei_take_over/normalizer.json +++ b/boefjes/boefjes/plugins/kat_nuclei_take_over/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_nuclei_takeover_normalize", "name": "Nuclei takeover", + "description": "Parses Nuclei takeover data into findings.", "consumes": [ "boefje/nuclei-takeover" ], diff --git a/boefjes/boefjes/plugins/kat_rdns/boefje.json b/boefjes/boefjes/plugins/kat_rdns/boefje.json index 44b486f04fe..a838a103061 100644 --- a/boefjes/boefjes/plugins/kat_rdns/boefje.json +++ b/boefjes/boefjes/plugins/kat_rdns/boefje.json @@ -1,7 +1,7 @@ { "id": "rdns", "name": "Reverse DNS", - "description": "Resolve IP addresses to a hostname", + "description": "Resolve IP addresses to a hostname.", "consumes": [ "IPAddressV4", "IPAddressV6" diff --git a/boefjes/boefjes/plugins/kat_rdns/normalizer.json b/boefjes/boefjes/plugins/kat_rdns/normalizer.json index 2e1e99a15bb..c0dfa4a4e8f 100644 --- a/boefjes/boefjes/plugins/kat_rdns/normalizer.json +++ b/boefjes/boefjes/plugins/kat_rdns/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_rdns_normalize", - "name": "RDNS", + "name": "Reverse DNS", + "description": "Parses reverse DNS data into PTR records.", "consumes": [ "boefje/rdns" ], diff --git a/boefjes/boefjes/plugins/kat_report_data/normalizer.json b/boefjes/boefjes/plugins/kat_report_data/normalizer.json index 01927fd0753..9c3d0e17bdb 100644 --- a/boefjes/boefjes/plugins/kat_report_data/normalizer.json +++ b/boefjes/boefjes/plugins/kat_report_data/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_report_data", "name": "Report data", + "description": "Parses (uploaded) report data to create reports.", "consumes": [ "openkat/report-data" ], diff --git a/boefjes/boefjes/plugins/kat_retirejs_finding_types/boefje.json b/boefjes/boefjes/plugins/kat_retirejs_finding_types/boefje.json index d7957dcae2f..d8be8eca744 100644 --- a/boefjes/boefjes/plugins/kat_retirejs_finding_types/boefje.json +++ b/boefjes/boefjes/plugins/kat_retirejs_finding_types/boefje.json @@ -1,7 +1,7 @@ { "id": "retirejs-finding-types", "name": "RetireJS Finding Types", - "description": "Hydrate information of RetireJS finding types", + "description": "Hydrate information of RetireJS finding types.", "consumes": [ "RetireJSFindingType" ], diff --git a/boefjes/boefjes/plugins/kat_retirejs_finding_types/normalizer.json b/boefjes/boefjes/plugins/kat_retirejs_finding_types/normalizer.json index 40e1bbbf235..e525365378c 100644 --- a/boefjes/boefjes/plugins/kat_retirejs_finding_types/normalizer.json +++ b/boefjes/boefjes/plugins/kat_retirejs_finding_types/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_retirejs_finding_types_normalize", "name": "RetireJS finding types", + "description": "Parses RetireJS data into findings.", "consumes": [ "boefje/retirejs-finding-types" ], diff --git a/boefjes/boefjes/plugins/kat_rpki/boefje.json b/boefjes/boefjes/plugins/kat_rpki/boefje.json index edbd65b28b8..dc31c0fd354 100644 --- a/boefjes/boefjes/plugins/kat_rpki/boefje.json +++ b/boefjes/boefjes/plugins/kat_rpki/boefje.json @@ -1,7 +1,7 @@ { "id": "rpki", "name": "RPKI", - "description": "Check if an IPv4 or IPv6 address has a valid VRPS record.", + "description": "Check BGP announcements to see if an IPv4 or IPv6 address has Validated ROA Payload (VRPs).", "consumes": [ "IPAddressV4", "IPAddressV6" diff --git a/boefjes/boefjes/plugins/kat_rpki/normalizer.json b/boefjes/boefjes/plugins/kat_rpki/normalizer.json index 59c5567e427..488e23ecafe 100644 --- a/boefjes/boefjes/plugins/kat_rpki/normalizer.json +++ b/boefjes/boefjes/plugins/kat_rpki/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_rpki_normalize", "name": "RPKI", + "description": "Parses RPKI data into findings.", "consumes": [ "rpki/results" ], diff --git a/boefjes/boefjes/plugins/kat_security_txt_downloader/boefje.json b/boefjes/boefjes/plugins/kat_security_txt_downloader/boefje.json index ff83f57ff5e..3f0e3452478 100644 --- a/boefjes/boefjes/plugins/kat_security_txt_downloader/boefje.json +++ b/boefjes/boefjes/plugins/kat_security_txt_downloader/boefje.json @@ -1,7 +1,7 @@ { "id": "security_txt_downloader", "name": "Security.txt downloader", - "description": "Downloads the security.txt file from the target host.", + "description": "Downloads the security.txt file from the target website to check if it contains all the required elements.", "consumes": [ "Website" ], diff --git a/boefjes/boefjes/plugins/kat_security_txt_downloader/normalizer.json b/boefjes/boefjes/plugins/kat_security_txt_downloader/normalizer.json index 01d20c7a895..a5dad882aec 100644 --- a/boefjes/boefjes/plugins/kat_security_txt_downloader/normalizer.json +++ b/boefjes/boefjes/plugins/kat_security_txt_downloader/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_sec_txt_downloader_normalize", "name": "Security.txt downloader", + "description": "Parses the downloaded security.txt data from a website.", "consumes": [ "boefje/security_txt_downloader" ], diff --git a/boefjes/boefjes/plugins/kat_service_banner/boefje.json b/boefjes/boefjes/plugins/kat_service_banner/boefje.json index 6319afe8c94..8a04b669a3f 100644 --- a/boefjes/boefjes/plugins/kat_service_banner/boefje.json +++ b/boefjes/boefjes/plugins/kat_service_banner/boefje.json @@ -1,7 +1,7 @@ { "id": "service_banner", "name": "Service banner download", - "description": "Downloads service banners from the target hosts", + "description": "Downloads service banners from the target hosts.", "consumes": [ "IPPort" ], diff --git a/boefjes/boefjes/plugins/kat_shodan/boefje.json b/boefjes/boefjes/plugins/kat_shodan/boefje.json index c1309e7e1ac..240e065da2c 100644 --- a/boefjes/boefjes/plugins/kat_shodan/boefje.json +++ b/boefjes/boefjes/plugins/kat_shodan/boefje.json @@ -1,7 +1,7 @@ { "id": "shodan", "name": "Shodan", - "description": "Use Shodan to find open ports with vulnerabilities that are found on that port", + "description": "Use Shodan to find open ports with vulnerabilities that are found on that port. Requires an API key.", "consumes": [ "IPAddressV4", "IPAddressV6" diff --git a/boefjes/boefjes/plugins/kat_shodan/normalizer.json b/boefjes/boefjes/plugins/kat_shodan/normalizer.json index 76f7798a49a..eb1b4376d8a 100644 --- a/boefjes/boefjes/plugins/kat_shodan/normalizer.json +++ b/boefjes/boefjes/plugins/kat_shodan/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_shodan_normalize", "name": "Shodan", + "description": "Parses Shodan data into (CVE) findings and ports.", "consumes": [ "boefje/shodan" ], diff --git a/boefjes/boefjes/plugins/kat_snyk/boefje.json b/boefjes/boefjes/plugins/kat_snyk/boefje.json index 5caed40ad8e..52036fcfc93 100644 --- a/boefjes/boefjes/plugins/kat_snyk/boefje.json +++ b/boefjes/boefjes/plugins/kat_snyk/boefje.json @@ -1,7 +1,7 @@ { "id": "snyk", "name": "Snyk.io-vulnerabilities", - "description": "Get Snyk.io vulnerabilities based on Software", + "description": "Get Snyk.io vulnerabilities based on identified Software.", "consumes": [ "SoftwareInstance" ], diff --git a/boefjes/boefjes/plugins/kat_snyk/normalizer.json b/boefjes/boefjes/plugins/kat_snyk/normalizer.json index a24799474f2..7234a8de07f 100644 --- a/boefjes/boefjes/plugins/kat_snyk/normalizer.json +++ b/boefjes/boefjes/plugins/kat_snyk/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_snyk_normalize", "name": "Snyk.io", + "description": "Parses Snyk.io data into various findings.", "consumes": [ "boefje/snyk" ], diff --git a/boefjes/boefjes/plugins/kat_snyk_finding_types/boefje.json b/boefjes/boefjes/plugins/kat_snyk_finding_types/boefje.json index f48633af47b..2c710422948 100644 --- a/boefjes/boefjes/plugins/kat_snyk_finding_types/boefje.json +++ b/boefjes/boefjes/plugins/kat_snyk_finding_types/boefje.json @@ -1,7 +1,7 @@ { "id": "snyk-finding-types", "name": "SNYK Finding Types", - "description": "Hydrate information of SNYK finding types", + "description": "Hydrate information of SNYK finding types.", "consumes": [ "SnykFindingType" ], diff --git a/boefjes/boefjes/plugins/kat_snyk_finding_types/normalizer.json b/boefjes/boefjes/plugins/kat_snyk_finding_types/normalizer.json index f576b514d7d..80f919d126d 100644 --- a/boefjes/boefjes/plugins/kat_snyk_finding_types/normalizer.json +++ b/boefjes/boefjes/plugins/kat_snyk_finding_types/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_snyk_finding_types_normalize", "name": "Snyk.io finding types", + "description": "Parses Snyk.io data into Finding Types. Required for the Snyk Normalizer.", "consumes": [ "boefje/snyk-finding-types" ], diff --git a/boefjes/boefjes/plugins/kat_ssl_certificates/boefje.json b/boefjes/boefjes/plugins/kat_ssl_certificates/boefje.json index 0d6ed28a5b4..3cf277314a2 100644 --- a/boefjes/boefjes/plugins/kat_ssl_certificates/boefje.json +++ b/boefjes/boefjes/plugins/kat_ssl_certificates/boefje.json @@ -1,7 +1,7 @@ { "id": "ssl-certificates", "name": "SSLCertificates", - "description": "Scan SSL certificates of websites", + "description": "Scan SSL certificates of websites. Checks if certificates are valid and/or expired.", "consumes": [ "Website" ], diff --git a/boefjes/boefjes/plugins/kat_ssl_certificates/normalizer.json b/boefjes/boefjes/plugins/kat_ssl_certificates/normalizer.json index 6445ad84e4e..77b555201c9 100644 --- a/boefjes/boefjes/plugins/kat_ssl_certificates/normalizer.json +++ b/boefjes/boefjes/plugins/kat_ssl_certificates/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_ssl_certificates_normalize", "name": "SSL certificates", + "description": "Parses SSL certificates data into X509 certificates.", "consumes": [ "boefje/ssl-certificates" ], diff --git a/boefjes/boefjes/plugins/kat_ssl_scan/boefje.json b/boefjes/boefjes/plugins/kat_ssl_scan/boefje.json index 7bc7dddcd71..2fb0a2a1ec7 100644 --- a/boefjes/boefjes/plugins/kat_ssl_scan/boefje.json +++ b/boefjes/boefjes/plugins/kat_ssl_scan/boefje.json @@ -1,7 +1,7 @@ { "id": "ssl-version", "name": "SSLScan", - "description": "Scan SSL/TLS versions of websites", + "description": "Scan SSL/TLS versions (protocols) of websites. Will result in findings if outdated SSL/TLS versions are identified such as SSLv3. ", "consumes": [ "Website" ], diff --git a/boefjes/boefjes/plugins/kat_ssl_scan/normalizer.json b/boefjes/boefjes/plugins/kat_ssl_scan/normalizer.json index 03440d05d64..a1bb4705da9 100644 --- a/boefjes/boefjes/plugins/kat_ssl_scan/normalizer.json +++ b/boefjes/boefjes/plugins/kat_ssl_scan/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_ssl_scan_normalize", "name": "SSL scan", + "description": "Parses SSL scan version data into findings.", "consumes": [ "boefje/ssl-version" ], diff --git a/boefjes/boefjes/plugins/kat_testssl_sh_ciphers/boefje.json b/boefjes/boefjes/plugins/kat_testssl_sh_ciphers/boefje.json index 92626c95337..5d717a60661 100644 --- a/boefjes/boefjes/plugins/kat_testssl_sh_ciphers/boefje.json +++ b/boefjes/boefjes/plugins/kat_testssl_sh_ciphers/boefje.json @@ -1,7 +1,7 @@ { "id": "testssl-sh-ciphers", "name": "Testssl.sh Ciphers", - "description": "Run testssl.sh Docker container and check ciphers", + "description": "Checks the SSL and TLS ciphers of a website for any insecure ciphers that are offered.", "consumes": [ "IPService" ], diff --git a/boefjes/boefjes/plugins/kat_testssl_sh_ciphers/normalizer.json b/boefjes/boefjes/plugins/kat_testssl_sh_ciphers/normalizer.json index 7d8d73f78a7..670cea50569 100644 --- a/boefjes/boefjes/plugins/kat_testssl_sh_ciphers/normalizer.json +++ b/boefjes/boefjes/plugins/kat_testssl_sh_ciphers/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_ssl_test_ciphers_normalize", "name": "SSL test ciphers", + "description": "Parses TestSSL data into TLS ciphers.", "consumes": [ "boefje/testssl-sh-ciphers" ], diff --git a/boefjes/boefjes/plugins/kat_wappalyzer/normalizer.json b/boefjes/boefjes/plugins/kat_wappalyzer/normalizer.json index 078eeb6eab1..aadfd6cb73a 100644 --- a/boefjes/boefjes/plugins/kat_wappalyzer/normalizer.json +++ b/boefjes/boefjes/plugins/kat_wappalyzer/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_wappalyzer_normalize", "name": "Wappalyzer", + "description": "Checks HTTP responses for Software versions.", "consumes": [ "openkat-http/response" ], diff --git a/boefjes/boefjes/plugins/kat_webpage_analysis/check_images/normalizer.json b/boefjes/boefjes/plugins/kat_webpage_analysis/check_images/normalizer.json index 1f6d2edfae1..61e8b1ec671 100644 --- a/boefjes/boefjes/plugins/kat_webpage_analysis/check_images/normalizer.json +++ b/boefjes/boefjes/plugins/kat_webpage_analysis/check_images/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_check_images", - "name": "Webpage analysis check images", + "name": "Webpage analysis check images for metadata", + "description": "Checks images for metadata.", "consumes": [ "image/jpeg", "image/jpg", diff --git a/boefjes/boefjes/plugins/kat_webpage_analysis/find_images_in_html/normalizer.json b/boefjes/boefjes/plugins/kat_webpage_analysis/find_images_in_html/normalizer.json index 112a43fdb40..6e4902e45f7 100644 --- a/boefjes/boefjes/plugins/kat_webpage_analysis/find_images_in_html/normalizer.json +++ b/boefjes/boefjes/plugins/kat_webpage_analysis/find_images_in_html/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_find_images_in_html", "name": "Webpage analysis find images in html", + "description": "Parses websites to find images.", "consumes": [ "text/html" ], diff --git a/boefjes/boefjes/plugins/kat_webpage_analysis/headers/normalizer.json b/boefjes/boefjes/plugins/kat_webpage_analysis/headers/normalizer.json index cb66bfead5c..7af10b6f0ad 100644 --- a/boefjes/boefjes/plugins/kat_webpage_analysis/headers/normalizer.json +++ b/boefjes/boefjes/plugins/kat_webpage_analysis/headers/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_webpage_analysis_headers_normalize", "name": "Webpage analysis HTTP headers", + "description": "Parses the HTTP headers from websites.", "consumes": [ "openkat-http/headers" ], diff --git a/boefjes/boefjes/plugins/kat_webpage_capture/boefje.json b/boefjes/boefjes/plugins/kat_webpage_capture/boefje.json index 7b28df2c714..75db6e9e3fe 100644 --- a/boefjes/boefjes/plugins/kat_webpage_capture/boefje.json +++ b/boefjes/boefjes/plugins/kat_webpage_capture/boefje.json @@ -1,7 +1,7 @@ { "id": "webpage-capture", "name": "Webpage Capture", - "description": "Takes a screenshot of a webpage. Image is stored to bytes.", + "description": "Takes a screenshot of a webpage. Image can be found on the Tasks page in the downloadable 'meta and raw data' file.", "consumes": [ "HostnameHTTPURL", "IPAddressHTTPURL" diff --git a/boefjes/boefjes/plugins/kat_wpscan/boefje.json b/boefjes/boefjes/plugins/kat_wpscan/boefje.json index 9c1d0b343da..35a7e543d7a 100644 --- a/boefjes/boefjes/plugins/kat_wpscan/boefje.json +++ b/boefjes/boefjes/plugins/kat_wpscan/boefje.json @@ -1,7 +1,7 @@ { "id": "wp-scan", "name": "WPScan", - "description": "WordPress security scanner", + "description": "Scans WordPress websites.", "consumes": [ "SoftwareInstance" ], diff --git a/boefjes/boefjes/plugins/kat_wpscan/normalizer.json b/boefjes/boefjes/plugins/kat_wpscan/normalizer.json index 931a4dc72c4..d4319ac6b66 100644 --- a/boefjes/boefjes/plugins/kat_wpscan/normalizer.json +++ b/boefjes/boefjes/plugins/kat_wpscan/normalizer.json @@ -1,6 +1,7 @@ { "id": "kat_wpscan_normalize", "name": "WPscan", + "description": "Creates findings from WPscan data.", "consumes": [ "boefje/wp-scan" ],