certify: add some subscopes in PgpKeyOperation for readability

note this commit introduces NO semantical changes whatsoever!

1 files changed, 128 insertions, 112 deletions

diff --git a/OpenPGP-Keychain/src/main/java/org/sufficientlysecure/keychain/pgp/PgpKeyOperation.java b/OpenPGP-Keychain/src/main/java/org/sufficientlysecure/keychain/pgp/PgpKeyOperation.java
index c7ec02d7d..fe09ea525 100644
--- a/OpenPGP-Keychain/src/main/java/org/sufficientlysecure/keychain/pgp/PgpKeyOperation.java
+++ b/OpenPGP-Keychain/src/main/java/org/sufficientlysecure/keychain/pgp/PgpKeyOperation.java
@@ -215,105 +215,117 @@ public class PgpKeyOperation {
 
         updateProgress(R.string.progress_preparing_master_key, 10, 100);
 
-        int usageId = keysUsages.get(0);
-        boolean canSign =
-                (usageId == Id.choice.usage.sign_only || usageId == Id.choice.usage.sign_and_encrypt);
-        boolean canEncrypt =
-                (usageId == Id.choice.usage.encrypt_only || usageId == Id.choice.usage.sign_and_encrypt);
+        // prepare keyring generator with given master public and secret key
+        PGPKeyRingGenerator keyGen;
+        PGPPublicKey masterPublicKey; {
 
-        String mainUserId = userIds.get(0);
+            String mainUserId = userIds.get(0);
 
-        PGPSecretKey masterKey = keys.get(0);
+            // prepare the master key pair
+            PGPKeyPair masterKeyPair; {
 
-        // this removes all userIds and certifications previously attached to the masterPublicKey
-        PGPPublicKey tmpKey = masterKey.getPublicKey();
-        PGPPublicKey masterPublicKey = new PGPPublicKey(tmpKey.getAlgorithm(),
-                tmpKey.getKey(new BouncyCastleProvider()), tmpKey.getCreationTime());
+                PGPSecretKey masterKey = keys.get(0);
 
-        // already done by code above:
-        // PGPPublicKey masterPublicKey = masterKey.getPublicKey();
-        // // Somehow, the PGPPublicKey already has an empty certification attached to it when the
-        // // keyRing is generated the first time, we remove that when it exists, before adding the
-        // new
-        // // ones
-        // PGPPublicKey masterPublicKeyRmCert = PGPPublicKey.removeCertification(masterPublicKey,
-        // "");
-        // if (masterPublicKeyRmCert != null) {
-        // masterPublicKey = masterPublicKeyRmCert;
-        // }
+                // this removes all userIds and certifications previously attached to the masterPublicKey
+                PGPPublicKey tmpKey = masterKey.getPublicKey();
+                masterPublicKey = new PGPPublicKey(tmpKey.getAlgorithm(),
+                        tmpKey.getKey(new BouncyCastleProvider()), tmpKey.getCreationTime());
 
-        PBESecretKeyDecryptor keyDecryptor = new JcePBESecretKeyDecryptorBuilder().setProvider(
-                Constants.BOUNCY_CASTLE_PROVIDER_NAME).build(oldPassPhrase.toCharArray());
-        PGPPrivateKey masterPrivateKey = masterKey.extractPrivateKey(keyDecryptor);
+                // already done by code above:
+                // PGPPublicKey masterPublicKey = masterKey.getPublicKey();
+                // // Somehow, the PGPPublicKey already has an empty certification attached to it when the
+                // // keyRing is generated the first time, we remove that when it exists, before adding the
+                // new
+                // // ones
+                // PGPPublicKey masterPublicKeyRmCert = PGPPublicKey.removeCertification(masterPublicKey,
+                // "");
+                // if (masterPublicKeyRmCert != null) {
+                // masterPublicKey = masterPublicKeyRmCert;
+                // }
 
-        updateProgress(R.string.progress_certifying_master_key, 20, 100);
+                PBESecretKeyDecryptor keyDecryptor = new JcePBESecretKeyDecryptorBuilder().setProvider(
+                        Constants.BOUNCY_CASTLE_PROVIDER_NAME).build(oldPassPhrase.toCharArray());
+                PGPPrivateKey masterPrivateKey = masterKey.extractPrivateKey(keyDecryptor);
 
-        // TODO: if we are editing a key, keep old certs, don't remake certs we don't have to.
+                updateProgress(R.string.progress_certifying_master_key, 20, 100);
 
-        for (String userId : userIds) {
-            PGPContentSignerBuilder signerBuilder = new JcaPGPContentSignerBuilder(
-                    masterPublicKey.getAlgorithm(), HashAlgorithmTags.SHA1)
-                    .setProvider(Constants.BOUNCY_CASTLE_PROVIDER_NAME);
-            PGPSignatureGenerator sGen = new PGPSignatureGenerator(signerBuilder);
+                // TODO: if we are editing a key, keep old certs, don't remake certs we don't have to.
 
-            sGen.init(PGPSignature.POSITIVE_CERTIFICATION, masterPrivateKey);
+                for (String userId : userIds) {
+                    PGPContentSignerBuilder signerBuilder = new JcaPGPContentSignerBuilder(
+                            masterPublicKey.getAlgorithm(), HashAlgorithmTags.SHA1)
+                            .setProvider(Constants.BOUNCY_CASTLE_PROVIDER_NAME);
+                    PGPSignatureGenerator sGen = new PGPSignatureGenerator(signerBuilder);
 
-            PGPSignature certification = sGen.generateCertification(userId, masterPublicKey);
+                    sGen.init(PGPSignature.POSITIVE_CERTIFICATION, masterPrivateKey);
 
-            masterPublicKey = PGPPublicKey.addCertification(masterPublicKey, userId, certification);
-        }
+                    PGPSignature certification = sGen.generateCertification(userId, masterPublicKey);
 
-        PGPKeyPair masterKeyPair = new PGPKeyPair(masterPublicKey, masterPrivateKey);
+                    masterPublicKey = PGPPublicKey.addCertification(masterPublicKey, userId, certification);
+                }
 
-        PGPSignatureSubpacketGenerator hashedPacketsGen = new PGPSignatureSubpacketGenerator();
-        PGPSignatureSubpacketGenerator unhashedPacketsGen = new PGPSignatureSubpacketGenerator();
+                masterKeyPair = new PGPKeyPair(masterPublicKey, masterPrivateKey);
+            }
 
-        int keyFlags = KeyFlags.CERTIFY_OTHER | KeyFlags.SIGN_DATA;
-        if (canEncrypt) {
-            keyFlags |= KeyFlags.ENCRYPT_COMMS | KeyFlags.ENCRYPT_STORAGE;
-        }
-        hashedPacketsGen.setKeyFlags(true, keyFlags);
-
-        hashedPacketsGen.setPreferredSymmetricAlgorithms(true, PREFERRED_SYMMETRIC_ALGORITHMS);
-        hashedPacketsGen.setPreferredHashAlgorithms(true, PREFERRED_HASH_ALGORITHMS);
-        hashedPacketsGen.setPreferredCompressionAlgorithms(true, PREFERRED_COMPRESSION_ALGORITHMS);
-
-        if (keysExpiryDates.get(0) != null) {
-            GregorianCalendar creationDate = new GregorianCalendar(TimeZone.getTimeZone("UTC"));
-            creationDate.setTime(masterPublicKey.getCreationTime());
-            GregorianCalendar expiryDate = keysExpiryDates.get(0);
-            //note that the below, (a/c) - (b/c) is *not* the same as (a - b) /c
-            //here we purposefully ignore partial days in each date - long type has no fractional part!
-            long numDays =
-                    (expiryDate.getTimeInMillis() / 86400000) - (creationDate.getTimeInMillis() / 86400000);
-            if (numDays <= 0) {
-                throw new PgpGeneralException(
-                        mContext.getString(R.string.error_expiry_must_come_after_creation));
+            PGPSignatureSubpacketGenerator hashedPacketsGen;
+            PGPSignatureSubpacketGenerator unhashedPacketsGen; {
+
+                hashedPacketsGen = new PGPSignatureSubpacketGenerator();
+                unhashedPacketsGen = new PGPSignatureSubpacketGenerator();
+
+                int usageId = keysUsages.get(0);
+                boolean canEncrypt =
+                        (usageId == Id.choice.usage.encrypt_only || usageId == Id.choice.usage.sign_and_encrypt);
+
+                int keyFlags = KeyFlags.CERTIFY_OTHER | KeyFlags.SIGN_DATA;
+                if (canEncrypt) {
+                    keyFlags |= KeyFlags.ENCRYPT_COMMS | KeyFlags.ENCRYPT_STORAGE;
+                }
+                hashedPacketsGen.setKeyFlags(true, keyFlags);
+
+                hashedPacketsGen.setPreferredSymmetricAlgorithms(true, PREFERRED_SYMMETRIC_ALGORITHMS);
+                hashedPacketsGen.setPreferredHashAlgorithms(true, PREFERRED_HASH_ALGORITHMS);
+                hashedPacketsGen.setPreferredCompressionAlgorithms(true, PREFERRED_COMPRESSION_ALGORITHMS);
+
+                if (keysExpiryDates.get(0) != null) {
+                    GregorianCalendar creationDate = new GregorianCalendar(TimeZone.getTimeZone("UTC"));
+                    creationDate.setTime(masterPublicKey.getCreationTime());
+                    GregorianCalendar expiryDate = keysExpiryDates.get(0);
+                    //note that the below, (a/c) - (b/c) is *not* the same as (a - b) /c
+                    //here we purposefully ignore partial days in each date - long type has no fractional part!
+                    long numDays =
+                            (expiryDate.getTimeInMillis() / 86400000) - (creationDate.getTimeInMillis() / 86400000);
+                    if (numDays <= 0) {
+                        throw new PgpGeneralException(
+                                mContext.getString(R.string.error_expiry_must_come_after_creation));
+                    }
+                    hashedPacketsGen.setKeyExpirationTime(false, numDays * 86400);
+                } else {
+                    //do this explicitly, although since we're rebuilding,
+                    hashedPacketsGen.setKeyExpirationTime(false, 0);
+                    //this happens anyway
+                }
             }
-            hashedPacketsGen.setKeyExpirationTime(false, numDays * 86400);
-        } else {
-            //do this explicitly, although since we're rebuilding,
-            hashedPacketsGen.setKeyExpirationTime(false, 0);
-            //this happens anyway
-        }
 
-        updateProgress(R.string.progress_building_master_key, 30, 100);
+            updateProgress(R.string.progress_building_master_key, 30, 100);
 
-        // define hashing and signing algos
-        PGPDigestCalculator sha1Calc = new JcaPGPDigestCalculatorProviderBuilder().build().get(
-                HashAlgorithmTags.SHA1);
-        PGPContentSignerBuilder certificationSignerBuilder = new JcaPGPContentSignerBuilder(
-                masterKeyPair.getPublicKey().getAlgorithm(), HashAlgorithmTags.SHA1);
+            // define hashing and signing algos
+            PGPDigestCalculator sha1Calc = new JcaPGPDigestCalculatorProviderBuilder().build().get(
+                    HashAlgorithmTags.SHA1);
+            PGPContentSignerBuilder certificationSignerBuilder = new JcaPGPContentSignerBuilder(
+                    masterKeyPair.getPublicKey().getAlgorithm(), HashAlgorithmTags.SHA1);
 
-        // Build key encrypter based on passphrase
-        PBESecretKeyEncryptor keyEncryptor = new JcePBESecretKeyEncryptorBuilder(
-                PGPEncryptedData.CAST5, sha1Calc)
-                .setProvider(Constants.BOUNCY_CASTLE_PROVIDER_NAME).build(
-                        newPassPhrase.toCharArray());
+            // Build key encrypter based on passphrase
+            PBESecretKeyEncryptor keyEncryptor = new JcePBESecretKeyEncryptorBuilder(
+                    PGPEncryptedData.CAST5, sha1Calc)
+                    .setProvider(Constants.BOUNCY_CASTLE_PROVIDER_NAME).build(
+                            newPassPhrase.toCharArray());
+
+            keyGen = new PGPKeyRingGenerator(PGPSignature.POSITIVE_CERTIFICATION,
+                    masterKeyPair, mainUserId, sha1Calc, hashedPacketsGen.generate(),
+                    unhashedPacketsGen.generate(), certificationSignerBuilder, keyEncryptor);
 
-        PGPKeyRingGenerator keyGen = new PGPKeyRingGenerator(PGPSignature.POSITIVE_CERTIFICATION,
-                masterKeyPair, mainUserId, sha1Calc, hashedPacketsGen.generate(),
-                unhashedPacketsGen.generate(), certificationSignerBuilder, keyEncryptor);
+        }
 
         updateProgress(R.string.progress_adding_sub_keys, 40, 100);
 
@@ -323,23 +335,23 @@ public class PgpKeyOperation {
             PGPSecretKey subKey = keys.get(i);
             PGPPublicKey subPublicKey = subKey.getPublicKey();
 
-            PBESecretKeyDecryptor keyDecryptor2 = new JcePBESecretKeyDecryptorBuilder()
+            PBESecretKeyDecryptor keyDecryptor = new JcePBESecretKeyDecryptorBuilder()
                     .setProvider(Constants.BOUNCY_CASTLE_PROVIDER_NAME).build(
                             oldPassPhrase.toCharArray());
-            PGPPrivateKey subPrivateKey = subKey.extractPrivateKey(keyDecryptor2);
+            PGPPrivateKey subPrivateKey = subKey.extractPrivateKey(keyDecryptor);
 
             // TODO: now used without algorithm and creation time?! (APG 1)
             PGPKeyPair subKeyPair = new PGPKeyPair(subPublicKey, subPrivateKey);
 
-            hashedPacketsGen = new PGPSignatureSubpacketGenerator();
-            unhashedPacketsGen = new PGPSignatureSubpacketGenerator();
+            PGPSignatureSubpacketGenerator hashedPacketsGen = new PGPSignatureSubpacketGenerator();
+            PGPSignatureSubpacketGenerator unhashedPacketsGen = new PGPSignatureSubpacketGenerator();
 
-            keyFlags = 0;
+            int keyFlags = 0;
 
-            usageId = keysUsages.get(i);
-            canSign =
+            int usageId = keysUsages.get(i);
+            boolean canSign =
                     (usageId == Id.choice.usage.sign_only || usageId == Id.choice.usage.sign_and_encrypt);
-            canEncrypt =
+            boolean canEncrypt =
                     (usageId == Id.choice.usage.encrypt_only || usageId == Id.choice.usage.sign_and_encrypt);
             if (canSign) {
                 Date todayDate = new Date(); //both sig times the same
@@ -402,37 +414,41 @@ public class PgpKeyOperation {
         if (passphrase == null) {
             throw new PgpGeneralException("Unable to obtain passphrase");
         } else {
-            PGPPublicKeyRing pubring = ProviderHelper
-                    .getPGPPublicKeyRingByKeyId(mContext, pubKeyId);
 
-            PGPSecretKey certificationKey = PgpKeyHelper.getCertificationKey(mContext, masterKeyId);
-            if (certificationKey == null) {
-                throw new PgpGeneralException(mContext.getString(R.string.error_signature_failed));
-            }
-
-            PBESecretKeyDecryptor keyDecryptor = new JcePBESecretKeyDecryptorBuilder().setProvider(
-                    Constants.BOUNCY_CASTLE_PROVIDER_NAME).build(passphrase.toCharArray());
-            PGPPrivateKey signaturePrivateKey = certificationKey.extractPrivateKey(keyDecryptor);
-            if (signaturePrivateKey == null) {
-                throw new PgpGeneralException(
-                        mContext.getString(R.string.error_could_not_extract_private_key));
-            }
+            // create a signatureGenerator from the supplied masterKeyId and passphrase
+            PGPSignatureGenerator signatureGenerator; {
 
-            // TODO: SHA256 fixed?
-            JcaPGPContentSignerBuilder contentSignerBuilder = new JcaPGPContentSignerBuilder(
-                    certificationKey.getPublicKey().getAlgorithm(), PGPUtil.SHA256)
-                    .setProvider(Constants.BOUNCY_CASTLE_PROVIDER_NAME);
+                PGPSecretKey certificationKey = PgpKeyHelper.getCertificationKey(mContext, masterKeyId);
+                if (certificationKey == null) {
+                    throw new PgpGeneralException(mContext.getString(R.string.error_signature_failed));
+                }
 
-            PGPSignatureGenerator signatureGenerator = new PGPSignatureGenerator(
-                    contentSignerBuilder);
+                PBESecretKeyDecryptor keyDecryptor = new JcePBESecretKeyDecryptorBuilder().setProvider(
+                        Constants.BOUNCY_CASTLE_PROVIDER_NAME).build(passphrase.toCharArray());
+                PGPPrivateKey signaturePrivateKey = certificationKey.extractPrivateKey(keyDecryptor);
+                if (signaturePrivateKey == null) {
+                    throw new PgpGeneralException(
+                            mContext.getString(R.string.error_could_not_extract_private_key));
+                }
 
-            signatureGenerator.init(PGPSignature.DIRECT_KEY, signaturePrivateKey);
+                // TODO: SHA256 fixed?
+                JcaPGPContentSignerBuilder contentSignerBuilder = new JcaPGPContentSignerBuilder(
+                        certificationKey.getPublicKey().getAlgorithm(), PGPUtil.SHA256)
+                        .setProvider(Constants.BOUNCY_CASTLE_PROVIDER_NAME);
 
-            PGPSignatureSubpacketGenerator spGen = new PGPSignatureSubpacketGenerator();
+                signatureGenerator = new PGPSignatureGenerator(contentSignerBuilder);
+                signatureGenerator.init(PGPSignature.DIRECT_KEY, signaturePrivateKey);
+            }
 
-            PGPSignatureSubpacketVector packetVector = spGen.generate();
-            signatureGenerator.setHashedSubpackets(packetVector);
+            { // supply signatureGenerator with a SubpacketVector
+                PGPSignatureSubpacketGenerator spGen = new PGPSignatureSubpacketGenerator();
+                PGPSignatureSubpacketVector packetVector = spGen.generate();
+                signatureGenerator.setHashedSubpackets(packetVector);
+            }
 
+            // fetch public key ring, add the certification and return it
+            PGPPublicKeyRing pubring = ProviderHelper
+                    .getPGPPublicKeyRingByKeyId(mContext, pubKeyId);
             PGPPublicKey signedKey = PGPPublicKey.addCertification(pubring.getPublicKey(pubKeyId),
                     signatureGenerator.generate());
             pubring = PGPPublicKeyRing.insertPublicKey(pubring, signedKey);