Giter Club home page Giter Club logo

stackhawk-custom-image's Introduction

HawkScan

StackHawk provides dynamic application vulnerability scanning from development to production.

  • โšก Dynamic Application Scanning: Use HawkScan to find and fix security bugs in your web apps, before you push to production. Think of it as security integration testing. Get started with your first scan in minutes.

  • ๐Ÿฆธ Built for Modern Dev Teams: Automate scans with Docker commands, manage configs via YAML, and add app scanning as a build stage. We're built for dev teams that care about security and quality.

  • ๐Ÿงฐ Vulnerability Management: Document for compliance. Prioritize and manage fixes with integrations to existing ticketing tools. Point in time assessments are a thing of the past - there is a better way.

StackHawk Custom Image

This is a repository with examples of HawkScan used with other common software development tools, aka devtools, to help users customize their on StackHawk Docker images. This repo provides instructions to use HawkScan with:

This repo provides steps to create a custom docker image starting from stackhawk base image, and how to run it from a container. Typically a team may instead want to start from a different base image and add hawkscan as a third-party utility. See below for instructions.

Run HawkScan in your container

Containers are commonly used to host applications in a Continuous Integration / Continuous Delivery (CICD) pipeline. Running your containerized web application in a test environment will closely reflect how it will perform in production. Testing your web applications with HawkScan in the CICD pipeline will help teams ship secure software with confidence.

HawkScan is best implemented in the CICD pipeline, and testing your web application is much easier once your web application is containerized. A docker image includes instructions to copy your application code into the docker container and run it with required dependencies. Your docker container should include all software required to run and test your application. This includes:

  • Software Runtimes: such as nodejs or java
  • build libraries: such as gcc or gradle
  • runtime dependencies: such as drivers or browsers
  • your application source code

While this repo provides steps and examples to create a custom docker image starting from the stackhawk/hawkscan base image, typically a team will instead add HawkScan to your application's docker image. Here are the steps to accomplish that:

  • Add the StackHawk CLI to your base image with the following additions to your dockerfile:
# Update this value with your preferred version of HawkScan
ARG HAWKSCAN_VERSION="2.9.0"

# create a /hawk directory and download/unzip the version of HawkScan there
RUN mkdir /hawk \
    && curl -v https://download.stackhawk.com/hawk/cli/hawk-${HAWKSCAN_VERSION}.zip -o hawk-${HAWKSCAN_VERSION}.zip \
    && unzip hawk-${HAWKSCAN_VERSION}.zip /hawk

# ... include your application content, runtime source, and stackhawk.yaml file

# start hawkscan from the scan shawk endpoint.
ENTRYPOINT ["hawk/shawk"]
  • If HawkScan should to run alongside other third-party testing tools, be sure your StackHawk.yaml file is configured for Custom Scan Discovery to run the other testing tools as configured. Pay attention to any requirements for running your web application with https if that is enabled when running your web application in the CICD pipeline.

  • With new releases of HawkScan you can update the HAWKSCAN_VERSION for new scanner improvement capabilities.

stackhawk-custom-image's People

Contributors

bwvolleyball avatar kcberg avatar pritchyspritch avatar sh-afidalgo avatar untra avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  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.