cyphera 0.0.1-alpha.1

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Horizon Digital Engineering LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,71 @@
+# cyphera
+
+Data protection SDK for Node.js — format-preserving encryption (FF1/FF3), AES-GCM, data masking, and hashing. Zero dependencies.
+
+```
+npm install cyphera
+```
+
+## Usage
+
+```javascript
+const { Cyphera } = require("cyphera");
+
+// Auto-discover: checks CYPHERA_POLICY_FILE env, ./cyphera.json, /etc/cyphera/cyphera.json
+const c = Cyphera.load();
+
+// Or load from a specific file
+const c = Cyphera.fromFile("./config/cyphera.json");
+
+// Or inline config
+const c = new Cyphera({
+  policies: {
+    ssn: { engine: "ff1", key_ref: "my-key", tag: "T01" },
+  },
+  keys: {
+    "my-key": { material: "2B7E151628AED2A6ABF7158809CF4F3C" },
+  },
+});
+
+// Protect
+const encrypted = c.protect("123-45-6789", "ssn");
+// → "T01i6J-xF-07pX" (tagged, dashes preserved)
+
+// Access (tag-based, no policy name needed)
+const decrypted = c.access(encrypted);
+// → "123-45-6789"
+```
+
+## Policy File (cyphera.json)
+
+```json
+{
+  "policies": {
+    "ssn": { "engine": "ff1", "key_ref": "my-key", "tag": "T01" },
+    "cc": { "engine": "ff1", "key_ref": "my-key", "tag": "T02" },
+    "ssn_mask": { "engine": "mask", "pattern": "last4", "tag_enabled": false }
+  },
+  "keys": {
+    "my-key": { "material": "2B7E151628AED2A6ABF7158809CF4F3C" }
+  }
+}
+```
+
+## Cross-Language Compatible
+
+Java, Rust, and Node produce identical output for the same inputs:
+
+```
+Input:       123-45-6789
+Java:        T01i6J-xF-07pX
+Rust:        T01i6J-xF-07pX
+Node:        T01i6J-xF-07pX
+```
+
+## Status
+
+Alpha. API is unstable. Zero runtime dependencies — pure Node.js `crypto` module.
+
+## License
+
+Apache 2.0 — Copyright 2026 Horizon Digital Engineering LLC

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "cyphera",
+  "version": "0.0.1-alpha.1",
+  "description": "Data protection SDK — format-preserving encryption (FF1/FF3), AES-GCM, data masking, and hashing. Zero dependencies.",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "node --test src/*.test.js"
+  },
+  "keywords": [
+    "encryption",
+    "fpe",
+    "format-preserving-encryption",
+    "data-protection",
+    "masking",
+    "ff1",
+    "ff3",
+    "field-level-encryption"
+  ],
+  "author": "Leslie Gutschow <leslie.gutschow@horizondigital.dev>",
+  "homepage": "https://cyphera.io",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cyphera-labs/cyphera-node.git"
+  },
+  "bugs": {
+    "url": "https://github.com/cyphera-labs/cyphera-node/issues"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "files": [
+    "src/**/*.js",
+    "LICENSE",
+    "README.md"
+  ]
+}

package/src/cyphera.js

@@ -0,0 +1,290 @@
+"use strict";
+const crypto = require("crypto");
+const fs = require("fs");
+const path = require("path");
+const { FF1 } = require("./ff1");
+const { FF3 } = require("./ff3");
+
+const ALPHABETS = {
+  digits: "0123456789",
+  alpha_lower: "abcdefghijklmnopqrstuvwxyz",
+  alpha_upper: "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
+  alpha: "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
+  alphanumeric: "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
+};
+
+function resolveAlphabet(name) {
+  if (!name) return ALPHABETS.alphanumeric;
+  return ALPHABETS[name] || name; // literal custom alphabet if not a known name
+}
+
+class Cyphera {
+  constructor(config) {
+    this._policies = {};
+    this._tagIndex = {};
+    this._keys = {};
+
+    // Load keys
+    const keys = config.keys || {};
+    for (const [name, val] of Object.entries(keys)) {
+      const material = typeof val === "string" ? val : val.material;
+      this._keys[name] = Buffer.from(material, "hex");
+    }
+
+    // Load policies + build tag index
+    const policies = config.policies || {};
+    for (const [name, pol] of Object.entries(policies)) {
+      const tagEnabled = pol.tag_enabled !== false; // default true
+      const tag = pol.tag || null;
+
+      if (tagEnabled && !tag) {
+        throw new Error(`Policy '${name}' has tag_enabled=true but no tag specified`);
+      }
+
+      if (tagEnabled && tag) {
+        if (this._tagIndex[tag]) {
+          throw new Error(`Tag collision: '${tag}' used by both '${this._tagIndex[tag]}' and '${name}'`);
+        }
+        this._tagIndex[tag] = name;
+      }
+
+      this._policies[name] = {
+        engine: pol.engine || "ff1",
+        alphabet: resolveAlphabet(pol.alphabet),
+        keyRef: pol.key_ref || null,
+        tag,
+        tagEnabled,
+        tagLength: pol.tag_length || 3,
+        pattern: pol.pattern || null,
+        algorithm: pol.algorithm || "sha256",
+      };
+    }
+  }
+
+  protect(value, policyName) {
+    const policy = this._getPolicy(policyName);
+
+    switch (policy.engine) {
+      case "ff1": return this._protectFpe(value, policy, false);
+      case "ff3": return this._protectFpe(value, policy, true);
+      case "mask": return this._protectMask(value, policy);
+      case "hash": return this._protectHash(value, policy);
+      default: throw new Error(`Unknown engine: ${policy.engine}`);
+    }
+  }
+
+  access(protectedValue, policyName) {
+    if (policyName) {
+      // Explicit policy
+      const policy = this._getPolicy(policyName);
+      return this._accessFpe(protectedValue, policy);
+    }
+
+    // Tag-based lookup — check longest tags first
+    const tags = Object.keys(this._tagIndex).sort((a, b) => b.length - a.length);
+    for (const tag of tags) {
+      if (protectedValue.startsWith(tag)) {
+        const policy = this._getPolicy(this._tagIndex[tag]);
+        return this._accessFpe(protectedValue, policy);
+      }
+    }
+
+    throw new Error("No matching tag found. Use access(value, policyName) for untagged values.");
+  }
+
+  // ── FPE protect ──
+
+  _protectFpe(value, policy, isFF3) {
+    const key = this._resolveKey(policy.keyRef);
+    const alphabet = policy.alphabet;
+
+    // 1. Strip passthroughs
+    const { encryptable, positions, chars } = this._extractPassthroughs(value, alphabet);
+
+    // 2. Check zero encryptable
+    if (encryptable.length === 0) {
+      throw new Error("No encryptable characters in input");
+    }
+
+    // 3. Encrypt
+    let encrypted;
+    if (isFF3) {
+      const cipher = new FF3(key, Buffer.alloc(8), alphabet);
+      encrypted = cipher.encrypt(encryptable);
+    } else {
+      const cipher = new FF1(key, Buffer.alloc(0), alphabet);
+      encrypted = cipher.encrypt(encryptable);
+    }
+
+    // 4. Reinsert passthroughs
+    const withPt = this._reinsertPassthroughs(encrypted, positions, chars);
+
+    // 5. Prepend tag
+    if (policy.tagEnabled && policy.tag) {
+      return policy.tag + withPt;
+    }
+    return withPt;
+  }
+
+  // ── FPE access ──
+
+  _accessFpe(protectedValue, policy) {
+    if (!["ff1", "ff3"].includes(policy.engine)) {
+      throw new Error(`Cannot reverse '${policy.engine}' — not reversible`);
+    }
+
+    const key = this._resolveKey(policy.keyRef);
+    const alphabet = policy.alphabet;
+
+    // 1. Strip tag
+    let withoutTag = protectedValue;
+    if (policy.tagEnabled && policy.tag) {
+      withoutTag = protectedValue.slice(policy.tag.length);
+    }
+
+    // 2. Strip passthroughs
+    const { encryptable, positions, chars } = this._extractPassthroughs(withoutTag, alphabet);
+
+    // 3. Decrypt
+    let decrypted;
+    if (policy.engine === "ff3") {
+      const cipher = new FF3(key, Buffer.alloc(8), alphabet);
+      decrypted = cipher.decrypt(encryptable);
+    } else {
+      const cipher = new FF1(key, Buffer.alloc(0), alphabet);
+      decrypted = cipher.decrypt(encryptable);
+    }
+
+    // 4. Reinsert passthroughs
+    return this._reinsertPassthroughs(decrypted, positions, chars);
+  }
+
+  // ── Mask ──
+
+  _protectMask(value, policy) {
+    if (!policy.pattern) throw new Error("Mask policy requires 'pattern'");
+    const len = value.length;
+    const mask = "*";
+
+    switch (policy.pattern) {
+      case "last4": case "last_4":
+        return mask.repeat(Math.max(0, len - 4)) + value.slice(-4);
+      case "last2": case "last_2":
+        return mask.repeat(Math.max(0, len - 2)) + value.slice(-2);
+      case "first1": case "first_1":
+        return value.slice(0, 1) + mask.repeat(Math.max(0, len - 1));
+      case "first3": case "first_3":
+        return value.slice(0, 3) + mask.repeat(Math.max(0, len - 3));
+      case "full":
+      default:
+        return mask.repeat(len);
+    }
+  }
+
+  // ── Hash ──
+
+  _protectHash(value, policy) {
+    const algo = policy.algorithm.replace("-", "").toLowerCase();
+    let javaAlgo;
+    switch (algo) {
+      case "sha256": javaAlgo = "sha256"; break;
+      case "sha384": javaAlgo = "sha384"; break;
+      case "sha512": javaAlgo = "sha512"; break;
+      default: throw new Error(`Unsupported hash algorithm: ${policy.algorithm}`);
+    }
+
+    if (policy.keyRef) {
+      const key = this._resolveKey(policy.keyRef);
+      const hmac = crypto.createHmac(javaAlgo, key);
+      hmac.update(value, "utf8");
+      return hmac.digest("hex");
+    }
+
+    const hash = crypto.createHash(javaAlgo);
+    hash.update(value, "utf8");
+    return hash.digest("hex");
+  }
+
+  // ── Helpers ──
+
+  _getPolicy(name) {
+    const p = this._policies[name];
+    if (!p) throw new Error(`Unknown policy: ${name}`);
+    return p;
+  }
+
+  _resolveKey(keyRef) {
+    if (!keyRef) throw new Error("No key_ref in policy");
+    const key = this._keys[keyRef];
+    if (!key) throw new Error(`Unknown key: ${keyRef}`);
+    return key;
+  }
+
+  _extractPassthroughs(value, alphabet) {
+    let encryptable = "";
+    const positions = [];
+    const chars = [];
+
+    for (let i = 0; i < value.length; i++) {
+      if (alphabet.includes(value[i])) {
+        encryptable += value[i];
+      } else {
+        positions.push(i);
+        chars.push(value[i]);
+      }
+    }
+
+    return { encryptable, positions, chars };
+  }
+
+  _reinsertPassthroughs(encrypted, positions, chars) {
+    let result = encrypted;
+    for (let i = 0; i < positions.length; i++) {
+      const pos = positions[i];
+      if (pos <= result.length) {
+        result = result.slice(0, pos) + chars[i] + result.slice(pos);
+      } else {
+        result += chars[i];
+      }
+    }
+    return result;
+  }
+}
+
+/**
+ * Load from a JSON file path.
+ */
+Cyphera.fromFile = function (filePath) {
+  const contents = fs.readFileSync(filePath, "utf8");
+  const config = JSON.parse(contents);
+  return new Cyphera(config);
+};
+
+/**
+ * Auto-discover policy file using standard precedence:
+ * 1. CYPHERA_POLICY_FILE env var
+ * 2. ./cyphera.json
+ * 3. /etc/cyphera/cyphera.json
+ */
+Cyphera.load = function () {
+  const envPath = process.env.CYPHERA_POLICY_FILE;
+  if (envPath && fs.existsSync(envPath)) {
+    return Cyphera.fromFile(envPath);
+  }
+
+  const localPath = path.resolve("cyphera.json");
+  if (fs.existsSync(localPath)) {
+    return Cyphera.fromFile(localPath);
+  }
+
+  const systemPath = "/etc/cyphera/cyphera.json";
+  if (fs.existsSync(systemPath)) {
+    return Cyphera.fromFile(systemPath);
+  }
+
+  throw new Error(
+    "No policy file found. Checked: CYPHERA_POLICY_FILE env, ./cyphera.json, /etc/cyphera/cyphera.json"
+  );
+};
+
+module.exports = { Cyphera, ALPHABETS };

package/src/cyphera.test.js

@@ -0,0 +1,96 @@
+"use strict";
+const { describe, it } = require("node:test");
+const assert = require("node:assert");
+const { Cyphera } = require("./cyphera");
+
+const config = {
+  policies: {
+    ssn: { engine: "ff1", key_ref: "test-key", tag: "T01" },
+    ssn_digits: { engine: "ff1", alphabet: "digits", tag_enabled: false, key_ref: "test-key" },
+    ssn_mask: { engine: "mask", pattern: "last4", tag_enabled: false },
+    ssn_hash: { engine: "hash", algorithm: "sha256", key_ref: "test-key", tag_enabled: false },
+  },
+  keys: {
+    "test-key": { material: "2B7E151628AED2A6ABF7158809CF4F3C" },
+  },
+};
+
+describe("Cyphera SDK", () => {
+  it("protect and access with tag", () => {
+    const c = new Cyphera(config);
+    const protected_ = c.protect("123456789", "ssn");
+    assert.ok(protected_.startsWith("T01"));
+    assert.ok(protected_.length > "123456789".length);
+    const accessed = c.access(protected_);
+    assert.strictEqual(accessed, "123456789");
+  });
+
+  it("protect and access with passthroughs", () => {
+    const c = new Cyphera(config);
+    const protected_ = c.protect("123-45-6789", "ssn");
+    assert.ok(protected_.includes("-"));
+    const accessed = c.access(protected_);
+    assert.strictEqual(accessed, "123-45-6789");
+  });
+
+  it("untagged digits roundtrip", () => {
+    const c = new Cyphera(config);
+    const protected_ = c.protect("123456789", "ssn_digits");
+    assert.strictEqual(protected_.length, 9);
+    const accessed = c.access(protected_, "ssn_digits");
+    assert.strictEqual(accessed, "123456789");
+  });
+
+  it("deterministic", () => {
+    const c = new Cyphera(config);
+    const a = c.protect("123456789", "ssn");
+    const b = c.protect("123456789", "ssn");
+    assert.strictEqual(a, b);
+  });
+
+  it("mask last4", () => {
+    const c = new Cyphera(config);
+    const result = c.protect("123-45-6789", "ssn_mask");
+    assert.strictEqual(result, "*******6789");
+  });
+
+  it("hash deterministic", () => {
+    const c = new Cyphera(config);
+    const a = c.protect("123-45-6789", "ssn_hash");
+    const b = c.protect("123-45-6789", "ssn_hash");
+    assert.strictEqual(a, b);
+    assert.ok(/^[0-9a-f]+$/.test(a));
+  });
+
+  it("access non-reversible throws", () => {
+    const c = new Cyphera(config);
+    const masked = c.protect("123-45-6789", "ssn_mask");
+    assert.throws(() => c.access(masked), /No matching tag/);
+  });
+
+  it("tag collision throws", () => {
+    assert.throws(() => new Cyphera({
+      policies: {
+        a: { engine: "ff1", key_ref: "k", tag: "ABC" },
+        b: { engine: "ff1", key_ref: "k", tag: "ABC" },
+      },
+      keys: { k: { material: "2B7E151628AED2A6ABF7158809CF4F3C" } },
+    }), /Tag collision/);
+  });
+
+  it("tag required when enabled throws", () => {
+    assert.throws(() => new Cyphera({
+      policies: {
+        a: { engine: "ff1", key_ref: "k" },
+      },
+      keys: { k: { material: "2B7E151628AED2A6ABF7158809CF4F3C" } },
+    }), /no tag specified/);
+  });
+
+  it("unicode passthroughs roundtrip", () => {
+    const c = new Cyphera(config);
+    const protected_ = c.protect("José123456", "ssn");
+    const accessed = c.access(protected_);
+    assert.strictEqual(accessed, "José123456");
+  });
+});

package/src/ff1.js

@@ -0,0 +1,152 @@
+"use strict";
+const crypto = require("crypto");
+
+const DIGITS = "0123456789";
+const ALPHANUMERIC = "0123456789abcdefghijklmnopqrstuvwxyz";
+
+class FF1 {
+  constructor(key, tweak, alphabet = ALPHANUMERIC) {
+    if (![16, 24, 32].includes(key.length)) throw new Error("Key must be 16, 24, or 32 bytes");
+    if (alphabet.length < 2) throw new Error("Alphabet must have >= 2 chars");
+    this.key = key;
+    this.tweak = tweak;
+    this.alphabet = alphabet;
+    this.radix = BigInt(alphabet.length);
+    this.charMap = {};
+    for (let i = 0; i < alphabet.length; i++) this.charMap[alphabet[i]] = i;
+  }
+
+  encrypt(plaintext) {
+    const digits = this._toDigits(plaintext);
+    const result = this._ff1Encrypt(digits, this.tweak);
+    return this._fromDigits(result);
+  }
+
+  decrypt(ciphertext) {
+    const digits = this._toDigits(ciphertext);
+    const result = this._ff1Decrypt(digits, this.tweak);
+    return this._fromDigits(result);
+  }
+
+  _toDigits(s) { return [...s].map(c => this.charMap[c]); }
+  _fromDigits(d) { return d.map(i => this.alphabet[i]).join(""); }
+
+  _aes(block) {
+    const cipher = crypto.createCipheriv(`aes-${this.key.length * 8}-ecb`, this.key, null);
+    cipher.setAutoPadding(false);
+    return Buffer.concat([cipher.update(block), cipher.final()]);
+  }
+
+  _prf(data) {
+    let y = Buffer.alloc(16);
+    for (let i = 0; i < data.length; i += 16) {
+      const tmp = Buffer.alloc(16);
+      for (let j = 0; j < 16; j++) tmp[j] = y[j] ^ data[i + j];
+      y = this._aes(tmp);
+    }
+    return y;
+  }
+
+  _expandS(R, d) {
+    const blocks = Math.ceil(d / 16);
+    const out = Buffer.alloc(blocks * 16);
+    R.copy(out, 0);
+    let prev = Buffer.from(R);
+    for (let j = 1; j < blocks; j++) {
+      const x = Buffer.alloc(16);
+      x.writeBigUInt64BE(BigInt(j), 8);
+      for (let k = 0; k < 16; k++) x[k] ^= prev[k];
+      const enc = this._aes(x);
+      enc.copy(out, j * 16);
+      prev = enc;
+    }
+    return out.subarray(0, d);
+  }
+
+  _num(digits) {
+    let r = 0n;
+    for (const d of digits) r = r * this.radix + BigInt(d);
+    return r;
+  }
+
+  _str(num, len) {
+    const r = new Array(len).fill(0);
+    for (let i = len - 1; i >= 0; i--) { r[i] = Number(num % this.radix); num /= this.radix; }
+    return r;
+  }
+
+  _computeB(v) {
+    let pow = this.radix ** BigInt(v) - 1n;
+    return Math.ceil(pow === 0n ? 1 : Number(pow.toString(2).length) / 8);
+  }
+
+  _buildP(u, n, t) {
+    const P = Buffer.alloc(16);
+    P[0] = 1; P[1] = 2; P[2] = 1;
+    P[3] = Number(this.radix >> 16n) & 0xFF; P[4] = Number(this.radix >> 8n) & 0xFF; P[5] = Number(this.radix) & 0xFF;
+    P[6] = 10; P[7] = u;
+    P.writeUInt32BE(n, 8);
+    P.writeUInt32BE(t, 12);
+    return P;
+  }
+
+  _buildQ(T, i, numBytes, b) {
+    const pad = (16 - ((T.length + 1 + b) % 16)) % 16;
+    const Q = Buffer.alloc(T.length + pad + 1 + b);
+    T.copy(Q, 0);
+    Q[T.length + pad] = i;
+    const start = Math.max(0, numBytes.length - b);
+    const dest = Q.length - (numBytes.length - start);
+    numBytes.copy(Q, dest, start);
+    return Q;
+  }
+
+  _bigIntToBytes(x, b) {
+    const hex = x.toString(16).padStart(b * 2, "0");
+    return Buffer.from(hex.slice(-b * 2), "hex");
+  }
+
+  _ff1Encrypt(pt, T) {
+    const n = pt.length, u = Math.floor(n / 2), v = n - u;
+    let A = pt.slice(0, u), B = pt.slice(u);
+    const b = this._computeB(v);
+    const d = 4 * Math.ceil(b / 4) + 4;
+    const P = this._buildP(u, n, T.length);
+
+    for (let i = 0; i < 10; i++) {
+      const numB = this._bigIntToBytes(this._num(B), b);
+      const Q = this._buildQ(T, i, numB, b);
+      const R = this._prf(Buffer.concat([P, Q]));
+      const S = this._expandS(R, d);
+      const y = BigInt("0x" + S.toString("hex"));
+      const m = i % 2 === 0 ? u : v;
+      const c = (this._num(A) + y) % (this.radix ** BigInt(m));
+      [A, B] = [B, this._str(c, m)];
+    }
+    return [...A, ...B];
+  }
+
+  _ff1Decrypt(ct, T) {
+    const n = ct.length, u = Math.floor(n / 2), v = n - u;
+    let A = ct.slice(0, u), B = ct.slice(u);
+    const b = this._computeB(v);
+    const d = 4 * Math.ceil(b / 4) + 4;
+    const P = this._buildP(u, n, T.length);
+
+    for (let i = 9; i >= 0; i--) {
+      const numA = this._bigIntToBytes(this._num(A), b);
+      const Q = this._buildQ(T, i, numA, b);
+      const R = this._prf(Buffer.concat([P, Q]));
+      const S = this._expandS(R, d);
+      const y = BigInt("0x" + S.toString("hex"));
+      const m = i % 2 === 0 ? u : v;
+      const mod = this.radix ** BigInt(m);
+      let c = (this._num(B) - y) % mod;
+      if (c < 0n) c += mod;
+      [B, A] = [A, this._str(c, m)];
+    }
+    return [...A, ...B];
+  }
+}
+
+module.exports = { FF1, DIGITS, ALPHANUMERIC };

package/src/ff1.test.js

@@ -0,0 +1,17 @@
+const { describe, it } = require("node:test");
+const assert = require("node:assert/strict");
+const { FF1, DIGITS, ALPHANUMERIC } = require("./ff1");
+
+const hex = (s) => Buffer.from(s, "hex");
+
+describe("FF1 NIST Vectors", () => {
+  it("sample 1", () => { const c = new FF1(hex("2B7E151628AED2A6ABF7158809CF4F3C"), Buffer.alloc(0), DIGITS); assert.equal(c.encrypt("0123456789"), "2433477484"); assert.equal(c.decrypt("2433477484"), "0123456789"); });
+  it("sample 2", () => { const c = new FF1(hex("2B7E151628AED2A6ABF7158809CF4F3C"), hex("39383736353433323130"), DIGITS); assert.equal(c.encrypt("0123456789"), "6124200773"); assert.equal(c.decrypt("6124200773"), "0123456789"); });
+  it("sample 3", () => { const c = new FF1(hex("2B7E151628AED2A6ABF7158809CF4F3C"), hex("3737373770717273373737"), ALPHANUMERIC); assert.equal(c.encrypt("0123456789abcdefghi"), "a9tv40mll9kdu509eum"); assert.equal(c.decrypt("a9tv40mll9kdu509eum"), "0123456789abcdefghi"); });
+  it("sample 4", () => { const c = new FF1(hex("2B7E151628AED2A6ABF7158809CF4F3CEF4359D8D580AA4F"), Buffer.alloc(0), DIGITS); assert.equal(c.encrypt("0123456789"), "2830668132"); assert.equal(c.decrypt("2830668132"), "0123456789"); });
+  it("sample 5", () => { const c = new FF1(hex("2B7E151628AED2A6ABF7158809CF4F3CEF4359D8D580AA4F"), hex("39383736353433323130"), DIGITS); assert.equal(c.encrypt("0123456789"), "2496655549"); assert.equal(c.decrypt("2496655549"), "0123456789"); });
+  it("sample 6", () => { const c = new FF1(hex("2B7E151628AED2A6ABF7158809CF4F3CEF4359D8D580AA4F"), hex("3737373770717273373737"), ALPHANUMERIC); assert.equal(c.encrypt("0123456789abcdefghi"), "xbj3kv35jrawxv32ysr"); assert.equal(c.decrypt("xbj3kv35jrawxv32ysr"), "0123456789abcdefghi"); });
+  it("sample 7", () => { const c = new FF1(hex("2B7E151628AED2A6ABF7158809CF4F3CEF4359D8D580AA4F7F036D6F04FC6A94"), Buffer.alloc(0), DIGITS); assert.equal(c.encrypt("0123456789"), "6657667009"); assert.equal(c.decrypt("6657667009"), "0123456789"); });
+  it("sample 8", () => { const c = new FF1(hex("2B7E151628AED2A6ABF7158809CF4F3CEF4359D8D580AA4F7F036D6F04FC6A94"), hex("39383736353433323130"), DIGITS); assert.equal(c.encrypt("0123456789"), "1001623463"); assert.equal(c.decrypt("1001623463"), "0123456789"); });
+  it("sample 9", () => { const c = new FF1(hex("2B7E151628AED2A6ABF7158809CF4F3CEF4359D8D580AA4F7F036D6F04FC6A94"), hex("3737373770717273373737"), ALPHANUMERIC); assert.equal(c.encrypt("0123456789abcdefghi"), "xs8a0azh2avyalyzuwd"); assert.equal(c.decrypt("xs8a0azh2avyalyzuwd"), "0123456789abcdefghi"); });
+});

package/src/ff3.js

@@ -0,0 +1,127 @@
+"use strict";
+const crypto = require("crypto");
+
+const DIGITS = "0123456789";
+const ALPHANUMERIC = "0123456789abcdefghijklmnopqrstuvwxyz";
+
+class FF3 {
+  constructor(key, tweak, alphabet = ALPHANUMERIC) {
+    if (![16, 24, 32].includes(key.length)) throw new Error("Key must be 16, 24, or 32 bytes");
+    if (tweak.length !== 8) throw new Error("Tweak must be exactly 8 bytes");
+    if (alphabet.length < 2) throw new Error("Alphabet must have >= 2 chars");
+    // FF3 reverses the key
+    this.key = Buffer.from([...key].reverse());
+    this.tweak = tweak;
+    this.alphabet = alphabet;
+    this.radix = BigInt(alphabet.length);
+    this.charMap = {};
+    for (let i = 0; i < alphabet.length; i++) this.charMap[alphabet[i]] = i;
+  }
+
+  encrypt(plaintext) {
+    const digits = this._toDigits(plaintext);
+    return this._fromDigits(this._ff3Encrypt(digits));
+  }
+
+  decrypt(ciphertext) {
+    const digits = this._toDigits(ciphertext);
+    return this._fromDigits(this._ff3Decrypt(digits));
+  }
+
+  _toDigits(s) { return [...s].map(c => this.charMap[c]); }
+  _fromDigits(d) { return d.map(i => this.alphabet[i]).join(""); }
+
+  _aes(block) {
+    const cipher = crypto.createCipheriv(`aes-${this.key.length * 8}-ecb`, this.key, null);
+    cipher.setAutoPadding(false);
+    return Buffer.concat([cipher.update(block), cipher.final()]);
+  }
+
+  _num(digits) {
+    let r = 0n;
+    for (const d of digits) r = r * this.radix + BigInt(d);
+    return r;
+  }
+
+  _str(num, len) {
+    const r = new Array(len).fill(0);
+    for (let i = len - 1; i >= 0; i--) { r[i] = Number(num % this.radix); num /= this.radix; }
+    return r;
+  }
+
+  _calcP(round, w, half) {
+    const input = Buffer.alloc(16);
+    w.copy(input, 0);
+    input[3] ^= round;
+
+    const revHalf = [...half].reverse();
+    const halfNum = this._num(revHalf);
+    let hb;
+    if (halfNum === 0n) {
+      hb = Buffer.alloc(1);
+    } else {
+      const hex = halfNum.toString(16);
+      hb = Buffer.from(hex.length % 2 ? "0" + hex : hex, "hex");
+    }
+    if (hb.length <= 12) {
+      hb.copy(input, 16 - hb.length);
+    } else {
+      hb.copy(input, 4, hb.length - 12);
+    }
+
+    const revInput = Buffer.from([...input].reverse());
+    const aesOut = this._aes(revInput);
+    const revOut = Buffer.from([...aesOut].reverse());
+    return BigInt("0x" + revOut.toString("hex"));
+  }
+
+  _ff3Encrypt(pt) {
+    const n = pt.length, u = Math.ceil(n / 2), v = n - u;
+    let A = pt.slice(0, u), B = pt.slice(u);
+
+    for (let i = 0; i < 8; i++) {
+      const w = i % 2 === 0 ? this.tweak.subarray(4, 8) : this.tweak.subarray(0, 4);
+      if (i % 2 === 0) {
+        const p = this._calcP(i, w, B);
+        const m = this.radix ** BigInt(u);
+        const aNum = this._num([...A].reverse());
+        const y = (aNum + p) % m;
+        A = this._str(y, u).reverse();
+      } else {
+        const p = this._calcP(i, w, A);
+        const m = this.radix ** BigInt(v);
+        const bNum = this._num([...B].reverse());
+        const y = (bNum + p) % m;
+        B = this._str(y, v).reverse();
+      }
+    }
+    return [...A, ...B];
+  }
+
+  _ff3Decrypt(ct) {
+    const n = ct.length, u = Math.ceil(n / 2), v = n - u;
+    let A = ct.slice(0, u), B = ct.slice(u);
+
+    for (let i = 7; i >= 0; i--) {
+      const w = i % 2 === 0 ? this.tweak.subarray(4, 8) : this.tweak.subarray(0, 4);
+      if (i % 2 === 0) {
+        const p = this._calcP(i, w, B);
+        const m = this.radix ** BigInt(u);
+        const aNum = this._num([...A].reverse());
+        let y = (aNum - p) % m;
+        if (y < 0n) y += m;
+        A = this._str(y, u).reverse();
+      } else {
+        const p = this._calcP(i, w, A);
+        const m = this.radix ** BigInt(v);
+        const bNum = this._num([...B].reverse());
+        let y = (bNum - p) % m;
+        if (y < 0n) y += m;
+        B = this._str(y, v).reverse();
+      }
+    }
+    return [...A, ...B];
+  }
+}
+
+module.exports = { FF3, DIGITS, ALPHANUMERIC };

package/src/ff3.test.js

@@ -0,0 +1,30 @@
+const { describe, it } = require("node:test");
+const assert = require("node:assert/strict");
+const { FF3, DIGITS } = require("./ff3");
+
+const hex = (s) => Buffer.from(s, "hex");
+const R26 = "0123456789abcdefghijklmnop";
+
+function nist(keyHex, tweakHex, alphabet, pt, ct) {
+  const c = new FF3(hex(keyHex), hex(tweakHex), alphabet);
+  assert.equal(c.encrypt(pt), ct, `encrypt(${pt})`);
+  assert.equal(c.decrypt(ct), pt, `decrypt(${ct})`);
+}
+
+describe("FF3 NIST Vectors", () => {
+  it("s01", () => nist("EF4359D8D580AA4F7F036D6F04FC6A94", "D8E7920AFA330A73", DIGITS, "890121234567890000", "750918814058654607"));
+  it("s02", () => nist("EF4359D8D580AA4F7F036D6F04FC6A94", "9A768A92F60E12D8", DIGITS, "890121234567890000", "018989839189395384"));
+  it("s03", () => nist("EF4359D8D580AA4F7F036D6F04FC6A94", "D8E7920AFA330A73", DIGITS, "89012123456789000000789000000", "48598367162252569629397416226"));
+  it("s04", () => nist("EF4359D8D580AA4F7F036D6F04FC6A94", "0000000000000000", DIGITS, "89012123456789000000789000000", "34695224821734535122613701434"));
+  it("s05", () => nist("EF4359D8D580AA4F7F036D6F04FC6A94", "9A768A92F60E12D8", R26, "0123456789abcdefghi", "g2pk40i992fn20cjakb"));
+  it("s06", () => nist("EF4359D8D580AA4F7F036D6F04FC6A942B7E151628AED2A6", "D8E7920AFA330A73", DIGITS, "890121234567890000", "646965393875028755"));
+  it("s07", () => nist("EF4359D8D580AA4F7F036D6F04FC6A942B7E151628AED2A6", "9A768A92F60E12D8", DIGITS, "890121234567890000", "961610514491424446"));
+  it("s08", () => nist("EF4359D8D580AA4F7F036D6F04FC6A942B7E151628AED2A6", "D8E7920AFA330A73", DIGITS, "89012123456789000000789000000", "53048884065350204541786380807"));
+  it("s09", () => nist("EF4359D8D580AA4F7F036D6F04FC6A942B7E151628AED2A6", "0000000000000000", DIGITS, "89012123456789000000789000000", "98083802678820389295041483512"));
+  it("s10", () => nist("EF4359D8D580AA4F7F036D6F04FC6A942B7E151628AED2A6", "9A768A92F60E12D8", R26, "0123456789abcdefghi", "i0ihe2jfj7a9opf9p88"));
+  it("s11", () => nist("EF4359D8D580AA4F7F036D6F04FC6A942B7E151628AED2A6ABF7158809CF4F3C", "D8E7920AFA330A73", DIGITS, "890121234567890000", "922011205562777495"));
+  it("s12", () => nist("EF4359D8D580AA4F7F036D6F04FC6A942B7E151628AED2A6ABF7158809CF4F3C", "9A768A92F60E12D8", DIGITS, "890121234567890000", "504149865578056140"));
+  it("s13", () => nist("EF4359D8D580AA4F7F036D6F04FC6A942B7E151628AED2A6ABF7158809CF4F3C", "D8E7920AFA330A73", DIGITS, "89012123456789000000789000000", "04344343235792599165734622699"));
+  it("s14", () => nist("EF4359D8D580AA4F7F036D6F04FC6A942B7E151628AED2A6ABF7158809CF4F3C", "0000000000000000", DIGITS, "89012123456789000000789000000", "30859239999374053872365555822"));
+  it("s15", () => nist("EF4359D8D580AA4F7F036D6F04FC6A942B7E151628AED2A6ABF7158809CF4F3C", "9A768A92F60E12D8", R26, "0123456789abcdefghi", "p0b2godfja9bhb7bk38"));
+});

package/src/index.js

@@ -0,0 +1,6 @@
+"use strict";
+const { FF1 } = require("./ff1");
+const { FF3 } = require("./ff3");
+const { Cyphera, ALPHABETS } = require("./cyphera");
+
+module.exports = { Cyphera, FF1, FF3, ALPHABETS };