@probot/get-private-key

v2.0.0

Get private key from a path, environment variables, or a `*.pem` file in the current working directory For more information about how to use this package see README

Latest version published 4 months ago

License: ISC

NPM

GitHub

Package Health Score

75 / 100

security
No known security issues
popularity
Recognized
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.0.0	\|	08/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.2	\|	11/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.0	\|	11/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

ISC

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (32,763)

GitHub Stars: 10
Forks: 14
Contributors: 8

Direct Usage Popularity

The npm package @probot/get-private-key receives a total of 32,763 downloads a week. As such, we scored @probot/get-private-key popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package @probot/get-private-key, we found that it has been starred 10 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 8
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 0
Open PR: 5
Last Release: 4 months ago
Last Commit: 3 months ago

Further analysis of the maintenance status of @probot/get-private-key based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @probot/get-private-key demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >= 18

Age: 4 years
Dependencies: 0 Direct
Versions: 8
Install Size: 16.7 kB
Dist-tags: 2
# of Files: 9
Maintainers: 7
TS Typings: Yes

@probot/get-private-key has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

@probot/get-private-key

> Get private key from a file path, environment variables, or a *.pem file in the current working directory

Finds a private key through various user-(un)specified methods. Order of precedence:

Explicit file path option
PRIVATE_KEY environment variable or explicit env.PRIVATE_KEY option. The private key can optionally be base64 encoded.
PRIVATE_KEY_PATH environment variable or explicit env.PRIVATE_KEY_PATH option
Any file w/ .pem extension in current working dir

Supports both PKCS1 (i.e -----BEGIN RSA PRIVATE KEY-----) and PKCS8 (i.e -----BEGIN PRIVATE KEY-----).

Usage

Browsers

Browsers	`@probot/get-private-key` is not compatible with browser usage
Node	Install with `npm install @probot/get-private-key` `import { Probot } from "probot"; import { getPrivateKey } from "@probot/get-private-key";` > [!IMPORTANT] > As we use conditional exports, you will need to adapt your `tsconfig.json` by setting `"moduleResolution": "node16", "module": "node16"`. > > See the TypeScript docs on package.json "exports". > See this helpful guide on transitioning to ESM from @sindresorhus

@probot/get-private-key is not compatible with browser usage

Node

Install with npm install @probot/get-private-key

import { Probot } from "probot";
import { getPrivateKey } from "@probot/get-private-key";

> [!IMPORTANT] > As we use conditional exports, you will need to adapt your tsconfig.json by setting "moduleResolution": "node16", "module": "node16". > > See the TypeScript docs on package.json "exports".
> See this helpful guide on transitioning to ESM from @sindresorhus

const probot = new Probot({
  appId: 123,
  privateKey: getPrivateKey(),
});

Options

name type description

name	type	description
`options.filepath`	`string`	Pass a path to a `*.pem` file. A relative path will be resolved to the current working directory (which you can set with the `cwd` option) `const privateKey = getPrivateKey({ filepath: "private-key.pem", });`
`options.cwd`	`string`	Defaults to `process.cwd()`. Used to resolve the `filepath` option and used as folder to find `*.pem` files. `const privateKey = getPrivateKey({ cwd: "/app/current", });`
`options.env`	`object`	Defaults to `process.env`. Pass `env.PRIVATE_KEY` or `env.PRIVATE_KEY_PATH` to workaround reading environment variables `const privateKey = getPrivateKey({ env: { PRIVATE_KEY: "-----BEGIN RSA PRIVATE KEY-----\n...", }, });`

options.filepath

string

Pass a path to a *.pem file. A relative path will be resolved to the current working directory (which you can set with the cwd option)

const privateKey = getPrivateKey({
  filepath: "private-key.pem",
});

options.cwd

string

Defaults to process.cwd(). Used to resolve the filepath option and used as folder to find *.pem files.

const privateKey = getPrivateKey({
  cwd: "/app/current",
});

options.env

object

Defaults to process.env. Pass env.PRIVATE_KEY or env.PRIVATE_KEY_PATH to workaround reading environment variables

const privateKey = getPrivateKey({
  env: {
    PRIVATE_KEY: "-----BEGIN RSA PRIVATE KEY-----\n...",
  },
});

LICENSE

ISC

@probot/get-private-key development dependencies

@octokit/tsconfig @vitest/coverage-v8 esbuild prettier semantic-release semantic-release-plugin-update-version-in-files typescript vitest

FAQs

What is @probot/get-private-key?

Get private key from a path, environment variables, or a `*.pem` file in the current working directory. Visit Snyk Advisor to see a full health score report for @probot/get-private-key, including popularity, security, maintenance & community analysis.

Is @probot/get-private-key popular?

The npm package @probot/get-private-key receives a total of 32,763 weekly downloads. As such, @probot/get-private-key popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @probot/get-private-key well maintained?

We found that @probot/get-private-key demonstrated a healthy version release cadence and project activity. It has a community of 8 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @probot/get-private-key safe to use?

The npm package @probot/get-private-key was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 19 November-2024, at 04:26 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (32,763)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

@probot/get-private-key

Usage

Options

LICENSE

@probot/get-private-key development dependencies

FAQs

What is @probot/get-private-key?

Is @probot/get-private-key popular?

Is @probot/get-private-key well maintained?

Is @probot/get-private-key safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues