@k9o/kibo-react-native 0.0.0-stage → 1.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 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 those 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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/NOTICE

@@ -0,0 +1,4 @@
+Kilimanjaro SDK
+Copyright 2026 Formelo Inc.
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).

package/README.md

@@ -1,3 +1,173 @@
-# Temporary Holding Version
+# @k9o/kibo-react-native
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Kibo for React Native. Encrypt and decrypt on the device with keys held in your own KMS, so the platform never sees your plaintext.
+
+## Contents
+
+- [Install](#install)
+- [Quick start](#quick-start)
+- [Load the core](#load-the-core)
+- [Encrypt and decrypt](#encrypt-and-decrypt)
+- [Handle errors](#handle-errors)
+- [Appendix](#appendix)
+  - [Requirements](#requirements)
+  - [Methods](#methods)
+  - [Encrypt and decrypt fields](#encrypt-and-decrypt-fields)
+  - [Error codes](#error-codes)
+  - [Related packages](#related-packages)
+
+## Install
+
+```bash
+npm install @k9o/kibo-react-native
+```
+
+Yarn works too: `yarn add @k9o/kibo-react-native`. See [requirements](#requirements).
+
+## Quick start
+
+- Load the Kibo core once at app start. See [load the core](#load-the-core).
+- Call `encrypt` and `decrypt`. See [encrypt and decrypt](#encrypt-and-decrypt).
+
+This package has no cryptography of its own. It passes typed input to the Kibo core, a WebAssembly module, and returns the result.
+
+## Load the core
+
+React Native cannot import the WebAssembly core on demand. Your app loads it and hands it over once with `setZkWasm`.
+
+```ts
+import { setZkWasm } from "@k9o/kibo-react-native";
+import * as core from "./kibo_kms_rest_ffi.js";
+
+setZkWasm(core);
+```
+
+- The core is not shipped inside this package. Your app bundles it.
+- It must expose async `zk_encrypt` and `zk_decrypt` functions (the `ZkWasm` type).
+- Until `setZkWasm` runs, `encrypt` and `decrypt` fail with `KIBO_WASM_NOT_LOADED`.
+
+## Encrypt and decrypt
+
+The example encrypts the title of a task. `kms_cred.secret` is a short-lived federated token you issue for your KMS.
+
+```ts
+import { encrypt, decrypt } from "@k9o/kibo-react-native";
+
+const kmsToken = "FEDERATED_TOKEN";
+const context = [{ key: "collection", value: "tasks" }];
+const title = new TextEncoder().encode("Write the README");
+
+const sealed = await encrypt({
+  provider: "aws-kms",
+  posture: "byok",
+  kms_cred: { secret: kmsToken, expires_at_unix_secs: 1_800_000_000 },
+  key_ref: { version: 1, external_ref: "arn:aws:kms:eu-central-1:111122223333:key/example" },
+  provider_config: { aws_region: "eu-central-1" },
+  attestation_tier: "software",
+  encryption_context: context,
+  plaintext: title,
+});
+
+const opened = await decrypt({
+  kms_cred: { secret: kmsToken, expires_at_unix_secs: 1_800_000_000 },
+  provider_config: { aws_region: "eu-central-1" },
+  envelope: sealed.envelope,
+  strategy: "local_envelope",
+  attestation_tier: "software",
+  encryption_context: context,
+});
+
+console.log(new TextDecoder().decode(opened.plaintext));
+```
+
+```text
+Write the README
+```
+
+- Give `decrypt` the same `strategy`, `attestation_tier` and `encryption_context` you used to encrypt.
+- The returned `envelope` is opaque bytes. Store it with the encrypted record.
+- All fields are listed in [encrypt and decrypt fields](#encrypt-and-decrypt-fields).
+
+## Handle errors
+
+Every failure is a `KiboError` with `code`, `message` and `context`.
+
+```ts
+import { KiboError } from "@k9o/kibo-react-native";
+
+try {
+  await encrypt(input);
+} catch (error) {
+  if (error instanceof KiboError) {
+    console.log(error.code);
+  }
+}
+```
+
+If `setZkWasm` was skipped, this prints:
+
+```text
+KIBO_WASM_NOT_LOADED
+```
+
+See [error codes](#error-codes) for the full list.
+
+## Appendix
+
+### Requirements
+
+| Requirement | Version |
+|---|---|
+| React | 18 or later |
+| React Native | 0.74 or later |
+| Kibo core (WebAssembly) | Bundled by your app |
+
+### Methods
+
+| Function | What it does |
+|---|---|
+| `setZkWasm(core)` | Supply the Kibo core; call once at app start |
+| `encrypt(input)` | Encrypt bytes with your KMS; returns `{ envelope }` |
+| `decrypt(input)` | Decrypt an envelope; returns `{ plaintext }` |
+
+### Encrypt and decrypt fields
+
+| Field | Used by | Meaning |
+|---|---|---|
+| `provider` | encrypt | `aws-kms`, `gcp-kms`, `azure-kv` or `hashicorp-vault` |
+| `posture` | encrypt | `byok` or `hyok` |
+| `kms_cred` | both | `{ secret, expires_at_unix_secs }` |
+| `key_ref` | encrypt | `{ version, external_ref }` identifying your KMS key |
+| `provider_config` | both | `{ aws_region?, vault_address? }` |
+| `attestation_tier` | both | `software`, `hardware_backed` or `confidential` |
+| `encryption_context` | both | List of `{ key, value }` pairs; `kibo:` keys are reserved |
+| `strategy` | decrypt (optional on encrypt) | `local_envelope` or `customer_kms_oracle` |
+| `oracle_mode` | encrypt, optional | `brokered` or `direct` |
+| `posture_policy` | encrypt, optional | Minimum custody posture and allowed oracle modes |
+| `plaintext` | encrypt | Bytes to encrypt |
+| `envelope` | decrypt | Bytes returned by `encrypt` |
+
+### Error codes
+
+Codes from the core are passed through unchanged.
+
+| Code | When |
+|---|---|
+| `KIBO_WASM_NOT_LOADED` | `setZkWasm` has not been called |
+| `K9O_CRYPTO_POSTURE_FLOOR_VIOLATION` | `posture` is below the floor in `posture_policy`; `context` has `dimension`, `requested`, `declared` |
+| `UPSTREAM_KMS_ERROR` | Your own KMS rejected or failed the call |
+| `KIBO_WASM_DECODE_ERROR` | The core returned something other than bytes |
+| `KIBO_WASM_ERROR` | The core failed with a message that has no code |
+
+### Related packages
+
+| Package | Purpose |
+|---|---|
+| `@k9o/gate-react-native` | End-user sign-in for React Native |
+| `@k9o/kibo` | TypeScript package that also covers vault secrets and wrapped data keys |
+
+Documentation: <https://kilimanjaro.dev>
+
+## License
+
+Apache-2.0 © Formelo Inc. See `LICENSE` and `NOTICE`.

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "@k9o/kibo-react-native",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.1.0",
+  "description": "Kibo Zero-Knowledge BYOK/HYOK vault SDK for React Native — client-side encrypt/decrypt against your own KMS, over the audited Rust core (kibo-kms-rest-ffi) compiled to wasm. The platform never sees plaintext.",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "files": [
+    "src",
+    "wasm",
+    "!src/__tests__",
+    "LICENSE",
+    "NOTICE",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/k9o-dev/k9o-kibo-react-native.git"
+  },
+  "homepage": "https://kilimanjaro.dev/sdks/react-native",
+  "keywords": ["kilimanjaro", "kibo", "byok", "hyok", "encryption", "react-native"],
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-native": ">=0.74.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.6.0"
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node"
+  },
+  "scripts": {
+    "test": "jest",
+    "typecheck": "tsc --noEmit"
+  }
+}

package/src/KiboError.ts

@@ -0,0 +1,24 @@
+/**
+ * Error thrown by @k9o/kibo-react-native crypto operations.
+ *
+ * Mirrors the platform `KError` shape (code + message + context). The bound
+ * core flattens its `ZkFfiError` to a display string across the wasm boundary;
+ * `KiboError` re-structures it. Codes are passed through from the core (never
+ * hardcoded), per the KError discipline:
+ *   - a `K9O_*` wire code for platform errors,
+ *   - `UPSTREAM_KMS_ERROR` for the customer's own KMS failing (upstream
+ *     failures carry no `K9O_*` code),
+ *   - `K9O_CRYPTO_POSTURE_FLOOR_VIOLATION` for a posture-floor breach, with the
+ *     `dimension` / `requested` / `declared` carried in `context`.
+ */
+export class KiboError extends Error {
+  readonly code: string;
+  readonly context: Record<string, unknown>;
+
+  constructor(opts: { code: string; message: string; context?: Record<string, unknown> }) {
+    super(opts.message);
+    this.name = "KiboError";
+    this.code = opts.code;
+    this.context = opts.context ?? {};
+  }
+}

package/src/crypto-types.ts

@@ -0,0 +1,118 @@
+/**
+ * TS contract for the ZK encrypt/decrypt FFI surface — mirrors the Rust
+ * `kibo-kms-rest-ffi::types` (the bound core, piece C) field-for-field.
+ *
+ * These types cross the wasm boundary as plain JS objects (serde-wasm-bindgen),
+ * so the field names + enum wire-tokens must match the Rust serde exactly:
+ *   - `KmsProvider`        kebab-case   (`aws-kms`, `gcp-kms`, `azure-kv`, `hashicorp-vault`)
+ *   - all other enums      snake_case   (`byok`, `local_envelope`, `hardware_backed`, …)
+ *   - bytes (`Vec<u8>`)    `Uint8Array` at the boundary
+ *
+ * Strict-ZK invariant: the `secret` in `KiboCredential` is a customer-issued
+ * short-lived federated token — never a platform KEK; it is zeroized in the core
+ * after use and never logged or returned. The platform never sees plaintext.
+ *
+ * (This RN package is standalone — `KmsProvider` is inlined here rather than
+ * imported from `@k9o/core`, matching the `@k9o/gate-react-native` pattern.)
+ */
+
+/** The customer KMS provider — kebab-case wire tokens. */
+export type KmsProvider = "aws-kms" | "gcp-kms" | "azure-kv" | "hashicorp-vault";
+
+/** Custody posture for an encrypt call. `platform-managed` is structurally absent
+ *  here — `kibo-kms-rest` is the KEK-free customer-KMS layer (ZK is never PM). */
+export type KiboPosture = "byok" | "hyok";
+
+/** Explicit strategy pin. Omit → `local_envelope` (the posture default). */
+export type KiboStrategy = "local_envelope" | "customer_kms_oracle";
+
+/** Oracle routing mode. Omit → `brokered` (default). */
+export type KiboOracleMode = "brokered" | "direct";
+
+/** Device attestation tier bound into the AAD for every operation. */
+export type KiboAttestationTier = "software" | "hardware_backed" | "confidential";
+
+/** The min-custody-posture floor ladder (3-mode; `platform_managed` = no floor).
+ *  Ordering: `PLATFORM_MANAGED < BYOK < HYOK`. */
+export type KiboMinPosture = "platform_managed" | "byok" | "hyok";
+
+/** Acceptable oracle-mode set (the `allowed_oracle_modes` policy dial). */
+export interface KiboAllowedOracleModes {
+  brokered: boolean;
+  direct: boolean;
+}
+
+/** Project-declared crypto-posture floor. Omit fields for the
+ *  most-permissive default (`platform_managed` floor + both oracle modes). */
+export interface KiboPosturePolicy {
+  min_custody_posture?: KiboMinPosture;
+  allowed_oracle_modes?: KiboAllowedOracleModes;
+}
+
+/** Short-lived customer KMS credential — the edge device's federated token.
+ *  `secret` is treated as secret material (zeroized in-core; never returned). */
+export interface KiboCredential {
+  secret: string;
+  expires_at_unix_secs: number;
+}
+
+/** Key version reference identifying the customer KMS key. `external_ref` is
+ *  provider-specific (AWS key ARN / GCP resource name / Azure key URL / Vault
+ *  `<mount>/<key>:<ver>`). `version` is the monotone KEK-rotation counter. */
+export interface KiboKeyRef {
+  version: number;
+  external_ref: string;
+}
+
+/** Provider-specific init params. Only the compiled-in provider's field is read. */
+export interface KiboProviderConfig {
+  aws_region?: string;
+  vault_address?: string;
+}
+
+/** A single encryption-context key/value pair. Bound into the AAD at encrypt and
+ *  re-supplied byte-for-byte at decrypt. (Record shape — uniffi can't cross
+ *  tuples; the wasm JSON is `[{"key":"…","value":"…"}]`.) `kibo:` is reserved. */
+export interface KiboKvPair {
+  key: string;
+  value: string;
+}
+
+/** All inputs to `encrypt` — mirrors Rust `EncryptInput`. */
+export interface KiboEncryptInput {
+  provider: KmsProvider;
+  posture: KiboPosture;
+  strategy?: KiboStrategy;
+  oracle_mode?: KiboOracleMode;
+  kms_cred: KiboCredential;
+  key_ref: KiboKeyRef;
+  provider_config: KiboProviderConfig;
+  attestation_tier: KiboAttestationTier;
+  encryption_context: KiboKvPair[];
+  /** Plaintext bytes to encrypt. */
+  plaintext: Uint8Array;
+  posture_policy?: KiboPosturePolicy;
+}
+
+/** All inputs to `decrypt` — mirrors Rust `DecryptInput`. `strategy`,
+ *  `attestation_tier`, and `encryption_context` MUST be re-supplied (never read
+ *  from the envelope — anti-envelope-substitution discipline). */
+export interface KiboDecryptInput {
+  kms_cred: KiboCredential;
+  provider_config: KiboProviderConfig;
+  /** The canonical (`b"KIBO"`) envelope from a prior `encrypt`. */
+  envelope: Uint8Array;
+  strategy: KiboStrategy;
+  attestation_tier: KiboAttestationTier;
+  encryption_context: KiboKvPair[];
+}
+
+/** Output of `encrypt` — the opaque ZKFE envelope (pass straight to `decrypt`). */
+export interface KiboEncryptOutput {
+  envelope: Uint8Array;
+}
+
+/** Output of `decrypt` — the recovered plaintext. */
+export interface KiboDecryptOutput {
+  plaintext: Uint8Array;
+}