aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorHarald Eilertsen <haraldei@anduin.net>2019-05-08 22:50:36 +0200
committerHarald Eilertsen <haraldei@anduin.net>2019-05-08 22:50:36 +0200
commite88cbfe52ba87039cb404dec68c086ad25227efa (patch)
tree62afc1fe8f4ca646b03cf954d7771c5aa70d6423 /README.md
parentbb7eb2da2918dcfdb9b5d672b4165449230c5532 (diff)
downloadphisher-e88cbfe52ba87039cb404dec68c086ad25227efa.tar.gz
phisher-e88cbfe52ba87039cb404dec68c086ad25227efa.tar.bz2
phisher-e88cbfe52ba87039cb404dec68c086ad25227efa.zip
Add readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md58
1 files changed, 58 insertions, 0 deletions
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 <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.
+
+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 <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/>.