Updated images & README.md

README.md

@@ -1,2 +1,83 @@
-# censys-enumeration
-A script to extract subdomains/emails for a given domain using SSL/TLS certificates dtaset on Censys
+# Censys Enumeration
+
+- A script to extract subdomains/emails for a given domain using SSL/TLS certificates dataset on Censys
+- The output is in JSON format
+
+## Screenshots
+
+## Non verbose mode
+![non-verbose](imgs/non_verbose.png)
+
+
+## Verbose mode
+![verbose](imgs/verbose_output.png)
+
+## Sample JSON output
+![non-verbose](imgs/sample_json_output.png)
+## 3rd party package dependency 
+
+[**censys**](https://pypi.python.org/pypi/censys)
+
+[**click**](https://pypi.python.org/pypi/click)
+
+## Setup
+
+- Clone this repo
+
+```bash
+$ git clone [email protected]:yamakira/censys-enumeration.git
+```
+
+- Install dependencies
+
+```bash
+$ pip install -r requirements.txt
+```
+
+- Get Censys API ID and Censys API secret by creating a account on `https://censys.io`
+
+- Add Censys API ID and Censys API secret as  `CENSYS_API_ID` & `CENSYS_API_SECRET` respectively to the OS environment variables. On Linux you can use a command similar to following to do this
+
+```bash
+$ export CENSYS_API_SECRET="iySd1n0l2JLnHTMisbFHzxClFuE0"
+```
+
+- Check help menu
+
+
+```bash
+$ python censys_enumeration.py --help                                                                                                 
+Usage: censys_enumeration.py [OPTIONS] FILE
+
+Options:
+  --verbose                       Verbose output
+  --subdomains / --no-subdomains  Enable/Disable subdomain enumeration
+  --emails / --no-emails          Enable/Disable email enumeration
+  --help                          Show this message and exit.
+```
+
+## Usage
+
+- Subdomain and email enumeration
+
+```
+$ python censys_enumeration.py domains.txt
+```
+
+- Only subdomain enumeration
+
+```
+$ python censys_enumeration.py --no-emails domains.txt 
+```
+
+- Only email enumeration
+
+```
+$ python censys_enumeration.py --no-sudomains domains.txt 
+```
+
+- Verbose output
+
+```
+$ python censys_enumeration.py --verbose domains.txt 
+```

email_data.json

@@ -0,0 +1 @@
+{"ietf.org": {"domain": "ietf.org", "emails": ["[email protected]", "[email protected]", "[email protected]", "[email protected]"], "subdomains": ["www.rtg.ietf.org", "netdot.noc.ietf.org", "services-1.meeting.ietf.org", "permatrac.noc.ietf.org", "nms.sql1.ietf.org", "sql1.ietf.org", "etherpad.noc.ietf.org", "permatrac.sql1.ietf.org", "tools.ietf.org", "observium.meeting.ietf.org", "Switch.meeting.ietf.org", "sec.ietf.org", "ops.ietf.org", "dechaunac.tools.ietf.org", "vm1.noc.ietf.org", "codestand.ietf.org", "git.noc.ietf.org", "tickets.meeting.ietf.org", "noc.meeting.ietf.org", "vm0.noc.ietf.org", "noc.ietf.org", "etherpad.sql1.ietf.org", "meeting.ietf.org", "management.meeting.ietf.org", "rtg.ietf.org", "netdot.sql1.ietf.org", "ietf.org", "nms.noc.ietf.org", "services-2.meeting.ietf.org", "ztp.meeting.ietf.org", "deadperson.meeting.ietf.org", "vnam.meeting.ietf.org", "dhcp-8599.meeting.ietf.org", "vm2.noc.ietf.org", "dav.noc.ietf.org"]}, "censys.io": {"domain": "censys.io", "emails": ["[email protected]"], "subdomains": ["kibana2.censys.io", "www.censys.io", "es-frontend-1.censys.io", "elasticsearch2.censys.io", "kafka-1.censys.io", "alertmanager.censys.io", "kafka2.censys.io", "kafka1.censys.io", "elasticsearch1.censys.io", "kibana1.censys.io", "git.wiki.censys.io", "censys.io", "logs.censys.io", "prometheus.censys.io", "wiki.censys.io", "kibana.es-frontend-1.censys.io", "kafka3.censys.io", "grafana.censys.io", "support.censys.io", "ichnaea.censys.io", "kibana.es-frontend-2.censys.io", "es-frontend-2.censys.io"]}, "wikimedia.org": {"domain": "wikimedia.org", "emails": [], "subdomains": ["apt.wikimedia.org", "etherpad.wikimedia.org", "status.wikimedia.org", "blog.wikimedia.org", "bug-attachment.wikimedia.org", "mirrors.wikimedia.org", "mail.wikimedia.org", "ticket.wikimedia.org", "vpn.corp.wikimedia.org", "ganglia.wikimedia.org", "wikitech.wikimedia.org", "netbox.wikimedia.org", "mx1001.wikimedia.org", "icinga-admin.wikimedia.org", "frdev.wikimedia.org", "archiva.wikimedia.org", "civicrm.wikimedia.org", "frdata.wikimedia.org", "noc.wikimedia.org", "gerrit-slave.wikimedia.org", "ishmael.wikimedia.org", "git.wikimedia.org", "rt.wikimedia.org", "dumps.wikimedia.org", "tendril.wikimedia.org", "svn.wikimedia.org", "corp.wikimedia.org", "stats.wikimedia.org", "virt0.wikimedia.org", "metrics.wikimedia.org", "fundraising.wikimedia.org", "wikitech-static-iad.wikimedia.org", "policy.wikimedia.org", "download.wikimedia.org", "ubuntu.wikimedia.org", "wikitech-static.wikimedia.org", "wikitech-static-ord.wikimedia.org", "directory.corp.wikimedia.org", "racktables.wikimedia.org", "mx2002.wikimedia.org", "mx1002.wikimedia.org", "shop.wikimedia.org", "payments.wikimedia.org", "benefactorevents.wikimedia.org", "techblog.wikimedia.org", "mingle.corp.wikimedia.org", "lists.wikimedia.org", "sugar.corp.wikimedia.org", "gerrit-new.wikimedia.org", "bugzilla.wikimedia.org", "eventdonations.wikimedia.org", "planet.wikimedia.org", "stream.wikimedia.org", "www.ticket.wikimedia.org", "store.wikimedia.org", "www.policy.wikimedia.org", "librenms.wikimedia.org", "payments-listener.wikimedia.org", "icinga.wikimedia.org", "labtestwikitech.wikimedia.org", "gerrit.wikimedia.org", "mx2001.wikimedia.org", "m.wikimedia.org", "wikimedia.org"]}, "iana.org": {"domain": "iana.org", "emails": [], "subdomains": ["www.itar.iana.org", "data.iana.org", "iana.org", "www.ns.iana.org", "ns.iana.org", "itar.iana.org"]}}