org.bouncycastle.openpgp.api

Class OpenPGPCertificate.OpenPGPCertificateComponent

java.lang.Object

org.bouncycastle.openpgp.api.OpenPGPCertificate.OpenPGPCertificateComponent

Direct Known Subclasses:

OpenPGPCertificate.OpenPGPComponentKey, OpenPGPCertificate.OpenPGPIdentityComponent

Enclosing class:

OpenPGPCertificate

public abstract static class OpenPGPCertificate.OpenPGPCertificateComponent
extends java.lang.Object

Component on an OpenPGP certificate. Components can either be keys or identities.

Constructor Summary

Constructors

Constructor and Description
OpenPGPCertificateComponent(OpenPGPCertificate certificate)

Method Summary

Modifier and Type	Method and Description
PreferredAEADCiphersuites	getAEADCipherSuitePreferences() Return the PreferredAEADCiphersuites that apply to this (sub-)key.
PreferredAEADCiphersuites	getAEADCipherSuitePreferences(java.util.Date evaluationTime) Return the PreferredAEADCiphersuites that - at evaluation time - apply to this (sub-)key.
protected OpenPGPSignature.OpenPGPSignatureSubpacket	getApplyingSubpacket(java.util.Date evaluationTime, int subpacketType) Return the SignatureSubpacket instance of the given subpacketType, which currently applies to the key.
OpenPGPCertificate	getCertificate() Return this components OpenPGPCertificate.
OpenPGPCertificate.OpenPGPComponentSignature	getCertification() Return the latest self-signature certification binding this component.
OpenPGPCertificate.OpenPGPComponentSignature	getCertification(java.util.Date evaluationTime) Return the (at evaluation time) latest self certification signature binding this component.
PreferredAlgorithms	getCompressionAlgorithmPreferences() Return the compression algorithm preferences of this (sub-)key.
PreferredAlgorithms	getCompressionAlgorithmPreferences(java.util.Date evaluationTime) Return the compression algorithm preferences of this (sub-)key at evaluation time.
Features	getFeatures() Return the Features signature subpacket that currently applies to the key.
Features	getFeatures(java.util.Date evaluationTime) Return the Features signature subpacket that - at evaluation time - applies to the key.
PreferredAlgorithms	getHashAlgorithmPreferences() Return the current signature hash algorithm preferences of this (sub-)key.
PreferredAlgorithms	getHashAlgorithmPreferences(java.util.Date evaluationTime) Return the signature hash algorithm preferences of this (sub-)key at evaluation time.
protected abstract OpenPGPCertificate.OpenPGPComponentKey	getKeyComponent() Return the OpenPGPCertificate.OpenPGPComponentKey belonging to this OpenPGPCertificate.OpenPGPCertificateComponent.
java.util.Date	getKeyExpirationDate() Return the Date, at which the key expires.
java.util.Date	getKeyExpirationDateAt(java.util.Date evaluationTime) Return the Date, at which the key - at evaluation time - expires.
KeyFlags	getKeyFlags() Return the KeyFlags signature subpacket that currently applies to the key.
KeyFlags	getKeyFlags(java.util.Date evaluationTime) Return the KeyFlags signature subpacket that - at evaluation time - applies to the key.
OpenPGPCertificate.OpenPGPComponentSignature	getLatestSelfSignature() Return the latest self-signature on the component.
abstract OpenPGPCertificate.OpenPGPComponentSignature	getLatestSelfSignature(java.util.Date evaluationTime) Return the (at evaluation time) latest self-signature on the component.
protected OpenPGPCertificate.OpenPGPSignatureChains	getMergedDanglingExternalSignatureChainEndsFrom(OpenPGPCertificate thirdPartyCertificate) Find all third-party component signatures on this component, which were issued by the given third-party certificate.
protected OpenPGPCertificate.OpenPGPCertificateComponent	getPublicComponent() Return the public OpenPGPCertificate.OpenPGPCertificateComponent that belongs to this component.
OpenPGPCertificate.OpenPGPComponentSignature	getRevocation() Return the latest revocation signature on this component.
OpenPGPCertificate.OpenPGPComponentSignature	getRevocation(java.util.Date evaluationTime) Return the (at evaluation time) latest self revocation signature revoking this component.
protected OpenPGPCertificate.OpenPGPSignatureChains	getSelfSignatureChains() Return all self-signature chains on components of this certificate.
OpenPGPCertificate.OpenPGPSignatureChains	getSignatureChains() Return all OpenPGPCertificate.OpenPGPSignatureChains that bind this component.
PreferredAlgorithms	getSymmetricCipherPreferences() Return the current symmetric encryption algorithm preferences of this (sub-)key.
PreferredAlgorithms	getSymmetricCipherPreferences(java.util.Date evaluationTime) Return the symmetric encryption algorithm preferences of this (sub-)key at evaluation time.
java.util.List<OpenPGPCertificate.OpenPGPComponentSignature>	getThirdPartyCertifications() Return a list of all third-party-issued certifying OpenPGPComponentSignatures on this component.
java.util.List<OpenPGPCertificate.OpenPGPComponentSignature>	getThirdPartyRevocations() Return a list of all third-party-issued revoking OpenPGPComponentSignatures on this component.
protected OpenPGPCertificate.OpenPGPSignatureChains	getThirdPartySignatureChainsBy(OpenPGPCertificate thirdPartyCertificate) Return all third-party signature chains originating from the given certificate on this certificate.
boolean	hasKeyFlags(java.util.Date evaluationTime, int... flags) Return true, if the key has any of the given key flags.
boolean	isBound() Return true, if the component is currently validly bound to the certificate.
boolean	isBoundAt(java.util.Date evaluationTime) Return true, if this component is - at evaluation time - properly bound to its certificate.
abstract java.lang.String	toDetailString() Return a detailed String representation of this component.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenPGPCertificateComponent

public OpenPGPCertificateComponent(OpenPGPCertificate certificate)

Method Detail

getCertificate

public OpenPGPCertificate getCertificate()

Return this components OpenPGPCertificate.

Returns:

certificate

toDetailString

public abstract java.lang.String toDetailString()

Return a detailed String representation of this component.

Returns:

detailed String representation

isBound

public boolean isBound()

Return true, if the component is currently validly bound to the certificate.

Returns:

true if bound

isBoundAt

public boolean isBoundAt(java.util.Date evaluationTime)

Return true, if this component is - at evaluation time - properly bound to its certificate.

Parameters:

evaluationTime - evaluation time

Returns:

true if bound, false otherwise

getSignatureChains

public OpenPGPCertificate.OpenPGPSignatureChains getSignatureChains()

Return all OpenPGPCertificate.OpenPGPSignatureChains that bind this component.

Returns:

signature chains

getSelfSignatureChains

protected OpenPGPCertificate.OpenPGPSignatureChains getSelfSignatureChains()

Return all self-signature chains on components of this certificate.

Returns:

self-signature chains

getThirdPartySignatureChainsBy

protected OpenPGPCertificate.OpenPGPSignatureChains getThirdPartySignatureChainsBy(OpenPGPCertificate thirdPartyCertificate)

Return all third-party signature chains originating from the given certificate on this certificate.

Parameters:

thirdPartyCertificate - third-party certificate

Returns:

all signature chains over this component which originate at the given third-party certificate.

getCertification

public OpenPGPCertificate.OpenPGPComponentSignature getCertification()

Return the latest self-signature certification binding this component.

Returns:

latest component certification signature

getCertification

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

Return the (at evaluation time) latest self certification signature binding this component.

Parameters:

evaluationTime - reference time

Returns:

latest component certification signature

getRevocation

public OpenPGPCertificate.OpenPGPComponentSignature getRevocation()

Return the latest revocation signature on this component.

Returns:

latest revocation

getRevocation

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

Return the (at evaluation time) latest self revocation signature revoking this component.

Parameters:

evaluationTime - reference time

Returns:

latest component revocation signature

getThirdPartyCertifications

public java.util.List<OpenPGPCertificate.OpenPGPComponentSignature> getThirdPartyCertifications()

Return a list of all third-party-issued certifying OpenPGPComponentSignatures on this component.

Returns:

all third-party issued certification signatures on this component.

getThirdPartyRevocations

public java.util.List<OpenPGPCertificate.OpenPGPComponentSignature> getThirdPartyRevocations()

Return a list of all third-party-issued revoking OpenPGPComponentSignatures on this component.

Returns:

all third-party issued revocation signatures on this component.

getLatestSelfSignature

public OpenPGPCertificate.OpenPGPComponentSignature getLatestSelfSignature()

Return the latest self-signature on the component. That might either be a certification signature, or a revocation.

Returns:

latest self signature

getLatestSelfSignature

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

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

Parameters:

evaluationTime - reference time

Returns:

latest self signature

getPublicComponent

protected OpenPGPCertificate.OpenPGPCertificateComponent getPublicComponent()

Return the public OpenPGPCertificate.OpenPGPCertificateComponent that belongs to this component. For public components (pubkeys, identities...), that's simply this, while secret components return their corresponding public component. This is used to properly map secret key and public key components in Maps that use components as map keys.

Returns:

public certificate component

getKeyComponent

protected abstract OpenPGPCertificate.OpenPGPComponentKey getKeyComponent()

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.

Returns:

OpenPGPCertificate.OpenPGPComponentKey of this OpenPGPCertificate.OpenPGPCertificateComponent.

getKeyFlags

public KeyFlags getKeyFlags()

Return the KeyFlags signature subpacket that currently applies to the key.

Returns:

key flags subpacket

getKeyFlags

public KeyFlags getKeyFlags(java.util.Date evaluationTime)

Return the KeyFlags signature subpacket that - at evaluation time - applies to the key.

Parameters:

evaluationTime - evaluation time

Returns:

key flags subpacket

hasKeyFlags

public boolean hasKeyFlags(java.util.Date evaluationTime,
                           int... flags)

Return

true

, if the key has any of the given key flags.

Note: To check if the key has EITHER flag A or B, call

hasKeyFlags(evalTime, A, B)

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

hasKeyFlags(evalTime, A | B)

.

Parameters:

evaluationTime - evaluation time

flags - key flags (see KeyFlags for possible values)

Returns:

true if the key has ANY of the provided flags

getFeatures

public Features getFeatures()

Return the Features signature subpacket that currently applies to the key.

Returns:

feature signature subpacket

getFeatures

public Features getFeatures(java.util.Date evaluationTime)

Return the Features signature subpacket that - at evaluation time - applies to the key.

Parameters:

evaluationTime - evaluation time

Returns:

features subpacket

getAEADCipherSuitePreferences

public PreferredAEADCiphersuites getAEADCipherSuitePreferences()

Return the PreferredAEADCiphersuites that apply to this (sub-)key. Note: This refers to AEAD preferences as defined in rfc9580, NOT LibrePGP AEAD algorithms.

Returns:

AEAD algorithm preferences

getAEADCipherSuitePreferences

public PreferredAEADCiphersuites getAEADCipherSuitePreferences(java.util.Date evaluationTime)

Return the PreferredAEADCiphersuites that - at evaluation time - apply to this (sub-)key. Note: This refers to AEAD preferences as defined in rfc9580, NOT LibrePGP AEAD algorithms.

Parameters:

evaluationTime - evaluation time

Returns:

AEAD algorithm preferences at evaluation time

getSymmetricCipherPreferences

public PreferredAlgorithms getSymmetricCipherPreferences()

Return the current symmetric encryption algorithm preferences of this (sub-)key.

Returns:

current preferred symmetric-key algorithm preferences

getSymmetricCipherPreferences

public PreferredAlgorithms getSymmetricCipherPreferences(java.util.Date evaluationTime)

Return the symmetric encryption algorithm preferences of this (sub-)key at evaluation time.

Parameters:

evaluationTime - evaluation time

Returns:

current preferred symmetric-key algorithm preferences

getHashAlgorithmPreferences

public PreferredAlgorithms getHashAlgorithmPreferences()

Return the current signature hash algorithm preferences of this (sub-)key.

Returns:

hash algorithm preferences

getHashAlgorithmPreferences

public PreferredAlgorithms getHashAlgorithmPreferences(java.util.Date evaluationTime)

Return the signature hash algorithm preferences of this (sub-)key at evaluation time.

Parameters:

evaluationTime - evaluation time

Returns:

hash algorithm preferences

getCompressionAlgorithmPreferences

public PreferredAlgorithms getCompressionAlgorithmPreferences()

Return the compression algorithm preferences of this (sub-)key.

Returns:

compression algorithm preferences

getCompressionAlgorithmPreferences

public PreferredAlgorithms getCompressionAlgorithmPreferences(java.util.Date evaluationTime)

Return the compression algorithm preferences of this (sub-)key at evaluation time.

Parameters:

evaluationTime - reference time

Returns:

compression algorithm preferences

getKeyExpirationDate

public java.util.Date getKeyExpirationDate()

Return the Date, at which the key expires.

Returns:

key expiration time

getKeyExpirationDateAt

public java.util.Date getKeyExpirationDateAt(java.util.Date evaluationTime)

Return the Date, at which the key - at evaluation time - expires.

Parameters:

evaluationTime - evaluation time

Returns:

key expiration time

getApplyingSubpacket

protected OpenPGPSignature.OpenPGPSignatureSubpacket getApplyingSubpacket(java.util.Date evaluationTime,
                                                                          int subpacketType)

Return the SignatureSubpacket instance of the given subpacketType, which currently applies to the key. Since subpackets from the Direct-Key signature apply to all subkeys of a certificate, this method first inspects the signature that immediately applies to this key (e.g. a subkey-binding signature), and - if the queried subpacket is found in there, returns that instance. Otherwise, indirectly applying signatures (e.g. Direct-Key signatures) are queried. That way, preferences from the direct-key signature are considered, but per-key overwrites take precedence.

Parameters:

evaluationTime - evaluation time

subpacketType - subpacket type that is being searched for

Returns:

subpacket from directly or indirectly applying signature

See Also:

OpenPGP for application developers - Attribute Shadowing

getMergedDanglingExternalSignatureChainEndsFrom

protected OpenPGPCertificate.OpenPGPSignatureChains getMergedDanglingExternalSignatureChainEndsFrom(OpenPGPCertificate thirdPartyCertificate)

Find all third-party component signatures on this component, which were issued by the given third-party certificate. Find the OpenPGPCertificate.OpenPGPSignatureChains binding the issuing component key and append the third-party signatures as leaf links. Return all such chains. This is a utility method for third-party signature chain evaluation.

Parameters:

thirdPartyCertificate - third-party certificate

Returns:

dangling external signatures with issuer signature chains prepended