Merge pull request #18 from NodeFactoryIo/feature/noise-pipes

Noise pipes

src/handshake-ik.ts

@@ -24,6 +24,7 @@ export class IKHandshake implements IHandshake {
     staticKeypair: KeyPair,
     connection: WrappedConnection,
     remotePeer: PeerId,
+    remoteStaticKey: bytes,
     handshake?: IK,
   ) {
     this.isInitiator = isInitiator;
@@ -34,11 +35,7 @@ export class IKHandshake implements IHandshake {
     this.remotePeer = remotePeer;
 
     this.ik = handshake || new IK();
-
-    // Dummy data
-    // TODO: Load remote static keys if found
-    const remoteStaticKeys = this.staticKeypair;
-    this.session = this.ik.initSession(this.isInitiator, this.prologue, this.staticKeypair, remoteStaticKeys.publicKey);
+    this.session = this.ik.initSession(this.isInitiator, this.prologue, this.staticKeypair, remoteStaticKey);
   }
 
   public decrypt(ciphertext: Buffer, session: NoiseSession): Buffer {

src/handshake-xx.ts

@@ -114,6 +114,10 @@ export class XXHandshake implements IHandshake {
     return this.xx.decryptWithAd(cs, Buffer.alloc(0), ciphertext);
   }
 
+  public getRemoteStaticKey(): bytes {
+    return this.session.hs.rs;
+  }
+
   private getCS(session: NoiseSession, encryption = true) {
     if (!session.cs1 || !session.cs2) {
       throw new Error("Handshake not completed properly, cipher state does not exist.");

src/handshakes/xx.ts

@@ -145,7 +145,6 @@ export class XX extends AbstractHandshake {
       session.h = h;
       session.cs1 = cs1;
       session.cs2 = cs2;
-      delete session.hs;
     } else if (session.mc.gtn(2)) {
       if (session.i) {
         if (!session.cs1) {

src/keycache.ts

@@ -0,0 +1,27 @@
+import {PeerId} from "./@types/libp2p";
+import {bytes, bytes32} from "./@types/basic";
+
+/**
+ * Storage for static keys of previously connected peers.
+ */
+class Keycache {
+  private storage = new Map<bytes, bytes32>();
+
+  public async store(peerId: PeerId, key: bytes32): Promise<void> {
+    this.storage.set(peerId.id, key);
+  }
+
+  public async load(peerId: PeerId): Promise<bytes32|null> {
+    return this.storage.get(peerId.id) || null;
+  }
+
+  public resetStorage(): void {
+    this.storage.clear();
+  }
+
+}
+
+const KeyCache = new Keycache();
+export {
+  KeyCache,
+}

src/noise.ts

@@ -16,6 +16,8 @@ import { bytes } from "./@types/basic";
 import { INoiseConnection, PeerId, KeyPair, SecureOutbound } from "./@types/libp2p";
 import { Duplex } from "./@types/it-pair";
 import {IHandshake} from "./@types/handshake-interface";
+import {KeyCache} from "./keycache";
+import {logger} from "./logger";
 
 export type WrappedConnection = ReturnType<typeof Wrap>;
 
@@ -32,9 +34,11 @@ export class Noise implements INoiseConnection {
   private readonly prologue = Buffer.from(this.protocol);
   private readonly staticKeys: KeyPair;
   private readonly earlyData?: bytes;
+  private useNoisePipes: boolean;
 
-  constructor(staticNoiseKey?: bytes, earlyData?: bytes) {
+  constructor(staticNoiseKey?: bytes, earlyData?: bytes, useNoisePipes = true) {
     this.earlyData = earlyData || Buffer.alloc(0);
+    this.useNoisePipes = useNoisePipes;
 
     if (staticNoiseKey) {
       const publicKey = x25519.publicKeyCreate(staticNoiseKey); // TODO: verify this
@@ -95,27 +99,35 @@ export class Noise implements INoiseConnection {
 
   /**
    * If Noise pipes supported, tries IK handshake first with XX as fallback if it fails.
-   * If remote peer static key is unknown, use XX.
+   * If noise pipes disabled or remote peer static key is unknown, use XX.
    * @param connection
    * @param isInitiator
    * @param libp2pPublicKey
    * @param remotePeer
    */
   private async performHandshake(params: HandshakeParams): Promise<IHandshake> {
-    // TODO: Implement noise pipes
     const payload = await getPayload(params.localPeer, this.staticKeys.publicKey, this.earlyData);
 
-    if (false) {
-      let IKhandshake;
+    let foundRemoteStaticKey: bytes|null = null;
+    if (this.useNoisePipes && params.isInitiator) {
+      logger("Initiator using noise pipes. Going to load cached static key...");
+      foundRemoteStaticKey = await KeyCache.load(params.remotePeer);
+      logger(`Static key has been found: ${!!foundRemoteStaticKey}`)
+    }
+
+    if (foundRemoteStaticKey) {
+      // Try IK first
+      const { remotePeer, connection, isInitiator } = params;
+      const IKhandshake = new IKHandshake(isInitiator, payload, this.prologue, this.staticKeys, connection, remotePeer, foundRemoteStaticKey);
       try {
-        IKhandshake = await this.performIKHandshake(params, payload);
-        return IKhandshake;
+        return await this.performIKHandshake(IKhandshake, payload);
       } catch (e) {
-        // XX fallback
+        // IK failed, go to XX fallback
         const ephemeralKeys = IKhandshake.getRemoteEphemeralKeys();
         return await this.performXXFallbackHandshake(params, payload, ephemeralKeys, e.initialMsg);
       }
     } else {
+      // Noise pipes not supported, use XX
       return await this.performXXHandshake(params, payload);
     }
   }
@@ -152,6 +164,10 @@ export class Noise implements INoiseConnection {
       await handshake.propose();
       await handshake.exchange();
       await handshake.finish();
+
+      if (this.useNoisePipes) {
+        await KeyCache.store(remotePeer, handshake.getRemoteStaticKey());
+      }
     } catch (e) {
       throw new Error(`Error occurred during XX handshake: ${e.message}`);
     }
@@ -160,12 +176,9 @@ export class Noise implements INoiseConnection {
   }
 
   private async performIKHandshake(
-    params: HandshakeParams,
+    handshake: IKHandshake,
     payload: bytes,
   ): Promise<IKHandshake> {
-    const { isInitiator, remotePeer, connection } = params;
-    const handshake = new IKHandshake(isInitiator, payload, this.prologue, this.staticKeys, connection, remotePeer);
-
     // TODO
 
     return handshake;

test/keycache.test.ts

@@ -0,0 +1,34 @@
+import { expect, assert } from "chai";
+import { KeyCache } from "../src/keycache";
+import {createPeerIds, createPeerIdsFromFixtures} from "./fixtures/peer";
+
+describe("KeyCache", () => {
+  let peerA, peerB;
+
+  before(async () => {
+    [peerA, peerB] = await createPeerIdsFromFixtures(2);
+  });
+
+  it("should store and load same key successfully", async() => {
+    try {
+      const key = Buffer.from("this is id 007");
+      await KeyCache.store(peerA, key);
+      const result = await KeyCache.load(peerA);
+      assert(result.equals(key), "Stored and loaded key are not the same");
+    } catch (e) {
+      console.error(e);
+      assert(false, `Test failed - ${e.message}`)
+    }
+  });
+
+  it("should return undefined if key not found", async() => {
+    try {
+      const [newPeer] = await createPeerIds(1);
+      const result = await KeyCache.load(newPeer);
+      assert(!result);
+    } catch (e) {
+      console.error(e);
+      assert(false, `Test failed - ${e.message}`)
+    }
+  });
+});

test/noise.test.ts

@@ -26,8 +26,8 @@ describe("Noise", () => {
 
   it("should communicate through encrypted streams", async() => {
     try {
-      const noiseInit = new Noise();
-      const noiseResp = new Noise();
+      const noiseInit = new Noise(undefined, undefined, false);
+      const noiseResp = new Noise(undefined, undefined, false);
 
       const [inboundConnection, outboundConnection] = DuplexPair();
       const [outbound, inbound] = await Promise.all([
@@ -46,7 +46,7 @@ describe("Noise", () => {
   });
 
   it("should test that secureOutbound is spec compliant", async() => {
-    const noiseInit = new Noise();
+    const noiseInit = new Noise(undefined, undefined, false);
     const [inboundConnection, outboundConnection] = DuplexPair();
 
     const [outbound, { wrapped, handshake }] = await Promise.all([
@@ -99,8 +99,8 @@ describe("Noise", () => {
 
   it("should test large payloads", async() => {
     try {
-      const noiseInit = new Noise();
-      const noiseResp = new Noise();
+      const noiseInit = new Noise(undefined, undefined, false);
+      const noiseResp = new Noise(undefined, undefined, false);
 
       const [inboundConnection, outboundConnection] = DuplexPair();
       const [outbound, inbound] = await Promise.all([