From e88cbfe52ba87039cb404dec68c086ad25227efa Mon Sep 17 00:00:00 2001 From: Harald Eilertsen Date: Wed, 8 May 2019 22:50:36 +0200 Subject: Add readme --- README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..db4cc40 --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +# 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 + +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. + +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! + +## 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 + + 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 . -- cgit v1.2.3