handshake-ik.ts

import type { PeerId } from '@libp2p/interface-peer-id'
import type { ProtobufStream } from 'it-pb-stream'
import type { CipherState, NoiseSession } from './@types/handshake.js'
import type { bytes, bytes32 } from './@types/basic.js'
import type { KeyPair } from './@types/libp2p.js'
import type { IHandshake } from './@types/handshake-interface.js'
import type { ICryptoInterface } from './crypto.js'
import { IK } from './handshakes/ik.js'
import { decode0, decode1, encode0, encode1 } from './encoder.js'
import { FailedIKError } from './errors.js'
import {
  logger,
  logLocalStaticKeys,
  logRemoteStaticKey,
  logLocalEphemeralKeys,
  logRemoteEphemeralKey,
  logCipherState
} from './logger.js'
import { decodePayload, getPeerIdFromPayload, verifySignedPayload } from './utils.js'

export class IKHandshake implements IHandshake {
  public isInitiator: boolean
  public session: NoiseSession
  public remotePeer!: PeerId
  public remoteEarlyData: Uint8Array

  private readonly payload: bytes
  private readonly prologue: bytes32
  private readonly staticKeypair: KeyPair
  private readonly connection: ProtobufStream
  private readonly ik: IK

  constructor (
    isInitiator: boolean,
    payload: bytes,
    prologue: bytes32,
    crypto: ICryptoInterface,
    staticKeypair: KeyPair,
    connection: ProtobufStream,
    remoteStaticKey: bytes,
    remotePeer?: PeerId,
    handshake?: IK
  ) {
    this.isInitiator = isInitiator
    this.payload = payload
    this.prologue = prologue
    this.staticKeypair = staticKeypair
    this.connection = connection
    if (remotePeer) {
      this.remotePeer = remotePeer
    }
    this.ik = handshake ?? new IK(crypto)
    this.session = this.ik.initSession(this.isInitiator, this.prologue, this.staticKeypair, remoteStaticKey)
    this.remoteEarlyData = new Uint8Array()
  }

  public async stage0 (): Promise<void> {
    logLocalStaticKeys(this.session.hs.s)
    logRemoteStaticKey(this.session.hs.rs)
    if (this.isInitiator) {
      logger('IK Stage 0 - Initiator sending message...')
      const messageBuffer = this.ik.sendMessage(this.session, this.payload)
      this.connection.writeLP(encode1(messageBuffer))
      logger('IK Stage 0 - Initiator sent message.')
      logLocalEphemeralKeys(this.session.hs.e)
    } else {
      logger('IK Stage 0 - Responder receiving message...')
      const receivedMsg = await this.connection.readLP()
      try {
        const receivedMessageBuffer = decode1(receivedMsg.slice())
        const { plaintext, valid } = this.ik.recvMessage(this.session, receivedMessageBuffer)
        if (!valid) {
          throw new Error('ik handshake stage 0 decryption validation fail')
        }
        logger('IK Stage 0 - Responder got message, going to verify payload.')
        const decodedPayload = decodePayload(plaintext)
        this.remotePeer = this.remotePeer || await getPeerIdFromPayload(decodedPayload)
        await verifySignedPayload(this.session.hs.rs, decodedPayload, this.remotePeer)
        this.setRemoteEarlyData(decodedPayload.data)
        logger('IK Stage 0 - Responder successfully verified payload!')
        logRemoteEphemeralKey(this.session.hs.re)
      } catch (e) {
        const err = e as Error
        logger('Responder breaking up with IK handshake in stage 0.')

        throw new FailedIKError(receivedMsg.slice(), `Error occurred while verifying initiator's signed payload: ${err.message}`)
      }
    }
  }

  public async stage1 (): Promise<void> {
    if (this.isInitiator) {
      logger('IK Stage 1 - Initiator receiving message...')
      const receivedMsg = (await this.connection.readLP()).slice()
      const receivedMessageBuffer = decode0(receivedMsg)
      const { plaintext, valid } = this.ik.recvMessage(this.session, receivedMessageBuffer)
      logger('IK Stage 1 - Initiator got message, going to verify payload.')
      try {
        if (!valid) {
          throw new Error('ik stage 1 decryption validation fail')
        }
        const decodedPayload = decodePayload(plaintext)
        this.remotePeer = this.remotePeer || await getPeerIdFromPayload(decodedPayload)
        await verifySignedPayload(receivedMessageBuffer.ns.slice(0, 32), decodedPayload, this.remotePeer)
        this.setRemoteEarlyData(decodedPayload.data)
        logger('IK Stage 1 - Initiator successfully verified payload!')
        logRemoteEphemeralKey(this.session.hs.re)
      } catch (e) {
        const err = e as Error
        logger('Initiator breaking up with IK handshake in stage 1.')
        throw new FailedIKError(receivedMsg, `Error occurred while verifying responder's signed payload: ${err.message}`)
      }
    } else {
      logger('IK Stage 1 - Responder sending message...')
      const messageBuffer = this.ik.sendMessage(this.session, this.payload)
      this.connection.writeLP(encode0(messageBuffer))
      logger('IK Stage 1 - Responder sent message...')
      logLocalEphemeralKeys(this.session.hs.e)
    }
    logCipherState(this.session)
  }

  public decrypt (ciphertext: Uint8Array, session: NoiseSession): {plaintext: bytes, valid: boolean} {
    const cs = this.getCS(session, false)
    return this.ik.decryptWithAd(cs, new Uint8Array(0), ciphertext)
  }

  public encrypt (plaintext: Uint8Array, session: NoiseSession): bytes {
    const cs = this.getCS(session)
    return this.ik.encryptWithAd(cs, new Uint8Array(0), plaintext)
  }

  public getLocalEphemeralKeys (): KeyPair {
    if (!this.session.hs.e) {
      throw new Error('Ephemeral keys do not exist.')
    }

    return this.session.hs.e
  }

  private getCS (session: NoiseSession, encryption = true): CipherState {
    if (!session.cs1 || !session.cs2) {
      throw new Error('Handshake not completed properly, cipher state does not exist.')
    }

    if (this.isInitiator) {
      return encryption ? session.cs1 : session.cs2
    } else {
      return encryption ? session.cs2 : session.cs1
    }
  }

  private setRemoteEarlyData (data: Uint8Array|null|undefined): void {
    if (data) {
      this.remoteEarlyData = data
    }
  }
}