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

Add documentation for modifyKeyRing(keys, date)

Browse source
This commit is contained in:
Paul Schaub 2022-09-03 13:46:32 +02:00
parent c3dc3c9d87
commit 7189516dd4
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
pgpainless-core/src/main/java/org/pgpainless/PGPainless.java
View file

@ -118,8 +118,8 @@ public final class PGPainless {
} }
/** /**
* Make changes to a key ring. * Make changes to a secret key.
* This method can be used to change key expiration dates and passphrases, or add/remove/revoke subkeys. * This method can be used to change key expiration dates and passphrases, or add/revoke subkeys.
* *
* After making the desired changes in the builder, the modified key ring can be extracted using {@link SecretKeyRingEditorInterface#done()}. * After making the desired changes in the builder, the modified key ring can be extracted using {@link SecretKeyRingEditorInterface#done()}.
* *
@ -130,6 +130,16 @@ public final class PGPainless {
return modifyKeyRing(secretKeys, null); return modifyKeyRing(secretKeys, null);
} }
/**
* Make changes to a secret key at the given reference time.
* This method can be used to change key expiration dates and passphrases, or add/revoke user-ids and subkeys.
*
* After making the desired changes in the builder, the modified key can be extracted using {@link SecretKeyRingEditorInterface#done()}.
*
* @param secretKeys secret key ring
* @param referenceTime reference time used as signature creation date
* @return builder
*/
public static SecretKeyRingEditorInterface modifyKeyRing(PGPSecretKeyRing secretKeys, Date referenceTime) { public static SecretKeyRingEditorInterface modifyKeyRing(PGPSecretKeyRing secretKeys, Date referenceTime) {
return new SecretKeyRingEditor(secretKeys, referenceTime); return new SecretKeyRingEditor(secretKeys, referenceTime);
} }