-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Updating README with more relevant information for the `go-witness` library. --------- Signed-off-by: Tom Meadows <tom@tmlabs.co.uk>
- Loading branch information
1 parent
70efbcf
commit 737eed8
Showing
1 changed file
with
28 additions
and
298 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,302 +1,32 @@ | ||
| # go-witness | ||
| A client library for [Witness](https://github.com/in-toto/witness), written in Go. | ||
|
|
||
| [](https://pkg.go.dev/github.com/in-toto/go-witness) | ||
| [](https://goreportcard.com/report/github.com/in-toto/go-witness) | ||
| [](https://www.bestpractices.dev/projects/8164) | ||
| [](https://securityscorecards.dev/viewer/?uri=github.com/in-toto/go-witness) | ||
| [](https://app.fossa.com/projects/custom%2B41709%2Fgithub.com%2Fin-toto%2Fgo-witness?ref=badge_shield&issueType=license) | ||
|
|
||
| [](https://asciinema.org/a/2DZRRh8uzrzHcUVL8md86Zj4D) | ||
|
|
||
| ## Witness is a pluggable framework for supply chain security | ||
|
|
||
| Witness prevents tampering of build materials and verifies the integrity of the build process from source to target. It works by wrapping commands executed in a continuous integration process. Its attestation system is pluggable and offers support out of the box for most major CI and infrastructure providers. Verification of Witness metadata and a secure PKI distribution system will mitigate against many software supply chain attack vectors and can be used as a framework for automated governance. | ||
|
|
||
| Witness is an implementation of the in-toto spec including [ITE-5](https://github.com/in-toto/ITE/tree/master/ITE/5), [ITE-6](https://github.com/in-toto/ITE/tree/master/ITE/6), [ITE-7](https://github.com/in-toto/ITE/tree/master/ITE/7) with an [embedded rego policy engine](https://www.openpolicyagent.org/docs/latest/integration/#integrating-with-the-go-api). | ||
|
|
||
| - Does **NOT** require elevated privileges. | ||
| - Can run in a containerized or non-containerized environment | ||
| - Records secure hashes of materials, artifacts, and events occurring during the CI process | ||
| - Integrations with cloud identity services | ||
| - Keyless signing with [SPIFFE/SPIRE](https://spiffe.io/) | ||
| - Support for uploading attestation evidence to rekor server (sigstore) | ||
| - Build policy enforcement with Open Policy Agent. | ||
| - Alpha support for tracing and process tampering prevention | ||
| - Verifies file integrity between CI steps, and across air gap. | ||
| - Experimental Windows and ARM Support | ||
|
|
||
| ## Usage | ||
|
|
||
| - [Run](docs/witness_run.md) - Runs the provided command and records attestations about the execution. | ||
| - [Sign](docs/witness_sign.md) - Signs the provided file with the provided key. | ||
| - [Verify](docs/witness_verify.md) - Verifies a witness policy. | ||
|
|
||
| ## TOC | ||
|
|
||
| - [Witness Attestors](#witness-attestors) | ||
| - [What is a witness attestor?](#what-is-a-witness-attestor) | ||
| - [Attestor Security Model](#attestor-security-model) | ||
| - [Attestor Life Cycle](#attestor-life-cycle) | ||
| - [Attestation Lifecycle](#attestation-lifecycle) | ||
| - [Attestor Types](#attestor-types) | ||
| - [Pre Run Attestors](#pre-run-attestors) | ||
| - [Internal Attestors](#internal-attestors) | ||
| - [Post Run Attestors](#post-run-attestors) | ||
| - [AttestationCollection](#attestationcollection) | ||
| - [Attestor Subjects](#attestor-subjects) | ||
| - [Witness Policy](#witness-policy) | ||
| - [What is a witness policy?](#what-is-a-witness-policy) | ||
| - [Witness Verification](#witness-verification) | ||
| - [Verification Lifecycle](#verification-lifecycle) | ||
| - [Using SPIRE for Keyless Signing](#using-spire-for-keyless-signing) | ||
| - [Witness Examples](#witness-examples) | ||
| - [Media](#media) | ||
| - [Roadmap](#roadmap) | ||
| - [Support](#support) | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### Download the Binary | ||
| [Releases](https://github.com/testifysec/witness/releases) | ||
| ``` | ||
| curl -LO https://github.com/testifysec/witness/releases/download/${VERSION}/witness_${VERSION}_${ARCH}.tar.gz | ||
| tar -xzf witness_${VERSION}_${ARCH}.tar.gz | ||
| ``` | ||
|
|
||
| ### Create a Keypair | ||
|
|
||
| > Witness supports keyless signing with [SPIRE](https://spiffe.io/)! | ||
| ``` | ||
| openssl genpkey -algorithm ed25519 -outform PEM -out testkey.pem | ||
| openssl pkey -in testkey.pem -pubout > testpub.pem | ||
| ``` | ||
|
|
||
| ### Create a Witness configuration | ||
|
|
||
| > - This file generally resides in your source code repository along with the public keys generated above. | ||
| > - `.witness yaml` is the default location for the configuration file | ||
| > - `witness help` will show all configuration options | ||
| > - command-line arguments overrides configuration file values. | ||
| ``` | ||
| ## .witness.yaml | ||
| run: | ||
| key: testkey.pem | ||
| trace: false | ||
| verify: | ||
| attestations: | ||
| - "test-att.json" | ||
| policy: policy-signed.json | ||
| publickey: testpub.pem | ||
| ``` | ||
|
|
||
| ### Record attestations for a build step | ||
|
|
||
| > - The `-a {attestor}` flag allows you to define which attestors run | ||
| > - ex. `-a maven -a was -a gitlab` would be used for a maven build running on a GitLab runner on GCP. | ||
| > - Defining step names is important, these will be used in the policy. | ||
| > - This should happen as a part of a CI step | ||
| ``` | ||
| witness run --step build -o test-att.json -- go build -o=testapp . | ||
| ``` | ||
|
|
||
| ### View the attestation data in the signed DSSE Envelope | ||
|
|
||
| > - This data can be stored and retrieved from rekor! | ||
| > - This is the data that is evaluated against the Rego policy | ||
| ``` | ||
| cat test-att.json | jq -r .payload | base64 -d | jq | ||
| ``` | ||
|
|
||
| ### Create a Policy File | ||
|
|
||
| Look [here](docs/policy.md) for full documentation on Witness Policies. | ||
|
|
||
| > - Make sure to replace the keys in this file with the ones from the step above (sed command below). | ||
| > - Rego policies should be base64 encoded | ||
| > - Steps are bound to keys. Policy can be written to check the certificate data. For example, we can require a step is signed by a key with a specific `CN` attribute. | ||
| > - Witness will require all attestations to succeed | ||
| > - Witness will evaluate the rego policy against the JSON object in the corresponding attestor | ||
| ``` | ||
| ## policy.json | ||
| { | ||
| "expires": "2023-12-17T23:57:40-05:00", | ||
| "steps": { | ||
| "build": { | ||
| "name": "build", | ||
| "attestations": [ | ||
| { | ||
| "type": "https://witness.dev/attestations/material/v0.1", | ||
| "regopolicies": [] | ||
| }, | ||
| { | ||
| "type": "https://witness.dev/attestations/command-run/v0.1", | ||
| "regopolicies": [] | ||
| }, | ||
| { | ||
| "type": "https://witness.dev/attestations/product/v0.1", | ||
| "regopolicies": [] | ||
| } | ||
| ], | ||
| "functionaries": [ | ||
| { | ||
| "publickeyid": "{{PUBLIC_KEY_ID}}" | ||
| } | ||
| ] | ||
| } | ||
| }, | ||
| "publickeys": { | ||
| "{{PUBLIC_KEY_ID}}": { | ||
| "keyid": "{{PUBLIC_KEY_ID}}", | ||
| "key": "{{B64_PUBLIC_KEY}}" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Replace the variables in the policy | ||
|
|
||
| ``` | ||
| id=`sha256sum testpub.pem | awk '{print $1}'` && sed -i "s/{{PUBLIC_KEY_ID}}/$id/g" policy.json | ||
| pubb64=`cat testpub.pem | base64 -w 0` && sed -i "s/{{B64_PUBLIC_KEY}}/$pubb64/g" policy.json | ||
| ``` | ||
|
|
||
| ### Sign The Policy File | ||
|
|
||
| Keep this key safe, its owner will control the policy gates. | ||
|
|
||
| ``` | ||
| witness sign -f policy.json --key testkey.pem --outfile policy-signed.json | ||
| ``` | ||
|
|
||
| ### Verify the Binary Meets Policy Requirements | ||
|
|
||
| > This process works across air-gap as long as you have the signed policy file, correct binary, and public key or certificate authority corresponding to the private key that signed the policy. | ||
| > `witness verify` will return a `non-zero` exit and reason in the case of failure. Success will be silent with a `0` exit status | ||
| > for policies that require multiple steps, multiple attestations are required. | ||
| ``` | ||
| witness verify -f testapp -a test-att.json -p policy-signed.json -k testpub.pem | ||
| ``` | ||
|
|
||
| # Witness Attestors | ||
|
|
||
| ## What is a witness attestor? | ||
|
|
||
| Witness attestors are pieces of code that assert facts about a system and store those facts in a versioned schema. Each attestor has a `Name`, `Type`, and `RunType`. The `Type` is a versioned string corresponding to the JSON schema of the attestation. For example, the AWS attestor is defined as follows: | ||
|
|
||
| ``` | ||
| Name = "aws" | ||
| Type = "https://witness.dev/attestations/aws/v0.1" | ||
| RunType = attestation.PreRunType | ||
| ``` | ||
|
|
||
| The attestation types are used when we evaluate policy against these attestations. | ||
|
|
||
| ## Attestor Security Model | ||
|
|
||
| Attestations are only as secure as the data that feeds them. Where possible cryptographic material should be validated, evidence of validation should be included in the attestation for out-of-band validation. | ||
|
|
||
| Examples of cryptographic validation is found in the [GCP](https://github.com/in-toto/go-witness/blob/main/attestation/gcp-iit/gcp-iit.go), [AWS](https://github.com/in-toto/go-witness/blob/main/attestation/aws-iid/aws-iid.go), and [GitLab](https://github.com/in-toto/go-witness/blob/main/attestation/gitlab/gitlab.go) attestors. | ||
|
|
||
| ## Attestor Life Cycle | ||
|
|
||
| - **Pre-material:** Pre-material attestors run before any other attestors. These attestors generally collect information about the environment. | ||
|
|
||
| - **Material:** Material attestors run after any prematerial attestors and prior to any execute attestors. Generally these collect information about state that may change after any execute attestors, such as file hashes. | ||
|
|
||
| - **Execute:**: Execute attestors run after any material attestors and generally record information about some command or process that is to be executed. | ||
|
|
||
| - **Product:** Product attestors run after any execute attestors and generally record information about what changed during the execute lifecycle step, such as changed or created files. | ||
|
|
||
| - **Post-product:** Post-product attestors run after product attestors and generally record some additional information about specific products, such as OCI image information from a saved image tarball. | ||
|
|
||
| ### Attestation Lifecycle | ||
|
|
||
|  | ||
|
|
||
| ## Attestor Types | ||
|
|
||
| ### Pre-material Attestors | ||
| - [AWS](docs/attestors/aws-iid.md) - Attestor for AWS Instance Metadata | ||
| - [GCP](docs/attestors/gcp-iit.md) - Attestor for GCP Instance Identity Service | ||
| - [GitLab](docs/attestors/gitlab.md) - Attestor for GitLab Pipelines | ||
| - [Git](docs/attestors/git.md) - Attestor for Git Repository | ||
| - [Maven](docs/attestors/maven.md) Attestor for Maven Projects | ||
| - [Environment](docs/attestors/environment.md) - Attestor for environment variables (**_be careful with this - there is no way to mask values yet_**) | ||
| - [JWT](docs/attestors/jwt.md) - Attestor for JWT Tokens | ||
|
|
||
| ### Material Attestors | ||
| - [Material](docs/attestors/material.md) - Records secure hashes of files in current working directory | ||
|
|
||
| ### Execute Attestors | ||
| - [CommandRun](docs/attestors/commandrun.md) - Records traces and metadata about the actual process being run | ||
|
|
||
| ### Product Attestors | ||
| - [Product](docs/attestors/product.md) - Records secure hashes of files produced by commandrun attestor (only detects new files) | ||
|
|
||
| ### Post-product Attestors | ||
|
|
||
| - [OCI](docs/attestors/oci.md) - Attestor for tar'd OCI images | ||
|
|
||
| ### AttestationCollection | ||
|
|
||
| An `attestationCollection` is a collection of attestations that are cryptographically bound together. Because the attestations are bound together, we can trust that they all happened as part of the same attesation life cycle. Witness policy defines which attestations are required. | ||
|
|
||
| ### Attestor Subjects | ||
|
|
||
| Attestors define subjects that act as lookup indexes. The attestationCollection can be looked up by any of the subjects defined by the attestors. | ||
|
|
||
| ## Witness Policy | ||
|
|
||
| ### What is a witness policy? | ||
|
|
||
| A witness policy is a signed document that encodes the requirements for an artifact to be validated. A witness policy includes public keys for trusted functionaries, which attestations must be found, and rego policy to evaluate against the attestation meta-data. | ||
|
|
||
| I witness policy allowers administrators trace the compliance status of an artifact at any point during it's lifecycle. | ||
|
|
||
| ## Witness Verification | ||
|
|
||
| ### Verification Lifecycle | ||
|
|
||
|  | ||
|
|
||
| ## Using [SPIRE](https://github.com/spiffe/spire) for Keyless Signing | ||
|
|
||
| Witness can consume ephemeral keys from a [SPIRE](https://github.com/spiffe/spire) node agent. Configure witness with the flag `--spiffe-socket` to enable keyless signing. | ||
|
|
||
| During the verification process witness will use the [Rekor](https://github.com/sigstore/rekor) integrated time to make a determination on certificate validity. The SPIRE certificate only needs to remain valid long enough for the attestation to be integrated into the Rekor log. | ||
|
|
||
| ## Witness Examples | ||
|
|
||
| - [Using Witness To Prevent SolarWinds Type Attacks](examples/solarwinds/README.md) | ||
| - [Using Witness To Find Artifacts With Hidden Vulnerable Log4j Dependencies](examples/log4shell/README.md) | ||
|
|
||
| ## Media | ||
|
|
||
| - [Blog - What is a supply chain attestation, and why do I need it?](https://www.testifysec.com/blog/what-is-a-supply-chain-attestation/) | ||
| - [Talk - Securing the Software Supply Chain with the in-toto & SPIRE projects](https://www.youtube.com/watch?v=4lFbdkB62QI) | ||
| - [Talk - Securing the Software Supply Chain with SBOM and Attestation](https://www.youtube.com/watch?v=wX6aTZfpJv0) | ||
|
|
||
| ## Roadmap | ||
|
|
||
| - Attestors for all major platforms | ||
| - CaC Card Attestor | ||
| - GovCloud Attestor | ||
| - OIDC Attestor | ||
| - FIDO Attestor | ||
| - Vault Key Provider | ||
| - Cloud KMS Support | ||
| - Kubernetes Admission Controller | ||
| - SIEM Collection Agent | ||
| - Cosign Signature Validation | ||
| - Notary v2 Signature Validation | ||
| - [Zarf](https://github.com/defenseunicorns/zarf) Integration | ||
| - IronBank Attestor | ||
|
|
||
| ## Support | ||
|
|
||
| [TestifySec](https://testifysec.com) Provides support for witness and other CI security tools. | ||
| [Contact Us](mailto:info@testifysec.com) | ||
| ## Status | ||
| This library is currently pre-1.0 and therefore the API may be subject to breaking changes. | ||
|
|
||
| ## Features | ||
| - Creation and signing of in-toto attestations | ||
| - Verification of in-toto attestations and associated signatures with: | ||
| - Witness policy engine | ||
| - [OPA Rego policy language](https://www.openpolicyagent.org/docs/latest/policy-language/) | ||
| - A growing list of attestor types defined under a common interface | ||
| - A selection of attestation sources to search for attestation collections | ||
|
|
||
| ## Documentation | ||
| For more detail regarding the library itself, we recommend viewing [pkg.go.dev](https://pkg.go.dev/github.com/testifysec/go-witness). For | ||
| the documentation of the witness project, please view [the main witness repository](https://github.com/in-toto/witness/tree/main/docs). | ||
|
|
||
| ## Requirements | ||
| In order to effectively contribute to this library, you will need: | ||
| - A Unix-compatible Operating System | ||
| - GNU Make | ||
| - Go 1.19 | ||
|
|
||
| ## Running Tests | ||
| This repository uses Go tests for testing. You can run these tests by executing `make test`. |