gatekeeper-valint

README

Valint Gatekeeper Provider

To integrate OPA Gatekeeper's new ExternalData feature with Valint to verify policies on your supply chain.

This repo is meant for testing Gatekeeper external data feature. Do not use for production.

Installation

Installing gatekeeper

• Deploy Gatekeeper with external data enabled (--enable-external-data)

helm repo add gatekeeper https://open-policy-agent.github.io/gatekeeper/charts
helm install gatekeeper/gatekeeper  \
    --name-template=gatekeeper \
    --namespace gatekeeper-system --create-namespace \
    --set enableExternalData=true \
    --set controllerManager.dnsPolicy=ClusterFirst,audit.dnsPolicy=ClusterFirst \
    --version 3.10.0

Note: This repository is currently only working with Gatekeeper 3.10 and the externalData feature in alpha. There is an open issue to track the support of Gatekeeper 3.11 and externalData feature in beta: https://github.com/scribe-security/gatekeeper-valint/issues/20.

Installing Valint Gatekeeper provider

• kubectl apply -f manifest

• kubectl apply -f policy/provider.yaml

  • Update url if it's not http://gatekeeper-valint.gatekeeper-valint:8090 (default)

• kubectl apply -f policy/template.yaml

• kubectl apply -f policy/constraint.yaml

Evidence Stores

Each storer can be used to store, find and download evidence, unifying all the supply chain evidence into a system is an important part to be able to query any subset for policy validation.

Type	Description	requirement
scribe	Evidence is stored on scribe service	scribe credentials
OCI	Evidence is stored on a remote OCI registry	access to a OCI registry

Scribe Evidence store

Scribe evidence store allows you store evidence using scribe Service.

Related Deployment environments:

Note the values set:

• VALINT_SCRIBE_AUTH_CLIENT_ID
• VALINT_SCRIBE_AUTH_CLIENT_SECERT
• VALINT_SCRIBE_ENABLE

Before you begin

Integrating Scribe Hub with admission controller requires the following credentials that are found in the Integrations page. (In your Scribe Hub go to integrations)

• Client ID
• Client Secret

1. Edit the manifest/secret.yaml file, enable client and add related Client ID and Client Secret.

For example.

apiVersion: v1
kind: Secret
metadata:
  name: scribe-cred-secret
  namespace: gatekeeper-valint
stringData:
  scribe_client_id: "<your client secret>"
  scribe_client_secret: "<your client secret>"
  scribe_enable: "true"

1. To install the gatekeeper-valint with Scribe service integration:

    kubectl apply -f manifest
    # Update `url` if it's not `http://gatekeeper-valint.gatekeeper-valint:8090` (default)
    kubectl apply -f policy/provider.yaml

    kubectl apply -f policy/template.yaml
    kubectl apply -f policy/constraint.yaml

Credentials will be stored as a secret named scribe-cred-secret.

OCI Evidence store

Valint supports both storage and verification flows for attestations and statement objects using an OCI registry as an evidence store.
Using OCI registry as an evidence store allows you to upload and verify evidence across your supply chain in a seamless manner.

Related configmap flags:

• config.attest.cocosign.storer.OCI.enable - Enable OCI store.
• config.attest.cocosign.storer.OCI.repo - Evidence store location.

Dockerhub limitation

Dockerhub does not support the subpath format, oci-repo should be set to your Dockerhub Username.

Some registries like Jfrog allow multi layer format for repo names such as , my_org.jfrog.io/policies/attestations.

Before you begin

• Write access to upload evidence using the valint tool.
• Read access to download evidence for the provider.
• Evidence can be stored in any accessible OCI registry.

1. Edit the manifest/configmap.yaml file, enable OCI client and enable a OCI repo. For example,

   attest:
    cocosign:
      storer:
        OCI:
          enable: true
          repo: <optional oci-repo>
   

   [oci-repo] is the URL of the OCI repository where all evidence will be uploaded.

   • Example: If your oci repo is somewhere/evidence_store create a evidence for example/my_image:latest, the evidence will be stored as under somewhere/evidence_store/image/SHA-256-DIGEST.sig

   Empty oci-repo will Attach the evidence to the same repo as the uploaded image.

   • Example: If you create a evidence for example/my_image:latest, the evidence will be stored as example/my_image:SHA-256-DIGEST.sig (oci-repo).

1. To install the gatekeeper-valint with Scribe service integration:

    kubectl apply -f manifest
    # Update `url` if it's not `http://gatekeeper-valint.gatekeeper-valint:8090` (default)
    kubectl apply -f policy/provider.yaml

    kubectl apply -f policy/template.yaml
    kubectl apply -f policy/constraint.yaml

Verification

See Gatekeeper Valint in action

By default Valint policy is a simplistic verify signature policy.

kubectl apply -f policy/examples/error.yaml

Request should be rejected as the image was not signed.

  TBD output expected

This will successfully create the pod demo using a demo signed image.

kubectl apply -f policy/examples/valid.yaml

Request should be successfully deploy.

  TBD output expected

Uploading signed evidence

Using valint -o attest flag you can upload signed evidence on the image.

valint [bom, slsa] my_image -o attest [--oci OR --scribe.enable]

Adding custom policies

TBD