{"id":13978060,"url":"https://github.com/openclarity/openclarity","last_synced_at":"2025-12-15T06:04:53.535Z","repository":{"id":37584646,"uuid":"249182649","full_name":"openclarity/openclarity","owner":"openclarity","description":"OpenClarity is an open source tool built to enhance security and observability of cloud native applications and infrastructure","archived":false,"fork":false,"pushed_at":"2024-10-28T08:28:06.000Z","size":71960,"stargazers_count":1340,"open_issues_count":74,"forks_count":162,"subscribers_count":31,"default_branch":"main","last_synced_at":"2024-10-29T15:40:50.371Z","etag":null,"topics":["cloud","exploits","kubernetes","leaked-secrets","malware","rootkits","sbom","scanner","security","supply-chain","virtual-machine","vulnerabilities"],"latest_commit_sha":null,"homepage":"https://openclarity.io","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/openclarity.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-22T12:52:29.000Z","updated_at":"2024-10-29T08:01:45.000Z","dependencies_parsed_at":"2022-07-14T04:30:30.902Z","dependency_job_id":"4ff8782e-7f3f-453c-91f7-208d572f951f","html_url":"https://github.com/openclarity/openclarity","commit_stats":{"total_commits":347,"total_committers":40,"mean_commits":8.675,"dds":0.7780979827089337,"last_synced_commit":"5f6b411161100c15196c8149c0b1df5537c88a05"},"previous_names":["cisco-open/kubei","portshift/kubei","openclarity/openclarity"],"tags_count":179,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openclarity%2Fopenclarity","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openclarity%2Fopenclarity/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openclarity%2Fopenclarity/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openclarity%2Fopenclarity/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openclarity","download_url":"https://codeload.github.com/openclarity/openclarity/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248568214,"owners_count":21125987,"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":["cloud","exploits","kubernetes","leaked-secrets","malware","rootkits","sbom","scanner","security","supply-chain","virtual-machine","vulnerabilities"],"created_at":"2024-08-09T03:00:52.090Z","updated_at":"2025-12-15T06:04:48.482Z","avatar_url":"https://github.com/openclarity.png","language":"Go","funding_links":[],"categories":["Go","Инструменты","cloud"],"sub_categories":["Безопасность Kubernetes"],"readme":"\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"./assets/logos/OpenClarity-logo-dark-bg.png\"\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"./assets/logos/OpenClarity-logo-light-bg.png\"\u003e\n  \u003cimg alt=\"OpenClarity Logo\" src=\"./assets/logos/OpenClarity-logo-light-bg.png\"\u003e\n  \u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e\n\u003c/picture\u003e\n\n[![Slack Invite](https://img.shields.io/badge/Slack-Join-blue?logo=slack)](https://outshift.slack.com/messages/vmclarity)\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/openclarity/openclarity/main-merge.yml?style=flat-square\u0026branch=main)\n\n\u003c!--TODO: Uncomment these once we have the first tagged version--\u003e\n\u003c!--[![Go Reference](https://pkg.go.dev/badge/github.com/openclarity/openclarity.svg)](https://pkg.go.dev/github.com/openclarity/openclarity)--\u003e\n\u003c!--[![Go Report Card](https://goreportcard.com/badge/github.com/openclarity/openclarity)](https://goreportcard.com/report/github.com/openclarity/openclarity)--\u003e\n\nOpenClarity is an open source tool for agentless detection and management of Virtual Machine\nSoftware Bill Of Materials (SBOM) and security threats such as vulnerabilities, exploits, malware, rootkits, misconfigurations and leaked secrets.\n\n\u003cimg src=\"./assets/OpenClarity-demo.gif\" alt=\"OpenClarity demo\" /\u003e\n\nJoin [OpenClarity's Slack channel](https://outshift.slack.com/messages/openclarity) to hear about the latest announcements and upcoming activities. We would love to get your feedback!\n\n# Table of Contents\u003c!-- omit in toc --\u003e\n\n- [Why OpenClarity?](#why-openclarity)\n- [Getting started](#getting-started)\n- [Overview](#overview)\n  - [Usage modes](#usage-modes)\n    - [1. OpenClarity stack](#1-openclarity-stack)\n    - [2. CLI](#2-cli)\n    - [3. Go module](#3-go-module)\n  - [Asset discovery](#asset-discovery)\n  - [Supported filesystems](#supported-filesystems)\n- [Architecture](#architecture)\n- [Roadmap](#roadmap)\n- [Contributing](#contributing)\n- [Code of Conduct](#code-of-conduct)\n- [License](#license)\n\n# Why OpenClarity?\n\nVirtual machines (VMs) are the most used service across all hyperscalers. AWS,\nAzure, GCP, and others have virtual computing services that are used not only\nas standalone VM services but also as the most popular method for hosting\ncontainers (e.g., Docker, Kubernetes).\n\nVMs are vulnerable to multiple threats:\n\n- Software vulnerabilities\n- Leaked Secrets/Passwords\n- Malware\n- System Misconfiguration\n- Rootkits\n\nThere are many very good open source and commercial-based solutions for\nproviding threat detection for VMs, manifesting the different threat categories above.\n\nHowever, there are challenges with assembling and managing these tools yourself:\n\n- Complex installation, configuration, and reporting\n- Integration with deployment automation\n- Siloed reporting and visualization\n\nThe OpenClarity project is focused on unifying detection and management of VM security threats in an agentless manner.\n\n# Getting started\n\nFor step-by-step guidance on how to deploy OpenClarity across different environments, including AWS, Azure, GCP, and Docker, click on [this link](https://openclarity.io/docs/getting-started/) and choose your preferred provider for detailed deployment instructions.\n\n# Overview\n\nOpenClarity uses a pluggable scanning infrastructure to provide:\n\n- SBOM analysis\n- Package and OS vulnerability detection\n- Exploit detection\n- Leaked secret detection\n- Malware detection\n- Misconfiguration detection\n- Rootkit detection\n\nThe pluggable scanning infrastructure uses several tools that can be\nenabled/disabled on an individual basis. OpenClarity normalizes, merges and\nprovides a robust visualization of the results from these various tools.\n\nThese tools include:\n\n- SBOM Generation and Analysis\n  - [Syft](https://github.com/anchore/syft)\n  - [Trivy](https://github.com/aquasecurity/trivy)\n  - [Windows Registry](scanner/families/sbom/windows)\\*\n  - [Cyclonedx-gomod](https://github.com/CycloneDX/cyclonedx-gomod)\n- Vulnerability detection\n  - [Grype](https://github.com/anchore/grype)\n  - [Trivy](https://github.com/aquasecurity/trivy)\n- Exploits\n  - [Go exploit db](https://github.com/vulsio/go-exploitdb)\n- Secrets\n  - [gitleaks](https://github.com/gitleaks/gitleaks)\n- Malware\n  - [ClamAV](https://github.com/Cisco-Talos/clamav)\n  - [YARA](https://github.com/virustotal/yara)\n- Misconfiguration\n  - [Lynis](https://github.com/CISOfy/lynis)\\*\\*\n  - [CIS Docker Benchmark](https://github.com/goodwithtech/dockle)\n  - [KICS](https://github.com/Checkmarx/kics)\n- Rootkits\n  - [Chkrootkit](https://github.com/Magentron/chkrootkit)\\*\\*\n\n\\* Windows only\\\n\\*\\* Linux and MacOS only\n\n## Usage modes\n\nOpenClarity can be used multiple ways to fit different needs:\n\n### 1. OpenClarity stack\n\nAs a complete stack, OpenClarity provides an integrated solution to\n\n- discover assets in your environment,\n- manage scan configurations, schedule and execute scans,\n- visualize the results on a dashboard.\n\nFor the deployment instructions visit this page: [Getting started](https://openclarity.io/docs/getting-started/).\n\n### 2. CLI\n\nOpenClarity can be used as a standalone command line tool to run the supported scanner tools.\n\n1. Download `openclarity-cli` from the [GitHub releases page](https://github.com/openclarity/openclarity/releases/).\n2. Create a configuration file, make sure to enable the scanner families you need. An example can be found here: [.families.yaml](https://github.com/openclarity/openclarity/blob/main/.families.yaml)\n3. Execute the following command:\n\n   ```bash\n   openclarity-cli scan --config .families.yaml\n   ```\n\n### 3. Go module\n\nImport the `github.com/openclarity/openclarity/scanner` package to run a scan with OpenClarity’s family manager from your code.\n\nExample: [scan.go](https://github.com/openclarity/openclarity/blob/94c46f830838416706c2deef71ecce095d706e6a/cli/cmd/scan/scan.go#L121)\n\n## Asset discovery\n\nOpenClarity stack supports the automatic discovery of assets in the following providers:\n\n| Provider   | Asset types                      | Scope                 |\n| ---------- | -------------------------------- | --------------------- |\n| Docker     | Docker containers and images     | Local Docker daemon   |\n| Kubernetes | Docker containers and images     | Cluster               |\n| AWS        | Virtual machines (EC2 instances) | Account (all regions) |\n| Azure      | Virtual machines                 | Subscription          |\n| GCP        | Virtual machines                 | Project               |\n\n## Supported filesystems\n\nThe following filesystem operations are supported on different host types:\n\n| Host    | List block devices | Mount Ext2, Ext3, Ext4 | Mount XFS     | Mount NTFS    |\n| ------- | ------------------ | ---------------------- | ------------- | ------------- |\n| Linux   | Supported          | Supported              | Supported     | Supported     |\n| Darwin  | Supported          | Supported              | Supported     | Supported     |\n| Windows | Not supported      | Not supported          | Not supported | Not supported |\n\n# Architecture\n\nA high-level architecture overview is available [here](ARCHITECTURE.md).\n\n# Roadmap\n\nOpenClarity project roadmap is available [here](https://github.com/orgs/openclarity/projects/5/views/5).\n\n# Contributing\n\nIf you are ready to jump in and test, add code, or help with documentation,\nplease follow the instructions on our [contributing guide](CONTRIBUTING.md)\nfor details on how to open issues, setup OpenClarity for development and test.\n\n# Code of Conduct\n\nYou can view our code of conduct [here](CODE_OF_CONDUCT.md).\n\n# License\n\n[Apache License, Version 2.0](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenclarity%2Fopenclarity","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenclarity%2Fopenclarity","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenclarity%2Fopenclarity/lists"}