Skip to content

node crypto sign should accept a private key in jwk format #69820

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
typescript-bot merged 6 commits into from
Jul 16, 2024
Merged

node crypto sign should accept a private key in jwk format #69820

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
935a083
add SignJsonWebKeyInput type option to sign
omkelderman Jun 16, 2024
383161a
add tests for crypto.sign on a jwk key
omkelderman Jun 16, 2024
9edbd37
add tests on crypto.verify on a jwk key
omkelderman Jun 16, 2024
315c9ef
format
omkelderman Jun 16, 2024
6ff3f91
Merge branch 'master' into crypto-sign-jwk
omkelderman Jul 16, 2024
cf83bdd
same changes in the v16 and v18 folders
omkelderman Jul 16, 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
9 changes: 5 additions & 4 deletions types/node/crypto.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1364,6 +1364,7 @@ declare module "crypto" {
interface SignKeyObjectInput extends SigningOptions {
key: KeyObject;
}
interface SignJsonWebKeyInput extends JsonWebKeyInput, SigningOptions {}
interface VerifyPublicKeyInput extends PublicKeyInput, SigningOptions {}
interface VerifyKeyObjectInput extends SigningOptions {
key: KeyObject;
Expand Down Expand Up @@ -1459,9 +1460,9 @@ declare module "crypto" {
* called. Multiple calls to `sign.sign()` will result in an error being thrown.
* @since v0.1.92
*/
sign(privateKey: KeyLike | SignKeyObjectInput | SignPrivateKeyInput): Buffer;
sign(privateKey: KeyLike | SignKeyObjectInput | SignPrivateKeyInput | SignJsonWebKeyInput): Buffer;
sign(
privateKey: KeyLike | SignKeyObjectInput | SignPrivateKeyInput,
privateKey: KeyLike | SignKeyObjectInput | SignPrivateKeyInput | SignJsonWebKeyInput,
outputFormat: BinaryToTextEncoding,
): string;
}
Expand Down Expand Up @@ -3336,12 +3337,12 @@ declare module "crypto" {
function sign(
algorithm: string | null | undefined,
data: NodeJS.ArrayBufferView,
key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput,
key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput | SignJsonWebKeyInput,
): Buffer;
function sign(
algorithm: string | null | undefined,
data: NodeJS.ArrayBufferView,
key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput,
key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput | SignJsonWebKeyInput,
callback: (error: Error | null, data: Buffer) => void,
): void;
/**
Expand Down
63 changes: 63 additions & 0 deletions types/node/test/crypto.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1110,6 +1110,28 @@ import { promisify } from "node:util";
key,
dsaEncoding: "der",
});

const jwk = key.export({ format: "jwk" });
crypto.sign("sha256", Buffer.from("asd"), {
format: "jwk",
key: jwk,
dsaEncoding: "der",
});
crypto.sign("sha256", Buffer.from("asd"), {
format: "jwk",
key: jwk,
dsaEncoding: "der",
}, callback);
promisify(crypto.sign)("sha256", Buffer.from("asd"), {
format: "jwk",
key: jwk,
dsaEncoding: "der",
}).then((signature: Buffer) => {});
crypto.createSign("sha256").update(Buffer.from("asd")).sign({
format: "jwk",
key: jwk,
dsaEncoding: "der",
});
}

{
Expand Down Expand Up @@ -1169,6 +1191,47 @@ import { promisify } from "node:util";
},
Buffer.from("sig"),
);

const jwk = key.export({ format: "jwk" });
crypto.verify(
"sha256",
Buffer.from("asd"),
{
format: "jwk",
key: jwk,
dsaEncoding: "der",
},
Buffer.from("sig"),
);
crypto.verify(
"sha256",
Buffer.from("asd"),
{
format: "jwk",
key: jwk,
dsaEncoding: "der",
},
Buffer.from("sig"),
callback,
);
promisify(crypto.verify)(
"sha256",
Buffer.from("asd"),
{
format: "jwk",
key: jwk,
dsaEncoding: "der",
},
Buffer.from("sig"),
).then((result: boolean) => {});
crypto.createVerify("sha256").update(Buffer.from("asd")).verify(
{
format: "jwk",
key: jwk,
dsaEncoding: "der",
},
Buffer.from("sig"),
);
}

{
Expand Down
9 changes: 5 additions & 4 deletions types/node/v16/crypto.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1318,6 +1318,7 @@ declare module "crypto" {
interface SignKeyObjectInput extends SigningOptions {
key: KeyObject;
}
interface SignJsonWebKeyInput extends JsonWebKeyInput, SigningOptions {}
interface VerifyPublicKeyInput extends PublicKeyInput, SigningOptions {}
interface VerifyKeyObjectInput extends SigningOptions {
key: KeyObject;
Expand Down Expand Up @@ -1413,9 +1414,9 @@ declare module "crypto" {
* called. Multiple calls to `sign.sign()` will result in an error being thrown.
* @since v0.1.92
*/
sign(privateKey: KeyLike | SignKeyObjectInput | SignPrivateKeyInput): Buffer;
sign(privateKey: KeyLike | SignKeyObjectInput | SignPrivateKeyInput | SignJsonWebKeyInput): Buffer;
sign(
privateKey: KeyLike | SignKeyObjectInput | SignPrivateKeyInput,
privateKey: KeyLike | SignKeyObjectInput | SignPrivateKeyInput | SignJsonWebKeyInput,
outputFormat: BinaryToTextEncoding,
): string;
}
Expand Down Expand Up @@ -3297,12 +3298,12 @@ declare module "crypto" {
function sign(
algorithm: string | null | undefined,
data: NodeJS.ArrayBufferView,
key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput,
key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput | SignJsonWebKeyInput,
): Buffer;
function sign(
algorithm: string | null | undefined,
data: NodeJS.ArrayBufferView,
key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput,
key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput | SignJsonWebKeyInput,
callback: (error: Error | null, data: Buffer) => void,
): void;
/**
Expand Down
63 changes: 63 additions & 0 deletions types/node/v16/test/crypto.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1119,6 +1119,28 @@ import { promisify } from "node:util";
key,
dsaEncoding: "der",
});

const jwk = key.export({ format: "jwk" });
crypto.sign("sha256", Buffer.from("asd"), {
format: "jwk",
key: jwk,
dsaEncoding: "der",
});
crypto.sign("sha256", Buffer.from("asd"), {
format: "jwk",
key: jwk,
dsaEncoding: "der",
}, callback);
promisify(crypto.sign)("sha256", Buffer.from("asd"), {
format: "jwk",
key: jwk,
dsaEncoding: "der",
}).then((signature: Buffer) => {});
crypto.createSign("sha256").update(Buffer.from("asd")).sign({
format: "jwk",
key: jwk,
dsaEncoding: "der",
});
}

{
Expand Down Expand Up @@ -1178,6 +1200,47 @@ import { promisify } from "node:util";
},
Buffer.from("sig"),
);

const jwk = key.export({ format: "jwk" });
crypto.verify(
"sha256",
Buffer.from("asd"),
{
format: "jwk",
key: jwk,
dsaEncoding: "der",
},
Buffer.from("sig"),
);
crypto.verify(
"sha256",
Buffer.from("asd"),
{
format: "jwk",
key: jwk,
dsaEncoding: "der",
},
Buffer.from("sig"),
callback,
);
promisify(crypto.verify)(
"sha256",
Buffer.from("asd"),
{
format: "jwk",
key: jwk,
dsaEncoding: "der",
},
Buffer.from("sig"),
).then((result: boolean) => {});
crypto.createVerify("sha256").update(Buffer.from("asd")).verify(
{
format: "jwk",
key: jwk,
dsaEncoding: "der",
},
Buffer.from("sig"),
);
}

{
Expand Down
9 changes: 5 additions & 4 deletions types/node/v18/crypto.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1349,6 +1349,7 @@ declare module "crypto" {
interface SignKeyObjectInput extends SigningOptions {
key: KeyObject;
}
interface SignJsonWebKeyInput extends JsonWebKeyInput, SigningOptions {}
interface VerifyPublicKeyInput extends PublicKeyInput, SigningOptions {}
interface VerifyKeyObjectInput extends SigningOptions {
key: KeyObject;
Expand Down Expand Up @@ -1444,9 +1445,9 @@ declare module "crypto" {
* called. Multiple calls to `sign.sign()` will result in an error being thrown.
* @since v0.1.92
*/
sign(privateKey: KeyLike | SignKeyObjectInput | SignPrivateKeyInput): Buffer;
sign(privateKey: KeyLike | SignKeyObjectInput | SignPrivateKeyInput | SignJsonWebKeyInput): Buffer;
sign(
privateKey: KeyLike | SignKeyObjectInput | SignPrivateKeyInput,
privateKey: KeyLike | SignKeyObjectInput | SignPrivateKeyInput | SignJsonWebKeyInput,
outputFormat: BinaryToTextEncoding,
): string;
}
Expand Down Expand Up @@ -3336,12 +3337,12 @@ declare module "crypto" {
function sign(
algorithm: string | null | undefined,
data: NodeJS.ArrayBufferView,
key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput,
key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput | SignJsonWebKeyInput,
): Buffer;
function sign(
algorithm: string | null | undefined,
data: NodeJS.ArrayBufferView,
key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput,
key: KeyLike | SignKeyObjectInput | SignPrivateKeyInput | SignJsonWebKeyInput,
callback: (error: Error | null, data: Buffer) => void,
): void;
/**
Expand Down
63 changes: 63 additions & 0 deletions types/node/v18/test/crypto.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1117,6 +1117,28 @@ import { promisify } from "node:util";
key,
dsaEncoding: "der",
});

const jwk = key.export({ format: "jwk" });
crypto.sign("sha256", Buffer.from("asd"), {
format: "jwk",
key: jwk,
dsaEncoding: "der",
});
crypto.sign("sha256", Buffer.from("asd"), {
format: "jwk",
key: jwk,
dsaEncoding: "der",
}, callback);
promisify(crypto.sign)("sha256", Buffer.from("asd"), {
format: "jwk",
key: jwk,
dsaEncoding: "der",
}).then((signature: Buffer) => {});
crypto.createSign("sha256").update(Buffer.from("asd")).sign({
format: "jwk",
key: jwk,
dsaEncoding: "der",
});
}

{
Expand Down Expand Up @@ -1176,6 +1198,47 @@ import { promisify } from "node:util";
},
Buffer.from("sig"),
);

const jwk = key.export({ format: "jwk" });
crypto.verify(
"sha256",
Buffer.from("asd"),
{
format: "jwk",
key: jwk,
dsaEncoding: "der",
},
Buffer.from("sig"),
);
crypto.verify(
"sha256",
Buffer.from("asd"),
{
format: "jwk",
key: jwk,
dsaEncoding: "der",
},
Buffer.from("sig"),
callback,
);
promisify(crypto.verify)(
"sha256",
Buffer.from("asd"),
{
format: "jwk",
key: jwk,
dsaEncoding: "der",
},
Buffer.from("sig"),
).then((result: boolean) => {});
crypto.createVerify("sha256").update(Buffer.from("asd")).verify(
{
format: "jwk",
key: jwk,
dsaEncoding: "der",
},
Buffer.from("sig"),
);
}

{
Expand Down