PGPainless/pgpainless
PGPainless
/
pgpainless
mirror of https://github.com/pgpainless/pgpainless.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Rename KeyRingUtil.removeSecretKey() to stripSecretKey()

This commit is contained in:
Paul Schaub 2022-04-02 17:03:38 +02:00
parent 50bcb6a135
commit 8ec86e6464
Signed by: vanitasvitae
GPG Key ID: 62BEE9264BF17311
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
pgpainless-core/src/main/java/org/pgpainless/key/util/KeyRingUtils.java
View File

@ -430,11 +430,35 @@ public final class KeyRingUtils {
*
* @throws IOException
* @throws PGPException
*
* @deprecated use {@link #stripSecretKey(PGPSecretKeyRing, long)} instead.
* TODO: Remove in 1.2.X
*/
@Nonnull
@Deprecated
public static PGPSecretKeyRing removeSecretKey(@Nonnull PGPSecretKeyRing secretKeys,
long secretKeyId)
throws IOException, PGPException {
return stripSecretKey(secretKeys, secretKeyId);
}
/**
* Remove the secret key of the subkey identified by the given secret key id from the key ring.
* The public part stays attached to the key ring, so that it can still be used for encryption / verification of signatures.
*
* This method is intended to be used to remove secret primary keys from live keys when those are kept in offline storage.
*
* @param secretKeys secret key ring
* @param secretKeyId id of the secret key to remove
* @return secret key ring with removed secret key
*
* @throws IOException
* @throws PGPException
*/
@Nonnull
public static PGPSecretKeyRing stripSecretKey(@Nonnull PGPSecretKeyRing secretKeys,
long secretKeyId)
throws IOException, PGPException {
if (secretKeys.getSecretKey(secretKeyId) == null) {
throw new NoSuchElementException("PGPSecretKeyRing does not contain secret key " + Long.toHexString(secretKeyId));
}