feat: scripts/extract-nitro-pcrs.sh + self-hosted-tee docs #300
+270
−22
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,156 @@ | ||
| #!/usr/bin/env bash | ||
| # Build the tkhq/qos enclave image at the deployment rev declared in | ||
| # src/Cargo.toml (the `# qos-deployment-rev = …` marker, not the library | ||
| # `rev = "..."` on each qos crate) and extract /nitro.pcrs from the | ||
| # resulting OCI image. | ||
| set -euo pipefail | ||
|
|
||
| SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" | ||
| REPO_ROOT="$(git -C "$SCRIPT_DIR" rev-parse --show-toplevel)" | ||
|
|
||
| CARGO_TOML="$REPO_ROOT/src/Cargo.toml" | ||
| OUTPUT="$REPO_ROOT/out/nitro.pcrs" | ||
| SKOPEO_IMAGE="quay.io/skopeo/stable@sha256:4d60d6c00b62b463d0a99a7aeedc49358a32c8222540c72d561606e188afb168" | ||
| QOS_REMOTE="https://github.com/tkhq/qos.git" | ||
| QOS_DIR="" | ||
| REV="" | ||
|
|
||
| QOS_DIR_AUTO=0 | ||
| STAGE_DIR="" | ||
| CID="" | ||
| DOCKER_TAG="" | ||
|
|
||
| usage() { | ||
| cat <<EOF | ||
| Usage: $(basename "$0") [options] | ||
|
|
||
| Build the tkhq/qos enclave image at the deployment rev declared in | ||
| src/Cargo.toml (the '# qos-deployment-rev = ...' marker comment) and | ||
| extract /nitro.pcrs from the resulting OCI image. Pass --rev to target | ||
| any other qos rev — useful when auditing a prospective deployment bump | ||
| before updating Cargo.toml. | ||
|
|
||
| Options: | ||
| --cargo-toml PATH Workspace Cargo.toml (default: $CARGO_TOML) | ||
| --qos-dir PATH Where to clone/reuse qos (default: mktemp -d, removed on exit) | ||
| --output PATH Where to write nitro.pcrs (default: $OUTPUT) | ||
| --skopeo-image REF Skopeo image (pinned by digest) (default: pinned upstream) | ||
| --rev REV Override the rev (skip Cargo.toml marker) | ||
| -h, --help Show this help and exit | ||
| EOF | ||
| } | ||
|
|
||
| die() { | ||
| echo "$*" >&2 | ||
| exit 1 | ||
| } | ||
|
|
||
| parse_args() { | ||
| while [[ $# -gt 0 ]]; do | ||
| case "$1" in | ||
| --cargo-toml) CARGO_TOML="$2"; shift 2 ;; | ||
| --qos-dir) QOS_DIR="$2"; shift 2 ;; | ||
| --output) OUTPUT="$2"; shift 2 ;; | ||
| --skopeo-image) SKOPEO_IMAGE="$2"; shift 2 ;; | ||
| --rev) REV="$2"; shift 2 ;; | ||
| -h|--help) usage; exit 0 ;; | ||
| *) die "Unknown argument: $1" ;; | ||
| esac | ||
| done | ||
| } | ||
|
|
||
| read_rev() { | ||
| [[ -f "$CARGO_TOML" ]] || die "Cargo.toml not found: $CARGO_TOML" | ||
| local marker | ||
| marker=$(grep -oE '^#[[:space:]]*qos-deployment-rev[[:space:]]*=[[:space:]]*[0-9a-f]{40}' "$CARGO_TOML" || true) | ||
| [[ -n "$marker" ]] || die "No '# qos-deployment-rev = ...' marker in $CARGO_TOML" | ||
| REV=$(echo "$marker" | grep -oE '[0-9a-f]{40}') | ||
| } | ||
|
|
||
| ensure_qos_checkout() { | ||
| if [[ -z "$QOS_DIR" ]]; then | ||
| QOS_DIR="$(mktemp -d -t visualsign-qos.XXXXXX)" | ||
| QOS_DIR_AUTO=1 | ||
| fi | ||
|
|
||
| if [[ -d "$QOS_DIR/.git" ]]; then | ||
| local origin | ||
| origin="$(git -C "$QOS_DIR" remote get-url origin 2>/dev/null || true)" | ||
| [[ "$origin" == "$QOS_REMOTE" ]] \ | ||
| || die "qos checkout $QOS_DIR has origin '$origin'; expected '$QOS_REMOTE'. Refusing to mutate." | ||
| local head | ||
| head="$(git -C "$QOS_DIR" rev-parse HEAD)" | ||
| if [[ "$head" == "$REV" ]]; then | ||
| echo "Reusing qos checkout at $QOS_DIR (HEAD=$head)" >&2 | ||
| return | ||
| fi | ||
| [[ -z "$(git -C "$QOS_DIR" status --porcelain)" ]] \ | ||
| || die "qos checkout $QOS_DIR has uncommitted changes" | ||
| echo "Updating qos checkout in $QOS_DIR to $REV" >&2 | ||
| git -C "$QOS_DIR" fetch --quiet origin "$REV" | ||
| git -C "$QOS_DIR" checkout --quiet "$REV" | ||
| return | ||
| fi | ||
|
|
||
| echo "Cloning tkhq/qos into $QOS_DIR" >&2 | ||
| git clone --quiet "$QOS_REMOTE" "$QOS_DIR" | ||
| git -C "$QOS_DIR" checkout --quiet "$REV" | ||
| } | ||
|
Comment on lines
+76
to
+98
Contributor
Author
There was a problem hiding this comment. Fixed in 41489bf: |
||
|
|
||
| build_qos_enclave() { | ||
| echo "Building qos_enclave at rev $REV (may take several minutes)..." >&2 | ||
| make -C "$QOS_DIR" out/qos_enclave/index.json | ||
| } | ||
|
|
||
| extract_pcrs() { | ||
| local oci_dir="$QOS_DIR/out/qos_enclave" | ||
| [[ -f "$oci_dir/index.json" ]] || die "qos build did not produce $oci_dir/index.json" | ||
|
|
||
| STAGE_DIR="$(mktemp -d -t visualsign-pcrs.XXXXXX)" | ||
| DOCKER_TAG="qos-enclave:extract-$$-${RANDOM}" | ||
|
|
||
| docker run --rm \ | ||
| --user "$(id -u):$(id -g)" \ | ||
| -v "$oci_dir:/src:ro" \ | ||
| -v "$STAGE_DIR:/dst" \ | ||
| "$SKOPEO_IMAGE" \ | ||
| copy "oci:/src:latest" "docker-archive:/dst/qos_enclave.tar:$DOCKER_TAG" | ||
|
|
||
| docker load -i "$STAGE_DIR/qos_enclave.tar" | ||
| CID="$(docker create "$DOCKER_TAG")" | ||
|
|
||
| mkdir -p "$(dirname "$OUTPUT")" | ||
| docker cp "$CID:/nitro.pcrs" "$OUTPUT" | ||
| [[ -s "$OUTPUT" ]] || die "nitro.pcrs not found in qos-enclave image" | ||
| } | ||
|
|
||
| cleanup() { | ||
| if [[ -n "$CID" ]]; then | ||
| docker rm "$CID" >/dev/null 2>&1 || true | ||
| fi | ||
| if [[ -n "$DOCKER_TAG" ]]; then | ||
| docker rmi "$DOCKER_TAG" >/dev/null 2>&1 || true | ||
| fi | ||
| if [[ -n "$STAGE_DIR" ]]; then | ||
| rm -rf "$STAGE_DIR" | ||
| fi | ||
|
Comment on lines
+112
to
+136
Contributor
Author
There was a problem hiding this comment. Fixed in 41489bf: skopeo now runs with |
||
| if [[ "$QOS_DIR_AUTO" -eq 1 && -n "$QOS_DIR" ]]; then | ||
| rm -rf "$QOS_DIR" | ||
| fi | ||
| } | ||
|
Comment on lines
+127
to
+140
Contributor
Author
There was a problem hiding this comment. Fixed in 41489bf: |
||
|
|
||
| main() { | ||
| parse_args "$@" | ||
| if [[ -z "$REV" ]]; then | ||
| read_rev | ||
| fi | ||
| trap cleanup EXIT | ||
| ensure_qos_checkout | ||
| build_qos_enclave | ||
| extract_pcrs | ||
|
Comment on lines
+142
to
+150
Contributor
Author
There was a problem hiding this comment. Pushing back: existing scripts in |
||
| echo "Wrote $OUTPUT:" >&2 | ||
| cat "$OUTPUT" | ||
| echo | ||
| } | ||
|
|
||
| main "$@" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Resolved differently: rather than hardening the dep-line regex, the script now reads the deployment rev from a dedicated
# qos-deployment-rev = <40-hex>marker comment insrc/Cargo.toml(the deprev = "..."values are the qos library version, not the deployed runtime — see r-n-o thread above). The marker has a single fixed format, so the parsing is much more robust than the previous regex would have been.