search

Dilshan-H / Oblivion-Inverse

A Simple E-mail Tracker - Made with Flask, Setup under 30 minutes - Track your messages using your own platform!
https://dilshan-h.github.io/Oblivion-Inverse/
MIT License
29 stars 18 forks source link
email-tracker email-tracking firebase firebase-auth flask hacktoberfest mailtrack message-tracking messaging track-email tracking

readme

Oblivion-1 ~ A Simple E-mail Tracker

🎯️ Oblivion-Inverse is a simple e-mail tracking solution which based on the usage of web beacons or tracking pixels.

Oblivion-Inverse Open Source Email Tracker - Cover

GitHub license GitHub last commit GitHub issues GitHub pull requests

GitHub stars GitHub forks

📢 New UI Updates + Features

🚀 We have moved onto Cyclic platform! This branch (main) contains the code for the latest stable release of this project now.

💻 You can also use the initial versions from:

🌟 We are working on new features and improvements on 'dev' branch. You can check the progress and contribute to the project by visiting the dev branch.

Table of Contents

What is a web beacon?

A web beacon (web bug) is a technique used on web pages and emails to unobtrusively (usually invisibly) allow checking that a user has accessed some content. Web beacons are typically used by third parties to monitor the activity of users at a website for the purpose of web analytics or page tagging. They can also be used for email tracking. - Wikipedia

What can I achieve using this?

Basically using this pixel tracking method you can obtain vast amount of information about the targets. But, when it comes to emails there are few restrictions. For an instance, JavaScripts are not generally allowed in email clients.

Screenshots

Login Screen Add New Track Record
Login Screen Create Tracking Link
Link Dashboard Tracking Info
Link Dashboard Tracking Info

Setup & Usage

Basic Requirements

Installation

  1. First clone or download this repository as a Zip file to your local machine.

  2. Navigate to the directory.

    cd Oblivion-Inverse

  3. Create a virtual environment.

    python3 -m venv venv

  4. Activate virtual environment.

    Linux:

    source venv/bin/activate

    Windows:

    venv\Scripts\activate

  5. Install dependencies.

    pip install -r requirements.txt

  6. As we use Firebase Realtime Database and Firebase Authentication, you have to create a Firebase project and obtain the credentials. Visit Firebase Console and create a new project.
    Then go to the project settings and click on the Service Accounts tab. Then click on the Generate New Private Key button. This will download a JSON file containing the credentials. Rename the file to credentials.json and place it in the root directory of the project. (This file is already added to .gitignore so it won't be pushed to the repository)

  7. Now you have to create a new Firebase Authentication user. To do that, you have to go to the Authentication tab in the Firebase Console. Then click on the Set up sign-in method button. Then click on the Email/Password tab and enable it. Then click on the Users tab and click on the Add User button. Enter the email and password of the user account you want to create. Then click on the Add User button.

  8. Now you have to create a new Firebase Realtime Database. To do that, you have to go to the Database tab in the Firebase Console. Then click on the Create Database button. Then select the database location and click on the Next button and Enable the database.

  9. Now go to project settings again and under the General tab you can find the Web API Key. And also,you are able to find the Database URL under the SDK setup and configuration tab there.
    (Ex: databaseURL: "https://your-app-default-rtdb.asia-southeast1.firebasedatabase.app")
    Take a note of both of them since we will need them on the next step.

After that you can either test the application in your local machine or setup your selected platform, as you wish.

Testing/Using on your Local Machine | Network

First you have to set the following environment variables. Create a new file named .env in the root directory of the project and add the following lines to it. Replace the values with your own values.

FIREBASE_API_KEY=Your-Firebase-API-Key
FIREBASE_DB_URL=Your-Firebase-Database-URL
SECRET_KEY=replace-this-text-with-a-suitable-key
FLASK_DEBUG=true
TIMEZONE=Your-Timezone (ex:Asia/Colombo)

Note:

Then run the application using the following command:

flask run

If another program is already utilizing port 5000 (default port), Address already in use error will be displayed. If that happens you can specify a different port like this:

flask run --port 5001

Navigate to localhost:<port_number> (default: http://localhost:5000) in your browser. A login page will be displayed.
Input your newly created account's email & password and that's it!

Deploying to Cyclic

Single Click Deployment

Deploy to Cyclic

Click the button above and follow the instructions to deploy the app to Cyclic. (Follow the below section for environment variable setup)

Manual Deployment

  1. Push the code to your GitHub repository.
  2. Sign in to your Cyclic account and click Deploy New App button.
  3. Connect your GitHub account and select the repository.
  4. Select app runtime as Python and the branch you want to deploy and click Connect button.
  5. Go to the Settings tab and click on the Variables tab.
  6. Select Bulk option and paste the following environment variables and their values and click Save.
FIREBASE_API_KEY=Your-Firebase-API-Key
FIREBASE_DB_URL=Your-Firebase-Database-URL
SECRET_KEY=replace-this-text-with-a-suitable-key
FLASK_DEBUG=true
TIMEZONE=Your-Timezone (ex:Asia/Colombo)

Also, you have to add the Firebase Admin SDK credentials to the environment variables as well. You can append the following environment variables with the values from the credentials.json file you downloaded from the Firebase Console.

FIREBASE_TYPE=service_account
FIREBASE_PROJECT_ID=Your-Firebase-Project-ID
FIREBASE_PRIVATE_KEY_ID=Your-Firebase-Private-Key-ID
FIREBASE_PRIVATE_KEY=Your-Firebase-Private-Key
FIREBASE_CLIENT_EMAIL=Your-Firebase-Client-Email
FIREBASE_CLIENT_ID=Your-Firebase-Client-ID
FIREBASE_AUTH_URI=Your-Firebase-Auth-URI
FIREBASE_TOKEN_URI=Your-Firebase-Token-URI
FIREBASE_AUTH_PROVIDER_X509_CERT_URL=Your-Firebase-Auth-Provider-X509-Cert-URL
FIREBASE_CLIENT_X509_CERT_URL=Your-Firebase-Client-X509-Cert-URL
FIREBASE_UNIVERSE_DOMAIN=googleapis.com
  1. Go to the Overview tab and click on your app link to view your app.

Steps to create a tracking link for your email.

  1. Visit the homepage of the app and sign into your account.

  2. Add the subject of the specific email (which will make it easier to identified at later times) and the recipient's email address.

  3. Click 'Generate'

  4. Then, you can drag & drop the tracking image to the end of your message body. (DO NOT copy & paste the image since it will insert your image as a base64 image to the email body) -- Otherwise, you can manipulate the content of the email body using Developer Tools in browser.

  5. Everything's done! Now send your email and wait for the results to appear. (you need to refresh your browser to load new entries)

How to use a Geo Location API

Using a Geo Location API, you can collect additional information about the recipient such as;

This feature will be available in the next version. - Till then, you can use a service like ipwhois to obtain the location information using the recorded IP address.

Special note about G-Mail + several other email clients

Since some clients use a special technique, "Image Proxies" to deliver images; this pixel based tracking method is not suitable to gather additional information about the recipients who use such services. Instead of recipient's IP address and User-Agent, you will receive Google Image Proxy’s UA (User-Agent) (+IP address) which looks like this:

Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)

But, on the bright side, you can still get the resource accessed date and time!

Why not using cookies for tracking?

Yes, you can set cookies for additional/accurate data collection. But they represent as third party cookies within devices. Most of the web browsers/platforms block such cookies by default. [maybe not Chrome yet 😉] So, it's the death of 3rd party cookies.

Contributing

Got an idea? Found a bug? Feel free to open an issue or submit a pull request. For major changes, please open an issue first to discuss what you would like to change.

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us. You can also check CODE_OF_CONDUCT.md for more information.

License & Copyrights

License: MIT

This program is free software: you can redistribute it and/or modify it under the terms of the MIT License

Refer to the LICENSE file for more details.

Heroku, Render, Cyclic, GMail, ipwhois, VS Code, Chrome are copyrights and/or trademarks of their respective owners.

Disclaimer

Tracking other users actions across any platform may considered as violation of their privacy. So, kindly use this in a responsible manner. Authors of this repository are not responsible for any misuse of the provided information.