#873 pdns

analyzers/CIRCLPassiveDNS/CIRCLPassiveDNS.json

@@ -1,27 +1,49 @@
 {
-  "name": "CIRCLPassiveDNS",
-  "author": "Nils Kuhnert, CERT-Bund",
-  "license": "AGPL-V3",
-  "url": "https://github.com/BSI-CERT-Bund/cortex-analyzers",
-  "version": "2.0",
-  "description": "Check CIRCL's Passive DNS for a given domain or URL.",
-  "dataTypeList": ["domain", "url", "ip"],
-  "baseConfig": "CIRCL",
-  "command": "CIRCLPassiveDNS/circl_passivedns.py",
-  "configurationItems": [
-    {
-      "name": "user",
-      "description": "Username",
-      "type": "string",
-      "multi": false,
-      "required": true
+    "name": "CIRCLPassiveDNS",
+    "author": "Nils Kuhnert, CERT-Bund",
+    "license": "AGPL-V3",
+    "url": "https://github.com/BSI-CERT-Bund/cortex-analyzers",
+    "version": "2.0",
+    "description": "Check CIRCL's Passive DNS for a given domain or URL.",
+    "dataTypeList": [
+        "domain",
+        "url",
+        "ip"
+    ],
+    "baseConfig": "CIRCL",
+    "command": "CIRCLPassiveDNS/circl_passivedns.py",
+    "configurationItems": [
+        {
+            "name": "user",
+            "description": "Username",
+            "type": "string",
+            "multi": false,
+            "required": true
+        },
+        {
+            "name": "password",
+            "description": "Password",
+            "type": "string",
+            "multi": false,
+            "required": true
+        }
+    ],
+    "registration_required": true,
+    "subscription_required": true,
+    "free_subscription": true,
+    "service_homepage": "https://www.circl.lu/services/passive-dns/",
+    "service_logo": {
+        "path": "assets/passivedns.png",
+        "caption": "logo"
     },
-    {
-      "name": "password",
-      "description": "Password",
-      "type": "string",
-      "multi": false,
-      "required": true
-    }
-  ]
-}
+    "screenshots": [
+        {
+            "path": "sc-short-circlpassivedns.png",
+            "caption": "CIRCLPassiveDNS: short report"
+        },
+        {
+            "path": "sc-long-circlpassivedns.png",
+            "caption": "CIRCLPassiveDNS: long report"
+        }
+    ]
+}

analyzers/CIRCLPassiveDNS/README.md

@@ -0,0 +1,19 @@
+### CIRCLPassiveDNS
+
+Check [CIRCL's Passive DNS](https://www.circl.lu/services/passive-dns/) for a
+ given domain.
+
+This analyzer comes in only one flavor.
+
+#### Requirements
+
+Access to CIRCL Passive DNS is only allowed to trusted partners in Luxembourg
+and abroad. [Contact CIRCL](https://www.circl.lu/contact/) if you would like
+access. Include your affiliation and the foreseen use of the Passive DNS
+data.
+
+If the CIRCL positively answers your access request, you'll obtain a username
+ and password which are needed to make the analyzer work.
+
+supply your username as the value for the `user` parameter and your password
+as the value for the `password` parameter.