policykit 0.4.0

A set of utilities and classes for working with Open Policy Agent based tools, including Gatekeeper and Conftest

Policy Kit

A set of utilities and classes for working with Open Policy Agent based tools, including Gatekeeper and Conftest.

Installation

Policy Kit can be installed from PyPI using pip or similar tools:

pip install policykit

CLI

The module provides a CLI tool called pk for using some of the functionality.

$ pk build *.rego
[SecurityControls] Generating a ConstraintTemplate from "SecurityControls.rego"
[SecurityControls] Searching "lib" for additional rego files
[SecurityControls] Adding library from "lib/kubernetes.rego"
[SecurityControls] Saving to "SecurityControls.yaml"

You can also use the tool via Docker:

docker run --rm -it -v $(pwd):/app  garethr/policykit build

Python

This module currently contains several classes, the first for working with ConstraintTemplates in Gatekeeper.

from policykit import ConstraintTemplate

with open(path_to_rego_source_file, "r") as rego:
    ct = ConstraintTemplate(name, rego.read())
print(ct.yaml())

The Conftest class makes interacting with Conftest from Python easy. Note that this requires the conftest executable to be available on the path.

>>> from policykit import Conftest
>>> cli = Conftest("policy")
>>> result = cli.test("deployment.yaml")
>>> result
ConftestRun(code=1, results=[ConftestResult(filename='/Users/garethr/Documents/conftest/examples/kubernetes/deployment.yaml', Warnings=[], Failures=['hello-kubernetes must include Kubernetes recommended labels: https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/#labels ', 'Containers must not run as root in Deployment hello-kubernetes', 'Deployment hello-kubernetes must provide app/release labels for pod selectors'], Successes=[])]
>>> result.success
False

Passing in a dictionary to json_input is parsed as JSON then sent as stdin to the confest executable.

from policykit import Conftest

result = Conftest("policy").test(json_input={"foo": "bar"})
print(result)

Action

Policy Kit can also be easily used in GitHub Actions, using the following Action. This example also demonstrates committing the generated files back into the Git repository. Update the the values in <> as required.

on: push
name: Gatekeeper
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - name: Generate ConstraintTemplates for Gatekeeper
      uses: garethr/policykit/action@master
      with:
        args: <directory-of-rego-source-files>
    - name: Commit to repository
      env:
        GITHUB_TOKEN: ${{ secrets.github_token }}
        COMMIT_MSG: |
          Generated new ConstraintTemplates from Rego source
          skip-checks: true
      run: |
        # Hard-code user config
        git config user.email "<your-email-address>"
        git config user.name "<your-username>"
        git config --get-regexp "user\.(name|email)"
        # Update origin with token
        git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
        # Checkout the branch so we can push back to it
        git checkout master
        git add .
        # Only commit and push if we have changes
        git diff --quiet && git diff --staged --quiet || (git commit -m "${COMMIT_MSG}"; git push origin master

Notes

A few caveats for anyone trying to use this module.

• Loading libraries with lib is only supported in Gatekeeper HEAD today but should be in the next release.
• This module does not support parameterized ConstraintTemplates