org.simplify4u.plugins.sign.openpgp

Class PGPSecretKeyUtils

java.lang.Object

org.simplify4u.plugins.sign.openpgp.PGPSecretKeyUtils

public final class PGPSecretKeyUtils
extends Object

Utility for operation on Secret Keys.

Author:

Slawomir Jaranowski

Method Summary

Modifier and Type	Method and Description
static String	fingerprint(org.bouncycastle.openpgp.PGPSecretKey secretKey) Generate string version of key fingerprint
static String	getKeyId(org.bouncycastle.openpgp.PGPSecretKey secretKey) Generate keyId as hex string.
static Optional<org.bouncycastle.openpgp.PGPSecretKey>	getMasterKey(org.bouncycastle.openpgp.PGPSecretKey secretKey, org.bouncycastle.openpgp.PGPSecretKeyRing secretKeyRing) Return master key for given sub public key.
static Collection<String>	getUserIDs(org.bouncycastle.openpgp.PGPSecretKey secretKey, org.bouncycastle.openpgp.PGPSecretKeyRing secretKeyRing) List of user ids from secret key.
static String	keyIdDescription(org.bouncycastle.openpgp.PGPSecretKey secretKey, org.bouncycastle.openpgp.PGPSecretKeyRing secretKeyRing) Generate string with key id description.
static void	verifyKeyExpiration(org.bouncycastle.openpgp.PGPSecretKey secretKey, org.bouncycastle.openpgp.PGPSecretKeyRing secretKeyRing) Verify expiration time of secret key.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getKeyId

public static String getKeyId(org.bouncycastle.openpgp.PGPSecretKey secretKey)

Generate keyId as hex string.

Parameters:

secretKey - a key to print id

Returns:

keyId in hex format

getUserIDs

public static Collection<String> getUserIDs(org.bouncycastle.openpgp.PGPSecretKey secretKey,
                                            org.bouncycastle.openpgp.PGPSecretKeyRing secretKeyRing)

List of user ids from secret key. If secret key is sub key list is taken from master key.

Parameters:

secretKey - a secret key for user ids

secretKeyRing - a keyRing of connected keys - need for sub key

Returns:

List user ids from key

keyIdDescription

public static String keyIdDescription(org.bouncycastle.openpgp.PGPSecretKey secretKey,
                                      org.bouncycastle.openpgp.PGPSecretKeyRing secretKeyRing)

Generate string with key id description.

Parameters:

secretKey - given key

secretKeyRing - keys ring with master and sub keys

Returns:

string with key id description

getMasterKey

public static Optional<org.bouncycastle.openpgp.PGPSecretKey> getMasterKey(org.bouncycastle.openpgp.PGPSecretKey secretKey,
                                                                           org.bouncycastle.openpgp.PGPSecretKeyRing secretKeyRing)

Return master key for given sub public key.

Parameters:

secretKey - given key

secretKeyRing - keys ring with master and sub keys

Returns:

master key of empty if not found or given key is master key

fingerprint

public static String fingerprint(org.bouncycastle.openpgp.PGPSecretKey secretKey)

Generate string version of key fingerprint

Parameters:

secretKey - given key

Returns:

fingerprint as string

verifyKeyExpiration

public static void verifyKeyExpiration(org.bouncycastle.openpgp.PGPSecretKey secretKey,
                                       org.bouncycastle.openpgp.PGPSecretKeyRing secretKeyRing)

Verify expiration time of secret key.

Parameters:

secretKey - a key to check

secretKeyRing - a keyRing used for prepare message

Throws:

PGPSignerException - if key expired