Merge pull request #711 from datatrails/steve/scitt-example

SCITT Getting Started - Supply Chain

.vscode/settings.json

@@ -20,7 +20,7 @@
     "shortcode",
     "Shortcodes",
     "slugified",
-    "Synsation",
+    "synsation",
     "templating",
     "Untracking",
     "urlencode",

content/developers/developer-patterns/scitt-api/index.md

@@ -0,0 +1,174 @@
+---
+title: "Quickstart: SCITT Statements (Preview)"
+description: "Getting Started with SCITT: creating a collection of statements  (Preview)"
+lead: "Push a collection of Statements using SCITT APIs"
+date: 2021-06-09T13:49:35+01:00
+lastmod: 2021-06-09T13:49:35+01:00
+draft: false
+images: []
+menu:
+  developers:
+    parent: "developer-patterns"
+weight: 110
+toc: true
+aliases: 
+  - /docs/developer-patterns/scitt-api/
+---
+
+{{< caution >}}
+The SCITT API is currently in preview and subject to change
+{{< /caution >}}
+
+The **S**upply **C**hain **I**ntegrity, **T**ransparency and **T**rust (SCITT) initiative is a set of [IETF standards](https://datatracker.ietf.org/group/scitt/documents/) for managing the compliance and auditability of goods and services across end-to-end supply chains.
+SCITT supports the ongoing verification of goods and services where the authenticity of entities, evidence, policy, and artifacts can be assured and the actions of entities can be guaranteed to be authorized, non-repudiable, immutable, and auditable.
+
+To assure insights to supply chain artifacts are current, the SCITT APIs provide a correlation of statements, allowing verifiers to view a full history of statements.
+This includes previously registered statements, and newly registered statements providing the most up to date insights.
+
+This quickstart will:
+
+1. create, or use an existing a key to sign a collection of statements about an artifact
+1. create and register an statement for the artifact
+1. create and register an attestation for the artifact
+1. query a collection of statements about the artifact
+
+## Prerequisites
+
+- [A DataTrails subscription](https://app.datatrails.ai/signup)
+- [DataTrails sample code](#datatrails-sample-code)
+- [Environment Configuration](#environment-configuration)
+
+### DataTrails Sample Code
+
+The Quickstart uses existing samples and scripts to focus on the SCITT APIs.
+
+Clone the [DataTrails SCITT Examples](https://github.com/datatrails/datatrails-scitt-samples) repository to copy those files to your environment.
+
+  ```shell
+  git clone https://github.com/datatrails/datatrails-scitt-samples.git
+
+  cd datatrails-scitt-samples
+  ```
+
+## Environment Configuration
+
+1. Create a Python Virtual Environment for the sample scripts and install the dependencies
+
+    ```shell
+    python -m  venv venv && \
+    source venv/bin/activate && \
+    pip install -r requirements.txt
+    ```
+
+1. To ease copying and pasting commands, update any variables to fit your environment
+
+  ```shell
+  ISSUER=sample.sysnation.dev
+  SIGNING_KEY=my-signing-key.pem
+  SIGNED_STATEMENT_FILE=signed-statement.txt
+  ```
+
+1. Create a [bearer_token](/developers/developer-patterns/getting-access-tokens-using-app-registrations) stored as a file, in a secure local directory with 0600 permissions.
+
+## Create a Signing Key
+
+{{< note >}}
+If you already have a COSE Key, skip ahead to [Generating a Payload](#generating-a-payload)
+{{< /note >}}
+
+There are multiple methods to create a signed statement, for methods other than using a basic signing key, see: _(TODO: link to supporting docs)
+_(TODO: link to supported DataTrails Signing Keys\)_<br>
+For the Quickstart, create a testing [COSE Key](https://cose-wg.github.io/cose-spec/#key-structure) which DataTrails will cryptographically validate upon registration
+
+  ```shell
+  openssl ecparam -name prime256v1 -genkey -out $SIGNING_KEY
+  ```
+
+## Generating a Payload
+
+In the samples we assume the statement is a json document, e.g:
+
+```shell
+cat > payload.json <<EOF
+{
+    "author": "fred",
+    "title": "my biography",
+    "reviews": "mixed"
+}
+EOF
+```
+
+1. Create a Feed ID, used to correlate a collection of statements
+
+    ```shell
+    FEED="my-product-id"
+    ```
+
+1. Create a Signed Statement for the SPDX SBOM
+
+    ```shell
+    python scitt/create_signed_statement.py \
+      --signing-key-file $SIGNING_KEY \
+      --issuer $ISSUER \
+      --feed $FEED \
+      --content-type application/spdx+json \
+      --payload-file payload.json \
+      --output-file $SIGNED_STATEMENT_FILE
+
+1. Register the Statement
+
+    ```shell
+    SIGNED_STATEMENT=`cat $SIGNED_STATEMENT_FILE`
+    OPERATION_ID=$(curl -X POST -H @$HOME/.datatrails/bearer-token.txt -d \
+                    '{"statement":"'$SIGNED_STATEMENT'"}' \
+                    https://app.datatrails.ai/archivist/v1/publicscitt/entries | jq -r .operationID)
+    ```
+
+1. Monitor for the Statement to be anchored
+
+    ```shell
+    curl -H @$HOME/.datatrails/bearer-token.txt \
+      https://app.datatrails.ai/archivist/v1/publicscitt/operations/$OPERATION_ID \
+      | jq
+    ```
+
+1. Retrieve the Entry_ID for registered signed statement
+
+    ```shell
+    ENTRY_ID=$(curl -H @$HOME/.datatrails/bearer-token.txt \
+      https://app.datatrails.ai/archivist/v1/publicscitt/operations/$OPERATION_ID \
+      | jq -r .operationID)
+    ```
+
+1. Retrieve a SCITT Receipt
+
+    ```shell
+    curl -H @$HOME/.datatrails/bearer-token.txt \
+      https://app.datatrails.ai/archivist/v1/publicscitt/entries/$ENTRY_ID/receipt | jq
+    ```
+
+## Retrieve Statements for the Artifact
+
+The power of SCITT is the ability to retrieve the history of statements made for a given artifact.
+By querying the series of statements, consumers can verify who did what and when for a given artifact.
+
+1. Query DataTrails for the collection of statements
+
+    ```shell
+    curl -H @$HOME/.datatrails/bearer-token.txt \
+      https://app.datatrails.ai/archivist/v2/publicassets/-/events?event_attributes.feed_id=$FEED | jq
+    ```
+
+To filter on specific content types, such as what SBOMs have been registered, or which issuers have made statements, see \<TODO: here>
+
+## Summary
+
+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.
+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, and/or filter statements by the issuer.
+
+For more information:
+
+<!-- - [DataTrails SCITT API Reference](TBD) -->
+- [SCITT.io](SCITT.io)