# 🏠 Home
Opensource Intelligence Framework (OSIF) is an open-source framework dedicated to OSINT. For the ease of use, the interface has a layout that looks like Metasploit.
It consists of various modules that aid OSINT operations:
1. Attack Surface
2. Blockchain
3. Email
4. Geolocation
5. Host Enumeration
6. IoC
7. Mobile
8. Social Media
9. Web Enumeration
**Repository:**
**Release:**
v1.0.0 -
# 🖥 Installation
## Docker Installation (Recommended)
#### Docker installation
Get [Docker](https://docs.docker.com/get-docker/) for Windows, Linux and MacOS
**Where to get Docker Compose**
**Windows and macOS**
Docker Compose is included in [Docker Desktop](https://www.docker.com/products/docker-desktop) for Windows and macOS.
#### Linux
You can download Docker Compose binaries from the [release page](https://github.com/docker/compose/releases) on this repository.
Run OSIF with docker and docker-compose
git clone https://github.com/fr4nc1stein/osint-framework osif
cd osif
docker-compose up -d
docker exec -ti osif bash
./osif
If not started, follow this instruction below:
```
docker build --no-cache --tag osif .
docker run -ti osif bash
./osif
```
## Manual Installation
Recommended on Linux or Kali
Install Dependencies:
```
sudo apt-get update && \
apt-get -y install gcc mono-mcs
sudo apt-get update && apt-get install git build-essential -y
sudo apt-get install libmagic1 -y
```
Fork the Repo
```
git clone https://github.com/fr4nc1stein/osint-framework osif
cd osif
pip3 install -r requirements
```
## Configuration
Create .env
1. Virustotal API
2. CENSYS API (not working - still fixing)
3. ABUSECH (not required)
4. SHODAN API
5. HUNTER API
6. BITCOINABUSE API
7. WIGLE API (geolocation module)
```
VT_API=""
CENSYS_APPID=""
CENSYS_SECRET=""
ABUSECH_API_KEY = ""
SHODAN_API_KEY = ""
HUNTER_API_KEY = ""
BITCOINABUSE_API_KEY = ""
WIGLE_API_NAME = ""
WIGLE_API_TOKEN = ""
```
```
─$ ./osif
## #### ##### ######
# # # # # #
# # # # #
# # #### # ####
# # # # #
# # # # # #
## #### ##### #
>> OSINT Framework
>> @laet4x
-=[ 2 attack-surface ]=-
-=[ 3 blockchain ]=-
-=[ 1 email ]=-
-=[ 4 host_enum ]=-
-=[ 2 ioc ]=-
-=[ 1 social ]=-
-=[ 1 web_enum ]=-
[!] There are some issues ; use 'show issues' to see more details
osif > use host_enum/dns_records
```
# ⌨️ Usage
**Commands:**
```
osif > help
```
help
```
osif > show modules
```
show module
```
osif > search "keyword"
```
search
```
osif > use blockchain/bitcoin_balance
```
use modules
```
osif blockchain(bitcoin_balance) > show options
```
show options
```
osif blockchain(bitcoin_balance) > set ADDRESS "address-here"
```
set address
```
osif blockchain(bitcoin_balance) > run
```
run
# 📖 Contribution
### Contribution Guidelines
There are many ways to contribute to the OSIF project. This overview summarizes the most important steps to get you started as a contributor.
* Report bugs to the OSIF issue tracker.
* Make suggestions for changes, updates, or new features to the OSIF issue tracker.
* Contribute bug fixes, example code, documentation, or tutorials to OSIF.
* Contribute new features to OSIF.
### Contribute new modules
* *Fork it!*
* *Create your feature/module branch: **git checkout -b my-new-module***
* *Commit your changes: **git commit -am 'Add some module'***
* *Push to the branch: **git push origin my-new-module***
* *Submit a pull request*
### Module
Modules python code must be place inside **modules -> sub-folder**
module structure
This example shows an example of a module for OSIF aimed to find the DNS Records
# ✏️ Contributor
### Contributor
**Author / Module Developer**
laet4x is a Cyber Security Professional who focuses on Red and Blue Teaming, he is a blockchain enthusiast and loves to play CTF. He is a python lover (not a snake), ruby, PHP, and javascript.
**Module Developer**
cadeath, is a software engineer, security professional, and blockchain expert. He love pokemons, bulbasaur, typhlosion, python, Vaporeon, visualbasic, ruby, perl,and more.
# 🚧 Roadmap
Modules:
* [x] Attack Surface
* [x] Shodan
* [ ] Censys
* [x] Bitcoin and Ethereum Address Information
* [x] BitcoinAbuse
* [x] Bitcoin Wallet Balance
* [x] Ethereum Wallet Balance
* [x] Ethereum Address and ENS lookup
* [x] Email
* [x] hunter.io
* [ ] snov.io
* [x] Host Enumeration Modules
* [x] DNS Records
* [x] DNS Host
* [x] IPLookUP
* [x] Sublister
* [x] Geolocation
* [x] SSID/Bluetooth Search
* [x] IOC
* [x] VirusTotal URL
* [ ] VirusTotal Hash
* [x] AbuseCH Hash
* [x] Mobile
* [x] Temp Number Identifier (Philippines Only)
* [x] Social
* [x] Twitter Follower
* [x] Web Enumeration
* [x] Wappalyzer
* [x] Repositories
* [ ] SearchCode
Others (No Category Yet)
* [ ] LeakIX
* [ ] IPAbuse
* [ ] Domain History
.png?alt=media&token=b2d539ff-93af-4969-bdd0-d4776aed5d43)
