@keyhive/keyhive 0.1.0-alpha.3 → 0.1.0-alpha.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keyhive/keyhive",
-  "version": "0.1.0-alpha.3",
+  "version": "0.1.0-alpha.5",
   "description": "",
   "main": "pkg/keyhive_wasm.js",
   "keywords": [],

package/pkg/keyhive_wasm.d.ts

@@ -9,26 +9,6 @@ export class Access {
     static tryFromString(s: string): Access | undefined;
 }
 
-/**
- * The result of adding a member: the membership delegation, plus any new leaf
- * secrets produced by auto-rekeying a non-forward-secret document on add.
- */
-export class AddMemberUpdate {
-    private constructor();
-    free(): void;
-    [Symbol.dispose](): void;
-    readonly delegation: SignedDelegation;
-    /**
-     * New leaf secret keypairs from auto-rekeying a non-forward-secret document
-     * when this reader was added, serialized as a
-     * `BTreeMap<ShareKey, ShareSecretKey>` (the format `importPrekeySecrets`
-     * accepts). A sibling instance of this identity (e.g. a tab and its
-     * SharedWorker) installs them to derive the rotated key. `undefined` when
-     * no rotation occurred (a forward-secret document).
-     */
-    readonly leafSecrets: Uint8Array | undefined;
-}
-
 export class Agent {
     private constructor();
     free(): void;
@@ -135,6 +115,21 @@ export class ContactCard {
     readonly shareKey: ShareKey;
 }
 
+/**
+ * Plaintext plus the application secret key that decrypted it.
+ */
+export class DecryptedKeyed {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * The 32-byte application secret key used to decrypt this content.
+     * Treat as secret: do not log or persist unencrypted.
+     */
+    readonly applicationSecret: Uint8Array;
+    readonly plaintext: Uint8Array;
+}
+
 export class Delegation {
     private constructor();
     free(): void;
@@ -183,6 +178,11 @@ export class Encrypted {
     private constructor();
     free(): void;
     [Symbol.dispose](): void;
+    /**
+     * Decrypt this content with an explicit 32-byte application secret key,
+     * bypassing CGKA.
+     */
+    decryptWithKey(key: Uint8Array): Uint8Array;
     static fromBytes(bytes: Uint8Array): Encrypted;
     serialize(): Uint8Array;
     toBytes(): Uint8Array;
@@ -201,6 +201,21 @@ export class EncryptedContentWithUpdate {
     update_op(): SignedCgkaOperation | undefined;
 }
 
+/**
+ * Encrypted content plus the application secret key it was encrypted under.
+ */
+export class EncryptedKeyed {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    encrypted_content(): Encrypted;
+    update_op(): SignedCgkaOperation | undefined;
+    /**
+     * The 32-byte application secret key used to encrypt this content.
+     */
+    readonly applicationSecret: Uint8Array;
+}
+
 export class Event {
     private constructor();
     free(): void;
@@ -293,7 +308,7 @@ export class Keyhive {
     free(): void;
     [Symbol.dispose](): void;
     accessForDoc(id: Identifier, doc_id: DocumentId): Promise<Access | undefined>;
-    addMember(to_add: Agent, membered: Membered, access: Access, other_relevant_docs: Document[]): Promise<AddMemberUpdate>;
+    addMember(to_add: Agent, membered: Membered, access: Access, other_relevant_docs: Document[]): Promise<SignedDelegation>;
     /**
      * Returns all agent events with deduplicated storage and two-tier indirection
      * for membership, prekey, and CGKA ops.
@@ -314,14 +329,9 @@ export class Keyhive {
     /**
      * Force a PCS key rotation and return the new leaf secret, serialized as a
      * one-entry `BTreeMap<ShareKey, ShareSecretKey>` (the exact format
-     * `importPrekeySecrets` accepts). A sibling instance of this identity can
-     * install it to derive the rotated key without re-importing the whole bundle.
+     * `importPrekeySecrets` accepts).
      */
     forcePcsUpdate(doc: Document): Promise<Uint8Array>;
-    /**
-     * Generate a document. Whether it provides forward secrecy is determined by
-     * this peer's forward-secrecy policy (chosen at `Keyhive.init`).
-     */
     generateDocument(coparents: Peer[], initial_content_ref_head: ChangeId, more_initial_content_refs: ChangeId[]): Promise<Document>;
     generateGroup(js_coparents: Peer[]): Promise<Group>;
     getAgent(id: Identifier): Promise<Agent | undefined>;
@@ -332,16 +342,7 @@ export class Keyhive {
     importPrekeySecrets(bytes: Uint8Array): Promise<void>;
     ingestArchive(archive: Archive): Promise<void>;
     ingestEventsBytes(events_bytes_array: Array<any>): Promise<Array<any>>;
-    /**
-     * Initialize a peer.
-     *
-     * `forward_secrecy` is this peer's policy for all documents it creates or
-     * receives. When `false`, documents carry the CGKA predecessor key chain
-     * (a member added later reads the whole prior history) and adding a reader
-     * auto-rekeys (see `addMember`'s `leafSecrets`). When `true`, a member
-     * added later cannot read content from before they joined.
-     */
-    static init(signer: Signer, ciphertext_store: CiphertextStore, event_handler: Function, forward_secrecy: boolean): Promise<Keyhive>;
+    static init(signer: Signer, ciphertext_store: CiphertextStore, event_handler: Function): Promise<Keyhive>;
     intoArchive(): Promise<Archive>;
     membershipOpsForAgent(agent: Agent): Promise<Map<any, any>>;
     pendingEventHashes(): Promise<Set<any>>;
@@ -353,8 +354,17 @@ export class Keyhive {
     stats(): Promise<Stats>;
     toArchive(): Promise<Archive>;
     tryDecrypt(doc: Document, encrypted: Encrypted): Promise<Uint8Array>;
+    /**
+     * Decrypt content and also return the 32-byte application secret key used.
+     */
+    tryDecryptKeyed(doc: Document, encrypted: Encrypted): Promise<DecryptedKeyed>;
     tryEncrypt(doc: Document, content_ref: ChangeId, js_pred_refs: ChangeId[], content: Uint8Array): Promise<EncryptedContentWithUpdate>;
     tryEncryptArchive(doc: Document, content_ref: ChangeId, pred_refs: ChangeId[], content: Uint8Array): Promise<EncryptedContentWithUpdate>;
+    /**
+     * Encrypt content and also return the application secret key it was
+     * encrypted under.
+     */
+    tryEncryptKeyed(doc: Document, content_ref: ChangeId, js_pred_refs: ChangeId[], content: Uint8Array): Promise<EncryptedKeyed>;
     tryPcsKeyHash(doc: Document): Promise<Uint8Array | undefined>;
     trySign(data: Uint8Array): Promise<Signed>;
     readonly id: IndividualId;
@@ -514,3 +524,13 @@ export class Summary {
  * https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/template-deep-dive/src-utils-rs.html#2-what-is-console_error_panic_hook
  */
 export function setPanicHook(): void;
+
+/**
+ * Inverse of [`symmetric_encrypt`]. Reads `nonce(24) || ciphertext`.
+ */
+export function symmetricDecrypt(key: Uint8Array, blob: Uint8Array): Uint8Array;
+
+/**
+ * Encrypt `plaintext` under a 32-byte `key`, returning `nonce(24) || ciphertext`.
+ */
+export function symmetricEncrypt(key: Uint8Array, plaintext: Uint8Array, associated_data: Uint8Array): Uint8Array;

package/pkg/keyhive_wasm.js

@@ -5,5 +5,5 @@ import { __wbg_set_wasm } from "./keyhive_wasm_bg.js";
 __wbg_set_wasm(wasm);
 wasm.__wbindgen_start();
 export {
-    Access, AddMemberUpdate, Agent, AllAgentEvents, Archive, CannotParseEd25519SigningKey, CannotParseIdentifier, Capability, CgkaOperation, ChangeId, CiphertextStore, ContactCard, Delegation, DocContentRefs, Document, DocumentId, Encrypted, EncryptedContentWithUpdate, Event, GenerateWebCryptoError, Group, GroupId, History, Identifier, Individual, IndividualId, Invocation, Keyhive, Membered, Membership, Peer, Revocation, ShareKey, Signed, SignedCgkaOperation, SignedDelegation, SignedInvocation, SignedRevocation, Signer, Stats, Summary, setPanicHook
+    Access, Agent, AllAgentEvents, Archive, CannotParseEd25519SigningKey, CannotParseIdentifier, Capability, CgkaOperation, ChangeId, CiphertextStore, ContactCard, DecryptedKeyed, Delegation, DocContentRefs, Document, DocumentId, Encrypted, EncryptedContentWithUpdate, EncryptedKeyed, Event, GenerateWebCryptoError, Group, GroupId, History, Identifier, Individual, IndividualId, Invocation, Keyhive, Membered, Membership, Peer, Revocation, ShareKey, Signed, SignedCgkaOperation, SignedDelegation, SignedInvocation, SignedRevocation, Signer, Stats, Summary, setPanicHook, symmetricDecrypt, symmetricEncrypt
 } from "./keyhive_wasm_bg.js";