GitHub Actions

Features

• Retrieve secrets from the Keeper Vault within the Github Actions runner

• Set secret credentials as build arguments or environment variables in Github Actions scripts

• Copy secure files from the Keeper Vault

Video Demo

The below overview video covers basic setup and ends with a basic Github Actions integration.

Prerequisites

This page documents the Secrets Manager GitHub Actions integration. In order to utilize this integration, you will need:

• Keeper Secrets Manager access (See the for more details)

  • Secrets Manager addon enabled for your Keeper account

  • Membership in a Role with the Secrets Manager enforcement policy enabled

About

This action securely retrieves secrets from Keeper and places them to the desired destination of the GitHub Actions runner such as an environment variable, output parameters of the step or to the file.

Quick Start

Below example shows all available functionality of this plugin

You will need to provide two inputs to utilize the Github Actions plugin:

• A

  • Github Actions supports JSON type configuration

• queries for secrets

Inputs

keeper-secret-config

Secrets configuration. See for more information about creating a configuration.

JSON type configuration is supported.

Example:

We recommend storing the configuration in a Github Actions secret and accessing it as a variable, as shown in the example above.

secrets

Queries using Keeper Notation to access fields in Keeper records.

The secrets input is the list of secrets that you need to get from Keeper and put into either an environment variable, GitHub Action output or a file.

Example:

The first part is the id of the secret using the format.

The second part defines the destination of the secret in the GitHub runner.

Masking - Hiding Secrets from Logs

This action uses GitHub Action's built-in masking, so all variables will automatically be masked if printed to the console or to logs. This only obscures secrets from output logs. If someone has the ability to edit your workflows, then they are able to read and therefore write secrets to somewhere else just like normal GitHub Secrets.

Source Code

Find the Keeper Secrets Manager Github Actions plugin source code in the