Skip to content

Commit 0cb32a3

Browse files
committed
readme updated
1 parent ed0c2d5 commit 0cb32a3

File tree

1 file changed

+71
-74
lines changed

1 file changed

+71
-74
lines changed

README.md

Lines changed: 71 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -67,89 +67,86 @@ sudo pip3 install -r requirements.txt
6767
### Usage
6868

6969
```
70-
______ __ ___ __ __
71-
/ ____/___ ______/ |/ /___ ______/ //_/
72-
/ / __/ __ `/ ___/ /|_/ / __ `/ ___/ ,<
73-
/ /_/ / /_/ (__ ) / / / /_/ (__ ) /| |
74-
\____/\__,_/____/_/ /_/\__,_/____/_/ |_|
75-
76-
GasMasK - All in one Information gathering tool - OSINT
77-
Ver. 1.2
78-
Written by: @maldevel, @mikismaos, @xvass, @ndamoulianos, @sbrb
70+
71+
___________ .__ _________
72+
\__ ___/_ _ __ ____ | |___ __ ____ / _____/ ____ ____
73+
| | \ \/ \/ // __ \| |\ \/ // __ \ \_____ \_/ __ \_/ ___\
74+
| | \ /\ ___/| |_\ /\ ___/ / \ ___/\ \___
75+
|____| \/\_/ \___ >____/\_/ \___ >_______ /\___ >\___ >
76+
\/ \/ \/ \/ \/
77+
78+
GasMasK v. 1.5 - All in one Information gathering tool - OSINT
79+
GasMasK is an open source tool licensed under GPLv3.
80+
Written by: @maldevel, mikismaos, xvass, ndamoulianos, sbrb
7981
https://www.twelvesec.com/
82+
Please visit https://github.com/twelvesec/gasmask for more..
8083
8184
usage: gasmask.py [-h] [-d DOMAIN] [-s NAMESERVER] [-x PROXY] [-l LIMIT]
82-
[-i MODE] [-o BASENAME] [-m MATCH] [-f FILTER] [--count]
83-
[-R REPORT] [-B REPORT_BUCKET] [-1 CENSYS_API_ID]
84-
[-2 CENSYS_API_SECRET] [-r] [-u] [-a ASN] [-c COUNTRY]
85-
[-O CERT_ORG] [-I CERT_ISSUER] [-z CERT_HOST]
86-
[-S HTTP_SERVER] [-t HTML_TITLE] [-b HTML_BODY] [-T TAGS]
87-
[-L LIMIT] [-D] [-v] [-H]
85+
[-i MODE] [-o BASENAME] [-k API-KEY] [-e SPYSE_API_KEY]
86+
[-m MATCH] [-f FILTER] [--count] [-R REPORT]
87+
[-B REPORT_BUCKET] [-1 CENSYS_API_ID] [-2 CENSYS_API_SECRET]
88+
[-r] [-u] [-a ASN] [-c COUNTRY] [-O CERT_ORG]
89+
[-I CERT_ISSUER] [-z CERT_HOST] [-S HTTP_SERVER]
90+
[-t HTML_TITLE] [-b HTML_BODY] [-T TAGS] [-L LIMIT] [-D]
91+
[-v] [-H]
8892
[arguments [arguments ...]]
8993
9094
positional arguments:
9195
arguments Censys query
9296
9397
optional arguments:
94-
-h --help, show this help message and exit
95-
96-
-d DOMAIN, --domain DOMAIN, Domain to search.
97-
98-
-s NAMESERVER, --server NAMESERVER, DNS server to use.
99-
100-
-x PROXY, --proxy, PROXY Use a proxy server when retrieving results from search engines (eg. '-x http://127.0.0.1:8080')
101-
102-
-l LIMIT, --limit, LIMIT Limit the number of search engine results (default: 100).
103-
104-
-i MODE, --info MODE Limit information gathering (basic,whois,dns,revdns,vhosts,google,bing,yahoo,ask,dogpile,yandex,censys,linkedin,twitter,googleplus,youtube,reddit,github,instagram,crt,pgp,netcraft,virustotal,dnsdump,spyse).
105-
106-
-o BASENAME, --output BASENAME, Output in the four major formats at once (markdown, txt, xml and html).
107-
108-
-k API-KEY, --shodan-key API-KEY API key to use with Shodan search (MODE="shodan")
109-
110-
-m MATCH, --match MATCH, Highlight a string within an existing query result
111-
112-
-f FILTER, --filter FILTER Filter the JSON keys to display for each result (use value 'help' for interesting fields)
113-
114-
--count, Print the count result and exit
115-
116-
-R REPORT, --report REPORT, Stats on given field (use value 'help' for listing interesting fields)
117-
118-
-B REPORT_BUCKET, --report_bucket REPORT_BUCKET, Bucket length in report mode (default: 50)
119-
120-
-1 CENSYS_API_ID, --censys_api_id CENSYS_API_ID, Provide the authentication ID for the censys.io search engine
121-
122-
-2 CENSYS_API_SECRET, --censys_api_secret CENSYS_API_SECRET, Provide the secret hash for the censys.io search engine
123-
124-
-r, --read_api_keys, Read the API Keys stored in api_keys.txt file. (e.g. '-i censys -r')
125-
126-
-u, --update_api_keys, Update the API Keys stored in api_keys.txt file. (e.g. '-i censys -u')
127-
128-
-a ASN, --asn ASN, Filter with ASN (e.g 5408 for GR-NET AS)
129-
130-
-c COUNTRY, --country COUNTRY, Filter with country
131-
132-
-O CERT_ORG, --cert-org CERT_ORG, Certificate issued to organization
133-
134-
-I CERT_ISSUER, --cert-issuer CERT_ISSUER, Certificate issued by organization
135-
136-
-z CERT_HOST, --cert-host CERT_HOST, hostname Certificate is issued to
137-
138-
-S HTTP_SERVER, --http-server HTTP_SERVER, Server header
139-
140-
-t HTML_TITLE, --html-title HTML_TITLE, Filter on html page title
141-
142-
-b HTML_BODY, --html-body HTML_BODY, Filter on html body content
143-
144-
-T TAGS, --tags TAGS, Filter on specific tags. e.g: -T tag1,tag2,... (use keyword 'list' to list usual tags
145-
146-
-L LIMIT, --Limit LIMIT, Limit to N results ( this is for censys.io )
147-
148-
-D, --debug, Debug informations
149-
150-
-v, --verbose, Print raw JSON records
151-
152-
-H, --html, Renders html elements in a browser
98+
-h, --help show this help message and exit
99+
-d DOMAIN, --domain DOMAIN
100+
Domain to search.
101+
-s NAMESERVER, --server NAMESERVER
102+
DNS server to use.
103+
-x PROXY, --proxy PROXY
104+
Use a proxy server when retrieving results from search engines (eg. '-x http://127.0.0.1:8080')
105+
-l LIMIT, --limit LIMIT
106+
Limit the number of search engine results (default: 100).
107+
-i MODE, --info MODE Limit information gathering (basic,nongoogle,whois,dns,revdns,vhosts,google,bing,yahoo,ask,dogpile,yandex,linkedin,twitter,youtube,reddit,github,instagram,crt,pgp,netcraft,virustotal,dnsdump,shodan,censys,spyse).
108+
-o BASENAME, --output BASENAME
109+
Output in the four major formats at once (markdown, txt, xml and html).
110+
-k API-KEY, --shodan-key API-KEY
111+
API key to use with Shodan search (MODE="shodan")
112+
-e SPYSE_API_KEY, --spyse-key SPYSE_API_KEY
113+
-m MATCH, --match MATCH
114+
Highlight a string within an existing query result
115+
-f FILTER, --filter FILTER
116+
Filter the JSON keys to display for each result, use value 'help' for interesting fields
117+
--count Print the count result and exit
118+
-R REPORT, --report REPORT
119+
Stats on given field (use value 'help' for listing interesting fields)'
120+
-B REPORT_BUCKET, --report_bucket REPORT_BUCKET
121+
Bucket len in report mode (default: 10)
122+
-1 CENSYS_API_ID, --censys_api_id CENSYS_API_ID
123+
Provide the authentication ID for the censys.io search engine
124+
-2 CENSYS_API_SECRET, --censys_api_secret CENSYS_API_SECRET
125+
Provide the secret hash for the censys.io search engine
126+
-r, --read_api_keys Read the API Keys stored in api_keys.txt file. (e.g. '-i censys -r')
127+
-u, --update_api_keys
128+
Update the API Keys stored in api_keys.txt file. (e.g. '-i censys -u')
129+
-a ASN, --asn ASN Filter with ASN (e.g 5408 for GR-NET AS)
130+
-c COUNTRY, --country COUNTRY
131+
Filter with country
132+
-O CERT_ORG, --cert-org CERT_ORG
133+
Certificate issued to organization
134+
-I CERT_ISSUER, --cert-issuer CERT_ISSUER
135+
Certificate issued by organization
136+
-z CERT_HOST, --cert-host CERT_HOST
137+
hostname Certificate is issued to
138+
-S HTTP_SERVER, --http-server HTTP_SERVER
139+
Server header
140+
-t HTML_TITLE, --html-title HTML_TITLE
141+
Filter on html page title
142+
-b HTML_BODY, --html-body HTML_BODY
143+
Filter on html body content
144+
-T TAGS, --tags TAGS Filter on specific tags. e.g: -T tag1,tag2,... (use keyword 'list' to list usual tags
145+
-L LIMIT, --Limit LIMIT
146+
Limit to N results
147+
-D, --debug Debug information
148+
-v, --verbose Print raw JSON records
149+
-H, --html Renders html elements in a browser
153150
154151
```
155152

0 commit comments

Comments
 (0)