Skip to content

Latest commit

 

History

History
96 lines (65 loc) · 2.6 KB

README.md

File metadata and controls

96 lines (65 loc) · 2.6 KB
Raw

Dorky

License Twitter

Dorky is a command-line tool that searches GitHub and GitLab for matches in organization names, repository names, and usernames based on a list of input words. This tool can be helpful in identifying potential targets for security assessments, finding interesting projects, and discovering new organizations and users on GitHub and GitLab.

Example

echo "codingo\ncodingo dot com" | dorky -o -r -u -c

This will search for organization names, repository names, and usernames on both GitHub and GitLab based on the cleaned input words:

codingo
codingodotcom
codingo-dot-com

Installation

  1. Clone the repository:
git clone https://github.com/codingo/dorky.git
  1. Set your GitHub and/or GitLab access tokens as environment variables:
export GITHUB_ACCESS_TOKEN=your-github-access-token
export GITLAB_ACCESS_TOKEN=your-gitlab-access-token
  1. Pull the dependencies:
go get
  1. Build the Dorky tool:
go build -o dorky

Docker Instructions

Requirements

  • Docker
  • GITHUB_ACCESS_TOKEN and GITLAB_ACCESS_TOKEN environment variables

  1. Build the Docker image:

    docker build -t dorky .

  2. Run the Docker container:

    docker run --rm -it -e GITHUB_ACCESS_TOKEN=your-github-token -e GITLAB_ACCESS_TOKEN=your-gitlab-token dorky

    Replace your-github-token and your-gitlab-token with your GitHub and GitLab access tokens, respectively.

Usage

Pipe a list of words to the Dorky tool and use the appropriate flags to specify the search categories and platforms:

cat wordlist.txt | ./dorky -uro -gh

Available flags:

  • -o: Search for organization names (or groups in GitLab)
  • -r: Search for repository names (or projects in GitLab)
  • -u: Search for username matches
  • -max: Set the maximum number of search results per category (default: 10)
  • -c: Clean input URLs, turning them into words before performing searches
  • -gh: Search only GitHub
  • -gl: Search only GitLab
  • -s: Simple output style for piping to another tool
  • -v: Enable verbose mode for more detailed output

By default, the tool searches both GitHub and GitLab based on the provided access tokens. If both tokens are set, both platforms will be searched. If only one token is set, only that platform will be searched.

Dependencies

  • google/go-github/v38
  • xanzy/go-gitlab
  • golang.org/x/oauth2
  • golang.org/x/time/rate