From 775c4bbf7da1c7e1c6fc833f82aae1d34f8de0bd Mon Sep 17 00:00:00 2001 From: steve lasker Date: Wed, 28 Aug 2024 07:51:17 -0700 Subject: [PATCH 1/2] Add meta-map supporting Event Attributes in SCITT Signed-off-by: steve lasker --- .../developer-patterns/scitt-api/index.md | 26 ++++++++++++++++--- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/content/developers/developer-patterns/scitt-api/index.md b/content/developers/developer-patterns/scitt-api/index.md index b1c1744f6..e0f968a9b 100644 --- a/content/developers/developer-patterns/scitt-api/index.md +++ b/content/developers/developer-patterns/scitt-api/index.md @@ -56,6 +56,7 @@ Clone the [DataTrails SCITT Examples](https://github.com/datatrails/datatrails-s ```bash python -m venv venv && \ source venv/bin/activate && \ + trap deactivate EXIT && \ pip install --upgrade pip && \ pip install -r requirements.txt ``` @@ -96,7 +97,7 @@ For the Quickstart, create a testing key which DataTrails will cryptographically Create any payload you wish to register on DataTrails. ```bash -cat > payload.json < /tmp/payload.json < payload.json < /tmp/attributes.json < Date: Wed, 4 Sep 2024 12:46:21 -0700 Subject: [PATCH 2/2] Update examples Signed-off-by: steve lasker --- .../developer-patterns/scitt-api/index.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/content/developers/developer-patterns/scitt-api/index.md b/content/developers/developer-patterns/scitt-api/index.md index e0f968a9b..ff78b3233 100644 --- a/content/developers/developer-patterns/scitt-api/index.md +++ b/content/developers/developer-patterns/scitt-api/index.md @@ -1,7 +1,7 @@ --- title: "Quickstart: SCITT Statements (Preview)" description: "Getting Started with SCITT: creating a collection of statements (Preview)" -lead: "How to push a collection of Statements using SCITT APIs" +lead: "How to push a collection of Statements and meta-data using SCITT APIs" date: 2021-06-09T13:49:35+01:00 lastmod: 2021-06-09T13:49:35+01:00 draft: false @@ -28,7 +28,8 @@ This includes previously registered statements, and newly registered statements This quickstart will: 1. create, or use an existing a key to sign a collection of statements about an artifact -1. create and register a statement for an artifact +1. create metadata for the statement, enabling subsequent querying +1. create and register a signed statement for an artifact 1. query a collection of statements about the artifact ## Prerequisites @@ -76,7 +77,7 @@ Clone the [DataTrails SCITT Examples](https://github.com/datatrails/datatrails-s # File representing the transparent statement, which includes the signed statement and the registration receipt TRANSPARENT_STATEMENT_FILE="transparent-statement.cbor" - # Subject is a property used to correlate a collection of statements about an artifact + # Property used to correlate a collection of statements about an artifact SUBJECT="my-product-id" ``` @@ -110,12 +111,13 @@ EOF [DataTrails Event Attributes](./../../api-reference/events-api/) can be associated with a SCITT Statement, enabling indexing. -Create metadata with a dictionary of key:value pairs. +Create metadata with a dictionary of `key:value` pairs. ```bash +HASH=$(sha256sum "/tmp/payload.json" | cut -d ' ' -f 1) cat > /tmp/attributes.json <}} @@ -185,8 +186,7 @@ Coming soon: Filter on specific content types, such as what SBOMs have been regi The quickstart created a collection of statements for a given artifact. Over time, as new information is available, authors can publish new statements which verifiers and consumers can benefit from, making decisions specific to their environment. -There are no limits to the types of additional statements that may be registered, which may include new vulnerability information, notifications of new versions, end of life (EOL) notifications, or more. -By using the content-type parameter, verifiers can filter to specific types, filter statements by the issuer, or other headers & metadata. +There are no limits to the types of additional statements that may be registered, which may include new information related to an AI Model, new vulnerability information, notifications of new versions, end of life (EOL) notifications, or more. For more information: