OpenClarity Documentation

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

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

Table of Contents

• Why OpenClarity?
• Getting started
• Overview
  • Asset discovery
  • Supported filesystems
• Architecture
• Roadmap
• Contributing
• Code of Conduct
• License

Why OpenClarity?

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

VMs are vulnerable to multiple threats:

• Software vulnerabilities
• Leaked Secrets/Passwords
• Malware
• System Misconfiguration
• Rootkits

There are many very good open source and commercial-based solutions for providing 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 visualization.

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

For more information on the capabilities of OpenClarity, see Features.

Getting Started

For step-by-step guidance on how to deploy OpenClarity across different environments, including AWS, Azure, GCP, and Docker, see Getting Started and choose your preferred provider for detailed deployment instructions.

Overview

OpenClarity uses a pluggable scanning infrastructure to provide:

• SBOM analysis
• Package and OS vulnerability 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 individual basis. OpenClarity normalizes, merges and provides a robust visualization of the results from these various tools.

These tools include:

• SBOM Generation and Analysis
  • Syft
  • Trivy
  • Windows Registry*
  • Cyclonedx-gomod
• Vulnerability 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

Asset Discovery

The OpenClarity stack supports the automatic discovery of assets in the following providers:

Supported Filesystems

The following filesystem operations are supported on different host types:

Architecture

A high-level architecture overview is available under OpenClarity Stack.

Roadmap

The OpenClarity project roadmap is available 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 and setup OpenClarity for development and testing.

Code of Conduct

You can view our code of conduct here.

License

Apache License, Version 2.0