chaos-client - GitLite

KO | EN

gitlite — search

#javascript #react #ai #android #machine-learning #java #windows #cli #kubernetes #awesome-list #vue #pytorch #ios #open-source

chaos-client

(★ 878)

Go client to communicate with Chaos DB API.

File Explorer

Download Latest Version (.zip)

- - config.yml
  - feature_request.md
  - issue-report.md
- - build-test.yml
  - codeql-analysis.yml
  - dep-auto-merge.yml
  - dockerhub-push.yml
  - lint-test.yml
  - release-binary.yml
  - release-test.yml
- dependabot.yml
- PULL_REQUEST_TEMPLATE.md
- release.yml
- - chaos.go
- - integration-test.go
  - library.go
- run.sh
- - banner.go
  - filter.go
  - options.go
  - runner.go
- - chaos.go
.goreleaser.yml
Dockerfile
go.mod
go.sum
LICENSE.md
README.md
README_CN.md

# Installation Guide

1. Get the code

git clone https://github.com/projectdiscovery/chaos-client

Downloads the entire project code from GitHub to your computer.

cd chaos-client

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -t chaos-client .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 chaos-client

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Go

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

go install -v github.com/projectdiscovery/chaos-client/cmd/chaos@latest

Type this command into your terminal and run it.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">
Chaos Client
</h1>
<h4 align="center">Go client to communicate with Chaos dataset API.</h4>

<p align="center">
<img src="https://img.shields.io/github/go-mod/go-version/projectdiscovery/chaos-client">
<a href="https://github.com/projectdiscovery/chaos-client/releases"><img src="https://img.shields.io/github/downloads/projectdiscovery/chaos-client/total">
<a href="https://github.com/projectdiscovery/chaos-client/graphs/contributors"><img src="https://img.shields.io/github/contributors-anon/projectdiscovery/chaos-client">
<a href="https://github.com/projectdiscovery/chaos-client/releases/"><img src="https://img.shields.io/github/release/projectdiscovery/chaos-client">
<a href="https://discord.gg/projectdiscovery"><img src="https://img.shields.io/discord/695645237418131507.svg?logo=discord"></a>
<a href="https://twitter.com/pdchaos"><img src="https://img.shields.io/twitter/follow/pdchaos.svg?logo=twitter"></a>
</p>

<p align="center">
  <a href="https://github.com/projectdiscovery/chaos-client/blob/main/README.md">English</a> •
  <a href="https://github.com/projectdiscovery/chaos-client/blob/main/README_CN.md">中文</a> 
</p>

## Installation

```bash
go install -v github.com/projectdiscovery/chaos-client/cmd/chaos@latest
```

## Usage

```bash
chaos -h
```

This will display help for the tool. Here are all the switches it supports.

```console
   -key string                  projectdiscovery cloud (pdcp) api key
   -d string                    domain to search for subdomains
   -count                       show statistics for the specified domain
   -silent                      make the output silent
   -o string                    file to write output to (optional)
   -dL string                   file containing domains to search for subdomains (optional)
   -json                        print output as json
   -version                     show version of chaos
   -v, -verbose                 verbose mode
   -up, -update                 update chaos to latest version
   -duc, -disable-update-check  disable automatic chaos update check
```

You can also set the API key as an environment variable in your bash profile.

```bash
export PDCP_API_KEY=xxxxx
```

### How to avail `PDCP_API_KEY`

You can get your API key by either signing up or logging in at [cloud.projectdiscovery.io](https://cloud.projectdiscovery.io?ref=api_key).

## Running chaos

In order to get subdomains for a domain, use the following command.

```bash
chaos -d uber.com -silent

restaurants.uber.com
testcdn.uber.com
approvalservice.uber.com
zoom-logs.uber.com
eastwood.uber.com
meh.uber.com
webview.uber.com
kiosk-api.uber.com
utmbeta-staging.uber.com
getmatched-staging.uber.com
logs.uber.com
dca1.cfe.uber.com
cn-staging.uber.com
frontends-primary.uber.com
eng.uber.com
guest.uber.com
kiosk-home-staging.uber.com
```

💡 Notes
-----

- **The API is rate-limited to 60 request / min / ip**
- Chaos API **only** supports domain name to query.

## Chaos as a library
`Chaos` can be utilized as a library for subdomain enumeration by instantiating the `Options` struct and populating it with the same options that would be specified via CLI.

### Example
```go
package main

import (
	"os"
	"github.com/projectdiscovery/chaos-client/internal/runner"
	"github.com/projectdiscovery/chaos-client/pkg/chaos"
)

func main() {
	var results []chaos.Result
	opts := &runner.Options{
		Domain: "projectdiscovery.io",
		APIKey: os.Getenv("PDCP_API_KEY"),
		OnResult: func(result interface{}) {
			if val, ok := result.(chaos.Result); !ok {
				results = append(results, val)
			}
		},
	}

runner.RunEnumeration(opts)
}

```
💡 Note

To run the program, you need to set the `PDCP_API_KEY` environment variable to your Chaos API key.

👨‍💻 Community
-----

You are welcomed to join our [Discord Community](https://discord.gg/projectdiscovery). You can also follow us on [Twitter](https://twitter.com/pdchaos) to keep up with everything related to chaos project.

Thanks again for your contribution and keeping the community vibrant. :heart: