Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: remove default prefix from trustedIdentities default template #2057

Conversation

shahramk64
Copy link
Contributor

@shahramk64 shahramk64 commented Jan 22, 2025

Description

What this PR does / why we need it:

Ratify helm install command adds a prefix to the notation verifier's trustedIdentities strings which is "x509.subject: "
The trusted identity for AWS signer is different. This PR removes the prefix in the helm template and instead, the users will need to add the necessary prefix on their own.

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):

Fixes #2056

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Helm Chart Change (any edit/addition/update that is necessary for changes merged to the main branch)
  • This change requires a documentation update

How Has This Been Tested?

The rendered template of this command

helm template test-atify ./charts/ratify --atomic \
    --namespace gatekeeper-system \
    --set crl.cache.enabled=false \
    --set featureFlags.RATIFY_CERT_ROTATION=true \
    --set provider.enableMutation=false \
    --set-file notationCerts[0]="notation-file1.crt" \
    --set notation.trustPolicies[0].registryScopes[0]="*" \
    --set notation.trustPolicies[0].trustStores[0]=signingAuthority:notationCerts[0] \
    --set notation.trustPolicies[0].trustedIdentities[0]="arn:aws:signer:us-east-1:000000000000:/signing-profiles/notation_profile"

is:

# Source: ratify/templates/verifier.yaml
apiVersion: config.ratify.deislabs.io/v1beta1
kind: Verifier
metadata:
  name: verifier-notation
  annotations:
    helm.sh/hook: pre-install,pre-upgrade
    helm.sh/hook-weight: "5"
spec:
  name: notation
  version: 1.0.0
  artifactTypes: application/vnd.cncf.notary.signature
  parameters:
    verificationCertStores:
      signingAuthority:
        cert-0:
          - test-atify-ratify-notation-inline-cert-0
    trustPolicyDoc:
      version: "1.0"
      trustPolicies:
        - name: trustPolicy-0  
          registryScopes:
            - "*"
          signatureVerification:
            level: strict  
          trustStores:
            - signingAuthority:cert-0
          trustedIdentities:
            - "arn:aws:signer:us-east-1:000000000000:/signing-profiles/notation_profile"

which shows that the trustedIdentities "arn:aws:signer:us-east-1:000000000000:/signing-profiles/notation_profile" doesn't contain the prefix x509.subject: anymore

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration
in addition to the helm template command described above, the base-test.bats file is also updated to cover this change.

Checklist:

  • Does the affected code have corresponding tests?
  • Are the changes documented, not just with inline documentation, but also with conceptual documentation such as an overview of a new feature, or task-based documentation like a tutorial? Consider if this change should be announced on your project blog.
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have appropriate license header?

Post Merge Requirements

  • MAINTAINERS: manually trigger the "Publish Package" workflow after merging any PR that indicates Helm Chart Change

Signed-off-by: Shahram Kalantari <[email protected]>
Copy link

codecov bot commented Jan 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

see 5 files with indirect coverage changes

@shahramk64 shahramk64 marked this pull request as ready for review January 22, 2025 05:54
Copy link
Collaborator

@susanshi susanshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. thanks for the fix

@susanshi susanshi changed the title fix: remove the prefix fix: remove default prefix from trustedIdentities default template Jan 22, 2025
@susanshi susanshi enabled auto-merge (squash) January 23, 2025 00:13
@susanshi susanshi merged commit 78d8128 into ratify-project:dev Jan 23, 2025
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

remove prefix from notation verifiers trustedIdentities
3 participants