Class SecretKeys

java.lang.Object

org.eclipse.jgit.gpg.bc.internal.keys.SecretKeys

public final class SecretKeys
extends Object

Utilities for reading GPG secret keys from a gpg-agent key file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SecretKeys.PassphraseSupplier	Something that can supply a passphrase to decrypt an encrypted secret key.

Method Summary

Modifier and Type	Method	Description
static org.bouncycastle.openpgp.PGPSecretKey	readSecretKey(InputStream in, org.bouncycastle.openpgp.operator.PGPDigestCalculatorProvider calculatorProvider, SecretKeys.PassphraseSupplier passphraseSupplier, org.bouncycastle.openpgp.PGPPublicKey publicKey)	Reads a GPG secret key from the given stream.

Methods inherited from class Object

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

Method Details

readSecretKey

public static org.bouncycastle.openpgp.PGPSecretKey readSecretKey(InputStream in,
 org.bouncycastle.openpgp.operator.PGPDigestCalculatorProvider calculatorProvider,
 SecretKeys.PassphraseSupplier passphraseSupplier,
 org.bouncycastle.openpgp.PGPPublicKey publicKey)
                                                           throws IOException,
org.bouncycastle.openpgp.PGPException,
CanceledException,
UnsupportedCredentialItem,
URISyntaxException

Reads a GPG secret key from the given stream.

Parameters:

in - InputStream to read from, doesn't need to be buffered

calculatorProvider - for checking digests

passphraseSupplier - for decrypting encrypted keys

publicKey - the secret key should be for

Returns:

the secret key

Throws:

IOException - if the stream cannot be parsed

org.bouncycastle.openpgp.PGPException - if thrown by the underlying S-Expression parser, for instance when the passphrase is wrong

CanceledException - if thrown by the passphraseSupplier

UnsupportedCredentialItem - if thrown by the passphraseSupplier

URISyntaxException - if thrown by the passphraseSupplier