Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add support for PGP encrypted config files #683

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add support for PGP encrypted config files #683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,14 @@ After the token is generated, create an rc file with the following content:
Note: you could use `ncu-config` to configure these variables, but it's not
recommended to leave your tokens in your command line history.

If you have `gpg` installed and setup on your local machine, it is recommended
to store an encrypted version of this file:

```console
$ gpg --default-recipient-self --encrypt ~/.ncurc
$ rm ~/.ncurc
```

### Setting up Jenkins credentials

The `git-node` and `ncu-ci` commands need to query the Node.js Jenkins API for
Expand All @@ -99,8 +107,9 @@ To obtain the Jenkins API token
3. Enter an identifiable name (for example, `node-core-utils`) for this
token in the inbox that appears, and click `GENERATE`.
4. Copy the generated token.
5. Add it into your `ncurc` file (`~/.ncurc` or `$XDG_CONFIG_HOME/ncurc`)
with `jenkins_token` as key, like this:
5. Add it into your `ncurc` file (`~/.ncurc` or `$XDG_CONFIG_HOME/ncurc`, or
`~/.ncurc.gpg` or `$XDG_CONFIG_HOME/ncurc.gpg`) with `jenkins_token` as key,
like this:

```json
{
Expand All @@ -120,6 +129,7 @@ Put the following entries into your
```
# node-core-utils configuration file
.ncurc
.ncurc.gpg
# node-core-utils working directory
.ncu
```
Expand Down
10 changes: 10 additions & 0 deletions lib/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ import path from 'node:path';
import os from 'node:os';

import { readJson, writeJson } from './file.js';
import { existsSync } from 'node:fs';
import { spawnSync } from 'node:child_process';

export const GLOBAL_CONFIG = Symbol('globalConfig');
export const PROJECT_CONFIG = Symbol('projectConfig');
Expand All @@ -25,6 +27,14 @@ export function getMergedConfig(dir, home) {

export function getConfig(configType, dir) {
const configPath = getConfigPath(configType, dir);
const encryptedConfigPath = configPath + '.gpg';
if (existsSync(encryptedConfigPath)) {
const { status, stdout } =
spawnSync('gpg', ['--decrypt', encryptedConfigPath]);
if (status === 0) {
return JSON.parse(stdout.toString('utf-8'));
}
}
try {
return readJson(configPath);
} catch (cause) {
Expand Down