org.eclipse.jgit.lib.internal

Class BouncyCastleGpgKeyLocator

java.lang.Object

org.eclipse.jgit.lib.internal.BouncyCastleGpgKeyLocator

class BouncyCastleGpgKeyLocator
extends java.lang.Object

Locates GPG keys from either ~/.gnupg/private-keys-v1.d or ~/.gnupg/secring.gpg

Field Summary

Fields

Modifier and Type	Field and Description
private static java.nio.file.Path	GPG_DIRECTORY
private static org.slf4j.Logger	log
private BouncyCastleGpgKeyPassphrasePrompt	passphrasePrompt
private java.lang.String	signingKey
private static java.nio.file.Path	USER_KEYBOX_PATH
private static java.nio.file.Path	USER_PGP_LEGACY_SECRING_FILE
private static java.nio.file.Path	USER_SECRET_KEY_DIR

Constructor Summary

Constructors

Constructor and Description
BouncyCastleGpgKeyLocator(java.lang.String signingKey, BouncyCastleGpgKeyPassphrasePrompt passphrasePrompt) Create a new key locator for the specified signing key.

Method Summary

Modifier and Type	Method and Description
private org.bouncycastle.openpgp.PGPSecretKey	attemptParseSecretKey(java.nio.file.Path keyFile, org.bouncycastle.openpgp.operator.PGPDigestCalculatorProvider calculatorProvider, org.bouncycastle.openpgp.operator.PBEProtectionRemoverFactory passphraseProvider, org.bouncycastle.openpgp.PGPPublicKey publicKey)
private boolean	containsSigningKey(java.lang.String userId)
private static java.nio.file.Path	findGpgDirectory()
private org.bouncycastle.openpgp.PGPPublicKey	findPublicKeyByKeyId(org.bouncycastle.gpg.keybox.KeyBlob keyBlob)
private org.bouncycastle.openpgp.PGPPublicKey	findPublicKeyByUserId(org.bouncycastle.gpg.keybox.KeyBlob keyBlob)
private org.bouncycastle.openpgp.PGPPublicKey	findPublicKeyInKeyBox(java.nio.file.Path keyboxFile) Finds a public key associated with the signing key.
BouncyCastleGpgKey	findSecretKey() Use pubring.kbx when available, if not fallback to secring.gpg or secret key path provided to parse and return secret key
private BouncyCastleGpgKey	findSecretKeyForKeyBoxPublicKey(org.bouncycastle.openpgp.PGPPublicKey publicKey, java.nio.file.Path userKeyboxPath)
private org.bouncycastle.openpgp.PGPSecretKey	findSecretKeyInLegacySecring(java.lang.String signingkey, java.nio.file.Path secringFile) Return the first suitable key for signing in the key ring collection.
private org.bouncycastle.openpgp.PGPPublicKey	getFirstPublicKey(org.bouncycastle.gpg.keybox.KeyBlob keyBlob)
private org.bouncycastle.gpg.keybox.KeyBox	readKeyBoxFile(java.nio.file.Path keyboxFile)

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.slf4j.Logger log

GPG_DIRECTORY

private static final java.nio.file.Path GPG_DIRECTORY

USER_KEYBOX_PATH

private static final java.nio.file.Path USER_KEYBOX_PATH

USER_SECRET_KEY_DIR

private static final java.nio.file.Path USER_SECRET_KEY_DIR

USER_PGP_LEGACY_SECRING_FILE

private static final java.nio.file.Path USER_PGP_LEGACY_SECRING_FILE

signingKey

private final java.lang.String signingKey

passphrasePrompt

private BouncyCastleGpgKeyPassphrasePrompt passphrasePrompt

Constructor Detail

BouncyCastleGpgKeyLocator

public BouncyCastleGpgKeyLocator(java.lang.String signingKey,
                                 @NonNull
                                 BouncyCastleGpgKeyPassphrasePrompt passphrasePrompt)

Create a new key locator for the specified signing key.

The signing key must either be a hex representation of a specific key or a user identity substring (eg., email address). All keys in the KeyBox will be looked up in the order as returned by the KeyBox. A key id will be searched before attempting to find a key by user id.

Parameters:

signingKey - the signing key to search for

passphrasePrompt - the provider to use when asking for key passphrase

Method Detail

findGpgDirectory

private static java.nio.file.Path findGpgDirectory()

attemptParseSecretKey

private org.bouncycastle.openpgp.PGPSecretKey attemptParseSecretKey(java.nio.file.Path keyFile,
                                                                    org.bouncycastle.openpgp.operator.PGPDigestCalculatorProvider calculatorProvider,
                                                                    org.bouncycastle.openpgp.operator.PBEProtectionRemoverFactory passphraseProvider,
                                                                    org.bouncycastle.openpgp.PGPPublicKey publicKey)

containsSigningKey

private boolean containsSigningKey(java.lang.String userId)

findPublicKeyByKeyId

private org.bouncycastle.openpgp.PGPPublicKey findPublicKeyByKeyId(org.bouncycastle.gpg.keybox.KeyBlob keyBlob)
                                                            throws java.io.IOException

Throws:

java.io.IOException

findPublicKeyByUserId

private org.bouncycastle.openpgp.PGPPublicKey findPublicKeyByUserId(org.bouncycastle.gpg.keybox.KeyBlob keyBlob)
                                                             throws java.io.IOException

Throws:

java.io.IOException

findPublicKeyInKeyBox

private org.bouncycastle.openpgp.PGPPublicKey findPublicKeyInKeyBox(java.nio.file.Path keyboxFile)
                                                             throws java.io.IOException,
                                                                    java.security.NoSuchAlgorithmException,
                                                                    java.security.NoSuchProviderException

Finds a public key associated with the signing key.

Parameters:

keyboxFile - the KeyBox file

Returns:

publicKey the public key (maybe null)

Throws:

java.io.IOException - in case of problems reading the file

java.security.NoSuchAlgorithmException

java.security.NoSuchProviderException

findSecretKey

public BouncyCastleGpgKey findSecretKey()
                                 throws java.io.IOException,
                                        java.security.NoSuchAlgorithmException,
                                        java.security.NoSuchProviderException,
                                        org.bouncycastle.openpgp.PGPException,
                                        CanceledException,
                                        UnsupportedCredentialItem,
                                        java.net.URISyntaxException

Use pubring.kbx when available, if not fallback to secring.gpg or secret key path provided to parse and return secret key

Returns:

the secret key

Throws:

java.io.IOException - in case of issues reading key files

java.security.NoSuchAlgorithmException

java.security.NoSuchProviderException

org.bouncycastle.openpgp.PGPException - in case of issues finding a key

CanceledException

java.net.URISyntaxException

UnsupportedCredentialItem

findSecretKeyForKeyBoxPublicKey

private BouncyCastleGpgKey findSecretKeyForKeyBoxPublicKey(org.bouncycastle.openpgp.PGPPublicKey publicKey,
                                                           java.nio.file.Path userKeyboxPath)
                                                    throws org.bouncycastle.openpgp.PGPException,
                                                           CanceledException,
                                                           UnsupportedCredentialItem,
                                                           java.net.URISyntaxException

Throws:

org.bouncycastle.openpgp.PGPException

CanceledException

UnsupportedCredentialItem

java.net.URISyntaxException

findSecretKeyInLegacySecring

private org.bouncycastle.openpgp.PGPSecretKey findSecretKeyInLegacySecring(java.lang.String signingkey,
                                                                           java.nio.file.Path secringFile)
                                                                    throws java.io.IOException,
                                                                           org.bouncycastle.openpgp.PGPException

Return the first suitable key for signing in the key ring collection. For this case we only expect there to be one key available for signing.

Parameters:

signingkey -

secringFile -

Returns:

the first suitable PGP secret key found for signing

Throws:

java.io.IOException - on I/O related errors

org.bouncycastle.openpgp.PGPException - on BouncyCastle errors

getFirstPublicKey

private org.bouncycastle.openpgp.PGPPublicKey getFirstPublicKey(org.bouncycastle.gpg.keybox.KeyBlob keyBlob)
                                                         throws java.io.IOException

Throws:

java.io.IOException

readKeyBoxFile

private org.bouncycastle.gpg.keybox.KeyBox readKeyBoxFile(java.nio.file.Path keyboxFile)
                                                   throws java.io.IOException,
                                                          java.security.NoSuchAlgorithmException,
                                                          java.security.NoSuchProviderException

Throws:

java.io.IOException

java.security.NoSuchAlgorithmException

java.security.NoSuchProviderException