Class SignatureSubpacketsUtil
- java.lang.Object
-
- org.pgpainless.signature.subpackets.SignatureSubpacketsUtil
-
public final class SignatureSubpacketsUtil extends java.lang.Object
Utility class to access signature subpackets from signatures. Since rfc4880 is not always clear about where a signature subpacket can be located (hashed/unhashed area), this class makes some educated guesses as to where the subpacket may be found when necessary.
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static void
assureKeyCanCarryFlags(PublicKeyAlgorithm algorithm, KeyFlag... flags)
Make sure that a key of the givenPublicKeyAlgorithm
is able to carry the given key flags.static void
assureKeyCanCarryFlags(KeyType type, KeyFlag... flags)
Make sure that the given key type can carry the given key flags.static org.bouncycastle.openpgp.PGPSignatureList
getEmbeddedSignature(org.bouncycastle.openpgp.PGPSignature signature)
Return the embedded signature subpacket from the signatures hashed area.static org.bouncycastle.bcpg.sig.Exportable
getExportableCertification(org.bouncycastle.openpgp.PGPSignature signature)
Return the signatures exportable certification subpacket from the hashed area.static org.bouncycastle.bcpg.sig.Features
getFeatures(org.bouncycastle.openpgp.PGPSignature signature)
Return the features subpacket from the signatures hashed area.static java.util.List<org.bouncycastle.bcpg.sig.NotationData>
getHashedNotationData(org.bouncycastle.openpgp.PGPSignature signature)
Return the notation data subpackets from the signatures hashed area.static java.util.List<org.bouncycastle.bcpg.sig.NotationData>
getHashedNotationData(org.bouncycastle.openpgp.PGPSignature signature, java.lang.String notationName)
Return a list of allNotationData
objects from the hashed area of the signature that have a notation name equal to the given notationName argument.static java.util.List<org.bouncycastle.bcpg.sig.IntendedRecipientFingerprint>
getIntendedRecipientFingerprints(org.bouncycastle.openpgp.PGPSignature signature)
Return the intended recipients fingerprint subpackets from the hashed area of this signature.static org.bouncycastle.bcpg.sig.IssuerFingerprint
getIssuerFingerprint(org.bouncycastle.openpgp.PGPSignature signature)
Return the issuer-fingerprint subpacket of the signature.static OpenPgpFingerprint
getIssuerFingerprintAsOpenPgpFingerprint(org.bouncycastle.openpgp.PGPSignature signature)
Return theIssuerFingerprint
subpacket of the signature into aOpenPgpFingerprint
.static org.bouncycastle.bcpg.sig.IssuerKeyID
getIssuerKeyId(org.bouncycastle.openpgp.PGPSignature signature)
Return the issuer key-id subpacket of the signature.static java.lang.Long
getIssuerKeyIdAsLong(org.bouncycastle.openpgp.PGPSignature signature)
Inspect the given signature'sIssuerKeyID
packet to determine the issuer key-id.static org.bouncycastle.bcpg.sig.KeyExpirationTime
getKeyExpirationTime(org.bouncycastle.openpgp.PGPSignature signature)
Return the key expiration time subpacket of this signature.static java.util.Date
getKeyExpirationTimeAsDate(org.bouncycastle.openpgp.PGPSignature signature, org.bouncycastle.openpgp.PGPPublicKey signingKey)
Return the signatures key-expiration time as a date.static org.bouncycastle.bcpg.sig.KeyFlags
getKeyFlags(org.bouncycastle.openpgp.PGPSignature signature)
Return the key flags subpacket from the signatures hashed area.static long
getKeyLifetimeInSeconds(java.util.Date expirationDate, java.util.Date creationDate)
Calculate the duration in seconds until the key expires after creation.static org.bouncycastle.bcpg.sig.PreferredAlgorithms
getPreferredCompressionAlgorithms(org.bouncycastle.openpgp.PGPSignature signature)
Return the compression algorithm preferences from the signatures hashed area.static org.bouncycastle.bcpg.sig.PreferredAlgorithms
getPreferredHashAlgorithms(org.bouncycastle.openpgp.PGPSignature signature)
Return the hash algorithm preferences from the signatures hashed area.static org.bouncycastle.bcpg.sig.PreferredAlgorithms
getPreferredSymmetricAlgorithms(org.bouncycastle.openpgp.PGPSignature signature)
Return the symmetric algorithm preferences from the signatures hashed area.static org.bouncycastle.bcpg.sig.PrimaryUserID
getPrimaryUserId(org.bouncycastle.openpgp.PGPSignature signature)
Return the primary user-id subpacket from the signatures hashed area.static java.util.List<org.bouncycastle.bcpg.sig.RegularExpression>
getRegularExpressions(org.bouncycastle.openpgp.PGPSignature signature)
Return all regular expression subpackets from the hashed area of the given signature.static org.bouncycastle.bcpg.sig.Revocable
getRevocable(org.bouncycastle.openpgp.PGPSignature signature)
Return the revocable subpacket of this signature.static org.bouncycastle.bcpg.sig.RevocationKey
getRevocationKey(org.bouncycastle.openpgp.PGPSignature signature)
Return the revocation key subpacket from the signatures hashed area.static org.bouncycastle.bcpg.sig.RevocationReason
getRevocationReason(org.bouncycastle.openpgp.PGPSignature signature)
Return the revocation reason subpacket of the signature.static org.bouncycastle.bcpg.sig.SignatureCreationTime
getSignatureCreationTime(org.bouncycastle.openpgp.PGPSignature signature)
Return the signature creation time subpacket.static org.bouncycastle.bcpg.sig.SignatureExpirationTime
getSignatureExpirationTime(org.bouncycastle.openpgp.PGPSignature signature)
Return the signature expiration time subpacket of the signature.static java.util.Date
getSignatureExpirationTimeAsDate(org.bouncycastle.openpgp.PGPSignature signature)
Return the signatures' expiration time as a date.static <P extends org.bouncycastle.bcpg.SignatureSubpacket>
PgetSignatureSubpacket(org.bouncycastle.openpgp.PGPSignatureSubpacketVector vector, SignatureSubpacket type)
Return the last occurrence of a subpacket type in the given signature subpacket vector.static org.bouncycastle.bcpg.sig.SignatureTarget
getSignatureTarget(org.bouncycastle.openpgp.PGPSignature signature)
Return the signature target subpacket from the signature.static org.bouncycastle.bcpg.sig.SignerUserID
getSignerUserID(org.bouncycastle.openpgp.PGPSignature signature)
Return the signers user-id from the hashed area of the signature.static org.bouncycastle.bcpg.sig.TrustSignature
getTrustSignature(org.bouncycastle.openpgp.PGPSignature signature)
Return the trust signature packet from the signatures hashed area.static java.util.List<org.bouncycastle.bcpg.sig.NotationData>
getUnhashedNotationData(org.bouncycastle.openpgp.PGPSignature signature)
Return the notation data subpackets from the signatures unhashed area.static java.util.List<org.bouncycastle.bcpg.sig.NotationData>
getUnhashedNotationData(org.bouncycastle.openpgp.PGPSignature signature, java.lang.String notationName)
Return a list of allNotationData
objects from the unhashed area of the signature that have a notation name equal to the given notationName argument.static java.util.Set<Feature>
parseFeatures(org.bouncycastle.openpgp.PGPSignature signature)
Parse out the features subpacket of a signature.static java.util.List<KeyFlag>
parseKeyFlags(org.bouncycastle.openpgp.PGPSignature signature)
Return a list of key flags carried by the signature.static java.util.Set<CompressionAlgorithm>
parsePreferredCompressionAlgorithms(org.bouncycastle.openpgp.PGPSignature signature)
Return the preferredCompressionAlgorithms
as present in the signature.static java.util.Set<HashAlgorithm>
parsePreferredHashAlgorithms(org.bouncycastle.openpgp.PGPSignature signature)
Return the preferredHashAlgorithms
as present in the signature.static java.util.Set<SymmetricKeyAlgorithm>
parsePreferredSymmetricKeyAlgorithms(org.bouncycastle.openpgp.PGPSignature signature)
Return the preferredSymmetricKeyAlgorithms
as present in the signature.
-
-
-
Method Detail
-
getIssuerFingerprint
@Nullable public static org.bouncycastle.bcpg.sig.IssuerFingerprint getIssuerFingerprint(org.bouncycastle.openpgp.PGPSignature signature)
Return the issuer-fingerprint subpacket of the signature. Since this packet is self-authenticating, we expect it to be in the unhashed area, however as it cannot hurt we search for it in the hashed area first.- Parameters:
signature
- signature- Returns:
- issuer fingerprint or null
-
getIssuerFingerprintAsOpenPgpFingerprint
@Nullable public static OpenPgpFingerprint getIssuerFingerprintAsOpenPgpFingerprint(org.bouncycastle.openpgp.PGPSignature signature)
Return theIssuerFingerprint
subpacket of the signature into aOpenPgpFingerprint
. If no v4 issuer fingerprint is present in the signature, return null.- Parameters:
signature
- signature- Returns:
- v4 fingerprint of the issuer, or null
-
getIssuerKeyId
@Nullable public static org.bouncycastle.bcpg.sig.IssuerKeyID getIssuerKeyId(org.bouncycastle.openpgp.PGPSignature signature)
Return the issuer key-id subpacket of the signature. Since this packet is self-authenticating, we expect it to be in the unhashed area, however as it cannot hurt we search for it in the hashed area first.- Parameters:
signature
- signature- Returns:
- issuer key-id or null
-
getIssuerKeyIdAsLong
@Nullable public static java.lang.Long getIssuerKeyIdAsLong(org.bouncycastle.openpgp.PGPSignature signature)
Inspect the given signature'sIssuerKeyID
packet to determine the issuer key-id. If no such packet is present, return null.- Parameters:
signature
- signature- Returns:
- issuer key-id as
Long
-
getRevocationReason
@Nullable public static org.bouncycastle.bcpg.sig.RevocationReason getRevocationReason(org.bouncycastle.openpgp.PGPSignature signature)
Return the revocation reason subpacket of the signature. Since this packet is rather important for revocations, we only search for it in the hashed area of the signature.- Parameters:
signature
- signature- Returns:
- revocation reason
-
getSignatureCreationTime
@Nullable public static org.bouncycastle.bcpg.sig.SignatureCreationTime getSignatureCreationTime(org.bouncycastle.openpgp.PGPSignature signature)
Return the signature creation time subpacket. Since this packet is rather important, we only search for it in the hashed area of the signature.- Parameters:
signature
- signature- Returns:
- signature creation time subpacket
-
getSignatureExpirationTime
@Nullable public static org.bouncycastle.bcpg.sig.SignatureExpirationTime getSignatureExpirationTime(org.bouncycastle.openpgp.PGPSignature signature)
Return the signature expiration time subpacket of the signature. Since this packet is rather important, we only search for it in the hashed area of the signature.- Parameters:
signature
- signature- Returns:
- signature expiration time
-
getSignatureExpirationTimeAsDate
@Nullable public static java.util.Date getSignatureExpirationTimeAsDate(org.bouncycastle.openpgp.PGPSignature signature)
Return the signatures' expiration time as a date. The expiration date is computed by adding the expiration time to the signature creation date. If the signature has no expiration time subpacket, or the expiration time is set to '0', this message returns null.- Parameters:
signature
- signature- Returns:
- expiration time as date
-
getKeyExpirationTime
@Nullable public static org.bouncycastle.bcpg.sig.KeyExpirationTime getKeyExpirationTime(org.bouncycastle.openpgp.PGPSignature signature)
Return the key expiration time subpacket of this signature. We only look for it in the hashed area of the signature.- Parameters:
signature
- signature- Returns:
- key expiration time
-
getKeyExpirationTimeAsDate
@Nullable public static java.util.Date getKeyExpirationTimeAsDate(org.bouncycastle.openpgp.PGPSignature signature, org.bouncycastle.openpgp.PGPPublicKey signingKey)
Return the signatures key-expiration time as a date. The expiration date is computed by adding the signatures' key-expiration time to the signing keys creation date. If the signature does not have a key-expiration time subpacket, or its value is '0', this method returns null.- Parameters:
signature
- self-signature carrying the key-expiration time subpacketsigningKey
- signature creation key- Returns:
- key expiration time as date
-
getKeyLifetimeInSeconds
public static long getKeyLifetimeInSeconds(@Nullable java.util.Date expirationDate, @Nonnull java.util.Date creationDate)
Calculate the duration in seconds until the key expires after creation.- Parameters:
expirationDate
- new expiration datecreationDate
- key creation time- Returns:
- lifetime of the key in seconds
-
getRevocable
@Nullable public static org.bouncycastle.bcpg.sig.Revocable getRevocable(org.bouncycastle.openpgp.PGPSignature signature)
Return the revocable subpacket of this signature. We only look for it in the hashed area of the signature.- Parameters:
signature
- signature- Returns:
- revocable subpacket
-
getPreferredSymmetricAlgorithms
@Nullable public static org.bouncycastle.bcpg.sig.PreferredAlgorithms getPreferredSymmetricAlgorithms(org.bouncycastle.openpgp.PGPSignature signature)
Return the symmetric algorithm preferences from the signatures hashed area.- Parameters:
signature
- signature- Returns:
- symm. algo. prefs
-
parsePreferredSymmetricKeyAlgorithms
@Nonnull public static java.util.Set<SymmetricKeyAlgorithm> parsePreferredSymmetricKeyAlgorithms(org.bouncycastle.openpgp.PGPSignature signature)
Return the preferredSymmetricKeyAlgorithms
as present in the signature. If no preference is given with regard to symmetric encryption algorithms, return an empty set. In any case, the resulting set is ordered by occurrence (LinkedHashSet
).- Parameters:
signature
- signature- Returns:
- ordered set of symmetric key algorithm preferences
-
getPreferredHashAlgorithms
@Nullable public static org.bouncycastle.bcpg.sig.PreferredAlgorithms getPreferredHashAlgorithms(org.bouncycastle.openpgp.PGPSignature signature)
Return the hash algorithm preferences from the signatures hashed area.- Parameters:
signature
- signature- Returns:
- hash algo prefs
-
parsePreferredHashAlgorithms
@Nonnull public static java.util.Set<HashAlgorithm> parsePreferredHashAlgorithms(org.bouncycastle.openpgp.PGPSignature signature)
Return the preferredHashAlgorithms
as present in the signature. If no preference is given with regard to hash algorithms, return an empty set. In any case, the resulting set is ordered by occurrence (LinkedHashSet
).- Parameters:
signature
- signature- Returns:
- ordered set of hash algorithm preferences
-
getPreferredCompressionAlgorithms
@Nullable public static org.bouncycastle.bcpg.sig.PreferredAlgorithms getPreferredCompressionAlgorithms(org.bouncycastle.openpgp.PGPSignature signature)
Return the compression algorithm preferences from the signatures hashed area.- Parameters:
signature
- signature- Returns:
- compression algo prefs
-
parsePreferredCompressionAlgorithms
@Nonnull public static java.util.Set<CompressionAlgorithm> parsePreferredCompressionAlgorithms(org.bouncycastle.openpgp.PGPSignature signature)
Return the preferredCompressionAlgorithms
as present in the signature. If no preference is given with regard to compression algorithms, return an empty set. In any case, the resulting set is ordered by occurrence (LinkedHashSet
).- Parameters:
signature
- signature- Returns:
- ordered set of compression algorithm preferences
-
getPrimaryUserId
@Nullable public static org.bouncycastle.bcpg.sig.PrimaryUserID getPrimaryUserId(org.bouncycastle.openpgp.PGPSignature signature)
Return the primary user-id subpacket from the signatures hashed area.- Parameters:
signature
- signature- Returns:
- primary user id
-
getKeyFlags
@Nullable public static org.bouncycastle.bcpg.sig.KeyFlags getKeyFlags(org.bouncycastle.openpgp.PGPSignature signature)
Return the key flags subpacket from the signatures hashed area.- Parameters:
signature
- signature- Returns:
- key flags
-
parseKeyFlags
@Nullable public static java.util.List<KeyFlag> parseKeyFlags(@Nullable org.bouncycastle.openpgp.PGPSignature signature)
Return a list of key flags carried by the signature. If the signature is null, or has noKeyFlags
subpacket, return null.- Parameters:
signature
- signature- Returns:
- list of key flags
-
getFeatures
@Nullable public static org.bouncycastle.bcpg.sig.Features getFeatures(org.bouncycastle.openpgp.PGPSignature signature)
Return the features subpacket from the signatures hashed area.- Parameters:
signature
- signature- Returns:
- features subpacket
-
parseFeatures
@Nullable public static java.util.Set<Feature> parseFeatures(org.bouncycastle.openpgp.PGPSignature signature)
Parse out the features subpacket of a signature. If the signature has no features subpacket, return null. Otherwise, return the features as a feature set.- Parameters:
signature
- signature- Returns:
- features as set
-
getSignatureTarget
@Nullable public static org.bouncycastle.bcpg.sig.SignatureTarget getSignatureTarget(org.bouncycastle.openpgp.PGPSignature signature)
Return the signature target subpacket from the signature. We search for this subpacket in the hashed and unhashed area (in this order).- Parameters:
signature
- signature- Returns:
- signature target
-
getHashedNotationData
@Nonnull public static java.util.List<org.bouncycastle.bcpg.sig.NotationData> getHashedNotationData(org.bouncycastle.openpgp.PGPSignature signature)
Return the notation data subpackets from the signatures hashed area.- Parameters:
signature
- signature- Returns:
- hashed notations
-
getHashedNotationData
@Nonnull public static java.util.List<org.bouncycastle.bcpg.sig.NotationData> getHashedNotationData(org.bouncycastle.openpgp.PGPSignature signature, java.lang.String notationName)
Return a list of allNotationData
objects from the hashed area of the signature that have a notation name equal to the given notationName argument.- Parameters:
signature
- signaturenotationName
- notation name- Returns:
- list of matching notation data objects
-
getUnhashedNotationData
@Nonnull public static java.util.List<org.bouncycastle.bcpg.sig.NotationData> getUnhashedNotationData(org.bouncycastle.openpgp.PGPSignature signature)
Return the notation data subpackets from the signatures unhashed area.- Parameters:
signature
- signature- Returns:
- unhashed notations
-
getUnhashedNotationData
@Nonnull public static java.util.List<org.bouncycastle.bcpg.sig.NotationData> getUnhashedNotationData(org.bouncycastle.openpgp.PGPSignature signature, java.lang.String notationName)
Return a list of allNotationData
objects from the unhashed area of the signature that have a notation name equal to the given notationName argument.- Parameters:
signature
- signaturenotationName
- notation name- Returns:
- list of matching notation data objects
-
getRevocationKey
@Nullable public static org.bouncycastle.bcpg.sig.RevocationKey getRevocationKey(org.bouncycastle.openpgp.PGPSignature signature)
Return the revocation key subpacket from the signatures hashed area.- Parameters:
signature
- signature- Returns:
- revocation key
-
getSignerUserID
@Nullable public static org.bouncycastle.bcpg.sig.SignerUserID getSignerUserID(org.bouncycastle.openpgp.PGPSignature signature)
Return the signers user-id from the hashed area of the signature. TODO: Can this subpacket also be found in the unhashed area?- Parameters:
signature
- signature- Returns:
- signers user-id
-
getIntendedRecipientFingerprints
@Nonnull public static java.util.List<org.bouncycastle.bcpg.sig.IntendedRecipientFingerprint> getIntendedRecipientFingerprints(org.bouncycastle.openpgp.PGPSignature signature)
Return the intended recipients fingerprint subpackets from the hashed area of this signature.- Parameters:
signature
- signature- Returns:
- intended recipient fingerprint subpackets
-
getEmbeddedSignature
@Nullable public static org.bouncycastle.openpgp.PGPSignatureList getEmbeddedSignature(org.bouncycastle.openpgp.PGPSignature signature) throws org.bouncycastle.openpgp.PGPException
Return the embedded signature subpacket from the signatures hashed area.- Parameters:
signature
- signature- Returns:
- embedded signature
- Throws:
org.bouncycastle.openpgp.PGPException
- in case the embedded signatures cannot be parsed
-
getExportableCertification
@Nullable public static org.bouncycastle.bcpg.sig.Exportable getExportableCertification(org.bouncycastle.openpgp.PGPSignature signature)
Return the signatures exportable certification subpacket from the hashed area.- Parameters:
signature
- signature- Returns:
- exportable certification subpacket
-
getTrustSignature
@Nullable public static org.bouncycastle.bcpg.sig.TrustSignature getTrustSignature(org.bouncycastle.openpgp.PGPSignature signature)
Return the trust signature packet from the signatures hashed area.- Parameters:
signature
- signature- Returns:
- trust signature subpacket
-
getRegularExpressions
public static java.util.List<org.bouncycastle.bcpg.sig.RegularExpression> getRegularExpressions(org.bouncycastle.openpgp.PGPSignature signature)
Return all regular expression subpackets from the hashed area of the given signature.- Parameters:
signature
- signature- Returns:
- list of regular expressions
-
getSignatureSubpacket
@Nullable public static <P extends org.bouncycastle.bcpg.SignatureSubpacket> P getSignatureSubpacket(org.bouncycastle.openpgp.PGPSignatureSubpacketVector vector, SignatureSubpacket type)
Return the last occurrence of a subpacket type in the given signature subpacket vector.- Type Parameters:
P
- generic return type of the subpacket- Parameters:
vector
- subpacket vector (hashed/unhashed)type
- subpacket type- Returns:
- last occurrence of the subpacket in the vector
-
assureKeyCanCarryFlags
public static void assureKeyCanCarryFlags(KeyType type, KeyFlag... flags)
Make sure that the given key type can carry the given key flags.- Parameters:
type
- key typeflags
- key flags
-
assureKeyCanCarryFlags
public static void assureKeyCanCarryFlags(PublicKeyAlgorithm algorithm, KeyFlag... flags)
Make sure that a key of the givenPublicKeyAlgorithm
is able to carry the given key flags.- Parameters:
algorithm
- key algorithmflags
- key flags
-
-