ChopChop is a command-line tool for dynamic application security testing on web applications, initially written by the Michelin CERT.
Its goal is to scan several endpoints and identify exposition of services/files/folders through the webroot. Checks/Signatures are declared in a config file (by default: chopchop.yml
), fully configurable, and especially by developers.
"Chop chop" is a phrase rooted in Cantonese. "Chop chop" means "hurry" and suggests that something should be done now and without delay.
Building
We tried to make the build process painless and hopefully, it should be as easy as:
$ go mod download
$ go build .
There should be a resulting gochopchop
binary in the folder.
Using Docker
Thanks to Github Container Registry, we are able to provide you some freshly-build Docker images!
docker run ghcr.io/michelin/gochopchop scan https://foobar.com -v debug
But if you prefer, you can also build it locally, see below:
Build locally
docker build -t gochopchop .
Usage
We are continuously trying to make goChopChop
as easy as possible. Scanning a host with this utility is as simple as :
$ ./gochopchop scan https://foobar.com
Using Docker
docker run gochopchop scan https://foobar.com
Custom configuration file
docker run -v ./:/app chopchop scan -c /app/chopchop.yml https://foobar.com
What's next
The Golang rewrite took place a couple of months ago but there's so much to do, still. Here are some features we are planning to integrate : [x] Threading for better performance [x] Ability to specify the number of concurrent threads [x] Colors and better formatting [x] Ability to filter checks/signatures to search for [x] Mock and unit tests [x] Github CI And much more!
Testing
To quickly end-to-end test chopchop, we provided a web-server in tests/server.go
. To try it, please run go run tests/server.go
then run chopchop with the following command ./gochopchop scan http://localhost:8000 --verbosity Debug
. ChopChop should print "no vulnerabilities found".
There are also unit test that you can launch with go test -v ./...
. These tests are integrated in the github CI workflow.
Available flags
You can find the available flags available for the scan
command :
Flag | Full flag | Description |
---|---|---|
-h | --help | Help wizard |
-v | --verbosity | Verbose level of logging |
-c | --signature | Path of custom signature file |
-k | --insecure | Disable SSL Verification |
-u | --url-file | Path to a specified file containing urls to test |
-b | --max-severity | Block the CI pipeline if severity is over or equal specified flag |
-e | --export | Export type of the output (csv and/or json) |
--export-filename | Specify the filename for the export file(s) | |
-t | --timeout | Timeout for the HTTP requests |
--severity-filter | Filter Plugins by severity | |
--plugin-filter | Filter Plugins by name of plugin | |
--threads | Number of concurrent threads |
Advanced usage
Here is a list of advanced usage that you might be interested in. Note: Redirectors like >
for post processing can be used.
- Ability to scan and disable SSL verification
$ ./gochopchop scan https://foobar.com --insecure
- Ability to scan with a custom configuration file (including custom plugins)
$ ./gochopchop scan https://foobar.com --insecure --signature test_config.yml
- Ability to list all the plugins or by severity :
plugins
orplugins --severity High
$ ./gochopchop plugins --severity High
- Ability to specify number of concurrent threads :
--threads 4
for 4 workers
$ ./gochopchop plugins --threads 4
- Ability to block the CI pipeline by severity level (equal or over specified severity) :
--max-severity Medium
$ ./gochopchop scan https://foobar.com --max-severity Medium
- Ability to specify specific signatures to be checked
./gochopchop scan https://foobar.com --timeout 1 --verbosity --export=csv,json --export-filename boo --plugin-filters=Git,Zimbra,Jenkins
- Ability to list all the plugins
$ ./gochopchop plugins
- List High severity plugins
$ ./gochopchop plugins --severity High
- Set a list or URLs located in a file
$ ./gochopchop scan --url-file url_file.txt
- Export GoChopChop results in CSV and JSON format
$ ./gochopchop scan https://foobar.com --export=csv,json --export-filename results
Creating a new check
Writing a new check is as simple as :
- endpoint: "/.git/config"
checks:
- name: Git exposed
match:
- "[branch"
remediation: Do not deploy .git folder on production servers
description: Verifies that the GIT repository is accessible from the site
severity: "High"
An endpoint (eg. /.git/config
) is mapped to multiple checks which avoids sending X requests for X checks. Multiple checks can be done through a single HTTP request. Each check needs those fields:
Attribute | Type | Description | Optional ? | Example |
---|---|---|---|---|
name | string | Name of the check | No | Git exposed |
description | string | A small description for the check | No | Ensure .git repository is not accessible from the webroot |
remediation | string | Give a remediation for this specific "issue" | No | Do not deploy .git folder on production servers |
severity | Enum("High", "Medium", "Low", "Informational") | Rate the criticity if it triggers in your environment | No | High |
status_code | integer | The HTTP status code that should be returned | Yes | 200 |
headers | List of string | List of headers there should be in the HTTP response | Yes | N/A |
no_headers | List of string | List of headers there should NOT be in the HTTP response | Yes | N/A |
match | List of string | List the strings there should be in the HTTP response | Yes | "[branch" |
no_match | List of string | List the strings there should NOT be in the HTTP response | Yes | N/A |
query_string | GET parameters that have to be passed to the endpoint | String | Yes | query_string: "id=FOO-chopchoptest" |
External Libraries
Library Name | Link | License |
---|---|---|
Viper | https://github.com/spf13/viper | MIT License |
Go-pretty | https://github.com/jedib0t/go-pretty | MIT License |
Cobra | https://github.com/spf13/cobra | Apache License 2.0 |
strfmt | https://github.com/go-openapi/strfmt | Apache License 2.0 |
Go-homedir | https://github.com/mitchellh/go-homedir | MIT License |
pkg-errors | https://github.com/pkg/errors | BSD 2 (Simplified License) |
Go-runewidth | https://github.com/mattn/go-runewidth | MIT License |
Please, refer to the third-party.txt
file for further information.
Talks
- PyCon FR 2019 (The tool was initially developed in Python) - https://docs.google.com/presentation/d/1uVXGUpt7tC7zQ1HWegoBbEg2LHamABIqfDfiD9MWsD8/edit
- DEFCON AppSec Village 2020 "Turning offsec mindset to developer's toolset" - https://drive.google.com/file/d/15P8eSarIohwCVW-tR3FN78KJPGbpAtR1/view
License
ChopChop has been released under Apache License 2.0. Please, refer to the LICENSE
file for further information.
Authors
- Paul A.
- David R. (For the Python version)
- Stanislas M. (For the Golang version)
Related news
- Hacker Tools For Pc
- Hacking Tools For Windows 7
- Hacking Tools Software
- New Hack Tools
- Android Hack Tools Github
- Hack Tools For Mac
- Hack Tools
- Hacking Tools Software
- Pentest Tools List
- Hacking Tools Online
- Pentest Tools Url Fuzzer
- Pentest Tools Find Subdomains
- Pentest Tools Website
- Hackrf Tools
- World No 1 Hacker Software
- Hacking Tools And Software
- Github Hacking Tools
- Easy Hack Tools
- Hacking Tools
- Pentest Tools Find Subdomains
- Hacker Techniques Tools And Incident Handling
- Hacker Tools Apk Download
- Pentest Tools Framework
- Pentest Tools Website Vulnerability
- Pentest Tools Bluekeep
- Hacking Tools Kit
- Hacking Tools For Beginners
- Hack Tool Apk
- Hacking Tools For Mac
- Pentest Reporting Tools
- Hacking Tools Mac
- Hacker Security Tools
- Pentest Tools Free
- Best Hacking Tools 2019
- Tools Used For Hacking
- Free Pentest Tools For Windows
- Hacking Tools Hardware
- Easy Hack Tools
- Hacking Tools For Beginners
- Hack Tools For Ubuntu
- Pentest Automation Tools
- Hacking Tools For Windows 7
- Hacker Tools For Ios
- Pentest Tools Tcp Port Scanner
- Hacking Tools Free Download
- Install Pentest Tools Ubuntu
- Top Pentest Tools
- Hak5 Tools
- Hacking Tools For Pc
- Pentest Tools Github
- Hack Tools Online
- How To Make Hacking Tools
- What Are Hacking Tools
- Hack Tools For Pc
- Free Pentest Tools For Windows
- How To Hack
- Hacking Tools 2020
- Hacking Tools For Windows 7
- Hacker Tools Hardware
- Pentest Tools List
- Pentest Tools Apk
- Hacking Tools For Games
- Tools 4 Hack
- Pentest Tools Website Vulnerability
- Best Pentesting Tools 2018
- Pentest Tools Android
- Hacking Tools Mac
- Hacking Tools Github
- Hack Tools For Pc
- Hak5 Tools
- Pentest Tools Kali Linux
- Hack Tools Mac
- Hack Website Online Tool
- Hacking Tools Github
- Hacking Tools 2020
- Hacker Tools For Pc
- Pentest Tools Windows
- Pentest Recon Tools
- Wifi Hacker Tools For Windows
- What Are Hacking Tools
- World No 1 Hacker Software
- Hacking Tools Pc
- Hack Tools 2019
- Pentest Tools Find Subdomains
- Pentest Tools Find Subdomains
- Hacking Tools Hardware
- Hacking Tools Software
- Hack Tools 2019
- New Hacker Tools
- Pentest Tools Website
- Hacker Tools List
- Pentest Tools Windows
- Hacker Tools For Mac
- Hacker Tools Linux
- Top Pentest Tools
- Hacking Tools For Mac
- Hacking Tools Kit
- Hacker Hardware Tools
- Hack Tools For Windows
- Pentest Tools Github
- Hacker Tools Apk
- Pentest Tools
- Tools For Hacker
- What Is Hacking Tools
- Free Pentest Tools For Windows
- Hack Tool Apk
- Hacking Tools Github
- Pentest Tools Android
- Hacker Tools Software
- Hackrf Tools
- Nsa Hack Tools
- Hacker Search Tools
- Hacking Tools For Beginners
- How To Install Pentest Tools In Ubuntu
- Hacker Tools List
- Pentest Tools Download
- Hacker Tools Apk
- Hacking Tools Online
- Pentest Tools For Ubuntu
- Hack Tools For Pc
- Beginner Hacker Tools
- Hack Tools Pc
- How To Make Hacking Tools
- Hack Tool Apk No Root
- Pentest Tools Url Fuzzer
- Beginner Hacker Tools
- What Are Hacking Tools
- Pentest Box Tools Download
- Hacking Tools Pc
- Pentest Tools Port Scanner
- How To Install Pentest Tools In Ubuntu
- Pentest Tools Apk
- Nsa Hacker Tools
- Pentest Tools For Android
- Hacker
- Pentest Tools Download
- Pentest Tools Linux
- What Are Hacking Tools
- New Hack Tools
- Pentest Tools Open Source
- Nsa Hack Tools
- Hack Tools Pc
- Kik Hack Tools
- Hack Tool Apk
- Pentest Tools For Ubuntu
- Pentest Tools Website
- Hacker Techniques Tools And Incident Handling
- Pentest Tools Review
- Nsa Hacker Tools
- Hacker Tools List
- Pentest Tools Website
- Hacking Tools For Pc
- Pentest Box Tools Download
- Hacker Tools Github
- Tools For Hacker
- Github Hacking Tools
- Hacking Tools 2020
- Hacking Tools For Games
- Hacker Techniques Tools And Incident Handling
- Hacking Tools Download
- Bluetooth Hacking Tools Kali
- Hacking Tools Online
No comments:
Post a Comment