STRLCPY/opensquat

Update README.md

Minor improvements and added RapidAPI information

Andre Tenreiro committed with GitHub 2 years ago

b40f2124

1 parent 9cf39d8e

Total 1 files

■ ■ ■ ■ ■ ■

README.md

		skipped 26 lines
27	27		* Save output into different formats (txt, JSON and CSV)
28	28		* Can be integrated with other threat intelligence tools and DNS sinkholes
29	29
30		-	This is an opensource project so everyone's welcomed to contribute.
	30	+	As an opensource project, everyone's welcome to contribute.
31	31
32	32		Screenshot / Video Demo
33	33		-------------
		skipped 6 lines
40	40		------------
41	41		* [Phishy Domains](https://phishydomains.com) for a simple web version of the openSquat.
42	42		* [openSquat Bot](https://telegram.me/opensquat_bot) for a simple Telegram bot.
	43	+	* [RapidAPI](https://rapidapi.com/atenreiro/api/opensquat1) to integrate your application with openSquat using REST API.
43	44
44		-	Note: Both forks do not contain all openSquat features.
	45	+	Note: The forks do not contain all the openSquat features.
45	46
46	47
47	48		How to Install
		skipped 26 lines
74	75		# for all the options
75	76		python opensquat.py -h
76	77
77		-	# Search for generic terms used in phishing campaigns (can lead to false positives)
	78	+	# Search for generic terms used in phishing campaigns (can lead to false-positives)
78	79		python opensquat.py -k generic.txt
79	80
80	81		# With DNS validation (quad9)
		skipped 28 lines
109	110		python opensquat.py --phishing phishing_domains.txt --dns --ct --subdomains --portcheck
110	111		```
111	112
	113	+	Automations & Integrations
	114	+	-------------
	115	+	You can set up openSquat to run automatically using a task scheduler (such as crontab for Linux) to generate a new list of results daily.
	116	+
	117	+	We update our feeds with a fresh new list of domains every day around 7.30 am (UTC+0 / GMT+0)
	118	+
	119	+	```bash
	120	+	# Crontab example - run openSquat every day at 8 am
	121	+	# In this example, it saves the results file in JSON format
	122	+	0 10 * * * /home/john/opensquat/opensquat.py -k keywords.txt -o results.json -t json
	123	+	```
	124	+	You can use this output file to feed your SIEM, SOAR, or other tools that support importing from TXT/JSON/CSV formats.
	125	+
	126	+	Alternatively, currently in a Beta preview you can integrate using REST APIs, your application with [RapidAPI](https://rapidapi.com/atenreiro/api/opensquat1)
	127	+
	128	+	Do you have an integration idea or would like to share an integration you developed with our community? Open a GitHub issue or send me an email.
	129	+
112	130		To Do / Roadmap
113	131		-------------
114	132		* ~~Integration with VirusTotal (VT) for subdomains validation~~
		skipped 3 lines
118	136		* ~~Improve code quality from B to A grade (codacy)~~
119	137		* ~~PEP8 compliance~~
120	138		* AND logical condition for keywords search (e.g: google+login) - Thanks to Steff T.
121		-	* Add documentation
	139	+	* Enhanced documentation
122	140
123	141		Feature Request
124	142		-------------
125		-	To request for a new feature, create a "new issue" and describe the feature and potential use cases. If something similar already exists, you can upvote the "issue" and contribute to the discussions.
	143	+	To request a new feature, create a "new issue" and describe the feature and potential use cases. You can upvote the "issue" and contribute to the discussions if something similar already exists.
126	144
127	145		Changelog
128	146		-------------
		skipped 17 lines
146	164		* Open new issues with new suggestions, ideas, bug report or feature requests
147	165		* Spread this project within your network
148	166		* Share your story how have you been using the openSquat and what impact it brought to you
149		-	* Make a project logo
150	167