Skip to content

crashappsec/chalk

Chalk Logo

tests

About Chalk

Chalk™ captures metadata at build time, and can add a small 'chalk mark' (metadata) to any artifacts, so they can be identified in production. Chalk can also extract chalk marks and collect additional metadata about the operating environment when it does this.

Using Chalk, you can build a graph connecting people, development, builds and production, so that devops engineers understand what is happening in the development process, and so that developers can understand what is happening in the infrastructure.

How-tos

You can use Chalk to solve a variety of specific use cases such as:

Create software security supply chain compliance reports automatically

Many companies and the US Government are now mandating suppliers to provide supply chain statements when delivering software. This how to is an easy button to deliver the software bill of materials (SBOM), code and builds provenance and supports SLSA, Supply-chain Levels for Software Artifacts, level 2 compliance (an emerging supply chain standard) before SLSA level 1 has been mandated. Follow this guidance on our docs site here.

Gathering runtime information using exec reports

Chalk’s exec command is a powerful feature that allows you to gather runtime information about your applications as they execute. This capability creates a bridge between the build-time metadata collected during insertion operations and the actual runtime behavior of your software. Follow the guidance on our docs site here.

Deploy Chalk globally using Docker

You can deploy Chalk by setting a global alias for Docker and having it call Chalk, so that every build that runs through your build server using Docker, will automatically be 'chalked'. It's a technique that can be combined with chalks ability to deploy tools and configure monitoring, to automatically add security controls and collect information for every application. Follow this guidance on our docs site here]

All documentation for Chalk is available at https://chalkproject.io/docs/ and is also fully accessible though the command line interface.

Getting started

We recommend following the getting started guide on our documentation web site. Full documentation is also available directly inside the CLI.

We provide free binary downloads on our release page.

Issues

If you encounter any issues with Chalk please submit a GitHub issue to this repo.

Ideas and feedback

We are constantly learning about emerging use cases for Chalk, and are always interested in hearing about how others are using it. We are also interested in ideas and feature requests.If you would like to talk, please get in touch using [email protected].

Making contributions

We welcome contributions but do require you to complete a contributor license agreement or CLA. You can read the CLA and about our process here.

Getting additional help

If you need additional help including a demo of the cloud platform, please contact us using [email protected]

License

Chalk is licensed under the GPL version 3 license.

Try our cloud platform.

Our cloud hosted platform is built using Chalk. It makes enterprise deployments easy, and provides additional functionality including prebuilt integrations to enrich your data.

You can learn more at crashoverride.com.

About

Chalk allows you to follow code from development, through builds and into production.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors 16