PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-23 12:52:07 +01:00
Code Issues Releases Wiki Activity

Add documentation

Browse source
This commit is contained in:
Paul Schaub 2021-05-31 15:24:41 +02:00
parent 1ad23366a7
commit a871bc3a0c
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
pgpainless-core/src/main/java/org/pgpainless/key/info/KeyRingInfo.java
View file

@ -624,6 +624,16 @@ public class KeyRingInfo {
return SignatureUtils.getKeyExpirationDate(subkey.getCreationTime(), bindingSig); return SignatureUtils.getKeyExpirationDate(subkey.getCreationTime(), bindingSig);
} }
/**
* Return the latest date on which the key ring is still usable for the given key flag.
* If a only a subkey is carrying the required flag and the primary key expires earlier than the subkey,
* the expiry date of the primary key is returned.
*
* This method might return null, if the primary key and a subkey with the required flag does not expire.
* @param use key flag representing the use case, eg. {@link KeyFlag#SIGN_DATA} or
* {@link KeyFlag#ENCRYPT_COMMS}/{@link KeyFlag#ENCRYPT_STORAGE}.
* @return latest date on which the key ring can be used for the given use case, or null if it can be used indefinitely.
*/
public Date getExpirationDateForUse(KeyFlag use) { public Date getExpirationDateForUse(KeyFlag use) {
if (use == KeyFlag.SPLIT || use == KeyFlag.SHARED) { if (use == KeyFlag.SPLIT || use == KeyFlag.SHARED) {
throw new IllegalArgumentException("SPLIT and SHARED are not uses, but properties."); throw new IllegalArgumentException("SPLIT and SHARED are not uses, but properties.");
@ -634,6 +644,10 @@ public class KeyRingInfo {
Date latestSubkeyExpirationDate = null; Date latestSubkeyExpirationDate = null;
List<PGPPublicKey> keysWithFlag = getKeysWithKeyFlag(use); List<PGPPublicKey> keysWithFlag = getKeysWithKeyFlag(use);
if (keysWithFlag.isEmpty()) {
throw new NoSuchElementException("No key with the required key flag found.");
}
for (PGPPublicKey key : keysWithFlag) { for (PGPPublicKey key : keysWithFlag) {
Date subkeyExpirationDate = getSubkeyExpirationDate(new OpenPgpV4Fingerprint(key)); Date subkeyExpirationDate = getSubkeyExpirationDate(new OpenPgpV4Fingerprint(key));
if (subkeyExpirationDate == null) { if (subkeyExpirationDate == null) {
@ -752,6 +766,12 @@ public class KeyRingInfo {
return encryptionKeys; return encryptionKeys;
} }
/**
* Return a list of all keys which carry the provided key flag in their signature.
*
* @param flag flag
* @return keys with flag
*/
public List<PGPPublicKey> getKeysWithKeyFlag(KeyFlag flag) { public List<PGPPublicKey> getKeysWithKeyFlag(KeyFlag flag) {
List<PGPPublicKey> keysWithFlag = new ArrayList<>(); List<PGPPublicKey> keysWithFlag = new ArrayList<>();
for (PGPPublicKey key : getPublicKeys()) { for (PGPPublicKey key : getPublicKeys()) {