github-app-repl/lib/private-key.js

A REPL (read–eval–print loop) for GitHub Apps

const fs = require('fs');

/**
 * Finds a private key through various user-(un)specified methods.
 * Order of precedence:
 * 1. Explicit path (CLI option)
 * 2. `PRIVATE_KEY` env var
 * 3. `PRIVATE_KEY_PATH` env var
 * 4. Any file w/ `.pem` extension in current working dir
 * @param {string} [filepath] - Explicit, user-defined path to keyfile
 * @returns {string} Private key
 * @private
 */
function findPrivateKey(filepath) {
  if (filepath) {
    return fs.readFileSync(filepath);
  }
  if (process.env.PRIVATE_KEY) {
    return process.env.PRIVATE_KEY.replace(/\\n/g, '\n');
  }
  if (process.env.PRIVATE_KEY_PATH) {
    return fs.readFileSync(process.env.PRIVATE_KEY_PATH);
  }
  const foundPath = fs.readdirSync(process.cwd()).find(path => path.endsWith('.pem'));
  if (foundPath) {
    return findPrivateKey(foundPath);
  }
  throw new Error(`Missing private key for GitHub App. Please use:
  * \`--private-key=/path/to/private-key\` flag, or
  * \`PRIVATE_KEY\` environment variable, or
  * \`PRIVATE_KEY_PATH\` environment variable
`);
}

module.exports = {
  findPrivateKey
};