Node crypto.encapsulate function | API Reference | Bun
BuildDocsReferenceGuidesBlogDiscord/
node:crypto/
encapsulateFencapsulate
Search the reference...
/
BuildDocsReferenceGuidesBlogDiscord/
node:crypto/
encapsulateFencapsulate
function
crypto.encapsulatefunction
encapsulate(key:
JsonWebKeyInput |
PublicKeyInput |
KeyLike): { ciphertext: NonSharedBuffer; sharedKey: NonSharedBuffer };
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-KEMIf key is not a 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.
function
encapsulate(key:
JsonWebKeyInput |
PublicKeyInput |
KeyLike,callback: (err:
Error, result: { ciphertext: NonSharedBuffer; sharedKey: NonSharedBuffer }) => void): void;
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-KEMIf key is not a 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.
Referenced typesinterface
JsonWebKeyInputformat: 'jwk'
key:
JsonWebKeyinterface
PublicKeyInputencoding?: string
format?:
KeyFormatkey: string |
BufferArrayBufferLike>
type?:
PublicKeyExportTypetype
KeyLike = string |
Buffer |
KeyObjectResources
ReferenceDocsGuidesDiscordMerch StoreGitHubBlog Toolkit
RuntimePackage managerTest runnerBundlerPackage runnerProject
Bun 1.0Bun 1.1Bun 1.2Bun 1.3RoadmapContributingLicenseBaked with ❤️ in San Francisco
We're hiring →