relates to #1228 - added parent class for PGP symmetric encrypted data. Changed add session method for PGPEncryptedDataList to a create.

Author: dghgit

pg/src/main/java/org/bouncycastle/openpgp/PGPEncryptedDataList.java

@@ -39,7 +39,7 @@ public class PGPEncryptedDataList
     private static final Logger LOG = Logger.getLogger(PGPEncryptedDataList.class.getName());
 
     List<PGPEncryptedData> methods = new ArrayList<PGPEncryptedData>();
-    InputStreamPacket      data;
+    InputStreamPacket data;
 
     /**
      * Construct an encrypted data packet holder, reading PGP encrypted method packets and an
@@ -48,6 +48,7 @@ public class PGPEncryptedDataList
      * The first packet in the stream should be one of {@link PacketTags#SYMMETRIC_KEY_ENC_SESSION}
      * or {@link PacketTags#PUBLIC_KEY_ENC_SESSION}.
      * </p>
+     *
      * @param encData a byte array containing an encrypted stream.
      * @throws IOException if an error occurs reading from the PGP input.
      */
@@ -65,6 +66,7 @@ public PGPEncryptedDataList(
      * The first packet in the stream should be one of {@link PacketTags#SYMMETRIC_KEY_ENC_SESSION}
      * or {@link PacketTags#PUBLIC_KEY_ENC_SESSION}.
      * </p>
+     *
      * @param inStream the input stream being read.
      * @throws IOException if an error occurs reading from the PGP input.
      */
@@ -82,11 +84,12 @@ public PGPEncryptedDataList(
      * The next packet in the stream should be one of {@link PacketTags#SYMMETRIC_KEY_ENC_SESSION}
      * or {@link PacketTags#PUBLIC_KEY_ENC_SESSION}.
      * </p>
+     *
      * @param pIn the PGP object stream being read.
      * @throws IOException if an error occurs reading from the PGP input.
      */
     public PGPEncryptedDataList(
-        BCPGInputStream    pIn)
+        BCPGInputStream pIn)
         throws IOException
     {
         List list = new ArrayList();
@@ -130,26 +133,13 @@ public PGPEncryptedDataList(
     }
 
     /**
-     * Add a decryption method using a {@link PGPSessionKey}.
-     * This method can be used to decrypt messages which do not contain a SKESK or PKESK packet using a
-     * session key.
-     *
-     * @param sessionKey session key for message decryption
-     * @return session key encrypted data
-     */
-    public PGPSessionKeyEncryptedData addSessionKeyDecryptionMethod(PGPSessionKey sessionKey)
-    {
-        PGPSessionKeyEncryptedData sessionKeyEncryptedData = new PGPSessionKeyEncryptedData(sessionKey, data);
-        methods.add(sessionKeyEncryptedData);
-        return sessionKeyEncryptedData;
-    }
-
-    /** Checks whether the packet is integrity protected.
+     * Checks whether the packet is integrity protected.
      *
      * @return <code>true</code> if there is a modification detection code package associated with
      * this stream
      */
-    public boolean isIntegrityProtected() {
+    public boolean isIntegrityProtected()
+    {
         return data instanceof SymmetricEncIntegrityPacket;
     }
 
@@ -159,7 +149,7 @@ public boolean isIntegrityProtected() {
      * @param index the encryption method to obtain (0 based).
      */
     public PGPEncryptedData get(
-        int    index)
+        int index)
     {
         return (PGPEncryptedData)methods.get(index);
     }
@@ -196,4 +186,16 @@ public Iterator<PGPEncryptedData> iterator()
     {
         return getEncryptedDataObjects();
     }
+
+    /**
+     * Create a decryption method using a {@link PGPSessionKey}. This method can be used to decrypt messages which do not
+     * contain a SKESK or PKESK packet using a session key.
+     *
+     * @param sessionKey session key for message decryption
+     * @return session key encrypted data
+     */
+    public PGPSessionKeyEncryptedData makeSessionKeyEncryptedData(PGPSessionKey sessionKey)
+    {
+        return new PGPSessionKeyEncryptedData(sessionKey, data);
+    }
 }

pg/src/main/java/org/bouncycastle/openpgp/PGPPBEEncryptedData.java

@@ -1,19 +1,13 @@
 package org.bouncycastle.openpgp;
 
-import java.io.EOFException;
 import java.io.InputStream;
 
-import org.bouncycastle.bcpg.AEADEncDataPacket;
-import org.bouncycastle.bcpg.BCPGInputStream;
 import org.bouncycastle.bcpg.InputStreamPacket;
-import org.bouncycastle.bcpg.SymmetricEncIntegrityPacket;
 import org.bouncycastle.bcpg.SymmetricKeyAlgorithmTags;
 import org.bouncycastle.bcpg.SymmetricKeyEncSessionPacket;
 import org.bouncycastle.openpgp.operator.PBEDataDecryptorFactory;
-import org.bouncycastle.openpgp.operator.PGPDataDecryptor;
 import org.bouncycastle.openpgp.operator.SessionKeyDataDecryptorFactory;
 import org.bouncycastle.util.Arrays;
-import org.bouncycastle.util.io.TeeInputStream;
 
 /**
  * A password based encryption object.
@@ -23,7 +17,7 @@
  * </p>
  */
 public class PGPPBEEncryptedData
-    extends PGPEncryptedData
+    extends PGPSymmetricEncryptedData
 {
     SymmetricKeyEncSessionPacket keyData;
 
@@ -43,6 +37,16 @@ public class PGPPBEEncryptedData
         this.keyData = keyData;
     }
 
+    public int getVersion()
+    {
+        return keyData.getVersion();
+    }
+
+    public int getAlgorithm()
+    {
+        return keyData.getEncAlgorithm();
+    }
+
     /**
      * Return the symmetric key algorithm required to decrypt the data protected by this object.
      *
@@ -94,28 +98,7 @@ public InputStream getDataStream(
         {
             PGPSessionKey sessionKey = getSessionKey(dataDecryptorFactory);
 
-            if (encData instanceof AEADEncDataPacket)
-            {
-                AEADEncDataPacket aeadData = (AEADEncDataPacket)encData;
-
-                if (aeadData.getAlgorithm() != sessionKey.getAlgorithm())
-                {
-                    throw new PGPException("session key and AEAD algorithm mismatch");
-                }
-
-                PGPDataDecryptor dataDecryptor = dataDecryptorFactory.createDataDecryptor(aeadData.getAEADAlgorithm(), aeadData.getIV(), aeadData.getChunkSize(), sessionKey.getAlgorithm(), sessionKey.getKey());
-
-                BCPGInputStream encIn = encData.getInputStream();
-
-                encStream = new BCPGInputStream(dataDecryptor.getInputStream(encIn));
-            }
-            else
-            {
-                boolean withIntegrityPacket = encData instanceof SymmetricEncIntegrityPacket;
-                PGPDataDecryptor dataDecryptor = dataDecryptorFactory.createDataDecryptor(withIntegrityPacket, sessionKey.getAlgorithm(), sessionKey.getKey());
-
-                encStream =  getDataStream(withIntegrityPacket, dataDecryptor);
-            }
+            encStream = createDecryptionStream(dataDecryptorFactory, sessionKey);
 
             return encStream;
         }
@@ -136,79 +119,8 @@ public InputStream getDataStream(
         try
         {
             PGPSessionKey sessionKey = dataDecryptorFactory.getSessionKey();
-            boolean withIntegrityPacket = encData instanceof SymmetricEncIntegrityPacket;
-            PGPDataDecryptor dataDecryptor = dataDecryptorFactory.createDataDecryptor(withIntegrityPacket, sessionKey.getAlgorithm(), sessionKey.getKey());
-
-            return getDataStream(withIntegrityPacket, dataDecryptor);
-        }
-        catch (PGPException e)
-        {
-            throw e;
-        }
-        catch (Exception e)
-        {
-            throw new PGPException("Exception creating cipher", e);
-        }
-    }
-
-    private InputStream getDataStream(
-        boolean withIntegrityPacket,
-        PGPDataDecryptor dataDecryptor)
-        throws PGPException
-    {
-        try
-        {
-            BCPGInputStream encIn = encData.getInputStream();
-            encIn.mark(dataDecryptor.getBlockSize() + 2); // iv + 2 octets checksum
-
-            encStream = new BCPGInputStream(dataDecryptor.getInputStream(encIn));
-
-            if (withIntegrityPacket)
-            {
-                truncStream = new TruncatedStream(encStream);
-
-                integrityCalculator = dataDecryptor.getIntegrityCalculator();
-
-                encStream = new TeeInputStream(truncStream, integrityCalculator.getOutputStream());
-            }
-
-            byte[] iv = new byte[dataDecryptor.getBlockSize()];
-            for (int i = 0; i != iv.length; i++)
-            {
-                int ch = encStream.read();
-
-                if (ch < 0)
-                {
-                    throw new EOFException("unexpected end of stream.");
-                }
-
-                iv[i] = (byte)ch;
-            }
-
-            int v1 = encStream.read();
-            int v2 = encStream.read();
-
-            if (v1 < 0 || v2 < 0)
-            {
-                throw new EOFException("unexpected end of stream.");
-            }
-
 
-            // Note: the oracle attack on "quick check" bytes is not deemed
-            // a security risk for PBE (see PGPPublicKeyEncryptedData)
-
-            boolean repeatCheckPassed = iv[iv.length - 2] == (byte)v1
-                && iv[iv.length - 1] == (byte)v2;
-
-            // Note: some versions of PGP appear to produce 0 for the extra
-            // bytes rather than repeating the two previous bytes
-            boolean zeroesCheckPassed = v1 == 0 && v2 == 0;
-
-            if (!repeatCheckPassed && !zeroesCheckPassed)
-            {
-                encIn.reset();
-                throw new PGPDataValidationException("data check failed.");
-            }
+            encStream = createDecryptionStream(dataDecryptorFactory, sessionKey);
 
             return encStream;
         }
@@ -221,14 +133,4 @@ private InputStream getDataStream(
             throw new PGPException("Exception creating cipher", e);
         }
     }
-
-    public int getVersion()
-    {
-        return keyData.getVersion();
-    }
-
-    public int getAlgorithm()
-    {
-        return keyData.getEncAlgorithm();
-    }
 }