wallet-core/extension/lib/wallet/emscriptif.ts

/*
 This file is part of TALER
 (C) 2015 GNUnet e.V.

 TALER is free software; you can redistribute it and/or modify it under the
 terms of the GNU General Public License as published by the Free Software
 Foundation; either version 3, or (at your option) any later version.

 TALER is distributed in the hope that it will be useful, but WITHOUT ANY
 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

 You should have received a copy of the GNU General Public License along with
 TALER; see the file COPYING.  If not, If not, see <http://www.gnu.org/licenses/>
 */

import {AmountJson} from "./types";
import * as EmscWrapper from "../emscripten/emsc";

/**
 * High-level interface to emscripten-compiled modules used
 * by the wallet.
 * @module EmscriptIf
 * @author Florian Dold
 */

"use strict";

// Size of a native pointer.
const PTR_SIZE = 4;

const GNUNET_OK = 1;
const GNUNET_YES = 1;
const GNUNET_NO = 0;
const GNUNET_SYSERR = -1;

let Module = EmscWrapper.Module;

let getEmsc: EmscWrapper.EmscFunGen = (...args) => Module.cwrap.apply(null,
                                                                      args);

var emsc = {
  free: (ptr) => Module._free(ptr),
  get_value: getEmsc('TALER_WR_get_value',
                     'number',
                     ['number']),
  get_fraction: getEmsc('TALER_WR_get_fraction',
                        'number',
                        ['number']),
  get_currency: getEmsc('TALER_WR_get_currency',
                        'string',
                        ['number']),
  amount_add: getEmsc('TALER_amount_add',
                      'number',
                      ['number', 'number', 'number']),
  amount_subtract: getEmsc('TALER_amount_subtract',
                           'number',
                           ['number', 'number', 'number']),
  amount_normalize: getEmsc('TALER_amount_normalize',
                            'void',
                            ['number']),
  amount_get_zero: getEmsc('TALER_amount_get_zero',
                           'number',
                           ['string', 'number']),
  amount_cmp: getEmsc('TALER_amount_cmp',
                      'number',
                      ['number', 'number']),
  amount_hton: getEmsc('TALER_amount_hton',
                       'void',
                       ['number', 'number']),
  amount_ntoh: getEmsc('TALER_amount_ntoh',
                       'void',
                       ['number', 'number']),
  hash: getEmsc('GNUNET_CRYPTO_hash',
                'void',
                ['number', 'number', 'number']),
  memmove: getEmsc('memmove',
                   'number',
                   ['number', 'number', 'number']),
  rsa_public_key_free: getEmsc('GNUNET_CRYPTO_rsa_public_key_free',
                               'void',
                               ['number']),
  rsa_signature_free: getEmsc('GNUNET_CRYPTO_rsa_signature_free',
                              'void',
                              ['number']),
  string_to_data: getEmsc('GNUNET_STRINGS_string_to_data',
                          'number',
                          ['number', 'number', 'number', 'number']),
  eddsa_sign: getEmsc('GNUNET_CRYPTO_eddsa_sign',
                      'number',
                      ['number', 'number', 'number']),
  hash_create_random: getEmsc('GNUNET_CRYPTO_hash_create_random',
                              'void',
                              ['number', 'number']),
  rsa_blinding_key_destroy: getEmsc('GNUNET_CRYPTO_rsa_blinding_key_free',
                                    'void',
                                    ['number']),
};

var emscAlloc = {
  get_amount: getEmsc('TALER_WRALL_get_amount',
                      'number',
                      ['number', 'number', 'number', 'string']),
  eddsa_key_create: getEmsc('GNUNET_CRYPTO_eddsa_key_create',
                            'number', []),
  eddsa_public_key_from_private: getEmsc(
    'TALER_WRALL_eddsa_public_key_from_private',
    'number',
    ['number']),
  data_to_string_alloc: getEmsc('GNUNET_STRINGS_data_to_string_alloc',
                                'number',
                                ['number', 'number']),
  purpose_create: getEmsc('TALER_WRALL_purpose_create',
                          'number',
                          ['number', 'number', 'number']),
  rsa_blind: getEmsc('GNUNET_CRYPTO_rsa_blind',
                     'number',
                     ['number', 'number', 'number', 'number']),
  rsa_blinding_key_create: getEmsc('GNUNET_CRYPTO_rsa_blinding_key_create',
                                   'number',
                                   ['number']),
  rsa_blinding_key_encode: getEmsc('GNUNET_CRYPTO_rsa_blinding_key_encode',
                                   'number',
                                   ['number', 'number']),
  rsa_signature_encode: getEmsc('GNUNET_CRYPTO_rsa_signature_encode',
                                'number',
                                ['number', 'number']),
  rsa_blinding_key_decode: getEmsc('GNUNET_CRYPTO_rsa_blinding_key_decode',
                                   'number',
                                   ['number', 'number']),
  rsa_public_key_decode: getEmsc('GNUNET_CRYPTO_rsa_public_key_decode',
                                 'number',
                                 ['number', 'number']),
  rsa_signature_decode: getEmsc('GNUNET_CRYPTO_rsa_signature_decode',
                                'number',
                                ['number', 'number']),
  rsa_public_key_encode: getEmsc('GNUNET_CRYPTO_rsa_public_key_encode',
                                 'number',
                                 ['number', 'number']),
  rsa_unblind: getEmsc('GNUNET_CRYPTO_rsa_unblind',
                       'number',
                       ['number', 'number', 'number']),
  malloc: (size: number) => Module._malloc(size),
};


enum SignaturePurpose {
  RESERVE_WITHDRAW = 1200,
  WALLET_COIN_DEPOSIT = 1201,
}

enum RandomQuality {
  WEAK = 0,
  STRONG = 1,
  NONCE = 2
}


abstract class ArenaObject {
  private _nativePtr: number;
  arena: Arena;

  abstract destroy(): void;

  constructor(arena?: Arena) {
    this.nativePtr = null;
    if (!arena) {
      if (arenaStack.length == 0) {
        throw Error("No arena available")
      }
      arena = arenaStack[arenaStack.length - 1];
    }
    arena.put(this);
    this.arena = arena;
  }

  getNative(): number {
    // We want to allow latent allocation
    // of native wrappers, but we never want to
    // pass 'undefined' to emscripten.
    if (this._nativePtr === undefined) {
      throw Error("Native pointer not initialized");
    }
    return this._nativePtr;
  }

  free() {
    if (this.nativePtr !== undefined) {
      emsc.free(this.nativePtr);
      this.nativePtr = undefined;
    }
  }

  alloc(size: number) {
    if (this.nativePtr !== undefined) {
      throw Error("Double allocation");
    }
    this.nativePtr = emscAlloc.malloc(size);
  }

  setNative(n: number) {
    if (n === undefined) {
      throw Error("Native pointer must be a number or null");
    }
    this._nativePtr = n;
  }

  set nativePtr(v) {
    this.setNative(v);
  }

  get nativePtr() {
    return this.getNative();
  }

}

interface Arena {
  put(obj: ArenaObject): void;
  destroy(): void;
}

class DefaultArena implements Arena {
  heap: Array<ArenaObject>;

  constructor() {
    this.heap = [];
  }

  put(obj) {
    this.heap.push(obj);
  }

  destroy() {
    for (let obj of this.heap) {
      obj.destroy();
    }
    this.heap = []
  }
}


function mySetTimeout(ms: number, fn: () => void) {
  // We need to use different timeouts, depending on whether
  // we run in node or a web extension
  if ("function" === typeof setTimeout) {
    setTimeout(fn, ms);
  } else {
    chrome.extension.getBackgroundPage().setTimeout(fn, ms);
  }
}


/**
 * Arena that destroys all its objects once control has returned to the message
 * loop and a small interval has passed.
 */
class SyncArena extends DefaultArena {
  private isScheduled: boolean;

  constructor() {
    super();
  }

  pub(obj) {
    super.put(obj);
    if (!this.isScheduled) {
      this.schedule();
    }
    this.heap.push(obj);
  }

  destroy() {
    super.destroy();
  }

  private schedule() {
    this.isScheduled = true;
    mySetTimeout(50, () => {
      this.isScheduled = false;
      this.destroy();
    });
  }
}

let arenaStack: Arena[] = [];
arenaStack.push(new SyncArena());


export class Amount extends ArenaObject {
  constructor(args?: AmountJson, arena?: Arena) {
    super(arena);
    if (args) {
      this.nativePtr = emscAlloc.get_amount(args.value,
                                            0,
                                            args.fraction,
                                            args.currency);
    } else {
      this.nativePtr = emscAlloc.get_amount(0, 0, 0, "");
    }
  }

  destroy() {
    if (this.nativePtr != 0) {
      emsc.free(this.nativePtr);
    }
  }


  static getZero(currency: string, a?: Arena): Amount {
    let am = new Amount(null, a);
    let r = emsc.amount_get_zero(currency, am.getNative());
    if (r != GNUNET_OK) {
      throw Error("invalid currency");
    }
    return am;
  }


  toNbo(a?: Arena): AmountNbo {
    let x = new AmountNbo(a);
    x.alloc();
    emsc.amount_hton(x.nativePtr, this.nativePtr);
    return x;
  }

  fromNbo(nbo: AmountNbo): void {
    emsc.amount_ntoh(this.nativePtr, nbo.nativePtr);
  }

  get value() {
    return emsc.get_value(this.nativePtr);
  }

  get fraction() {
    return emsc.get_fraction(this.nativePtr);
  }

  get currency() {
    return emsc.get_currency(this.nativePtr);
  }

  toJson() {
    return {
      value: emsc.get_value(this.nativePtr),
      fraction: emsc.get_fraction(this.nativePtr),
      currency: emsc.get_currency(this.nativePtr)
    };
  }

  /**
   * Add an amount to this amount.
   */
  add(a) {
    let res = emsc.amount_add(this.nativePtr, a.nativePtr, this.nativePtr);
    if (res < 1) {
      // Overflow
      return false;
    }
    return true;
  }

  /**
   * Perform saturating subtraction on amounts.
   */
  sub(a) {
    // this = this - a
    let res = emsc.amount_subtract(this.nativePtr, this.nativePtr, a.nativePtr);
    if (res == 0) {
      // Underflow
      return false;
    }
    if (res > 0) {
      return true;
    }
    throw Error("Incompatible currencies");
  }

  cmp(a) {
    return emsc.amount_cmp(this.nativePtr, a.nativePtr);
  }

  normalize() {
    emsc.amount_normalize(this.nativePtr);
  }
}


abstract class PackedArenaObject extends ArenaObject {
  abstract size(): number;

  constructor(a?: Arena) {
    super(a);
  }

  toCrock(): string {
    var d = emscAlloc.data_to_string_alloc(this.nativePtr, this.size());
    var s = Module.Pointer_stringify(d);
    emsc.free(d);
    return s;
  }

  toJson(): any {
    // Per default, the json encoding of
    // packed arena objects is just the crockford encoding.
    // Subclasses typically want to override this.
    return this.toCrock();
  }

  loadCrock(s: string) {
    this.alloc();
    // We need to get the javascript string
    // to the emscripten heap first.
    let buf = ByteArray.fromString(s);
    let res = emsc.string_to_data(buf.nativePtr,
                                  s.length,
                                  this.nativePtr,
                                  this.size());
    buf.destroy();
    if (res < 1) {
      throw {error: "wrong encoding"};
    }
  }

  alloc() {
    if (this.nativePtr === null) {
      this.nativePtr = emscAlloc.malloc(this.size());
    }
  }

  destroy() {
    emsc.free(this.nativePtr);
    this.nativePtr = 0;
  }

  hash(): HashCode {
    var x = new HashCode();
    x.alloc();
    emsc.hash(this.nativePtr, this.size(), x.nativePtr);
    return x;
  }

  hexdump() {
    let bytes: string[] = [];
    for (let i = 0; i < this.size(); i++) {
      let b = Module.getValue(this.getNative() + i, "i8");
      b = (b + 256) % 256;
      bytes.push("0".concat(b.toString(16)).slice(-2));
    }
    let lines = [];
    for (let i = 0; i < bytes.length; i += 8) {
      lines.push(bytes.slice(i, i + 8).join(","));
    }
    return lines.join("\n");
  }
}


export class AmountNbo extends PackedArenaObject {
  size() {
    return 24;
  }

  toJson(): any {
    let a = new DefaultArena();
    let am = new Amount(null, a);
    am.fromNbo(this);
    let json = am.toJson();
    a.destroy();
    return json;
  }
}


export class EddsaPrivateKey extends PackedArenaObject {
  static create(a?: Arena): EddsaPrivateKey {
    let obj = new EddsaPrivateKey(a);
    obj.nativePtr = emscAlloc.eddsa_key_create();
    return obj;
  }

  size() {
    return 32;
  }

  getPublicKey(a?: Arena): EddsaPublicKey {
    let obj = new EddsaPublicKey(a);
    obj.nativePtr = emscAlloc.eddsa_public_key_from_private(this.nativePtr);
    return obj;
  }

  static fromCrock: (string) => EddsaPrivateKey;
}
mixinStatic(EddsaPrivateKey, fromCrock);


function fromCrock(s: string) {
  let x = new this();
  x.alloc();
  x.loadCrock(s);
  return x;
}


function mixin(obj, method, name?: string) {
  if (!name) {
    name = method.name;
  }
  if (!name) {
    throw Error("Mixin needs a name.");
  }
  obj.prototype[method.name] = method;
}


function mixinStatic(obj, method, name?: string) {
  if (!name) {
    name = method.name;
  }
  if (!name) {
    throw Error("Mixin needs a name.");
  }
  obj[method.name] = method;
}


export class EddsaPublicKey extends PackedArenaObject {
  size() {
    return 32;
  }

  static fromCrock: (s: string) => EddsaPublicKey;
}
mixinStatic(EddsaPublicKey, fromCrock);

function makeFromCrock(decodeFn: (p: number, s: number) => number) {
  function fromCrock(s: string, a?: Arena) {
    let obj = new this(a);
    let buf = ByteArray.fromCrock(s);
    obj.setNative(decodeFn(buf.getNative(),
                           buf.size()));
    buf.destroy();
    return obj;
  }

  return fromCrock;
}

function makeToCrock(encodeFn: (po: number,
                                ps: number) => number): () => string {
  function toCrock() {
    let ptr = emscAlloc.malloc(PTR_SIZE);
    let size = emscAlloc.rsa_blinding_key_encode(this.nativePtr, ptr);
    let res = new ByteArray(size, Module.getValue(ptr, '*'));
    let s = res.toCrock();
    emsc.free(ptr);
    res.destroy();
    return s;
  }

  return toCrock;
}

export class RsaBlindingKey extends ArenaObject {
  static create(len: number, a?: Arena) {
    let o = new RsaBlindingKey(a);
    o.nativePtr = emscAlloc.rsa_blinding_key_create(len);
    return o;
  }

  static fromCrock: (s: string, a?: Arena) => RsaBlindingKey;
  toCrock = makeToCrock(emscAlloc.rsa_blinding_key_encode);

  destroy() {
    // TODO
  }
}
mixinStatic(RsaBlindingKey, makeFromCrock(emscAlloc.rsa_blinding_key_decode));


export class HashCode extends PackedArenaObject {
  size() {
    return 64;
  }

  static fromCrock: (s: string) => HashCode;

  random(qualStr: string) {
    let qual: RandomQuality;
    switch (qualStr) {
      case "weak":
        qual = RandomQuality.WEAK;
        break;
      case "strong":
      case null:
      case undefined:
        qual = RandomQuality.STRONG;
        break;
      case "nonce":
        qual = RandomQuality.NONCE;
        break;
      default:
        throw Error(`unknown crypto quality: ${qual}`);
    }
    this.alloc();
    emsc.hash_create_random(qual, this.nativePtr);
  }
}
mixinStatic(HashCode, fromCrock);


export class ByteArray extends PackedArenaObject {
  private allocatedSize: number;

  size() {
    return this.allocatedSize;
  }

  constructor(desiredSize: number, init: number, a?: Arena) {
    super(a);
    if (init === undefined || init === null) {
      this.nativePtr = emscAlloc.malloc(desiredSize);
    } else {
      this.nativePtr = init;
    }
    this.allocatedSize = desiredSize;
  }

  static fromString(s: string, a?: Arena): ByteArray {
    let hstr = emscAlloc.malloc(s.length + 1);
    Module.writeStringToMemory(s, hstr);
    return new ByteArray(s.length, hstr, a);
  }

  static fromCrock(s: string, a?: Arena): ByteArray {
    let hstr = emscAlloc.malloc(s.length + 1);
    Module.writeStringToMemory(s, hstr);
    let decodedLen = Math.floor((s.length * 5) / 8);
    let ba = new ByteArray(decodedLen, null, a);
    let res = emsc.string_to_data(hstr, s.length, ba.nativePtr, decodedLen);
    emsc.free(hstr);
    if (res != GNUNET_OK) {
      throw Error("decoding failed");
    }
    return ba;
  }
}


export class EccSignaturePurpose extends PackedArenaObject {
  size() {
    return this.payloadSize + 8;
  }

  payloadSize: number;

  constructor(purpose: SignaturePurpose,
              payload: PackedArenaObject,
              a?: Arena) {
    super(a);
    this.nativePtr = emscAlloc.purpose_create(purpose,
                                              payload.nativePtr,
                                              payload.size());
    this.payloadSize = payload.size();
  }
}


abstract class SignatureStruct {
  abstract fieldTypes(): Array<any>;

  abstract purpose(): SignaturePurpose;

  private members: any = {};

  constructor(x: { [name: string]: any }) {
    for (let k in x) {
      this.set(k, x[k]);
    }
  }

  toPurpose(a?: Arena): EccSignaturePurpose {
    let totalSize = 0;
    for (let f of this.fieldTypes()) {
      let name = f[0];
      let member = this.members[name];
      if (!member) {
        throw Error(`Member ${name} not set`);
      }
      totalSize += member.size();
    }

    let buf = emscAlloc.malloc(totalSize);
    let ptr = buf;
    for (let f of this.fieldTypes()) {
      let name = f[0];
      let member = this.members[name];
      let size = member.size();
      emsc.memmove(ptr, member.nativePtr, size);
      ptr += size;
    }
    let ba = new ByteArray(totalSize, buf, a);
    return new EccSignaturePurpose(this.purpose(), ba);
  }


  toJson() {
    let res: any = {};
    for (let f of this.fieldTypes()) {
      let name = f[0];
      let member = this.members[name];
      if (!member) {
        throw Error(`Member ${name} not set`);
      }
      res[name] = member.toJson();
    }
    res["purpose"] = this.purpose();
    return res;
  }

  protected set(name: string, value: PackedArenaObject) {
    let typemap: any = {};
    for (let f of this.fieldTypes()) {
      typemap[f[0]] = f[1];
    }
    if (!(name in typemap)) {
      throw Error(`Key ${name} not found`);
    }
    if (!(value instanceof typemap[name])) {
      throw Error("Wrong type for ${name}");
    }
    this.members[name] = value;
  }
}


// It's redundant, but more type safe.
export interface WithdrawRequestPS_Args {
  reserve_pub: EddsaPublicKey;
  amount_with_fee: AmountNbo;
  withdraw_fee: AmountNbo;
  h_denomination_pub: HashCode;
  h_coin_envelope: HashCode;
}


export class WithdrawRequestPS extends SignatureStruct {
  constructor(w: WithdrawRequestPS_Args) {
    super(w);
  }

  purpose() {
    return SignaturePurpose.RESERVE_WITHDRAW;
  }

  fieldTypes() {
    return [
      ["reserve_pub", EddsaPublicKey],
      ["amount_with_fee", AmountNbo],
      ["withdraw_fee", AmountNbo],
      ["h_denomination_pub", HashCode],
      ["h_coin_envelope", HashCode]
    ];
  }
}


export class AbsoluteTimeNbo extends PackedArenaObject {
  static fromTalerString(s: string): AbsoluteTimeNbo {
    let x = new AbsoluteTimeNbo();
    x.alloc();
    let r = /Date\(([0-9]+)\)/;
    let m = r.exec(s);
    if (m.length != 2) {
      throw Error();
    }
    let n = parseInt(m[1]) * 1000000;
    // XXX: This only works up to 54 bit numbers.
    set64(x.getNative(), n);
    return x;
  }

  size() {
    return 8;
  }
}


// XXX: This only works up to 54 bit numbers.
function set64(p: number, n: number) {
  for (let i = 0; i < 8; ++i) {
    Module.setValue(p + (7 - i), n & 0xFF, "i8");
    n = Math.floor(n / 256);
  }

}


export class UInt64 extends PackedArenaObject {
  static fromNumber(n: number): UInt64 {
    let x = new UInt64();
    x.alloc();
    set64(x.getNative(), n);
    return x;
  }

  size() {
    return 8;
  }
}


// It's redundant, but more type safe.
export interface DepositRequestPS_Args {
  h_contract: HashCode;
  h_wire: HashCode;
  timestamp: AbsoluteTimeNbo;
  refund_deadline: AbsoluteTimeNbo;
  transaction_id: UInt64;
  amount_with_fee: AmountNbo;
  deposit_fee: AmountNbo;
  merchant: EddsaPublicKey;
  coin_pub: EddsaPublicKey;
}


export class DepositRequestPS extends SignatureStruct {
  constructor(w: DepositRequestPS_Args) {
    super(w);
  }

  purpose() {
    return SignaturePurpose.WALLET_COIN_DEPOSIT;
  }

  fieldTypes() {
    return [
      ["h_contract", HashCode],
      ["h_wire", HashCode],
      ["timestamp", AbsoluteTimeNbo],
      ["refund_deadline", AbsoluteTimeNbo],
      ["transaction_id", UInt64],
      ["amount_with_fee", AmountNbo],
      ["deposit_fee", AmountNbo],
      ["merchant", EddsaPublicKey],
      ["coin_pub", EddsaPublicKey],
    ];
  }
}


interface Encodeable {
  encode(arena?: Arena): ByteArray;
}

function makeEncode(encodeFn) {
  function encode(arena?: Arena) {
    let ptr = emscAlloc.malloc(PTR_SIZE);
    let len = encodeFn(this.getNative(), ptr);
    let res = new ByteArray(len, null, arena);
    res.setNative(Module.getValue(ptr, '*'));
    emsc.free(ptr);
    return res;
  }

  return encode;
}


export class RsaPublicKey extends ArenaObject implements Encodeable {
  static fromCrock: (s: string, a?: Arena) => RsaPublicKey;

  toCrock() {
    return this.encode().toCrock();
  }

  destroy() {
    emsc.rsa_public_key_free(this.nativePtr);
    this.nativePtr = 0;
  }

  encode: (arena?: Arena) => ByteArray;
}
mixinStatic(RsaPublicKey, makeFromCrock(emscAlloc.rsa_public_key_decode));
mixin(RsaPublicKey, makeEncode(emscAlloc.rsa_public_key_encode));


export class EddsaSignature extends PackedArenaObject {
  size() {
    return 64;
  }
}


export class RsaSignature extends ArenaObject implements Encodeable {
  static fromCrock: (s: string, a?: Arena) => RsaSignature;

  encode: (arena?: Arena) => ByteArray;

  destroy() {
    emsc.rsa_signature_free(this.getNative());
    this.setNative(0);
  }
}
mixinStatic(RsaSignature, makeFromCrock(emscAlloc.rsa_signature_decode));
mixin(RsaSignature, makeEncode(emscAlloc.rsa_signature_encode));


export function rsaBlind(hashCode: HashCode,
                         blindingKey: RsaBlindingKey,
                         pkey: RsaPublicKey,
                         arena?: Arena): ByteArray {
  let ptr = emscAlloc.malloc(PTR_SIZE);
  let s = emscAlloc.rsa_blind(hashCode.nativePtr,
                              blindingKey.nativePtr,
                              pkey.nativePtr,
                              ptr);
  return new ByteArray(s, Module.getValue(ptr, '*'), arena);
}


export function eddsaSign(purpose: EccSignaturePurpose,
                          priv: EddsaPrivateKey,
                          a?: Arena): EddsaSignature {
  let sig = new EddsaSignature(a);
  sig.alloc();
  let res = emsc.eddsa_sign(priv.nativePtr, purpose.nativePtr, sig.nativePtr);
  if (res < 1) {
    throw Error("EdDSA signing failed");
  }
  return sig;
}


export function rsaUnblind(sig: RsaSignature,
                           bk: RsaBlindingKey,
                           pk: RsaPublicKey,
                           a?: Arena): RsaSignature {
  let x = new RsaSignature(a);
  x.nativePtr = emscAlloc.rsa_unblind(sig.nativePtr,
                                      bk.nativePtr,
                                      pk.nativePtr);
  return x;
}