Package google.registry.keyring.api

Class PgpHelper

java.lang.Object

google.registry.keyring.api.PgpHelper

public final class PgpHelper
extends Object

Helper functions for extracting PGP keys from their keyrings.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PgpHelper.KeyRequirement	Narrowed key search requirements.

Constructor Summary

Constructors

Constructor	Description
PgpHelper()

Method Summary

Modifier and Type	Method	Description
static byte[]	convertPublicKeyToBytes(org.bouncycastle.openpgp.PGPPublicKey publicKey)	Converts publicKey to bytes.
static boolean	isSigningKey(org.bouncycastle.openpgp.PGPPublicKey key)	Returns true if this key can be used for signing.
static org.bouncycastle.openpgp.PGPPublicKey	loadPublicKeyBytes(byte[] data)	Returns raw key bytes as a Bouncy Castle PGP public key.
static org.bouncycastle.openpgp.PGPKeyPair	lookupKeyPair(org.bouncycastle.openpgp.PGPPublicKeyRingCollection publics, org.bouncycastle.openpgp.PGPSecretKeyRingCollection privates, String query, PgpHelper.KeyRequirement want)	Same as lookupPublicKey(org.bouncycastle.openpgp.PGPPublicKeyRingCollection, java.lang.String, google.registry.keyring.api.PgpHelper.KeyRequirement) but also retrieves the associated private key.
static org.bouncycastle.openpgp.PGPPublicKey	lookupPublicKey(org.bouncycastle.openpgp.PGPPublicKeyRingCollection keyring, String query, PgpHelper.KeyRequirement want)	Search for public key on keyring based on a substring (like an email address).
static Optional<org.bouncycastle.openpgp.PGPPublicKey>	lookupPublicSubkey(org.bouncycastle.openpgp.PGPPublicKeyRing ring, PgpHelper.KeyRequirement want)	Return appropriate key or subkey for given task from public key.

Methods inherited from class java.lang.Object

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

Constructor Details

PgpHelper

public PgpHelper()

Method Details

convertPublicKeyToBytes

public static byte[] convertPublicKeyToBytes(org.bouncycastle.openpgp.PGPPublicKey publicKey)

Converts publicKey to bytes.

loadPublicKeyBytes

public static org.bouncycastle.openpgp.PGPPublicKey loadPublicKeyBytes(byte[] data)

Returns raw key bytes as a Bouncy Castle PGP public key.

lookupPublicKey

public static org.bouncycastle.openpgp.PGPPublicKey lookupPublicKey(org.bouncycastle.openpgp.PGPPublicKeyRingCollection keyring,
 String query,
 PgpHelper.KeyRequirement want)

Search for public key on keyring based on a substring (like an email address).

Throws:

com.google.common.base.VerifyException - if the key couldn't be found.

See Also:

• lookupKeyPair(org.bouncycastle.openpgp.PGPPublicKeyRingCollection, org.bouncycastle.openpgp.PGPSecretKeyRingCollection, java.lang.String, google.registry.keyring.api.PgpHelper.KeyRequirement)

lookupKeyPair

public static org.bouncycastle.openpgp.PGPKeyPair lookupKeyPair(org.bouncycastle.openpgp.PGPPublicKeyRingCollection publics,
 org.bouncycastle.openpgp.PGPSecretKeyRingCollection privates,
 String query,
 PgpHelper.KeyRequirement want)

Same as lookupPublicKey(org.bouncycastle.openpgp.PGPPublicKeyRingCollection, java.lang.String, google.registry.keyring.api.PgpHelper.KeyRequirement) but also retrieves the associated private key.

Throws:

com.google.common.base.VerifyException - if either keys couldn't be found.

See Also:

• lookupPublicKey(org.bouncycastle.openpgp.PGPPublicKeyRingCollection, java.lang.String, google.registry.keyring.api.PgpHelper.KeyRequirement)

lookupPublicSubkey

public static Optional<org.bouncycastle.openpgp.PGPPublicKey> lookupPublicSubkey(org.bouncycastle.openpgp.PGPPublicKeyRing ring,
 PgpHelper.KeyRequirement want)

Return appropriate key or subkey for given task from public key.

Weirder older PGP public keys will actually have multiple keys. The main key will usually be sign-only in such situations. So you've gotta go digging in through the key packets and make sure you get the one that's valid for encryption, or whatever you want to do.

isSigningKey

public static boolean isSigningKey(org.bouncycastle.openpgp.PGPPublicKey key)

Returns true if this key can be used for signing.