https://github.com/gitbookio/github-api-signature
Node.js signature generator for GitHub API using a PGP key
https://github.com/gitbookio/github-api-signature
github gpg node
Last synced: 6 months ago
JSON representation
Node.js signature generator for GitHub API using a PGP key
- Host: GitHub
- URL: https://github.com/gitbookio/github-api-signature
- Owner: GitbookIO
- Created: 2018-01-26T15:59:42.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-03T08:32:59.000Z (over 2 years ago)
- Last Synced: 2025-07-06T01:09:33.384Z (6 months ago)
- Topics: github, gpg, node
- Language: TypeScript
- Size: 271 KB
- Stars: 13
- Watchers: 3
- Forks: 11
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# github-api-signature
[](https://badge.fury.io/js/github-api-signature)
[](https://circleci.com/gh/GitbookIO/github-api-signature)
Node.js signature generator for GitHub API using a PGP key.
## Install
```sh
$ npm i github-api-signature
```
or
```sh
$ yarn add github-api-signature
```
## API
### `generateKeyPair`
This method returns a `Promise` containing two properties `publicKey` and `privateKey` which are both `string`s.
It generates a public and private PGP keys pair that can be used to sign commits with GitHub API using a GitHub user's informations and a passphrase.
The public key should be added to the user's settings. The private key is then used with the `createSignature` method to sign the commit with the `committer` informations extracted from the payload sent to the API.
###### Usage
```js
import { generateKeyPair } from 'github-api-signature';
const passphrase: string = 'my secret phrase';
const user: UserInformations = {
name: 'Dohn Joe',
email: 'github@ghost.com'
};
// Optional number of bits for the generated RSA keys pair.
// Defaults to the maximum value 4096.
const rsaBits = 4096;
const type: 'ecc' | 'rsa' = 'ecc';
generateKeyPair(user, passphrase, rsaBits, type)
.then((keyPair: KeyPair) => {
// keyPair = {
// publicKey: '-----BEGIN PGP PUBLIC KEY BLOCK-----...',
// privateKey: '-----BEGIN PGP PRIVATE KEY BLOCK-----...'
// };
// Add publicKey to Dohn Joe's GitHub account settings.
// Use privateKey to create commits signatures for Dohn Joe's as committer.
});
```
###### Type definitions
```js
async function generateKeyPair(
user: UserInformations,
passphrase: string,
type: 'ecc' | 'rsa' = 'ecc',
rsaBits: number = 4096
): Promise
type UserInformations = {
name: string,
email: string
};
type KeyPair = {
publicKey: string,
privateKey: string
};
```
### `createSignature`
This method returns a `Promise` containing a `string` which is the PGP signature that should be used on the GitHub API to sign your commit with the committer informations.
Use this method with the same payload that you would send to the GitHub API `POST /repos/:owner/:repo/git/commits` endpoint.
It accepts either an already git-computed commit payload (see [GitHub's example](https://developer.github.com/v3/git/commits/#example-input)) which is the git content for a commit object, or a `CommitPayload` object.
When using a `CommitPayload` object, the `author` argument is **mandatory**, as opposed to the optional argument for the API. This is necessary since we need to generate the commit message string with the same `date` argument as GitHub will do to verify the signature.
The `committer` argument is still optional and will default to the `author` value if omitted.
In the following example, the commit will be signed for `Dohn Joe`. Hence, `privateKey` should be generated using `Dohn Joe`'s informations.
###### Usage
```js
import { createSignature, commitToString } from 'github-api-signature';
const privateKey: string = `-----BEGIN PGP PRIVATE KEY BLOCK-----
// Private key content //
-----END PGP PRIVATE KEY BLOCK-----`;
const passphrase: string = 'my secret phrase';
const commit: CommitPayload = {
message: 'Commit message',
tree: 'tree-sha',
parents: ['parent-sha'],
author: {
name: 'John Doe',
email: 'ghost@github.com',
date: '2018-01-01T00:00:00.000Z'
},
// Optional committer informations
// Defaults to
committer: {
name: 'Dohn Joe',
email: 'github@ghost.com',
date: '2018-01-01T00:00:00.000Z'
}
};
// Using a CommitPayload object
createSignature(commit, privateKey, passphrase)
.then((signature: string) => {
// signature = `-----BEGIN PGP SIGNATURE-----
//
// // Signature content
// -----END PGP SIGNATURE-----`;
const apiPayload = {
...commit,
signature
};
// Use signature with GitHub API
// https://developer.github.com/v3/git/commits/#create-a-commit
// POST /repos/:owner/:repo/git/commits
});
// Using a git-computed commit payload string
// commitToString returns the same format as "git cat-file -p "
const commitStr = commitToString(commit);
createSignature(commitStr, privateKey, passphrase)
.then((signature: string) => {
// ...
});
```
###### Type definitions
```js
async function createSignature(
commit: CommitPayload | string,
privateKey: string,
passphrase: string
): Promise {}
type UserInformations = {
name: string,
email: string
};
type GitHubUser = UserInformations & {
date: string
};
type CommitPayload = {
message: string,
tree: string,
parents: string[],
author: GitHubUser,
committer?: GitHubUser
};
```