generateKeyPair
external fun generateKeyPair(type: KeyType.rsa, options: RSAKeyPairPemPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: String) -> Unit)(source)
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.
});Content copied to clipboard
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.
Since
v10.12.0
Parameters
type
The asymmetric key type to generate. See the supported asymmetric key types.
external fun generateKeyPair(type: KeyType.rsa, options: RSAKeyPairPemDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.rsa, options: RSAKeyPairDerPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.rsa, options: RSAKeyPairDerDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.rsa, options: RSAKeyPairKeyObjectOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: KeyObject, privateKey: KeyObject) -> Unit)(source)
external fun generateKeyPair(type: KeyType.rsaPss, options: RSAPSSKeyPairPemPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.rsaPss, options: RSAPSSKeyPairPemDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.rsaPss, options: RSAPSSKeyPairDerPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.rsaPss, options: RSAPSSKeyPairDerDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.rsaPss, options: RSAPSSKeyPairKeyObjectOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: KeyObject, privateKey: KeyObject) -> Unit)(source)
external fun generateKeyPair(type: KeyType.dsa, options: DSAKeyPairPemPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.dsa, options: DSAKeyPairPemDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.dsa, options: DSAKeyPairDerPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.dsa, options: DSAKeyPairDerDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.dsa, options: DSAKeyPairKeyObjectOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: KeyObject, privateKey: KeyObject) -> Unit)(source)
external fun generateKeyPair(type: KeyType.ec, options: ECKeyPairPemPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.ec, options: ECKeyPairPemDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.ec, options: ECKeyPairDerPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.ec, options: ECKeyPairDerDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.ec, options: ECKeyPairKeyObjectOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: KeyObject, privateKey: KeyObject) -> Unit)(source)
external fun generateKeyPair(type: KeyType.ed25519, options: ED25519KeyPairPemPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.ed25519, options: ED25519KeyPairPemDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.ed25519, options: ED25519KeyPairDerPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.ed25519, options: ED25519KeyPairDerDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.ed25519, options: ED25519KeyPairKeyObjectOptions?, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: KeyObject, privateKey: KeyObject) -> Unit)(source)
external fun generateKeyPair(type: KeyType.ed448, options: ED448KeyPairPemPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.ed448, options: ED448KeyPairPemDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.ed448, options: ED448KeyPairDerPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.ed448, options: ED448KeyPairDerDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.ed448, options: ED448KeyPairKeyObjectOptions?, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: KeyObject, privateKey: KeyObject) -> Unit)(source)
external fun generateKeyPair(type: KeyType.x25519, options: X25519KeyPairPemPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.x25519, options: X25519KeyPairPemDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.x25519, options: X25519KeyPairDerPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.x25519, options: X25519KeyPairDerDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.x25519, options: X25519KeyPairKeyObjectOptions?, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: KeyObject, privateKey: KeyObject) -> Unit)(source)
external fun generateKeyPair(type: KeyType.x448, options: X448KeyPairPemPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.x448, options: X448KeyPairPemDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.x448, options: X448KeyPairDerPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.x448, options: X448KeyPairDerDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.x448, options: X448KeyPairKeyObjectOptions?, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: KeyObject, privateKey: KeyObject) -> Unit)(source)
external fun generateKeyPair(type: KeyType.mlDsa, options: MLDSAKeyPairPemPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.mlDsa, options: MLDSAKeyPairPemDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.mlDsa, options: MLDSAKeyPairDerPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.mlDsa, options: MLDSAKeyPairDerDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.mlDsa, options: MLDSAKeyPairKeyObjectOptions?, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: KeyObject, privateKey: KeyObject) -> Unit)(source)
external fun generateKeyPair(type: KeyType.mlKem, options: MLKEMKeyPairPemPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.mlKem, options: MLKEMKeyPairPemDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: String, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.mlKem, options: MLKEMKeyPairDerPemOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: String) -> Unit)(source)
external fun generateKeyPair(type: KeyType.mlKem, options: MLKEMKeyPairDerDerOptions, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: Buffer<*>, privateKey: Buffer<*>) -> Unit)(source)
external fun generateKeyPair(type: KeyType.mlKem, options: MLKEMKeyPairKeyObjectOptions?, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError??, publicKey: KeyObject, privateKey: KeyObject) -> Unit)(source)