Copy buffers to JS memory and free

Signed-off-by: jamshale <[email protected]>

Author: jamshale

packages/askar-nodejs/src/NodeJSAskar.ts

@@ -1,6 +1,8 @@
-import type {
+import {
+  AeadParams,
   AeadParamsOptions,
   Askar,
+  AskarError,
   AskarErrorObject,
   EncryptedBuffer,
   EntryListCountOptions,
@@ -9,6 +11,7 @@ import type {
   EntryListGetNameOptions,
   EntryListGetTagsOptions,
   EntryListGetValueOptions,
+  EntryListHandle,
   KeyAeadDecryptOptions,
   KeyAeadEncryptOptions,
   KeyAeadGetPaddingOptions,
@@ -27,6 +30,7 @@ import type {
   KeyEntryListGetMetadataOptions,
   KeyEntryListGetNameOptions,
   KeyEntryListGetTagsOptions,
+  KeyEntryListHandle,
   KeyEntryListLoadLocalOptions,
   KeyFreeOptions,
   KeyFromJwkOptions,
@@ -46,8 +50,10 @@ import type {
   KeyUnwrapKeyOptions,
   KeyVerifySignatureOptions,
   KeyWrapKeyOptions,
+  LocalKeyHandle,
   MigrateIndySdkOptions,
   ScanFreeOptions,
+  ScanHandle,
   ScanNextOptions,
   ScanStartOptions,
   SessionCloseOptions,
@@ -56,6 +62,7 @@ import type {
   SessionFetchAllOptions,
   SessionFetchKeyOptions,
   SessionFetchOptions,
+  SessionHandle,
   SessionInsertKeyOptions,
   SessionRemoveAllOptions,
   SessionRemoveKeyOptions,
@@ -70,46 +77,34 @@ import type {
   StoreGenerateRawKeyOptions,
   StoreGetDefaultProfileOptions,
   StoreGetProfileNameOptions,
+  StoreHandle,
   StoreListProfilesOptions,
   StoreOpenOptions,
   StoreProvisionOptions,
   StoreRekeyOptions,
   StoreRemoveOptions,
   StoreRemoveProfileOptions,
   StoreSetDefaultProfileOptions,
-} from '@openwallet-foundation/askar-shared'
-import {
-  AeadParams,
-  AskarError,
-  EntryListHandle,
-  KeyEntryListHandle,
-  LocalKeyHandle,
-  ScanHandle,
-  SessionHandle,
-  StoreHandle,
   handleInvalidNullResponse,
 } from '@openwallet-foundation/askar-shared'
-import type {
+import {
   ByteBufferType,
   EncryptedBufferType,
-  NativeCallback,
-  NativeCallbackWithResponse,
-  SecretBufferType,
-} from './ffi'
-import {
   FFI_ENTRY_LIST_HANDLE,
-  FFI_INT8,
   FFI_INT64,
+  FFI_INT8,
   FFI_KEY_ENTRY_LIST_HANDLE,
   FFI_SCAN_HANDLE,
   FFI_SESSION_HANDLE,
   FFI_STORE_HANDLE,
   FFI_STRING,
   FFI_STRING_LIST_HANDLE,
+  NativeCallback,
+  NativeCallbackWithResponse,
   allocateAeadParams,
   allocateEncryptedBuffer,
-  allocateInt8Buffer,
   allocateInt32Buffer,
+  allocateInt8Buffer,
   allocatePointer,
   allocateSecretBuffer,
   allocateStringBuffer,
@@ -120,7 +115,7 @@ import {
   serializeArguments,
   toNativeCallback,
   toNativeCallbackWithResponse,
-  toNativeLogCallback,
+  toNativeLogCallback
 } from './ffi'
 import { getNativeAskar } from './library'
 
@@ -317,9 +312,11 @@ export class NodeJSAskar implements Askar {
 
     const errorCode = this.nativeAskar.askar_entry_list_get_value(entryListHandle, index, ret)
     this.handleError(errorCode)
-
     const byteBuffer = handleReturnPointer<ByteBufferType>(ret)
-    return new Uint8Array(secretBufferToBuffer(byteBuffer))
+    const bufferArray= new Uint8Array(Buffer.from(secretBufferToBuffer(byteBuffer)))
+    this.nativeAskar.askar_buffer_free(byteBuffer as unknown as Buffer)
+
+    return bufferArray
   }
 
   public keyAeadDecrypt(options: KeyAeadDecryptOptions): Uint8Array {
@@ -328,9 +325,11 @@ export class NodeJSAskar implements Askar {
 
     const errorCode = this.nativeAskar.askar_key_aead_decrypt(localKeyHandle, ciphertext, nonce, tag, aad, ret)
     this.handleError(errorCode)
-
     const byteBuffer = handleReturnPointer<ByteBufferType>(ret)
-    return new Uint8Array(secretBufferToBuffer(byteBuffer))
+    const bufferArray= new Uint8Array(Buffer.from(secretBufferToBuffer(byteBuffer)))
+    this.nativeAskar.askar_buffer_free(byteBuffer as unknown as Buffer)
+
+    return bufferArray
   }
 
   public keyAeadEncrypt(options: KeyAeadEncryptOptions): EncryptedBuffer {
@@ -339,9 +338,11 @@ export class NodeJSAskar implements Askar {
 
     const errorCode = this.nativeAskar.askar_key_aead_encrypt(localKeyHandle, message, nonce, aad, ret)
     this.handleError(errorCode)
-
     const encryptedBuffer = handleReturnPointer<EncryptedBufferType>(ret)
-    return encryptedBufferStructToClass(encryptedBuffer)
+    const encryptedBufferClass = encryptedBufferStructToClass(encryptedBuffer)
+    this.nativeAskar.askar_buffer_free(encryptedBuffer.secretBuffer as unknown as Buffer)
+
+    return encryptedBufferClass
   }
 
   public keyAeadGetPadding(options: KeyAeadGetPaddingOptions): number {
@@ -370,9 +371,11 @@ export class NodeJSAskar implements Askar {
 
     const errorCode = this.nativeAskar.askar_key_aead_random_nonce(localKeyHandle, ret)
     this.handleError(errorCode)
+    const byteBuffer = handleReturnPointer<ByteBufferType>(ret)
+    const bufferArray= new Uint8Array(Buffer.from(secretBufferToBuffer(byteBuffer)))
+    this.nativeAskar.askar_buffer_free(byteBuffer as unknown as Buffer)
 
-    const secretBuffer = handleReturnPointer<SecretBufferType>(ret)
-    return new Uint8Array(secretBufferToBuffer(secretBuffer))
+    return bufferArray
   }
 
   public keyConvert(options: KeyConvertOptions): LocalKeyHandle {
@@ -392,9 +395,11 @@ export class NodeJSAskar implements Askar {
 
     const errorCode = this.nativeAskar.askar_key_crypto_box(recipientKey, senderKey, message, nonce, ret)
     this.handleError(errorCode)
+    const byteBuffer = handleReturnPointer<ByteBufferType>(ret)
+    const bufferArray= new Uint8Array(Buffer.from(secretBufferToBuffer(byteBuffer)))
+    this.nativeAskar.askar_buffer_free(byteBuffer as unknown as Buffer)
 
-    const secretBuffer = handleReturnPointer<SecretBufferType>(ret)
-    return new Uint8Array(secretBufferToBuffer(secretBuffer))
+    return bufferArray
   }
 
   public keyCryptoBoxOpen(options: KeyCryptoBoxOpenOptions): Uint8Array {
@@ -403,19 +408,23 @@ export class NodeJSAskar implements Askar {
 
     const errorCode = this.nativeAskar.askar_key_crypto_box_open(recipientKey, senderKey, message, nonce, ret)
     this.handleError(errorCode)
+    const byteBuffer = handleReturnPointer<ByteBufferType>(ret)
+    const bufferArray= new Uint8Array(Buffer.from(secretBufferToBuffer(byteBuffer)))
+    this.nativeAskar.askar_buffer_free(byteBuffer as unknown as Buffer)
 
-    const secretBuffer = handleReturnPointer<SecretBufferType>(ret)
-    return new Uint8Array(secretBufferToBuffer(secretBuffer))
+    return bufferArray
   }
 
   public keyCryptoBoxRandomNonce(): Uint8Array {
     const ret = allocateSecretBuffer()
 
     const errorCode = this.nativeAskar.askar_key_crypto_box_random_nonce(ret)
     this.handleError(errorCode)
+    const byteBuffer = handleReturnPointer<ByteBufferType>(ret)
+    const bufferArray= new Uint8Array(Buffer.from(secretBufferToBuffer(byteBuffer)))
+    this.nativeAskar.askar_buffer_free(byteBuffer as unknown as Buffer)
 
-    const secretBuffer = handleReturnPointer<SecretBufferType>(ret)
-    return new Uint8Array(secretBufferToBuffer(secretBuffer))
+    return bufferArray
   }
 
   public keyCryptoBoxSeal(options: KeyCryptoBoxSealOptions): Uint8Array {
@@ -424,9 +433,11 @@ export class NodeJSAskar implements Askar {
 
     const errorCode = this.nativeAskar.askar_key_crypto_box_seal(localKeyHandle, message, ret)
     this.handleError(errorCode)
+    const byteBuffer = handleReturnPointer<ByteBufferType>(ret)
+    const bufferArray= new Uint8Array(Buffer.from(secretBufferToBuffer(byteBuffer)))
+    this.nativeAskar.askar_buffer_free(byteBuffer as unknown as Buffer)
 
-    const secretBuffer = handleReturnPointer<SecretBufferType>(ret)
-    return new Uint8Array(secretBufferToBuffer(secretBuffer))
+    return bufferArray
   }
 
   public keyCryptoBoxSealOpen(options: KeyCryptoBoxSealOpenOptions): Uint8Array {
@@ -435,9 +446,11 @@ export class NodeJSAskar implements Askar {
 
     const errorCode = this.nativeAskar.askar_key_crypto_box_seal_open(localKeyHandle, ciphertext, ret)
     this.handleError(errorCode)
+    const byteBuffer = handleReturnPointer<ByteBufferType>(ret)
+    const bufferArray= new Uint8Array(Buffer.from(secretBufferToBuffer(byteBuffer)))
+    this.nativeAskar.askar_buffer_free(byteBuffer as unknown as Buffer)
 
-    const secretBuffer = handleReturnPointer<SecretBufferType>(ret)
-    return new Uint8Array(secretBufferToBuffer(secretBuffer))
+    return bufferArray
   }
 
   public keyDeriveEcdh1pu(options: KeyDeriveEcdh1puOptions): LocalKeyHandle {
@@ -659,9 +672,11 @@ export class NodeJSAskar implements Askar {
 
     const errorCode = this.nativeAskar.askar_key_get_jwk_secret(localKeyHandle, ret)
     this.handleError(errorCode)
+    const byteBuffer = handleReturnPointer<ByteBufferType>(ret)
+    const bufferArray= new Uint8Array(Buffer.from(secretBufferToBuffer(byteBuffer)))
+    this.nativeAskar.askar_buffer_free(byteBuffer as unknown as Buffer)
 
-    const secretBuffer = handleReturnPointer<SecretBufferType>(ret)
-    return new Uint8Array(secretBufferToBuffer(secretBuffer))
+    return bufferArray
   }
 
   public keyGetJwkThumbprint(options: KeyGetJwkThumbprintOptions): string {
@@ -680,9 +695,11 @@ export class NodeJSAskar implements Askar {
 
     const errorCode = this.nativeAskar.askar_key_get_public_bytes(localKeyHandle, ret)
     this.handleError(errorCode)
+    const byteBuffer = handleReturnPointer<ByteBufferType>(ret)
+    const bufferArray= new Uint8Array(Buffer.from(secretBufferToBuffer(byteBuffer)))
+    this.nativeAskar.askar_buffer_free(byteBuffer as unknown as Buffer)
 
-    const secretBuffer = handleReturnPointer<SecretBufferType>(ret)
-    return new Uint8Array(secretBufferToBuffer(secretBuffer))
+    return bufferArray
   }
 
   public keyGetSecretBytes(options: KeyGetSecretBytesOptions): Uint8Array {
@@ -691,9 +708,11 @@ export class NodeJSAskar implements Askar {
 
     const errorCode = this.nativeAskar.askar_key_get_secret_bytes(localKeyHandle, ret)
     this.handleError(errorCode)
+    const byteBuffer = handleReturnPointer<ByteBufferType>(ret)
+    const bufferArray= new Uint8Array(Buffer.from(secretBufferToBuffer(byteBuffer)))
+    this.nativeAskar.askar_buffer_free(byteBuffer as unknown as Buffer)
 
-    const secretBuffer = handleReturnPointer<SecretBufferType>(ret)
-    return new Uint8Array(secretBufferToBuffer(secretBuffer))
+    return bufferArray
   }
 
   public keySignMessage(options: KeySignMessageOptions): Uint8Array {
@@ -702,9 +721,11 @@ export class NodeJSAskar implements Askar {
 
     const errorCode = this.nativeAskar.askar_key_sign_message(localKeyHandle, message, sigType, ret)
     this.handleError(errorCode)
+    const byteBuffer = handleReturnPointer<ByteBufferType>(ret)
+    const bufferArray= new Uint8Array(Buffer.from(secretBufferToBuffer(byteBuffer)))
+    this.nativeAskar.askar_buffer_free(byteBuffer as unknown as Buffer)
 
-    const secretBuffer = handleReturnPointer<SecretBufferType>(ret)
-    return new Uint8Array(secretBufferToBuffer(secretBuffer))
+    return bufferArray
   }
 
   public keyUnwrapKey(options: KeyUnwrapKeyOptions): LocalKeyHandle {
@@ -734,9 +755,11 @@ export class NodeJSAskar implements Askar {
 
     const errorCode = this.nativeAskar.askar_key_wrap_key(localKeyHandle, other, nonce, ret)
     this.handleError(errorCode)
-
     const encryptedBuffer = handleReturnPointer<EncryptedBufferType>(ret)
-    return encryptedBufferStructToClass(encryptedBuffer)
+    const encryptedBufferClass = encryptedBufferStructToClass(encryptedBuffer)
+    this.nativeAskar.askar_buffer_free(encryptedBuffer.secretBuffer as unknown as Buffer)
+
+    return encryptedBufferClass
   }
 
   public keyGetSupportedBackends(): string[] {