663 lines
32 KiB
Java
663 lines
32 KiB
Java
// SPDX-FileCopyrightText: 2020 Paul Schaub <vanitasvitae@fsfe.org>
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package org.pgpainless.key.modification.secretkeyring;
|
|
|
|
import static org.pgpainless.util.CollectionUtils.concat;
|
|
|
|
import java.io.IOException;
|
|
import java.security.InvalidAlgorithmParameterException;
|
|
import java.security.NoSuchAlgorithmException;
|
|
import java.util.ArrayList;
|
|
import java.util.Collections;
|
|
import java.util.Date;
|
|
import java.util.Iterator;
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
import java.util.NoSuchElementException;
|
|
import javax.annotation.Nonnull;
|
|
import javax.annotation.Nullable;
|
|
|
|
import org.bouncycastle.bcpg.S2K;
|
|
import org.bouncycastle.bcpg.SecretKeyPacket;
|
|
import org.bouncycastle.openpgp.PGPException;
|
|
import org.bouncycastle.openpgp.PGPKeyPair;
|
|
import org.bouncycastle.openpgp.PGPKeyRingGenerator;
|
|
import org.bouncycastle.openpgp.PGPPrivateKey;
|
|
import org.bouncycastle.openpgp.PGPPublicKey;
|
|
import org.bouncycastle.openpgp.PGPPublicKeyRing;
|
|
import org.bouncycastle.openpgp.PGPSecretKey;
|
|
import org.bouncycastle.openpgp.PGPSecretKeyRing;
|
|
import org.bouncycastle.openpgp.PGPSignature;
|
|
import org.bouncycastle.openpgp.PGPSignatureGenerator;
|
|
import org.bouncycastle.openpgp.PGPSignatureSubpacketGenerator;
|
|
import org.bouncycastle.openpgp.PGPSignatureSubpacketVector;
|
|
import org.bouncycastle.openpgp.operator.PBESecretKeyDecryptor;
|
|
import org.bouncycastle.openpgp.operator.PBESecretKeyEncryptor;
|
|
import org.bouncycastle.openpgp.operator.PGPContentSignerBuilder;
|
|
import org.bouncycastle.openpgp.operator.PGPDigestCalculator;
|
|
import org.pgpainless.algorithm.HashAlgorithm;
|
|
import org.pgpainless.algorithm.KeyFlag;
|
|
import org.pgpainless.algorithm.PublicKeyAlgorithm;
|
|
import org.pgpainless.algorithm.SignatureType;
|
|
import org.pgpainless.algorithm.SymmetricKeyAlgorithm;
|
|
import org.pgpainless.implementation.ImplementationFactory;
|
|
import org.pgpainless.key.OpenPgpFingerprint;
|
|
import org.pgpainless.key.generation.KeyRingBuilder;
|
|
import org.pgpainless.key.generation.KeySpec;
|
|
import org.pgpainless.key.protection.CachingSecretKeyRingProtector;
|
|
import org.pgpainless.key.protection.KeyRingProtectionSettings;
|
|
import org.pgpainless.key.protection.PasswordBasedSecretKeyRingProtector;
|
|
import org.pgpainless.key.protection.SecretKeyRingProtector;
|
|
import org.pgpainless.key.protection.UnlockSecretKey;
|
|
import org.pgpainless.key.protection.UnprotectedKeysProtector;
|
|
import org.pgpainless.key.protection.fixes.S2KUsageFix;
|
|
import org.pgpainless.key.protection.passphrase_provider.SolitaryPassphraseProvider;
|
|
import org.pgpainless.key.util.KeyRingUtils;
|
|
import org.pgpainless.key.util.RevocationAttributes;
|
|
import org.pgpainless.signature.SignatureUtils;
|
|
import org.pgpainless.signature.builder.PrimaryKeyBindingSignatureBuilder;
|
|
import org.pgpainless.signature.builder.SelfSignatureBuilder;
|
|
import org.pgpainless.signature.builder.SubkeyBindingSignatureBuilder;
|
|
import org.pgpainless.signature.subpackets.SelfSignatureSubpackets;
|
|
import org.pgpainless.signature.subpackets.SignatureSubpacketGeneratorUtil;
|
|
import org.pgpainless.signature.subpackets.SignatureSubpacketsUtil;
|
|
import org.pgpainless.util.CollectionUtils;
|
|
import org.pgpainless.util.Passphrase;
|
|
|
|
public class SecretKeyRingEditor implements SecretKeyRingEditorInterface {
|
|
|
|
// 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 static final HashAlgorithm defaultDigestHashAlgorithm = HashAlgorithm.SHA1;
|
|
|
|
private PGPSecretKeyRing secretKeyRing;
|
|
|
|
public SecretKeyRingEditor(PGPSecretKeyRing secretKeyRing) {
|
|
if (secretKeyRing == null) {
|
|
throw new NullPointerException("SecretKeyRing MUST NOT be null.");
|
|
}
|
|
this.secretKeyRing = secretKeyRing;
|
|
}
|
|
|
|
@Override
|
|
public SecretKeyRingEditorInterface addUserId(String userId, SecretKeyRingProtector secretKeyRingProtector) throws PGPException {
|
|
return addUserId(userId, null, secretKeyRingProtector);
|
|
}
|
|
|
|
public SecretKeyRingEditorInterface addUserId(
|
|
String userId,
|
|
@Nullable SelfSignatureSubpackets.Callback signatureSubpacketCallback,
|
|
SecretKeyRingProtector protector) throws PGPException {
|
|
userId = sanitizeUserId(userId);
|
|
|
|
List<PGPSecretKey> secretKeyList = new ArrayList<>();
|
|
Iterator<PGPSecretKey> secretKeyIterator = secretKeyRing.getSecretKeys();
|
|
|
|
// add user-id certificate to primary key
|
|
PGPSecretKey primaryKey = secretKeyIterator.next();
|
|
PGPPublicKey publicKey = primaryKey.getPublicKey();
|
|
|
|
SelfSignatureBuilder builder = new SelfSignatureBuilder(primaryKey, protector);
|
|
builder.setSignatureType(SignatureType.POSITIVE_CERTIFICATION);
|
|
builder.applyCallback(signatureSubpacketCallback);
|
|
PGPSignature signature = builder.build(publicKey, userId);
|
|
|
|
publicKey = PGPPublicKey.addCertification(publicKey,
|
|
userId, signature);
|
|
primaryKey = PGPSecretKey.replacePublicKey(primaryKey, publicKey);
|
|
secretKeyList.add(primaryKey);
|
|
|
|
while (secretKeyIterator.hasNext()) {
|
|
secretKeyList.add(secretKeyIterator.next());
|
|
}
|
|
|
|
secretKeyRing = new PGPSecretKeyRing(secretKeyList);
|
|
|
|
return this;
|
|
}
|
|
|
|
// TODO: Move to utility class?
|
|
private String sanitizeUserId(String userId) {
|
|
userId = userId.trim();
|
|
// TODO: Further research how to sanitize user IDs.
|
|
// eg. what about newlines?
|
|
return userId;
|
|
}
|
|
|
|
@Override
|
|
public SecretKeyRingEditorInterface addSubKey(@Nonnull KeySpec keySpec,
|
|
@Nonnull Passphrase subKeyPassphrase,
|
|
SecretKeyRingProtector secretKeyRingProtector)
|
|
throws InvalidAlgorithmParameterException, NoSuchAlgorithmException, PGPException {
|
|
|
|
PGPSecretKey secretSubKey = generateSubKey(keySpec, subKeyPassphrase);
|
|
SecretKeyRingProtector subKeyProtector = PasswordBasedSecretKeyRingProtector
|
|
.forKey(secretSubKey, subKeyPassphrase);
|
|
PGPSignatureSubpacketVector hashedSubpackets = keySpec.getSubpackets();
|
|
PGPSignatureSubpacketVector unhashedSubpackets = null;
|
|
|
|
return addSubKey(secretSubKey, hashedSubpackets, unhashedSubpackets, subKeyProtector, secretKeyRingProtector);
|
|
}
|
|
|
|
@Override
|
|
@Deprecated
|
|
public SecretKeyRingEditorInterface addSubKey(PGPSecretKey secretSubKey,
|
|
PGPSignatureSubpacketVector hashedSubpackets,
|
|
PGPSignatureSubpacketVector unhashedSubpackets,
|
|
SecretKeyRingProtector subKeyProtector,
|
|
SecretKeyRingProtector keyRingProtector)
|
|
throws PGPException {
|
|
|
|
PGPPublicKey primaryKey = secretKeyRing.getSecretKey().getPublicKey();
|
|
|
|
PBESecretKeyDecryptor ringDecryptor = keyRingProtector.getDecryptor(primaryKey.getKeyID());
|
|
PBESecretKeyEncryptor subKeyEncryptor = subKeyProtector.getEncryptor(secretSubKey.getKeyID());
|
|
|
|
PGPDigestCalculator digestCalculator =
|
|
ImplementationFactory.getInstance().getPGPDigestCalculator(defaultDigestHashAlgorithm);
|
|
PGPContentSignerBuilder contentSignerBuilder =
|
|
SignatureUtils.getPgpContentSignerBuilderForKey(primaryKey);
|
|
|
|
PGPPrivateKey privateSubKey = UnlockSecretKey.unlockSecretKey(secretSubKey, subKeyProtector);
|
|
PGPKeyPair subKeyPair = new PGPKeyPair(secretSubKey.getPublicKey(), privateSubKey);
|
|
|
|
PGPKeyRingGenerator keyRingGenerator = new PGPKeyRingGenerator(
|
|
secretKeyRing, ringDecryptor, digestCalculator, contentSignerBuilder, subKeyEncryptor);
|
|
|
|
keyRingGenerator.addSubKey(subKeyPair, hashedSubpackets, unhashedSubpackets);
|
|
secretKeyRing = keyRingGenerator.generateSecretKeyRing();
|
|
|
|
return this;
|
|
}
|
|
|
|
@Override
|
|
public SecretKeyRingEditorInterface addSubKey(PGPSecretKey subkey,
|
|
@Nullable SelfSignatureSubpackets.Callback bindingSignatureCallback,
|
|
@Nullable SelfSignatureSubpackets.Callback backSignatureCallback,
|
|
SecretKeyRingProtector subkeyProtector,
|
|
SecretKeyRingProtector primaryKeyProtector,
|
|
KeyFlag keyFlag,
|
|
KeyFlag... additionalKeyFlags) throws PGPException, IOException {
|
|
KeyFlag[] flags = concat(keyFlag, additionalKeyFlags);
|
|
SignatureSubpacketsUtil.assureKeyCanCarryFlags(PublicKeyAlgorithm.fromId(subkey.getPublicKey().getAlgorithm()));
|
|
|
|
boolean isSigningKey = CollectionUtils.contains(flags, KeyFlag.SIGN_DATA) ||
|
|
CollectionUtils.contains(flags, KeyFlag.CERTIFY_OTHER);
|
|
if (!isSigningKey) {
|
|
return addSubKey(subkey.getPublicKey(),
|
|
bindingSignatureCallback,
|
|
primaryKeyProtector,
|
|
keyFlag,
|
|
additionalKeyFlags);
|
|
}
|
|
|
|
PGPSecretKey primaryKey = secretKeyRing.getSecretKey();
|
|
SubkeyBindingSignatureBuilder bindingSigBuilder = new SubkeyBindingSignatureBuilder(primaryKey, primaryKeyProtector);
|
|
bindingSigBuilder.applyCallback(bindingSignatureCallback);
|
|
bindingSigBuilder.getHashedSubpackets().setKeyFlags(flags);
|
|
|
|
PrimaryKeyBindingSignatureBuilder backSigBuilder = new PrimaryKeyBindingSignatureBuilder(subkey, subkeyProtector);
|
|
backSigBuilder.applyCallback(backSignatureCallback);
|
|
PGPSignature backSig = backSigBuilder.build(primaryKey.getPublicKey());
|
|
|
|
bindingSigBuilder.getHashedSubpackets().addEmbeddedSignature(backSig);
|
|
PGPSignature bindingSig = bindingSigBuilder.build(subkey.getPublicKey());
|
|
subkey = KeyRingUtils.secretKeyPlusSignature(subkey, bindingSig);
|
|
secretKeyRing = KeyRingUtils.secretKeysPlusSecretKey(secretKeyRing, subkey);
|
|
|
|
return this;
|
|
}
|
|
|
|
@Override
|
|
public SecretKeyRingEditorInterface addSubKey(PGPPublicKey subkey,
|
|
SelfSignatureSubpackets.Callback bindingSignatureCallback,
|
|
SecretKeyRingProtector primaryKeyProtector,
|
|
KeyFlag keyFlag,
|
|
KeyFlag... additionalKeyFlags) throws PGPException {
|
|
KeyFlag[] flags = concat(keyFlag, additionalKeyFlags);
|
|
boolean isSigningKey = CollectionUtils.contains(flags, KeyFlag.SIGN_DATA) ||
|
|
CollectionUtils.contains(flags, KeyFlag.CERTIFY_OTHER);
|
|
if (isSigningKey) {
|
|
throw new IllegalArgumentException("Cannot bind a signing capable subkey without access to the secret subkey.\n" +
|
|
"Please use addSubKey(PGPSecretKey secretSubKey, [...]) instead.");
|
|
}
|
|
|
|
PGPSignature bindingSignature = createSubkeyBindingSignature(subkey, bindingSignatureCallback, primaryKeyProtector, flags);
|
|
subkey = PGPPublicKey.addCertification(subkey, bindingSignature);
|
|
|
|
secretKeyRing = KeyRingUtils.secretKeysPlusPublicKey(secretKeyRing, subkey);
|
|
|
|
return this;
|
|
}
|
|
|
|
private PGPSignature createSubkeyBindingSignature(PGPPublicKey subkey,
|
|
SelfSignatureSubpackets.Callback bindingSignatureCallback,
|
|
SecretKeyRingProtector primaryKeyProtector,
|
|
KeyFlag... keyFlags) throws PGPException {
|
|
PGPSecretKey primaryKey = secretKeyRing.getSecretKey();
|
|
SubkeyBindingSignatureBuilder builder = new SubkeyBindingSignatureBuilder(primaryKey, primaryKeyProtector);
|
|
builder.applyCallback(bindingSignatureCallback);
|
|
builder.getHashedSubpackets().setKeyFlags(keyFlags);
|
|
|
|
PGPSignature signature = builder.build(subkey);
|
|
return signature;
|
|
}
|
|
|
|
private PGPSecretKey generateSubKey(@Nonnull KeySpec keySpec,
|
|
@Nonnull Passphrase subKeyPassphrase)
|
|
throws PGPException, InvalidAlgorithmParameterException, NoSuchAlgorithmException {
|
|
PGPDigestCalculator checksumCalculator = ImplementationFactory.getInstance()
|
|
.getPGPDigestCalculator(defaultDigestHashAlgorithm);
|
|
|
|
PBESecretKeyEncryptor subKeyEncryptor = subKeyPassphrase.isEmpty() ? null :
|
|
ImplementationFactory.getInstance().getPBESecretKeyEncryptor(SymmetricKeyAlgorithm.AES_256, subKeyPassphrase);
|
|
|
|
PGPKeyPair keyPair = KeyRingBuilder.generateKeyPair(keySpec);
|
|
PGPSecretKey secretKey = new PGPSecretKey(keyPair.getPrivateKey(), keyPair.getPublicKey(),
|
|
checksumCalculator, false, subKeyEncryptor);
|
|
return secretKey;
|
|
}
|
|
|
|
@Override
|
|
public SecretKeyRingEditorInterface revoke(SecretKeyRingProtector secretKeyRingProtector,
|
|
RevocationAttributes revocationAttributes)
|
|
throws PGPException {
|
|
return revokeSubKey(secretKeyRing.getSecretKey().getKeyID(), secretKeyRingProtector, revocationAttributes);
|
|
}
|
|
|
|
@Override
|
|
public SecretKeyRingEditorInterface revokeSubKey(OpenPgpFingerprint fingerprint,
|
|
SecretKeyRingProtector protector,
|
|
RevocationAttributes revocationAttributes)
|
|
throws PGPException {
|
|
return revokeSubKey(fingerprint.getKeyId(), protector, revocationAttributes);
|
|
}
|
|
|
|
@Override
|
|
public SecretKeyRingEditorInterface revokeSubKey(long subKeyId,
|
|
SecretKeyRingProtector protector,
|
|
RevocationAttributes revocationAttributes)
|
|
throws PGPException {
|
|
PGPPublicKey revokeeSubKey = secretKeyRing.getPublicKey(subKeyId);
|
|
if (revokeeSubKey == null) {
|
|
throw new NoSuchElementException("No subkey with id " + Long.toHexString(subKeyId) + " found.");
|
|
}
|
|
|
|
secretKeyRing = revokeSubKey(protector, revokeeSubKey, revocationAttributes);
|
|
return this;
|
|
}
|
|
|
|
@Override
|
|
public SecretKeyRingEditorInterface revokeUserId(String userId,
|
|
SecretKeyRingProtector secretKeyRingProtector,
|
|
RevocationAttributes revocationAttributes)
|
|
throws PGPException {
|
|
Iterator<String> userIds = secretKeyRing.getPublicKey().getUserIDs();
|
|
boolean found = false;
|
|
while (userIds.hasNext()) {
|
|
if (userId.equals(userIds.next())) {
|
|
found = true;
|
|
break;
|
|
}
|
|
}
|
|
if (!found) {
|
|
throw new NoSuchElementException("No user-id '" + userId + "' found on the key.");
|
|
}
|
|
return doRevokeUserId(userId, secretKeyRingProtector, revocationAttributes);
|
|
}
|
|
|
|
private SecretKeyRingEditorInterface doRevokeUserId(String userId,
|
|
SecretKeyRingProtector protector,
|
|
RevocationAttributes revocationAttributes) throws PGPException {
|
|
PGPSecretKey primarySecretKey = secretKeyRing.getSecretKey();
|
|
PGPPublicKey primaryPublicKey = primarySecretKey.getPublicKey();
|
|
PGPPrivateKey privateKey = UnlockSecretKey.unlockSecretKey(primarySecretKey, protector);
|
|
|
|
PGPSignatureSubpacketGenerator subpacketGenerator = new PGPSignatureSubpacketGenerator();
|
|
subpacketGenerator.setSignatureCreationTime(false, new Date());
|
|
subpacketGenerator.setRevocable(false, false);
|
|
subpacketGenerator.setIssuerFingerprint(false, primarySecretKey);
|
|
if (revocationAttributes != null) {
|
|
RevocationAttributes.Reason reason = revocationAttributes.getReason();
|
|
if (reason != RevocationAttributes.Reason.NO_REASON
|
|
&& reason != RevocationAttributes.Reason.USER_ID_NO_LONGER_VALID) {
|
|
throw new IllegalArgumentException("Revocation reason must either be NO_REASON or USER_ID_NO_LONGER_VALID");
|
|
}
|
|
subpacketGenerator.setRevocationReason(false, revocationAttributes.getReason().code(), revocationAttributes.getDescription());
|
|
}
|
|
|
|
PGPSignatureGenerator signatureGenerator = SignatureUtils.getSignatureGeneratorFor(primarySecretKey);
|
|
signatureGenerator.setHashedSubpackets(subpacketGenerator.generate());
|
|
signatureGenerator.init(SignatureType.CERTIFICATION_REVOCATION.getCode(), privateKey);
|
|
|
|
PGPSignature revocationSignature = signatureGenerator.generateCertification(userId, primaryPublicKey);
|
|
primaryPublicKey = PGPPublicKey.addCertification(primaryPublicKey, userId, revocationSignature);
|
|
|
|
PGPPublicKeyRing publicKeyRing = KeyRingUtils.publicKeyRingFrom(secretKeyRing);
|
|
publicKeyRing = PGPPublicKeyRing.insertPublicKey(publicKeyRing, primaryPublicKey);
|
|
secretKeyRing = PGPSecretKeyRing.replacePublicKeys(secretKeyRing, publicKeyRing);
|
|
|
|
return this;
|
|
}
|
|
|
|
@Override
|
|
public SecretKeyRingEditorInterface setExpirationDate(Date expiration,
|
|
SecretKeyRingProtector secretKeyRingProtector)
|
|
throws PGPException {
|
|
return setExpirationDate(OpenPgpFingerprint.of(secretKeyRing), expiration, secretKeyRingProtector);
|
|
}
|
|
|
|
@Override
|
|
public SecretKeyRingEditorInterface setExpirationDate(OpenPgpFingerprint fingerprint,
|
|
Date expiration,
|
|
SecretKeyRingProtector secretKeyRingProtector)
|
|
throws PGPException {
|
|
|
|
List<PGPSecretKey> secretKeyList = new ArrayList<>();
|
|
PGPSecretKey primaryKey = secretKeyRing.getSecretKey();
|
|
if (!primaryKey.isMasterKey()) {
|
|
throw new IllegalArgumentException("Key Ring does not appear to contain a primary secret key.");
|
|
}
|
|
|
|
boolean found = false;
|
|
for (PGPSecretKey secretKey : secretKeyRing) {
|
|
// Skip over unaffected subkeys
|
|
if (secretKey.getKeyID() != fingerprint.getKeyId()) {
|
|
secretKeyList.add(secretKey);
|
|
continue;
|
|
}
|
|
// We found the target subkey
|
|
found = true;
|
|
secretKey = setExpirationDate(primaryKey, secretKey, expiration, secretKeyRingProtector);
|
|
secretKeyList.add(secretKey);
|
|
}
|
|
|
|
if (!found) {
|
|
throw new IllegalArgumentException("Key Ring does not contain secret key with fingerprint " + fingerprint);
|
|
}
|
|
|
|
secretKeyRing = new PGPSecretKeyRing(secretKeyList);
|
|
|
|
return this;
|
|
}
|
|
|
|
private PGPSecretKey setExpirationDate(PGPSecretKey primaryKey,
|
|
PGPSecretKey subjectKey,
|
|
Date expiration,
|
|
SecretKeyRingProtector secretKeyRingProtector)
|
|
throws PGPException {
|
|
|
|
if (expiration != null && expiration.before(subjectKey.getPublicKey().getCreationTime())) {
|
|
throw new IllegalArgumentException("Expiration date cannot be before creation date.");
|
|
}
|
|
|
|
PGPPrivateKey privateKey = UnlockSecretKey.unlockSecretKey(primaryKey, secretKeyRingProtector);
|
|
PGPPublicKey subjectPubKey = subjectKey.getPublicKey();
|
|
|
|
PGPSignature oldSignature = getPreviousSignature(primaryKey, subjectPubKey);
|
|
|
|
PGPSignatureSubpacketVector oldSubpackets = oldSignature.getHashedSubPackets();
|
|
PGPSignatureSubpacketGenerator subpacketGenerator = new PGPSignatureSubpacketGenerator(oldSubpackets);
|
|
SignatureSubpacketGeneratorUtil.setSignatureCreationTimeInSubpacketGenerator(new Date(), subpacketGenerator);
|
|
SignatureSubpacketGeneratorUtil.setKeyExpirationDateInSubpacketGenerator(expiration, subjectPubKey.getCreationTime(), subpacketGenerator);
|
|
|
|
PGPSignatureGenerator signatureGenerator = SignatureUtils.getSignatureGeneratorFor(primaryKey);
|
|
signatureGenerator.setHashedSubpackets(subpacketGenerator.generate());
|
|
|
|
if (primaryKey.getKeyID() == subjectKey.getKeyID()) {
|
|
signatureGenerator.init(PGPSignature.POSITIVE_CERTIFICATION, privateKey);
|
|
|
|
for (Iterator<String> it = subjectKey.getUserIDs(); it.hasNext(); ) {
|
|
String userId = it.next();
|
|
PGPSignature signature = signatureGenerator.generateCertification(userId, subjectPubKey);
|
|
subjectPubKey = PGPPublicKey.addCertification(subjectPubKey, userId, signature);
|
|
}
|
|
} else {
|
|
signatureGenerator.init(PGPSignature.SUBKEY_BINDING, privateKey);
|
|
|
|
PGPSignature signature = signatureGenerator.generateCertification(primaryKey.getPublicKey(), subjectPubKey);
|
|
subjectPubKey = PGPPublicKey.addCertification(subjectPubKey, signature);
|
|
}
|
|
|
|
subjectKey = PGPSecretKey.replacePublicKey(subjectKey, subjectPubKey);
|
|
return subjectKey;
|
|
}
|
|
|
|
private PGPSignature getPreviousSignature(PGPSecretKey primaryKey, PGPPublicKey subjectPubKey) {
|
|
PGPSignature oldSignature = null;
|
|
if (primaryKey.getKeyID() == subjectPubKey.getKeyID()) {
|
|
Iterator<PGPSignature> keySignatures = subjectPubKey.getSignaturesForKeyID(primaryKey.getKeyID());
|
|
while (keySignatures.hasNext()) {
|
|
PGPSignature next = keySignatures.next();
|
|
SignatureType type = SignatureType.valueOf(next.getSignatureType());
|
|
if (type == SignatureType.POSITIVE_CERTIFICATION ||
|
|
type == SignatureType.CASUAL_CERTIFICATION ||
|
|
type == SignatureType.GENERIC_CERTIFICATION) {
|
|
oldSignature = next;
|
|
}
|
|
}
|
|
if (oldSignature == null) {
|
|
throw new IllegalStateException("Key " + OpenPgpFingerprint.of(subjectPubKey) + " does not have a previous positive/casual/generic certification signature.");
|
|
}
|
|
} else {
|
|
Iterator<PGPSignature> bindingSignatures = subjectPubKey.getSignaturesOfType(SignatureType.SUBKEY_BINDING.getCode());
|
|
while (bindingSignatures.hasNext()) {
|
|
oldSignature = bindingSignatures.next();
|
|
}
|
|
}
|
|
|
|
if (oldSignature == null) {
|
|
throw new IllegalStateException("Key " + OpenPgpFingerprint.of(subjectPubKey) + " does not have a previous subkey binding signature.");
|
|
}
|
|
return oldSignature;
|
|
}
|
|
|
|
@Override
|
|
public PGPSignature createRevocationCertificate(SecretKeyRingProtector secretKeyRingProtector,
|
|
RevocationAttributes revocationAttributes)
|
|
throws PGPException {
|
|
PGPPublicKey revokeeSubKey = secretKeyRing.getPublicKey();
|
|
PGPSignature revocationCertificate = generateRevocation(secretKeyRingProtector, revokeeSubKey, revocationAttributes);
|
|
return revocationCertificate;
|
|
}
|
|
|
|
@Override
|
|
public PGPSignature createRevocationCertificate(long subkeyId, SecretKeyRingProtector secretKeyRingProtector, RevocationAttributes revocationAttributes) throws PGPException {
|
|
PGPPublicKey revokeeSubKey = KeyRingUtils.requirePublicKeyFrom(secretKeyRing, subkeyId);
|
|
PGPSignature revocationCertificate = generateRevocation(secretKeyRingProtector, revokeeSubKey, revocationAttributes);
|
|
return revocationCertificate;
|
|
}
|
|
|
|
private PGPSecretKeyRing revokeSubKey(SecretKeyRingProtector protector,
|
|
PGPPublicKey revokeeSubKey,
|
|
RevocationAttributes revocationAttributes)
|
|
throws PGPException {
|
|
PGPSignature subKeyRevocation = generateRevocation(protector, revokeeSubKey, revocationAttributes);
|
|
revokeeSubKey = PGPPublicKey.addCertification(revokeeSubKey, subKeyRevocation);
|
|
|
|
// Inject revoked public key into key ring
|
|
PGPPublicKeyRing publicKeyRing = KeyRingUtils.publicKeyRingFrom(secretKeyRing);
|
|
publicKeyRing = PGPPublicKeyRing.insertPublicKey(publicKeyRing, revokeeSubKey);
|
|
return PGPSecretKeyRing.replacePublicKeys(secretKeyRing, publicKeyRing);
|
|
}
|
|
|
|
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 = UnlockSecretKey.unlockSecretKey(primaryKey, protector);
|
|
|
|
PGPSignature revocation;
|
|
if (revokeeSubKey.isMasterKey()) {
|
|
signatureGenerator.init(SignatureType.KEY_REVOCATION.getCode(), privateKey);
|
|
revocation = signatureGenerator.generateCertification(revokeeSubKey);
|
|
} else {
|
|
signatureGenerator.init(SignatureType.SUBKEY_REVOCATION.getCode(), privateKey);
|
|
revocation = signatureGenerator.generateCertification(primaryKey.getPublicKey(), revokeeSubKey);
|
|
}
|
|
return revocation;
|
|
}
|
|
|
|
@Override
|
|
public WithKeyRingEncryptionSettings changePassphraseFromOldPassphrase(@Nullable Passphrase oldPassphrase,
|
|
@Nonnull KeyRingProtectionSettings oldProtectionSettings) {
|
|
SecretKeyRingProtector protector = new PasswordBasedSecretKeyRingProtector(
|
|
oldProtectionSettings,
|
|
new SolitaryPassphraseProvider(oldPassphrase));
|
|
|
|
return new WithKeyRingEncryptionSettingsImpl(null, protector);
|
|
}
|
|
|
|
@Override
|
|
public WithKeyRingEncryptionSettings changeSubKeyPassphraseFromOldPassphrase(@Nonnull Long keyId,
|
|
@Nullable Passphrase oldPassphrase,
|
|
@Nonnull KeyRingProtectionSettings oldProtectionSettings) {
|
|
Map<Long, Passphrase> passphraseMap = Collections.singletonMap(keyId, oldPassphrase);
|
|
SecretKeyRingProtector protector = new CachingSecretKeyRingProtector(
|
|
passphraseMap, oldProtectionSettings, null);
|
|
|
|
return new WithKeyRingEncryptionSettingsImpl(keyId, protector);
|
|
}
|
|
|
|
@Override
|
|
public PGPSecretKeyRing done() {
|
|
return secretKeyRing;
|
|
}
|
|
|
|
private final class WithKeyRingEncryptionSettingsImpl implements WithKeyRingEncryptionSettings {
|
|
|
|
private final Long keyId;
|
|
// Protector to unlock the key with the old passphrase
|
|
private final SecretKeyRingProtector oldProtector;
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
private WithKeyRingEncryptionSettingsImpl(Long keyId, SecretKeyRingProtector oldProtector) {
|
|
this.keyId = keyId;
|
|
this.oldProtector = oldProtector;
|
|
}
|
|
|
|
@Override
|
|
public WithPassphrase withSecureDefaultSettings() {
|
|
return withCustomSettings(KeyRingProtectionSettings.secureDefaultSettings());
|
|
}
|
|
|
|
@Override
|
|
public WithPassphrase withCustomSettings(KeyRingProtectionSettings settings) {
|
|
return new WithPassphraseImpl(keyId, oldProtector, settings);
|
|
}
|
|
}
|
|
|
|
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;
|
|
}
|
|
|
|
@Override
|
|
public SecretKeyRingEditorInterface toNewPassphrase(Passphrase passphrase) throws PGPException {
|
|
SecretKeyRingProtector newProtector = new PasswordBasedSecretKeyRingProtector(
|
|
newProtectionSettings, new SolitaryPassphraseProvider(passphrase));
|
|
|
|
PGPSecretKeyRing secretKeys = changePassphrase(keyId, SecretKeyRingEditor.this.secretKeyRing, oldProtector, newProtector);
|
|
SecretKeyRingEditor.this.secretKeyRing = secretKeys;
|
|
|
|
return SecretKeyRingEditor.this;
|
|
}
|
|
|
|
@Override
|
|
public SecretKeyRingEditorInterface toNoPassphrase() throws PGPException {
|
|
SecretKeyRingProtector newProtector = new UnprotectedKeysProtector();
|
|
|
|
PGPSecretKeyRing secretKeys = changePassphrase(keyId, SecretKeyRingEditor.this.secretKeyRing, oldProtector, newProtector);
|
|
SecretKeyRingEditor.this.secretKeyRing = secretKeys;
|
|
|
|
return SecretKeyRingEditor.this;
|
|
}
|
|
}
|
|
|
|
private PGPSecretKeyRing changePassphrase(Long keyId,
|
|
PGPSecretKeyRing secretKeys,
|
|
SecretKeyRingProtector oldProtector,
|
|
SecretKeyRingProtector newProtector) throws PGPException {
|
|
List<PGPSecretKey> secretKeyList = new ArrayList<>();
|
|
if (keyId == null) {
|
|
// change passphrase of whole key ring
|
|
Iterator<PGPSecretKey> secretKeyIterator = secretKeys.getSecretKeys();
|
|
while (secretKeyIterator.hasNext()) {
|
|
PGPSecretKey secretKey = secretKeyIterator.next();
|
|
secretKey = reencryptPrivateKey(secretKey, oldProtector, newProtector);
|
|
secretKeyList.add(secretKey);
|
|
}
|
|
} else {
|
|
// change passphrase of selected subkey only
|
|
Iterator<PGPSecretKey> secretKeyIterator = secretKeys.getSecretKeys();
|
|
while (secretKeyIterator.hasNext()) {
|
|
PGPSecretKey secretKey = secretKeyIterator.next();
|
|
if (secretKey.getPublicKey().getKeyID() == keyId) {
|
|
// Re-encrypt only the selected subkey
|
|
secretKey = reencryptPrivateKey(secretKey, oldProtector, newProtector);
|
|
}
|
|
secretKeyList.add(secretKey);
|
|
}
|
|
}
|
|
|
|
PGPSecretKeyRing newRing = new PGPSecretKeyRing(secretKeyList);
|
|
newRing = s2kUsageFixIfNecessary(newRing, newProtector);
|
|
return newRing;
|
|
}
|
|
|
|
private PGPSecretKeyRing s2kUsageFixIfNecessary(PGPSecretKeyRing secretKeys, SecretKeyRingProtector protector) throws PGPException {
|
|
boolean hasS2KUsageChecksum = false;
|
|
for (PGPSecretKey secKey : secretKeys) {
|
|
if (secKey.getS2KUsage() == SecretKeyPacket.USAGE_CHECKSUM) {
|
|
hasS2KUsageChecksum = true;
|
|
break;
|
|
}
|
|
}
|
|
if (hasS2KUsageChecksum) {
|
|
secretKeys = S2KUsageFix.replaceUsageChecksumWithUsageSha1(secretKeys, protector, true);
|
|
}
|
|
return secretKeys;
|
|
}
|
|
|
|
private static PGPSecretKey reencryptPrivateKey(PGPSecretKey secretKey, SecretKeyRingProtector oldProtector, SecretKeyRingProtector newProtector) throws PGPException {
|
|
S2K s2k = secretKey.getS2K();
|
|
// If the key uses GNU_DUMMY_S2K, we leave it as is and skip this block
|
|
if (s2k == null || s2k.getType() != S2K.GNU_DUMMY_S2K) {
|
|
long secretKeyId = secretKey.getKeyID();
|
|
PBESecretKeyDecryptor decryptor = oldProtector.getDecryptor(secretKeyId);
|
|
PBESecretKeyEncryptor encryptor = newProtector.getEncryptor(secretKeyId);
|
|
secretKey = PGPSecretKey.copyWithNewPassword(secretKey, decryptor, encryptor);
|
|
}
|
|
return secretKey;
|
|
}
|
|
}
|