webscan

README

webscan

webscan is designed as a simple, easy to use web application scanning tool that security teams can use to automate the collection of data about their web applications. Designed with data-modeling and data-integration needs in mind, webscan can be used on its own as an interactive CLI, orchestrated as part of a broader data pipeline, or leveraged from within the Method Platform.

The types of scans that webscan can conduct are constantly growing. For the most up to date listing, please see the documentation here

To learn more about webscan, please see the Documentation site for the most detailed information.

Quick Start

Get webscan

For the full list of available installation options, please see the Installation page. For convenience, here are some of the most commonly used options:

• docker run methodsecurity/webscan
• docker run ghcr.io/method-security/webscan
• Download the latest binary from the Github Releases page
• Installation documentation

Examples

webscan spider --targets https://example.com,https://example.dev

webscan vuln --severity INFO --tags swagger --tags fastapi --tags api --target example.com

Building a Statically Compiled Container for Local Testing

(Reference reusable-build.yaml)

1. Build ARM64 builder image: docker buildx build . --platform linux/arm64 --load --tag armbuilder -f Dockerfile.builder

2. Build ARM64 image: docker run -v .:/app/webscan -e GOARCH=arm64 -e GOOS=linux --rm armbuilder goreleaser build --single-target -f .goreleaser/goreleaser-build.yml --snapshot --clean

3. cp dist/linux_arm64/build-linux_linux_arm64/webscan .

4. docker buildx build . --platform linux/arm64 --load --tag webscan:local -f Dockerfile

5. Open shell: docker run -it --rm --entrypoint /bin/sh webscan:testing

6. OR run command without shell example: docker run webscan:local app enumerate graphql --target https://countries.trevorblades.com/ -o json

Note:

This tool runs on a headless-shell base image to support chrome/chromium browser automation. The dockerfile uses debian-based install tools.

Contributing

Interested in contributing to webscan? Please see our organization wide Contribution page.

Want More?

If you're looking for an easy way to tie webscan into your broader cybersecurity workflows, or want to leverage some autonomy to improve your overall security posture, you'll love the broader Method Platform.

For more information, visit us here

Community

webscan is a Method Security open source project.

Learn more about Method's open source source work by checking out our other projects here or our organization wide documentation here.

Have an idea for a Tool to contribute? Open a Discussion here.