fork-openpgpjs/src/keyring/keyring.js

// GPG4Browsers - An OpenPGP implementation in javascript
// Copyright (C) 2011 Recurity Labs GmbH
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 3.0 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

/**
 * @fileoverview Provides the Keyring class
 * @requires key
 * @requires keyring/localstore
 * @module keyring/keyring
 */

import { readKeys } from '../key';
import defaultConfig from '../config';
import LocalStore from './localstore';

/**
 * Array of keys
 */
class KeyArray {
  /**
   * @param {Array<module:key.Key>} keys The keys to store in this array
   */
  constructor(keys) {
    this.keys = keys;
  }

  /**
   * Searches all keys in the KeyArray matching the address or address part of the user ids
   * @param {String} email email address to search for
   * @returns {Array<module:key.Key>} The public keys associated with provided email address.
   */
  getForAddress(email) {
    const results = [];
    for (let i = 0; i < this.keys.length; i++) {
      if (emailCheck(email, this.keys[i])) {
        results.push(this.keys[i]);
      }
    }
    return results;
  }

  /**
   * Searches the KeyArray for a key having the specified key id
   * @param {String} keyId provided as string of lowercase hex number
   * withouth 0x prefix (can be 16-character key ID or fingerprint)
   * @param  {Boolean} deep if true search also in subkeys
   * @returns {module:key.Key|null} key found or null
   */
  getForId(keyId, deep) {
    for (let i = 0; i < this.keys.length; i++) {
      if (keyIdCheck(keyId, this.keys[i])) {
        return this.keys[i];
      }
      if (deep && this.keys[i].subKeys.length) {
        for (let j = 0; j < this.keys[i].subKeys.length; j++) {
          if (keyIdCheck(keyId, this.keys[i].subKeys[j])) {
            return this.keys[i];
          }
        }
      }
    }
    return null;
  }

  /**
   * Imports a key from an ascii armored message
   * @param {String} armored message to read the keys/key from
   * @param {Object} config  (optional) full configuration, defaults to openpgp.config
   * @async
   */
  async importKey(armored, config = defaultConfig) {
    const imported = await readKeys({ armoredKeys: armored, config });
    for (let i = 0; i < imported.length; i++) {
      const key = imported[i];
      // check if key already in key array
      const keyidHex = key.getKeyId().toHex();
      const keyFound = this.getForId(keyidHex);
      if (keyFound) {
        await keyFound.update(key);
      } else {
        this.push(key);
      }
    }
  }

  /**
   * Add key to KeyArray
   * @param {module:key.Key} key The key that will be added to the keyring
   * @returns {Number} The new length of the KeyArray
   */
  push(key) {
    return this.keys.push(key);
  }

  /**
   * Removes a key with the specified keyid from the keyring
   * @param {String} keyId provided as string of lowercase hex number
   * withouth 0x prefix (can be 16-character key ID or fingerprint)
   * @returns {module:key.Key|null} The key object which has been removed or null
   */
  removeForId(keyId) {
    for (let i = 0; i < this.keys.length; i++) {
      if (keyIdCheck(keyId, this.keys[i])) {
        return this.keys.splice(i, 1)[0];
      }
    }
    return null;
  }
}

class Keyring {
  /**
   * Initialization routine for the keyring.
   * @param {keyring/localstore} [storeHandler] class implementing loadPublic(), loadPrivate(), storePublic(), and storePrivate() methods
   * @param {Object} config  (optional) full configuration, defaults to openpgp.config
   */
  constructor(storeHandler, config = defaultConfig) {
    this.storeHandler = storeHandler || new LocalStore(undefined, config);
  }

  /**
   * Calls the storeHandler to load the keys
   * @async
   */
  async load() {
    this.publicKeys = new KeyArray(await this.storeHandler.loadPublic());
    this.privateKeys = new KeyArray(await this.storeHandler.loadPrivate());
  }

  /**
   * Calls the storeHandler to save the keys
   * @async
   */
  async store() {
    await Promise.all([
      this.storeHandler.storePublic(this.publicKeys.keys),
      this.storeHandler.storePrivate(this.privateKeys.keys)
    ]);
  }

  /**
   * Clear the keyring - erase all the keys
   */
  clear() {
    this.publicKeys.keys = [];
    this.privateKeys.keys = [];
  }

  /**
   * Searches the keyring for keys having the specified key id
   * @param {String} keyId provided as string of lowercase hex number
   * withouth 0x prefix (can be 16-character key ID or fingerprint)
   * @param  {Boolean} deep if true search also in subkeys
   * @returns {Array<module:key.Key>|null} keys found or null
   */
  getKeysForId(keyId, deep) {
    let result = [];
    result = result.concat(this.publicKeys.getForId(keyId, deep) || []);
    result = result.concat(this.privateKeys.getForId(keyId, deep) || []);
    return result.length ? result : null;
  }

  /**
   * Removes keys having the specified key id from the keyring
   * @param {String} keyId provided as string of lowercase hex number
   * withouth 0x prefix (can be 16-character key ID or fingerprint)
   * @returns {Array<module:key.Key>|null} keys found or null
   */
  removeKeysForId(keyId) {
    let result = [];
    result = result.concat(this.publicKeys.removeForId(keyId) || []);
    result = result.concat(this.privateKeys.removeForId(keyId) || []);
    return result.length ? result : null;
  }

  /**
   * Get all public and private keys
   * @returns {Array<module:key.Key>} all keys
   */
  getAllKeys() {
    return this.publicKeys.keys.concat(this.privateKeys.keys);
  }
}

/**
 * Checks a key to see if it matches the specified email address
 * @private
 * @param {String} email email address to search for
 * @param {module:key.Key} key The key to be checked.
 * @returns {Boolean} True if the email address is defined in the specified key
 */
function emailCheck(email, key) {
  email = email.toLowerCase();
  // escape email before using in regular expression
  const emailEsc = email.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
  const emailRegex = new RegExp('<' + emailEsc + '>');
  const userIds = key.getUserIds();
  for (let i = 0; i < userIds.length; i++) {
    const userId = userIds[i].toLowerCase();
    if (email === userId || emailRegex.test(userId)) {
      return true;
    }
  }
  return false;
}

/**
 * Checks a key to see if it matches the specified keyid
 * @private
 * @param {String} keyId provided as string of lowercase hex number
 * withouth 0x prefix (can be 16-character key ID or fingerprint)
 * @param {module:key.Key|module:key.SubKey} key The key to be checked
 * @returns {Boolean} True if key has the specified keyid
 */
function keyIdCheck(keyId, key) {
  if (keyId.length === 16) {
    return keyId === key.getKeyId().toHex();
  }
  return keyId === key.getFingerprint();
}

export default Keyring;