{"id":16868481,"url":"https://github.com/chen-keinan/openshift-ordeal","last_synced_at":"2025-04-11T10:25:32.005Z","repository":{"id":42491557,"uuid":"405401819","full_name":"chen-keinan/openshift-ordeal","owner":"chen-keinan","description":"Open Source runtime scanner for OpenShift cluster and perform security audit checks based on CIS RedHat OpenShift Benchmark specification","archived":false,"fork":false,"pushed_at":"2022-04-21T05:47:07.000Z","size":350,"stargazers_count":6,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T07:04:59.067Z","etag":null,"topics":["audit-checks","cis-benchmark","cis-security","kube","kubernetes","linux","openshift","openshift-ordeal","openshift-scrutiny","redhat","scan","security"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chen-keinan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-09-11T14:34:12.000Z","updated_at":"2023-11-15T08:45:40.000Z","dependencies_parsed_at":"2022-09-03T08:40:35.954Z","dependency_job_id":null,"html_url":"https://github.com/chen-keinan/openshift-ordeal","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chen-keinan%2Fopenshift-ordeal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chen-keinan%2Fopenshift-ordeal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chen-keinan%2Fopenshift-ordeal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chen-keinan%2Fopenshift-ordeal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chen-keinan","download_url":"https://codeload.github.com/chen-keinan/openshift-ordeal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248374257,"owners_count":21093295,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["audit-checks","cis-benchmark","cis-security","kube","kubernetes","linux","openshift","openshift-ordeal","openshift-scrutiny","redhat","scan","security"],"created_at":"2024-10-13T14:58:27.137Z","updated_at":"2025-04-11T10:25:31.975Z","avatar_url":"https://github.com/chen-keinan.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/chen-keinan/openshift-ordeal/blob/main/LICENSE)\n\u003cimg src=\"./pkg/img/coverage_badge.png\" alt=\"test coverage badge\"\u003e\n[![Gitter](https://badges.gitter.im/beacon-sec/openshift-ordeal.svg)](https://gitter.im/beacon-sec/openshift-ordeal?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge)\n\u003cbr\u003e\u003cimg src=\"./pkg/img/openshift-ordeal.png\" width=\"300\" alt=\"openshift-ordeal logo\"\u003e\u003cbr\u003e\n# OpenShift-Ordeal\n\n###  Scan your Openshift cluster\nOpenShift-Ordeal is an open source audit scanner who perform audit check on OpenShift Cluster and output it security report\n\nThe audit tests are the full implementation of [CIS openshift Benchmark specification](https://www.cisecurity.org/benchmark/openshift/) \u003cbr\u003e\n\naudit result now can be leveraged as webhook via user plugin(using go plugin)\n#### Audit checks are performed on OpenShift cluster, and output audit report include :\n 1.  root cause of the security issue.\n 2. proposed remediation for security issue.\n\n#### Openshift cluster scan output:\n\n\n\n# Under Construction - in Progress :)\n\n--------------------------------------------------------------------------------------------------------\n\n* [Installation](#installation)\n* [Quick Start](#quick-start)\n* [User Plugin Usage](#user-plugin-usage)\n* [Supported Specs](#supported-specs)\n* [Contribution](#Contribution)\n\n## Installation\n\n```\ngit clone https://github.com/chen-keinan/openshift-ordeal\ncd openshift-ordeal\nmake build\n./openshift-ordeal\n```\n\n## Quick Start\n\n```\nUsage: openshift-ordeal [--version] [--help] \u003ccommand\u003e [\u003cargs\u003e]\n\nAvailable commands are:\n  -r , --report :  run audit tests and generate failure and warn report\n  -i , --include:  execute only specific audit test,   example -i=1.2.3,1.4.5\n  -e , --exclude:  ignore specific audit tests,  example -e=1.2.3,1.4.5\n  -c , --classic:  test report in classic view,  example -c\n\n```\n## User Plugin Usage\nThe openshift-ordeal expose hook for user plugins [Example](https://github.com/chen-keinan/openshift-ordeal/tree/master/examples/plugins) :\n- **openshiftBenchAuditResultHook** - this hook accepts audit benchmark results as found by audit test\n\n##### Compile user plugin\n```\ngo build -buildmode=plugin -o=~/\u003cplugin folder\u003e/bench_plugin.so /\u003cplugin folder\u003e/bench_plugin.go\n```\n##### Copy plugin to folder (.openshift-ordeal folder is created on the 1st startup)\n```\ncp /\u003cplugin folder\u003e/bench_plugin.so ~/.openshift-ordeal/plugins/compile/bench_plugin.so\n```\nNote: Plugin and binary must compile with the same linux env\n## Supported Specs\nThe openshift-ordeal support cis specs and can be easily extended:\n- master config file change spec [CIS openshift Benchmark specification](https://www.cisecurity.org/benchmark/openshift/)\nboth specs can be easily extended by amended the spec files under ```~/.openshift-ordeal/benchmarks/openshift/v1.0.0``` folder\n\n## Contribution\n- code contribution is welcome !! , contribution with tests and passing linter is more than welcome\n- /.dev folder include vagrantfile to be used for development : [Dev Instruction](https://github.com/chen-keinan/openshift-ordeal/tree/master/.dev)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchen-keinan%2Fopenshift-ordeal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchen-keinan%2Fopenshift-ordeal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchen-keinan%2Fopenshift-ordeal/lists"}