openbao-plugin-secrets-github

command module
v0.1.3-rc.54 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 15, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

README

openbao-plugin-secrets-github

An OpenBao secrets engine that mints short-lived, permission-scoped GitHub App installation tokens. The App's private key stays inside OpenBao and is never handed to a client.

This is a fork of martinbaillie/vault-plugin-secrets-github (Apache-2.0) ported to the OpenBao SDK. The engine's API is unchanged from upstream — see upstream's README for the full path reference. Track upstream via the upstream git remote.

Why

A GitHub App private key stored as a CI secret can be read by any code running in that workflow, used from anywhere, and stays valid until rotated. Brokering it means a workflow authenticates by OIDC and receives a token that expires in about an hour and carries only the permissions that workflow declared.

Install

OpenBao 2.5+ can download the plugin itself. In openbao.hcl:

plugin_directory = "/openbao/plugins"

plugin "secret" "github" {
  image       = "ghcr.io/rknightion/openbao-plugin-secrets-github"
  version     = "v0.1.1"
  binary_name = "openbao-plugin-secrets-github"
  sha256sum   = "<binary sha256 from the release checksums file>"
}

The sha256sum is the checksum of the binary, not the image digest. Take it from the release's checksums.txt, matching your platform.

plugin_directory must be writable by the OpenBao process. If you run OpenBao with a read-only root filesystem, mount a writable volume there.

Build

just setup
just check

See just --list for the full task surface, including formatting, linting, the vulnerability scan, and the Containerfile image build.

Licence

Apache-2.0. See LICENSE and NOTICE.

Documentation

Overview

Package main can be used to build the Vault GitHub secrets plugin.

Directories

Path Synopsis
Package github manages the configuration and execution of the Vault Secrets Plugin for GitHub.
Package github manages the configuration and execution of the Vault Secrets Plugin for GitHub.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL