Update attestor docs from bump to go-witness v0.7.0

Signed-off-by: John Kjell <[email protected]>
in-toto · Dec 4, 2024 · a167dc5 · a167dc5
1 parent dc167c2
commit a167dc5
Show file tree

Hide file tree

Showing 4 changed files with 139 additions and 1 deletion.
diff --git a/docs/attestors/git.json b/docs/attestors/git.json
@@ -4,6 +4,15 @@
   "$defs": {
     "Attestor": {
       "properties": {
+        "gittool": {
+          "type": "string"
+        },
+        "gitbinpath": {
+          "type": "string"
+        },
+        "gitbinhash": {
+          "$ref": "#/$defs/DigestSet"
+        },
         "commithash": {
           "type": "string"
         },
@@ -71,6 +80,7 @@
       "additionalProperties": false,
       "type": "object",
       "required": [
+        "gittool",
         "commithash",
         "author",
         "authoremail",

diff --git a/docs/attestors/git.md b/docs/attestors/git.md
@@ -3,19 +3,28 @@
 The Git Attestor records the current state of the objects in the git repository, including untracked objects.
 Both staged and unstaged states are recorded.
 
-
 ## Subjects
 
 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",
   "$ref": "#/$defs/Attestor",
   "$defs": {
     "Attestor": {
       "properties": {
+        "gittool": {
+          "type": "string"
+        },
+        "gitbinpath": {
+          "type": "string"
+        },
+        "gitbinhash": {
+          "$ref": "#/$defs/DigestSet"
+        },
         "commithash": {
           "type": "string"
         },
@@ -83,6 +92,7 @@ The attestor returns the SHA1 ([Secure Hash Algorithm 1](https://en.wikipedia.or
       "additionalProperties": false,
       "type": "object",
       "required": [
+        "gittool",
         "commithash",
         "author",
         "authoremail",

diff --git a/docs/attestors/jenkins.json b/docs/attestors/jenkins.json
@@ -0,0 +1,55 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Attestor",
+  "$defs": {
+    "Attestor": {
+      "properties": {
+        "buildid": {
+          "type": "string"
+        },
+        "buildnumber": {
+          "type": "string"
+        },
+        "buildtag": {
+          "type": "string"
+        },
+        "pipelineurl": {
+          "type": "string"
+        },
+        "executornumber": {
+          "type": "string"
+        },
+        "javahome": {
+          "type": "string"
+        },
+        "jenkinsurl": {
+          "type": "string"
+        },
+        "jobname": {
+          "type": "string"
+        },
+        "nodename": {
+          "type": "string"
+        },
+        "workspace": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "type": "object",
+      "required": [
+        "buildid",
+        "buildnumber",
+        "buildtag",
+        "pipelineurl",
+        "executornumber",
+        "javahome",
+        "jenkinsurl",
+        "jobname",
+        "nodename",
+        "workspace"
+      ]
+    }
+  }
+}
+
diff --git a/docs/attestors/jenkins.md b/docs/attestors/jenkins.md
@@ -0,0 +1,63 @@
+# Jenkins Attestor
+
+The [Jenkins](https://www.jenkins.io/) Attestor records information about the Jenkins CI/CD job execution in which
+Witness was run.
+
+## Schema
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Attestor",
+  "$defs": {
+    "Attestor": {
+      "properties": {
+        "buildid": {
+          "type": "string"
+        },
+        "buildnumber": {
+          "type": "string"
+        },
+        "buildtag": {
+          "type": "string"
+        },
+        "pipelineurl": {
+          "type": "string"
+        },
+        "executornumber": {
+          "type": "string"
+        },
+        "javahome": {
+          "type": "string"
+        },
+        "jenkinsurl": {
+          "type": "string"
+        },
+        "jobname": {
+          "type": "string"
+        },
+        "nodename": {
+          "type": "string"
+        },
+        "workspace": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "type": "object",
+      "required": [
+        "buildid",
+        "buildnumber",
+        "buildtag",
+        "pipelineurl",
+        "executornumber",
+        "javahome",
+        "jenkinsurl",
+        "jobname",
+        "nodename",
+        "workspace"
+      ]
+    }
+  }
+}
+```