js-noise/src/patterns.ts

import { Hash } from "@stablelib/hash";
import { SHA256 } from "@stablelib/sha256";

import { DHKey } from "./crypto";
import { DH25519 } from "./dh25519";

/**
 * The Noise tokens appearing in Noise (pre)message patterns
 * as in http://www.noiseprotocol.org/noise.html#handshake-pattern-basics
 */
export enum NoiseTokens {
  e = "e",
  s = "s",
  es = "es",
  ee = "ee",
  se = "se",
  ss = "ss",
  psk = "psk",
}

/**
 * The direction of a (pre)message pattern in canonical form (i.e. Alice-initiated form)
 * as in http://www.noiseprotocol.org/noise.html#alice-and-bob
 */
export enum MessageDirection {
  r = "->",
  l = "<-",
}

/**
 * The pre message pattern consisting of a message direction and some Noise tokens, if any.
 * (if non empty, only tokens e and s are allowed: http://www.noiseprotocol.org/noise.html#handshake-pattern-basics)
 */
export class PreMessagePattern {
  constructor(public readonly direction: MessageDirection, public readonly tokens: Array<NoiseTokens>) {}

  /**
   * Check PreMessagePattern equality
   * @param other object to compare against
   * @returns true if equal, false otherwise
   */
  equals(other: PreMessagePattern): boolean {
    return (
      this.direction == other.direction &&
      this.tokens.length === other.tokens.length &&
      this.tokens.every((val, index) => val === other.tokens[index])
    );
  }
}

/**
 * The message pattern consisting of a message direction and some Noise tokens
 * All Noise tokens are allowed
 */
export class MessagePattern {
  constructor(public readonly direction: MessageDirection, public readonly tokens: Array<NoiseTokens>) {}

  /**
   * Check MessagePattern equality
   * @param other object to compare against
   * @returns true if equal, false otherwise
   */
  equals(other: MessagePattern): boolean {
    return (
      this.direction == other.direction &&
      this.tokens.length === other.tokens.length &&
      this.tokens.every((val, index) => val === other.tokens[index])
    );
  }
}

/**
 * The handshake pattern object. It stores the handshake protocol name, the
 * handshake pre message patterns and the handshake message patterns
 */
export class HandshakePattern {
  public readonly dhKey: DHKey;

  constructor(
    public readonly name: string,
    dhKeyType: new () => DHKey,
    public readonly hash: new () => Hash,
    public readonly preMessagePatterns: Array<PreMessagePattern>,
    public readonly messagePatterns: Array<MessagePattern>
  ) {
    this.dhKey = new dhKeyType();
  }

  /**
   * Check HandshakePattern equality
   * @param other object to compare against
   * @returns true if equal, false otherwise
   */
  equals(other: HandshakePattern): boolean {
    if (this.preMessagePatterns.length != other.preMessagePatterns.length) return false;
    for (let i = 0; i < this.preMessagePatterns.length; i++) {
      if (!this.preMessagePatterns[i].equals(other.preMessagePatterns[i])) return false;
    }

    if (this.messagePatterns.length != other.messagePatterns.length) return false;
    for (let i = 0; i < this.messagePatterns.length; i++) {
      if (!this.messagePatterns[i].equals(other.messagePatterns[i])) return false;
    }

    return this.name == other.name;
  }
}

/**
 * Supported Noise handshake patterns as defined in https://rfc.vac.dev/spec/35/#specification
 */
export const NoiseHandshakePatterns: Record<string, HandshakePattern> = {
  Noise_K1K1_25519_ChaChaPoly_SHA256: new HandshakePattern(
    "Noise_K1K1_25519_ChaChaPoly_SHA256",
    DH25519,
    SHA256,
    [
      new PreMessagePattern(MessageDirection.r, [NoiseTokens.s]),
      new PreMessagePattern(MessageDirection.l, [NoiseTokens.s]),
    ],
    [
      new MessagePattern(MessageDirection.r, [NoiseTokens.e]),
      new MessagePattern(MessageDirection.l, [NoiseTokens.e, NoiseTokens.ee, NoiseTokens.es]),
      new MessagePattern(MessageDirection.r, [NoiseTokens.se]),
    ]
  ),
  Noise_XK1_25519_ChaChaPoly_SHA256: new HandshakePattern(
    "Noise_XK1_25519_ChaChaPoly_SHA256",
    DH25519,
    SHA256,
    [new PreMessagePattern(MessageDirection.l, [NoiseTokens.s])],
    [
      new MessagePattern(MessageDirection.r, [NoiseTokens.e]),
      new MessagePattern(MessageDirection.l, [NoiseTokens.e, NoiseTokens.ee, NoiseTokens.es]),
      new MessagePattern(MessageDirection.r, [NoiseTokens.s, NoiseTokens.se]),
    ]
  ),
  Noise_XX_25519_ChaChaPoly_SHA256: new HandshakePattern(
    "Noise_XX_25519_ChaChaPoly_SHA256",
    DH25519,
    SHA256,
    [],
    [
      new MessagePattern(MessageDirection.r, [NoiseTokens.e]),
      new MessagePattern(MessageDirection.l, [NoiseTokens.e, NoiseTokens.ee, NoiseTokens.s, NoiseTokens.es]),
      new MessagePattern(MessageDirection.r, [NoiseTokens.s, NoiseTokens.se]),
    ]
  ),
  Noise_XXpsk0_25519_ChaChaPoly_SHA256: new HandshakePattern(
    "Noise_XXpsk0_25519_ChaChaPoly_SHA256",
    DH25519,
    SHA256,
    [],
    [
      new MessagePattern(MessageDirection.r, [NoiseTokens.psk, NoiseTokens.e]),
      new MessagePattern(MessageDirection.l, [NoiseTokens.e, NoiseTokens.ee, NoiseTokens.s, NoiseTokens.es]),
      new MessagePattern(MessageDirection.r, [NoiseTokens.s, NoiseTokens.se]),
    ]
  ),
  Noise_WakuPairing_25519_ChaChaPoly_SHA256: new HandshakePattern(
    "Noise_WakuPairing_25519_ChaChaPoly_SHA256",
    DH25519,
    SHA256,
    [new PreMessagePattern(MessageDirection.l, [NoiseTokens.e])],
    [
      new MessagePattern(MessageDirection.r, [NoiseTokens.e, NoiseTokens.ee]),
      new MessagePattern(MessageDirection.l, [NoiseTokens.s, NoiseTokens.es]),
      new MessagePattern(MessageDirection.r, [NoiseTokens.s, NoiseTokens.se, NoiseTokens.ss]),
    ]
  ),
};

/**
 * Supported Protocol ID for PayloadV2 objects
 * Protocol IDs are defined according to https://rfc.vac.dev/spec/35/#specification
 */
export const PayloadV2ProtocolIDs: { [id: string]: number } = {
  "": 0,
  Noise_K1K1_25519_ChaChaPoly_SHA256: 10,
  Noise_XK1_25519_ChaChaPoly_SHA256: 11,
  Noise_XX_25519_ChaChaPoly_SHA256: 12,
  Noise_XXpsk0_25519_ChaChaPoly_SHA256: 13,
  Noise_WakuPairing_25519_ChaChaPoly_SHA256: 14,
  ChaChaPoly: 30,
};