Enhance recipe-engine to support digests #134

vishwahiremat · 2026-01-07T17:50:22Z

No description provided.

Signed-off-by: Vishwanath Hiremath <vhiremath@microsoft.com>

recipe/2025-12-recipe-digest.md

nithyatsu · 2026-01-07T18:46:10Z

recipe/2025-12-recipe-digest.md

+
+#### User story 2
+As a user of Radius recipes, I want Radius to execute the same recipe artifact that I originally published and intended during deployment, so that hidden registry changes cannot cause unexpected infrastructure behavior.
+


prevention of recipe changes with malicious intent, 2. prevent recipe changes from breaking infrastructure inadvertantly. Is this correct?

recipe/2025-12-recipe-digest.md

brooke-hamilton

How about using Spec Kit for this spec?

nithyatsu · 2026-01-07T19:08:20Z

recipe/2025-12-recipe-digest.md

+Terraform recipes require source‑specific immutability rules that align with Terraform’s supported module sources. However, this can be achieved for most module sources, but plain HTTPS or S3 needs explicit versioning or checksums.
+
+- **Git/Mercurial Based Modules** : Pin module sources using immutable commit SHAs (ref=<commit‑sha>)
+- **Terraform Registry Modules** : Registry enforces immutability of published versions.


Would we add more details here, such as a terraform documentation link that captures how tf configs can be used in a secure way

+1. Also need to specify what would happen if the user provides digest for a Terraform Recipe in the pack.

recipe/2025-12-recipe-digest.md

lakshmimsft · 2026-01-07T19:31:06Z

recipe/2025-12-recipe-digest.md

+As a platform engineer, I want to pin a recipe to an immutable digest when I register it in a recipe pack, so that any deployment using that recipe executes exactly the artifact I reviewed and approved.
+
+#### User story 2
+As a user of Radius recipes, I want Radius to execute the same recipe artifact that I originally published and intended during deployment, so that hidden registry changes cannot cause unexpected infrastructure behavior.


should we expand/give example of 'hidden registry changes'?

willtsai · 2026-01-07T19:31:00Z

recipe/2025-12-recipe-digest.md

+The core idea is :
+- A recipe is registered with both a tag and a digest
+- The digest represents the exact recipe artifact that is allowed to execute
+- During deployment, recipes are pulled by digest, not by tag


if a digest is supplied, does the tag become optional?

willtsai · 2026-01-07T19:33:50Z

recipe/2025-12-recipe-digest.md

+- The absence of an explicit digest in the recipe definition obscures which artifact was intended at authoring time.
+
+#### Proposed Option
+Option 1 is recommended. While Option 2 offers a slightly smoother authoring experience, it can result in the recipe pack being bound to a different artifact than the one originally published. Option 1 requires the digest to be explicitly provided by the user, making the intended recipe artifact clear, stable, and auditable. The additional manual step is acceptable for infrastructure recipes and aligns with established digest‑pinning practices used for OCI artifacts.


Agreed. And since providing the digest is optional anyway, the additional manual work is not forced upon the user.

recipe/2025-12-recipe-digest.md

brooke-hamilton · 2026-01-07T19:27:12Z

recipe/2025-12-recipe-digest.md

+- Maintain backward compatibility for existing recipes that do not specify a digest.
+
+### Non goals
+- No automatic patching of running apps if digests change; updates are explicit via recipe pack changes.


Nit: this is phrased as a goal rather than as a non-goal

recipe/2025-12-recipe-digest.md

willtsai · 2026-01-07T19:34:27Z

recipe/2025-12-recipe-digest.md

+Disadvantages:
+- **Manual step required**: Users must copy the digest from publish output into the recipe pack definition.
+
+##### Option 2: Controller‑Computed Digest During Registration


would there be advantages to compute and store the digest anyway, even if users don't want to specify the use of digests?

willdavsmith · 2026-01-07T19:30:55Z

recipe/2025-12-recipe-digest.md

+- The digest represents the exact recipe artifact that is allowed to execute
+- During deployment, recipes are pulled by digest, not by tag
+
+This guarantees that the infrastructure deployed by Radius is always derived from the same recipe artifact that was originally published and registered.and persists the new digest.


Suggested change

This guarantees that the infrastructure deployed by Radius is always derived from the same recipe artifact that was originally published and registered.and persists the new digest.

This guarantees that the infrastructure deployed by Radius is always derived from the same recipe artifact that was originally published and registered, and persists the new digest.

willdavsmith · 2026-01-07T19:33:22Z

recipe/2025-12-recipe-digest.md

+- The absence of an explicit digest in the recipe definition obscures which artifact was intended at authoring time.
+
+#### Proposed Option
+Option 1 is recommended. While Option 2 offers a slightly smoother authoring experience, it can result in the recipe pack being bound to a different artifact than the one originally published. Option 1 requires the digest to be explicitly provided by the user, making the intended recipe artifact clear, stable, and auditable. The additional manual step is acceptable for infrastructure recipes and aligns with established digest‑pinning practices used for OCI artifacts.


I think option 1 is fine because it's an "opt-in" security feature.

DariuszPorowski · 2026-01-07T19:36:01Z

recipe/2025-12-recipe-digest.md

+
+```
+#### Registering a recipe pack
+When registering a recipe pack, users can optionally specify the digest of the recipe artifact. When provided, the digest becomes the authoritative identifier used for deployment.


Clarify what "authoritative" means (tag vs digest behavior). i.e.

strict: if digest is set, deployment fails if recipeLocation tag doesn't currently resolve to the same digest (strong drift detection).

digest-authoritative: always pull digest and ignore the tag resolution (strong immutability, drift detection becomes a warning-only or not done at all).

willtsai · 2026-01-07T19:37:53Z

recipe/2025-12-recipe-digest.md

+
+
+### CLI Design (if applicable)
+Adding digest details to `rad recipe-pack show` command.


and also to the recipe publish commands too, right?

DariuszPorowski · 2026-01-07T19:38:31Z

recipe/2025-12-recipe-digest.md

+This proposal introduces a consistent approach to **recipe source integrity**, ensuring that recipes executed during deployment are identical to those originally intended. By validating artifact identity deployment time, Radius can detect unexpected changes and prevent execution of modified content.
+
+
+## Terms and definitions


Define the expected digest format/validation. Add a short note specifying sha256:<64 hex> and whether other algorithms are allowed; also whether validation happens at registration time, deploy time, or both.

validation happens only at deploy time.

willtsai · 2026-01-07T19:38:43Z

recipe/2025-12-recipe-digest.md

+```
+
+
+### Error Handling


What if there is a mismatch between the provided tag and digest? Does the digest take precedence, or would we error out?

removed the digest filed in the updated design.

agree with the updated design, much better

kachawla · 2026-01-07T19:42:26Z

recipe/2025-12-recipe-digest.md

+
+Terraform is different as recipes are executed by invoking `terraform init` and `terraform apply`, and Terraform itself provides built‑in integrity mechanisms:
+- Git sources can be pinned to immutable commit SHAs.
+- Terraform Registry modules are versioned and protected by checksums recorded in .terraform.lock.hcl.


What is the user experience for Terraform recipe deployment if the terraform registry module version is mutated in place?

terraform registry modules are mutable, users should enable immutable github releases/tags to achieve immutability for modules.

kachawla · 2026-01-07T19:55:02Z

recipe/2025-12-recipe-digest.md

+
+```
+#### Registering a recipe pack
+When registering a recipe pack, users can optionally specify the digest of the recipe artifact. When provided, the digest becomes the authoritative identifier used for deployment.


Should it be a required property?

kachawla · 2026-01-07T20:05:52Z

recipe/2025-12-recipe-digest.md

+##### Option 1: User‑Provided Digest at Registration Time
+In this approach, the digest is explicitly supplied by the user when creating or updating a recipe pack. The digest is typically obtained from the output of the recipe publish command and added as part of the recipe definition.
+Workflow
+- The user publishes a Bicep recipe to an OCI registry.


Are we making an assumption that bicep sources will always support a digest?

Signed-off-by: Vishwanath Hiremath <vhiremath@microsoft.com>

brooke-hamilton

I think we should do this spec as a Spec Kit feature. It would be fairly simple to use this document as input to /speckit.specify.

nithyatsu · 2026-01-14T19:42:30Z

recipe/2025-12-recipe-digest.md

+- Update authoring guide: copy digest from publish output into recipe pack.
+- Add docs for terraform recipe integrity. 
+
+## Open Questions


Would we automaticaly detect if the url has a digest or tag , and take action appropritely so that digest remains optional? How do we detect it?

willtsai · 2026-01-14T19:43:16Z

recipe/2025-12-recipe-digest.md

+    recipes: {
+      'Radius.Cache/redis': {
+        recipeKind: 'bicep'
+        recipeLocation: 'vishwaradius.azurecr.io/redis@sha256:c6a1…eabb' 


I much prefer this to requiring a separate recipeDigest field

willtsai · 2026-01-14T19:45:01Z

recipe/2025-12-recipe-digest.md

+
+Because OCI digests are immutable, this pull operation deterministically retrieves the exact recipe artifact that was originally published and registered.
+
+### Integrity Enforcement for Terraform Recipes


General guidance for Terraform - if the recipe source supports digests (e.g. git source with specific hash in the URI) then Radius should be able to support it without "getting in the way". If the source does not support digests, it is not the responsibility for Radius to build that funcationality.

+1. I think we should apply same guidance to bicep since there is no guarantee that all future bicep sources will always support a digest.

recipe-digest

2924fde

Signed-off-by: Vishwanath Hiremath <vhiremath@microsoft.com>

vishwahiremat requested review from a team as code owners January 7, 2026 17:50

vishwahiremat added 2 commits January 7, 2026 09:51

update

3e8f115

Signed-off-by: Vishwanath Hiremath <vhiremath@microsoft.com>

update

b62d2fa

Signed-off-by: Vishwanath Hiremath <vhiremath@microsoft.com>

nithyatsu reviewed Jan 7, 2026

View reviewed changes

recipe/2025-12-recipe-digest.md Show resolved Hide resolved

nithyatsu reviewed Jan 7, 2026

View reviewed changes

recipe/2025-12-recipe-digest.md Show resolved Hide resolved

brooke-hamilton reviewed Jan 7, 2026

View reviewed changes

nithyatsu reviewed Jan 7, 2026

View reviewed changes

recipe/2025-12-recipe-digest.md Show resolved Hide resolved

lakshmimsft reviewed Jan 7, 2026

View reviewed changes

willtsai reviewed Jan 7, 2026

View reviewed changes

brooke-hamilton requested changes Jan 7, 2026

View reviewed changes

willtsai reviewed Jan 7, 2026

View reviewed changes

willdavsmith reviewed Jan 7, 2026

View reviewed changes

DariuszPorowski reviewed Jan 7, 2026

View reviewed changes

willtsai reviewed Jan 7, 2026

View reviewed changes

DariuszPorowski reviewed Jan 7, 2026

View reviewed changes

willtsai reviewed Jan 7, 2026

View reviewed changes

kachawla reviewed Jan 7, 2026

View reviewed changes

vishwahiremat added 2 commits January 14, 2026 09:40

addressing feedback

e4742fd

Signed-off-by: Vishwanath Hiremath <vhiremath@microsoft.com>

update

0b0fff5

Signed-off-by: Vishwanath Hiremath <vhiremath@microsoft.com>

brooke-hamilton reviewed Jan 14, 2026

View reviewed changes

nithyatsu reviewed Jan 14, 2026

View reviewed changes

willtsai reviewed Jan 14, 2026

View reviewed changes


		#### User story 2
		As a user of Radius recipes, I want Radius to execute the same recipe artifact that I originally published and intended during deployment, so that hidden registry changes cannot cause unexpected infrastructure behavior.

	This guarantees that the infrastructure deployed by Radius is always derived from the same recipe artifact that was originally published and registered.and persists the new digest.
	This guarantees that the infrastructure deployed by Radius is always derived from the same recipe artifact that was originally published and registered, and persists the new digest.



		### CLI Design (if applicable)
		Adding digest details to `rad recipe-pack show` command.

		This proposal introduces a consistent approach to recipe source integrity, ensuring that recipes executed during deployment are identical to those originally intended. By validating artifact identity deployment time, Radius can detect unexpected changes and prevent execution of modified content.


		## Terms and definitions


		Because OCI digests are immutable, this pull operation deterministically retrieves the exact recipe artifact that was originally published and registered.

		### Integrity Enforcement for Terraform Recipes

Enhance recipe-engine to support digests #134

Are you sure you want to change the base?

Enhance recipe-engine to support digests #134

Uh oh!

Conversation

vishwahiremat commented Jan 7, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

brooke-hamilton left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brooke-hamilton left a comment

Choose a reason for hiding this comment

Uh oh!

nithyatsu Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kachawla Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

nithyatsu Jan 14, 2026 •

edited

Loading

kachawla Jan 14, 2026 •

edited

Loading