mirror of
https://github.com/pgpainless/pgpainless.git
synced 2024-12-25 04:17:59 +01:00
Kotlin conversion: S2KUsageFix
This commit is contained in:
parent
a243bebae0
commit
2d1d5580d1
GPG key ID:
62BEE9264BF17311
3 changed files with 79 additions and 100 deletions
|
|
@ -1,92 +0,0 @@
|
|||
// SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
|
||||
//
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
package org.pgpainless.key.protection.fixes;
|
||||
|
||||
import org.bouncycastle.bcpg.SecretKeyPacket;
|
||||
import org.bouncycastle.openpgp.PGPException;
|
||||
import org.bouncycastle.openpgp.PGPPrivateKey;
|
||||
import org.bouncycastle.openpgp.PGPSecretKey;
|
||||
import org.bouncycastle.openpgp.PGPSecretKeyRing;
|
||||
import org.bouncycastle.openpgp.operator.PBESecretKeyEncryptor;
|
||||
import org.bouncycastle.openpgp.operator.PGPDigestCalculator;
|
||||
import org.pgpainless.algorithm.HashAlgorithm;
|
||||
import org.pgpainless.exception.WrongPassphraseException;
|
||||
import org.pgpainless.implementation.ImplementationFactory;
|
||||
import org.pgpainless.key.protection.SecretKeyRingProtector;
|
||||
import org.pgpainless.key.protection.UnlockSecretKey;
|
||||
|
||||
/**
|
||||
* Repair class to fix keys which use S2K usage of value {@link SecretKeyPacket#USAGE_CHECKSUM}.
|
||||
* The method {@link #replaceUsageChecksumWithUsageSha1(PGPSecretKeyRing, SecretKeyRingProtector)} ensures
|
||||
* that such keys are encrypted using S2K usage {@link SecretKeyPacket#USAGE_SHA1} instead.
|
||||
*
|
||||
* @see <a href="https://github.com/pgpainless/pgpainless/issues/176">Related PGPainless Bug Report</a>
|
||||
* @see <a href="https://github.com/pgpainless/pgpainless/issues/178">Related PGPainless Feature Request</a>
|
||||
* @see <a href="https://github.com/bcgit/bc-java/issues/1020">Related upstream BC bug report</a>
|
||||
*/
|
||||
public final class S2KUsageFix {
|
||||
|
||||
private S2KUsageFix() {
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Repair method for keys which use S2K usage <pre>USAGE_CHECKSUM</pre> which is deemed insecure.
|
||||
* This method fixes the private keys by changing them to <pre>USAGE_SHA1</pre> instead.
|
||||
*
|
||||
* @param keys keys
|
||||
* @param protector protector to unlock and re-lock affected private keys
|
||||
* @return fixed key ring
|
||||
* @throws PGPException in case of a PGP error.
|
||||
*/
|
||||
public static PGPSecretKeyRing replaceUsageChecksumWithUsageSha1(PGPSecretKeyRing keys, SecretKeyRingProtector protector) throws PGPException {
|
||||
return replaceUsageChecksumWithUsageSha1(keys, protector, false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Repair method for keys which use S2K usage <pre>USAGE_CHECKSUM</pre> which is deemed insecure.
|
||||
* This method fixes the private keys by changing them to <pre>USAGE_SHA1</pre> instead.
|
||||
*
|
||||
* @param keys keys
|
||||
* @param protector protector to unlock and re-lock affected private keys
|
||||
* @param skipKeysWithMissingPassphrase if set to true, missing subkey passphrases will cause the subkey to stay unaffected.
|
||||
* @return fixed key ring
|
||||
* @throws PGPException in case of a PGP error.
|
||||
*/
|
||||
public static PGPSecretKeyRing replaceUsageChecksumWithUsageSha1(PGPSecretKeyRing keys,
|
||||
SecretKeyRingProtector protector,
|
||||
boolean skipKeysWithMissingPassphrase) throws PGPException {
|
||||
PGPDigestCalculator digestCalculator = ImplementationFactory.getInstance().getPGPDigestCalculator(HashAlgorithm.SHA1);
|
||||
for (PGPSecretKey key : keys) {
|
||||
// CHECKSUM is not recommended
|
||||
if (key.getS2KUsage() != SecretKeyPacket.USAGE_CHECKSUM) {
|
||||
continue;
|
||||
}
|
||||
|
||||
long keyId = key.getKeyID();
|
||||
PBESecretKeyEncryptor encryptor = protector.getEncryptor(keyId);
|
||||
if (encryptor == null) {
|
||||
if (skipKeysWithMissingPassphrase) {
|
||||
continue;
|
||||
}
|
||||
throw new WrongPassphraseException("Missing passphrase for key with ID " + Long.toHexString(keyId));
|
||||
}
|
||||
|
||||
PGPPrivateKey privateKey = UnlockSecretKey.unlockSecretKey(key, protector);
|
||||
// This constructor makes use of USAGE_SHA1 by default
|
||||
PGPSecretKey fixedKey = new PGPSecretKey(
|
||||
privateKey,
|
||||
key.getPublicKey(),
|
||||
digestCalculator,
|
||||
key.isMasterKey(),
|
||||
protector.getEncryptor(keyId)
|
||||
);
|
||||
|
||||
// replace the original key with the fixed one
|
||||
keys = PGPSecretKeyRing.insertSecretKey(keys, fixedKey);
|
||||
}
|
||||
return keys;
|
||||
}
|
||||
}
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
// SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
|
||||
//
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
/**
|
||||
* Secret Key Protection Fixes.
|
||||
*/
|
||||
package org.pgpainless.key.protection.fixes;
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
// SPDX-FileCopyrightText: 2023 Paul Schaub <vanitasvitae@fsfe.org>
|
||||
//
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
package org.pgpainless.key.protection.fixes
|
||||
|
||||
import org.bouncycastle.bcpg.SecretKeyPacket
|
||||
import org.bouncycastle.openpgp.PGPSecretKey
|
||||
import org.bouncycastle.openpgp.PGPSecretKeyRing
|
||||
import org.pgpainless.algorithm.HashAlgorithm
|
||||
import org.pgpainless.exception.WrongPassphraseException
|
||||
import org.pgpainless.implementation.ImplementationFactory
|
||||
import org.pgpainless.key.protection.SecretKeyRingProtector
|
||||
import org.pgpainless.key.protection.UnlockSecretKey.Companion.unlockSecretKey
|
||||
|
||||
/**
|
||||
* Repair class to fix keys which use S2K usage of value [SecretKeyPacket.USAGE_CHECKSUM].
|
||||
* The method [replaceUsageChecksumWithUsageSha1] ensures that such keys are encrypted using
|
||||
* S2K usage [SecretKeyPacket.USAGE_SHA1] instead.
|
||||
*
|
||||
* @see <a href="https://github.com/pgpainless/pgpainless/issues/176">Related PGPainless Bug Report</a>
|
||||
* @see <a href="https://github.com/pgpainless/pgpainless/issues/178">Related PGPainless Feature Request</a>
|
||||
* @see <a href="https://github.com/bcgit/bc-java/issues/1020">Related upstream BC bug report</a>
|
||||
*/
|
||||
class S2KUsageFix {
|
||||
|
||||
companion object {
|
||||
|
||||
/**
|
||||
* Repair method for keys which use S2K usage <pre>USAGE_CHECKSUM</pre> which is deemed insecure.
|
||||
* This method fixes the private keys by changing them to <pre>USAGE_SHA1</pre> instead.
|
||||
*
|
||||
* @param keys keys
|
||||
* @param protector protector to unlock and re-lock affected private keys
|
||||
* @param skipKeysWithMissingPassphrase if set to true, missing subkey passphrases will cause the subkey to stay unaffected.
|
||||
* @return fixed key ring
|
||||
* @throws PGPException in case of a PGP error.
|
||||
*/
|
||||
@JvmStatic
|
||||
@JvmOverloads
|
||||
fun replaceUsageChecksumWithUsageSha1(
|
||||
keys: PGPSecretKeyRing,
|
||||
protector: SecretKeyRingProtector,
|
||||
skipKeysWithMissingPassphrase: Boolean = false
|
||||
): PGPSecretKeyRing {
|
||||
val digestCalculator = ImplementationFactory.getInstance().getPGPDigestCalculator(HashAlgorithm.SHA1)
|
||||
val keyList = mutableListOf<PGPSecretKey>()
|
||||
for (key in keys) {
|
||||
// CHECKSUM is not recommended
|
||||
if (key.s2KUsage != SecretKeyPacket.USAGE_CHECKSUM) {
|
||||
keyList.add(key)
|
||||
continue
|
||||
}
|
||||
|
||||
val keyId = key.keyID
|
||||
val encryptor = protector.getEncryptor(keyId)
|
||||
if (encryptor == null) {
|
||||
if (skipKeysWithMissingPassphrase) {
|
||||
keyList.add(key)
|
||||
continue
|
||||
}
|
||||
throw WrongPassphraseException("Missing passphrase for key with ID " + java.lang.Long.toHexString(keyId))
|
||||
}
|
||||
|
||||
val privateKey = unlockSecretKey(key, protector)
|
||||
// This constructor makes use of USAGE_SHA1 by default
|
||||
val fixedKey = PGPSecretKey(
|
||||
privateKey,
|
||||
key.publicKey,
|
||||
digestCalculator,
|
||||
key.isMasterKey,
|
||||
protector.getEncryptor(keyId)
|
||||
)
|
||||
keyList.add(fixedKey)
|
||||
}
|
||||
return PGPSecretKeyRing(keyList)
|
||||
}
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue