Omniscient - Information Gathering Apparatus

Table of Contents

• Information
  • About
  • Installation and Usage
  • Implementation
  • Testing
  • Attributions
• Package Types a-z
  • Court Cases
  • IP Address
  • Multi-Use
  • Username
  • Vehicle

Information

About

Omniscient, an information gathering apparatus, is a conglomerate of tools including custom algorithms, API wrappers, etc... in order to make the reconnaissance process significantly quicker. Some packages do require an authentication key and others do not. See the Package Types tables for more information.

Installation and Usage

1. Fetch the repository via 'git clone': git clone https://github.com/audioo/omniscient.git
2. Navigate into the Omniscient repository: cd omniscient
3. In your preferred terminal, enter and run: go run main.go
4. After running the aforementioned command, all dependencies will be installed and usage help will be printed to the console.

Implementation

Instructions/Documentation are provided for each and every package, all you have to do is find what you need in the Package Types section.

Testing

Omniscient is currently passing all tests; however, I have provided instructions for properly running the tests if you would like to do so.

1. In the root directory of Omniscient, create a file named config.json
2. In config.json, paste the following text:

{
    "melissaKeyCred": "Paste Melissa Key with Credits Here",
    "hibpKey": "Paste Have I Been Pwned Key Here",
    "dataGovKey": "Paste Data.gov Key Here"
}

1. Paste in your API keys. The test will fail without a valid API key.
2. In your preferred terminal, enter and run go test ./...

Attributions

Social Preview created by TheOneTrueDude

Package-Types

Court Cases

IP Address

Multi-Use

Username

Vehicle