on_key_list Event

Fires for each key in the keyring when ListKeys is called.

Syntax

class KeyMgrKeyListEventParams(object):
  @property
  def user_id() -> str: ...
  @property
  def key_id() -> str: ...
  @property
  def fingerprint() -> str: ...
  @property
  def has_secret_key() -> bool: ...
  @property
  def public_key_algorithm() -> str: ...
  @property
  def public_key_length() -> int: ...
  @property
  def curve() -> str: ...

# In class KeyMgr:
@property
def on_key_list() -> Callable[[KeyMgrKeyListEventParams], None]: ...
@on_key_list.setter
def on_key_list(event_hook: Callable[[KeyMgrKeyListEventParams], None]) -> None: ...

Remarks

This event fires once for each key in the keyring when list_keys is called.

UserId holds the current user Id of the key.

The UserId format is:

FirstName LastName (Comment) <Email>

Not all values are required when selecting or generating a key, but at least FirstName or Email are required.

KeyId is the hex-encoded, 4-byte or 8-byte Id of the key. It is the same as the last 4 or 8 bytes of the Fingerprint. For instance:

BF52A0AB

Fingerprint holds the hex-encoded, 20-byte fingerprint of the key. This is in the form:

5E70662EA810E768391A2FE8F7B7D49C89C9D7B1

HasSecretKey returns True if the key contains a secret key.

PublicKeyAlgorithm is the public key algorithm. Possible values are:

• RSA
• DSA
• ECDSA
• EdDSA

PublicKeyLength is the length of the public key. Common values are 512, 1024, and 2048. If the PublicKeyAlgorithm is ECDSA or EdDSA the length of the public key is determined by the Curve. Possible lengths are:

Curve	Public Key Length (bits)
secp256r1	256
secp384r1	384
secp521r1	521
Ed25519	256
secp256k1	256

Curve is the curve used by the key when PublicKeyAlgorithm is ECDSA or EdDSA. Possible values are:

Value	PublicKeyAlgorithm	Description
secp256r1	ECDSA	NIST curve P-256
secp384r1	ECDSA	NIST curve P-384
secp521r1	ECDSA	NIST curve P-521
Ed25519	EdDSA	Ed25519
secp256k1	EdDSA	Secp256k1