kotlin-node/node.crypto/encapsulate

encapsulate

external fun encapsulate(key: KeyLike): EncapsulateResult(source)
external fun encapsulate(key: PublicKeyInput): EncapsulateResult(source)
external fun encapsulate(key: JsonWebKeyInput): EncapsulateResult(source)

Key encapsulation using a KEM algorithm with a public key.

Supported key types and their KEM algorithms are:

  • 'rsa' RSA Secret Value Encapsulation

  • 'ec' DHKEM(P-256, HKDF-SHA256), DHKEM(P-384, HKDF-SHA256), DHKEM(P-521, HKDF-SHA256)

  • 'x25519' DHKEM(X25519, HKDF-SHA256)

  • 'x448' DHKEM(X448, HKDF-SHA512)

  • 'ml-kem-512' ML-KEM

  • 'ml-kem-768' ML-KEM

  • 'ml-kem-1024' ML-KEM

If key is not a {@link KeyObject}, this function behaves as if key had been passed to crypto.createPublicKey().

If the callback function is provided this function uses libuv's threadpool.

Since

v24.7.0

external fun encapsulate(key: KeyLike, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError, result: EncapsulateCallbackResult) -> Unit)(source)
external fun encapsulate(key: PublicKeyInput, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError, result: EncapsulateCallbackResult) -> Unit)(source)
external fun encapsulate(key: JsonWebKeyInput, callback: (@R|kotlin/ParameterName|(name = String(err)) ERROR CLASS: Symbol not found for js.errors.JsError, result: EncapsulateCallbackResult) -> Unit)(source)