Skip to content

Commit

Permalink
chore: Update attestors and commands documentation.
Browse files Browse the repository at this point in the history
Signed-off-by: Matthias Glastra <matglas.git@gmail.com>
  • Loading branch information
matglas committed Feb 17, 2025
1 parent 9a3e894 commit ebc3f07
Show file tree
Hide file tree
Showing 9 changed files with 106 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/attestors/git.json
Original file line number Diff line number Diff line change
Expand Up @@ -142,3 +142,4 @@
}
}
}

1 change: 0 additions & 1 deletion docs/attestors/git.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Both staged and unstaged states are recorded.
The attestor returns the SHA1 ([Secure Hash Algorithm 1](https://en.wikipedia.org/wiki/SHA-1)) git commit hash as a subject.

## Schema

```json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
Expand Down
1 change: 0 additions & 1 deletion docs/attestors/jenkins.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ The [Jenkins](https://www.jenkins.io/) Attestor records information about the Je
Witness was run.

## Schema

```json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
Expand Down
48 changes: 48 additions & 0 deletions docs/attestors/lockfiles.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$ref": "#/$defs/Attestor",
"$defs": {
"Attestor": {
"properties": {
"lockfiles": {
"items": {
"$ref": "#/$defs/LockfileInfo"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"lockfiles"
]
},
"DigestSet": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"LockfileInfo": {
"properties": {
"filename": {
"type": "string"
},
"content": {
"type": "string"
},
"digest": {
"$ref": "#/$defs/DigestSet"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"filename",
"content",
"digest"
]
}
}
}

50 changes: 50 additions & 0 deletions docs/attestors/lockfiles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
## Schema
```json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$ref": "#/$defs/Attestor",
"$defs": {
"Attestor": {
"properties": {
"lockfiles": {
"items": {
"$ref": "#/$defs/LockfileInfo"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"lockfiles"
]
},
"DigestSet": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"LockfileInfo": {
"properties": {
"filename": {
"type": "string"
},
"content": {
"type": "string"
},
"digest": {
"$ref": "#/$defs/DigestSet"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"filename",
"content",
"digest"
]
}
}
}
```
1 change: 1 addition & 0 deletions docs/attestors/omnitrail.json
Original file line number Diff line number Diff line change
Expand Up @@ -143,3 +143,4 @@
}
}
}

1 change: 1 addition & 0 deletions docs/attestors/sbom.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@
}
}
}

1 change: 1 addition & 0 deletions docs/attestors/vex.json
Original file line number Diff line number Diff line change
Expand Up @@ -200,3 +200,4 @@
}
}
}

4 changes: 4 additions & 0 deletions docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ witness run [cmd] [flags]
--attestor-slsa-export Export the SLSA provenance predicate in its own attestation
--dirhash-glob strings Dirhash glob can be used to collapse material and product hashes on matching directory matches.
--enable-archivista Use Archivista to store or retrieve attestations
--env-add-sensitive-key strings Add keys or globs (e.g. '*TEXT') to the list of sensitive environment keys.
--env-disable-default-sensitive-vars Disable the default list of sensitive vars and only use the items mentioned by --add-sensitive-key.
--env-exclude-sensitive-key strings Exclude specific keys from the list of sensitive environment keys. Note: This does not support globs.
--env-filter-sensitive-vars Switch from obfuscate to filtering variables which removes them from the output completely.
--hashes strings Hashes selected for digest calculation. Defaults to SHA256 (default [sha256])
-h, --help help for run
-o, --outfile string File to write signed data to
Expand Down

0 comments on commit ebc3f07

Please sign in to comment.