Support reading gh app key directly from env (#39)

* Support reading gh app key directly from env

Pass the app-key directly via GPC_GITHUB_APP_KEY env instead
of reading a file.
A file can still be used with the `app-key-file` flag.

* Fix error output for loading key file

Co-authored-by: Bernd Ahlers <bernd@users.noreply.github.com>

---------

Co-authored-by: Bernd Ahlers <bernd@users.noreply.github.com>
This commit is contained in:
Marco Pfatschbacher
2023-11-07 11:09:42 +00:00
committed by GitHub
parent 429d8122c6
commit 754e4fcd3f
2 changed files with 21 additions and 16 deletions

View File

@@ -6,6 +6,7 @@ import (
"github.com/Graylog2/graylog-project-cli/logger"
"github.com/spf13/cobra"
"github.com/spf13/viper"
"os"
)
var githubCmd = &cobra.Command{
@@ -39,11 +40,11 @@ var githubBranchProtectionCmd = &cobra.Command{
func init() {
githubAppAccessTokenGenerateCmd.Flags().StringP("app-id", "a", "", "the GitHub app ID (env: GPC_GITHUB_APP_ID)")
githubAppAccessTokenGenerateCmd.Flags().StringP("key", "k", "", "path to the private key to use for token generation (env: GPC_GITHUB_APP_KEY)")
githubAppAccessTokenGenerateCmd.Flags().StringP("key-file", "k", "", "path to the private key to use for token generation (or key from env: GPC_GITHUB_APP_KEY)")
githubAppAccessTokenGenerateCmd.Flags().StringP("org", "o", "", "GitHub org for the generated token (app needs to be installed in the org) (env: GPC_GITHUB_ORG)")
viper.BindPFlag("github.app-id", githubAppAccessTokenGenerateCmd.Flags().Lookup("app-id"))
viper.BindPFlag("github.app-key", githubAppAccessTokenGenerateCmd.Flags().Lookup("key"))
viper.BindPFlag("github.app-key-file", githubAppAccessTokenGenerateCmd.Flags().Lookup("key-file"))
viper.BindPFlag("github.org", githubAppAccessTokenGenerateCmd.Flags().Lookup("org"))
viper.MustBindEnv("github.app-id", "GPC_GITHUB_APP_ID")
@@ -57,9 +58,10 @@ func init() {
type gitHubCmdConfig struct {
GitHub struct {
AppID string `mapstructure:"app-id"`
AppKey string `mapstructure:"app-key"`
Org string `mapstructure:"org"`
AppID string `mapstructure:"app-id"`
AppKeyFile string `mapstructure:"app-key-file"`
AppKey string `mapstructure:"app-key"`
Org string `mapstructure:"org"`
} `mapstructure:"github"`
}
@@ -72,14 +74,23 @@ func githubAppAccessTokenGenerateCommand(cmd *cobra.Command, args []string) {
if cfg.GitHub.AppID == "" {
exitWithUsage(cmd, "Missing app ID flag")
}
if cfg.GitHub.AppKey == "" {
exitWithUsage(cmd, "Missing app key flag")
if cfg.GitHub.AppKey == "" && cfg.GitHub.AppKeyFile == "" {
exitWithUsage(cmd, "Missing app key GPC_GITHUB_APP_KEY or key file flag")
}
if cfg.GitHub.Org == "" {
exitWithUsage(cmd, "Missing GitHub org flag")
}
token, err := gh.GenerateAppToken(cfg.GitHub.Org, cfg.GitHub.AppID, cfg.GitHub.AppKey)
appKey := cfg.GitHub.AppKey
if cfg.GitHub.AppKeyFile != "" {
buf, err := os.ReadFile(cfg.GitHub.AppKeyFile)
appKey = string(buf)
if err != nil {
logger.Fatal("ERROR: couldn't read key file: %s", err)
}
}
token, err := gh.GenerateAppToken(cfg.GitHub.Org, cfg.GitHub.AppID, appKey)
if err != nil {
logger.Fatal("ERROR: %s", err)
}

View File

@@ -4,20 +4,14 @@ import (
"context"
"fmt"
"github.com/golang-jwt/jwt/v4"
"os"
"time"
)
// GenerateAppToken creates an access token for the given GitHub app in the given GitHub org. The app must be installed
// in the org. The returned access token is valid for one hour.
// (for details see: https://docs.github.com/en/rest/apps/apps#create-an-installation-access-token-for-an-app)
func GenerateAppToken(org string, appId string, keyFile string) (string, error) {
buf, err := os.ReadFile(keyFile)
if err != nil {
return "", fmt.Errorf("couldn't read key file: %w", err)
}
key, err := jwt.ParseRSAPrivateKeyFromPEM(buf)
func GenerateAppToken(org string, appId string, appKey string) (string, error) {
key, err := jwt.ParseRSAPrivateKeyFromPEM([]byte(appKey))
if err != nil {
return "", fmt.Errorf("couldn't parse key: %w", err)
}