Skip to content

πŸ§©βžœπŸ‘€ TheDig enrich personal data from a full name and an email

License

Notifications You must be signed in to change notification settings

ankaboot-source/thedig

Folders and files

NameName
Last commit message
Last commit date
Oct 7, 2024
Aug 18, 2024
Nov 6, 2024
Aug 11, 2023
Aug 21, 2022
Aug 18, 2024
Aug 18, 2024
Aug 22, 2022
Oct 6, 2024
Aug 18, 2024
Sep 13, 2024
Oct 13, 2024
Aug 20, 2024
Aug 21, 2024
Oct 7, 2024
Oct 7, 2024
Nov 14, 2024
Aug 22, 2024
Sep 12, 2024

Repository files navigation

License: AGPL v3 Make the Web Open Again

TheDig πŸ§©βžœπŸ‘€

Excavate public data from an email and a full name using OSINT and IA.

Features ♦ Privacy-by-design ♦ How to use ♦ How to contribute ♦ Support ♦ License

Archeologists digging raw materials from social networks to reconstruct the identify of a person who looks like Michel Foucault

✨ Features

TheDig checks, as much as possible, that exacataved data belongs to the person before returning any results. Person's with #OptOut in their social profile will not be enriched.

Person

Fields excavated from an email address and full name:

  • Given name, Family name
  • Job title
  • Social Network's URL and LinkedIn's URL
  • Profile pictures
  • Company's name
  • Work's location

Company

Company informations excavated from domain:

  • name
  • website's url
  • alternate name
  • industry
  • legal name
  • description
  • employees number
  • founding date
  • founders
  • email
  • telephone
  • social network's URL

πŸ›‘οΈ Privacy-by-design

This program intend to be actively GDPR compliant and respectful of mined person's privacy. Our intent is to help user's enrich data on existing contacts not to spy nor gather data on someone with a malicious purpose.

We implemented proactively a few GDPR principles in the code itself
  • Right to Opt-Out: if the person mined use the tag #OptOut in its social profile, no enrichment will occur.
  • Lawfulness, fairness and transparency: our sources of data are only public data the person already consent to share publicly. We do not mine databreached data nor doxing for examples.
  • Purpose and Accuracy: we rather prefer not to enrich with dubious information than take the risk of false positives, for examples the social profiles found are, as possible, checked to be the ones about the person itself. We do not mine social networks or websites that are irrelevant to marketing purposes.

By using this application, you must abid to local, international and ethical privacy rules. For instance, it's highly recommended to inform the person's enriched that he has been the object of this mining. Such feature is not in the scope of this present OpenSource repository. Please reach [email protected] for further enquiries.

πŸ—οΈ How to use

Configure

To run this project, you'll need a few environement variables which includes some API keys from Google.

You'll need a few API keys, depending on which search engine you wish to use, yet Google Vision (reverse-image search) is mandatory. Have a look at default.env for instructions on how to create them, fill them and rename the file as .env.

In order to help you start smoothly, we provided a script for Google setup_googlecloud.sh. Run it to set-up automatically Google Vision API. By default, the project will be thedig and so the API key. If you wish to change defaults, feel free to modify the script by yourself.

Launch

Download it and:

  docker-compose up -d

Then open http://localhost:8080/docs

🀝 How to contribute

You're welcome! First, have a look on issues open and closed. If nothing is related to your needs, either open an issue or fork, create a branch and submit your PR.

Launch in developer mode

  • Set the LOG_LEVEL to DEBUG in .env
  • Enter the thedig folder and run it this way : uvicorn main:app --reload

Contributor Copyright Agreement

In consideration of your contributions to this product, you shall be granted the right to utilize, modify, and disseminate the product in conjunction with your contributions. Simultaneously, you hereby grant the software editor (Ankaboot Company) an irrevocable, perpetual, and unrestricted license to employ, adapt, and publish, including for commercial purposes, your contributions, in their entirety.

⚠️ Support

For support, contact by email [email protected] for commercial support or open an issue for community support.

πŸ“ƒ License

This software is a free software (open source) dual-licensed under the AGPL (No SLA, No Warranty) and a commercial license. Basically, that means that you could use, modify and distribute this software freely if the derivative work is OpenSource itself (OSI-approved). For exemple, if your software is a Software-as-a-Service, your SaaS must be OpenSource itself. If you wish to use this software in a non-OSI approved license, aka proprietary software, you must buy a commercial license from the editor of this product (aka ankaboot.io - [email protected]).