From a6dcf027c02055161cdc05286442252019189f5f Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Mon, 7 Mar 2022 10:36:20 +0100 Subject: [PATCH] Add and document PGPainless.inspectKeyRing(key, date) --- .../src/main/java/org/pgpainless/PGPainless.java | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/pgpainless-core/src/main/java/org/pgpainless/PGPainless.java b/pgpainless-core/src/main/java/org/pgpainless/PGPainless.java index 57dd29d5..bd353f24 100644 --- a/pgpainless-core/src/main/java/org/pgpainless/PGPainless.java +++ b/pgpainless-core/src/main/java/org/pgpainless/PGPainless.java @@ -116,7 +116,7 @@ public final class PGPainless { * This method can be used to determine expiration dates, key flags and other information about a key. * * To evaluate a key at a given date (e.g. to determine if the key was allowed to create a certain signature) - * use {@link KeyRingInfo#KeyRingInfo(PGPKeyRing, Date)} instead. + * use {@link #inspectKeyRing(PGPKeyRing, Date)} instead. * * @param keyRing key ring * @return access object @@ -125,6 +125,18 @@ public final class PGPainless { return new KeyRingInfo(keyRing); } + /** + * Quickly access information about a {@link org.bouncycastle.openpgp.PGPPublicKeyRing} / {@link PGPSecretKeyRing}. + * This method can be used to determine expiration dates, key flags and other information about a key at a specific time. + * + * @param keyRing key ring + * @param inspectionDate date of inspection + * @return access object + */ + public static KeyRingInfo inspectKeyRing(PGPKeyRing keyRing, Date inspectionDate) { + return new KeyRingInfo(keyRing, inspectionDate); + } + /** * Access, and make changes to PGPainless policy on acceptable/default algorithms etc. *