Package org.apache.sshd.openpgp

Class PGPPublicRingWatcher

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.util.io.ModifiableFileWatcher

org.apache.sshd.openpgp.PGPPublicRingWatcher

All Implemented Interfaces:

PublicKeyEntryResolver, PGPAuthorizedKeyEntriesLoader, PGPPublicKeyExtractor

public class PGPPublicRingWatcher
extends ModifiableFileWatcher
implements PGPAuthorizedKeyEntriesLoader

TODO Add javadoc

Author:

Apache MINA SSHD Project

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GPG_V1_PUBLIC_RING_FILENAME
static final String	GPG_V2_PUBLIC_RING_FILENAME
static final List<String>	PUBLIC_RING_FILES	V1 and V2 known public ring file names in order of preference
protected final AtomicReference<NavigableMap<String,PublicKey>>	ringKeys	Holds a Map whose key=the fingerprint (case insensitive), value=the associated PublicKey

Fields inherited from class org.apache.sshd.common.util.io.ModifiableFileWatcher

options, STRICTLY_PROHIBITED_FILE_PERMISSION

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.common.config.keys.PublicKeyEntryResolver

FAILING, IGNORING, UNSUPPORTED

Constructor Summary

Constructors

Constructor	Description
PGPPublicRingWatcher(Path file)

Method Summary

Modifier and Type	Method	Description
static Path	detectDefaultPublicRingFilePath()
static Path	detectDefaultPublicRingFilePath(Path dir)	Checks if either the "pubring.gpg" or "pubring.kbx" exist as a regular file and can be read.
<K extends PublicKey> K	generatePublicKey(String algorithm, Class<K> keyType, KeySpec keySpec)
protected KeyFactory	getKeyFactory(String algorithm)
protected PublicKey	handleDuplicateKeyFingerprint(SessionContext session, NamedResource resourceKey, String fingerprint, org.c02e.jpgpj.Subkey subKey, PublicKey k1, PublicKey k2)	/** Invoked if duplicate public keys found for the same fingerprint
protected PublicKey	handlePublicKeyExtractionError(SessionContext session, NamedResource resourceKey, String fingerprint, org.c02e.jpgpj.Subkey subKey, Throwable reason)	Invoked if failed to extract a PublicKey from a given Subkey
List<PublicKey>	loadMatchingKeyFingerprints(SessionContext session, Collection<String> fingerprints)
protected NavigableMap<String,PublicKey>	reloadRingKeys(SessionContext session, NamedResource resourceKey, Collection<org.c02e.jpgpj.Key> keys)
protected NavigableMap<String,PublicKey>	reloadRingKeys(SessionContext session, NamedResource resourceKey, org.c02e.jpgpj.Ring ring)
protected NavigableMap<String,PublicKey>	reloadRingKeys(SessionContext session, IoResource<?> resourceKey)
protected NavigableMap<String,PublicKey>	resolveRingKeys(SessionContext session)

Methods inherited from class org.apache.sshd.common.util.io.ModifiableFileWatcher

checkReloadRequired, exists, getPath, lastModified, resetReloadAttributes, size, toPathResource, toPathResource, toString, updateReloadAttributes, validateStrictConfigFilePermissions

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.openpgp.PGPAuthorizedKeyEntriesLoader

loadMatchingAuthorizedEntries, resolve, resolveAuthorizedEntries

Methods inherited from interface org.apache.sshd.openpgp.PGPPublicKeyExtractor

extractDSSPublicKey, extractECDSAPublicKey, extractECPublicKey, extractEdDSAPublicKey, extractPublicKey, extractRSAPublicKey

Field Details

GPG_V1_PUBLIC_RING_FILENAME

public static final String GPG_V1_PUBLIC_RING_FILENAME

See Also:

• Removal of the secret keyring
• Constant Field Values

GPG_V2_PUBLIC_RING_FILENAME

public static final String GPG_V2_PUBLIC_RING_FILENAME

See Also:

• Constant Field Values

PUBLIC_RING_FILES

public static final List<String> PUBLIC_RING_FILES

V1 and V2 known public ring file names in order of preference

ringKeys

protected final AtomicReference<NavigableMap<String,PublicKey>> ringKeys

Holds a Map whose key=the fingerprint (case insensitive), value=the associated PublicKey

Constructor Details

PGPPublicRingWatcher

public PGPPublicRingWatcher(Path file)

Method Details

loadMatchingKeyFingerprints

public List<PublicKey> loadMatchingKeyFingerprints(SessionContext session,
 Collection<String> fingerprints)
                                            throws IOException,
GeneralSecurityException,
org.bouncycastle.openpgp.PGPException

Specified by:

loadMatchingKeyFingerprints in interface PGPAuthorizedKeyEntriesLoader

Throws:

IOException

GeneralSecurityException

org.bouncycastle.openpgp.PGPException

resolveRingKeys

protected NavigableMap<String,PublicKey> resolveRingKeys(SessionContext session)
                                                  throws IOException,
GeneralSecurityException,
org.bouncycastle.openpgp.PGPException

Throws:

IOException

GeneralSecurityException

org.bouncycastle.openpgp.PGPException

reloadRingKeys

protected NavigableMap<String,PublicKey> reloadRingKeys(SessionContext session,
 IoResource<?> resourceKey)
                                                 throws IOException,
GeneralSecurityException,
org.bouncycastle.openpgp.PGPException

Throws:

IOException

GeneralSecurityException

org.bouncycastle.openpgp.PGPException

reloadRingKeys

protected NavigableMap<String,PublicKey> reloadRingKeys(SessionContext session,
 NamedResource resourceKey,
 org.c02e.jpgpj.Ring ring)
                                                 throws IOException,
GeneralSecurityException,
org.bouncycastle.openpgp.PGPException

Throws:

IOException

GeneralSecurityException

org.bouncycastle.openpgp.PGPException

reloadRingKeys

protected NavigableMap<String,PublicKey> reloadRingKeys(SessionContext session,
 NamedResource resourceKey,
 Collection<org.c02e.jpgpj.Key> keys)
                                                 throws IOException,
GeneralSecurityException,
org.bouncycastle.openpgp.PGPException

Throws:

IOException

GeneralSecurityException

org.bouncycastle.openpgp.PGPException

handlePublicKeyExtractionError

protected PublicKey handlePublicKeyExtractionError(SessionContext session,
 NamedResource resourceKey,
 String fingerprint,
 org.c02e.jpgpj.Subkey subKey,
 Throwable reason)
                                            throws IOException,
GeneralSecurityException,
org.bouncycastle.openpgp.PGPException

Invoked if failed to extract a PublicKey from a given Subkey

Parameters:

session - The SessionContext of the invocation - may be null if no session context available (e.g., offline tool invocation)

resourceKey - A key representing the resource from which the key data was read

fingerprint - The fingerprint value

subKey - The Subkey that contains the failed public key

reason - The reason for the failure

Returns:

The effective key to use - if null (default behavior) then sub-key is skipped

Throws:

IOException - If failed to process some internal data stream

GeneralSecurityException - If failed to generate a surrogate key

org.bouncycastle.openpgp.PGPException - If failed to convert PGP key to Java one

handleDuplicateKeyFingerprint

protected PublicKey handleDuplicateKeyFingerprint(SessionContext session,
 NamedResource resourceKey,
 String fingerprint,
 org.c02e.jpgpj.Subkey subKey,
 PublicKey k1,
 PublicKey k2)
                                           throws IOException,
GeneralSecurityException,
org.bouncycastle.openpgp.PGPException

/** Invoked if duplicate public keys found for the same fingerprint

Parameters:

session - The SessionContext of the invocation - may be null if no session context available (e.g., offline tool invocation)

resourceKey - A key representing the resource from which the key data was read

fingerprint - The duplicate fingerprint

subKey - The Subkey from which the duplicate originated

k1 - The original PublicKey associated with this fingerprint

k2 - The replacing PublicKey associated for same fingerprint

Returns:

The effective key to use (default=the replacing one) - if null then associated for the specified fingerprint is nullified

Throws:

IOException - If failed to process some internal data stream

GeneralSecurityException - If failed to generate a surrogate key

org.bouncycastle.openpgp.PGPException - If failed to convert PGP key to Java one

generatePublicKey

public <K extends PublicKey> K generatePublicKey(String algorithm,
 Class<K> keyType,
 KeySpec keySpec)
                                          throws GeneralSecurityException

Specified by:

generatePublicKey in interface PGPPublicKeyExtractor

Throws:

GeneralSecurityException

getKeyFactory

protected KeyFactory getKeyFactory(String algorithm)
                            throws GeneralSecurityException

Throws:

GeneralSecurityException

detectDefaultPublicRingFilePath

public static Path detectDefaultPublicRingFilePath()

detectDefaultPublicRingFilePath

public static Path detectDefaultPublicRingFilePath(Path dir)

Checks if either the "pubring.gpg" or "pubring.kbx" exist as a regular file and can be read. Note: it attempts the V2 file first.

Parameters:

dir - The directory to look into

Returns:

The resolved Path - null if none of the files exists.