ProjectDiscovery

https://docs.projectdiscovery.io/
Admin
ProjectDiscovery is a security platform providing exposure discovery, vulnerability detection, cloud...
Tokens:356,328
Snippets:3,365
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Interactsh Server

Source: https://docs.projectdiscovery.io/opensource/interactsh/server

Install the interactsh-server binary using Go. Ensure you have Go installed and configured.

```bash
go install -v github.com/projectdiscovery/interactsh/cmd/interactsh-server@latest
```

--------------------------------

### Install httpx from GitHub

Source: https://docs.projectdiscovery.io/opensource/httpx/install

Install httpx by cloning the GitHub repository, building from source, and moving the binary to your PATH. Verify the installation with `httpx -version`.

```bash
git clone https://github.com/projectdiscovery/httpx.git; 
cd httpx/cmd/httpx; 
go build; 
mv httpx /usr/local/bin/; 
httpx -version;
```

--------------------------------

### Install Naabu using Go

Source: https://docs.projectdiscovery.io/opensource/naabu/install

Install Naabu using the Go package manager. Ensure libpcap is installed beforehand for packet capturing.

```bash
go install -v github.com/projectdiscovery/naabu/v2/cmd/naabu@latest
```

--------------------------------

### Install Minimum Dependencies for Headless Mode

Source: https://docs.projectdiscovery.io/opensource/nuclei/faq

Install only the essential shared libraries required for the browser binary if a full browser installation is not feasible or desired.

```bash
sudo apt-get install libnss3 libgconf-2-4
```

--------------------------------

### Install Prerequisites on Ubuntu

Source: https://docs.projectdiscovery.io/opensource/katana/install

Installs necessary prerequisites for running Katana on Ubuntu, including Go, zip, curl, wget, and git. It also updates the system and installs Google Chrome.

```sh
sudo apt update
sudo snap refresh
sudo apt install zip curl wget git
sudo snap install golang --classic
wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
    sudo sh -c 'echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
sudo apt update
sudo apt install google-chrome-stable
```

--------------------------------

### Install All Tools with PDTM

Source: https://docs.projectdiscovery.io/opensource/pdtm/running

Use this command to install all available tools managed by PDTM. The output shows the installation progress and versions of the installed tools.

```console
$ pdtm -install-all
                ____          
     ____  ____/ / /_____ ___ 
    / __ \/ __  / __/ __ __  \
   / /_/ / /_/ / /_/ / / / / /
  / .___/\__,_/\__/_/ /_/ /_/
 /_/                          v0.0.1

      projectdiscovery.io

[INF] Installed httpx v1.1.1
[INF] Installed nuclei v2.6.3
[INF] Installed naabu v2.6.3
[INF] Installed dnsx v2.6.3
```

--------------------------------

### Interactsh Server Running Example

Source: https://docs.projectdiscovery.io/opensource/interactsh/server

Example output showing a successfully running interactsh server with its listening services and version.

```console
interactsh-server -domain interact.sh

    _       __                       __       __  
   (_)___  / /____  _________ ______/ /______/ /_ 
  / / __ \/ __/ _ \/ ___/ __ \'/ ___/ __/ ___/ __ \
 / / / / / /_/  __/ /  / /_/ / /__/ /_(__  ) / / /
/_/_/ /_/\__/~___/_/   \__,_/\___/\__/____/_/ /_/ v1.0.0

                projectdiscovery.io

[INF] Listening with the following services:
[HTTPS] Listening on TCP 46.101.25.250:443
[HTTP] Listening on TCP 46.101.25.250:80
[SMTPS] Listening on TCP 46.101.25.250:587
[LDAP] Listening on TCP 46.101.25.250:389
[SMTP] Listening on TCP 46.101.25.250:25
[DNS] Listening on TCP 46.101.25.250:53
[DNS] Listening on UDP 46.101.25.250:53
```

--------------------------------

### Install Cloudlist using Go

Source: https://docs.projectdiscovery.io/opensource/cloudlist/install

Use this command to install ProjectDiscovery's Cloudlist via Go. Ensure Go is installed and the Go bin path is added to your system's PATH.

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

--------------------------------

### Install httpx using Go

Source: https://docs.projectdiscovery.io/opensource/httpx/install

Use this command to install ProjectDiscovery's httpx via Go. Ensure Go is installed and the Go bin path is added to your system's PATH.

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

--------------------------------

### Install Uncover using Go

Source: https://docs.projectdiscovery.io/opensource/uncover/install

Enter the command below in a terminal to install uncover using Go. This command installs the latest version of uncover.

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

--------------------------------

### Install pdtm and pd-agent

Source: https://docs.projectdiscovery.io/cloud/scanning/internal-scan

Use these commands to install the ProjectDiscovery Tool Manager (pdtm) and then install the pd-agent. Ensure Go is installed on your system.

```bash
go install -v github.com/projectdiscovery/pdtm/cmd/pdtm@latest
pdtm -ia
```

```bash
go install -v github.com/projectdiscovery/pdtm/cmd/pdtm@latest && pdtm -ia
```

--------------------------------

### Install AlterX using Go

Source: https://docs.projectdiscovery.io/opensource/alterx/install

Enter the command below in a terminal to install AlterX using Go. This command installs the latest version of AlterX.

```bash
go install github.com/projectdiscovery/alterx/cmd/alterx@latest
```

--------------------------------

### Install dnsx using Go

Source: https://docs.projectdiscovery.io/opensource/dnsx/install

Use this command to install ProjectDiscovery's dnsx using Go. Ensure Go is installed and the Go bin path is added to your system paths.

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

--------------------------------

### Install Notify using Go

Source: https://docs.projectdiscovery.io/opensource/notify/install

Enter this command in your terminal to install Notify. Requires the latest version of Go.

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

--------------------------------

### Install Subfinder from GitHub Source

Source: https://docs.projectdiscovery.io/opensource/subfinder/install

Clone the Subfinder repository from GitHub, build the binary, and move it to your system's PATH. This method requires Go to be installed.

```bash
git clone https://github.com/projectdiscovery/subfinder.git; \
cd subfinder/v2/cmd/subfinder; \
go build; \
mv subfinder /usr/local/bin/; \
subfinder -version;
```

--------------------------------

### Example Provider Configuration

Source: https://docs.projectdiscovery.io/opensource/cloudlist/running

An example configuration file for Cloudlist, demonstrating how to set up authentication for different cloud providers like DigitalOcean, Scaleway, AWS, and GCP.

```yaml
- provider: do # provider is the name of the provider
  # id is the name defined by user for filtering (optional)
  id: xxxx
  # digitalocean_token is the API key for digitalocean cloud platform
  digitalocean_token: $DIGITALOCEAN_TOKEN

- provider: scw # provider is the name of the provider
  # scaleway_access_key is the access key for scaleway API
  scaleway_access_key: $SCALEWAY_ACCESS_KEY
  # scaleway_access_token is the access token for scaleway API
  scaleway_access_token: $SCALEWAY_ACCESS_TOKEN

- provider: aws # provider is the name of the provider
  # id is the name defined by user for filtering (optional)
  id: staging
  # aws_access_key is the access key for AWS account
  aws_access_key: $AWS_ACCESS_KEY
  # aws_secret_key is the secret key for AWS account
  aws_secret_key: $AWS_SECRET_KEY
  # aws_session_token session token for temporary security credentials retrieved via STS (optional)
  aws_session_token: $AWS_SESSION_TOKEN

- provider: gcp # provider is the name of the provider
  # profile is the name of the provider profile
  id: logs
  # gcp_service_account_key is the minified json of a google cloud service account with list permissions
  gcp_service_account_key: '{xxxxxxxxxxxxx}'
```

--------------------------------

### Install httpx using Homebrew

Source: https://docs.projectdiscovery.io/opensource/httpx/install

Install httpx on macOS or Linux using the Homebrew package manager.

```bash
brew install httpx
```

--------------------------------

### Install Katana using Go

Source: https://docs.projectdiscovery.io/opensource/katana/install

Use this command to install the latest version of Katana via Go. Ensure Go is installed and the bin path is added to your system's PATH environment variable.

```bash
go install github.com/projectdiscovery/katana/cmd/katana@latest
```

--------------------------------

### Install Chaos Client with Go

Source: https://docs.projectdiscovery.io/opensource/chaos/install

Use this command to install the ProjectDiscovery Chaos Client via Go. Requires the latest version of Go.

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

--------------------------------

### Install Subfinder using Go

Source: https://docs.projectdiscovery.io/opensource/subfinder/install

Use this command to install the latest version of Subfinder using Go. Ensure you have the latest Go version installed.

```bash
go install -v github.com/projectdiscovery/subfinder/v2/cmd/subfinder@latest
```

--------------------------------

### Install Interactsh CLI Client

Source: https://docs.projectdiscovery.io/opensource/interactsh/install

Use this command to install the Interactsh CLI client. Requires the latest version of Go.

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

--------------------------------

### Install PDTM using Go

Source: https://docs.projectdiscovery.io/opensource/pdtm/install

Use this command to install ProjectDiscovery's PDTM client with Go. Ensure you have the latest version of Go installed.

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

--------------------------------

### Install cvemap using Go

Source: https://docs.projectdiscovery.io/opensource/cvemap/install

Use this command to install ProjectDiscovery's cvemap via Go. Ensure Go is installed and its bin path is added to your system's PATH.

```bash
go install github.com/projectdiscovery/cvemap/cmd/cvemap@latest
```

--------------------------------

### File Protocol Configuration Example

Source: https://docs.projectdiscovery.io/templates/protocols/file

An example Nuclei template demonstrating the file protocol for detecting Google API keys. It matches all file extensions and uses a regex extractor.

```yaml
id: google-api-key

info:
  name: Google API Key
  author: pdteam
  severity: info

file:
  - extensions:
      - all
      - txt

    extractors:
      - type: regex
        name: google-api-key
        regex:
          - "AIza[0-9A-Za-z\-_]{35}"

```

--------------------------------

### Install dnsx using Homebrew

Source: https://docs.projectdiscovery.io/opensource/dnsx/install

Install dnsx using Homebrew. This method is supported on macOS and Linux.

```bash
brew install dnsx
```

--------------------------------

### Install Nuclei using Homebrew

Source: https://docs.projectdiscovery.io/opensource/nuclei/install

Install Nuclei using Homebrew. Supported in macOS or Linux.

```bash
brew install nuclei
```

--------------------------------

### AlterX Pattern Examples

Source: https://docs.projectdiscovery.io/opensource/alterx/running

Provides examples of how AlterX patterns can be used to generate subdomain permutations based on input variables and a given wordlist.

```console
// Below are some of example patterns which can be used to generate permutations
// assuming api.scanme.sh was given as input and variable {{word}} was given as input with only one value prod
// alterx generates subdomains for below patterns

"{{sub}}-{{word}}.{{suffix}}" // ex: api-prod.scanme.sh
"{{word}}-{{sub}}.{{suffix}}" // ex: prod-api.scanme.sh
"{{word}}.{{sub}}.{{suffix}}" // ex: prod.api.scanme.sh
"{{sub}}.{{word}}.{{suffix}}" // ex: api.prod.scanme.sh
```

--------------------------------

### Install Nuclei using Go

Source: https://docs.projectdiscovery.io/opensource/nuclei/install

Use this command to install the latest version of Nuclei using Go. Requires the latest GO version.

```bash
go install -v github.com/projectdiscovery/nuclei/v3/cmd/nuclei@latest
```

--------------------------------

### DSL Extractor Example

Source: https://docs.projectdiscovery.io/templates/reference/extractors

Use the DSL extractor to evaluate expressions against the response, such as getting the body length.

```yaml
extractors:
  - type: dsl  # type of the extractor
    dsl:
      - len(body) # dsl expression value to extract from response
```

--------------------------------

### Get leak information by ID

Source: https://docs.projectdiscovery.io/llms.txt

Retrieve detailed leak information by leak ID. Passwords are unmasked after domain verification. See Domain Verification for setup instructions.

```APIDOC
## Get leak information by ID

### Description
Retrieve detailed leak information by leak ID. Passwords are unmasked after domain verification. See [Domain Verification](/cloud/credential-monitoring#domain-verification) for setup instructions.

### Method
GET

### Endpoint
/leaks/{leakId}

### Parameters
#### Path Parameters
- **leakId** (string) - Required - The ID of the leak to retrieve.

### Response
#### Success Response (200)
- **leakId** (string) - The ID of the leak.
- **password** (string) - The unmasked password (if domain verified).
- **email** (string) - The email address associated with the leak.
- **domain** (string) - The domain associated with the leak.
- **type** (string) - The type of leak.
- **date** (string) - The date of the leak.
- **details** (object) - Additional details about the leak.

#### Response Example
```json
{
  "leakId": "leak-12345",
  "password": "$2a$10$abcdefghijklmnopqrstuvwxyz0123456789",
  "email": "user@example.com",
  "domain": "example.com",
  "type": "employee",
  "date": "2023-05-15T10:30:00Z",
  "details": {
    "username": "testuser"
  }
}
```
```

--------------------------------

### Usage Example: Get Leak Information via cURL

Source: https://docs.projectdiscovery.io/api-reference/leaks/get-leak-info

This cURL command demonstrates how to make a POST request to the API to retrieve leak information. Ensure you replace 'YOUR_API_KEY' with your actual API key and provide a valid 'leakid'.

```bash
curl -X POST "https://api.projectdiscovery.io/v1/leaks/info" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "leakid": "b3652f2555841f7652badd9804859f4e"
  }'
```

--------------------------------

### Display Cloudlist Help Options

Source: https://docs.projectdiscovery.io/opensource/cloudlist/usage

Use the -h flag to view all available command-line options and their descriptions.

```bash
cloudlist -h
```

--------------------------------

### Get All Results

Source: https://docs.projectdiscovery.io/llms.txt

Get scans results of a user.

```APIDOC
## Get All Results

### Description
Get scans results of a user.

### Method
GET

### Endpoint
/results

### Response
#### Success Response (200)
- **results** (array) - A list of scan results.

#### Response Example
```json
{
  "results": [
    {
      "scanId": "scan-abcde",
      "findings": 15,
      "status": "completed"
    }
  ]
}
```
```

--------------------------------

### Install ProjectDiscovery Tools Individually

Source: https://docs.projectdiscovery.io/quickstart

Install specific ProjectDiscovery tools like Subfinder, HTTPx, and Nuclei individually using Go. Ensure your Go bin path is in your system's PATH.

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

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

```bash
go install -v github.com/projectdiscovery/nuclei/v2/cmd/nuclei@latest
```

--------------------------------

### Get Retest Vulnerability

Source: https://docs.projectdiscovery.io/llms.txt

Get retest vulnerability (retests from editor).

```APIDOC
## Get Retest Vulnerability

### Description
Get retest vulnerability (retests from editor).

### Method
GET

### Endpoint
/retests/vulnerability

### Response
#### Success Response (200)
- **retests** (array) - A list of retest vulnerabilities.

#### Response Example
```json
{
  "retests": [
    {
      "retestId": "retest-xyz",
      "vulnerabilityId": "vuln-456",
      "status": "pending"
    }
  ]
}
```
```

--------------------------------

### Combined Inclusion and Exclusion Example

Source: https://docs.projectdiscovery.io/cloud/assets/exclusions

Demonstrates how to include production systems while excluding a specific staging subdomain. Targets must match an inclusion pattern and not match any exclusion pattern.

```text
+prod-*.company.com
+api.company.com
*.staging.company.com
```

--------------------------------

### Nuclei Configuration File Example

Source: https://docs.projectdiscovery.io/opensource/nuclei/running

An example of a Nuclei configuration file (`config.yaml`) demonstrating how to set default headers, specify template directories and tags, define template filters (allowlist/denylist), and configure rate limiting and concurrency.

```yaml
# Headers to include with all HTTP request
header:
  - 'X-BugBounty-Hacker: h1/geekboy'

# Directory based template execution
templates:
  - cves/
  - vulnerabilities/
  - misconfiguration/

# Tags based template execution
tags: exposures,cve

# Template Filters
tags: exposures,cve
author: geeknik,pikpikcu,dhiyaneshdk
severity: critical,high,medium

# Template Allowlist
# 
# Note: This will take precedence over the .nuclei-ignore file and denylist
# entries (exclude-tags or exclude-templates list).
include-tags: dos,fuzz # Tag based inclusion
include-templates: # Template based inclusion
  - vulnerabilities/xxx
  - misconfiguration/xxxx

# Template Denylist
exclude-tags: info # Tag based exclusion
exclude-templates: # Template based exclusion
  - vulnerabilities/xxx
  - misconfiguration/xxxx

# Rate Limit configuration
rate-limit: 500
bulk-size: 50
concurrency: 50
```

--------------------------------

### Get Vulnerability Changelogs

Source: https://docs.projectdiscovery.io/llms.txt

Get changelogs of specific vulnerability by id.

```APIDOC
## Get Vulnerability Changelogs

### Description
Get changelogs of specific vulnerability by id.

### Method
GET

### Endpoint
/vulnerabilities/{vulnerabilityId}/changelogs

### Parameters
#### Path Parameters
- **vulnerabilityId** (string) - Required - The ID of the vulnerability.

### Response
#### Success Response (200)
- **changelogs** (array) - A list of vulnerability changelogs.

#### Response Example
```json
{
  "changelogs": [
    {
      "changeDate": "2023-01-01T10:00:00Z",
      "description": "Severity updated from Medium to High."
    }
  ]
}
```
```

--------------------------------

### Get Scan Vulnerability

Source: https://docs.projectdiscovery.io/llms.txt

Get scan result vulnerability by ID.

```APIDOC
## Get Scan Vulnerability

### Description
Get scan result vulnerability by ID.

### Method
GET

### Endpoint
/scans/{scanId}/vulnerabilities/{vulnerabilityId}

### Parameters
#### Path Parameters
- **scanId** (string) - Required - The ID of the scan.
- **vulnerabilityId** (string) - Required - The ID of the vulnerability.

### Response
#### Success Response (200)
- **vulnerabilityId** (string) - The ID of the vulnerability.
- **name** (string) - The name of the vulnerability.
- **severity** (string) - The severity of the vulnerability.
- **status** (string) - The status of the vulnerability.

#### Response Example
```json
{
  "vulnerabilityId": "vuln-123",
  "name": "SQL Injection",
  "severity": "High",
  "status": "Open"
}
```
```

--------------------------------

### List Assets from Cloud Providers in Go

Source: https://docs.projectdiscovery.io/opensource/cloudlist/running

Use this snippet to initialize Cloudlist and retrieve resources from specified cloud providers. Ensure you provide the necessary authentication tokens for each provider.

```go
package main

import (
  "context"
  "log"

  "github.com/projectdiscovery/cloudlist/pkg/inventory"
  "github.com/projectdiscovery/cloudlist/pkg/schema"
)

func main() {
  inventory, err := inventory.New(schema.Options{
    schema.OptionBlock{"provider": "digitalocean", "digitalocean_token": "ec405badb974fd3d891c9223245f9ab5871c127fce9e632c8dc421edd46d7242"},
  })
  if err != nil {
    log.Fatalf("%s\n", err)
  }

  for _, provider := range inventory.Providers {
    resources, err := provider.Resources(context.Background())
    if err != nil {
      log.Fatalf("%s\n", err)
    }
    for _, resource := range resources.Items {
      _ = resource // Do something with the resource
    }
  }
}
```

--------------------------------

### Use Case: Manual Asset Review (Bash)

Source: https://docs.projectdiscovery.io/api-reference/assets/add-labels-to-asset

Example of labeling an asset as 'reviewed' and 'approved' after manual inspection.

```bash
curl -X POST "https://api.projectdiscovery.io/v1/asset/789012/labels" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "labels": ["reviewed", "approved"]
  }'
```

--------------------------------

### Example: Nuclei Scan using Template-Defined Search Queries

Source: https://docs.projectdiscovery.io/opensource/nuclei/running

Demonstrates running Nuclei scans using templates that leverage the uncover module. The first command scans a specific CVE template, while the second scans all templates tagged 'cve' against hosts found by uncover.

```console
nuclei -t cves/2021/CVE-2021-26855.yaml -uncover
nuclei -tags cve -uncover
```

--------------------------------

### HTTP Request Example

Source: https://docs.projectdiscovery.io/templates/protocols/http/fuzzing-overview

An example of an HTTP request that will be abstracted into key-value pairs for fuzzing.

```http
POST /reset-password?token=x0x0x0&source=app HTTP/1.1
Host: 127.0.0.1:8082
User-Agent: Go-http-client/1.1
Cookie: PHPSESSID=1234567890
Content-Length: 23
Content-Type: application/json
Accept-Encoding: gzip
Connection: close

{"password":"12345678"}
```

--------------------------------

### Initialize MySQL Client

Source: https://docs.projectdiscovery.io/templates/protocols/javascript/modules/mysql.MySQLClient

Instantiate the MySQLClient class. This is the first step before performing any database operations.

```javascript
const mysql = require('nuclei/mysql');
const client = new mysql.MySQLClient;
```

--------------------------------

### Install Subfinder using Homebrew

Source: https://docs.projectdiscovery.io/opensource/subfinder/install

Install Subfinder using Homebrew, which is supported on macOS and Linux.

```bash
brew install subfinder
```

--------------------------------

### Running Katana with Custom Fields

Source: https://docs.projectdiscovery.io/opensource/katana/running

Example command to run Katana using custom fields 'email' and 'phone' that have been previously defined in a configuration file.

```bash
katana -u https://tesla.com -f email,phone
```

--------------------------------

### Quick Troubleshooting Reference Commands

Source: https://docs.projectdiscovery.io/cloud/credential-monitoring

A consolidated reference for commands used to troubleshoot domain verification across different methods (DNS, HTML, File).

```bash
dig TXT yourdomain.com
```

```bash
curl -s https://yourdomain | grep projectdiscovery-verification
```

```bash
curl -s https://yourdomain/pd-verification.txt
```

--------------------------------

### Asynchronous Response Example

Source: https://docs.projectdiscovery.io/api-reference/assets/update-asset-labels

This is an example of an asynchronous response, returned for larger operations that are queued for background processing.

```json
{
  "message": "Label update queued",
  "asset_count": 5000,
  "async": true
}
```

--------------------------------

### Example: Replace All Labels on Asset

Source: https://docs.projectdiscovery.io/api-reference/assets/modify-asset-labels

Demonstrates replacing all existing labels on an asset with a new set. The 'Before' and 'After' states show the complete label replacement.

```json
{
  "id": 123456,
  "name": "https://api.example.com",
  "labels": ["production", "api", "old-label", "deprecated"]
}
```

```bash
curl -X PATCH "https://api.projectdiscovery.io/v1/asset/123456/labels?update_type=replace" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "labels": ["staging", "testing"]
  }'
```

```json
{
  "id": 123456,
  "name": "https://api.example.com",
  "labels": ["staging", "testing"]
}
```

--------------------------------

### Synchronous Response Example

Source: https://docs.projectdiscovery.io/api-reference/assets/update-asset-labels

This is an example of a synchronous response, typically returned for smaller operations where the update is processed immediately.

```json
{
  "message": "Labels updated successfully",
  "asset_count": 42,
  "async": false
}
```

--------------------------------

### Install Dependencies for Headless Mode on Ubuntu (Without Snap)

Source: https://docs.projectdiscovery.io/opensource/nuclei/faq

Install necessary packages including wget, git, and Google Chrome for headless mode on Ubuntu if not using snap. Ensure your system is updated before proceeding.

```bash
sudo apt update
sudo snap refresh
sudo apt install zip curl wget git
sudo snap install golang --classic
wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | sudo apt-key add -

```

```bash
sudo sh -c 'echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
sudo apt update
sudo apt install google-chrome-stable
```

--------------------------------

### Katana JSONL Output Example

Source: https://docs.projectdiscovery.io/opensource/katana/running

This is an example of the JSON Lines output generated by Katana, showing request and response details.

```json
{
  "timestamp": "2023-03-20T16:23:58.027559+05:30",
  "request": {
    "method": "GET",
    "endpoint": "https://example.com",
    "raw": "GET / HTTP/1.1\r\nHost: example.com\r\nUser-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 11_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36\r\nAccept-Encoding: gzip\r\n\r\n"
  },
  "response": {
    "status_code": 200,
    "headers": {
      "accept_ranges": "bytes",
      "expires": "Mon, 27 Mar 2023 10:53:58 GMT",
      "last_modified": "Thu, 17 Oct 2019 07:18:26 GMT",
      "content_type": "text/html; charset=UTF-8",
      "server": "ECS (dcb/7EA3)",
      "vary": "Accept-Encoding",
      "etag": "\"3147526947\"",
      "cache_control": "max-age=604800",
      "x_cache": "HIT",
      "date": "Mon, 20 Mar 2023 10:53:58 GMT",
      "age": "331239"
    },
    "body": "<!doctype html>\n<html>\n<head>\n    <title>Example Domain</title>\n\n    <meta charset=\"utf-8" />\n    <meta http-equiv=\"Content-type\" content=\"text/html; charset=utf-8" />\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1" />\n    <style type=\"text/css\">
    body {\n        background-color: #f0f0f2;\n        margin: 0;\n        padding: 0;\n        font-family: -apple-system, system-ui, BlinkMacSystemFont, \"Segoe UI\", \"Open Sans\", \"Helvetica Neue\", Helvetica, Arial, sans-serif;\n        \n    }\n    div {\n        width: 600px;\n        margin: 5em auto;\n        padding: 2em;\n        background-color: #fdfdff;\n        border-radius: 0.5em;\n        box-shadow: 2px 3px 7px 2px rgba(0,0,0,0.02);\n    }\n    a:link, a:visited {\n        color: #38488f;\n        text-decoration: none;\n    }\n    @media (max-width: 700px) {\n        div {\n            margin: 0 auto;\n            width: auto;\n        }\n    }\n    </style>    \n</head>\n\n<body>\n<div>\n    <h1>Example Domain</h1>\n    <p>This domain is for use in illustrative examples in documents. You may use this\n    domain in literature without prior coordination or asking for permission.</p>\n    <p><a href=\"https://www.iana.org/domains/example\">More information...</a></p>\n</div>\n</body>\n</html>\n",
    "technologies": [
      "Azure",
      "Amazon ECS",
      "Amazon Web Services",
      "Docker",
      "Azure CDN"
    ],
    "raw": "HTTP/1.1 200 OK\r\nContent-Length: 1256\r\nAccept-Ranges: bytes\r\nAge: 331239\r\nCache-Control: max-age=604800\r\nContent-Type: text/html; charset=UTF-8\r\nDate: Mon, 20 Mar 2023 10:53:58 GMT\r\nEtag: \"3147526947\"\r\nExpires: Mon, 27 Mar 2023 10:53:58 GMT\r\nLast-Modified: Thu, 17 Oct 2019 07:18:26 GMT\r\nServer: ECS (dcb/7EA3)\r\nVary: Accept-Encoding\r\nX-Cache: HIT\r\n\r\n<!doctype html>\n<html>\n<head>\n    <title>Example Domain</title>\n\n    <meta charset=\"utf-8" />\n    <meta http-equiv=\"Content-type\" content=\"text/html; charset=utf-8" />\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1" />\n    <style type=\"text/css\">
    body {\n        background-color: #f0f0f2;\n        margin: 0;\n        padding: 0;\n        font-family: -apple-system, system-ui, BlinkMacSystemFont, \"Segoe UI\", \"Open Sans\", \"Helvetica Neue\", Helvetica, Arial, sans-serif;\n        \n    }\n    div {\n        width: 600px;\n        margin: 5em auto;\n        padding: 2em;\n        background-color: #fdfdff;\n        border-radius: 0.5em;\n        box-shadow: 2px 3px 7px 2px rgba(0,0,0,0.02);\n    }\n    a:link, a:visited {\n        color: #38488f;\n        text-decoration: none;\n    }\n    @media (max-width: 700px) {\n        div {\n            margin: 0 auto;\n            width: auto;\n        }\n    }\n    </style>    \n</head>\n\n<body>\n<div>\n    <h1>Example Domain</h1>\n    <p>This domain is for use in illustrative examples in documents. You may use this\n    domain in literature without prior coordination or asking for permission.</p>\n    <p><a href=\"https://www.iana.org/domains/example\">More information...</a></p>\n</div>\n</body>\n</html>\n"
  }
}
```

--------------------------------

### DNSX as a Go Library

Source: https://docs.projectdiscovery.io/opensource/dnsx/running

Example of using the DNSX library in a Go program to perform DNS lookups. It demonstrates creating a client, performing A record lookups, and querying raw responses.

```go
package main

import (
	"fmt"

	"github.com/projectdiscovery/dnsx/libs/dnsx"
)

func main() {
	// Create DNS Resolver with default options
	dnsClient, err := dnsx.New(dnsx.DefaultOptions)
	if err != nil {
		fmt.Printf("err: %v\n", err)
		return
	}

	// DNS A question and returns corresponding IPs
	result, err := dnsClient.Lookup("hackerone.com")
	if err != nil {
		fmt.Printf("err: %v\n", err)
		return
	}
	for idx, msg := range result {
		fmt.Printf("%d: %s\n", idx+1, msg)
	}

	// Query
	rawResp, err := dnsClient.QueryOne("hackerone.com")
	if err != nil {
		fmt.Printf("err: %v\n", err)
		return
	}
	fmt.Printf("rawResp: %v\n", rawResp)

	jsonStr, err := rawResp.JSON()
	if err != nil {
		fmt.Printf("err: %v\n", err)
		return
	}
	fmt.Println(jsonStr)

	return
}
```

--------------------------------

### Create a labeling policy

Source: https://docs.projectdiscovery.io/api-reference/assets/create-asset-policy

This example demonstrates creating a policy to tag assets identified as WordPress sites.

```APIDOC
## POST /v1/asset/policy

### Description
Create a new asset policy that automatically takes action on assets matching defined conditions.

### Method
POST

### Endpoint
/v1/asset/policy

### Request Body
- **name** (string) - Required - The name of the policy.
- **policy_type** (string) - Required - The type of policy. Supported types: `alert`, `delete`, `set_label`, `remove_label`.
- **policies** (object) - Required - The conditions for the policy to match.
  - **host** (string) - Optional - Matches assets with the specified host.
  - **status_code** (string) - Optional - Matches assets with the specified HTTP status code.
  - **port** (string) - Optional - Matches assets with the specified ports (comma-separated).
  - **technologies** (string) - Optional - Matches assets with the specified technologies.
- **apply_to_existing** (boolean) - Optional - If true, applies the policy to existing matching assets immediately. Defaults to false.
- **alerting_config_ids** (array of strings) - Required if `policy_type` is `alert` - IDs of the alerting configurations to use.
- **labels** (array of strings) - Required if `policy_type` is `set_label` or `remove_label` - The labels to add or remove.

### Request Example
```json
{
  "name": "Tag WordPress sites",
  "policy_type": "set_label",
  "policies": {
    "technologies": "WordPress"
  },
  "labels": ["cms", "wordpress"],
  "apply_to_existing": true
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the created policy.
- **name** (string) - The name of the policy.
- **policy_type** (string) - The type of the policy.
- **policies** (object) - The conditions for the policy.
- **apply_to_existing** (boolean) - Whether the policy applies to existing assets.
- **created_at** (string) - The timestamp when the policy was created.
```

--------------------------------

### JSON Export Response Example

Source: https://docs.projectdiscovery.io/api-reference/leaks/export-leaks

This is an example of a JSON response when exporting leaked credentials. It includes details about each leak and a summary.

```json
{
  "data": [
    {
      "id": "leak_id_hash",
      "url": "https://example.com",
      "username": "user@example.com", 
      "password": "masked_password",
      "device_ip": "192.168.1.1",
      "hostname": "DESKTOP-ABC123",
      "os": "Windows 10",
      "country": "United States",
      "log_date": "2023-01-15",
      "hardware_id": "hw_12345",
      "domain": "example.com",
      "email_domain": "example.com",
      "url_domain": "example.com",
      "status": "open",
      "user_type": "employee"
    }
  ],
  "total_leaks": 150,
  "summary": {
    "total_leaks": 150,
    "personal_leaks": 25,
    "employee_leaks": 100,
    "customer_leaks": 25
  }
}
```

--------------------------------

### AWS Configuration Example

Source: https://docs.projectdiscovery.io/opensource/cloudlist/providers

Integrate AWS by using this configuration block. Ensure you provide valid AWS credentials and optionally session tokens or assume role names.

```yaml
- provider: aws
  id: staging
  aws_access_key: $AWS_ACCESS_KEY
  aws_secret_key: $AWS_SECRET_KEY
  aws_session_token: $AWS_SESSION_TOKEN
  assume_role_name: $AWS_ASSUME_ROLE_NAME
  account_ids:
    - $AWS_ACCOUNT_ID_1
    - $AWS_ACCOUNT_ID_2
```

--------------------------------

### Basic HTTP GET Request

Source: https://docs.projectdiscovery.io/templates/protocols/http/basic-http-examples

A basic template to perform a GET request to the base URL and match a specific string in the response.

```yaml
id: basic-example

info:
  name: Test HTTP Template
  author: pdteam
  severity: info

http:
  - method: GET
    path:
      - "{{BaseURL}}"
    matchers:
      - type: word
        words:
          - "This is test matcher text"
```

--------------------------------

### Pipe Uncover Output to naabu for Port Scanning

Source: https://docs.projectdiscovery.io/opensource/uncover/running

This example demonstrates piping the IP addresses found by uncover to naabu for port scanning. It assumes a query '-q example' has been run.

```console
uncover -q example -f ip | naabu
```

--------------------------------

### CSV Export Response Example

Source: https://docs.projectdiscovery.io/api-reference/leaks/export-leaks

This is an example of a CSV response when exporting leaked credentials. It provides a comma-separated list of leak data.

```csv
id,url,username,password,device_ip,hostname,os,country,log_date,hardware_id,domain,email_domain,url_domain,status,user_type
leak_id_hash,https://example.com,user@example.com,masked_password,192.168.1.1,DESKTOP-ABC123,Windows 10,United States,2023-01-15,hw_12345,example.com,example.com,example.com,open,employee
```

--------------------------------

### Initialize and Set IP Address for Kerberos Client

Source: https://docs.projectdiscovery.io/templates/protocols/javascript/modules/kerberos.Config

Demonstrates how to create a new Kerberos Config object and set a specific IP address for the client. Use this to configure the network endpoint for Kerberos communication.

```javascript
const kerberos = require('nuclei/kerberos');
const cfg = new kerberos.Config();
cfg.SetIPAddress('10.10.10.1');
```

--------------------------------

### Check if Line Starts With Prefix

Source: https://docs.projectdiscovery.io/templates/reference/helper-functions

Checks if any line within a string starts with any of the specified prefixes. Ideal for parsing multi-line inputs.

```go
line_starts_with("Hi\nHello", "He")
```

--------------------------------

### Example Use: Subdomain Enumeration, URL Probing, and Vulnerability Scanning

Source: https://docs.projectdiscovery.io/opensource/notify/running

This example chains SubFinder, httpx, and Nuclei to enumerate subdomains, probe alive URLs, and scan for vulnerabilities, sending the results to configured providers via Notify.

```sh
subfinder -d intigriti.com | httpx | nuclei -tags exposure -o output.txt; notify -bulk -data output.txt
```

--------------------------------

### Install Development Version of libnss3

Source: https://docs.projectdiscovery.io/opensource/nuclei/faq

If you encounter 'libnss3.so: cannot open shared object file' errors, install the development version of the library to resolve the issue.

```bash
sudo apt-get install libnss3-dev
```
Tokens:
Raw