Skip to content

Fix recoveryCode, privateKey, privateKeyPath options usage in PolykeyAgentOptions #601

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
tegefaulkes merged 4 commits into from
Oct 24, 2023
Merged

Fix recoveryCode, privateKey, privateKeyPath options usage in PolykeyAgentOptions #601

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
527040b
fix: change PrivateKey type to a more generic type
addievo Oct 24, 2023
9f1772a
fix: add recoveryCode, privateKey and privateKeyPath to PkAgent start…
addievo Oct 24, 2023
0fce357
lintfix
addievo Oct 24, 2023
231cbf6
fix: final fixup and review
tegefaulkes Oct 24, 2023
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
35 changes: 25 additions & 10 deletions src/PolykeyAgent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import type { DeepPartial, FileSystem } from './types';
import type { DeepPartial, FileSystem, ObjectEmpty } from './types';
import type { PolykeyWorkerManagerInterface } from './workers/types';
import type { TLSConfig } from './network/types';
import type { SeedNodes } from './nodes/types';
import type { Key, PasswordOpsLimit, PasswordMemLimit, PrivateKey } from "./keys/types";
import type { Key, PasswordOpsLimit, PasswordMemLimit } from './keys/types';
import path from 'path';
import process from 'process';
import Logger from '@matrixai/logger';
Expand Down Expand Up @@ -61,9 +61,12 @@ type PolykeyAgentOptions = {
certDuration: number;
certRenewLeadTime: number;
recoveryCode: string;
privateKeyPath: string;
privateKey: PrivateKey;
};
} & (
| ObjectEmpty
| { recoveryCode: string }
| { privateKey: Buffer }
| { privateKeyPath: string }
);
client: {
keepAliveTimeoutTime: number;
keepAliveIntervalTime: number;
Expand Down Expand Up @@ -164,7 +167,7 @@ class PolykeyAgent {
connectionHolePunchIntervalTime:
config.defaultsSystem.nodesConnectionHolePunchIntervalTime,
},
}) as PolykeyAgentOptions;
});
// This can only happen if the caller didn't specify the node path and the
// automatic detection failed
if (optionsDefaulted.nodePath == null) {
Expand Down Expand Up @@ -222,13 +225,16 @@ class PolykeyAgent {
});
keyRing = await KeyRing.createKeyRing({
keysPath,
passwordOpsLimit: optionsDefaulted.keys.passwordOpsLimit,
passwordMemLimit: optionsDefaulted.keys.passwordMemLimit,
strictMemoryLock: optionsDefaulted.keys.strictMemoryLock,
fs,
fresh,
password,
logger: logger.getChild(KeyRing.name),
passwordMemLimit: optionsDefaulted.keys.passwordMemLimit,
passwordOpsLimit: optionsDefaulted.keys.passwordOpsLimit,
privateKey: optionsDefaulted.keys.privateKey,
privateKeyPath: optionsDefaulted.keys.privateKeyPath,
recoveryCode: optionsDefaulted.keys.recoveryCode,
strictMemoryLock: optionsDefaulted.keys.strictMemoryLock,
});
db = await DB.createDB({
dbPath,
Expand Down Expand Up @@ -490,6 +496,7 @@ class PolykeyAgent {
public readonly fs: FileSystem;
public readonly logger: Logger;
public readonly clientService: ClientService;
public readonly privateKeyPath: string;
protected workerManager: PolykeyWorkerManagerInterface | undefined;

protected handleEventCertManagerCertChange = async (
Expand Down Expand Up @@ -606,13 +613,18 @@ class PolykeyAgent {
fresh = false,
}: {
password: string;
options?: Partial<{
options?: DeepPartial<{
clientServiceHost: string;
clientServicePort: number;
agentServiceHost: string;
agentServicePort: number;
ipv6Only: boolean;
workers: number;
keys:
| ObjectEmpty
| { recoveryCode: string }
| { privateKey: Buffer }
| { privateKeyPath: string };
}>;
workers?: number;
fresh?: boolean;
Expand All @@ -638,6 +650,9 @@ class PolykeyAgent {
await this.keyRing.start({
password,
fresh,
recoveryCode: optionsDefaulted.keys?.recoveryCode,
privateKey: optionsDefaulted.keys?.privateKey,
privateKeyPath: optionsDefaulted.keys?.privateKeyPath,
});
await this.db.start({
crypto: {
Expand Down