Git Product home page Git Product logo

sam1101-sys / kubescape Goto Github PK

View Code? Open in Web Editor NEW

This project forked from kubescape/kubescape

0.0 0.0 0.0 2.13 MB

kubescape is the first tool for testing if Kubernetes is deployed securely as defined in Kubernetes Hardening Guidance by to NSA and CISA (https://www.nsa.gov/News-Features/Feature-Stories/Article-View/Article/2716980/nsa-cisa-release-kubernetes-hardening-guidance/)

License: Apache License 2.0

Go 99.68% Shell 0.32%

kubescape's Introduction

logo

build Github All Releases Go Report Card

Kubescape is the first tool for testing if Kubernetes is deployed securely as defined in Kubernetes Hardening Guidance by NSA and CISA

Use Kubescape to test clusters or scan single YAML files and integrate it to your processes.

TL;DR

Install & Run

Install:

curl -s https://raw.githubusercontent.com/armosec/kubescape/master/install.sh | /bin/bash

Run:

kubescape scan framework nsa --exclude-namespaces kube-system,kube-public

If you wish to scan all namespaces in your cluster, remove the --exclude-namespaces flag.

Flags

flag default description options
-e/--exclude-namespaces Scan all namespaces Namespaces to exclude from scanning. Recommended to exclude kube-system and kube-public namespaces
-s/--silent Display progress messages Silent progress messages
-t/--fail-threshold 0 (do not fail) fail command (return exit code 1) if result bellow threshold 0 -> 100
-f/--format pretty-printer Output format pretty-printer/json/junit
-o/--output print to stdout Save scan result in file

Usage & Examples

Examples

  • Scan a running Kubernetes cluster with nsa framework
kubescape scan framework nsa --exclude-namespaces kube-system,kube-public
  • Scan local yaml/json files before deploying
kubescape scan framework nsa *.yaml
  • Scan yaml/json files from url
kubescape scan framework nsa https://raw.githubusercontent.com/GoogleCloudPlatform/microservices-demo/master/release/kubernetes-manifests.yaml
  • Output in json format
kubescape scan framework nsa --exclude-namespaces kube-system,kube-public --format json --output results.json
  • Output in junit xml format
kubescape scan framework nsa --exclude-namespaces kube-system,kube-public --format junit --output results.xml

Helm Support

helm template [NAME] [CHART] [flags] --dry-run | kubescape scan framework nsa -

for example:

helm template bitnami/mysql --generate-name --dry-run | kubescape scan framework nsa -

Offline Support

It is possible to run Kubescape offline!

First download the framework and then scan with --use-from flag

  • Download and save in file, if file name not specified, will store save to ~/.kubescape/<framework name>.json
kubescape download framework nsa --output nsa.json
  • Scan using the downloaded framework
kubescape scan framework nsa --use-from nsa.json

How to build

Note: development (and the release process) is done with Go 1.16

  1. Clone Project
git clone [email protected]:armosec/kubescape.git kubescape && cd "$_"
  1. Build
go mod tidy && go build -o kubescape .
  1. Run
./kubescape scan framework nsa --exclude-namespaces kube-system,kube-public
  1. Enjoy 🤪

Under the hood

Tests

Kubescape is running the following tests according to what is defined by Kubernetes Hardening Guidance by NSA and CISA

  • Non-root containers
  • Immutable container filesystem
  • Privileged containers
  • hostPID, hostIPC privileges
  • hostNetwork access
  • allowedHostPaths field
  • Protecting pod service account tokens
  • Resource policies
  • Control plane hardening
  • Exposed dashboard
  • Allow privilege escalation
  • Applications credentials in configuration files
  • Cluster-admin binding
  • Exec into container
  • Dangerous capabilities
  • Insecure capabilities
  • Linux hardening
  • Ingress and Egress blocked
  • Container hostPort
  • Network policies

Technology

Kubescape based on OPA engine: https://github.com/open-policy-agent/opa and ARMO's posture controls.

The tools retrieves Kubernetes objects from the API server and runs a set of regos snippets developed by ARMO.

The results by default printed in a pretty "console friendly" manner, but they can be retrieved in JSON format for further processing.

Kubescape is an open source project, we welcome your feedback and ideas for improvement. We’re also aiming to collaborate with the Kubernetes community to help make the tests themselves more robust and complete as Kubernetes develops.

kubescape's People

Contributors

daniel-grunbergerca avatar slashben avatar dwertent avatar bezbran avatar amiralis avatar mayocream 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.