Tim-LaRocque552 / bitcrook

Open-Source Intelligence Apparatus

Bitcrook

Centralize and expedite OSINT investigations
View the roadmap

Table of Contents

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

Information

About

Bitcrook is an open-source intelligence apparatus that aims to centralize all of the tools necessary to carry out an investigation. Although investigations will still require human interaction to connect the dots, the interface can be tailored to an individual’s needs to expedite the process of due diligence. Some packages do require an authentication key and others do not. See the Package Types tables for more information. Bitcrook can be integrated within your application OR it can be used directly from the terminal/web browser.

Disclaimer

It is the end user's responsibility to obey all applicable local, state, and federal laws. Developers assume no liability and are not responsible for any misuse or damage caused by this program. By using Bitcrook, you agree to the previous statements.

Preview

Attributions

Logo created by TheOneTrueDude.

Social Preview created with Canva.

Usage

Installation

• Fetch the repository via 'git clone': git clone https://github.com/audioo/bitcrook.git

CLI

1. Navigate to the root directory of Bitcrook via cd
2. In your preferred terminal, enter and run: go run main.go
3. After running the aforementioned command, all dependencies will be installed and usage help will be printed to the console.

GUI

1. From the root directory of Bitcrook, navigate into the api directory via cd
2. In your preferred terminal, enter and run: go run server.go
3. A pop-up should appear requesting network access, allow it.
4. In your preferred web browser, navigate to http://localhost:6174

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

Bitcrook is currently passing all tests; however, I have provided instructions for properly running the tests if you would like to do so. Some tests may not function properly without their corresponding API keys.

1. In the root directory of Bitcrook, create a file named keyconfig.json
2. In keyconfig.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"
}

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

Package-Types

Court Cases

Package	Description	Auth	Location	Status
Case Law	Court Case Search	none	US	Functioning

IP Address

Package	Description	Auth	Location	Status
IPV4 Address Lookup	IPV4 Address Lookup	none	Global	Functioning

Multi-Use

Package	Description	Auth	Location	Status
Have I Been Pwned	Email and Password Vulnerability - (Breaches)	paid	Global	Functioning
Melissa	Lookups - Email, Phone Number, IP Address	free	US	Functioning

Username

Package	Description	Auth	Location	Status
Username Lookup	Username Lookup - (Comparable to Sherlock)	none	Global	Functioning

Vehicle

Package	Description	Auth	Location	Status
VIN Lookup	Vehicle Identification Number Lookup	none	-	Not Functioning