Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/root4loot/rescope

A scope generation tool for Burp Suite & ZAP
https://github.com/root4loot/rescope

bugbounty burp burpsuite enumeration go golang infosec pentesting scope security security-tools websec zap

Last synced: about 2 months ago
JSON representation

A scope generation tool for Burp Suite & ZAP

Host: GitHub
URL: https://github.com/root4loot/rescope
Owner: root4loot
License: mit
Created: 2019-03-06T21:20:55.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-10-27T10:45:02.000Z (11 months ago)
Last Synced: 2024-02-15T09:33:52.182Z (7 months ago)
Topics: bugbounty, burp, burpsuite, enumeration, go, golang, infosec, pentesting, scope, security, security-tools, websec, zap
Language: Go
Homepage: https://root4loot.com/tags/rescope/
Size: 2.72 MB
Stars: 308
Watchers: 9
Forks: 61
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

cybersecurity-golang-security - rescope - Parse scope definitions to Burp Suite / ZAP compatible formats for import (Web Application Testing)
awesome-go-security - rescope - Parse scope definitions to Burp Suite / ZAP compatible formats for import (Web Application Testing)
awesome-hacking-lists - root4loot/rescope - A scope generation tool for Burp Suite & ZAP (Go)

README

        
![](assets/logo.png)

![GitHub release](https://img.shields.io/github/release-pre/root4loot/rescope.svg)

![GitHub](https://img.shields.io/github/license/root4loot/rescope.svg)

[![Go Report Card](https://goreportcard.com/badge/github.com/root4loot/rescope)](https://goreportcard.com/report/github.com/root4loot/rescope)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/root4loot/rescope/issues)

![Twitter Follow](https://img.shields.io/twitter/follow/danielantonsen.svg?style=social)

Rescope is a cli-tool (written in Go) that aims to make life easier when defining scopes in Burp Suite and OWASP ZAP.

## How it works

1. Provide any public or private scope.

2. rescope takes care of the rest and spits out a Burp/ZAP compatible JSON/XML file.

3. Import results from Burp/ZAP.

- [Installation](#installation)

- [Features](#features)

- [Supported bugbounty platforms](#supported-bug-bounty-services-bbaas)

- [Usage](#usage)

- [Arguments](#arguments)

- [Public scopes](#public-scopes)

- [Private scopes](#private-scopes)

- [Combining Public and Private Scopes](#combining-public-and-private-scopes)

- [Importing to Burp/ZAP](#importing-results)

## ☛ Installation

Requires [Go]() and git

```

go install github.com/root4loot/rescope@latest

```

## Features

* Define public scope(s) directly from any supported BBaaS (**Bug-Bounty-as-a-Service**) platform

* Define private scopes by copy/pasting target definitions from pretty much anywhere

* Outputs results that is compatible with Burp Suite and Zaproxy for direct import

* Combine private and public scopes

* Scope include/exclude separation

* Parse multiple scopes to the same result

* Supports IP-ranges & CIDR

* Resolves conflicting includes/excludes

* Avoid resources from third party services such as github.com, gitlab.com, itunes.apple.com, etc

### Supported Bug-Bounty Services (BBaaS)

- [bugcrowd.com](https://bugcrowd.com)

- [hackerone.com](https://hackerone.com)

- [hackenproof.com](https://hackenproof.com)

- [intigriti.com](https://www.intigriti.com/public)

- [openbugbounty.com](https://www.openbugbounty.org)

- [yeswehack.com](https://yeswehack.com)

- [bugbounty.jp](https://bugbounty.jp)

- [federacy.com](https://www.federacy.com)

## Usage

```

usage: rescope [arguments]

```

### Arguments

| Short | Long       	     | Description                   					                 |

| :---: |:------------------:| :---------------------------------------------------------------- |

| -h    | --help     	     | Print help information        					 

| -z    | --zap      	     | Export scope to ZAP-compatible XML instead of default (Burp JSON) |

| -r    | --raw      	     | Export raw scope-definitions to list of text                      |

| -u    | --url      	     | Public bug bounty program URL 					                 |

| -i    | --infile   	     | File containing scope-definitions     					         |

| -o    | --outfile  	     | Save results to given filename  					                 |

| -s    | --silent   	     | Do not print identified targets 					                 |

| -n    | --name     	     | Name of ZAP context           					                 |

|       | --itag     	     | Custom include tag (default: !INCLUDE) 			                 |

|       | --etag     	     | Custom exclude tag (default: !EXCLUDE) 			                 |

|       | --resolveConflicts | Resolve all exclude conflicts                                     |

|       | --avoid3P          | Avoid all third party resources                                   |

|       | --version          | Print version                 					                 |

### Example Usage

Parse scopes from public bugbounty program to Burp (JSON)  

`rescope -u hackerone.com/security -o burpscope.json`  

Parse scopes from public bugbounty programs to ZAP (XML)  

`rescope --zap --name CoolScope -u hackerone.com/security -o zapscope.context`

Parse scope from infile having target definitions to Burp (JSON)  

`rescope -i scope.txt -o burpscope.json`

### Example Result



## Public Scopes

Defining scopes as a bugbounty researcher has never been this easy.  

(For private bugbounty scopes, see [Private Scopes](#private-scopes))

```

rescope -u hackerone.com/security -o burpscope.json

```

rescope will print out a list of identified targets as seen below. Use this list to verify that it got what you wanted.  

Includes (+) are highlighted in Green, and Excludes (-) in Red.

```diff

$ rescope -u hackerone.com/security -o burpscope.json

[-] Grabbing targets from hackerone.com/security 

+  https://hackerone.com

+  https://api.hackerone.com

+  *.vpn.hackerone.net

+  https://hackerone-us-west-2-production-attachments.s3-us-west-2.amazonaws.com/

+  https://www.hackerone.com

+  https://errors.hackerone.net

+  https://*.hackerone-ext-content.com

+  https://ctf.hacker101.com

+  https://*.hackerone-user-content.com/

+  66.232.20.0/23

+  206.166.248.0/23

-  https://support.hackerone.com

-  https://ma.hacker.one

-  https://www.hackeronestatus.com/

-  https://info.hacker.one/

-  https://go.hacker.one

[-] Parsing to JSON (Burp Suite)

[✓] Done. Wrote 185786 bytes to burpscope.json

```

The resulting file may now be imported to Burp or ZAP depending on your choice. See [importing results](#importing-results) for details.

### Defining multiple scopes

Defining multiple scopes at once (to the same result) is only a matter of setting `-u`  several times.

```

rescope --zap -u hackerone.com/security -u bugcrowd.com/bugcrowd -u intigriti.com/intigriti/intigriti --name CoolScope -o zapscope.context

```

Alternatively, list them in an infile as so.

```

$ cat combined.txt

hackerone.com/security

bugcrowd.com/bugcrowd

intigriti.com/intigriti/intigriti

```

And pass this as an infile.

```

rescope  -i combined.txt -o burpscope.json

```

## Private Scopes

**Update:** HackerOne users may parse private scopes directly by setting environment variable `H1_TOKEN` to the value of `X-Auth-Token`.  

rescope is not limited to public BBaaS scopes.  

If your scope is private then list targets in a text file and pass it to `--infile` (`-i`).

Example scope:

```

$ cat scope.txt

target1.example.com

target2.example.com

target3.example.com

192.168.0.1/24

10.10.10.1-3

```

```

rescope  -i scope.txt -o burpscope.json

```

Defining multiple scopes at once (to the same result) is only a matter of setting `-i`  several times.

```

rescope --zap -i scope1.txt -i scope2.txt --name CoolScope -o zapscope.context

```

One of the neat things about rescope is that it'll automagically detect the targets from the scope you provide- meaning they don't have to be in a specific structure/format. This allows you to simply copy/paste the scope from pretty much anywhere and provide it to rescope without the need of having to filter it out in advance.

I.e., the same scope as above, but with some leading/ending text and multiple targets on the same line.

```sh

$ cat scope.txt

High priority: target1.example.com

Medium: target2.example.com and target3.example.com

Internal: 192.168.0.1/24 (department A)

          10.10.10.1-3

```

As seen below, rescope was able to identify the targets, despite having leading text or multiple hosts on the same line. Includes (+) are highlighted in Green, and Excludes (-) in Red. Use this list to verify that it got what you wanted.

```diff

$ rescope -i scope.txt -o burpscope.json

[-] Grabbing targets from scope.txt

+  target1.example.com

+  target2.example.com

+  target3.example.com

+  192.168.0.1/24

+  10.10.10.1-3

[-] Parsing to JSON (Burp Suite)

[✓] Done. Wrote 46555 bytes to burpscope.json

```

### Setting Excludes

Out-of-scope targets are set by specifying **!EXCLUDE** in the document, followed by the targets you want to exclude. Any target succeeding this tag is excluded (exclusively) from the scope. A custom exclude tag can be set with the optional `--etag` argument.

Example (scope.txt):

```

In-Scope:

target1.example.com

target2.example.com

target3.example.com

!EXCLUDE

Out-of-Scope:

target4.example.com

target5.example.com

```

If the "out-of-scope" targets happen to come _before_ the list of includes, then you must either move out-of-scope section _after_ the list of includes, or provide an **!INCLUDE** tag before the list of in-scope targets. A custom include tag can be set with the optional `--itag` argument.

Example (scope.txt):

```

!EXCLUDE

Out-of-Scope:

target4.example.com

target5.example.com

!INCLUDE  <-- required when excludes come first

In-Scope:

target1.example.com

target2.example.com

target3.example.com

```

## Combining Public and Private Scopes

Rescope is flexible in that you can define both public and private scopes to the same result.  

This is accomplished by simply combining `-u`  and `-i`  as seen below.

```sh

rescope -i scope.txt -u bugcrowd.com/bugcrowd -o burpscope.json

```

Alternatively, you can include BBaaS URL's in an infile, along with your private identifiers.  

The position at which you place these URL's does not matter.

```

$ cat scope.txt

bugcrowd.com/bugcrowd

hackerone.com/security  

intigriti.com/intigriti/intigriti  

!INCLUDE

target1.example.com

target2.example.com

!EXCLUDE

target3.example.com

```

```

$ rescope --zap --name CoolScope -i scope.txt -o zapscope.context --silent

[-] Identified BBaaS program (bugcrowd.com/bugcrowd) in scope.txt

[-] Identified BBaaS program (hackerone.com/security) in scope.txt

[-] Identified BBaaS program (intigriti.com/intigriti/intigriti) in scope.txt

[-] Grabbing targets from scope.txt

[-] Grabbing targets from bugcrowd.com/bugcrowd

[-] Grabbing targets from hackerone.com/security

[-] Grabbing targets from intigriti.com/intigriti/intigriti

[-] Parsing to XML (OWASP ZAP)

[✓] Done. Wrote 68994 bytes to zapscope.context

```

## Importing results

### Burp Suite

1. Head to **Target** -> ⚙︎ Scope settings

2. Click the ⚙︎ icon below "Target Scope" and choose "Load Settings"

3. Choose file exported from rescope

### OWASP ZAP

Choose **File** -> **Import Context** and select XML file.

**Note for OWASP ZAP:**

- If you set `-o` filename extension to anything other than `.context` then you'll have to choose "All Format" in file select.

- For ZAP HUD; set context `--name "HUD Context"`

## TODO

- Scrap argparse

- Pipe support

- Docker support

- Add more unit tests

- CI

## Author

* Daniel Antonsen [@danielantonsen](https://twitter.com/danielantonsen)

## License

Licensed under MIT (see license file)