Skip to main content

generateKeyPair

function generateKeyPair
Jump to headinggenerateKeyPair(
type: "rsa",
options: RSAKeyPairOptions<"pem", "pem">,
callback: (
err: Error | null,
publicKey: string,
privateKey: string,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Generates a new asymmetric key pair of the given type. RSA, RSA-PSS, DSA, EC, Ed25519, Ed448, X25519, X448, and DH are currently supported.

If a publicKeyEncoding or privateKeyEncoding was specified, this function behaves as if keyObject.export() had been called on its result. Otherwise, the respective part of the key is returned as a KeyObject.

It is recommended to encode public keys as 'spki' and private keys as 'pkcs8' with encryption for long-term storage:

const {
  generateKeyPair,
} = await import('node:crypto');

generateKeyPair('rsa', {
  modulusLength: 4096,
  publicKeyEncoding: {
    type: 'spki',
    format: 'pem',
  },
  privateKeyEncoding: {
    type: 'pkcs8',
    format: 'pem',
    cipher: 'aes-256-cbc',
    passphrase: 'top secret',
  },
}, (err, publicKey, privateKey) => {
  // Handle errors and use the generated key pair.
});

On completion, callback will be called with err set to undefined and publicKey / privateKey representing the generated key pair.

If this method is invoked as its util.promisify() ed version, it returns a Promise for an Object with publicKey and privateKey properties.

Parameters Jump to heading

Jump to headingtype: "rsa"

Must be 'rsa', 'rsa-pss', 'dsa', 'ec', 'ed25519', 'ed448', 'x25519', 'x448', or 'dh'.

Jump to headingoptions: RSAKeyPairOptions<"pem", "pem">
Jump to headingcallback: (
err: Error | null,
publicKey: string,
privateKey: string,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "rsa",
options: RSAKeyPairOptions<"pem", "der">,
callback: (
err: Error | null,
publicKey: string,
privateKey: Buffer,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "rsa"
Jump to headingoptions: RSAKeyPairOptions<"pem", "der">
Jump to headingcallback: (
err: Error | null,
publicKey: string,
privateKey: Buffer,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "rsa",
options: RSAKeyPairOptions<"der", "pem">,
callback: (
err: Error | null,
publicKey: Buffer,
privateKey: string,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "rsa"
Jump to headingoptions: RSAKeyPairOptions<"der", "pem">
Jump to headingcallback: (
err: Error | null,
publicKey: Buffer,
privateKey: string,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "rsa",
options: RSAKeyPairOptions<"der", "der">,
callback: (
err: Error | null,
publicKey: Buffer,
privateKey: Buffer,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "rsa"
Jump to headingoptions: RSAKeyPairOptions<"der", "der">
Jump to headingcallback: (
err: Error | null,
publicKey: Buffer,
privateKey: Buffer,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "rsa",
callback: (
err: Error | null,
publicKey: KeyObject,
privateKey: KeyObject,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "rsa"
Jump to headingcallback: (
err: Error | null,
publicKey: KeyObject,
privateKey: KeyObject,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "rsa-pss",
options: RSAPSSKeyPairOptions<"pem", "pem">,
callback: (
err: Error | null,
publicKey: string,
privateKey: string,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "rsa-pss"
Jump to headingcallback: (
err: Error | null,
publicKey: string,
privateKey: string,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "rsa-pss",
options: RSAPSSKeyPairOptions<"pem", "der">,
callback: (
err: Error | null,
publicKey: string,
privateKey: Buffer,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "rsa-pss"
Jump to headingcallback: (
err: Error | null,
publicKey: string,
privateKey: Buffer,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "rsa-pss",
options: RSAPSSKeyPairOptions<"der", "pem">,
callback: (
err: Error | null,
publicKey: Buffer,
privateKey: string,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "rsa-pss"
Jump to headingcallback: (
err: Error | null,
publicKey: Buffer,
privateKey: string,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "rsa-pss",
options: RSAPSSKeyPairOptions<"der", "der">,
callback: (
err: Error | null,
publicKey: Buffer,
privateKey: Buffer,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "rsa-pss"
Jump to headingcallback: (
err: Error | null,
publicKey: Buffer,
privateKey: Buffer,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "rsa-pss",
callback: (
err: Error | null,
publicKey: KeyObject,
privateKey: KeyObject,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "rsa-pss"
Jump to headingcallback: (
err: Error | null,
publicKey: KeyObject,
privateKey: KeyObject,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "dsa",
options: DSAKeyPairOptions<"pem", "pem">,
callback: (
err: Error | null,
publicKey: string,
privateKey: string,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "dsa"
Jump to headingoptions: DSAKeyPairOptions<"pem", "pem">
Jump to headingcallback: (
err: Error | null,
publicKey: string,
privateKey: string,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "dsa",
options: DSAKeyPairOptions<"pem", "der">,
callback: (
err: Error | null,
publicKey: string,
privateKey: Buffer,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "dsa"
Jump to headingoptions: DSAKeyPairOptions<"pem", "der">
Jump to headingcallback: (
err: Error | null,
publicKey: string,
privateKey: Buffer,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "dsa",
options: DSAKeyPairOptions<"der", "pem">,
callback: (
err: Error | null,
publicKey: Buffer,
privateKey: string,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "dsa"
Jump to headingoptions: DSAKeyPairOptions<"der", "pem">
Jump to headingcallback: (
err: Error | null,
publicKey: Buffer,
privateKey: string,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "dsa",
options: DSAKeyPairOptions<"der", "der">,
callback: (
err: Error | null,
publicKey: Buffer,
privateKey: Buffer,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "dsa"
Jump to headingoptions: DSAKeyPairOptions<"der", "der">
Jump to headingcallback: (
err: Error | null,
publicKey: Buffer,
privateKey: Buffer,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "dsa",
callback: (
err: Error | null,
publicKey: KeyObject,
privateKey: KeyObject,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "dsa"
Jump to headingcallback: (
err: Error | null,
publicKey: KeyObject,
privateKey: KeyObject,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "ec",
options: ECKeyPairOptions<"pem", "pem">,
callback: (
err: Error | null,
publicKey: string,
privateKey: string,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingoptions: ECKeyPairOptions<"pem", "pem">
Jump to headingcallback: (
err: Error | null,
publicKey: string,
privateKey: string,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "ec",
options: ECKeyPairOptions<"pem", "der">,
callback: (
err: Error | null,
publicKey: string,
privateKey: Buffer,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingoptions: ECKeyPairOptions<"pem", "der">
Jump to headingcallback: (
err: Error | null,
publicKey: string,
privateKey: Buffer,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "ec",
options: ECKeyPairOptions<"der", "pem">,
callback: (
err: Error | null,
publicKey: Buffer,
privateKey: string,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingoptions: ECKeyPairOptions<"der", "pem">
Jump to headingcallback: (
err: Error | null,
publicKey: Buffer,
privateKey: string,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "ec",
options: ECKeyPairOptions<"der", "der">,
callback: (
err: Error | null,
publicKey: Buffer,
privateKey: Buffer,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingoptions: ECKeyPairOptions<"der", "der">
Jump to headingcallback: (
err: Error | null,
publicKey: Buffer,
privateKey: Buffer,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "ec",
callback: (
err: Error | null,
publicKey: KeyObject,
privateKey: KeyObject,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingcallback: (
err: Error | null,
publicKey: KeyObject,
privateKey: KeyObject,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "ed25519",
options: ED25519KeyPairOptions<"pem", "pem">,
callback: (
err: Error | null,
publicKey: string,
privateKey: string,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "ed25519"
Jump to headingcallback: (
err: Error | null,
publicKey: string,
privateKey: string,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "ed25519",
options: ED25519KeyPairOptions<"pem", "der">,
callback: (
err: Error | null,
publicKey: string,
privateKey: Buffer,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "ed25519"
Jump to headingcallback: (
err: Error | null,
publicKey: string,
privateKey: Buffer,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "ed25519",
options: ED25519KeyPairOptions<"der", "pem">,
callback: (
err: Error | null,
publicKey: Buffer,
privateKey: string,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "ed25519"
Jump to headingcallback: (
err: Error | null,
publicKey: Buffer,
privateKey: string,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "ed25519",
options: ED25519KeyPairOptions<"der", "der">,
callback: (
err: Error | null,
publicKey: Buffer,
privateKey: Buffer,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "ed25519"
Jump to headingcallback: (
err: Error | null,
publicKey: Buffer,
privateKey: Buffer,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "ed25519",
options: ED25519KeyPairKeyObjectOptions | undefined,
callback: (
err: Error | null,
publicKey: KeyObject,
privateKey: KeyObject,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "ed25519"
Jump to headingcallback: (
err: Error | null,
publicKey: KeyObject,
privateKey: KeyObject,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "ed448",
options: ED448KeyPairOptions<"pem", "pem">,
callback: (
err: Error | null,
publicKey: string,
privateKey: string,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "ed448"
Jump to headingcallback: (
err: Error | null,
publicKey: string,
privateKey: string,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "ed448",
options: ED448KeyPairOptions<"pem", "der">,
callback: (
err: Error | null,
publicKey: string,
privateKey: Buffer,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "ed448"
Jump to headingcallback: (
err: Error | null,
publicKey: string,
privateKey: Buffer,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "ed448",
options: ED448KeyPairOptions<"der", "pem">,
callback: (
err: Error | null,
publicKey: Buffer,
privateKey: string,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "ed448"
Jump to headingcallback: (
err: Error | null,
publicKey: Buffer,
privateKey: string,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "ed448",
options: ED448KeyPairOptions<"der", "der">,
callback: (
err: Error | null,
publicKey: Buffer,
privateKey: Buffer,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "ed448"
Jump to headingcallback: (
err: Error | null,
publicKey: Buffer,
privateKey: Buffer,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "ed448",
options: ED448KeyPairKeyObjectOptions | undefined,
callback: (
err: Error | null,
publicKey: KeyObject,
privateKey: KeyObject,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "ed448"
Jump to headingcallback: (
err: Error | null,
publicKey: KeyObject,
privateKey: KeyObject,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "x25519",
options: X25519KeyPairOptions<"pem", "pem">,
callback: (
err: Error | null,
publicKey: string,
privateKey: string,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "x25519"
Jump to headingcallback: (
err: Error | null,
publicKey: string,
privateKey: string,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "x25519",
options: X25519KeyPairOptions<"pem", "der">,
callback: (
err: Error | null,
publicKey: string,
privateKey: Buffer,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "x25519"
Jump to headingcallback: (
err: Error | null,
publicKey: string,
privateKey: Buffer,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "x25519",
options: X25519KeyPairOptions<"der", "pem">,
callback: (
err: Error | null,
publicKey: Buffer,
privateKey: string,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "x25519"
Jump to headingcallback: (
err: Error | null,
publicKey: Buffer,
privateKey: string,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "x25519",
options: X25519KeyPairOptions<"der", "der">,
callback: (
err: Error | null,
publicKey: Buffer,
privateKey: Buffer,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "x25519"
Jump to headingcallback: (
err: Error | null,
publicKey: Buffer,
privateKey: Buffer,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "x25519",
options: X25519KeyPairKeyObjectOptions | undefined,
callback: (
err: Error | null,
publicKey: KeyObject,
privateKey: KeyObject,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "x25519"
Jump to headingcallback: (
err: Error | null,
publicKey: KeyObject,
privateKey: KeyObject,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "x448",
options: X448KeyPairOptions<"pem", "pem">,
callback: (
err: Error | null,
publicKey: string,
privateKey: string,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "x448"
Jump to headingoptions: X448KeyPairOptions<"pem", "pem">
Jump to headingcallback: (
err: Error | null,
publicKey: string,
privateKey: string,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "x448",
options: X448KeyPairOptions<"pem", "der">,
callback: (
err: Error | null,
publicKey: string,
privateKey: Buffer,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "x448"
Jump to headingoptions: X448KeyPairOptions<"pem", "der">
Jump to headingcallback: (
err: Error | null,
publicKey: string,
privateKey: Buffer,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "x448",
options: X448KeyPairOptions<"der", "pem">,
callback: (
err: Error | null,
publicKey: Buffer,
privateKey: string,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "x448"
Jump to headingoptions: X448KeyPairOptions<"der", "pem">
Jump to headingcallback: (
err: Error | null,
publicKey: Buffer,
privateKey: string,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "x448",
options: X448KeyPairOptions<"der", "der">,
callback: (
err: Error | null,
publicKey: Buffer,
privateKey: Buffer,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "x448"
Jump to headingoptions: X448KeyPairOptions<"der", "der">
Jump to headingcallback: (
err: Error | null,
publicKey: Buffer,
privateKey: Buffer,
) => void

Return Type Jump to heading

void
Jump to headinggenerateKeyPair(
type: "x448",
options: X448KeyPairKeyObjectOptions | undefined,
callback: (
err: Error | null,
publicKey: KeyObject,
privateKey: KeyObject,
) => void,
): void

Deno compatibility

The x448 option is not supported.

Parameters Jump to heading

Jump to headingtype: "x448"
Jump to headingcallback: (
err: Error | null,
publicKey: KeyObject,
privateKey: KeyObject,
) => void

Return Type Jump to heading

void
Back to top