Skip to content

Commit fdb038d

Browse files
committed
Module update
moving script and its readme to folder, updated readme for module
1 parent 78bc1ed commit fdb038d

File tree

3 files changed

+51
-15
lines changed

3 files changed

+51
-15
lines changed

README.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,32 @@
11
# send-toNetcraft
2-
- Use the NetCraft API to send URLs to Netcraft to report as phishing sites.
2+
3+
- Use the NetCraft API to send URLs to Netcraft to report as phishing sites.
34
- API Documentation: https://report.netcraft.com/api/v2#tag/report/paths/~1report~1urls/post.
45

5-
## To use this script
6+
## To use the module
7+
8+
- Import the module
9+
10+
```PowerShell
11+
PS C:\temp> Import-Module .\send-toNetcraft.psm1
12+
```
13+
614
- Change parameters on the following lines:
7-
- 20: Pick the $prod or $test URI endpoint
8-
- 24: Email address you are submitting as
9-
- 27: Reason for submitting
10-
- Currently we (Netcraft) accept reports of phishing, malware, web shell and phishing kit URLs (https://report.netcraft.com/report).
11-
- Default value of "phish" is specified by this script.
15+
- 67: Pick the $prod or $test URI endpoint ($prod by default)
16+
- 51: Default Email address you will submit as
17+
- 53: Default reason for submitting (phish by default)
1218

13-
## To use from CLI:
1419
- Mandatory parameter
1520
- -u: URL
1621
- Comma separated for multiple
17-
- These are considered optional parameters. They can be hard-coded in your .ps1 file (lines 24 & 27 as noted above):
22+
- These are considered optional parameters. The defaults can be changed in your .psm1 file (lines 51 & 53 as noted above):
1823
- -e: Email address to report as
1924
- -r: Reason for reporting
20-
- Examples:
21-
```
22-
.\send-toNetcraft.ps1 -u http://superfake.com/really/really/awful.php
23-
.\send-toNetcraft.ps1 -u https://veryphishy.buzz/very/phishy/o365.html -e you@your.com -r phishing
24-
.\send-toNetcraft.ps1 -u https://veryphishy.buzz/very/phishy.zip -r "phishing kit"
25-
.\send-toNetcraft.ps1 -u www.badguyz.top/very/badstuff.php,reallylame.xyz/badstuff.asp
25+
- Examples:
26+
27+
```PowerShell
28+
send-toNetcraft -u http://superfake.com/really/really/awful.php
29+
send-toNetcraft -u https://veryphishy.buzz/very/phishy/o365.html -e you@your.com -r phishing
30+
send-toNetcraft -u https://veryphishy.buzz/very/phishy.zip -r "phishing kit"
31+
send-toNetcraft -u www.badguyz.top/very/badstuff.php,reallylame.xyz/badstuff.asp
2632
```

script/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# send-toNetcraft
2+
3+
- Use the NetCraft API to send URLs to Netcraft to report as phishing sites.
4+
- API Documentation: https://report.netcraft.com/api/v2#tag/report/paths/~1report~1urls/post.
5+
6+
## To use the script
7+
8+
- Change parameters on the following lines:
9+
- 20: Pick the $prod or $test URI endpoint
10+
- 24: Email address you are submitting as
11+
- 27: Reason for submitting
12+
- Currently we (Netcraft) accept reports of phishing, malware, web shell and phishing kit URLs (https://report.netcraft.com/report).
13+
- Default value of "phish" is specified by this script.
14+
15+
## To use from CLI
16+
17+
- Mandatory parameter
18+
- -u: URL
19+
- Comma separated for multiple
20+
- These are considered optional parameters. They can be hard-coded in your .ps1 file (lines 24 & 27 as noted above):
21+
- -e: Email address to report as
22+
- -r: Reason for reporting
23+
- Examples:
24+
25+
```PowerShell
26+
.\send-toNetcraft.ps1 -u http://superfake.com/really/really/awful.php
27+
.\send-toNetcraft.ps1 -u https://veryphishy.buzz/very/phishy/o365.html -e you@your.com -r phishing
28+
.\send-toNetcraft.ps1 -u https://veryphishy.buzz/very/phishy.zip -r "phishing kit"
29+
.\send-toNetcraft.ps1 -u www.badguyz.top/very/badstuff.php,reallylame.xyz/badstuff.asp
30+
```
File renamed without changes.

0 commit comments

Comments
 (0)