openclarity - OpenClarity is an open source platform built to en

项目说明

<picture>
<source media="(prefers-color-scheme: dark)" srcset="./assets/logos/OpenClarity-logo-dark-bg.png">
<source media="(prefers-color-scheme: light)" srcset="./assets/logos/OpenClarity-logo-light-bg.png">
<img alt="OpenClarity Logo" src="./assets/logos/OpenClarity-logo-light-bg.png">
<br/><br/><br/>
</picture>

![Slack Invite]()
!GitHub Workflow Status

<!--TODO: Uncomment these once we have the first tagged >
<!--![Go Reference]()-->
<!--![Go Report Card]()-->

OpenClarity is an open source tool for agentless detection and management of Machine
Software Bill Of Materials (SBOM) and security threats such as , exploits, malware, rootkits, misconfigurations and leaked secrets.

<img src="./assets/OpenClarity-demo.gif" alt="OpenClarity demo" />

Join OpenClarity's Slack channel to hear about the latest announcements and upcoming acti. We would love to get your feedback!

Table of Contents<!-- omit in toc -->

Why OpenClarity?

Getting started

O

- Usage modes
- 1. OpenClarity stack
- 2. CLI
- 3. Go module
- Asset discovery
- Supported filesystems

Architecture

Roadmap

Contributing

Code of Conduct

License

Why OpenClarity?

machines (VMs) are the most used service across all hyperscalers. AWS,
Azure, GCP, and others ha computing services that are used not only
as standalone but also as the most popular method for hosting
containers (e.g., Docker, Kubernetes).

VMs are to multiple threats:

Software

Leaked Secrets/Passwords

Malware

System Misconfiguration

Rootkits

There are many very good open source and commercial-based solutions for
pro threat detection for VMs, manifesting the different threat categories above.

However, there are challenges with assembling and managing these tools yourself:

Complex installation, configuration, and reporting

Integration with deployment automation

Siloed reporting and

The OpenClarity project is focused on unifying detection and management of threats in an agentless manner.

Getting started

For step-by-step guidance on how to deploy OpenClarity across different en, including AWS, Azure, GCP, and Docker, click on this link and choose your preferred provider for detailed deployment instructions.

O

OpenClarity uses a pluggable scanning infrastructure to provide:

SBOM analysis

Package and OS detection

Exploit detection

Leaked secret detection

Malware detection

Misconfiguration detection

Rootkit detection

The pluggable scanning infrastructure uses several tools that can be
enabled/disabled on an indi basis. OpenClarity normalizes, merges and
provides a robust of the results from these tools.

These tools include:

SBOM Generation and Analysis

- Syft
- Trivy
- Windows Registry\*
- Cyclonedx-gomod

detection

- Grype
- Trivy

Exploits

- Go exploit db

Secrets

- gitleaks

Malware

- ClamAV
- YARA

Misconfiguration

- Lynis\*\*
- CIS Docker Benchmark
- KICS

Rootkits

- Chkrootkit\*\*

\* Windows only\
\*\* Linux and MacOS only

Usage modes

OpenClarity can be used multiple ways to fit different needs:

1. OpenClarity stack

As a complete stack, OpenClarity provides an integrated solution to

disco in your en,

manage scan configurations, schedule and execute scans,

the results on a dashboard.

For the deployment instructions visit this page: Getting started.

2. CLI

OpenClarity can be used as a standalone command line tool to run the supported scanner tools.

1. Download openclarity-cli from the GitHub releases page.
2. Create a configuration file, make sure to enable the scanner families you need. An example can be found here: .families.yaml
3. Execute the following command:

3. Go module

Import the github.com/openclarity/openclarity/scanner package to run a scan with OpenClarity’s family manager from your code.

Example: scan.go

Asset discovery

OpenClarity stack supports the automatic discovery of assets in the following pro:

| Provider | Asset types | Scope |
| ---------- | -------------------------------- | --------------------- |
| Docker | Docker containers and images | Local Docker daemon |
| Kubernetes | Docker containers and images | Cluster |
| AWS | machines (EC2 instances) | Account (all regions) |
| Azure | machines | Subscription |
| GCP | machines | Project |

Supported filesystems

The following filesystem operations are supported on different host types:

| Host | List block devices | Mount Ext2, Ext3, Ext4 | Mount XFS | Mount NTFS |
| ------- | ------------------ | ---------------------- | ------------- | ------------- |
| Linux | Supported | Supported | Supported | Supported |
| Darwin | Supported | Supported | Supported | Supported |
| Windows | Not supported | Not supported | Not supported | Not supported |

Architecture

A high-le o is a here.

Roadmap

OpenClarity project roadmap is a here.

Contributing

If you are ready to jump in and test, add code, or help with documentation,
please follow the instructions on our contributing guide
for details on how to open issues, setup OpenClarity for de and test.

Code of Conduct

You can view our code of conduct here.

License

Apache License, 2.0

项目信息

开发语言：Go

Star 数：1460

技术要点

该项目属于病毒分析方向的开源资源，代码结构清晰，适合安全研究人员学习参考。项目围绕OpenClarity is an open source platform built to enhance security and observability of cloud native applications and infrastructure展开，提供了可运行的实现，对理解相关安全机制、工具原理与攻防技术具有较高的研究价值。

从技术实现角度看，此类项目的核心在于对底层原理的深入理解与工程化落地。开发者在研究过程中可以结合官方文档与社区讨论，梳理项目的初始化流程、核心模块职责与数据流转，逐步掌握其中的技术细节与设计思路。

使用与学习建议

1. 下载源码压缩包，解压到本地环境。

2. 根据项目类型准备对应的运行环境与依赖。

3. 按照 README 中的步骤完成配置与部署。

4. 在隔离的测试环境中运行验证，避免影响生产系统。

免责声明

本资源来源于开源社区，仅供安全研究、技术学习与合法授权范围内的攻防演练使用，请勿用于任何非法或侵害他人权益的用途。使用本项目产生的一切后果由使用者自行承担。