Skip to content

Commit

Permalink
Update README.md file for version 1.0
Browse files Browse the repository at this point in the history
Signed-off-by: Gladiator <gladiator@localhost.localdomain>
  • Loading branch information
Gladiator committed Aug 20, 2016
1 parent e3493c7 commit f7e41d9
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/.idea/
/out/
/ARP_Guard.iml
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,28 @@
# ARPGuard
##ARP Spoofing Detector Engine
(ARP Spoofing Detector Engine)

##What is this?

# Comming soon ...
This is a free-platform tool for protecting you against [ARP spoofing](https://en.wikipedia.org/wiki/ARP_spoofing) attacks on your local network.

**Attention** : This tool is a detector engine that detects and alerts you if you will be under ARP spoofing attacks and doesn't prevent of this kind of attacks.
(For preventing ARP spoofing see [this documentation](http://security.stackexchange.com/questions/43373/how-to-prevent-arp-poisoning-on-my-network)).

##Pre-Installation

This tool has been written in java language, so is free-platform and you will need jre (>= 8) on your machine for running that.
See [this documentation](https://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html) for learn how to install jre.

##Installation

There is two way for installation this tool:

1. Download latest version from release page.**(recommended for end-users)**

2. Clone or download repository and build from source.**(recommended for developers)**

##How to use?

For use this tool you should modify [configuration.properties](https://github.com/arVahedi/ARPGuard/blob/master/configuration.properties) file and set your local interface ip and router ip and trusted router mac address.After this step you can run jar file and you will be safe against ARP spoofing attacks.

**Note** : Currently version (1.0) supports only one local interface and only router mac address for protection.We are working strongly for remove this limitation in next version.

0 comments on commit f7e41d9

Please sign in to comment.