KeyObject

Node.js uses a KeyObject class to represent a symmetric or asymmetric key, and each kind of key exposes different functions. The {@link createSecretKey}, {@link createPublicKey} and {@link createPrivateKey} methods are used to create KeyObjectinstances. KeyObject objects are not to be created directly using the newkeyword.

Most applications should consider using the new KeyObject API instead of passing keys as strings or Buffers due to improved security features.

KeyObject instances can be passed to other threads via postMessage(). The receiver obtains a cloned KeyObject, and the KeyObject does not need to be listed in the transferList argument.

Since

v11.6.0

Constructors

KeyObject

constructor()

Types

Companion

object Companion

Properties

asymmetricKeyDetails

var asymmetricKeyDetails: AsymmetricKeyDetails?

This property exists only on asymmetric keys. Depending on the type of the key, this object contains information about the key. None of the information obtained through this property can be used to uniquely identify a key or to compromise the security of the key.

asymmetricKeyType

var asymmetricKeyType: KeyType?

For asymmetric keys, this property represents the type of the key. See the supported asymmetric key types.

symmetricKeySize

var symmetricKeySize: Double?

For secret keys, this property represents the size of the key in bytes. This property is undefined for asymmetric keys.

type

var type: KeyObjectType

Depending on the type of this KeyObject, this property is either'secret' for secret (symmetric) keys, 'public' for public (asymmetric) keys or 'private' for private (asymmetric) keys.

Functions

equals

fun equals(otherKeyObject: KeyObject): Boolean

Returns true or false depending on whether the keys have exactly the same type, value, and parameters. This method is not constant time.

export

fun export(options: JwkKeyExportOptions = definedExternally): JsonWebKey

fun export(options: KeyExportOptions<KeyFormat.der> = definedExternally): Buffer<*>

toCryptoKey

fun toCryptoKey(algorithm: ERROR CLASS: Symbol not found for web.crypto.EcKeyImportParams, extractable: Boolean, keyUsages: ERROR CLASS: Symbol not found for js.array.ReadonlyArray<ERROR CLASS: Symbol not found for web.crypto.KeyUsage>): ERROR CLASS: Symbol not found for web.crypto.CryptoKey

fun toCryptoKey(algorithm: ERROR CLASS: Symbol not found for web.crypto.HmacImportParams, extractable: Boolean, keyUsages: ERROR CLASS: Symbol not found for js.array.ReadonlyArray<ERROR CLASS: Symbol not found for web.crypto.KeyUsage>): ERROR CLASS: Symbol not found for web.crypto.CryptoKey

fun toCryptoKey(algorithm: ERROR CLASS: Symbol not found for web.crypto.RsaHashedImportParams, extractable: Boolean, keyUsages: ERROR CLASS: Symbol not found for js.array.ReadonlyArray<ERROR CLASS: Symbol not found for web.crypto.KeyUsage>): ERROR CLASS: Symbol not found for web.crypto.CryptoKey

fun toCryptoKey(algorithm: AlgorithmIdentifier, extractable: Boolean, keyUsages: ERROR CLASS: Symbol not found for js.array.ReadonlyArray<ERROR CLASS: Symbol not found for web.crypto.KeyUsage>): ERROR CLASS: Symbol not found for web.crypto.CryptoKey

Converts a KeyObject instance to a CryptoKey.