Skip to content

feat: allow to configure keymanager token file path #6525

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

Merged
nflaig merged 3 commits into from
Mar 25, 2024
Merged

feat: allow to configure keymanager token file path #6525

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5416018
feat: allow to configure keymanager token file path
nflaig Mar 8, 2024
f335aa1
Merge branch 'unstable' into nflaig/configurable-token-path
nflaig Mar 25, 2024
a273bd8
Update CLI flag name to set path to token file
nflaig Mar 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/cli/src/cmds/validator/handler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,9 +200,10 @@ export async function validatorHandler(args: IValidatorCliArgs & GlobalArgs): Pr
address: args["keymanager.address"],
port: args["keymanager.port"],
cors: args["keymanager.cors"],
isAuthEnabled: args["keymanager.authEnabled"],
isAuthEnabled: args["keymanager.auth"],
headerLimit: args["keymanager.headerLimit"],
bodyLimit: args["keymanager.bodyLimit"],
tokenFile: args["keymanager.tokenFile"],
tokenDir: dbPath,
},
{config, logger, api: keymanagerApi, metrics: metrics ? metrics.keymanagerApiRest : null}
Expand Down
6 changes: 5 additions & 1 deletion packages/cli/src/cmds/validator/keymanager/server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ import {writeFile600Perm} from "../../../util/index.js";
export type KeymanagerRestApiServerOpts = RestApiServerOpts & {
isAuthEnabled: boolean;
tokenDir?: string;
// Takes precedence over `tokenDir`
tokenFile?: string;
};

export const keymanagerRestApiServerOptsDefault: KeymanagerRestApiServerOpts = {
Expand Down Expand Up @@ -44,7 +46,9 @@ export class KeymanagerRestApiServer extends RestApiServer {
...Object.fromEntries(Object.entries(optsArg).filter(([_, v]) => v != null)),
};

const apiTokenPath = path.join(opts.tokenDir ?? ".", apiTokenFileName);
const apiTokenPath = opts.tokenFile
? path.resolve(opts.tokenFile)
: path.join(opts.tokenDir ?? ".", apiTokenFileName);
let bearerToken: string | undefined;

if (opts.isAuthEnabled) {
Expand Down
11 changes: 9 additions & 2 deletions packages/cli/src/cmds/validator/options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,8 @@ export type IValidatorCliArgs = AccountValidatorArgs &

export type KeymanagerArgs = {
keymanager?: boolean;
"keymanager.authEnabled"?: boolean;
"keymanager.auth"?: boolean;
"keymanager.tokenFile"?: string;
"keymanager.port"?: number;
"keymanager.address"?: string;
"keymanager.cors"?: string;
Expand All @@ -93,12 +94,18 @@ export const keymanagerOptions: CliCommandOptions<KeymanagerArgs> = {
default: false,
group: "keymanager",
},
"keymanager.authEnabled": {
"keymanager.auth": {

@nflaig nflaig Mar 8, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the flag to enable authentication to be more inline with other existing boolean flags

@jeluard jeluard Mar 23, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably worth documenting in next release, so that people can migrate to the preferred syntax?

@nflaig nflaig Mar 23, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no need to migrate, existing setups can keep previous value

alias: ["keymanager.authEnabled"],
type: "boolean",
description: "Enable token bearer authentication for key manager API server",
default: true,
group: "keymanager",
},
"keymanager.tokenFile": {
type: "string",
description: "Path to file containing bearer token used for key manager API authentication",
group: "keymanager",
},
"keymanager.port": {
type: "number",
description: "Set port for key manager API",
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/test/e2e/voluntaryExitFromApi.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ describe("voluntary exit from api", function () {
"--keymanager",
`--keymanager.port=${keymanagerPort}`,
// Disable bearer token auth to simplify testing
"--keymanager.authEnabled=false",
"--keymanager.auth=false",
],
{pipeStdioToParent: false, logPrefix: "dev", testContext: {beforeEach, afterEach, afterAll}}
);
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/test/utils/simulation/validator_clients/lodestar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export const generateLodestarValidatorNode: ValidatorNodeGenerator<ValidatorClie
dataDir: rootDir,
server: beaconUrls,
keymanager: true,
"keymanager.authEnabled": false,
"keymanager.auth": false,
"keymanager.address": "127.0.0.1",
"keymanager.port": ports.validator.keymanagerPort,
logPrefix: id,
Expand Down