cosign-installer GitHub Action
This action enables you to sign and verify container images using cosign.
cosign-installer verifies the integrity of the cosign release during installation.
For a quick start guide on the usage of cosign, please refer to https://github.com/sigstore/cosign#quick-start.
For available cosign releases, see https://github.com/sigstore/cosign/releases.
Usage
This action currently supports GitHub-provided Linux, macOS and Windows runners (self-hosted runners may not work).
Add the following entry to your Github workflow YAML file:
uses: sigstore/cosign-installer@main
with:
cosign-release: 'v2.0.1' # optionalExample using a pinned version:
jobs:
test_cosign_action:
runs-on: ubuntu-latest
permissions: {}
name: Install Cosign and test presence in path
steps:
- name: Install Cosign
uses: sigstore/cosign-installer@main
with:
cosign-release: 'v2.0.1'
- name: Check install!
run: cosign versionExample using the default version:
jobs:
test_cosign_action:
runs-on: ubuntu-latest
permissions: {}
name: Install Cosign and test presence in path
steps:
- name: Install Cosign
uses: sigstore/cosign-installer@main
- name: Check install!
run: cosign versionIf you want to install cosign from its main version by using 'go install' under the hood, you can set 'cosign-release' as 'main'. Once you did that, cosign will be installed via 'go install' which means that please ensure that go is installed.
Example of installing cosign via go install:
jobs:
test_cosign_action:
runs-on: ubuntu-latest
permissions: {}
name: Install Cosign via go install
steps:
- name: Install go
uses: actions/setup-go@v4
with:
go-version: '1.20'
check-latest: true
- name: Install Cosign
uses: sigstore/cosign-installer@main
with:
cosign-release: main
- name: Check install!
run: cosign versionThis action does not need any GitHub permission to run, however, if your workflow needs to update, create or perform any action against your repository, then you should change the scope of the permission appropriately.
For example, if you are using the gcr.io as your registry to push the images you will need to give the write permission
to the packages scope.
Example of a simple workflow:
jobs:
test_cosign_action:
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
id-token: write # needed for signing the images with GitHub OIDC Token **not production ready**
name: Install Cosign and test presence in path
steps:
- uses: actions/checkout@master
with:
fetch-depth: 1
- name: Install Cosign
uses: sigstore/cosign-installer@main
- name: Set up QEMU
uses: docker/setup-qemu-action@v1
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
- id: docker_meta
uses: docker/[email protected]
with:
images: ghcr.io/sigstore/sample-honk
tags: type=sha,format=long
- name: Build and Push container images
uses: docker/build-push-action@v2
with:
platforms: linux/amd64,linux/arm/v7,linux/arm64
push: true
tags: ${{ steps.docker_meta.outputs.tags }}
labels: ${{ steps.docker_meta.outputs.labels }}
- name: Sign image with a key
run: |
cosign sign --key env://COSIGN_PRIVATE_KEY ${TAGS}
env:
TAGS: ${{ steps.docker_meta.outputs.tags }}
COSIGN_PRIVATE_KEY: ${{secrets.COSIGN_PRIVATE_KEY}}
COSIGN_PASSWORD: ${{secrets.COSIGN_PASSWORD}}
- name: Sign the images with GitHub OIDC Token **not production ready**
run: cosign sign --yes ${TAGS}
env:
TAGS: ${{ steps.docker_meta.outputs.tags }}Optional Inputs
The following optional inputs:
| Input | Description |
|---|---|
cosign-release |
cosign version to use instead of the default. |
install-dir |
directory to place the cosign binary into instead of the default ($HOME/.cosign). |
use-sudo |
set to true if install-dir location requires sudo privs. Defaults to false. |
Security
Should you discover any security issues, please refer to sigstore's security process