aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 29d1652290769bcd4653df878de6ebb2cdc1d1f8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# Phisher

Check phishing links using data from PhishTank.

## How to build

Make sure you have an [up to date rust toolchain](https://rustup.rs/), any
version supporting the [2018 edition](https://doc.rust-lang.org/nightly/edition-guide/rust-2018/index.html)
should work.

    cargo build --release

## How to run

Make sure you have the dataset from phishtank.com. See the [PhishTank developer
docs](https://www.phishtank.com/developer_info.php) for how to obtain the dataset.
You need to download the json dataset.

Then launch the phisher server process like this:

    phisher --phishtank <phishtank-json-file>

Loading the dataset will take a while, once it is done, it will print out the
number of phishes loaded, and the socket where it will listen for potentially
phishy URLs.

You can check if an URL is phishy or not by connecting to the socket and passing
one URL at the time to the socket. For each URL the server will respond if it's
phishy or good.

Once the client is done, it can drop the connection gracefully by issuing the `bye`
command, or simply drop the connection.

An example session can be like this:

    % socat - UNIX-CONNECT:/tmp/phisher
    https://volse.no
    good url.
    https://safravideos.com/login
    it's a phish!
    bye
    bye.

## How to contribute

Send me patches, bugs, ideas by [email](mailto:haraldei-phisher@anduin.net) or through Hubzilla/Mastodon/Diaspora etc on [my hubzilla account](https://hub.volse.no/channel/harald).

## License

    Copyright (C) 2019  Harald Eilertsen <haraldei@anduin.net>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.