Skip to content

isuru-c/LeakHawk

Repository files navigation

LeakHawk

Leakhawk is a product designed to identify potential data breaches or hacking attacks in near real-time related to a domain(s) defined by the user. It performs multilevel filtering and classification to identify as well as classify data leakages and evidence of hacking attacks.

Getting Started

These instructions will guide you to install and start the leakhawk system in your local machine.

Prerequisites

We need to start apache kafka server before getting started with LeakHawk.

* Download Apache Kafka (With zookeeper)

https://kafka.apache.org/downloads
* Install Maven for your machine

https://maven.apache.org/install.html
* Clone the project 

Installing

Step 1

Start zookeeper server

/<path-to-kafka-installation>/bin/zookeeper-server-start.sh /<path-to-kafka-installation>/config/zookeeper.properties

Step 2

Start kafka server

/<path-to-kafka-installation>/bin/kafka-server-start.sh /<path-to-kafka-installation>/config/server.properties

Step 3

Create a topic for tweets in the kafka server.

/<path-to-kafka-installation>/bin/kafka-topics.sh --zookeeper localhost:2181 --create --topic tweets --partitions 2 --replication-factor 1

Step 4

Use following command to build the project with maven.

mvn clean install 

Now you should be able to run the projet.

Built With

  • Maven - Dependency Management

Configure

You need to provide resource folder to LeakHawk in the initialization. This folder needs these files

  • context.properties - Context Filter Matching Regex patterns
  • context_wordList.txt - Context Filter Word List
  • PreFilter_twitter.txt - Twitter Pre filtered word list
  • twitter.properties - Twitter API user credentials
  • All Model files need inside the code

you need to provide that resource folder file path when you going to start the LeakHawk.

Authors

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details