Method unlock

src/controller/pwd.controller.js:96–135

* @param {Object} options * @param {openpgp.key.Key} options.key - key to unlock * @param {String} [options.reason] - optional explanation for password dialog * @param {Boolean} [options.openPopup=true] - password popup required (false if dialog appears integrated) * @param {Function} [o

(options)

   * @return {Promise<Object, Error>} - resolves with unlocked key and password {key: openpgp.key.Key, password: String}
   */
  async unlock(options) {
    this.options = options;
    this.options.reason ??= '';
    this.options.openPopup ??= true;
    const cacheEntry = await pwdCache.get(this.options.key.getFingerprint(), options.message);
    if (cacheEntry && !options.noCache) {
      if (cacheEntry.key) {
        return cacheEntry;
      }
      // password is in cache
      this.options.password = cacheEntry.password;
    }
    if (this.keyIsDecrypted(this.options) && !options.noCache) {
      // secret-key data is not encrypted, nothing to do
      return {key: this.options.key, password: this.options.password};
    }
    if (this.options.password) {
      // secret-key data is encrypted, but we have password
      const key = await pwdCache.unlock(this.options);
      return {key, password: this.options.password};
    }
    this.passwordRequest = Promise.withResolvers();
    if (this.options.beforePasswordRequest) {
      this.options.beforePasswordRequest(this.id);
    }
    if (this.options.openPopup) {
      setTimeout(async () => {
        const popup = await mvelo.windows.openPopup(`components/enter-password/passwordDialog.html?id=${this.id}`, {width: 580, height: 490});
        this.receivedPortMsg = false;
        this.pwdPopup = popup;
        popup.addRemoveListener(() => {
          if (!this.receivedPortMsg) {
            this.pwdPopup = null;
            this.onCancel();
          }
        });
      }, 50);
    }
    return this.passwordRequest.promise;
  }

  /**
   * Check if key is decrypted. As openpgp.decryptKey always decrypts all key packets, we only check the primary key status.