File

src/app/_pgp/pgp-key-store.ts

Implements

MutableKeyStore

Example

Index

Methods

Methods

clearKeysInKeyring
clearKeysInKeyring()
Returns : void
getEncryptKeys
getEncryptKeys()
Returns : Array<any>
getFingerprint
getFingerprint()
Returns : string
getKeyId
getKeyId(key: any)
Parameters :
Name Type Optional
key any No
Returns : string
getKeysForId
getKeysForId(keyId: string)
Parameters :
Name Type Optional
keyId string No
Returns : Array<any>
getPrivateKey
getPrivateKey()
Returns : any
getPrivateKeyForId
getPrivateKeyForId(keyId)
Parameters :
Name Optional
keyId No
Returns : any
getPrivateKeyId
getPrivateKeyId()
Returns : string
getPrivateKeys
getPrivateKeys()
Returns : Array<any>
getPublicKeyForId
getPublicKeyForId(keyId)
Parameters :
Name Optional
keyId No
Returns : any
getPublicKeyForSubkeyId
getPublicKeyForSubkeyId(subkeyId)
Parameters :
Name Optional
subkeyId No
Returns : any
getPublicKeys
getPublicKeys()
Returns : Array<any>
getPublicKeysForAddress
getPublicKeysForAddress(address)
Parameters :
Name Optional
address No
Returns : Array<any>
getTrustedActiveKeys
getTrustedActiveKeys()
Returns : Array<any>
getTrustedKeys
getTrustedKeys()
Returns : Array<any>
Async importKeyPair
importKeyPair(publicKey: any, privateKey: any)
Parameters :
Name Type Optional
publicKey any No
privateKey any No
Returns : Promise<void>
Async importPrivateKey
importPrivateKey(privateKey: any)
Parameters :
Name Type Optional
privateKey any No
Returns : Promise<void>
importPublicKey
importPublicKey(publicKey: any)
Parameters :
Name Type Optional
publicKey any No
Returns : void
Async isEncryptedPrivateKey
isEncryptedPrivateKey(privateKey: any)
Parameters :
Name Type Optional
privateKey any No
Returns : Promise<boolean>
Async isValidKey
isValidKey(key)
Parameters :
Name Optional
key No
Returns : Promise<boolean>
Async loadKeyring
loadKeyring()
Returns : Promise<void>
removeKeysForId
removeKeysForId(keyId)
Parameters :
Name Optional
keyId No
Returns : Array<any>
removePublicKey
removePublicKey(publicKey: any)
Parameters :
Name Type Optional
publicKey any No
Returns : any
removePublicKeyForId
removePublicKeyForId(keyId)
Parameters :
Name Optional
keyId No
Returns : any
Async sign
sign(plainText)
Parameters :
Name Optional
plainText No
Returns : Promise<any>
import { KeyStore } from 'cic-client-meta';
// TODO should we put this on the mutable key store object
import * as openpgp from 'openpgp';
const keyring = new openpgp.Keyring();

/**
 * @extends
 */
interface MutableKeyStore extends KeyStore {
  loadKeyring(): void;
  importKeyPair(publicKey: any, privateKey: any): Promise<void>;
  importPublicKey(publicKey: any): void;
  importPrivateKey(privateKey: any): Promise<void>;
  getPublicKeys(): Array<any>;
  getTrustedKeys(): Array<any>;
  getTrustedActiveKeys(): Array<any>;
  getEncryptKeys(): Array<any>;
  getPrivateKeys(): Array<any>;
  getPrivateKey(): any;
  isValidKey(key: any): Promise<boolean>;
  isEncryptedPrivateKey(privateKey: any): Promise<boolean>;
  getFingerprint(): string;
  getKeyId(key: any): string;
  getPrivateKeyId(): string;
  getKeysForId(keyId: string): Array<any>;
  getPublicKeyForId(keyId: string): any;
  getPrivateKeyForId(keyId: string): any;
  getPublicKeyForSubkeyId(subkeyId: string): any;
  getPublicKeysForAddress(address: string): Array<any>;
  removeKeysForId(keyId: string): Array<any>;
  removePublicKeyForId(keyId: string): any;
  removePublicKey(publicKey: any): any;
  clearKeysInKeyring(): void;
  sign(plainText: string): Promise<any>;
}

/**
 * @implements
 */
class MutablePgpKeyStore implements MutableKeyStore{

  async loadKeyring(): Promise<void> {
    await keyring.load();
    await keyring.store();
  }

  async importKeyPair(publicKey: any, privateKey: any): Promise<void> {
    await keyring.publicKeys.importKey(publicKey);
    await keyring.privateKeys.importKey(privateKey);
  }

  importPublicKey(publicKey: any): void {
    keyring.publicKeys.importKey(publicKey);
  }

  async importPrivateKey(privateKey: any): Promise<void> {
    await keyring.privateKeys.importKey(privateKey);
  }

  getPublicKeys(): Array<any> {
    return keyring.publicKeys.keys;
  }

  getTrustedKeys(): Array<any> {
    return keyring.publicKeys.keys;
  }

  getTrustedActiveKeys(): Array<any> {
    return keyring.publicKeys.keys;
  }

  getEncryptKeys(): Array<any> {
    return [];
  }

  getPrivateKeys(): Array<any> {
    return keyring.privateKeys.keys;
  }

  getPrivateKey(): any {
    return keyring.privateKeys && keyring.privateKeys.keys[0];
  }

  async isValidKey(key): Promise<boolean> {
    // There is supposed to be an openpgp.readKey() method but I can't find it?
    const _key = await openpgp.key.readArmored(key);
    return !_key.err;
  }

  async isEncryptedPrivateKey(privateKey: any): Promise<boolean> {
    const imported = await openpgp.key.readArmored(privateKey);
    for (const key of imported.keys) {
      if (key.isDecrypted()) {
        return false;
      }
    }
    return true;
  }

  getFingerprint(): string {
    // TODO Handle multiple keys
    return keyring.privateKeys && keyring.privateKeys.keys[0] && keyring.privateKeys.keys[0].keyPacket &&
      keyring.privateKeys.keys[0].keyPacket.fingerprint;
  }

  getKeyId(key: any): string {
    return key.getKeyId().toHex();
  }

  getPrivateKeyId(): string {
    // TODO is there a library that comes with angular for doing this?
    return keyring.privateKeys && keyring.privateKeys.keys[0] && keyring.privateKeys.keys[0].getKeyId().toHex();
  }

  getKeysForId(keyId: string): Array<any> {
    return keyring.getKeysForId(keyId);
  }

  getPublicKeyForId(keyId): any {
    return keyring.publicKeys.getForId(keyId);
  }

  getPrivateKeyForId(keyId): any {
    return keyring.privateKeys.getForId(keyId);
  }

  getPublicKeyForSubkeyId(subkeyId): any {
    return keyring.publicKeys.getForId(subkeyId, true);
  }

  getPublicKeysForAddress(address): Array<any> {
    return keyring.publicKeys.getForAddress(address);
  }

  removeKeysForId(keyId): Array<any> {
    return keyring.removeKeysForId(keyId);
  }

  removePublicKeyForId(keyId): any {
    return keyring.publicKeys.removeForId(keyId);
  }

  removePublicKey(publicKey: any): any {
    const keyId =  publicKey.getKeyId().toHex();
    return keyring.publicKeys.removeForId(keyId);
  }

  clearKeysInKeyring(): void {
    keyring.clear();
  }

  async sign(plainText): Promise<any> {
    const privateKey = this.getPrivateKey();
    if (!privateKey.isDecrypted()) {
      const password = window.prompt('password');
      await privateKey.decrypt(password);
    }
    const opts = {
      message: openpgp.message.fromText(plainText),
      privateKeys: [privateKey],
      detached: true,
    };
    const signatureObject = await openpgp.sign(opts);
    return signatureObject.signature;
  }
}

export {
  MutablePgpKeyStore,
  MutableKeyStore
};

result-matching ""

    No results matching ""