asherah 1.0.43 → 1.0.46

package/README.md

@@ -4,12 +4,13 @@ This is a wrapper of the Asherah Go implementation using the Cobhan FFI library
 
 Example code: 
 
+### TypeScript
 
 ```typescript
 import { AsherahConfig, decrypt, encrypt, setup, shutdown } from 'asherah'
 
 const config: AsherahConfig = {
-    KMS: 'static',
+    KMS: 'aws',
     Metastore: 'memory',
     ServiceName: 'TestService',
     ProductID: 'TestProduct',
@@ -24,7 +25,7 @@ const config: AsherahConfig = {
     DynamoDBTableName: null,
     SessionCacheMaxSize: null,
     SessionCacheDuration: null,
-    RegionMap: null,
+    RegionMap: {"us-west-2": "arn:aws:kms:us-west-2:XXXXXXXXX:key/XXXXXXXXXX"},
     PreferredRegion: null,
     EnableRegionSuffix: null
   };
@@ -33,6 +34,8 @@ setup(config)
 
 const input = 'mysecretdata'
 
+console.log("Input: " + input)
+
 const data = Buffer.from(input, 'utf8');
 
 const encrypted = encrypt('partition', data);
@@ -41,5 +44,53 @@ const decrypted = decrypt('partition', encrypted);
 
 const output = decrypted.toString('utf8');
 
+console.log("Output: " + output)
+
 shutdown()
 ```
+
+### JavaScript
+
+```javascript
+
+const asherah = require('asherah')
+
+const config = {
+    KMS: 'aws',
+    Metastore: 'memory',
+    ServiceName: 'TestService',
+    ProductID: 'TestProduct',
+    Verbose: true,
+    EnableSessionCaching: true,
+    ExpireAfter: null,
+    CheckInterval: null,
+    ConnectionString: null,
+    ReplicaReadConsistency: null,
+    DynamoDBEndpoint: null,
+    DynamoDBRegion: null,
+    DynamoDBTableName: null,
+    SessionCacheMaxSize: null,
+    SessionCacheDuration: null,
+    RegionMap: {"us-west-2": "arn:aws:kms:us-west-2:XXXXXXXXX:key/XXXXXXXXXX"},
+    PreferredRegion: null,
+    EnableRegionSuffix: null
+  };
+
+asherah.setup(config)
+
+const input = 'mysecretdata'
+
+console.log("Input: " + input)
+
+const data = Buffer.from(input, 'utf8');
+
+const encrypted = asherah.encrypt('partition', data);
+
+const decrypted = asherah.decrypt('partition', encrypted);
+
+const output = decrypted.toString('utf8');
+
+console.log("Output: " + output)
+
+asherah.shutdown()
+```

package/dist/asherah.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="ref-napi" />
 export declare type AsherahConfig = {
     /** The name of this service (Required) */
     ServiceName: string;

package/dist/asherah.js

@@ -6,13 +6,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.encrypt_string = exports.decrypt_string = exports.encrypt = exports.decrypt = exports.shutdown = exports.setup = void 0;
 const cobhan_1 = require("cobhan");
 const fs_1 = __importDefault(require("fs"));
+const ref_napi_1 = __importDefault(require("ref-napi"));
 const binaries_path = find_binaries();
 const libasherah = (0, cobhan_1.load_platform_library)(binaries_path, 'libasherah', {
-    'SetupJson': ['int32', ['pointer']],
-    'EncryptToJson': ['int32', ['pointer', 'pointer', 'pointer']],
-    'DecryptFromJson': ['int32', ['pointer', 'pointer', 'pointer']],
-    'Shutdown': ['void', []]
+    'SetupJson': [ref_napi_1.default.types.int32, [ref_napi_1.default.refType(ref_napi_1.default.types.void)]],
+    'EncryptToJson': [ref_napi_1.default.types.int32, [ref_napi_1.default.refType(ref_napi_1.default.types.void), ref_napi_1.default.refType(ref_napi_1.default.types.void), ref_napi_1.default.refType(ref_napi_1.default.types.void)]],
+    'DecryptFromJson': [ref_napi_1.default.types.int32, [ref_napi_1.default.refType(ref_napi_1.default.types.void), ref_napi_1.default.refType(ref_napi_1.default.types.void), ref_napi_1.default.refType(ref_napi_1.default.types.void)]],
+    'Shutdown': [ref_napi_1.default.types.void, []]
 });
+const DecryptFromJson = libasherah["DecryptFromJson"];
+const EncryptToJson = libasherah["EncryptToJson"];
+const EstimatedEncryptionOverhead = 48;
+const EstimatedEnvelopeOverhead = 185;
+const Base64Overhead = 1.34;
+let EstimatedIntermediateKeyOverhead = 0;
+function estimate_buffer(dataLen, partitionLen) {
+    const estimatedDataLen = (dataLen + EstimatedEncryptionOverhead) * Base64Overhead;
+    return cobhan_1.header_size + EstimatedEnvelopeOverhead + EstimatedIntermediateKeyOverhead + partitionLen + estimatedDataLen;
+}
 function find_binaries() {
     if (fs_1.default.existsSync('node_modules/asherah/binaries')) {
         return 'node_modules/asherah/binaries';
@@ -24,6 +35,7 @@ function find_binaries() {
 }
 function setup(config) {
     const configJsonBuffer = (0, cobhan_1.json_to_cbuffer)(config);
+    EstimatedIntermediateKeyOverhead = config.ProductID.length + config.ServiceName.length;
     const result = libasherah.SetupJson(configJsonBuffer);
     if (result < 0) {
         throw new Error('setupJson failed: ' + result);
@@ -38,7 +50,7 @@ function decrypt(partitionId, dataRowRecord) {
     const partitionIdBuffer = (0, cobhan_1.string_to_cbuffer)(partitionId);
     const jsonBuffer = (0, cobhan_1.string_to_cbuffer)(dataRowRecord);
     const outputDataBuffer = (0, cobhan_1.allocate_cbuffer)(jsonBuffer.byteLength);
-    const result = libasherah.DecryptFromJson(partitionIdBuffer, jsonBuffer, outputDataBuffer);
+    const result = DecryptFromJson(partitionIdBuffer, jsonBuffer, outputDataBuffer);
     if (result < 0) {
         throw new Error('decrypt failed: ' + result);
     }
@@ -46,11 +58,10 @@ function decrypt(partitionId, dataRowRecord) {
 }
 exports.decrypt = decrypt;
 function encrypt(partitionId, data) {
-    const json_overhead = 256;
     const partitionIdBuffer = (0, cobhan_1.string_to_cbuffer)(partitionId);
     const dataBuffer = (0, cobhan_1.buffer_to_cbuffer)(data);
-    const outputJsonBuffer = (0, cobhan_1.allocate_cbuffer)(data.byteLength + json_overhead);
-    const result = libasherah.EncryptToJson(partitionIdBuffer, dataBuffer, outputJsonBuffer);
+    const outputJsonBuffer = (0, cobhan_1.allocate_cbuffer)(estimate_buffer(data.byteLength, partitionId.length));
+    const result = EncryptToJson(partitionIdBuffer, dataBuffer, outputJsonBuffer);
     if (result < 0) {
         throw new Error('encrypt failed: ' + result);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "asherah",
-  "version": "1.0.43",
+  "version": "1.0.46",
   "description": "Asherah envelope encryption and key rotation library",
   "main": "dist/asherah.js",
   "repository": {
@@ -27,6 +27,7 @@
     "@types/chai": "^4.3.0",
     "@types/mocha": "^9.1.0",
     "@types/node": "^17.0.21",
+    "@types/ref-napi": "^3.0.4",
     "@typescript-eslint/eslint-plugin": "^5.13.0",
     "@typescript-eslint/parser": "^5.13.0",
     "benchmark": "^2.1.4",
@@ -48,6 +49,7 @@
   },
   "types": "dist/asherah.d.ts",
   "dependencies": {
-    "cobhan": "^1.0.27"
+    "cobhan": "^1.0.33",
+    "ref-napi": "^3.0.3"
   }
 }