OpenPGPKey.java

package org.bouncycastle.openpgp.api;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import org.bouncycastle.bcpg.BCPGOutputStream;
import org.bouncycastle.bcpg.HashAlgorithmTags;
import org.bouncycastle.bcpg.KeyIdentifier;
import org.bouncycastle.bcpg.PacketFormat;
import org.bouncycastle.bcpg.PublicKeyPacket;
import org.bouncycastle.bcpg.S2K;
import org.bouncycastle.bcpg.SecretKeyPacket;
import org.bouncycastle.openpgp.PGPException;
import org.bouncycastle.openpgp.PGPKeyPair;
import org.bouncycastle.openpgp.PGPKeyValidationException;
import org.bouncycastle.openpgp.PGPPrivateKey;
import org.bouncycastle.openpgp.PGPSecretKey;
import org.bouncycastle.openpgp.PGPSecretKeyRing;
import org.bouncycastle.openpgp.api.exception.KeyPassphraseException;
import org.bouncycastle.openpgp.operator.PBESecretKeyDecryptor;
import org.bouncycastle.openpgp.operator.PBESecretKeyDecryptorBuilderProvider;
import org.bouncycastle.openpgp.operator.PBESecretKeyEncryptor;
import org.bouncycastle.openpgp.operator.PBESecretKeyEncryptorFactory;

/**
 * An {@link OpenPGPKey} (TSK - transferable secret key) is the pendant to an {@link OpenPGPCertificate},
 * but containing the secret key material in addition to the public components.
 * It consists of one or multiple {@link OpenPGPSecretKey} objects.
 */
public class OpenPGPKey
    extends OpenPGPCertificate
{
    // This class extends OpenPGPCertificate, but also holds secret key components in a dedicated map.
    private final Map<KeyIdentifier, OpenPGPSecretKey> secretKeys;

    /**
     * Create an {@link OpenPGPKey} instance based on a {@link PGPSecretKeyRing}.
     * The {@link OpenPGPImplementation} will be acquired by invoking {@link OpenPGPImplementation#getInstance()}.
     *
     * @param keyRing secret key ring
     */
    public OpenPGPKey(PGPSecretKeyRing keyRing)
    {
        this(keyRing, OpenPGPImplementation.getInstance());
    }

    /**
     * Create an {@link OpenPGPKey} instance based on a {@link PGPSecretKeyRing},
     * a provided {@link OpenPGPImplementation} and its {@link OpenPGPPolicy}.
     *
     * @param keyRing        secret key ring
     * @param implementation OpenPGP implementation
     */
    public OpenPGPKey(PGPSecretKeyRing keyRing, OpenPGPImplementation implementation)
    {
        this(keyRing, implementation, implementation.policy());
    }

    public OpenPGPKey(Collection<OpenPGPSecretKey> secretKeys, OpenPGPImplementation implementation)
    {
        this(secretKeys, implementation, implementation.policy());
    }

    public OpenPGPKey(Collection<OpenPGPSecretKey> secretKeys, OpenPGPImplementation implementation, OpenPGPPolicy policy)
    {
        this(fromSecretKeys(secretKeys), implementation, policy);
    }

    private static PGPSecretKeyRing fromSecretKeys(Collection<OpenPGPSecretKey> secretKeys)
    {
        List<PGPSecretKey> pgpSecretKeys = new ArrayList<>();
        for (OpenPGPSecretKey secretKey : secretKeys)
        {
            pgpSecretKeys.add(secretKey.getPGPSecretKey());
        }
        return new PGPSecretKeyRing(pgpSecretKeys);
    }

    /**
     * Create an {@link OpenPGPKey} instance based on a {@link PGPSecretKeyRing},
     * a provided {@link OpenPGPImplementation} and {@link OpenPGPPolicy}.
     *
     * @param keyRing        secret key ring
     * @param implementation OpenPGP implementation
     * @param policy         OpenPGP policy
     */
    public OpenPGPKey(PGPSecretKeyRing keyRing, OpenPGPImplementation implementation, OpenPGPPolicy policy)
    {
        super(keyRing, implementation, policy);

        // Process and map secret keys
        this.secretKeys = new LinkedHashMap<KeyIdentifier, OpenPGPSecretKey>();
        for (Iterator it = getKeys().iterator(); it.hasNext(); )
        {
            OpenPGPComponentKey key = (OpenPGPComponentKey)it.next();
            KeyIdentifier identifier = key.getKeyIdentifier();
            PGPSecretKey secretKey = keyRing.getSecretKey(identifier);
            if (secretKey == null)
            {
                continue;
            }

            secretKeys.put(identifier, new OpenPGPSecretKey(key, secretKey, implementation.pbeSecretKeyDecryptorBuilderProvider()));
        }
    }

    @Override
    public boolean isSecretKey()
    {
        return true;
    }

    /**
     * Return the {@link OpenPGPCertificate} of this {@link OpenPGPKey}.
     *
     * @return certificate
     */
    public OpenPGPCertificate toCertificate()
    {
        return new OpenPGPCertificate(getPGPPublicKeyRing(), implementation, policy);
    }

    @Override
    public List<OpenPGPCertificateComponent> getComponents()
    {
        // We go through the list of components returned by OpenPGPCertificate and replace those components
        //  where we have the secret key available

        // contains only public components
        List<OpenPGPCertificateComponent> components = super.getComponents();
        for (int i = components.size() - 1; i >= 0; i--)
        {
            OpenPGPCertificateComponent component = (OpenPGPCertificateComponent)components.get(i);
            if (component instanceof OpenPGPComponentKey)
            {
                OpenPGPSecretKey secretKey = getSecretKey((OpenPGPComponentKey)component);
                if (secretKey != null)
                {
                    // swap in secret component
                    components.remove(i);
                    components.add(i, secretKey);
                }
            }
        }
        return components;
    }

    /**
     * Return the {@link OpenPGPSecretKey} of this key's primary key.
     *
     * @return primary secret key
     */
    public OpenPGPSecretKey getPrimarySecretKey()
    {
        return getSecretKey(getPrimaryKey());
    }

    /**
     * Return a {@link Map} containing all {@link OpenPGPSecretKey} components (secret subkeys) of the key.
     *
     * @return secret key components
     */
    public Map<KeyIdentifier, OpenPGPSecretKey> getSecretKeys()
    {
        return new LinkedHashMap<KeyIdentifier, OpenPGPSecretKey>(secretKeys);
    }

    /**
     * Return the {@link OpenPGPSecretKey} identified by the passed {@link KeyIdentifier}.
     *
     * @param identifier key identifier
     * @return corresponding secret key or null
     */
    public OpenPGPSecretKey getSecretKey(KeyIdentifier identifier)
    {
        return secretKeys.get(identifier);
    }

    /**
     * Return the {@link OpenPGPSecretKey} that corresponds to the passed {@link OpenPGPComponentKey}.
     *
     * @param key component key
     * @return corresponding secret key or null
     */
    public OpenPGPSecretKey getSecretKey(OpenPGPComponentKey key)
    {
        return getSecretKey(key.getKeyIdentifier());
    }

    /**
     * Replace the given secret key component.
     *
     * @param secretKey secret key
     */
    void replaceSecretKey(OpenPGPSecretKey secretKey)
    {
        keyRing = PGPSecretKeyRing.insertSecretKey((PGPSecretKeyRing)keyRing, secretKey.rawSecKey);
        secretKeys.put(secretKey.getKeyIdentifier(), secretKey);
    }

    @Override
    public PGPSecretKeyRing getPGPKeyRing()
    {
        return getPGPSecretKeyRing();
    }

    /**
     * Return the underlying {@link PGPSecretKeyRing}.
     *
     * @return secret key ring
     */
    public PGPSecretKeyRing getPGPSecretKeyRing()
    {
        return (PGPSecretKeyRing)super.getPGPKeyRing();
    }

    @Override
    public byte[] getEncoded(PacketFormat packetFormat)
        throws IOException
    {
        ByteArrayOutputStream bOut = new ByteArrayOutputStream();
        BCPGOutputStream pOut = new BCPGOutputStream(bOut, packetFormat);
        getPGPSecretKeyRing().encode(pOut);
        pOut.close();
        return bOut.toByteArray();
    }

    /**
     * Secret key component of a {@link org.bouncycastle.openpgp.api.OpenPGPCertificate.OpenPGPPrimaryKey} or
     * {@link org.bouncycastle.openpgp.api.OpenPGPCertificate.OpenPGPSubkey}.
     */
    public static class OpenPGPSecretKey
        extends OpenPGPComponentKey
    {
        private final PGPSecretKey rawSecKey;
        private final OpenPGPComponentKey pubKey;
        private final PBESecretKeyDecryptorBuilderProvider decryptorBuilderProvider;

        /**
         * Constructor.
         *
         * @param pubKey                   corresponding public key component
         * @param secKey                   secret key
         * @param decryptorBuilderProvider for unlocking private keys
         */
        public OpenPGPSecretKey(OpenPGPComponentKey pubKey,
                                PGPSecretKey secKey,
                                PBESecretKeyDecryptorBuilderProvider decryptorBuilderProvider)
        {
            super(pubKey.getPGPPublicKey(), pubKey.getCertificate());
            this.decryptorBuilderProvider = decryptorBuilderProvider;
            this.rawSecKey = secKey;
            this.pubKey = pubKey;
        }

        @Override
        protected OpenPGPCertificateComponent getPublicComponent()
        {
            // return the public key component to properly map this secret key to its public key component when
            //  the public key component is used as key in a map.
            return pubKey;
        }

        @Override
        public boolean isPrimaryKey()
        {
            return getPublicKey().isPrimaryKey();
        }

        @Override
        public OpenPGPComponentSignature getLatestSelfSignature(Date evaluationTime)
        {
            return getPublicKey().getLatestSelfSignature(evaluationTime);
        }

        /**
         * Return the {@link OpenPGPKey} which this {@link OpenPGPSecretKey} belongs to.
         *
         * @return OpenPGPKey
         */
        public OpenPGPKey getOpenPGPKey()
        {
            return (OpenPGPKey)getCertificate();
        }

        @Override
        public String toDetailString()
        {
            return "Private" + pubKey.toDetailString();
        }

        /**
         * Return the underlying {@link PGPSecretKey}.
         *
         * @return secret key
         */
        public PGPSecretKey getPGPSecretKey()
        {
            return rawSecKey;
        }

        /**
         * Return the public {@link OpenPGPComponentKey} corresponding to this {@link OpenPGPSecretKey}.
         *
         * @return public component key
         */
        public OpenPGPComponentKey getPublicKey()
        {
            return pubKey;
        }

        /**
         * If true, the secret key is not available in plain and likely needs to be decrypted by providing
         * a key passphrase.
         *
         * @return true if the key is locked
         */
        public boolean isLocked()
        {
            return getPGPSecretKey().getS2KUsage() != SecretKeyPacket.USAGE_NONE;
        }

        /**
         * Unlock an unprotected {@link OpenPGPSecretKey}.
         *
         * @return unlocked private key
         * @throws PGPException if the key cannot be unlocked
         */
        public OpenPGPPrivateKey unlock()
            throws PGPException
        {
            return unlock((char[])null);
        }

        /**
         * Unlock a protected {@link OpenPGPSecretKey}.
         *
         * @param passphraseProvider provider for key passphrases
         * @return unlocked private key
         * @throws PGPException if the key cannot be unlocked
         */
        public OpenPGPPrivateKey unlock(KeyPassphraseProvider passphraseProvider)
            throws PGPException
        {
            if (!isLocked())
            {
                return unlock((char[])null);
            }
            return unlock(passphraseProvider.getKeyPassword(this));
        }

        /**
         * Access the {@link PGPKeyPair} by unlocking the potentially locked secret key using the provided
         * passphrase. Note: If the key is not locked, it is sufficient to pass null as passphrase.
         *
         * @param passphrase passphrase or null
         * @return keypair containing unlocked private key
         * @throws PGPException if the key cannot be unlocked
         */
        public OpenPGPPrivateKey unlock(char[] passphrase)
            throws PGPException
        {
            sanitizeProtectionMode();
            PBESecretKeyDecryptor decryptor = null;
            try
            {
                if (passphrase != null)
                {
                    decryptor = decryptorBuilderProvider.provide().build(passphrase);
                }

                PGPPrivateKey privateKey = getPGPSecretKey().extractPrivateKey(decryptor);
                if (privateKey == null)
                {
                    return null;
                }

                PGPKeyPair unlockedKey = new PGPKeyPair(getPGPSecretKey().getPublicKey(), privateKey);
                return new OpenPGPPrivateKey(this, unlockedKey);
            }
            catch (PGPException e)
            {
                throw new KeyPassphraseException(this, e);
            }
        }

        private void sanitizeProtectionMode()
            throws PGPException
        {
            if (!isLocked())
            {
                return;
            }

            PGPSecretKey secretKey = getPGPSecretKey();
            S2K s2k = secretKey.getS2K();
            if (s2k == null)
            {
                throw new PGPKeyValidationException("Legacy CFB using MD5 is not allowed.");
            }

            if (s2k.getType() == S2K.ARGON_2 && secretKey.getS2KUsage() != SecretKeyPacket.USAGE_AEAD)
            {
                throw new PGPKeyValidationException("Argon2 without AEAD is not allowed.");
            }

            if (getVersion() == PublicKeyPacket.VERSION_6)
            {
                if (secretKey.getS2KUsage() == SecretKeyPacket.USAGE_CHECKSUM)
                {
                    throw new PGPKeyValidationException("Version 6 keys MUST NOT use malleable CFB.");
                }
                if (s2k.getType() == S2K.SIMPLE)
                {
                    throw new PGPKeyValidationException("Version 6 keys MUST NOT use SIMPLE S2K.");
                }
            }
        }

        /**
         * Return true if the provided passphrase is correct.
         * Note: This method will always return false for stripped secret keys.
         *
         * @param passphrase passphrase
         * @return true if the passphrase is correct
         */
        public boolean isPassphraseCorrect(char[] passphrase)
        {
            if (passphrase != null && !isLocked())
            {
                return false;
            }

            try
            {
                OpenPGPPrivateKey privateKey = unlock(passphrase);
                return privateKey != null && privateKey.unlockedKey != null;
            }
            catch (PGPException e)
            {
                return false;
            }
        }
    }

    /**
     * Unlocked {@link OpenPGPSecretKey}.
     */
    public static class OpenPGPPrivateKey
    {
        private final OpenPGPSecretKey secretKey;
        private final PGPKeyPair unlockedKey;

        public OpenPGPPrivateKey(OpenPGPSecretKey secretKey, PGPKeyPair unlockedKey)
        {
            this.secretKey = secretKey;
            this.unlockedKey = unlockedKey;
        }

        /**
         * Return the public {@link OpenPGPComponentKey} of this {@link OpenPGPPrivateKey}.
         *
         * @return public component key
         */
        public OpenPGPComponentKey getPublicKey()
        {
            return secretKey.getPublicKey();
        }

        /**
         * Return the {@link OpenPGPSecretKey} in its potentially locked form.
         *
         * @return secret key
         */
        public OpenPGPSecretKey getSecretKey()
        {
            return secretKey;
        }

        /**
         * Return the unlocked {@link PGPKeyPair} containing the decrypted {@link PGPPrivateKey}.
         *
         * @return unlocked private key
         */
        public PGPKeyPair getKeyPair()
        {
            return unlockedKey;
        }

        /**
         * Return the used {@link OpenPGPImplementation}.
         *
         * @return implementation
         */
        private OpenPGPImplementation getImplementation()
        {
            return getSecretKey().getOpenPGPKey().implementation;
        }

        /**
         * Return a NEW instance of the {@link OpenPGPSecretKey} locked with the new passphrase.
         * If the key was unprotected before, or if it was protected using AEAD, the new instance will be
         * protected using AEAD as well.
         *
         * @param newPassphrase new passphrase
         * @return new instance of the key, locked with the new passphrase
         * @throws PGPException if the key cannot be locked
         */
        public OpenPGPSecretKey changePassphrase(char[] newPassphrase)
            throws PGPException
        {
            boolean useAead = !secretKey.isLocked() ||
                secretKey.getPGPSecretKey().getS2KUsage() == SecretKeyPacket.USAGE_AEAD;

            return changePassphrase(newPassphrase, getImplementation(), useAead);
        }

        /**
         * Return a NEW instance of the {@link OpenPGPSecretKey} locked with the new passphrase.
         *
         * @param newPassphrase  new passphrase
         * @param implementation OpenPGP implementation
         * @param useAEAD        whether to protect the key using AEAD
         * @return new instance of the key, locked with the new passphrase
         * @throws PGPException if the key cannot be locked
         */
        public OpenPGPSecretKey changePassphrase(char[] newPassphrase,
                                                 OpenPGPImplementation implementation,
                                                 boolean useAEAD)
            throws PGPException
        {
            return changePassphrase(newPassphrase, implementation.pbeSecretKeyEncryptorFactory(useAEAD));
        }

        /**
         * Return a NEW instance of the {@link OpenPGPSecretKey} locked with the new passphrase.
         *
         * @param newPassphrase       new passphrase
         * @param keyEncryptorFactory factory for {@link PBESecretKeyEncryptor} instances
         * @return new instance of the key, locked with the new passphrase
         * @throws PGPException if the key cannot be locked
         */
        public OpenPGPSecretKey changePassphrase(char[] newPassphrase,
                                                 PBESecretKeyEncryptorFactory keyEncryptorFactory)
            throws PGPException
        {
            PBESecretKeyEncryptor keyEncryptor;
            if (newPassphrase == null || newPassphrase.length == 0)
            {
                keyEncryptor = null;
            }
            else
            {
                keyEncryptor = keyEncryptorFactory.build(
                    newPassphrase,
                    getKeyPair().getPublicKey().getPublicKeyPacket());
            }

            return changePassphrase(keyEncryptor);
        }

        /**
         * Return a NEW instance of the {@link OpenPGPSecretKey} locked using the given {@link PBESecretKeyEncryptor}.
         *
         * @param keyEncryptor encryptor
         * @return new instance of the key, locked with the key encryptor
         * @throws PGPException if the key cannot be locked
         */
        public OpenPGPSecretKey changePassphrase(PBESecretKeyEncryptor keyEncryptor)
            throws PGPException
        {
            PGPSecretKey encrypted = new PGPSecretKey(
                getKeyPair().getPrivateKey(),
                getKeyPair().getPublicKey(),
                getImplementation().pgpDigestCalculatorProvider().get(HashAlgorithmTags.SHA1),
                getSecretKey().isPrimaryKey(),
                keyEncryptor);

            OpenPGPSecretKey sk = new OpenPGPSecretKey(
                getSecretKey().getPublicKey(),
                encrypted,
                getImplementation().pbeSecretKeyDecryptorBuilderProvider());
            sk.sanitizeProtectionMode();
            return sk;
        }

        /**
         * Return a NEW instance of the {@link OpenPGPSecretKey} with removed passphrase protection.
         *
         * @return unlocked new instance of the key
         * @throws PGPException if the key cannot be unlocked
         */
        public OpenPGPSecretKey removePassphrase()
            throws PGPException
        {
            return changePassphrase((PBESecretKeyEncryptor)null);
        }
    }
}