Auto Mail OSINT - API

This is an open source project that developed by Alp Keskin and Davut Kulaksız within the scope of My Security Analytics 2021 Summer Internship Program which supervised by Çalgan Aygün.

This repository is the API part of this project.

To learn more about the front-end part, check out the WEB Repository.

Functionality

Login/Register endpoints with JWT
Email format check
Mailbox server check
SMTP check
Scan social platforms (Instagram, Twitter, Snapchat and Tumblr)
Scan mailbox providers (yaani, gmail and protonmail)

Tech Stack

For building the APIs, FastAPI is used.
Server-side is made by using Python.
MongoDB used to save users login data and save their searching logs.

Installation

Clone API repo and install dependencies.

  git clone https://github.com/mysecurityanalytics/auto-mail-osint-api.git
  cd auto-mail-osint-api
  pip install -r requirements.txt

Set environment variables.

  export MONGO_URI=''
  export DB_NAME=''
  export JWT_SECRET=''

Run

  uvicorn main:app --reload

--reload: make the server restart after code changes. Only do this for development!

API Reference

Authorization Endpoint Documentation

http://localhost:8000/auth/docs or http://localhost:8000/auth/redoc

Email Verification Endpoint Documentation

http://localhost:8000/verify/docs or http://localhost:8000/verify/redoc

Email Scan Endpoint Documentation

http://localhost:8000/scan/docs or http://localhost:8000/scan/redoc

Status Codes

Status Code	Description
200	`OK`
400	`BAD REQUEST`
401	`UNAUTHORIZED`
403	`FORBIDDEN`
404	`NOT FOUND`
409	`EMAIL ALREADY TAKEN`
500	`INTERNAL SERVER ERROR`

Special thanks to Çalgan Aygün for his contribution to the project.