chore: byte buffer with free

Signed-off-by: Timo Glastra <[email protected]>

Author: TimoGlastra

packages/askar-nodejs/src/NodeJSAskar.ts

@@ -1,95 +1,95 @@
+import type {
+  AeadParamsOptions,
+  Askar,
+  AskarErrorObject,
+  EncryptedBuffer,
+  EntryListCountOptions,
+  EntryListFreeOptions,
+  EntryListGetCategoryOptions,
+  EntryListGetNameOptions,
+  EntryListGetTagsOptions,
+  EntryListGetValueOptions,
+  KeyAeadDecryptOptions,
+  KeyAeadEncryptOptions,
+  KeyAeadGetPaddingOptions,
+  KeyAeadGetParamsOptions,
+  KeyAeadRandomNonceOptions,
+  KeyConvertOptions,
+  KeyCryptoBoxOpenOptions,
+  KeyCryptoBoxOptions,
+  KeyCryptoBoxSealOpenOptions,
+  KeyCryptoBoxSealOptions,
+  KeyDeriveEcdh1puOptions,
+  KeyDeriveEcdhEsOptions,
+  KeyEntryListCountOptions,
+  KeyEntryListFreeOptions,
+  KeyEntryListGetAlgorithmOptions,
+  KeyEntryListGetMetadataOptions,
+  KeyEntryListGetNameOptions,
+  KeyEntryListGetTagsOptions,
+  KeyEntryListLoadLocalOptions,
+  KeyFreeOptions,
+  KeyFromJwkOptions,
+  KeyFromKeyExchangeOptions,
+  KeyFromPublicBytesOptions,
+  KeyFromSecretBytesOptions,
+  KeyFromSeedOptions,
+  KeyGenerateOptions,
+  KeyGetAlgorithmOptions,
+  KeyGetEphemeralOptions,
+  KeyGetJwkPublicOptions,
+  KeyGetJwkSecretOptions,
+  KeyGetJwkThumbprintOptions,
+  KeyGetPublicBytesOptions,
+  KeyGetSecretBytesOptions,
+  KeySignMessageOptions,
+  KeyUnwrapKeyOptions,
+  KeyVerifySignatureOptions,
+  KeyWrapKeyOptions,
+  MigrateIndySdkOptions,
+  ScanFreeOptions,
+  ScanNextOptions,
+  ScanStartOptions,
+  SessionCloseOptions,
+  SessionCountOptions,
+  SessionFetchAllKeysOptions,
+  SessionFetchAllOptions,
+  SessionFetchKeyOptions,
+  SessionFetchOptions,
+  SessionInsertKeyOptions,
+  SessionRemoveAllOptions,
+  SessionRemoveKeyOptions,
+  SessionStartOptions,
+  SessionUpdateKeyOptions,
+  SessionUpdateOptions,
+  SetCustomLoggerOptions,
+  SetMaxLogLevelOptions,
+  StoreCloseOptions,
+  StoreCopyToOptions,
+  StoreCreateProfileOptions,
+  StoreGenerateRawKeyOptions,
+  StoreGetDefaultProfileOptions,
+  StoreGetProfileNameOptions,
+  StoreListProfilesOptions,
+  StoreOpenOptions,
+  StoreProvisionOptions,
+  StoreRekeyOptions,
+  StoreRemoveOptions,
+  StoreRemoveProfileOptions,
+  StoreSetDefaultProfileOptions,
+} from '@openwallet-foundation/askar-shared'
 import {
   AeadParams,
-  type AeadParamsOptions,
-  type Askar,
   AskarError,
-  type AskarErrorObject,
-  type EncryptedBuffer,
-  type EntryListCountOptions,
-  type EntryListFreeOptions,
-  type EntryListGetCategoryOptions,
-  type EntryListGetNameOptions,
-  type EntryListGetTagsOptions,
-  type EntryListGetValueOptions,
   EntryListHandle,
-  type KeyAeadDecryptOptions,
-  type KeyAeadEncryptOptions,
-  type KeyAeadGetPaddingOptions,
-  type KeyAeadGetParamsOptions,
-  type KeyAeadRandomNonceOptions,
-  type KeyConvertOptions,
-  type KeyCryptoBoxOpenOptions,
-  type KeyCryptoBoxOptions,
-  type KeyCryptoBoxSealOpenOptions,
-  type KeyCryptoBoxSealOptions,
-  type KeyDeriveEcdh1puOptions,
-  type KeyDeriveEcdhEsOptions,
-  type KeyEntryListCountOptions,
-  type KeyEntryListFreeOptions,
-  type KeyEntryListGetAlgorithmOptions,
-  type KeyEntryListGetMetadataOptions,
-  type KeyEntryListGetNameOptions,
-  type KeyEntryListGetTagsOptions,
   KeyEntryListHandle,
-  type KeyEntryListLoadLocalOptions,
-  type KeyFreeOptions,
-  type KeyFromJwkOptions,
-  type KeyFromKeyExchangeOptions,
-  type KeyFromPublicBytesOptions,
-  type KeyFromSecretBytesOptions,
-  type KeyFromSeedOptions,
-  type KeyGenerateOptions,
-  type KeyGetAlgorithmOptions,
-  type KeyGetEphemeralOptions,
-  type KeyGetJwkPublicOptions,
-  type KeyGetJwkSecretOptions,
-  type KeyGetJwkThumbprintOptions,
-  type KeyGetPublicBytesOptions,
-  type KeyGetSecretBytesOptions,
-  type KeySignMessageOptions,
-  type KeyUnwrapKeyOptions,
-  type KeyVerifySignatureOptions,
-  type KeyWrapKeyOptions,
   LocalKeyHandle,
-  type MigrateIndySdkOptions,
-  type ScanFreeOptions,
   ScanHandle,
-  type ScanNextOptions,
-  type ScanStartOptions,
-  type SessionCloseOptions,
-  type SessionCountOptions,
-  type SessionFetchAllKeysOptions,
-  type SessionFetchAllOptions,
-  type SessionFetchKeyOptions,
-  type SessionFetchOptions,
   SessionHandle,
-  type SessionInsertKeyOptions,
-  type SessionRemoveAllOptions,
-  type SessionRemoveKeyOptions,
-  type SessionStartOptions,
-  type SessionUpdateKeyOptions,
-  type SessionUpdateOptions,
-  type SetCustomLoggerOptions,
-  type SetMaxLogLevelOptions,
-  type StoreCloseOptions,
-  type StoreCopyToOptions,
-  type StoreCreateProfileOptions,
-  type StoreGenerateRawKeyOptions,
-  type StoreGetDefaultProfileOptions,
-  type StoreGetProfileNameOptions,
   StoreHandle,
-  type StoreListProfilesOptions,
-  type StoreOpenOptions,
-  type StoreProvisionOptions,
-  type StoreRekeyOptions,
-  type StoreRemoveOptions,
-  type StoreRemoveProfileOptions,
-  type StoreSetDefaultProfileOptions,
   handleInvalidNullResponse,
 } from '@openwallet-foundation/askar-shared'
 import {
-  type ByteBufferType,
-  type EncryptedBufferType,
   FFI_ENTRY_LIST_HANDLE,
   FFI_INT8,
   FFI_INT64,
@@ -99,8 +99,6 @@ import {
   FFI_STORE_HANDLE,
   FFI_STRING,
   FFI_STRING_LIST_HANDLE,
-  type NativeCallback,
-  type NativeCallbackWithResponse,
   allocateAeadParams,
   allocateEncryptedBuffer,
   allocateInt8Buffer,
@@ -111,12 +109,13 @@ import {
   allocateStringListHandle,
   deallocateCallbackBuffer,
   encryptedBufferStructToClass,
-  secretBufferToBuffer,
+  secretBufferToBufferWithFree,
   serializeArguments,
   toNativeCallback,
   toNativeCallbackWithResponse,
   toNativeLogCallback,
 } from './ffi'
+import type { ByteBufferType, EncryptedBufferType, NativeCallback, NativeCallbackWithResponse } from './ffi'
 import { getNativeAskar } from './library'
 
 function handleNullableReturnPointer<Return>(returnValue: Buffer): Return | null {
@@ -313,8 +312,7 @@ 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)
-    const bufferArray = new Uint8Array(Buffer.from(secretBufferToBuffer(byteBuffer)))
-    this.nativeAskar.askar_buffer_free(byteBuffer as unknown as Buffer)
+    const bufferArray = new Uint8Array(secretBufferToBufferWithFree(byteBuffer))
 
     return bufferArray
   }
@@ -326,8 +324,7 @@ 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)
-    const bufferArray = new Uint8Array(Buffer.from(secretBufferToBuffer(byteBuffer)))
-    this.nativeAskar.askar_buffer_free(byteBuffer as unknown as Buffer)
+    const bufferArray = new Uint8Array(secretBufferToBufferWithFree(byteBuffer))
 
     return bufferArray
   }
@@ -372,8 +369,7 @@ 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 bufferArray = new Uint8Array(secretBufferToBufferWithFree(byteBuffer))
 
     return bufferArray
   }
@@ -396,8 +392,7 @@ 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 bufferArray = new Uint8Array(secretBufferToBufferWithFree(byteBuffer))
 
     return bufferArray
   }
@@ -409,8 +404,7 @@ 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 bufferArray = new Uint8Array(secretBufferToBufferWithFree(byteBuffer))
 
     return bufferArray
   }
@@ -421,8 +415,7 @@ export class NodeJSAskar implements Askar {
     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 bufferArray = new Uint8Array(secretBufferToBufferWithFree(byteBuffer))
 
     return bufferArray
   }
@@ -434,8 +427,7 @@ 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 bufferArray = new Uint8Array(secretBufferToBufferWithFree(byteBuffer))
 
     return bufferArray
   }
@@ -447,8 +439,7 @@ 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 bufferArray = new Uint8Array(secretBufferToBufferWithFree(byteBuffer))
 
     return bufferArray
   }
@@ -673,8 +664,7 @@ 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 bufferArray = new Uint8Array(secretBufferToBufferWithFree(byteBuffer))
 
     return bufferArray
   }
@@ -696,8 +686,7 @@ 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 bufferArray = new Uint8Array(secretBufferToBufferWithFree(byteBuffer))
 
     return bufferArray
   }
@@ -709,8 +698,7 @@ 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 bufferArray = new Uint8Array(secretBufferToBufferWithFree(byteBuffer))
 
     return bufferArray
   }
@@ -722,8 +710,7 @@ 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 bufferArray = new Uint8Array(secretBufferToBufferWithFree(byteBuffer))
 
     return bufferArray
   }

packages/askar-nodejs/src/ffi/conversion.ts

@@ -2,6 +2,7 @@ import type { Pointer } from '@2060.io/ref-napi'
 import { reinterpret } from '@2060.io/ref-napi'
 import { EncryptedBuffer } from '@openwallet-foundation/askar-shared'
 import type { TypedArray } from 'ref-array-di'
+import { getNativeAskar } from '../library'
 import type { ByteBufferType, EncryptedBufferType } from './structures'
 import { ByteBufferStruct } from './structures'
 
@@ -19,8 +20,15 @@ export const uint8arrayToByteBufferStruct = (buf: Buffer) => {
 }
 
 export const byteBufferToBuffer = ({ data, len }: ByteBufferType) => reinterpret(data, len)
+export const byteBufferToBufferWithFree = ({ data, len }: ByteBufferType) => {
+  const buffer = reinterpret(data, len)
+  const newBuffer = Buffer.from(buffer)
+  getNativeAskar().askar_buffer_free(buffer)
+  return newBuffer
+}
 
 export const secretBufferToBuffer = byteBufferToBuffer
+export const secretBufferToBufferWithFree = byteBufferToBufferWithFree
 
 export const encryptedBufferStructToClass = ({ secretBuffer, tagPos, noncePos }: EncryptedBufferType) => {
   const buffer = Uint8Array.from(secretBufferToBuffer(secretBuffer))