2020-10-25 19:54:03 +01:00
|
|
|
/*
|
|
|
|
* Copyright 2020 Paul Schaub.
|
|
|
|
*
|
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
* you may not use this file except in compliance with the License.
|
|
|
|
* You may obtain a copy of the License at
|
|
|
|
*
|
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
*
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
* See the License for the specific language governing permissions and
|
|
|
|
* limitations under the License.
|
|
|
|
*/
|
2020-11-19 17:51:57 +01:00
|
|
|
package org.pgpainless.key.modification.secretkeyring;
|
2020-10-22 01:20:43 +02:00
|
|
|
|
2020-11-29 16:04:15 +01:00
|
|
|
import static org.pgpainless.key.util.KeyRingUtils.unlockSecretKey;
|
2020-11-13 15:08:37 +01:00
|
|
|
|
2020-11-10 17:25:35 +01:00
|
|
|
import java.security.InvalidAlgorithmParameterException;
|
|
|
|
import java.security.NoSuchAlgorithmException;
|
2020-10-23 16:44:21 +02:00
|
|
|
import java.util.ArrayList;
|
2020-10-25 20:43:09 +01:00
|
|
|
import java.util.Collections;
|
2020-11-27 13:00:06 +01:00
|
|
|
import java.util.Date;
|
2020-10-23 16:44:21 +02:00
|
|
|
import java.util.Iterator;
|
|
|
|
import java.util.List;
|
2020-10-25 20:43:09 +01:00
|
|
|
import java.util.Map;
|
2020-11-03 19:29:15 +01:00
|
|
|
import java.util.NoSuchElementException;
|
2020-10-23 16:44:21 +02:00
|
|
|
import javax.annotation.Nonnull;
|
2020-10-22 01:20:43 +02:00
|
|
|
import javax.annotation.Nullable;
|
|
|
|
|
2020-10-23 16:44:21 +02:00
|
|
|
import org.bouncycastle.openpgp.PGPException;
|
2020-11-10 17:25:35 +01:00
|
|
|
import org.bouncycastle.openpgp.PGPKeyPair;
|
|
|
|
import org.bouncycastle.openpgp.PGPKeyRingGenerator;
|
2020-10-23 16:44:21 +02:00
|
|
|
import org.bouncycastle.openpgp.PGPPrivateKey;
|
|
|
|
import org.bouncycastle.openpgp.PGPPublicKey;
|
2020-11-03 19:29:15 +01:00
|
|
|
import org.bouncycastle.openpgp.PGPPublicKeyRing;
|
2020-10-23 16:44:21 +02:00
|
|
|
import org.bouncycastle.openpgp.PGPSecretKey;
|
2020-10-22 01:20:43 +02:00
|
|
|
import org.bouncycastle.openpgp.PGPSecretKeyRing;
|
2020-10-23 16:44:21 +02:00
|
|
|
import org.bouncycastle.openpgp.PGPSignature;
|
2020-10-25 19:54:03 +01:00
|
|
|
import org.bouncycastle.openpgp.PGPSignatureGenerator;
|
2020-11-20 12:01:39 +01:00
|
|
|
import org.bouncycastle.openpgp.PGPSignatureSubpacketGenerator;
|
|
|
|
import org.bouncycastle.openpgp.PGPSignatureSubpacketVector;
|
2020-10-23 16:44:21 +02:00
|
|
|
import org.bouncycastle.openpgp.operator.PBESecretKeyDecryptor;
|
2020-10-25 20:43:09 +01:00
|
|
|
import org.bouncycastle.openpgp.operator.PBESecretKeyEncryptor;
|
2020-11-10 17:25:35 +01:00
|
|
|
import org.bouncycastle.openpgp.operator.PGPContentSignerBuilder;
|
2020-10-25 19:54:03 +01:00
|
|
|
import org.bouncycastle.openpgp.operator.PGPDigestCalculator;
|
2020-11-10 17:25:35 +01:00
|
|
|
import org.bouncycastle.openpgp.operator.bc.BcPBESecretKeyEncryptorBuilder;
|
2020-10-25 19:54:03 +01:00
|
|
|
import org.bouncycastle.openpgp.operator.bc.BcPGPContentSignerBuilder;
|
|
|
|
import org.bouncycastle.openpgp.operator.bc.BcPGPDigestCalculatorProvider;
|
|
|
|
import org.pgpainless.algorithm.HashAlgorithm;
|
2020-10-23 16:44:21 +02:00
|
|
|
import org.pgpainless.algorithm.SignatureType;
|
2020-11-10 17:25:35 +01:00
|
|
|
import org.pgpainless.algorithm.SymmetricKeyAlgorithm;
|
2020-10-22 01:20:43 +02:00
|
|
|
import org.pgpainless.key.OpenPgpV4Fingerprint;
|
2020-11-10 17:25:35 +01:00
|
|
|
import org.pgpainless.key.generation.KeyRingBuilder;
|
2020-10-22 01:20:43 +02:00
|
|
|
import org.pgpainless.key.generation.KeySpec;
|
2020-10-23 16:44:21 +02:00
|
|
|
import org.pgpainless.key.protection.KeyRingProtectionSettings;
|
2020-10-25 20:43:09 +01:00
|
|
|
import org.pgpainless.key.protection.PassphraseMapKeyRingProtector;
|
|
|
|
import org.pgpainless.key.protection.PasswordBasedSecretKeyRingProtector;
|
2020-10-23 16:44:21 +02:00
|
|
|
import org.pgpainless.key.protection.SecretKeyRingProtector;
|
2020-10-25 20:43:09 +01:00
|
|
|
import org.pgpainless.key.protection.UnprotectedKeysProtector;
|
|
|
|
import org.pgpainless.key.protection.passphrase_provider.SolitaryPassphraseProvider;
|
2020-11-13 14:32:29 +01:00
|
|
|
import org.pgpainless.key.util.KeyRingUtils;
|
2020-11-20 12:01:39 +01:00
|
|
|
import org.pgpainless.key.util.RevocationAttributes;
|
2020-11-13 15:08:37 +01:00
|
|
|
import org.pgpainless.key.util.SignatureUtils;
|
2020-10-22 01:20:43 +02:00
|
|
|
import org.pgpainless.util.Passphrase;
|
|
|
|
|
2020-11-19 17:51:57 +01:00
|
|
|
public class SecretKeyRingEditor implements SecretKeyRingEditorInterface {
|
2020-10-22 01:20:43 +02:00
|
|
|
|
2020-10-30 12:28:11 +01:00
|
|
|
// Default algorithm for calculating private key checksums
|
|
|
|
// While I'd like to use something else, eg. SHA256, BC seems to lack support for
|
|
|
|
// calculating secret key checksums with algorithms other than SHA1.
|
|
|
|
private final HashAlgorithm defaultDigestHashAlgorithm = HashAlgorithm.SHA1;
|
|
|
|
|
2020-10-22 01:20:43 +02:00
|
|
|
private PGPSecretKeyRing secretKeyRing;
|
|
|
|
|
2020-11-19 17:51:57 +01:00
|
|
|
public SecretKeyRingEditor(PGPSecretKeyRing secretKeyRing) {
|
2020-10-22 01:20:43 +02:00
|
|
|
if (secretKeyRing == null) {
|
|
|
|
throw new NullPointerException("SecretKeyRing MUST NOT be null.");
|
|
|
|
}
|
|
|
|
this.secretKeyRing = secretKeyRing;
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
2020-11-19 17:51:57 +01:00
|
|
|
public SecretKeyRingEditorInterface addUserId(String userId, SecretKeyRingProtector secretKeyRingProtector) throws PGPException {
|
2020-11-03 19:29:15 +01:00
|
|
|
return addUserId(secretKeyRing.getPublicKey().getKeyID(), userId, secretKeyRingProtector);
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
2020-11-19 17:51:57 +01:00
|
|
|
public SecretKeyRingEditorInterface addUserId(long keyId, String userId, SecretKeyRingProtector secretKeyRingProtector) throws PGPException {
|
2020-10-23 16:44:21 +02:00
|
|
|
userId = sanitizeUserId(userId);
|
|
|
|
|
2020-11-03 19:29:15 +01:00
|
|
|
List<PGPSecretKey> secretKeyList = new ArrayList<>();
|
|
|
|
Iterator<PGPSecretKey> secretKeyIterator = secretKeyRing.getSecretKeys();
|
|
|
|
|
|
|
|
boolean found = false;
|
2020-11-13 15:11:33 +01:00
|
|
|
while (!found && secretKeyIterator.hasNext()) {
|
2020-11-03 19:29:15 +01:00
|
|
|
PGPSecretKey secretKey = secretKeyIterator.next();
|
|
|
|
if (secretKey.getKeyID() == keyId) {
|
|
|
|
found = true;
|
|
|
|
PGPPublicKey publicKey = secretKey.getPublicKey();
|
|
|
|
PGPPrivateKey privateKey = unlockSecretKey(secretKey, secretKeyRingProtector);
|
|
|
|
publicKey = addUserIdToPubKey(userId, privateKey, publicKey);
|
|
|
|
secretKey = PGPSecretKey.replacePublicKey(secretKey, publicKey);
|
|
|
|
}
|
|
|
|
secretKeyList.add(secretKey);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!found) {
|
|
|
|
throw new NoSuchElementException("Cannot find secret key with id " + Long.toHexString(keyId));
|
|
|
|
}
|
2020-10-29 15:15:13 +01:00
|
|
|
|
2020-11-03 19:29:15 +01:00
|
|
|
secretKeyRing = new PGPSecretKeyRing(secretKeyList);
|
2020-10-25 19:54:03 +01:00
|
|
|
|
2020-11-03 19:29:15 +01:00
|
|
|
return this;
|
|
|
|
}
|
|
|
|
|
|
|
|
private static PGPPublicKey addUserIdToPubKey(String userId, PGPPrivateKey privateKey, PGPPublicKey publicKey) throws PGPException {
|
|
|
|
if (privateKey.getKeyID() != publicKey.getKeyID()) {
|
|
|
|
throw new IllegalArgumentException("Key-ID mismatch!");
|
|
|
|
}
|
2020-10-29 15:15:13 +01:00
|
|
|
// Create signature with new user-id and add it to the public key
|
2020-11-13 15:08:37 +01:00
|
|
|
PGPSignatureGenerator signatureGenerator = SignatureUtils.getSignatureGeneratorFor(publicKey);
|
2020-10-23 16:44:21 +02:00
|
|
|
signatureGenerator.init(SignatureType.POSITIVE_CERTIFICATION.getCode(), privateKey);
|
|
|
|
|
2020-11-03 19:29:15 +01:00
|
|
|
PGPSignature userIdSignature = signatureGenerator.generateCertification(userId, publicKey);
|
|
|
|
publicKey = PGPPublicKey.addCertification(publicKey,
|
|
|
|
userId, userIdSignature);
|
2020-10-23 16:44:21 +02:00
|
|
|
|
2020-11-03 19:29:15 +01:00
|
|
|
return publicKey;
|
2020-10-22 01:20:43 +02:00
|
|
|
}
|
|
|
|
|
2020-10-25 20:43:09 +01:00
|
|
|
// TODO: Move to utility class?
|
2020-10-23 16:44:21 +02:00
|
|
|
private String sanitizeUserId(String userId) {
|
|
|
|
userId = userId.trim();
|
|
|
|
// TODO: Further research how to sanitize user IDs.
|
|
|
|
// eg. what about newlines?
|
|
|
|
return userId;
|
|
|
|
}
|
|
|
|
|
2020-10-22 01:20:43 +02:00
|
|
|
@Override
|
2020-11-19 17:51:57 +01:00
|
|
|
public SecretKeyRingEditorInterface deleteUserId(String userId, SecretKeyRingProtector protector) {
|
2020-11-03 19:56:35 +01:00
|
|
|
PGPPublicKey publicKey = secretKeyRing.getPublicKey();
|
|
|
|
return deleteUserId(publicKey.getKeyID(), userId, protector);
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
2020-11-19 17:51:57 +01:00
|
|
|
public SecretKeyRingEditorInterface deleteUserId(long keyId, String userId, SecretKeyRingProtector secretKeyRingProtector) {
|
2020-11-03 19:56:35 +01:00
|
|
|
List<PGPPublicKey> publicKeys = new ArrayList<>();
|
|
|
|
Iterator<PGPPublicKey> publicKeyIterator = secretKeyRing.getPublicKeys();
|
|
|
|
boolean foundKey = false;
|
|
|
|
while (publicKeyIterator.hasNext()) {
|
|
|
|
PGPPublicKey publicKey = publicKeyIterator.next();
|
|
|
|
if (publicKey.getKeyID() == keyId) {
|
|
|
|
foundKey = true;
|
|
|
|
if (!hasUserId(userId, publicKey)) {
|
|
|
|
throw new NoSuchElementException("Key " + Long.toHexString(keyId) + " does not have a user-id attribute of value '" + userId + "'");
|
|
|
|
}
|
|
|
|
publicKey = PGPPublicKey.removeCertification(publicKey, userId);
|
|
|
|
}
|
|
|
|
publicKeys.add(publicKey);
|
|
|
|
}
|
|
|
|
if (!foundKey) {
|
|
|
|
throw new NoSuchElementException("Cannot find public key with id " + Long.toHexString(keyId));
|
|
|
|
}
|
|
|
|
PGPPublicKeyRing publicKeyRing = new PGPPublicKeyRing(publicKeys);
|
|
|
|
secretKeyRing = PGPSecretKeyRing.replacePublicKeys(secretKeyRing, publicKeyRing);
|
|
|
|
return this;
|
|
|
|
}
|
|
|
|
|
|
|
|
private static boolean hasUserId(String userId, PGPPublicKey publicKey) {
|
|
|
|
boolean hasUserId = false;
|
|
|
|
Iterator<String> userIdIterator = publicKey.getUserIDs();
|
|
|
|
while (userIdIterator.hasNext()) {
|
|
|
|
hasUserId = userId.equals(userIdIterator.next());
|
|
|
|
if (hasUserId) break;
|
|
|
|
}
|
|
|
|
return hasUserId;
|
2020-10-22 01:20:43 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
2020-11-19 17:51:57 +01:00
|
|
|
public SecretKeyRingEditorInterface addSubKey(@Nonnull KeySpec keySpec,
|
|
|
|
@Nonnull Passphrase subKeyPassphrase,
|
|
|
|
SecretKeyRingProtector secretKeyRingProtector)
|
2020-11-10 17:25:35 +01:00
|
|
|
throws InvalidAlgorithmParameterException, NoSuchAlgorithmException, PGPException {
|
|
|
|
|
|
|
|
PGPSecretKey secretSubKey = generateSubKey(keySpec, subKeyPassphrase);
|
|
|
|
SecretKeyRingProtector subKeyProtector = PasswordBasedSecretKeyRingProtector
|
|
|
|
.forKey(secretSubKey, subKeyPassphrase);
|
|
|
|
|
|
|
|
return addSubKey(secretSubKey, subKeyProtector, secretKeyRingProtector);
|
2020-10-22 01:20:43 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
2020-11-19 17:51:57 +01:00
|
|
|
public SecretKeyRingEditorInterface addSubKey(PGPSecretKey secretSubKey,
|
|
|
|
SecretKeyRingProtector subKeyProtector,
|
|
|
|
SecretKeyRingProtector keyRingProtector)
|
2020-11-10 17:25:35 +01:00
|
|
|
throws PGPException {
|
|
|
|
|
|
|
|
PGPPublicKey primaryKey = secretKeyRing.getSecretKey().getPublicKey();
|
|
|
|
|
|
|
|
PBESecretKeyDecryptor ringDecryptor = keyRingProtector.getDecryptor(primaryKey.getKeyID());
|
|
|
|
PBESecretKeyEncryptor subKeyEncryptor = subKeyProtector.getEncryptor(secretSubKey.getKeyID());
|
|
|
|
|
|
|
|
PGPDigestCalculator digestCalculator = new BcPGPDigestCalculatorProvider()
|
|
|
|
.get(defaultDigestHashAlgorithm.getAlgorithmId());
|
|
|
|
PGPContentSignerBuilder contentSignerBuilder = new BcPGPContentSignerBuilder(
|
|
|
|
primaryKey.getAlgorithm(), HashAlgorithm.SHA256.getAlgorithmId());
|
|
|
|
|
|
|
|
PGPPrivateKey privateSubKey = unlockSecretKey(secretSubKey, subKeyProtector);
|
|
|
|
PGPKeyPair subKeyPair = new PGPKeyPair(secretSubKey.getPublicKey(), privateSubKey);
|
|
|
|
|
|
|
|
PGPKeyRingGenerator keyRingGenerator = new PGPKeyRingGenerator(
|
|
|
|
secretKeyRing, ringDecryptor, digestCalculator, contentSignerBuilder, subKeyEncryptor);
|
|
|
|
|
|
|
|
keyRingGenerator.addSubKey(subKeyPair);
|
|
|
|
secretKeyRing = keyRingGenerator.generateSecretKeyRing();
|
|
|
|
|
|
|
|
return this;
|
|
|
|
}
|
|
|
|
|
|
|
|
private PGPSecretKey generateSubKey(@Nonnull KeySpec keySpec,
|
|
|
|
@Nonnull Passphrase subKeyPassphrase)
|
|
|
|
throws PGPException, InvalidAlgorithmParameterException, NoSuchAlgorithmException {
|
|
|
|
PGPDigestCalculator checksumCalculator = new BcPGPDigestCalculatorProvider()
|
|
|
|
.get(defaultDigestHashAlgorithm.getAlgorithmId());
|
|
|
|
|
|
|
|
PBESecretKeyEncryptor subKeyEncryptor = subKeyPassphrase.isEmpty() ? null :
|
|
|
|
new BcPBESecretKeyEncryptorBuilder(SymmetricKeyAlgorithm.AES_256.getAlgorithmId())
|
|
|
|
.build(subKeyPassphrase.getChars());
|
|
|
|
|
|
|
|
PGPKeyPair keyPair = KeyRingBuilder.generateKeyPair(keySpec);
|
|
|
|
PGPSecretKey secretKey = new PGPSecretKey(keyPair.getPrivateKey(), keyPair.getPublicKey(),
|
|
|
|
checksumCalculator, false, subKeyEncryptor);
|
|
|
|
return secretKey;
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
2020-11-19 17:51:57 +01:00
|
|
|
public SecretKeyRingEditorInterface deleteSubKey(OpenPgpV4Fingerprint fingerprint,
|
|
|
|
SecretKeyRingProtector protector) {
|
2020-11-03 19:32:01 +01:00
|
|
|
return deleteSubKey(fingerprint.getKeyId(), protector);
|
2020-10-22 01:20:43 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
2020-11-19 17:51:57 +01:00
|
|
|
public SecretKeyRingEditorInterface deleteSubKey(long subKeyId,
|
|
|
|
SecretKeyRingProtector protector) {
|
2020-11-03 19:32:01 +01:00
|
|
|
if (secretKeyRing.getSecretKey().getKeyID() == subKeyId) {
|
|
|
|
throw new IllegalArgumentException("You cannot delete the primary key of this key ring.");
|
|
|
|
}
|
|
|
|
|
|
|
|
PGPSecretKey deleteMe = secretKeyRing.getSecretKey(subKeyId);
|
|
|
|
if (deleteMe == null) {
|
2020-11-13 15:08:37 +01:00
|
|
|
throw new NoSuchElementException("KeyRing does not contain a key with keyId " + Long.toHexString(subKeyId));
|
2020-11-03 19:32:01 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
PGPSecretKeyRing newKeyRing = PGPSecretKeyRing.removeSecretKey(secretKeyRing, deleteMe);
|
|
|
|
secretKeyRing = newKeyRing;
|
|
|
|
return this;
|
2020-10-22 01:20:43 +02:00
|
|
|
}
|
|
|
|
|
2020-11-22 21:25:52 +01:00
|
|
|
@Override
|
|
|
|
public SecretKeyRingEditorInterface revoke(SecretKeyRingProtector secretKeyRingProtector,
|
|
|
|
RevocationAttributes revocationAttributes)
|
|
|
|
throws PGPException {
|
|
|
|
return revokeSubKey(secretKeyRing.getSecretKey().getKeyID(), secretKeyRingProtector, revocationAttributes);
|
|
|
|
}
|
|
|
|
|
2020-10-22 01:20:43 +02:00
|
|
|
@Override
|
2020-11-20 12:19:45 +01:00
|
|
|
public SecretKeyRingEditorInterface revokeSubKey(OpenPgpV4Fingerprint fingerprint,
|
|
|
|
SecretKeyRingProtector protector,
|
|
|
|
RevocationAttributes revocationAttributes)
|
2020-11-13 14:32:29 +01:00
|
|
|
throws PGPException {
|
2020-11-20 12:19:45 +01:00
|
|
|
return revokeSubKey(fingerprint.getKeyId(), protector, revocationAttributes);
|
2020-11-13 16:59:55 +01:00
|
|
|
}
|
2020-11-13 14:32:29 +01:00
|
|
|
|
2020-11-13 16:59:55 +01:00
|
|
|
@Override
|
2020-11-20 12:19:45 +01:00
|
|
|
public SecretKeyRingEditorInterface revokeSubKey(long subKeyId,
|
|
|
|
SecretKeyRingProtector protector,
|
|
|
|
RevocationAttributes revocationAttributes)
|
|
|
|
throws PGPException {
|
2020-11-13 16:59:55 +01:00
|
|
|
PGPPublicKey revokeeSubKey = secretKeyRing.getPublicKey(subKeyId);
|
2020-11-13 14:32:29 +01:00
|
|
|
if (revokeeSubKey == null) {
|
2020-11-13 16:59:55 +01:00
|
|
|
throw new NoSuchElementException("No subkey with id " + Long.toHexString(subKeyId) + " found.");
|
2020-11-13 14:32:29 +01:00
|
|
|
}
|
|
|
|
|
2020-11-20 12:19:45 +01:00
|
|
|
secretKeyRing = revokeSubKey(protector, revokeeSubKey, revocationAttributes);
|
2020-11-13 16:59:55 +01:00
|
|
|
return this;
|
|
|
|
}
|
|
|
|
|
2020-11-27 13:00:06 +01:00
|
|
|
@Override
|
|
|
|
public SecretKeyRingEditorInterface setExpirationDate(OpenPgpV4Fingerprint fingerprint,
|
|
|
|
Date expiration,
|
|
|
|
SecretKeyRingProtector secretKeyRingProtector)
|
|
|
|
throws PGPException {
|
|
|
|
Iterator<PGPSecretKey> secretKeyIterator = secretKeyRing.getSecretKeys();
|
|
|
|
|
|
|
|
if (!secretKeyIterator.hasNext()) {
|
|
|
|
throw new NoSuchElementException("No secret keys in the ring.");
|
|
|
|
}
|
|
|
|
|
|
|
|
PGPSecretKey secretKey = secretKeyIterator.next();
|
|
|
|
PGPPublicKey publicKey = secretKey.getPublicKey();
|
|
|
|
|
|
|
|
if (!new OpenPgpV4Fingerprint(publicKey).equals(fingerprint)) {
|
|
|
|
throw new IllegalArgumentException("Currently it is possible to adjust expiration date for primary key only.");
|
|
|
|
}
|
|
|
|
|
|
|
|
List<PGPSecretKey> secretKeyList = new ArrayList<>();
|
|
|
|
PGPPrivateKey privateKey = unlockSecretKey(secretKey, secretKeyRingProtector);
|
|
|
|
|
|
|
|
PGPSecretKey primaryKey = secretKeyRing.getSecretKey();
|
|
|
|
PGPSignatureGenerator signatureGenerator = SignatureUtils.getSignatureGeneratorFor(primaryKey);
|
|
|
|
PGPSignatureSubpacketGenerator subpacketGenerator = new PGPSignatureSubpacketGenerator();
|
|
|
|
|
|
|
|
long secondsToExpire = 0; // 0 means "no expiration"
|
|
|
|
if (expiration != null) {
|
|
|
|
secondsToExpire = (expiration.getTime() - primaryKey.getPublicKey().getCreationTime().getTime()) / 1000;
|
|
|
|
}
|
|
|
|
subpacketGenerator.setKeyExpirationTime(false, secondsToExpire);
|
|
|
|
|
|
|
|
PGPSignatureSubpacketVector subPackets = subpacketGenerator.generate();
|
|
|
|
signatureGenerator.setHashedSubpackets(subPackets);
|
|
|
|
|
|
|
|
signatureGenerator.init(PGPSignature.POSITIVE_CERTIFICATION, privateKey);
|
|
|
|
|
|
|
|
Iterator<String> users = publicKey.getUserIDs();
|
|
|
|
while (users.hasNext()) {
|
|
|
|
String user = users.next();
|
|
|
|
PGPSignature signature = signatureGenerator.generateCertification(user, primaryKey.getPublicKey());
|
|
|
|
publicKey = PGPPublicKey.addCertification(publicKey, user, signature);
|
|
|
|
}
|
|
|
|
|
|
|
|
secretKey = PGPSecretKey.replacePublicKey(secretKey, publicKey);
|
|
|
|
secretKeyList.add(secretKey);
|
|
|
|
|
|
|
|
secretKeyRing = new PGPSecretKeyRing(secretKeyList);
|
|
|
|
|
|
|
|
return this;
|
|
|
|
}
|
|
|
|
|
2020-11-20 12:01:39 +01:00
|
|
|
@Override
|
|
|
|
public PGPSignature createRevocationCertificate(OpenPgpV4Fingerprint fingerprint,
|
|
|
|
SecretKeyRingProtector secretKeyRingProtector,
|
|
|
|
RevocationAttributes revocationAttributes)
|
|
|
|
throws PGPException {
|
|
|
|
PGPPublicKey revokeeSubKey = secretKeyRing.getPublicKey(fingerprint.getKeyId());
|
|
|
|
if (revokeeSubKey == null) {
|
|
|
|
throw new NoSuchElementException("No subkey with fingerprint " + fingerprint + " found.");
|
|
|
|
}
|
2020-11-13 14:32:29 +01:00
|
|
|
|
2020-11-20 12:01:39 +01:00
|
|
|
PGPSignature revocationCertificate = generateRevocation(secretKeyRingProtector, revokeeSubKey, revocationAttributes);
|
|
|
|
return revocationCertificate;
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
|
|
|
public PGPSignature createRevocationCertificate(long subKeyId,
|
|
|
|
SecretKeyRingProtector secretKeyRingProtector,
|
|
|
|
RevocationAttributes revocationAttributes)
|
|
|
|
throws PGPException {
|
|
|
|
PGPPublicKey revokeeSubKey = secretKeyRing.getPublicKey(subKeyId);
|
|
|
|
if (revokeeSubKey == null) {
|
|
|
|
throw new NoSuchElementException("No subkey with id " + Long.toHexString(subKeyId) + " found.");
|
|
|
|
}
|
|
|
|
|
|
|
|
PGPSignature revocationCertificate = generateRevocation(secretKeyRingProtector, revokeeSubKey, revocationAttributes);
|
|
|
|
return revocationCertificate;
|
|
|
|
}
|
|
|
|
|
2020-11-20 12:19:45 +01:00
|
|
|
private PGPSecretKeyRing revokeSubKey(SecretKeyRingProtector protector,
|
|
|
|
PGPPublicKey revokeeSubKey,
|
|
|
|
RevocationAttributes revocationAttributes)
|
2020-11-20 12:01:39 +01:00
|
|
|
throws PGPException {
|
2020-11-20 12:19:45 +01:00
|
|
|
PGPSignature subKeyRevocation = generateRevocation(protector, revokeeSubKey, revocationAttributes);
|
2020-11-13 14:32:29 +01:00
|
|
|
revokeeSubKey = PGPPublicKey.addCertification(revokeeSubKey, subKeyRevocation);
|
|
|
|
|
|
|
|
// Inject revoked public key into key ring
|
|
|
|
PGPPublicKeyRing publicKeyRing = KeyRingUtils.publicKeyRingFrom(secretKeyRing);
|
|
|
|
publicKeyRing = PGPPublicKeyRing.insertPublicKey(publicKeyRing, revokeeSubKey);
|
2020-11-13 16:59:55 +01:00
|
|
|
return PGPSecretKeyRing.replacePublicKeys(secretKeyRing, publicKeyRing);
|
2020-10-22 01:20:43 +02:00
|
|
|
}
|
|
|
|
|
2020-11-20 12:01:39 +01:00
|
|
|
private PGPSignature generateRevocation(SecretKeyRingProtector protector,
|
|
|
|
PGPPublicKey revokeeSubKey,
|
|
|
|
RevocationAttributes revocationAttributes)
|
|
|
|
throws PGPException {
|
|
|
|
PGPSecretKey primaryKey = secretKeyRing.getSecretKey();
|
|
|
|
PGPSignatureGenerator signatureGenerator = SignatureUtils.getSignatureGeneratorFor(primaryKey);
|
|
|
|
PGPSignatureSubpacketGenerator subpacketGenerator = new PGPSignatureSubpacketGenerator();
|
|
|
|
subpacketGenerator.setIssuerFingerprint(false, primaryKey);
|
|
|
|
|
|
|
|
if (revocationAttributes != null) {
|
|
|
|
subpacketGenerator.setRevocationReason(false, revocationAttributes.getReason().code(), revocationAttributes.getDescription());
|
|
|
|
}
|
|
|
|
|
|
|
|
PGPSignatureSubpacketVector subPackets = subpacketGenerator.generate();
|
|
|
|
signatureGenerator.setHashedSubpackets(subPackets);
|
|
|
|
|
|
|
|
PGPPrivateKey privateKey = primaryKey.extractPrivateKey(protector.getDecryptor(primaryKey.getKeyID()));
|
|
|
|
SignatureType type = revokeeSubKey.isMasterKey() ? SignatureType.KEY_REVOCATION : SignatureType.SUBKEY_REVOCATION;
|
|
|
|
signatureGenerator.init(type.getCode(), privateKey);
|
|
|
|
|
|
|
|
// Generate revocation
|
|
|
|
PGPSignature subKeyRevocation = signatureGenerator.generateCertification(primaryKey.getPublicKey(), revokeeSubKey);
|
|
|
|
return subKeyRevocation;
|
|
|
|
}
|
|
|
|
|
2020-10-23 16:44:21 +02:00
|
|
|
@Override
|
|
|
|
public WithKeyRingEncryptionSettings changePassphraseFromOldPassphrase(@Nullable Passphrase oldPassphrase,
|
|
|
|
@Nonnull KeyRingProtectionSettings oldProtectionSettings) {
|
2020-10-25 20:43:09 +01:00
|
|
|
SecretKeyRingProtector protector = new PasswordBasedSecretKeyRingProtector(
|
|
|
|
oldProtectionSettings,
|
|
|
|
new SolitaryPassphraseProvider(oldPassphrase));
|
|
|
|
|
|
|
|
return new WithKeyRingEncryptionSettingsImpl(null, protector);
|
2020-10-23 16:44:21 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
|
|
|
public WithKeyRingEncryptionSettings changeSubKeyPassphraseFromOldPassphrase(@Nonnull Long keyId,
|
|
|
|
@Nullable Passphrase oldPassphrase,
|
|
|
|
@Nonnull KeyRingProtectionSettings oldProtectionSettings) {
|
2020-10-25 20:43:09 +01:00
|
|
|
Map<Long, Passphrase> passphraseMap = Collections.singletonMap(keyId, oldPassphrase);
|
|
|
|
SecretKeyRingProtector protector = new PassphraseMapKeyRingProtector(
|
|
|
|
passphraseMap, oldProtectionSettings, null);
|
|
|
|
|
|
|
|
return new WithKeyRingEncryptionSettingsImpl(keyId, protector);
|
2020-10-23 16:44:21 +02:00
|
|
|
}
|
|
|
|
|
2020-10-22 01:20:43 +02:00
|
|
|
@Override
|
|
|
|
public PGPSecretKeyRing done() {
|
|
|
|
return secretKeyRing;
|
|
|
|
}
|
2020-10-23 16:44:21 +02:00
|
|
|
|
2020-10-25 20:43:09 +01:00
|
|
|
private final class WithKeyRingEncryptionSettingsImpl implements WithKeyRingEncryptionSettings {
|
|
|
|
|
|
|
|
private final Long keyId;
|
|
|
|
// Protector to unlock the key with the old passphrase
|
|
|
|
private final SecretKeyRingProtector oldProtector;
|
|
|
|
|
2020-10-29 15:15:13 +01:00
|
|
|
/**
|
|
|
|
* Builder for selecting protection settings.
|
|
|
|
*
|
|
|
|
* If the keyId is null, the whole keyRing will get the same new passphrase.
|
|
|
|
*
|
|
|
|
* @param keyId id of the subkey whose passphrase will be changed, or null.
|
|
|
|
* @param oldProtector protector do unlock the key/ring.
|
|
|
|
*/
|
2020-10-25 20:43:09 +01:00
|
|
|
private WithKeyRingEncryptionSettingsImpl(Long keyId, SecretKeyRingProtector oldProtector) {
|
|
|
|
this.keyId = keyId;
|
|
|
|
this.oldProtector = oldProtector;
|
|
|
|
}
|
2020-10-23 16:44:21 +02:00
|
|
|
|
|
|
|
@Override
|
|
|
|
public WithPassphrase withSecureDefaultSettings() {
|
|
|
|
return withCustomSettings(KeyRingProtectionSettings.secureDefaultSettings());
|
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
|
|
|
public WithPassphrase withCustomSettings(KeyRingProtectionSettings settings) {
|
2020-10-25 20:43:09 +01:00
|
|
|
return new WithPassphraseImpl(keyId, oldProtector, settings);
|
2020-10-23 16:44:21 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-10-25 20:43:09 +01:00
|
|
|
private final class WithPassphraseImpl implements WithPassphrase {
|
|
|
|
|
|
|
|
private final SecretKeyRingProtector oldProtector;
|
|
|
|
private final KeyRingProtectionSettings newProtectionSettings;
|
|
|
|
private final Long keyId;
|
|
|
|
|
|
|
|
private WithPassphraseImpl(Long keyId, SecretKeyRingProtector oldProtector, KeyRingProtectionSettings newProtectionSettings) {
|
|
|
|
this.keyId = keyId;
|
|
|
|
this.oldProtector = oldProtector;
|
|
|
|
this.newProtectionSettings = newProtectionSettings;
|
|
|
|
}
|
2020-10-23 16:44:21 +02:00
|
|
|
|
|
|
|
@Override
|
2020-11-19 17:51:57 +01:00
|
|
|
public SecretKeyRingEditorInterface toNewPassphrase(Passphrase passphrase) throws PGPException {
|
2020-10-25 20:43:09 +01:00
|
|
|
SecretKeyRingProtector newProtector = new PasswordBasedSecretKeyRingProtector(
|
|
|
|
newProtectionSettings, new SolitaryPassphraseProvider(passphrase));
|
|
|
|
|
2020-11-19 17:51:57 +01:00
|
|
|
PGPSecretKeyRing secretKeys = changePassphrase(keyId, SecretKeyRingEditor.this.secretKeyRing, oldProtector, newProtector);
|
|
|
|
SecretKeyRingEditor.this.secretKeyRing = secretKeys;
|
2020-10-25 20:43:09 +01:00
|
|
|
|
2020-11-19 17:51:57 +01:00
|
|
|
return SecretKeyRingEditor.this;
|
2020-10-23 16:44:21 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
@Override
|
2020-11-19 17:51:57 +01:00
|
|
|
public SecretKeyRingEditorInterface toNoPassphrase() throws PGPException {
|
2020-10-25 20:43:09 +01:00
|
|
|
SecretKeyRingProtector newProtector = new UnprotectedKeysProtector();
|
|
|
|
|
2020-11-19 17:51:57 +01:00
|
|
|
PGPSecretKeyRing secretKeys = changePassphrase(keyId, SecretKeyRingEditor.this.secretKeyRing, oldProtector, newProtector);
|
|
|
|
SecretKeyRingEditor.this.secretKeyRing = secretKeys;
|
2020-10-25 20:43:09 +01:00
|
|
|
|
2020-11-19 17:51:57 +01:00
|
|
|
return SecretKeyRingEditor.this;
|
2020-10-23 16:44:21 +02:00
|
|
|
}
|
2020-11-10 17:25:35 +01:00
|
|
|
}
|
2020-10-25 20:43:09 +01:00
|
|
|
|
2020-11-10 17:25:35 +01:00
|
|
|
private PGPSecretKeyRing changePassphrase(Long keyId,
|
|
|
|
PGPSecretKeyRing secretKeys,
|
|
|
|
SecretKeyRingProtector oldProtector,
|
|
|
|
SecretKeyRingProtector newProtector) throws PGPException {
|
|
|
|
if (keyId == null) {
|
|
|
|
// change passphrase of whole key ring
|
|
|
|
List<PGPSecretKey> newlyEncryptedSecretKeys = new ArrayList<>();
|
|
|
|
Iterator<PGPSecretKey> secretKeyIterator = secretKeys.getSecretKeys();
|
|
|
|
while (secretKeyIterator.hasNext()) {
|
|
|
|
PGPSecretKey secretKey = secretKeyIterator.next();
|
|
|
|
PGPPrivateKey privateKey = unlockSecretKey(secretKey, oldProtector);
|
|
|
|
secretKey = lockPrivateKey(privateKey, secretKey.getPublicKey(), newProtector);
|
|
|
|
newlyEncryptedSecretKeys.add(secretKey);
|
|
|
|
}
|
|
|
|
return new PGPSecretKeyRing(newlyEncryptedSecretKeys);
|
|
|
|
} else {
|
|
|
|
// change passphrase of selected subkey only
|
|
|
|
List<PGPSecretKey> secretKeyList = new ArrayList<>();
|
|
|
|
Iterator<PGPSecretKey> secretKeyIterator = secretKeys.getSecretKeys();
|
|
|
|
while (secretKeyIterator.hasNext()) {
|
|
|
|
PGPSecretKey secretKey = secretKeyIterator.next();
|
|
|
|
|
|
|
|
if (secretKey.getPublicKey().getKeyID() == keyId) {
|
|
|
|
// Re-encrypt only the selected subkey
|
2020-10-25 20:43:09 +01:00
|
|
|
PGPPrivateKey privateKey = unlockSecretKey(secretKey, oldProtector);
|
|
|
|
secretKey = lockPrivateKey(privateKey, secretKey.getPublicKey(), newProtector);
|
|
|
|
}
|
2020-11-10 17:25:35 +01:00
|
|
|
|
|
|
|
secretKeyList.add(secretKey);
|
2020-10-25 20:43:09 +01:00
|
|
|
}
|
2020-11-10 17:25:35 +01:00
|
|
|
return new PGPSecretKeyRing(secretKeyList);
|
2020-10-25 20:43:09 +01:00
|
|
|
}
|
2020-11-10 17:25:35 +01:00
|
|
|
}
|
2020-10-25 20:43:09 +01:00
|
|
|
|
2020-11-10 17:25:35 +01:00
|
|
|
// TODO: Move to utility class
|
|
|
|
private PGPSecretKey lockPrivateKey(PGPPrivateKey privateKey, PGPPublicKey publicKey, SecretKeyRingProtector protector) throws PGPException {
|
|
|
|
PGPDigestCalculator checksumCalculator = new BcPGPDigestCalculatorProvider()
|
|
|
|
.get(defaultDigestHashAlgorithm.getAlgorithmId());
|
|
|
|
PBESecretKeyEncryptor encryptor = protector.getEncryptor(publicKey.getKeyID());
|
|
|
|
PGPSecretKey secretKey = new PGPSecretKey(privateKey, publicKey, checksumCalculator, publicKey.isMasterKey(), encryptor);
|
|
|
|
return secretKey;
|
2020-10-23 16:44:21 +02:00
|
|
|
}
|
2020-10-22 01:20:43 +02:00
|
|
|
}
|