Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md from Eraser #171

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md from Eraser #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added ...7U03___---diagram----4c9bbf64e2f7bf77a83fef9f45c6ce06-EagleEye-Process-Flow.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 27 additions & 0 deletions README-EagleEye Process Flow-1.eraserdiagram
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
flowchart-diagram


title EagleEye Process Flow

// Define nodes and relationships
Start [shape: oval, icon: flag] > Get image of person [icon: image]
Get image of person > Enter name clue [icon: file-text]
Enter name clue > Choose platform [shape: diamond, icon: globe]
Choose platform > Search Instagram [icon: instagram]: Instagram
Choose platform > Search YouTube [icon: youtube]: YouTube
Choose platform > Search Facebook [icon: facebook]: Facebook
Choose platform > Search Twitter [icon: twitter]: Twitter
Search Instagram > Analyze results [icon: search]
Search YouTube > Analyze results [icon: search]
Search Facebook > Analyze results [icon: search]
Search Twitter > Analyze results [icon: search]
Analyze results > End [shape: oval, icon: check]

// Define Groups
For each platform [icon: repeat] {
Search Instagram
Search YouTube
Search Facebook
Search Twitter
Analyze results
}
361 changes: 171 additions & 190 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,190 +1,171 @@
```
$$$$$$$$\ $$\ $$$$$$$$\
$$ _____| $$ | $$ _____|
$$ | $$$$$$\ $$$$$$\ $$ | $$$$$$\ $$ | $$\ $$\ $$$$$$\
$$$$$\ \____$$\ $$ __$$\ $$ |$$ __$$\ $$$$$\ $$ | $$ |$$ __$$\
$$ __| $$$$$$$ |$$ / $$ |$$ |$$$$$$$$ | $$ __| $$ | $$ |$$$$$$$$ |
$$ | $$ __$$ |$$ | $$ |$$ |$$ ____| $$ | $$ | $$ |$$ ____|
$$$$$$$$\\$$$$$$$ |\$$$$$$$ |$$ |\$$$$$$$\ $$$$$$$$\\$$$$$$$ |\$$$$$$$\
\________|\_______| \____$$ |\__| \_______| \________|\____$$ | \_______|
$$\ $$ | $$\ $$ |
\$$$$$$ | \$$$$$$ |
\______/ \______/

```

<div align="center">

![Python 3.5](https://img.shields.io/badge/Python-3.6%2B-blue.svg)
![OS Linux](https://img.shields.io/badge/Supported%20OS-Linux-yellow.svg)
![Lets stalk](https://img.shields.io/badge/Stalkermode-Activated-red.svg)

</div>

---

<p align="center"> You have at least one image of the person you are looking for and a clue about their name.
<br>
You enter this data into EagleEye and it tries to find Instagram, Youtube, Facebook, and Twitter Profiles of this person.
<br>
</p>

## 📝 Table of Contents
- [Getting Started](#getting_started)
- [Usage](#usage)
- [Built Using](#built_using)
- [TODO](#todo)
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)


## 🏁 Getting Started <a name = "getting_started"></a>
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

- A system with a x-server installed (Linux)
- Firefox installed

#### When using docker
- Only docker is required

#### When you dont use docker
- Python 3.6 or higher
- Pythons pip


### Installing

#### Docker (Preferred)
**Make sure that you have docker installed**
**Make sure that you use a LINUX distribution as the host**
1. Clone the Repository

``` $ git clone https://github.com/ThoughtfulDev/EagleEye ```
2. ```
$ cd EagleEye
$ sudo docker build -t eagle-eye .
```
3. Now create a `known` folder and a `result` folder anywhere on your PC.
4. Put the images of the known person in the known folder.
5. Change the name of the person your are searching for in `entry.sh`
6. Start the container. **Make sure to edit the paths**:
```
sudo docker run -t --net=host --env="DISPLAY" \
--volume="$HOME/.Xauthority:/root/.Xauthority:rw" \
-v /path/to/known:/EagleEye/known \
-v /path/to/result:/result \
-v /path/to/EagleEye/Repository/entry.sh:/entry.sh \
eagle-eye

```

The result should now be in `/path/to/result`

---

#### Automated Prerequisites Installation (If Docker doesn't work)
```
wget https://raw.githubusercontent.com/ThoughtfulDev/EagleEye/master/install.sh && chmod +x install.sh && ./install.sh
```

---

#### Manual Prerequisites Installation (If you are hardcore)

For **Debian** based Distros
```
$ sudo apt update && sudo apt upgrade -y
$ sudo apt install git python3 python3-pip python3-dev
$ sudo apt install libgtk-3-dev libboost-all-dev build-essential cmake libffi-dev
$ git clone https://github.com/ThoughtfulDev/EagleEye
$ cd EagleEye && sudo pip3 install -r requirements.txt
$ sudo pip3 install --upgrade beautifulsoup4 html5lib spry
```

For **Arch**
```
$ sudo pacman -Syu
$ sudo pacman -S git python python-pip gtk3 boost cmake libffi
$ git clone https://github.com/ThoughtfulDev/EagleEye
$ cd EagleEye && sudo pip3 install -r requirements.txt
$ sudo pip3 install --upgrade beautifulsoup4 html5lib spry
```


If Firefox is installed, download the [latest release](https://github.com/mozilla/geckodriver/releases/latest) of the Geckodriver for you Architecture.

**If you get a `broken pipe` Error use Geckodriver Version 0.19.1.**

**Note: If you are using Firefox ESR (like Kali does) please use the Geckodriver Version 0.17.**

Make the Geckodriver executable:
```
$ chmod +x /path/to/geckodriver
```

Note: The `geckodriver` prefers to be in your path so wherever you do set it up you will likely need to setup a link to somewhere in your PATH (or add it to your PATH).

Example:
```
$ sudo ln -s /path/to/geckodriver /usr/local/bin/geckodriver
```


## 🎈 Usage <a name="usage"></a>

### Configuration: General

Change the value in `config.json` to the path of the `geckodriver` e.g
```
{
"DEFAULTS": {
...
},
"WEBDRIVER": {
"ENGINE": "firefox",
"PATH": "/usr/local/bin/geckodriver"
},
"FILTER": [
....
],
...
}
```

### Configuration: Images

Put at least one Image of the Person you want to find in the `known` folder.

Supported Filetypes are: **jpg/JPG, jpeg/JPEG, png/PNG, and bmp/BMP.**

### Run

Then run the program ;)
```
$ python3 eagle-eye.py
```

To see a list of all available Options just type
```
$ python3 eagle-eye.py -h
```

*The ImageRaider Reverse Image Search can take some minutes 1-15 Minutes depending on the count of Images*


## TODO <a name = "todo"></a>
* Implement the Chrome Webdriver

## ⛏️ Built Using <a name = "built_using"></a>
- [Python](https://www.python.org/) - Language
- [dlib](http://dlib.net/) - Face detection
- [face_recognition](https://github.com/ageitgey/face_recognition) - dlib python api
- [Selenium](https://www.seleniumhq.org/) - WebBrowser automation

## ✍️ Authors <a name = "authors"></a>
- [@ThoughtfulDev](https://github.com/ThoughtfulDev) - Idea & Work

## 🎉 Acknowledgements <a name = "acknowledgement"></a>
- The movie Eagle Eye
<p><a target="_blank" href="https://app.eraser.io/workspace/jeBD3FVioZt4xPfGR28O" id="edit-in-eraser-github-link"><img alt="Edit in Eraser" src="https://firebasestorage.googleapis.com/v0/b/second-petal-295822.appspot.com/o/images%2Fgithub%2FOpen%20in%20Eraser.svg?alt=media&amp;token=968381c8-a7e7-472a-8ed6-4a6626da5501"></a></p>

```
$$$$$$$$\ $$\ $$$$$$$$\
$$ _____| $$ | $$ _____|
$$ | $$$$$$\ $$$$$$\ $$ | $$$$$$\ $$ | $$\ $$\ $$$$$$\
$$$$$\ \____$$\ $$ __$$\ $$ |$$ __$$\ $$$$$\ $$ | $$ |$$ __$$\
$$ __| $$$$$$$ |$$ / $$ |$$ |$$$$$$$$ | $$ __| $$ | $$ |$$$$$$$$ |
$$ | $$ __$$ |$$ | $$ |$$ |$$ ____| $$ | $$ | $$ |$$ ____|
$$$$$$$$\\$$$$$$$ |\$$$$$$$ |$$ |\$$$$$$$\ $$$$$$$$\\$$$$$$$ |\$$$$$$$\
\________|\_______| \____$$ |\__| \_______| \________|\____$$ | \_______|
$$\ $$ | $$\ $$ |
\$$$$$$ | \$$$$$$ |
\______/ \______/
```
![Python 3.5](https://img.shields.io/badge/Python-3.6%2B-blue.svg "")

![OS Linux](https://img.shields.io/badge/Supported%20OS-Linux-yellow.svg "")

![Lets stalk](https://img.shields.io/badge/Stalkermode-Activated-red.svg "")

---

You have at least one image of the person you are looking for and a clue about their name.
You enter this data into EagleEye and it tries to find Instagram, Youtube, Facebook, and Twitter Profiles of this person.


## 📝 Table of Contents
- [Getting Started](#getting_started)
- [Usage](#usage)
- [Built Using](#built_using)
- [TODO](#todo)
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)
## 🏁 Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites
- A system with a x-server installed (Linux)
- Firefox installed
#### When using docker
- Only docker is required
#### When you dont use docker
- Python 3.6 or higher
- Pythons pip
### Installing
#### Docker (Preferred)
**Make sure that you have docker installed**
**Make sure that you use a LINUX distribution as the host**

1. Clone the Repository`$ git clone https://github.com/ThoughtfulDev/EagleEye`
2. $ cd EagleEye
$ sudo docker build -t eagle-eye .
3. Now create a `known` folder and a `result` folder anywhere on your PC.
4. Put the images of the known person in the known folder.
5. Change the name of the person your are searching for in `entry.sh`
6. Start the container. **Make sure to edit the paths**:
```
sudo docker run -t --net=host --env="DISPLAY" \
--volume="$HOME/.Xauthority:/root/.Xauthority:rw" \
-v /path/to/known:/EagleEye/known \
-v /path/to/result:/result \
-v /path/to/EagleEye/Repository/entry.sh:/entry.sh \
eagle-eye
```
The result should now be in `/path/to/result`

---

#### Automated Prerequisites Installation (If Docker doesn't work)
```
wget https://raw.githubusercontent.com/ThoughtfulDev/EagleEye/master/install.sh && chmod +x install.sh && ./install.sh
```
---

#### Manual Prerequisites Installation (If you are hardcore)
For **Debian** based Distros

```
$ sudo apt update && sudo apt upgrade -y
$ sudo apt install git python3 python3-pip python3-dev
$ sudo apt install libgtk-3-dev libboost-all-dev build-essential cmake libffi-dev
$ git clone https://github.com/ThoughtfulDev/EagleEye
$ cd EagleEye && sudo pip3 install -r requirements.txt
$ sudo pip3 install --upgrade beautifulsoup4 html5lib spry
```
For **Arch**

```
$ sudo pacman -Syu
$ sudo pacman -S git python python-pip gtk3 boost cmake libffi
$ git clone https://github.com/ThoughtfulDev/EagleEye
$ cd EagleEye && sudo pip3 install -r requirements.txt
$ sudo pip3 install --upgrade beautifulsoup4 html5lib spry
```
If Firefox is installed, download the [latest release](https://github.com/mozilla/geckodriver/releases/latest) of the Geckodriver for you Architecture.

**If you get a **`**broken pipe**`** Error use Geckodriver Version 0.19.1.**

**Note: If you are using Firefox ESR (like Kali does) please use the Geckodriver Version 0.17.**

Make the Geckodriver executable:

```
$ chmod +x /path/to/geckodriver
```
Note: The `geckodriver` prefers to be in your path so wherever you do set it up you will likely need to setup a link to somewhere in your PATH (or add it to your PATH).

Example:

```
$ sudo ln -s /path/to/geckodriver /usr/local/bin/geckodriver
```
## 🎈 Usage
### Configuration: General
Change the value in `config.json` to the path of the `geckodriver` e.g

```
{
"DEFAULTS": {
...
},
"WEBDRIVER": {
"ENGINE": "firefox",
"PATH": "/usr/local/bin/geckodriver"
},
"FILTER": [
....
],
...
}
```
### Configuration: Images
Put at least one Image of the Person you want to find in the `known` folder.

Supported Filetypes are: **jpg/JPG, jpeg/JPEG, png/PNG, and bmp/BMP.**

### Run
Then run the program ;)

```
$ python3 eagle-eye.py
```
To see a list of all available Options just type

```
$ python3 eagle-eye.py -h
```
_The ImageRaider Reverse Image Search can take some minutes 1-15 Minutes depending on the count of Images_

## TODO
- Implement the Chrome Webdriver
## ⛏️ Built Using
- [Python](https://www.python.org/) - Language
- [dlib](http://dlib.net/) - Face detection
- [face_recognition](https://github.com/ageitgey/face_recognition) - dlib python api
- [Selenium](https://www.seleniumhq.org/) - WebBrowser automation
## ✍️ Authors
- [@ThoughtfulDev](https://github.com/ThoughtfulDev) - Idea & Work
## 🎉 Acknowledgements
- The movie Eagle Eye



<!-- eraser-additional-content -->
## Diagrams
<!-- eraser-additional-files -->
<a href="/README-EagleEye Process Flow-1.eraserdiagram" data-element-id="L41KzreICHnykHERl4GNd"><img src="/.eraser/jeBD3FVioZt4xPfGR28O___3Jivg2tjMecMlrHwbIVIBR8f7U03___---diagram----4c9bbf64e2f7bf77a83fef9f45c6ce06-EagleEye-Process-Flow.png" alt="" data-element-id="L41KzreICHnykHERl4GNd" /></a>
<!-- end-eraser-additional-files -->
<!-- end-eraser-additional-content -->
<!--- Eraser file: https://app.eraser.io/workspace/jeBD3FVioZt4xPfGR28O --->