Giter Club home page Giter Club logo

gowitness's Introduction

A golang, web screenshot utility using Chrome Headless.

@leonjza Go Report Card Docker Cloud Build Status


introduction

gowitness is a website screenshot utility written in Golang, that uses Chrome Headless to generate screenshots of web interfaces using the command line. Both Linux and macOS is supported, with Windows support 'partially working'.

Inspiration for gowitness comes from Eyewitness. If you are looking for something with lots of extra features, be sure to check it out along with these other projects.

installation

All you would need is an installation of the latest Google Chrome or Chromium and gowitness itself. gowitness can be downloaded using go get -u github.com/sensepost/gowitness or using the binaries available for download from the releases page.

running using docker

To screenshot a page using docker, simply run the following command that would also pull the latest gowitness image:

docker run --rm -it -v $(pwd)/screenshots:/screenshots leonjza/gowitness:latest single --url=https://www.google.com

Keep in mind that a folder needs to be mounted into the container for gowitness to write your screenshots to, otherwise they will be lost when the container exits. The container is configured with the /screenshots/ directory as the working directory, so the above command mounts a local screenshots/ directory there.

If you want to read an nmap file, save it locally into a screenshots directory, and use it with:

docker run --rm -it -v $(pwd)/screenshots:/screenshots leonjza/gowitness:latest nmap -f /screenshots/nmap.xml

For any other commands, you can get help similar to the local binary install. For example:

docker run --rm -it -v $(pwd)/screenshots:/screenshots leonjza/gowitness:latest -h
A commandline web screenshot and information gathering tool by @leonjza

Usage:
  gowitness [command]

Available Commands:
  file        Screenshot URLs sourced from a file
  help        Help about any command
  nmap        Screenshot services from an Nmap XML file
  report      Work with gowitness reports
  scan        Scan a CIDR range and take screenshots along the way
  single      Take a screenshot of a single URL
  version     Prints the version of gowitness

build from source

To build gowitness from source, follow the following steps:

  • Ensure that you have at least golang version 1.13.
  • Clone this repository and cd into it.
  • Run go build to get the gowitness binary for the current machine.
  • Or, make to build for all targets. Binaries will be in the build/ diretory.

usage examples

screenshot a single website

$ gowitness single --url=https://www.google.com/

This should result in a file being created called: https-www.google.com.png

screenshot a cidr

$ gowitness scan --cidr 192.168.0.0/24 --threads 20

This should result in many .png images in the current directory when complete. This can would also use 20 threads and not the default of 4.

generate a report

$ gowitness report generate

This should result in an report.html file with a screenshot report.

$ gowitness report generate --sort-perception

This should result in an report.html file with a screenshot report where screenshots are sorted using perception hashing.

$ gowitness report list

This should list the entries in the gowitness.db file.

license

gowitness is licensed under a GNU General Public v3 License. Permissions beyond the scope of this license may be available at http://sensepost.com/contact/.

gowitness's People

Contributors

leonjza avatar jughead avatar coldshell avatar fork-while-fork avatar nnam avatar y-yagi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.