Skip to content
This repository has been archived by the owner on Jun 6, 2024. It is now read-only.

Commit

Permalink
remove old check docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Cole Kennedy committed Mar 28, 2023
1 parent 48ef8a3 commit 289a94d
Showing 1 changed file with 1 addition and 16 deletions.
17 changes: 1 addition & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# [Witness](http://github.com/testifysec/witness) Policy Tool
# Witness Policy Tool

The Witness Policy Tool is a command-line utility designed to create, and validate Witness policies. These policies play a crucial role in maintaining the integrity and security of your software development lifecycle (SDLC) by requiring the presence of specific attestations and values throughout every stage. To learn more about Witness, visit its [GitHub repository](http://github.com/testifysec/witness) , and for further information on policies, consult the [Witness policy documentation](https://github.com/testifysec/witness/blob/main/docs/policy.md) .

Expand All @@ -15,21 +15,6 @@ To generate a [Witness](http://github.com/testifysec/witness) policy from existi

Additionally, the tool includes a Rego Module Generator that helps you create Rego modules for validating attestation data based on key-value pairs provided in a YAML configuration file.

#### Check Command

The tool is run from the command line and takes the unsigned policy file as its only argument. For example:

```policy-tool check unsigned_policy_file.json```

The tool will output the following information:

- The steps in the policy file and the attestations associated with each step
- The decoded Rego policy module for each attestation
- The roots used in the policy file and the subject of each root's certificate
- The number of steps and roots parsed from the policy file

If there are any errors in the policy file, the tool will output a detailed error message with information about the error, including the step and attestation where the error occurred.

## Generating Policy From Existing Attestations

The policy tool supports generating attestations from attestation collections. The user should instrument their pipeline with [Witness](http://github.com/testifysec/witness) and take
Expand Down

0 comments on commit 289a94d

Please sign in to comment.