Class JPake

constructor

• new JPake(userId: string, otherInfo?: string[]): JPake

• Creates a new instance of the JPake protocol.

  Parameters

  • userId: string

    The unique identifier for the current user.
  • OptionalotherInfo: string[]

    Optional additional information to be included in the protocol.

  Returns JPake

  Throws

  If userId is empty.

ReadonlyuserId

deriveSharedKey

• deriveSharedKey(): Uint8Array

• Derives the shared key after completing Round 2. From RFC: When the second round finishes, Alice verifies the received ZKPs. Alice and Bob shall check that these new generators are not points at infinity. If the verification fails, the session is aborted. Otherwise, the two parties compute the common key material as follows: o Alice computes Ka = (B - (G4 x [x2*s])) x [x2]

  Returns Uint8Array

  The derived shared key.

  Throws

  If called in an invalid state, if required data is missing, or if verification fails.

getState

• getState(): JPakeState

• Returns JPakeState

  The current state of the J-PAKE transfer.

round1

• round1(): Round1Result

• Executes Round 1 of the J-PAKE protocol. From RFC: Round 1: Alice selects an ephemeral private key x1 uniformly at random from [0, q-1] and another ephemeral private key x2 uniformly at random from [1, q-1]. G1 = G x [x1], G2 = G x [x2] and ZKPs for x1 and x2

  Returns Round1Result

  The public values and proofs for Round 1.

  Throws

  If called in an invalid state or if generation fails.

round2

• round2(
      round1ResultBob: Round1Result,
      s: Uint8Array,
      bobUserId: string,
  ): Round2Result

• Executes Round 2 of the J-PAKE protocol. From RFC: When round 1 finishes, Alice verifies the received ZKPs as specified in [RFC8235]. The verifier shall check the prover's UserID is a valid identity and is different from its own identity. If the verification of the ZKP fails, the session is aborted. Then: Alice -> Bob: A = (G1 + G3 + G4) x [x2s] and a ZKP for x2s

  Parameters

  • round1ResultBob: Round1Result

    The Round 1 results received from Bob.
  • s: Uint8Array

    The shared secret (password) converted to a bigint.
  • bobUserId: string

    Bob's unique identifier.

  Returns Round2Result

  The public values and proofs for Round 2.

  Throws

  If called in an invalid state, if arguments are invalid, or if verification fails.

setRound2ResultFromBob

• setRound2ResultFromBob(round2ResultBob: Round2Result): void

• Sets the Round 2 results received from Bob.

  Parameters

  • round2ResultBob: Round2Result

    The Round 2 results received from Bob.

  Returns void

  Throws

  If called in an invalid state or if the received results are incomplete.