asherah 1.0.35 → 1.0.38

package/README.md

@@ -5,23 +5,41 @@ This is a wrapper of the Asherah Go implementation using the Cobhan FFI library
 Example code: 
 
 
-```javascript
-import { setup, encrypt, decrypt } from 'asherah'
-
-setup({
-  kmsType: 'static',
-  metastore: 'memory',
-  serviceName: 'TestService',
-  productId: 'TestProduct',
-  verbose: true,
-  sessionCache: true
-});
-
-const data = Buffer.from('mysecretdata', 'utf8');
+```typescript
+import { AsherahConfig, decrypt, encrypt, setup, shutdown } from 'asherah'
+
+const config: AsherahConfig = {
+    KMS: 'static',
+    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: null,
+    PreferredRegion: null,
+    EnableRegionSuffix: null
+  };
+
+setup(config)
+
+const input = 'mysecretdata'
+
+const data = Buffer.from(input, 'utf8');
 
 const encrypted = encrypt('partition', data);
-console.log(encrypted);
 
 const decrypted = decrypt('partition', encrypted);
-console.log("Decrypted: " + decrypted.toString('utf8'));
+
+const output = decrypted.toString('utf8');
+
+shutdown()
 ```

package/dist/asherah.d.ts

@@ -0,0 +1,45 @@
+/// <reference types="node" />
+export declare type AsherahConfig = {
+    /** The name of this service (Required) */
+    ServiceName: string;
+    /** The name of the product that owns this service (Required) */
+    ProductID: string;
+    /** The amount of time a key is considered valid */
+    ExpireAfter: number | null;
+    /** The amount of time before cached keys are considered stale */
+    CheckInterval: number | null;
+    /** Determines the type of metastore to use for persisting keys (Required) { "rdbms", "dynamodb", "memory" } */
+    Metastore: string;
+    /** The database connection string (Required if metastore=rdbms) */
+    ConnectionString: string | null;
+    /** Required for Aurora sessions using write forwarding { "eventual", "global", "session" } */
+    ReplicaReadConsistency: string | null;
+    /** An optional endpoint URL (hostname only or fully qualified URI) (only supported by metastore=dynamodb) */
+    DynamoDBEndpoint: string | null;
+    /** The AWS region for DynamoDB requests (defaults to globally configured region) (only supported by metastore=dynamodb) */
+    DynamoDBRegion: string | null;
+    /** The table name for DynamoDB (only supported by metastore=dynamodb) */
+    DynamoDBTableName: string | null;
+    /** Define the maximum number of sessions to cache (Default 1000) */
+    SessionCacheMaxSize: number | null;
+    /** The amount of time a session will remain cached (Default 2h) */
+    SessionCacheDuration: number | null;
+    /** Configures the master key management service (Default kms) { "aws", "static" } */
+    KMS: string | null;
+    /** A comma separated list of key-value pairs in the form of REGION1=ARN1[,REGION2=ARN2] (required if kms=aws) */
+    RegionMap: string | null;
+    /** The preferred AWS region (required if kms=aws) */
+    PreferredRegion: string | null;
+    /** Configure the metastore to use regional suffixes (only supported by metastore=dynamodb) */
+    EnableRegionSuffix: boolean | null;
+    /** Enable shared session caching */
+    EnableSessionCaching: boolean | null;
+    /** Enable verbose logging output */
+    Verbose: boolean | null;
+};
+export declare function setup(config: AsherahConfig): void;
+export declare function shutdown(): void;
+export declare function decrypt(partitionId: string, dataRowRecord: string): Buffer;
+export declare function encrypt(partitionId: string, data: Buffer): string;
+export declare function decrypt_string(partitionId: string, dataRowRecord: string): string;
+export declare function encrypt_string(partitionId: string, data: string): string;

package/dist/asherah.js

@@ -3,14 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.encrypt = exports.decrypt = exports.shutdown = exports.setup = void 0;
+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 binaries_path = find_binaries();
 const libasherah = (0, cobhan_1.load_platform_library)(binaries_path, 'libasherah', {
-    'Encrypt': ['int32', ['pointer', 'pointer', 'pointer', 'pointer', 'pointer', 'pointer', 'pointer']],
-    'Decrypt': ['int32', ['pointer', 'pointer', 'pointer', 'int64', 'pointer', 'int64', 'pointer']],
     'SetupJson': ['int32', ['pointer']],
+    'EncryptToJson': ['int32', ['pointer', 'pointer', 'pointer']],
+    'DecryptFromJson': ['int32', ['pointer', 'pointer', 'pointer']],
     'Shutdown': ['void', []]
 });
 function find_binaries() {
@@ -36,13 +36,9 @@ function shutdown() {
 exports.shutdown = shutdown;
 function decrypt(partitionId, dataRowRecord) {
     const partitionIdBuffer = (0, cobhan_1.string_to_cbuffer)(partitionId);
-    const encryptedDataBuffer = (0, cobhan_1.buffer_to_cbuffer)(dataRowRecord.Data);
-    const encryptedKeyBuffer = (0, cobhan_1.buffer_to_cbuffer)(dataRowRecord.Key.EncryptedKey);
-    const created = dataRowRecord.Key.Created;
-    const parentKeyIdBuffer = (0, cobhan_1.string_to_cbuffer)(dataRowRecord.Key.ParentKeyMeta.ID);
-    const parentKeyCreated = dataRowRecord.Key.ParentKeyMeta.Created;
-    const outputDataBuffer = (0, cobhan_1.allocate_cbuffer)(encryptedDataBuffer.length + 256);
-    const result = libasherah.Decrypt(partitionIdBuffer, encryptedDataBuffer, encryptedKeyBuffer, created, parentKeyIdBuffer, parentKeyCreated, outputDataBuffer);
+    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);
     if (result < 0) {
         throw new Error('decrypt failed: ' + result);
     }
@@ -50,29 +46,22 @@ 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 outputEncryptedDataBuffer = (0, cobhan_1.allocate_cbuffer)(data.length + 256);
-    const outputEncryptedKeyBuffer = (0, cobhan_1.allocate_cbuffer)(256);
-    const outputCreatedBuffer = (0, cobhan_1.int64_to_buffer)(0);
-    const outputParentKeyIdBuffer = (0, cobhan_1.allocate_cbuffer)(256);
-    const outputParentKeyCreatedBuffer = (0, cobhan_1.int64_to_buffer)(0);
-    const result = libasherah.Encrypt(partitionIdBuffer, dataBuffer, outputEncryptedDataBuffer, outputEncryptedKeyBuffer, outputCreatedBuffer, outputParentKeyIdBuffer, outputParentKeyCreatedBuffer);
+    const outputJsonBuffer = (0, cobhan_1.allocate_cbuffer)(data.byteLength + json_overhead);
+    const result = libasherah.EncryptToJson(partitionIdBuffer, dataBuffer, outputJsonBuffer);
     if (result < 0) {
         throw new Error('encrypt failed: ' + result);
     }
-    const parentKeyId = (0, cobhan_1.cbuffer_to_string)(outputParentKeyIdBuffer);
-    const dataRowRecord = {
-        Data: (0, cobhan_1.cbuffer_to_buffer)(outputEncryptedDataBuffer),
-        Key: {
-            EncryptedKey: (0, cobhan_1.cbuffer_to_buffer)(outputEncryptedKeyBuffer),
-            Created: (0, cobhan_1.buffer_to_int64)(outputCreatedBuffer),
-            ParentKeyMeta: {
-                ID: parentKeyId,
-                Created: (0, cobhan_1.buffer_to_int64)(outputParentKeyCreatedBuffer)
-            }
-        }
-    };
-    return dataRowRecord;
+    return (0, cobhan_1.cbuffer_to_string)(outputJsonBuffer);
 }
 exports.encrypt = encrypt;
+function decrypt_string(partitionId, dataRowRecord) {
+    return decrypt(partitionId, dataRowRecord).toString('utf8');
+}
+exports.decrypt_string = decrypt_string;
+function encrypt_string(partitionId, data) {
+    return encrypt(partitionId, Buffer.from(data, 'utf8'));
+}
+exports.encrypt_string = encrypt_string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "asherah",
-  "version": "1.0.35",
+  "version": "1.0.38",
   "description": "Asherah envelope encryption and key rotation library",
   "main": "dist/asherah.js",
   "repository": {
@@ -20,16 +20,19 @@
   "files": [
     "binaries/*.so",
     "binaries/*.dylib",
-    "dist/index.d.ts"
+    "dist/asherah.d.ts"
   ],
   "devDependencies": {
+    "@types/benchmark": "^2.1.1",
     "@types/chai": "^4.3.0",
     "@types/mocha": "^9.1.0",
     "@types/node": "^17.0.21",
     "@typescript-eslint/eslint-plugin": "^5.13.0",
     "@typescript-eslint/parser": "^5.13.0",
+    "benchmark": "^2.1.4",
     "chai": "^4.3.6",
     "eslint": "^8.10.0",
+    "microtime": "^3.0.0",
     "mocha": "^9.2.1",
     "nyc": "^15.1.0",
     "ts-mocha": "^9.0.2",