Node crypto.generateKeyPairSync function | API Reference

Node crypto.generateKeyPairSync function | API Reference | BunBuild Docs Reference Guides Blog Discord/node:crypto/generateKeyPairSyncFgenerateKeyPairSync

Search the reference...

Build Docs Reference Guides Blog Discord/node:crypto/generateKeyPairSyncFgenerateKeyPairSync

function

crypto.generateKeyPairSyncfunction generateKeyPairSyncT extends DHKeyPairOptions>(type: 'dh',options: T): KeyPairExportResultT>;

Generates a new asymmetric key pair of the given type. See the supported asymmetric key types.

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.

When encoding public keys, it is recommended to use 'spki'. When encoding private keys, it is recommended to use 'pkcs8' with a strong passphrase, and to keep the passphrase confidential.

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

const {
publicKey,
privateKey,
} = generateKeyPairSync('rsa', {
modulusLength: 4096,
publicKeyEncoding: {
type: 'spki',
format: 'pem',
},
privateKeyEncoding: {
type: 'pkcs8',
format: 'pem',
cipher: 'aes-256-cbc',
passphrase: 'top secret',
},
});

The return value { publicKey, privateKey } represents the generated key pair. When PEM encoding was selected, the respective key will be a string, otherwise it will be a buffer containing the data encoded as DER.

@param type

The asymmetric key type to generate. See the supported asymmetric key types.

function generateKeyPairSyncT extends DSAKeyPairOptions>(type: 'dsa',options: T): KeyPairExportResultT>;

Generates a new asymmetric key pair of the given type. See the supported asymmetric key types.

When encoding public keys, it is recommended to use 'spki'. When encoding private keys, it is recommended to use 'pkcs8' with a strong passphrase, and to keep the passphrase confidential.

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

const {
publicKey,
privateKey,
} = generateKeyPairSync('rsa', {
modulusLength: 4096,
publicKeyEncoding: {
type: 'spki',
format: 'pem',
},
privateKeyEncoding: {
type: 'pkcs8',
format: 'pem',
cipher: 'aes-256-cbc',
passphrase: 'top secret',
},
});

@param type

The asymmetric key type to generate. See the supported asymmetric key types.

function generateKeyPairSyncT extends ECKeyPairOptions>(type: 'ec',options: T): KeyPairExportResultT>;

Generates a new asymmetric key pair of the given type. See the supported asymmetric key types.

When encoding public keys, it is recommended to use 'spki'. When encoding private keys, it is recommended to use 'pkcs8' with a strong passphrase, and to keep the passphrase confidential.

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

const {
publicKey,
privateKey,
} = generateKeyPairSync('rsa', {
modulusLength: 4096,
publicKeyEncoding: {
type: 'spki',
format: 'pem',
},
privateKeyEncoding: {
type: 'pkcs8',
format: 'pem',
cipher: 'aes-256-cbc',
passphrase: 'top secret',
},
});

@param type

The asymmetric key type to generate. See the supported asymmetric key types.

function generateKeyPairSyncT extends ED25519KeyPairOptions = {}>(type: 'ed25519',options?: T): KeyPairExportResultT>;

Generates a new asymmetric key pair of the given type. See the supported asymmetric key types.

When encoding public keys, it is recommended to use 'spki'. When encoding private keys, it is recommended to use 'pkcs8' with a strong passphrase, and to keep the passphrase confidential.

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

const {
publicKey,
privateKey,
} = generateKeyPairSync('rsa', {
modulusLength: 4096,
publicKeyEncoding: {
type: 'spki',
format: 'pem',
},
privateKeyEncoding: {
type: 'pkcs8',
format: 'pem',
cipher: 'aes-256-cbc',
passphrase: 'top secret',
},
});

@param type

The asymmetric key type to generate. See the supported asymmetric key types.

function generateKeyPairSyncT extends ED448KeyPairOptions = {}>(type: 'ed448',options?: T): KeyPairExportResultT>;

Generates a new asymmetric key pair of the given type. See the supported asymmetric key types.

When encoding public keys, it is recommended to use 'spki'. When encoding private keys, it is recommended to use 'pkcs8' with a strong passphrase, and to keep the passphrase confidential.

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

const {
publicKey,
privateKey,
} = generateKeyPairSync('rsa', {
modulusLength: 4096,
publicKeyEncoding: {
type: 'spki',
format: 'pem',
},
privateKeyEncoding: {
type: 'pkcs8',
format: 'pem',
cipher: 'aes-256-cbc',
passphrase: 'top secret',
},
});

@param type

The asymmetric key type to generate. See the supported asymmetric key types.

function generateKeyPairSyncT extends MLDSAKeyPairOptions = {}>(type: 'ml-dsa-44' | 'ml-dsa-65' | 'ml-dsa-87',options?: T): KeyPairExportResultT>;

Generates a new asymmetric key pair of the given type. See the supported asymmetric key types.

When encoding public keys, it is recommended to use 'spki'. When encoding private keys, it is recommended to use 'pkcs8' with a strong passphrase, and to keep the passphrase confidential.

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

const {
publicKey,
privateKey,
} = generateKeyPairSync('rsa', {
modulusLength: 4096,
publicKeyEncoding: {
type: 'spki',
format: 'pem',
},
privateKeyEncoding: {
type: 'pkcs8',
format: 'pem',
cipher: 'aes-256-cbc',
passphrase: 'top secret',
},
});

@param type

The asymmetric key type to generate. See the supported asymmetric key types.

function generateKeyPairSyncT extends MLKEMKeyPairOptions = {}>(type: 'ml-kem-1024' | 'ml-kem-512' | 'ml-kem-768',options?: T): KeyPairExportResultT>;

Generates a new asymmetric key pair of the given type. See the supported asymmetric key types.

When encoding public keys, it is recommended to use 'spki'. When encoding private keys, it is recommended to use 'pkcs8' with a strong passphrase, and to keep the passphrase confidential.

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

const {
publicKey,
privateKey,
} = generateKeyPairSync('rsa', {
modulusLength: 4096,
publicKeyEncoding: {
type: 'spki',
format: 'pem',
},
privateKeyEncoding: {
type: 'pkcs8',
format: 'pem',
cipher: 'aes-256-cbc',
passphrase: 'top secret',
},
});

@param type

The asymmetric key type to generate. See the supported asymmetric key types.

function generateKeyPairSyncT extends RSAPSSKeyPairOptions>(type: 'rsa-pss',options: T): KeyPairExportResultT>;

Generates a new asymmetric key pair of the given type. See the supported asymmetric key types.

When encoding public keys, it is recommended to use 'spki'. When encoding private keys, it is recommended to use 'pkcs8' with a strong passphrase, and to keep the passphrase confidential.

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

const {
publicKey,
privateKey,
} = generateKeyPairSync('rsa', {
modulusLength: 4096,
publicKeyEncoding: {
type: 'spki',
format: 'pem',
},
privateKeyEncoding: {
type: 'pkcs8',
format: 'pem',
cipher: 'aes-256-cbc',
passphrase: 'top secret',
},
});

@param type

The asymmetric key type to generate. See the supported asymmetric key types.

function generateKeyPairSyncT extends RSAKeyPairOptions>(type: 'rsa',options: T): KeyPairExportResultT>;

Generates a new asymmetric key pair of the given type. See the supported asymmetric key types.

When encoding public keys, it is recommended to use 'spki'. When encoding private keys, it is recommended to use 'pkcs8' with a strong passphrase, and to keep the passphrase confidential.

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

const {
publicKey,
privateKey,
} = generateKeyPairSync('rsa', {
modulusLength: 4096,
publicKeyEncoding: {
type: 'spki',
format: 'pem',
},
privateKeyEncoding: {
type: 'pkcs8',
format: 'pem',
cipher: 'aes-256-cbc',
passphrase: 'top secret',
},
});

@param type

The asymmetric key type to generate. See the supported asymmetric key types.

function generateKeyPairSyncT extends SLHDSAKeyPairOptions = {}>(type: 'slh-dsa-sha2-128f' | 'slh-dsa-sha2-128s' | 'slh-dsa-sha2-192f' | 'slh-dsa-sha2-192s' | 'slh-dsa-sha2-256f' | 'slh-dsa-sha2-256s' | 'slh-dsa-shake-128f' | 'slh-dsa-shake-128s' | 'slh-dsa-shake-192f' | 'slh-dsa-shake-192s' | 'slh-dsa-shake-256f' | 'slh-dsa-shake-256s',options?: T): KeyPairExportResultT>;

Generates a new asymmetric key pair of the given type. See the supported asymmetric key types.

When encoding public keys, it is recommended to use 'spki'. When encoding private keys, it is recommended to use 'pkcs8' with a strong passphrase, and to keep the passphrase confidential.

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

const {
publicKey,
privateKey,
} = generateKeyPairSync('rsa', {
modulusLength: 4096,
publicKeyEncoding: {
type: 'spki',
format: 'pem',
},
privateKeyEncoding: {
type: 'pkcs8',
format: 'pem',
cipher: 'aes-256-cbc',
passphrase: 'top secret',
},
});

@param type

The asymmetric key type to generate. See the supported asymmetric key types.

function generateKeyPairSyncT extends X25519KeyPairOptions = {}>(type: 'x25519',options?: T): KeyPairExportResultT>;

Generates a new asymmetric key pair of the given type. See the supported asymmetric key types.

When encoding public keys, it is recommended to use 'spki'. When encoding private keys, it is recommended to use 'pkcs8' with a strong passphrase, and to keep the passphrase confidential.

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

const {
publicKey,
privateKey,
} = generateKeyPairSync('rsa', {
modulusLength: 4096,
publicKeyEncoding: {
type: 'spki',
format: 'pem',
},
privateKeyEncoding: {
type: 'pkcs8',
format: 'pem',
cipher: 'aes-256-cbc',
passphrase: 'top secret',
},
});

@param type

The asymmetric key type to generate. See the supported asymmetric key types.

function generateKeyPairSyncT extends X448KeyPairOptions = {}>(type: 'x448',options?: T): KeyPairExportResultT>;

Generates a new asymmetric key pair of the given type. See the supported asymmetric key types.

When encoding public keys, it is recommended to use 'spki'. When encoding private keys, it is recommended to use 'pkcs8' with a strong passphrase, and to keep the passphrase confidential.

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

const {
publicKey,
privateKey,
} = generateKeyPairSync('rsa', {
modulusLength: 4096,
publicKeyEncoding: {
type: 'spki',
format: 'pem',
},
privateKeyEncoding: {
type: 'pkcs8',
format: 'pem',
cipher: 'aes-256-cbc',
passphrase: 'top secret',
},
});

@param type

The asymmetric key type to generate. See the supported asymmetric key types.

Referenced typesinterface KeyPairExportResultT extends KeyPairExportOptions>privateKey: KeyExportResultT['privateKeyEncoding'], KeyObject>publicKey: KeyExportResultT['publicKeyEncoding'], KeyObject>

Resources

Reference Docs Guides Discord Merch Store GitHub Blog

Toolkit

Runtime Package manager Test runner Bundler Package runner

Project

Bun 1.0 Bun 1.1 Bun 1.2 Bun 1.3 Roadmap Contributing License

Baked with ❤️ in San Francisco

We're hiring →

Node crypto.generateKeyPairSync function | API Reference | Bun

Node crypto.generateKeyPairSync function | API Reference | Bun,AI智能索引,全网链接索引,智能导航,网页索引