org.bouncycastle.openpgp.api

Class OpenPGPCertificate.OpenPGPComponentKey

java.lang.Object

org.bouncycastle.openpgp.api.OpenPGPCertificate.OpenPGPCertificateComponent

org.bouncycastle.openpgp.api.OpenPGPCertificate.OpenPGPComponentKey

Direct Known Subclasses:

OpenPGPCertificate.OpenPGPPrimaryKey, OpenPGPCertificate.OpenPGPSubkey, OpenPGPKey.OpenPGPSecretKey

Enclosing class:

OpenPGPCertificate

public abstract static class OpenPGPCertificate.OpenPGPComponentKey
extends OpenPGPCertificate.OpenPGPCertificateComponent

A component key is either an OpenPGPCertificate.OpenPGPPrimaryKey, or an OpenPGPCertificate.OpenPGPSubkey.

See Also:

OpenPGP for Application Developers - Layers of keys in OpenPGP

Field Summary

Fields

Modifier and Type	Field and Description
protected PGPPublicKey	rawPubkey

Constructor Summary

Constructors

Constructor and Description
OpenPGPComponentKey(PGPPublicKey rawPubkey, OpenPGPCertificate certificate) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	getAlgorithm() Return the public key algorithm.
java.util.Date	getCreationTime() Return the creation time of this key.
protected OpenPGPCertificate.OpenPGPComponentKey	getKeyComponent() Return the OpenPGPCertificate.OpenPGPComponentKey belonging to this OpenPGPCertificate.OpenPGPCertificateComponent.
KeyIdentifier	getKeyIdentifier() Return the KeyIdentifier of this key.
OpenPGPCertificate.OpenPGPComponentSignature	getLatestSelfSignature(java.util.Date evaluationTime) Return the (at evaluation time) latest self-signature on the component.
PGPPublicKey	getPGPPublicKey() Return the underlying PGPPublicKey of this OpenPGPCertificate.OpenPGPComponentKey.
int	getVersion() Return the public key version.
int	hashCode()
boolean	isCertificationKey() Return true, if the key is currently marked as certification key that can sign 3rd-party certificates.
boolean	isCertificationKey(java.util.Date evaluationTime) Return true, if the key is - at evaluation time - marked as certification key that can sign 3rd-party certificates.
boolean	isEncryptionKey() Return true, if the key is currently marked as encryption key.
boolean	isEncryptionKey(java.util.Date evaluationTime) Return true, if the key is - at evaluation time - marked as an encryption key.
boolean	isEncryptionKey(java.util.Date evaluationTime, int... keyFlags) Return true, if the key is - at evaluation time - marked as an encryption key and carries any of the given key flags.
abstract boolean	isPrimaryKey() Return true, if this OpenPGPCertificate.OpenPGPComponentKey represents the primary key of an OpenPGPCertificate.
boolean	isSigningKey() Return true, if the key is currently marked as a signing key for message signing.
boolean	isSigningKey(java.util.Date evaluationTime) Return true, if the key is - at evaluation time - marked as signing key for message signing.

Methods inherited from class org.bouncycastle.openpgp.api.OpenPGPCertificate.OpenPGPCertificateComponent

getAEADCipherSuitePreferences, getAEADCipherSuitePreferences, getApplyingSubpacket, getCertificate, getCertification, getCertification, getCompressionAlgorithmPreferences, getCompressionAlgorithmPreferences, getFeatures, getFeatures, getHashAlgorithmPreferences, getHashAlgorithmPreferences, getKeyExpirationDate, getKeyExpirationDateAt, getKeyFlags, getKeyFlags, getLatestSelfSignature, getMergedDanglingExternalSignatureChainEndsFrom, getPublicComponent, getRevocation, getRevocation, getSelfSignatureChains, getSignatureChains, getSymmetricCipherPreferences, getSymmetricCipherPreferences, getThirdPartyCertifications, getThirdPartyRevocations, getThirdPartySignatureChainsBy, hasKeyFlags, isBound, isBoundAt, toDetailString

Methods inherited from class java.lang.Object

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

Field Detail

rawPubkey

protected final PGPPublicKey rawPubkey

Constructor Detail

OpenPGPComponentKey

public OpenPGPComponentKey(PGPPublicKey rawPubkey,
                           OpenPGPCertificate certificate)

Constructor.

Parameters:

rawPubkey - public key

certificate - certificate

Method Detail

getPGPPublicKey

public PGPPublicKey getPGPPublicKey()

Return the underlying PGPPublicKey of this OpenPGPCertificate.OpenPGPComponentKey.

Returns:

public key

getKeyIdentifier

public KeyIdentifier getKeyIdentifier()

Return the KeyIdentifier of this key.

Returns:

key identifier

getAlgorithm

public int getAlgorithm()

Return the public key algorithm.

Returns:

public key algorithm id

See Also:

PublicKeyAlgorithmTags

getVersion

public int getVersion()

Return the public key version.

Returns:

key version

getCreationTime

public java.util.Date getCreationTime()

Return the creation time of this key.

Returns:

creation time

isPrimaryKey

public abstract boolean isPrimaryKey()

Return true, if this OpenPGPCertificate.OpenPGPComponentKey represents the primary key of an OpenPGPCertificate.

Returns:

true if primary, false if subkey

getLatestSelfSignature

public OpenPGPCertificate.OpenPGPComponentSignature getLatestSelfSignature(java.util.Date evaluationTime)

Description copied from class: OpenPGPCertificate.OpenPGPCertificateComponent

Return the (at evaluation time) latest self-signature on the component. That might either be a certification signature, or a revocation.

Specified by:

getLatestSelfSignature in class OpenPGPCertificate.OpenPGPCertificateComponent

Parameters:

evaluationTime - reference time

Returns:

latest self signature

isEncryptionKey

public boolean isEncryptionKey()

Return true, if the key is currently marked as encryption key.

Returns:

true if the key is an encryption key, false otherwise

isEncryptionKey

public boolean isEncryptionKey(java.util.Date evaluationTime)

Return true, if the key is - at evaluation time - marked as an encryption key.

Parameters:

evaluationTime - evaluation time

Returns:

true if key is an encryption key at evaluation time, false otherwise

isEncryptionKey

public boolean isEncryptionKey(java.util.Date evaluationTime,
                               int... keyFlags)

Return true, if the key is - at evaluation time - marked as an encryption key and carries any of the given key flags. Note: To check if the key has EITHER flag A or B, call

isEncryptionKey(evalTime, A, B)

. To instead check, if the key has BOTH flags A AND B, call

isEncryptionKey(evalTime, A | B)

.

Parameters:

evaluationTime - evaluation time

keyFlags - key flags

Returns:

true if the key is an encryption key for any of the given key flags

isSigningKey

public boolean isSigningKey()

Return true, if the key is currently marked as a signing key for message signing.

Returns:

true, if key is currently signing key

isSigningKey

public boolean isSigningKey(java.util.Date evaluationTime)

Return true, if the key is - at evaluation time - marked as signing key for message signing.

Parameters:

evaluationTime - evaluation time

Returns:

true if key is signing key at evaluation time

isCertificationKey

public boolean isCertificationKey()

Return true, if the key is currently marked as certification key that can sign 3rd-party certificates.

Returns:

true, if key is certification key

isCertificationKey

public boolean isCertificationKey(java.util.Date evaluationTime)

Return true, if the key is - at evaluation time - marked as certification key that can sign 3rd-party certificates.

Parameters:

evaluationTime - evaluation time

Returns:

true if key is certification key at evaluation time

getKeyComponent

protected OpenPGPCertificate.OpenPGPComponentKey getKeyComponent()

Description copied from class: OpenPGPCertificate.OpenPGPCertificateComponent

Return the OpenPGPCertificate.OpenPGPComponentKey belonging to this OpenPGPCertificate.OpenPGPCertificateComponent. If this OpenPGPCertificate.OpenPGPCertificateComponent is an instance of OpenPGPCertificate.OpenPGPComponentKey, the method simply returns

this

. If instead, the OpenPGPCertificate.OpenPGPCertificateComponent is an OpenPGPCertificate.OpenPGPIdentityComponent, the primary key it is bound to is returned.

Specified by:

getKeyComponent in class OpenPGPCertificate.OpenPGPCertificateComponent

Returns:

OpenPGPCertificate.OpenPGPComponentKey of this OpenPGPCertificate.OpenPGPCertificateComponent.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object