nostr-double-ratchet 0.0.1 → 0.0.3

package/README.md

@@ -1,4 +1,7 @@
-* WIP: Double ratchet on nostr
-* currently only single DH ratchet (but it already provides forward & backward secrecy)
-* invite links for securely exchanging session keys. don't use your long-term key for initiating a session.
-* check out [tests](./tests/) for usage
+* Double ratchet on nostr
+- [x] 1-on-1 channel
+- [ ] group channel
+* Invite links for securely exchanging session keys. don't use your long-term key for initiating a session.
+* Breaking changes are likely
+* Stable version on [NPM](https://www.npmjs.com/package/nostr-double-ratchet)
+* check out [tests](./tests/) for usage

package/dist/Channel.d.ts

@@ -1,24 +1,32 @@
 import { VerifiedEvent } from "nostr-tools";
-import { ChannelState, Unsubscribe, NostrSubscribe, MessageCallback, KeyPair, Sender, KeyType } from "./types";
+import { ChannelState, Unsubscribe, NostrSubscribe, MessageCallback } from "./types";
+/**
+ * Similar to Signal's "Double Ratchet with header encryption"
+ * https://signal.org/docs/specifications/doubleratchet/
+ */
 export declare class Channel {
     private nostrSubscribe;
     state: ChannelState;
-    nostrUnsubscribe: Unsubscribe | undefined;
-    nostrNextUnsubscribe: Unsubscribe | undefined;
-    currentInternalSubscriptionId: number;
-    internalSubscriptions: Map<number, MessageCallback>;
+    private nostrUnsubscribe?;
+    private nostrNextUnsubscribe?;
+    private internalSubscriptions;
+    private currentInternalSubscriptionId;
     name: string;
     constructor(nostrSubscribe: NostrSubscribe, state: ChannelState);
     /**
-     * To preserve forward secrecy, do not use long-term keys for channel initialization. Use e.g. InviteLink to exchange session keys.
+     * @param sharedSecret optional, but useful to keep the first chain of messages secure. Unlike the Nostr keys, it can be forgotten after the 1st message in the chain.
+     * @param isInitiator determines which chain key is used for sending vs receiving
      */
-    static init(nostrSubscribe: NostrSubscribe, theirCurrentNostrPublicKey: string, ourCurrentPrivateKey: Uint8Array, name?: string): Channel;
-    updateTheirCurrentNostrPublicKey(theirNewPublicKey: string): void;
-    private rotateOurCurrentNostrKey;
-    getNostrSenderKeypair(sender: Sender, keyType: KeyType): KeyPair;
-    private nostrSubscribeNext;
-    private subscribeToNostrEvents;
-    onMessage(callback: MessageCallback): Unsubscribe;
+    static init(nostrSubscribe: NostrSubscribe, theirNostrPublicKey: string, ourCurrentPrivateKey: Uint8Array, sharedSecret?: Uint8Array, name?: string, isInitiator?: boolean): Channel;
     send(data: string): VerifiedEvent;
+    onMessage(callback: MessageCallback): Unsubscribe;
+    private ratchetEncrypt;
+    private ratchetDecrypt;
+    private ratchetStep;
+    private skipMessageKeys;
+    private trySkippedMessageKeys;
+    private decryptHeader;
+    private handleNostrEvent;
+    private subscribeToNostrEvents;
 }
 //# sourceMappingURL=Channel.d.ts.map

package/dist/Channel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Channel.d.ts","sourceRoot":"","sources":["../src/Channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyD,aAAa,EAAE,MAAM,aAAa,CAAC;AAEnG,OAAO,EACL,YAAY,EAEZ,WAAW,EACX,cAAc,EACd,eAAe,EAEf,OAAO,EACP,MAAM,EACN,OAAO,EACR,MAAM,SAAS,CAAC;AAGjB,qBAAa,OAAO;IAON,OAAO,CAAC,cAAc;IAAyB,KAAK,EAAE,YAAY;IAN9E,gBAAgB,EAAE,WAAW,GAAG,SAAS,CAAA;IACzC,oBAAoB,EAAE,WAAW,GAAG,SAAS,CAAA;IAC7C,6BAA6B,SAAI;IACjC,qBAAqB,+BAAqC;IAC1D,IAAI,SAA6C;gBAE7B,cAAc,EAAE,cAAc,EAAS,KAAK,EAAE,YAAY;IAI9E;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,cAAc,EAAE,0BAA0B,EAAE,MAAM,EAAE,oBAAoB,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO;IAoBzI,gCAAgC,CAAC,iBAAiB,EAAE,MAAM;IAU1D,OAAO,CAAC,wBAAwB;IAShC,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO;IAchE,OAAO,CAAC,kBAAkB;IAiB1B,OAAO,CAAC,sBAAsB;IAiB9B,SAAS,CAAC,QAAQ,EAAE,eAAe,GAAG,WAAW;IAOjD,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa;CAmBlC"}
+{"version":3,"file":"Channel.d.ts","sourceRoot":"","sources":["../src/Channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyD,aAAa,EAAE,MAAM,aAAa,CAAC;AAEnG,OAAO,EACL,YAAY,EAEZ,WAAW,EACX,cAAc,EACd,eAAe,EAEhB,MAAM,SAAS,CAAC;AAKjB;;;GAGG;AACH,qBAAa,OAAO;IAON,OAAO,CAAC,cAAc;IAAyB,KAAK,EAAE,YAAY;IAN9E,OAAO,CAAC,gBAAgB,CAAC,CAAc;IACvC,OAAO,CAAC,oBAAoB,CAAC,CAAc;IAC3C,OAAO,CAAC,qBAAqB,CAAsC;IACnE,OAAO,CAAC,6BAA6B,CAAK;IACnC,IAAI,EAAE,MAAM,CAAC;gBAEA,cAAc,EAAE,cAAc,EAAS,KAAK,EAAE,YAAY;IAI9E;;;OAGG;IACH,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,EAAE,oBAAoB,EAAE,UAAU,EAAE,YAAY,aAAmB,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,WAAW,UAAO,GAAG,OAAO;IA6BvL,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa;IAoBjC,SAAS,CAAC,QAAQ,EAAE,eAAe,GAAG,WAAW;IAOjD,OAAO,CAAC,cAAc;IAYtB,OAAO,CAAC,cAAc;IAuBtB,OAAO,CAAC,WAAW;IAwBnB,OAAO,CAAC,eAAe;IAavB,OAAO,CAAC,qBAAqB;IAU7B,OAAO,CAAC,aAAa;IAuBrB,OAAO,CAAC,gBAAgB;IAuBxB,OAAO,CAAC,sBAAsB;CAa/B"}

package/dist/InviteLink.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InviteLink.d.ts","sourceRoot":"","sources":["../src/InviteLink.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyD,aAAa,EAAS,MAAM,aAAa,CAAC;AAE1G,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE3D;;;;;;;;;;GAUG;AACH,qBAAa,UAAU;IAER,uBAAuB,EAAE,MAAM;IAC/B,UAAU,EAAE,MAAM;IAClB,OAAO,EAAE,MAAM;IACf,wBAAwB,CAAC,EAAE,UAAU;IACrC,KAAK,CAAC,EAAE,MAAM;IACd,OAAO,CAAC,EAAE,MAAM;IAChB,MAAM,EAAE,MAAM,EAAE;gBANhB,uBAAuB,EAAE,MAAM,EAC/B,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,EACf,wBAAwB,CAAC,EAAE,UAAU,YAAA,EACrC,KAAK,CAAC,EAAE,MAAM,YAAA,EACd,OAAO,CAAC,EAAE,MAAM,YAAA,EAChB,MAAM,GAAE,MAAM,EAAO;IAGhC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,UAAU;IAc/E,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU;IA6BvC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU;IAa5C,SAAS,IAAI,MAAM;IAYnB,MAAM,CAAC,IAAI,SAAoB;IAO/B;;;;;;;;;;;;;;OAcG;IACG,YAAY,CACd,cAAc,EAAE,cAAc,EAC9B,gBAAgB,EAAE,MAAM,EACxB,gBAAgB,EAAE,UAAU,GAAG,eAAe,GAC/C,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,aAAa,CAAA;KAAE,CAAC;IAiCtD,MAAM,CAAC,gBAAgB,EAAE,UAAU,GAAG,eAAe,EAAE,cAAc,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,WAAW;CAkChK"}
+{"version":3,"file":"InviteLink.d.ts","sourceRoot":"","sources":["../src/InviteLink.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyD,aAAa,EAAS,MAAM,aAAa,CAAC;AAE1G,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE3D;;;;;;;;;;GAUG;AACH,qBAAa,UAAU;IAER,uBAAuB,EAAE,MAAM;IAC/B,UAAU,EAAE,MAAM;IAClB,OAAO,EAAE,MAAM;IACf,wBAAwB,CAAC,EAAE,UAAU;IACrC,KAAK,CAAC,EAAE,MAAM;IACd,OAAO,CAAC,EAAE,MAAM;IAChB,MAAM,EAAE,MAAM,EAAE;gBANhB,uBAAuB,EAAE,MAAM,EAC/B,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,EACf,wBAAwB,CAAC,EAAE,UAAU,YAAA,EACrC,KAAK,CAAC,EAAE,MAAM,YAAA,EACd,OAAO,CAAC,EAAE,MAAM,YAAA,EAChB,MAAM,GAAE,MAAM,EAAO;IAGhC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,UAAU;IAc/E,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU;IA6BvC,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU;IAa5C,SAAS,IAAI,MAAM;IAYnB,MAAM,CAAC,IAAI,SAAoB;IAO/B;;;;;;;;;;;;;;OAcG;IACG,YAAY,CACd,cAAc,EAAE,cAAc,EAC9B,gBAAgB,EAAE,MAAM,EACxB,gBAAgB,EAAE,UAAU,GAAG,eAAe,GAC/C,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,aAAa,CAAA;KAAE,CAAC;IAiCtD,MAAM,CAAC,gBAAgB,EAAE,UAAU,GAAG,eAAe,EAAE,cAAc,EAAE,cAAc,EAAE,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,WAAW;CAmChK"}