IPWorks OpenPGP 2020 Kotlin Edition

Questions / Feedback?

KeyPassphrase Event

Fired if the passphrase of current key is incorrect or empty.

Syntax

public open class DefaultPimapEventListener : PimapEventListener {
  ...
  public override fun keyPassphrase(e: PimapKeyPassphraseEvent) {}
  ...
}

public class PimapKeyPassphraseEvent {
  val userId: String?
  val keyId: String?
  var passphrase: String?
}

Remarks

This event fires when the passphrase for the key is required. The passphrase must be specified before operations requiring the secret key are attempted. The passphrase may be supplied by setting the Passphrase parameter in this event, or by specifying the Passphrase field before attempting the operation.

The passphrase is required when using the following methods in KeyMgr:

  • AddUserId
  • SignUserId
  • ChangeExpirationDate
  • ChangePassphrase

When using the OpenPGP component, or an email-based component, the following methods require a passphrase for the key:

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OpenPGP 2020 Kotlin Edition - Version 20.0 [Build 7941]