Skip to content

Latest commit

 

History

History
80 lines (57 loc) · 2.13 KB

README.md

File metadata and controls

80 lines (57 loc) · 2.13 KB
Raw

GitHub Email Scanner

A tool to scan GitHub repositories for exposed email addresses and names.

screenshot

Introduction

This tool uses the GitHub API to scan repositories owned by a user for email addresses and associated names. It provides options to scan specific repositories and exclude forked repositories. Additionally, you can provide a GitHub API token to increase the rate limit for API requests.

Installation

npm install -g gitrecon

Usage

Command Line Arguments:

  -u, --username <username>         GitHub username (Required)
  -t, --token <token>               GitHub API token (Optional)
  -r, --repo <repo>                 Repository name (Optional)
  -n, --no-forks                    Exclude forked repositories (Optional)
  -h, --help                        output usage information

Example usage: Scan all public repositories of a user:

gitrecon -u <username> -n

Scan a specific repository of a user:

gitrecon -u <username> -r <repo>

Provide a GitHub API token:

gitrecon -u <username> -t <token>

Implementation Details

Constants

API_URL: The base URL for GitHub API.

HEADER: Default HTTP headers for API requests.

DELAY: Delay between API requests (3000 milliseconds).

Functions

Repository(name, isFork): Factory function to create Repository objects.

updateHeader(updateObj): Function to update HTTP headers.

getRepositories(username): Function to retrieve user's repositories.

getEmails(username, repoName): Function to retrieve email addresses from a repository's commits.

apiCall(url): Function to make API calls with a delay.

Main Function

  • Parses command line arguments.
  • Fetches repositories to scan based on user input.
  • Scans repositories for email addresses and names.
  • Displays the results.

C++ version

A C++ version of this tool is available here.

C++ future work

  • GUI for the tool.

Ethics and Disclaimer

This tool is intended to be used for educational purposes only. The author is not responsible for any misuse of this tool.