Giter Club home page Giter Club logo

openshift-ordeal's Introduction

License test coverage badge Gitter
openshift-ordeal logo

OpenShift-Ordeal

Scan your Openshift cluster

OpenShift-Ordeal is an open source audit scanner who perform audit check on OpenShift Cluster and output it security report

The audit tests are the full implementation of CIS openshift Benchmark specification

audit result now can be leveraged as webhook via user plugin(using go plugin)

Audit checks are performed on OpenShift cluster, and output audit report include :

  1. root cause of the security issue.
  2. proposed remediation for security issue.

Openshift cluster scan output:

Under Construction - in Progress :)


Installation

git clone https://github.com/chen-keinan/openshift-ordeal
cd openshift-ordeal
make build
./openshift-ordeal

Quick Start

Usage: openshift-ordeal [--version] [--help] <command> [<args>]

Available commands are:
  -r , --report :  run audit tests and generate failure and warn report
  -i , --include:  execute only specific audit test,   example -i=1.2.3,1.4.5
  -e , --exclude:  ignore specific audit tests,  example -e=1.2.3,1.4.5
  -c , --classic:  test report in classic view,  example -c

User Plugin Usage

The openshift-ordeal expose hook for user plugins Example :

  • openshiftBenchAuditResultHook - this hook accepts audit benchmark results as found by audit test
Compile user plugin
go build -buildmode=plugin -o=~/<plugin folder>/bench_plugin.so /<plugin folder>/bench_plugin.go
Copy plugin to folder (.openshift-ordeal folder is created on the 1st startup)
cp /<plugin folder>/bench_plugin.so ~/.openshift-ordeal/plugins/compile/bench_plugin.so

Note: Plugin and binary must compile with the same linux env

Supported Specs

The openshift-ordeal support cis specs and can be easily extended:

  • master config file change spec CIS openshift Benchmark specification both specs can be easily extended by amended the spec files under ~/.openshift-ordeal/benchmarks/openshift/v1.0.0 folder

Contribution

  • code contribution is welcome !! , contribution with tests and passing linter is more than welcome
  • /.dev folder include vagrantfile to be used for development : Dev Instruction

openshift-ordeal's People

Contributors

chen-keinan avatar chokana avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

chokana okn28 dkeler

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.