README
¶
Clair
Note: The main branch may be in an unstable or even broken state during development.
Please use releases instead of the main branch in order to get stable binaries.
Clair is an open source project for the static analysis of vulnerabilities in application containers (currently including OCI and docker).
Clients use the Clair API to index their container images and can then match it against known vulnerabilities.
Our goal is to enable a more transparent view of the security of container-based infrastructure.
Thus, the project was named Clair after the French term which translates to clear, bright, transparent.
The book contains all the documentation on Clair's architecture and operation.
Community
- Mailing List: clair-dev@googlegroups.com
- IRC: #clair on freenode.org
- Bugs: issues
Contributing
See CONTRIBUTING for details on submitting patches and the contribution workflow.
License
Clair is under the Apache 2.0 license. See the LICENSE file for details.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd provides some common information to clair's binaries.
|
Package cmd provides some common information to clair's binaries. |
|
clair
command
|
|
|
clairctl
command
|
|
|
contrib
|
|
|
cmd/quaybackstop
command
Quaybackstop is a helper command to ensure that Quay's GC decisions are propagated back to Clair.
|
Quaybackstop is a helper command to ensure that Quay's GC decisions are propagated back to Clair. |
|
Package httptransport contains the HTTP logic for implementing the Clair(v4) HTTP API v1.
|
Package httptransport contains the HTTP logic for implementing the Clair(v4) HTTP API v1. |
|
types/v1
Package types provides JSON Schemas for the HTTP API.
|
Package types provides JSON Schemas for the HTTP API. |
|
auto
Package auto does automatic detection and runtime configuration for certain environments.
|
Package auto does automatic detection and runtime configuration for certain environments. |
|
internal
|
|
|
codec
Package codec is a unified place for configuring and allocating JSON encoders and decoders.
|
Package codec is a unified place for configuring and allocating JSON encoders and decoders. |
|
Package introspection holds the implementation details for the "introspection" HTTP server that Clair hosts.
|
Package introspection holds the implementation details for the "introspection" HTTP server that Clair hosts. |
|
middleware
|
|
|
compress
Package compress implements an RFC9110 compliant handler for the "Accept-Encoding" header.
|
Package compress implements an RFC9110 compliant handler for the "Accept-Encoding" header. |
|
amqp
Package amqp implements a Deliverer over the AMQP protocol.
|
Package amqp implements a Deliverer over the AMQP protocol. |
|
stomp
Package stomp implements a Deliverer over the STOMP protocol.
|
Package stomp implements a Deliverer over the STOMP protocol. |
|
webhook/cmd/webhookd
command
Command webhookd is a server implementation of Clair's "webhook" notification protocol.
|
Command webhookd is a server implementation of Clair's "webhook" notification protocol. |