|
| 1 | +# Introduction |
| 2 | + |
| 3 | +``` |
| 4 | + ,_ |
| 5 | + ,' '\,_ Utku Sen's |
| 6 | + |_,-'_) wholeaked |
| 7 | + /##c '\ ( |
| 8 | + ' |' -{. ) "When you have eliminated the impossible, |
| 9 | + /\__-' \[] whatever remains, however improbable, |
| 10 | + /'-_'\ must be the truth" - Sherlock Holmes |
| 11 | + ' \ |
| 12 | + ``` |
| 13 | + |
| 14 | +wholeaked is a file-sharing tool that allows you to find the responsible person in case of a leakage. It's written in Go. |
| 15 | + |
| 16 | +## How? |
| 17 | + |
| 18 | +wholeaked gets the file that will be shared and a list of recipients. It creates a unique signature for each recipient and adds it to the file secretly. After then, you can automatically send files to the corresponding recipients by using Sendgrid, AWS SES or SMTP integrations. Instead of sending them by e-mail, you can also share them manually. |
| 19 | + |
| 20 | +wholeaked works with every file type. However, it has additional features for common file types such as PDF, DOCX, MOV etc. |
| 21 | + |
| 22 | +### Sharing Process |
| 23 | + |
| 24 | +``` |
| 25 | + +-----------+ |
| 26 | + |Top Secret | |
| 27 | + |.pdf | |
| 28 | + | | |
| 29 | + -| | |
| 30 | + / | | |
| 31 | + / |Hidden | |
| 32 | + a@gov / |signature1 | |
| 33 | + / +-----------+ |
| 34 | + / +-----------+ |
| 35 | ++-----------++-----------+ / |Top Secret | |
| 36 | +|Top Secret ||Recipient | / |.pdf | |
| 37 | +|.pdf ||List | +---------+ / | | |
| 38 | +| || | |utkusen/ | / b@gov | | |
| 39 | +| ||a@gov |----->|wholeaked| /----------+ | |
| 40 | +| ||b@gov | | | \ |Hidden | |
| 41 | +| ||c@gov | +---------+ \ |signature2 | |
| 42 | +| || | \ +-----------+ |
| 43 | ++-----------++-----------+ \ +-----------+ |
| 44 | + \ |Top Secret | |
| 45 | + \ |.pdf | |
| 46 | + c@gov \ | | |
| 47 | + \ | | |
| 48 | + \ | | |
| 49 | + \ |Hidden | |
| 50 | + -|signature3 | |
| 51 | + +-----------+ |
| 52 | +``` |
| 53 | + |
| 54 | +### Validation Part |
| 55 | + |
| 56 | +To find who leaked the document, you just need to provide the leaked file to wholeaked and it will reveal the responsible person by comparing the signatures in the database. |
| 57 | + |
| 58 | +``` |
| 59 | ++-----------+ +---------+ |
| 60 | +|Top Secret | |Signature| |
| 61 | +|.pdf | +---------+|Database | |
| 62 | +| | |utkusen/ || | Document leaked by |
| 63 | +| |->|wholeaked|| |--------+ |
| 64 | +| | | || | b@gov |
| 65 | +|Hidden | +---------+| | |
| 66 | +|Signature2 | | | |
| 67 | ++-----------+ +---------+ |
| 68 | + |
| 69 | +``` |
| 70 | + |
| 71 | +## Demonstration Video |
| 72 | + |
| 73 | +[](https://www.youtube.com/watch?v=EEDtXp9ngHw) |
| 74 | + |
| 75 | +## File Types and Detection Modes |
| 76 | + |
| 77 | +wholeaked can add the unique signature to different sections of a file. Available detection modes are given below: |
| 78 | + |
| 79 | +**File Hash:** SHA256 hash of the file. All file types are supported. |
| 80 | + |
| 81 | +**Binary:** The signature is added to the binary of a file. *Almost* all filetypes are supported. |
| 82 | + |
| 83 | +**Metadata:** The signature is added to a metadata section of a file. Supported file types: PDF, DOCX, XLSX, PPTX, MOV, JPG, PNG, GIF, EPS, AI, PSD |
| 84 | + |
| 85 | +**Watermark:** An invisible signature is inserted to the text. Only PDF files are supported. |
| 86 | + |
| 87 | +# Installation |
| 88 | + |
| 89 | +## From Binary |
| 90 | + |
| 91 | +You can download the pre-built binaries from the [releases](https://github.com/utkusen/wholeaked/releases/latest) page and run. For example: |
| 92 | + |
| 93 | +`tar xzvf wholeaked_0.1.0_Linux_amd64.tar.gz` |
| 94 | + |
| 95 | +`./wholeaked --help` |
| 96 | + |
| 97 | +## From Source |
| 98 | + |
| 99 | +1) Install Go on your system |
| 100 | + |
| 101 | +2) Run: `go get -u github.com/utkusen/wholeaked` |
| 102 | + |
| 103 | +## Installing Dependencies |
| 104 | + |
| 105 | +wholeaked requires `exiftool` for adding signatures to metadata section of files. If you don't want to use this feature, you don't need to install it. |
| 106 | + |
| 107 | +1) Debian-based Linux: Run `apt install exiftool` |
| 108 | +2) macOS: Run `brew install exiftool` |
| 109 | +3) Windows: Download exiftool from here https://exiftool.org/ and put the `exiftool.exe` in the same directory with wholeaked. |
| 110 | + |
| 111 | +wholeaked requires `pdftotext` for verifying watermarks inside PDF files. If you don't want to use this feature, you don't need to install it. |
| 112 | + |
| 113 | +1) Download "Xpdf command line tools" for Linux, macOS or Windows from here: https://www.xpdfreader.com/download.html |
| 114 | +2) Extract the archive and navigate to `bin64` folder. |
| 115 | +3) Copy the `pdftotext` (or `pdftotext.exe`) executable to the same folder with wholeaked |
| 116 | +4) For Debian Based Linux: Run `apt install libfontconfig` command. |
| 117 | + |
| 118 | +# Usage |
| 119 | + |
| 120 | +## Basic Usage |
| 121 | + |
| 122 | +wholeaked requires a project name `-n`, path of the base file which the signatures will added `-f` and a list of target recipients `-t` |
| 123 | + |
| 124 | +Example command: `./wholeaked -n test_project -f secret.pdf -t targets.txt` |
| 125 | + |
| 126 | +The `targets.txt` file should contain name and the e-mail address in the following format: |
| 127 | + |
| 128 | +``` |
| 129 | +Utku Sen,utku@utkusen.com |
| 130 | +Bill Gates,bill@microsoft.com |
| 131 | +``` |
| 132 | + |
| 133 | +After execution is completed, the following unique files will be generated: |
| 134 | + |
| 135 | +``` |
| 136 | +test_project/files/Utku_Sen/secret.pdf |
| 137 | +test_project/files/Bill_Gates/secret.pdf |
| 138 | +``` |
| 139 | + |
| 140 | +By default, wholeaked adds signatures to all available places that are defined in the "File Types and Detection Modes" section. If you don't want to use a method, you can define it with a `false` flag. For example: |
| 141 | + |
| 142 | +`./wholeaked -n test_project -f secret.pdf -t targets.txt -binary=false -metadata=false -watermark=false` |
| 143 | + |
| 144 | +## Sending E-mails |
| 145 | + |
| 146 | +In order to send e-mails, you need to fill some sections in the `CONFIG` file. |
| 147 | + |
| 148 | +- If you want to send e-mails via Sendgrid, type your API key to the `SENDGRID_API_KEY` section. |
| 149 | + |
| 150 | +- If you want to send e-mails via AWS SES integration, you need to install `awscli` on your machine and add the required AWS key to it. wholeaked will read the key by itself. But you need to fill the `AWS_REGION` section in the config file. |
| 151 | + |
| 152 | +- If you want to send e-mails via a SMTP server, fill the `SMTP_SERVER`, `SMTP_PORT`, `SMTP_USERNAME`, `SMTP_PASSWORD` sections. |
| 153 | + |
| 154 | +The other necessary fields to fill: |
| 155 | + |
| 156 | +- `EMAIL_TEMPLATE_PATH` Path of the e-mail's body. You can specify use HTML or text format. |
| 157 | +- `EMAIL_CONTENT_TYPE` Can be `html` or `text` |
| 158 | +- `EMAIL_SUBJECT` Subject of the e-mail |
| 159 | +- `FROM_NAME` From name of the e-mail |
| 160 | +- `FROM_EMAIL` From e-mail of the e-mail |
| 161 | + |
| 162 | +To specify the sending method, you can use `-sendgrid`, `-ses` or `-smtp` flags. For example: |
| 163 | + |
| 164 | +`./wholeaked -n test_project -f secret.pdf -t targets.txt -sendgrid` |
| 165 | + |
| 166 | +## Validating a Leaked File |
| 167 | + |
| 168 | +You can use the `-validate` flag to reveal the owner of a leaked file. wholeaked will compare the signatures detected in the file and the database located in the project folder. Example: |
| 169 | + |
| 170 | +`./wholeaked -n test_project -f secret.pdf -validate` |
| 171 | + |
| 172 | +**Important:** You shouldn't delete the `project_folder/db.csv` file if you want to use the file validation feature. If that file is deleted, wholeaked won't be able to compare the signatures. |
| 173 | + |
| 174 | +# Donation |
| 175 | + |
| 176 | +Loved the project? You can buy me a coffee |
| 177 | + |
| 178 | +<a href="https://www.buymeacoffee.com/utkusen" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a> |
0 commit comments