@bitgo-beta/key-card 0.0.1-beta.19 → 0.0.1-beta.190

package/src/drawKeycard.ts

@@ -1,222 +0,0 @@
-import { jsPDF } from 'jspdf';
-import * as QRCode from 'qrcode';
-import { FAQ } from './faq';
-import { QrData } from './generateQrData';
-import { splitKeys } from './utils';
-
-// Max for Binary/Byte Data https://en.wikipedia.org/wiki/QR_code#Standards
-// keys for TSS wallets aren't alphanumeric, so qrcode.react falls back to binary/byte encoding
-export const QRBinaryMaxLength = 2953;
-
-const font = {
-  header: 24,
-  subheader: 15,
-  body: 12,
-};
-
-const color = {
-  black: '#000000',
-  darkgray: '#4c4c4c',
-  gray: '#9b9b9b',
-  red: '#e21e1e',
-};
-
-const margin = 30;
-
-export async function drawKeycard({ activationCode, questions, keyCardImage, qrData, walletLabel }: {
-  activationCode?: string;
-  keyCardImage?: HTMLImageElement;
-  qrData: QrData;
-  questions: FAQ[];
-  walletLabel: string;
-}): Promise<jsPDF> {
-  // document details
-  const width = 8.5 * 72;
-  let y = 0;
-
-  // Helpers for data formatting / positioning on the paper
-  const left = (x: number) => margin + x;
-  const moveDown = (ydelta: number) => (y += ydelta);
-
-  // Create the PDF instance
-
-  const doc = new jsPDF('portrait', 'pt', 'letter'); // jshint ignore:line
-  doc.setFont('helvetica');
-
-  // PDF Header Area - includes the logo and company name
-  // This is data for the BitGo logo in the top left of the PDF
-  moveDown(30);
-
-  if (keyCardImage) {
-    doc.addImage(keyCardImage, left(0), y, 303, 40);
-  }
-
-  // Activation Code
-  if (activationCode) {
-    moveDown(8);
-    doc.setFontSize(font.body).setTextColor(color.gray);
-    doc.text('Activation Code', left(460), y);
-  }
-  doc.setFontSize(font.header).setTextColor(color.black);
-  moveDown(25);
-  doc.text('KeyCard', left(325), y - 1);
-  if (activationCode) {
-    doc.setFontSize(font.header).setTextColor(color.gray);
-    doc.text(activationCode, left(460), y);
-  }
-
-  // Subheader
-  // titles
-  const date = new Date().toDateString();
-  moveDown(margin);
-  doc.setFontSize(font.body).setTextColor(color.gray);
-  doc.text('Created on ' + date + ' for wallet named:', left(0), y);
-  // copy
-  moveDown(25);
-  doc.setFontSize(font.subheader).setTextColor(color.black);
-  doc.text(walletLabel, left(0), y);
-  // Red Bar
-  moveDown(20);
-  doc.setFillColor(255, 230, 230);
-  doc.rect(left(0), y, width - 2 * margin, 32, 'F');
-
-  // warning message
-  moveDown(20);
-  doc.setFontSize(font.body).setTextColor(color.red);
-  doc.text('Print this document, or keep it securely offline. See below for FAQ.', left(75), y);
-
-  // Generate the first page's data for the backup PDF
-  moveDown(35);
-  const qrSize = 130;
-
-  const qrKeys = ['user', 'passcode', 'backup', 'bitgo'];
-  for (let index = 0; index < qrKeys.length; index++) {
-    const name = qrKeys[index];
-    if (index === 2) {
-      // Add 2nd Page
-      doc.addPage();
-
-      // 2nd page title
-      y = 30;
-    }
-
-    const qr = qrData[name];
-    let topY = y;
-    const textLeft = left(qrSize + 15);
-    let textHeight = 0;
-
-    if (qr.data.length <= QRBinaryMaxLength) {
-      const image = await QRCode.toCanvas(qr.data, { errorCorrectionLevel: 'L' });
-      doc.addImage(image, left(0), y, qrSize, qrSize);
-    } else {
-      // key is too long for one QR code
-      const keys = splitKeys(qr.data, QRBinaryMaxLength);
-      for (let keyIndex = 0; keyIndex < keys.length; keyIndex++) {
-        const image = await QRCode.toCanvas(keys[keyIndex], { errorCorrectionLevel: 'L' });
-        doc.addImage(image, left(0), y, qrSize, qrSize);
-        const textBuffer = 15;
-        moveDown(qrSize + textBuffer);
-        doc.setFontSize(font.body).setTextColor(color.black);
-        doc.text('Part ' + (keyIndex + 1).toString(), left(0), y);
-        moveDown(20);
-      }
-      y = topY;
-    }
-
-    doc.setFontSize(font.subheader).setTextColor(color.black);
-    moveDown(10);
-    textHeight += 10;
-    doc.text(qr.title, textLeft, y);
-    textHeight += doc.getLineHeight();
-    moveDown(15);
-    textHeight += 15;
-    doc.setFontSize(font.body).setTextColor(color.darkgray);
-    doc.text(qr.description, textLeft, y);
-    textHeight += doc.getLineHeight();
-    doc.setFontSize(font.body - 2);
-    if (qr?.data?.length > QRBinaryMaxLength) {
-      moveDown(30);
-      textHeight += 30;
-      doc.text('Note: you will need to put Part 1 and Part 2 together for the full key', textLeft, y);
-    }
-    moveDown(30);
-    textHeight += 30;
-    doc.text('Data:', textLeft, y);
-    textHeight += doc.getLineHeight();
-    moveDown(15);
-    textHeight += 15;
-    const width = 72 * 8.5 - textLeft - 30;
-    doc.setFont('courier').setFontSize(9).setTextColor(color.black);
-    const lines = doc.splitTextToSize(qr.data, width);
-    const buffer = 10;
-    for (let line = 0; line < lines.length; line++) {
-      // add new page if data does not fit on one page
-      if (y + buffer >= doc.internal.pageSize.getHeight()) {
-        doc.addPage();
-        textHeight = 0;
-        y = 30;
-        topY = y;
-      }
-      doc.text(lines[line], textLeft, y);
-      if (line !== lines.length - 1) {
-        moveDown(buffer);
-        textHeight += buffer;
-      }
-    }
-
-    // Add public key if exists
-    if (qr.publicMasterKey) {
-      const text = 'Key Id: ' + qr.publicMasterKey;
-
-      // Gray bar
-      moveDown(20);
-      textHeight += 20;
-      doc.setFillColor(247, 249, 249); // Gray background
-      doc.setDrawColor(0, 0, 0); // Border
-
-      // Leave a bit of space for the side of the rectangle.
-      const splitKeyId = doc.splitTextToSize(text, width - 10);
-
-      // The height of the box must be at least 15 px (for single line case), or
-      // a multiple of 13 for each line.  This allows for proper padding.
-      doc.rect(textLeft, y, width, Math.max(12 * splitKeyId.length, 15), 'FD');
-      textHeight += splitKeyId.length * doc.getLineHeight();
-      doc.text(splitKeyId, textLeft + 5, y + 10);
-    }
-
-    doc.setFont('helvetica');
-    // Move down the size of the QR code minus accumulated height on the right side, plus margin
-    // if we have a key that spans multiple pages, then exclude QR code size
-    let rowHeight = Math.max(qrSize, textHeight);
-    if (qr?.data?.length > QRBinaryMaxLength) {
-      rowHeight = textHeight;
-    }
-    const marginBottom = 15;
-    moveDown(rowHeight - (y - topY) + marginBottom);
-  }
-
-  // Add next Page
-  doc.addPage();
-
-  // next pages title
-  y = 0;
-  moveDown(55);
-  doc.setFontSize(font.header).setTextColor(color.black);
-  doc.text('BitGo KeyCard FAQ', left(0), y);
-
-  // Generate the second page's data for the backup PDF
-  moveDown(30);
-  questions.forEach(function (q) {
-    doc.setFontSize(font.subheader).setTextColor(color.black);
-    doc.text(q.question, left(0), y);
-    moveDown(20);
-    doc.setFontSize(font.body).setTextColor(color.darkgray);
-    q.answer.forEach(function (line) {
-      doc.text(line, left(0), y);
-      moveDown(font.body + 3);
-    });
-    moveDown(22);
-  });
-
-  return doc;
-}

package/src/faq.ts

@@ -1,82 +0,0 @@
-export interface FAQ {
-  question: string;
-  // the answer to the question, already split into individual lines of text
-  answer: string[];
-}
-
-export function generateFaq(coinName: string): FAQ[] {
-  const sectionACoinSpecific =
-    `The KeyCard contains important information which can be used to recover the ${coinName} `;
-  const sectionBCoinSpecific =
-    `If you have lost or damaged all copies of your KeyCard, your ${coinName} is still safe, but this `;
-  const sectionCCoinSpecific =
-    `source tools at https://github.com/bitgo to recover your ${coinName}. Note: You should never enter `;
-  const sectionDCoinSpecific =
-    `your KeyCard will be able to steal your ${coinName}. We recommend keeping your wallet password `;
-
-  return [
-    {
-      question: 'What is the KeyCard?',
-      answer: [
-        sectionACoinSpecific,
-        'from your wallet in several situations. Each BitGo wallet has its own, unique KeyCard. ',
-        'If you have created multiple wallets, you should retain the KeyCard for each of them.',
-      ],
-    },
-    {
-      question: 'What should I do with it?',
-      answer: [
-        'You should print the KeyCard and/or save the PDF to an offline storage device. The print-out ',
-        "or USB stick should be kept in a safe place, such as a bank vault or home safe. It's a good idea ",
-        'to keep a second copy in a different location.',
-        '',
-        "Important: If you haven't provided an external backup key, then the original PDF should be ",
-        'deleted from any machine where the wallet will be regularly accessed to prevent malware from ',
-        'capturing both the KeyCard and your wallet passcode.',
-      ],
-    },
-    {
-      question: 'What should I do if I lose it?',
-      answer: [
-        sectionBCoinSpecific,
-        'Wallet should be considered at risk for loss. As soon as is convenient, you should use BitGo ',
-        'to empty the wallet into a new wallet and discontinue use of the old wallet.',
-      ],
-    },
-    {
-      question: 'What if someone sees my KeyCard?',
-      answer: [
-        "Don't panic! All sensitive information on the KeyCard is encrypted with your passcode, or with a",
-        'key which only BitGo has. But, in general, you should make best efforts to keep your ',
-        'KeyCard private. If your KeyCard does get exposed or copied in a way that makes you ',
-        'uncomfortable, the best course of action is to empty the corresponding wallet into another ',
-        'wallet and discontinue use of the old wallet.',
-      ],
-    },
-    {
-      question: 'What if I forget or lose my wallet password?',
-      answer: [
-        'BitGo can use the information in QR Code D to help you recover access to your wallet. ',
-        'Without the KeyCard, BitGo is not able to recover funds from a wallet with a lost password.',
-      ],
-    },
-    {
-      question: 'What if BitGo becomes inaccessible for an extended period?',
-      answer: [
-        "Your KeyCard and wallet passcode can be used together with BitGo's published open ",
-        sectionCCoinSpecific,
-        'information from your KeyCard into tools other than the tools BitGo has published, or your ',
-        'funds may be at risk for theft.',
-      ],
-    },
-    {
-      question: 'Should I write my wallet password on my KeyCard?',
-      answer: [
-        "No! BitGo's signature scheme approach to security depends on there not being a single point ",
-        'of attack. But if your wallet password is on your KeyCard, then anyone who gains access to ',
-        sectionDCoinSpecific,
-        'safe in a secure password manager such as LastPass, 1Password or KeePass.',
-      ],
-    },
-  ];
-}

package/src/generateQrData.ts

@@ -1,187 +0,0 @@
-import { BaseCoin } from '@bitgo-beta/statics';
-import { Keychain } from '@bitgo-beta/sdk-core';
-import { encrypt } from '@bitgo-beta/sdk-api';
-import * as assert from 'assert';
-
-export interface GenerateQrDataParams {
-  // The backup keychain as it is returned from the BitGo API upon creation
-  backupKeychain: Keychain,
-  // The name of the 3rd party provider of the backup key if neither the user nor BitGo stores it
-  backupKeyProvider?: string;
-  // The key id of the backup key, only used for cold keys
-  backupMasterKey?: string;
-  // The BitGo keychain as it is returned from the BitGo API upon creation
-  bitgoKeychain: Keychain,
-  // The coin of the wallet that was/ is about to be created
-  coin: Readonly<BaseCoin>;
-  // A code that can be used to encrypt the wallet password to.
-  // If both the passphrase and passcodeEncryptionCode are passed, then this code encrypts the passphrase with the
-  // passcodeEncryptionCode and puts the result into Box D. Allows recoveries of the wallet password.
-  passcodeEncryptionCode?: string;
-  // The wallet password
-  // If both the passphrase and passcodeEncryptionCode are passed, then this code encrypts the passphrase with the
-  // passcodeEncryptionCode and puts the result into Box D. Allows recoveries of the wallet password.
-  passphrase?: string;
-  // The user keychain as it is returned from the BitGo API upon creation
-  userKeychain: Keychain;
-  // The key id of the user key, only used for cold keys
-  userMasterKey?: string;
-}
-
-interface QrDataEntry {
-  data: string;
-  description: string;
-  title: string;
-  publicMasterKey?: string;
-}
-
-export interface QrData {
-  backup?: QrDataEntry;
-  bitgo?: QrDataEntry;
-  passcode?: QrDataEntry;
-  user: QrDataEntry;
-}
-
-function getPubFromKey(key: Keychain): string | undefined {
-  switch (key.type) {
-    case 'blsdkg':
-      return key.commonPub;
-    case 'tss':
-      return key.commonKeychain;
-    case 'independent':
-      return key.pub;
-  }
-}
-
-function generateUserQrData(userKeychain: Keychain, userMasterKey?: string): QrDataEntry {
-  if (userKeychain.encryptedPrv) {
-    return {
-      title: 'A: User Key',
-      description: 'This is your private key, encrypted with your wallet password.',
-      data: userKeychain.encryptedPrv,
-    };
-  }
-
-  const pub = getPubFromKey(userKeychain);
-  assert(pub);
-
-  return {
-    title: 'A: Provided User Key',
-    description: 'This is the public key you provided for your wallet.',
-    data: pub,
-    publicMasterKey: userMasterKey,
-  };
-}
-
-function generateBackupQrData(coin: Readonly<BaseCoin>, backupKeychain: Keychain, {
-  backupKeyProvider,
-  backupMasterKey,
-}: {
-  backupKeyProvider?: string;
-  backupMasterKey?: string;
-} = {}): QrDataEntry {
-  const title = 'B: Backup Key';
-  if (backupKeychain.encryptedPrv) {
-    return {
-      title,
-      description: 'This is your backup private key, encrypted with your wallet password.',
-      data: backupKeychain.encryptedPrv,
-    };
-  }
-
-  if (backupKeyProvider === 'BitGo Trust' && backupKeychain.type === 'tss') {
-    const userToBackupShare = backupKeychain.keyShares?.find((keyShare) => keyShare.from === 'user' && keyShare.to === 'backup');
-    assert(userToBackupShare);
-    return {
-      title: 'B: User To Backup Key Share',
-      description: `This is the key share from you for ${backupKeyProvider}. If BitGo Inc goes out of\r\nbusiness,` +
-        ` contact ${backupKeyProvider} and they will help you recover your funds.`,
-      data: JSON.stringify(userToBackupShare),
-    };
-  }
-
-  const pub = getPubFromKey(backupKeychain);
-  assert(pub);
-
-  if (backupKeyProvider) {
-    return {
-      title: 'B: Backup Key',
-      description: `This is the public key held at ${backupKeyProvider}, an ${coin.name} recovery service. ` +
-        `If you lose\r\nyour key, ${backupKeyProvider} will be able to sign transactions to recover funds.`,
-      data: pub,
-    };
-  }
-
-  return {
-    title: 'B: Provided Backup Key',
-    description: 'This is the public key you provided for your wallet.',
-    data: pub,
-    publicMasterKey: backupMasterKey,
-  };
-}
-
-function generateBitGoQrData(bitgoKeychain: Keychain, {
-  backupKeychain,
-  backupKeyProvider,
-}: {
-  backupKeychain?: Keychain,
-  backupKeyProvider?: string;
-}): QrDataEntry {
-  if (backupKeyProvider === 'BitGo Trust' && backupKeychain?.type === 'tss') {
-    const bitgoToBackupShare = backupKeychain.keyShares?.find((keyShare) => keyShare.from === 'bitgo' && keyShare.to === 'backup');
-    assert(bitgoToBackupShare);
-    return {
-      title: 'C: BitGo To Backup Key Share',
-      description: `This is the key share from BitGo Inc for ${backupKeyProvider}. If BitGo Inc goes out of\r\nbusiness,` +
-        ` contact ${backupKeyProvider} and they will help you recover your funds.`,
-      data: JSON.stringify(bitgoToBackupShare),
-    };
-  }
-
-  const bitgoData = getPubFromKey(bitgoKeychain);
-  assert(bitgoData);
-
-  return {
-    title: 'C: BitGo Public Key',
-    description:
-      'This is the public part of the key that BitGo will use to ' +
-      'co-sign transactions\r\nwith you on your wallet.',
-    data: bitgoData,
-  };
-}
-
-export function generateQrData({
-  backupKeychain,
-  backupKeyProvider,
-  backupMasterKey,
-  bitgoKeychain,
-  coin,
-  passcodeEncryptionCode,
-  passphrase,
-  userKeychain,
-  userMasterKey,
-}: GenerateQrDataParams): QrData {
-  const qrData: QrData = {
-    user: generateUserQrData(userKeychain, userMasterKey),
-    backup: generateBackupQrData(coin, backupKeychain, {
-      backupKeyProvider,
-      backupMasterKey,
-    }),
-    bitgo: generateBitGoQrData(bitgoKeychain, {
-      backupKeychain,
-      backupKeyProvider,
-    }),
-  };
-
-  if (passphrase && passcodeEncryptionCode) {
-    const encryptedWalletPasscode = encrypt(passcodeEncryptionCode, passphrase);
-
-    qrData.passcode = {
-      title: 'D: Encrypted wallet Password',
-      description: 'This is the wallet password, encrypted client-side with a key held by BitGo.',
-      data: encryptedWalletPasscode,
-    };
-  }
-
-  return qrData;
-}

package/src/index.ts

@@ -1,22 +0,0 @@
-import { generateQrData, GenerateQrDataParams } from './generateQrData';
-import { generateFaq } from './faq';
-import { drawKeycard } from './drawKeycard';
-
-export * from './drawKeycard';
-export * from './faq';
-export * from './generateQrData';
-export * from './utils';
-
-export interface GenerateKeycardParams extends GenerateQrDataParams {
-  activationCode?: string;
-  keyCardImage?: HTMLImageElement;
-  walletLabel: string;
-}
-
-export async function generateKeycard(params: GenerateKeycardParams): Promise<void> {
-  const questions = generateFaq(params.coin.fullName);
-  const qrData = generateQrData(params);
-  const keycard = await drawKeycard({ ...params, questions, qrData });
-  // Save the PDF on the user's browser
-  keycard.save(`BitGo Keycard for ${params.walletLabel}.pdf`);
-}

package/src/utils.ts

@@ -1,15 +0,0 @@
-export function splitKeys(key: string, limit: number): string[] {
-  if (key.length <= limit) {
-    return [key];
-  }
-
-  const keys: string[] = [];
-
-  let rightIndex = limit;
-  for (let i = 0; i < key.length; i += limit) {
-    keys.push(key.substring(i, rightIndex));
-    rightIndex = Math.min(rightIndex + limit, key.length);
-  }
-
-  return keys;
-}

package/test/unit/faq.ts

@@ -1,14 +0,0 @@
-import { generateFaq } from '../../src/faq';
-
-describe('generateFaq', function () {
-  it('generates faq with filled in coin name', function () {
-    const coinName = 'fooCoin';
-    const questions = generateFaq(coinName);
-
-    questions.length.should.equal(7);
-    questions[0].answer[0].should.match(new RegExp(coinName));
-    questions[2].answer[0].should.match(new RegExp(coinName));
-    questions[5].answer[1].should.match(new RegExp(coinName));
-    questions[6].answer[2].should.match(new RegExp(coinName));
-  });
-});