githubsecret

README

githubsecret

A Go package for encrypting GitHub secrets. It uses hashing and encryption APIs from golang.org/x/crypto and does not require libsodium C bindings.

Usage

$ go get github.com/jefflinse/githubsecret

package main

import (
    "github.com/jefflinse/githubsecret"
)

func main() {
    // 1. obtain your repository's public key:
    // https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#get-a-repository-public-key

    // 2. encrypt your secret
    encrypted, err := githubsecret.Encrypt(repoPublicKey, content)

    // 3. store the encrypted secret
    // https://docs.github.com/en/free-pro-team@latest/rest/reference/actions#create-or-update-a-repository-secret
}

Example

The examples directory contains a CLI app called putsecret for storing GitHub secrets. It demonstrates the entire workflow of obtaining a repository's public key, using it to encrypt a secret, and storing the secret for use in GitHub Actions.

Clone, build, and run it with no arguments to view its usage:

$ git clone https://github.com/jefflinse/githubsecret

$ cd githubsecret/examples/putsecret

$ go build

$ ./putsecret

Define GITHUB_USERNAME and GITHUB_TOKEN in your environment with your GitHub username and personal access token, respectively. Your access token must have sufficient privileges to read the repository's public key and to update secrets.

Pass the owner, repository, secret name (key), and secret value as command line arguments.

$ ./putsecret owner repo secret_id "secret value"

Go to the Secrets page in your repository's settings and you should see your secret listed.

Issues

Please open an issue if you discover one.

Documentation

Index

• func Encrypt(recipientPublicKey string, content string) (string, error)

Functions

func Encrypt

func Encrypt(recipientPublicKey string, content string) (string, error)

Encrypt encrypts a secret using the provided recipient public key.