// Copyright (C) 2002 IAIK
// https://sic.tech/
//
// Copyright (C) 2003 - 2025 Stiftung Secure Information and 
//                           Communication Technologies SIC
// https://sic.tech/
//
// All rights reserved.
//
// This source is provided for inspection purposes and recompilation only,
// unless specified differently in a contract with IAIK. This source has to
// be kept in strict confidence and must not be disclosed to any third party
// under any circumstances. Redistribution in source and binary forms, with
// or without modification, are <not> permitted in any case!
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
// OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE.
//
// $Header: /IAIK-CMS/current/src/demo/cms/envelopedData/EnvelopedDataDemoAEAD.java 5     12.02.25 17:58 Dbratko $
// $Revision: 5 $
//


package demo.cms.envelopedData;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.security.InvalidKeyException;
import java.security.Key;
import java.security.NoSuchAlgorithmException;
import java.security.PrivateKey;
import java.security.SecureRandom;

import javax.crypto.KeyGenerator;
import javax.crypto.SecretKey;

import demo.DemoUtil;
import demo.keystore.CMSKeyStore;
import iaik.asn1.ObjectID;
import iaik.asn1.structures.AlgorithmID;
import iaik.cms.CMSException;
import iaik.cms.CertificateIdentifier;
import iaik.cms.ContentInfo;
import iaik.cms.ContentInfoOutputStream;
import iaik.cms.ContentInfoStream;
import iaik.cms.EncryptedContentInfo;
import iaik.cms.EncryptedContentInfoStream;
import iaik.cms.EnvelopedData;
import iaik.cms.EnvelopedDataOutputStream;
import iaik.cms.EnvelopedDataStream;
import iaik.cms.IssuerAndSerialNumber;
import iaik.cms.KEKIdentifier;
import iaik.cms.KEKRecipientInfo;
import iaik.cms.KeyAgreeRecipientInfo;
import iaik.cms.KeyIdentifier;
import iaik.cms.KeyTransRecipientInfo;
import iaik.cms.RecipientInfo;
import iaik.cms.RecipientKeyIdentifier;
import iaik.cms.SubjectKeyID;
import iaik.security.random.SecRandom;
import iaik.utils.CryptoUtils;
import iaik.utils.Util;
import iaik.x509.X509Certificate;


/**
 * Demonstrates the usage of class {@link iaik.cms.EnvelopedDataStream}, 
 * {@link iaik.cms.EnvelopedData} and {@link iaik.cms.EnvelopedDataOutputStream} for
 * AEAD encrypting data using the CMS type EnvelopedData according to 
 * <a href = "http://www.ietf.org/rfc/rfc5652.txt" target="_blank">RFC 5652</a>.
 * <p>
 * Usually CMS uses AEAD cipher modes like GCM with the <code>AuthEnvelopedData</code> type. However, 
 * technically -- when appending the mac value to the cipher text -- it is also possible to use
 * AEAD ciphers with the <code>EnvelopedData</code> type as shown in this demo.
 * <br>
 * Since AES-CCM and AES-GCM are not implemented by IAIK-JCE versions prior 3.17, this demo
 * at least may require IAIK-JCE 3.17 as cryptographic service provider. 
 * ChaCha20-Poly1305 for CMS requires IAIK-JCE version 5.62 or later.
 * <p>
 * Keys and certificates are retrieved from the demo KeyStore ("cms.keystore") 
 * which has to be located in your current working directory and may be
 * created by running the {@link demo.keystore.SetupCMSKeyStore
 * SetupCMSKeyStore} program.
 * <p>
 * This demo requires Java 7 or later.
 * 
 * @see iaik.cms.EnvelopedDataStream
 * @see iaik.cms.EnvelopedData
 * @see iaik.cms.RecipientInfo
 * @see iaik.cms.KeyTransRecipientInfo
 * @see iaik.cms.KeyAgreeRecipientInfo
 * @see iaik.cms.KEKRecipientInfo
 */
public class EnvelopedDataDemoAEAD {

  // certificate of rsaUser 1
  X509Certificate rsaUser1;
  // private key of rsaUser 1
  PrivateKey rsaUser1_pk;
  // certificate of rsaUser 2
  X509Certificate rsaUser2;
  // private key of rsaUser 2
  PrivateKey rsaUser2_pk;

  // certificate of esdhUser 1
  X509Certificate esdhUser1;
  // private key of esdhUser 1
  PrivateKey esdhUser1_pk;
  // certificate of esdhUser 2
  X509Certificate esdhUser2;
  // private key of esdhUser 2
  PrivateKey esdhUser2_pk;
  
  // key encryption key for KEKRecipientInfo
  SecretKey kek;
  byte[] kekID;

  // secure random number generator
  SecureRandom random;
  
  // the test message
  byte[] test_message;

  /**
   * Setup the demo certificate chains.
   *
   * Keys and certificates are retrieved from the demo KeyStore ("cms.keystore")
   * file which has to be located in your current working directory and may be
   * created by running {@link demo.keystore.SetupCMSKeyStore
   * SetupCMSKeyStore}.
   *
   * @throws IOException if an file read error occurs
   */
  public EnvelopedDataDemoAEAD() throws IOException {
    
    System.out.println();
    System.out.println("*************************************************************************************");
    System.out.println("*                              EnvelopedDataDemoAEAD                                *");
    System.out.println("*  (shows the usage of the CMS EnvelopedData type implementation with AEAD ciphers) *");
    System.out.println("*************************************************************************************");
    System.out.println();
    
    // add all certificates to the list
    X509Certificate[] certs = CMSKeyStore.getCertificateChain(CMSKeyStore.RSA, CMSKeyStore.SZ_2048_CRYPT_1);
    rsaUser1 = certs[0];
    rsaUser1_pk = CMSKeyStore.getPrivateKey(CMSKeyStore.RSA, CMSKeyStore.SZ_2048_CRYPT_1);
    rsaUser2 = CMSKeyStore.getCertificateChain(CMSKeyStore.RSA, CMSKeyStore.SZ_2048_CRYPT_2)[0];
    rsaUser2_pk = CMSKeyStore.getPrivateKey(CMSKeyStore.RSA, CMSKeyStore.SZ_2048_CRYPT_2);
    
    esdhUser1 = CMSKeyStore.getCertificateChain(CMSKeyStore.ESDH, CMSKeyStore.SZ_2048_CRYPT_1)[0];
    esdhUser1_pk = CMSKeyStore.getPrivateKey(CMSKeyStore.ESDH, CMSKeyStore.SZ_2048_CRYPT_1);
    esdhUser2 = CMSKeyStore.getCertificateChain(CMSKeyStore.ESDH, CMSKeyStore.SZ_2048_CRYPT_2)[0];
    esdhUser2_pk = CMSKeyStore.getPrivateKey(CMSKeyStore.ESDH, CMSKeyStore.SZ_2048_CRYPT_2);
    random = SecRandom.getDefault();
    // create a secret key encryption key for a KEKRecipientInfo
    KeyGenerator kg;
    try {
      kg = KeyGenerator.getInstance("AES");
    } catch (NoSuchAlgorithmException ex) {
      throw new IOException("KeyGenerator for AES not avcailable!");   
    }   
    kg.init(random);
    kek = kg.generateKey();
    kekID = new byte[] { 00, 00, 00, 01 };
    
    test_message = "This is the test message.".getBytes();
  }


  /**
   * Creates a CMS <code>EnvelopedDataStream</code> message.
   *
   * @param message the message to be authenticated-enveloped, as byte representation
   * @param contentAuthEncAlg the id of the content-authenticated encryption algorithm
   * 
   * @return the BER encoding of the <code>EnvelopedData</code> object just created
   * 
   * @throws CMSException if the <code>EnvelopedData</code> object cannot
   *                          be created
   * @throws IOException if an I/O error occurs
   */
  public byte[] createEnvelopedDataStream(byte[] message, 
                                              AlgorithmID contentAuthEncAlg)
    throws CMSException, IOException {

    // we are testing the stream interface
    ByteArrayInputStream is = new ByteArrayInputStream(message);
    // create a new EnvelopedData object 
    EnvelopedDataStream enveleopedData;
    try {
      enveleopedData = new EnvelopedDataStream(is, contentAuthEncAlg);
    } catch (NoSuchAlgorithmException e) {
      throw new CMSException(e.getMessage());
    }
    
    // create the recipient infos
    RecipientInfo[] recipients = createRecipients();
    // specify the recipients of the encrypted message
    enveleopedData.setRecipientInfos(recipients);

    // wrap into ContentInfo
    ContentInfoStream contentInfo = new ContentInfoStream(enveleopedData);
    ByteArrayOutputStream os = new ByteArrayOutputStream();
    contentInfo.writeTo(os);
    return os.toByteArray();
  }
  
  /**
   * Uses the <code>EnvelopedDataOutputStream</code> implementation to create an
   * EnvelopedData message.
   *
   * @param message the message to be authenticated-enveloped, as byte representation
   * @param contentAuthEncAlg the id of the content-authenticated encryption algorithm
   * 
   * @return the BER encoding of the <code>EnvelopedData</code> object just created
   * 
   * @throws CMSException if the <code>EnvelopedData</code> object cannot
   *                          be created
   * @throws IOException if an I/O error occurs
   */
  public byte[] createEnvelopedDataOutputStream(byte[] message, 
                                              AlgorithmID contentAuthEncAlg)
    throws CMSException, IOException {

    // a stream from which to read the data to be encrypted
    ByteArrayInputStream is = new ByteArrayInputStream(message);
    
    // the stream to which to write the EnvelopedData
    ByteArrayOutputStream resultStream = new ByteArrayOutputStream();
    EnvelopedDataOutputStream envelopedData;

    //  wrap EnvelopedData into a ContentInfo 
    ContentInfoOutputStream contentInfoStream = 
      new ContentInfoOutputStream(ObjectID.cms_envelopedData, resultStream);
    // create a new EnvelopedData object encrypted with AES
    try {
      envelopedData = new EnvelopedDataOutputStream(contentInfoStream, 
                                                    contentAuthEncAlg);
    } catch (NoSuchAlgorithmException ex) {
      throw new CMSException("No implementation for AES.");
    }
    
    // create the recipient infos
    RecipientInfo[] recipients = createRecipients();
    // specify the recipients of the encrypted message
    envelopedData.setRecipientInfos(recipients);

    int blockSize = 16; // in real world we would use a block size like 2048
    //  write in the data to be encrypted
    byte[] buffer = new byte[blockSize];
    int bytesRead;
    while ((bytesRead = is.read(buffer)) != -1) {
      envelopedData.write(buffer, 0, bytesRead);
    }
    
    // closing the stream finishes encryption and closes the underlying stream
    envelopedData.close();
    return resultStream.toByteArray();
  }
  

  /**
   * Decrypts the encrypted content of the given <code>EnvelopedData</code> object for
   * the recipient identified by its index into the recipientInfos field and verifies
   * the message authentication code.
   * <p>
   * This way of decrypting the content may be used for any type of RecipientInfo
   * (KeyTransRecipientInfo, KeyAgreeRecipientInfo, KEKRecipientInfo), but requires to
   * know at what index of the recipientInfo field the RecipientInfo for the 
   * particular recipient in mind can be found. If the recipient in mind uses
   * a RecipientInfo of type KeyAgreeRecipientInfo some processing overhead may
   * take place because a KeyAgreeRecipientInfo may contain encrypted content-encryption
   * keys for more than only one recipient; since the recipientInfoIndex only
   * specifies the RecipientInfo but not the encrypted content encryption key 
   * -- if there are more than only one -- repeated decryption runs may be
   * required as long as the decryption process completes successfully.
   *
   * @param encoding the <code>EnvelopedData</code> object as DER encoded byte array
   * @param key the key to decrypt the message
   * @param recipientInfoIndex the index into the <code>RecipientInfo</code> array
   *                        to which the specified key belongs
   *
   * @return the recovered message, as byte array
   * @throws CMSException if the message cannot be recovered or MAC verification fails
   * @throws IOException if a stream read/write error occurs
   */
  public byte[] getEnvelopedDataStream(byte[] encoding, Key key, int recipientInfoIndex)
    throws CMSException, IOException {

    // create the EnvelopedData object from a BER encoded byte array
    ByteArrayInputStream is = new ByteArrayInputStream(encoding);
    EnvelopedDataStream enveleopedData = new EnvelopedDataStream(is);

    System.out.println("Information about the authenticated encrypted data:");
    EncryptedContentInfoStream eci = enveleopedData.getEncryptedContentInfo();
    System.out.println("Content type: "+eci.getContentType().getName());
    System.out.println("Content encryption algorithm: "+eci.getContentEncryptionAlgorithm().getName());

    System.out.println("\nThis message can be decrypted by the owners of the following certificates:");
    RecipientInfo[] recipients = enveleopedData.getRecipientInfos();
    
    // for demonstration purposes we only look one time for all recipients included:
    if (recipientInfoIndex == 0) {
      int k = 0;
      for (int i=0; i<recipients.length; i++) {
        KeyIdentifier[] recipientIDs = recipients[i].getRecipientIdentifiers();
        for (int j = 0; j < recipientIDs.length; j++) {
          System.out.println("Recipient "+(++k)+":");
          System.out.println(recipientIDs[j]);
        }   
      }
    }
    // decrypt the message for the first recipient and verify mac
    try {
      enveleopedData.setupCipher(key, recipientInfoIndex);
      InputStream decrypted = enveleopedData.getInputStream();
      ByteArrayOutputStream os = new ByteArrayOutputStream();
      Util.copyStream(decrypted, os, null);
      byte[] content = os.toByteArray();

      checkDecryptedMessage(content, test_message);
      return content;
    } catch (InvalidKeyException ex) {
      throw new CMSException("Private key error: "+ex.toString());
    } catch (NoSuchAlgorithmException ex) {
      throw new CMSException("Content encryption algorithm not implemented: "+ex.toString());
    }
  }
  
  /**
   * Decrypts the encrypted content of the given <code>EnvelopedData</code> object for
   * the recipient identified by recipient identifier and verifies the message 
   * authentication code.
   * <p>
   * This way of decrypting the content may be used for any type of RecipientInfo
   * (KeyTransRecipientInfo, KeyAgreeRecipientInfo, KEKRecipientInfo). The 
   * recipient in mind is identified by its recipient identifier.
   *
   * @param encoding the <code>EnvelopedData</code> object as BER encoded byte array
   * @param key the key to decrypt the message
   * @param recipientID the recipient identifier uniquely identifying the key of the
   *        recipient
   *
   * @return the recovered message, as byte array
   * @throws CMSException if the message cannot be recovered
   * @throws IOException if a stream read/write error occurs
   */
  public byte[] getEnvelopedDataStream(byte[] encoding, Key key, KeyIdentifier recipientID)
    throws CMSException, IOException {

    // create the EnvelopedData object from a DER encoded byte array
    ByteArrayInputStream is = new ByteArrayInputStream(encoding);
    EnvelopedDataStream enveleopedData = new EnvelopedDataStream(is);

    System.out.println("Information about the encrypted data:");
    EncryptedContentInfoStream eci = enveleopedData.getEncryptedContentInfo();
    System.out.println("Content type: "+eci.getContentType().getName());
    System.out.println("Content encryption algorithm: "+eci.getContentEncryptionAlgorithm().getName());
    
    // get the right RecipientInfo
    System.out.println("\nSearch for RecipientInfo:");
    RecipientInfo recipient = enveleopedData.getRecipientInfo(recipientID);
    if (recipient != null) {
      System.out.println("RecipientInfo: " + recipient);   
    } else {
      throw new CMSException("No recipient with ID: " + recipientID);
    }    
    // decrypt the content encryption key and the content; verify mac
    try {
      System.out.println("Decrypt encrypted content encryption key...");
      SecretKey cek = recipient.decryptKey(key, recipientID);
      System.out.println("Decrypt content with decrypted content encryption key...");
      enveleopedData.setupCipher(cek);
      InputStream decrypted = enveleopedData.getInputStream();
      ByteArrayOutputStream os = new ByteArrayOutputStream();
      Util.copyStream(decrypted, os, null);
      byte[] content = os.toByteArray();
      checkDecryptedMessage(content, test_message);
      return content;
    } catch (InvalidKeyException ex) {
      throw new CMSException("Private key error: "+ex.toString());
    } catch (NoSuchAlgorithmException ex) {
      throw new CMSException("Content encryption algorithm not implemented: "+ex.toString());
    }
  }
  
  /**
   * Decrypts the encrypted content of the given <code>EnvelopedData</code> object for
   * the recipient identified by its recipient certificate or kekID and verifies the message 
   * authentication code.
   * <p>
   * Since recipient certificates only may be used for for RecipientInfos of type
   * KeyTransRecipientInfo or KeyAgreeRecipientInfo, a key id has to be supplied
   * for decrypting the content for a recipient using a KEKRecipientInfo.
   *
   * @param encoding the <code>EnvelopedData</code> object as BER encoded byte array
   * @param key the key to decrypt the message
   * @param recipientCert the certificate of the recipient having a RecipientInfo of
   *                      type KeyTransRecipientInfo or KeyAgreeRecipientInfo
   * @param kekID the kekID identifying the recipient key when using a RecipientInfo
   *              of type KEKRecipientInfo
   *
   * @return the recovered message, as byte array
   * @throws CMSException if the message cannot be recovered
   * @throws IOException if a stream read/write error occurs
   */
  public byte[] getEnvelopedDataStream(byte[] encoding, Key key, X509Certificate recipientCert, byte[] kekID)
    throws CMSException, IOException {

    // create the EnvelopedData object from a BER encoded byte array
    ByteArrayInputStream is = new ByteArrayInputStream(encoding);
    EnvelopedDataStream enveleopedData = new EnvelopedDataStream(is);

    System.out.println("Information about the encrypted data:");
    EncryptedContentInfoStream eci = (EncryptedContentInfoStream)enveleopedData.getEncryptedContentInfo();
    System.out.println("Content type: "+eci.getContentType().getName());
    System.out.println("Content encryption algorithm: "+eci.getContentEncryptionAlgorithm().getName());
    
    // decrypt the content encryption key and the content; verify mac
    try {
      System.out.println("Decrypt the content...");
      if (recipientCert != null) {
        enveleopedData.setupCipher(key, recipientCert);
      } else {
        // KEKRecipientInfo
        enveleopedData.setupCipher(key, new KEKIdentifier(kekID));
      }  
      InputStream decrypted = enveleopedData.getInputStream();
      ByteArrayOutputStream os = new ByteArrayOutputStream();
      Util.copyStream(decrypted, os, null);
      byte[] content = os.toByteArray();
      checkDecryptedMessage(content, test_message);
      return content;
    } catch (InvalidKeyException ex) {
      throw new CMSException("Private key error: "+ex.toString());
    } catch (NoSuchAlgorithmException ex) {
      throw new CMSException("Content encryption algorithm not implemented: "+ex.toString());
    } 
  }


  // non stream

  /**
   * Creates a CMS <code>EnvelopedData</code> message.
   * 
   * @param message the message to be enveloped, as byte representation
   * @param contentAuthEncAlg the id of the content-authenticated encryption algorithm
   *
   * 
   * @return the encoded <code>EnvelopedData</code>, as byte array
   * 
   * @throws CMSException if the <code>EnvelopedData</code> object cannot
   *                          be created
   */
  public byte[] createEnvelopedData(byte[] message, AlgorithmID contentAuthEncAlg)
    throws CMSException {
    
    EnvelopedData enveleopedData;

    // create a new EnvelopedData object
    try {
      enveleopedData = new EnvelopedData(message, contentAuthEncAlg);
    } catch (NoSuchAlgorithmException e) {
      throw new CMSException(e.getMessage());
    }
 
    // set the RecipientInfos
    RecipientInfo[] recipients = createRecipients();
    enveleopedData.setRecipientInfos(recipients);

    // wrap into ContentInfo
    ContentInfo contentInfo = new ContentInfo(enveleopedData);
    // return encoded EnvelopedData
    return contentInfo.getEncoded();
  }


  /**
   * Decrypts the encrypted content of the given <code>EnvelopedData</code> object for
   * the recipient identified by its index into the recipientInfos field and verifies
   * the message authentication code.
   * <p>
   * This way of decrypting the content may be used for any type of RecipientInfo
   * (KeyTransRecipientInfo, KeyAgreeRecipientInfo, KEKRecipientInfo), but requires to
   * know at what index of the recipientInfo field the RecipientInfo for the 
   * particular recipient in mind can be found. If the recipient in mind uses
   * a RecipientInfo of type KeyAgreeRecipientInfo some processing overhead may
   * take place because a KeyAgreeRecipientInfo may contain encrypted content-encryption
   * keys for more than only one recipient; since the recipientInfoIndex only
   * specifies the RecipientInfo but not the encrypted content encryption key 
   * -- if there are more than only one -- repeated decryption runs may be
   * required as long as the decryption process completes successfully.
   *
   * @param enc the encoded <code>EnvelopedData</code>
   * 
   * @param key the key to decrypt the message
   * 
   * @param recipientInfoIndex the index into the <code>RecipientInfo</code> array
   *                    to which the specified key belongs
   *
   * @return the recovered message, as byte array
   * 
   * @throws CMSException if the message cannot be recovered
   * @throws IOException if an I/O error occurs
   */
  public byte[] getEnvelopedData(byte[] enc, Key key, int recipientInfoIndex) 
    throws CMSException, IOException {
    ByteArrayInputStream bais = new ByteArrayInputStream(enc);
    EnvelopedData enveleopedData = new EnvelopedData(bais);

    System.out.println("Information about the encrypted data:");
    EncryptedContentInfo eci = (EncryptedContentInfo)enveleopedData.getEncryptedContentInfo();
    System.out.println("Content type: "+eci.getContentType().getName());
    System.out.println("Content encryption algorithm: "+eci.getContentEncryptionAlgorithm().getName());

    System.out.println("\nThis message can be decrypted by the owners of the following certificates:");
    RecipientInfo[] recipients = enveleopedData.getRecipientInfos();
    
    // for demonstration purposes we only look one time for all recipients included:
    if (recipientInfoIndex == 0) {
      int k = 0;
      for (int i=0; i<recipients.length; i++) {
        KeyIdentifier[] recipientIDs = recipients[i].getRecipientIdentifiers();
        for (int j = 0; j < recipientIDs.length; j++) {
          System.out.println("Recipient "+(++k)+":");
          System.out.println(recipientIDs[j]);
        }   
      }
    }
    
    // decrypt the message and verify the mac
    try {
      enveleopedData.setupCipher(key, recipientInfoIndex);
      byte[] content = enveleopedData.getContent();
      checkDecryptedMessage(content, test_message);
      return content;
    } catch (InvalidKeyException ex) {
      throw new CMSException("Private key error: "+ex.toString());
    } catch (NoSuchAlgorithmException ex) {
      throw new CMSException("Content encryption algorithm not implemented: "+ex.toString());
    } 
  } 
  /**
   * Decrypts the encrypted content of the given <code>EnvelopedData</code> object for
   * the recipient identified by recipient identifier.
   * <p>
   * This way of decrypting the content may be used for any type of RecipientInfo
   * (KeyTransRecipientInfo, KeyAgreeRecipientInfo, KEKRecipientInfo). The 
   * recipient in mind is identified by its recipient identifier.
   *
   * @param enc the BER encoded <code>EnvelopedData</code> ASN.1 object
   * @param key the key to decrypt the message
   * @param recipientID the recipient identifier uniquely identifying the key of the
   *        recipient
   *
   * @return the recovered message, as byte array
   * @throws CMSException if the message cannot be recovered
   * @throws IOException if an I/O error occurs
   */
  public byte[] getEnvelopedData(byte[] enc, Key key, KeyIdentifier recipientID) 
    throws CMSException, IOException {
    ByteArrayInputStream bais = new ByteArrayInputStream(enc);
    EnvelopedData enveleopedData = new EnvelopedData(bais);

    System.out.println("Information about the encrypted data:");
    EncryptedContentInfo eci = (EncryptedContentInfo)enveleopedData.getEncryptedContentInfo();
    System.out.println("Content type: "+eci.getContentType().getName());
    System.out.println("Content encryption algorithm: "+eci.getContentEncryptionAlgorithm().getName());

    // get the right RecipientInfo
    System.out.println("\nSearch for RecipientInfo:");
    RecipientInfo recipient = enveleopedData.getRecipientInfo(recipientID);
    if (recipient != null) {
      System.out.println("RecipientInfo: " + recipient);   
    } else {
      throw new CMSException("No recipient with ID: " + recipientID);
    }    
    // decrypt the content encryption key and the content
    try {
      System.out.println("Decrypt encrypted content encryption key...");
      SecretKey cek = recipient.decryptKey(key, recipientID);
      System.out.println("Decrypt content with decrypted content encryption key...");
      // decrypt content and verify mac      
      enveleopedData.setupCipher(cek);
      byte[] content = enveleopedData.getContent();
      checkDecryptedMessage(content, test_message);
      return content;
    } catch (InvalidKeyException ex) {
      throw new CMSException("Private key error: "+ex.toString());
    } catch (NoSuchAlgorithmException ex) {
      throw new CMSException("Content encryption algorithm not implemented: "+ex.toString());
    } 
  }
  
  /**
   * Decrypts the encrypted content of the given <code>EnvelopedData</code> object for
   * the recipient identified by its recipient certificate or keyID.
   * <p>
   * Since recipient certificates only may be used for for RecipientInfos of type
   * KeyTransRecipientInfo or KeyAgreeRecipientInfo, a key id has to be supplied
   * for decrypting the content for a recipient using a KEKRecipientInfo.
   *
   * @param enc the BER encoded <code>EnvelopedData</code> ASN.1 object
   * @param key the key to decrypt the message
   * @param recipientCert the certificate of the recipient having a RecipientInfo of
   *                      type KeyTransRecipientInfo or KeyAgreeRecipientInfo
   * @param kekID the kekID identifying the recipient key when using a RecipientInfo
   *              of type KEKRecipientInfo
   *
   * @return the recovered message, as byte array
   * @throws CMSException if the message cannot be recovered
   */
  public byte[] getEnvelopedData(byte[] enc, Key key, X509Certificate recipientCert, byte[] kekID) 
    throws CMSException, IOException {
    ByteArrayInputStream bais = new ByteArrayInputStream(enc);
    EnvelopedData enveleopedData = new EnvelopedData(bais);

    System.out.println("Information about the encrypted data:");
    EncryptedContentInfo eci = (EncryptedContentInfo)enveleopedData.getEncryptedContentInfo();
    System.out.println("Content type: "+eci.getContentType().getName());
    System.out.println("Content encryption algorithm: "+eci.getContentEncryptionAlgorithm().getName());

    // decrypt the content encryption key and the content
    try {
      System.out.println("Decrypt the content and verify mac...");
      // decrypt content and verify mac
      if (recipientCert != null) {
        enveleopedData.setupCipher(key, recipientCert);
      } else {
        // KEKRecipientInfo
        enveleopedData.setupCipher(key, new KEKIdentifier(kekID));
      }
      byte[] content = enveleopedData.getContent();
      checkDecryptedMessage(content, test_message);
      return content;
    } catch (InvalidKeyException ex) {
      throw new CMSException("Private key error: "+ex.toString());
    } catch (NoSuchAlgorithmException ex) {
      throw new CMSException("Content encryption algorithm not implemented: "+ex.toString());
    } 

  }
  
  /**
   * Creates the RecipientInfos.
   *
   * @return the RecipientInfos created, two KeyTransRecipientInfos, one
   *         KeyAgreeRecipientInfo (for two recipients with same domain
   *         parameters), and one KEKRecipientInfo
   *
   * @throws CMSException if an error occurs when creating the recipient infos
   */
  public RecipientInfo[] createRecipients() throws CMSException {
    
    RecipientInfo[] recipients = new RecipientInfo[4];
    try {
      // rsaUser1 is the first receiver (cert identified by IssuerAndSerialNumber)
      recipients[0] = new KeyTransRecipientInfo(rsaUser1, 
                                                (AlgorithmID)AlgorithmID.rsaEncryption.clone());
      // rsaUser2 is the second receiver (cert identifief by SubjectKeyIdentifier)
      recipients[1] = new KeyTransRecipientInfo(rsaUser2, 
                                                CertificateIdentifier.SUBJECT_KEY_IDENTIFIER, 
                                                (AlgorithmID)AlgorithmID.rsaEncryption.clone());

      // next recipients use key agreement
      // the key encryption (key agreement) algorithm to use:
      AlgorithmID keyEA = (AlgorithmID)AlgorithmID.esdhKeyAgreement.clone();
      // the key wrap algorithm to use:
      AlgorithmID keyWrapAlg = (AlgorithmID)AlgorithmID.cms_aes256_wrap.clone();
      // the length of the key encryption key to be generated:
      int kekLength = 256;
      recipients[2] = new KeyAgreeRecipientInfo(keyEA, keyWrapAlg, kekLength);
      // esdhUser1 is the third receiver  (cert identified by IssuerAndSerialNumber)
      ((KeyAgreeRecipientInfo)recipients[2]).addRecipient(esdhUser1, CertificateIdentifier.ISSUER_AND_SERIALNUMBER);
      // esdhUser2 is the fourth receiver (cert identified by RecipientKeyIdentifier)
      ((KeyAgreeRecipientInfo)recipients[2]).addRecipient(esdhUser2, CertificateIdentifier.RECIPIENT_KEY_IDENTIFIER);
      
      // last receiver uses a symmetric key encryption key  
      AlgorithmID kea = (AlgorithmID)AlgorithmID.cms_aes256_wrap.clone();
      KEKIdentifier kekIdentifier = new KEKIdentifier(kekID);
      recipients[3] = new KEKRecipientInfo(kekIdentifier, kea, kek);
    } catch (Exception ex) {
      throw new CMSException("Error adding recipients: " + ex.getMessage()); 
    }    
    return recipients;
  }  
  
  /**
   * Parses an EnvelopedData and decrypts the content for all test recipients
   * using the index into the recipientInfos field for identifying the recipient.
   *
   * @param stream whether to use EnvelopedDataStream or EnvelopedData
   * @param encodedEnvelopedData the encoded EnvelopedData object 
   *
   * @throws Exception if some error occurs during decoding/decryption
   */ 
  public void parseEnvelopedDataWithRecipientInfoIndex(boolean stream, byte[] encodedEnvelopedData) throws Exception {
    byte[] receivedMessage;
    if (stream) {
      // rsaUser1
      System.out.println("\nDecrypt for rsaUser1:");
      receivedMessage = getEnvelopedDataStream(encodedEnvelopedData, rsaUser1_pk, 0);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // rsaUser2
      System.out.println("\nDecrypt for rsaUser2:");
      receivedMessage = getEnvelopedDataStream(encodedEnvelopedData, rsaUser2_pk, 1);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // esdhUser1
      System.out.println("\nDecrypt for esdhUser1:");
      receivedMessage = getEnvelopedDataStream(encodedEnvelopedData, esdhUser1_pk, 2);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // esdhUser2
      System.out.println("\nDecrypt for esdhUser2:");
      receivedMessage = getEnvelopedDataStream(encodedEnvelopedData, esdhUser2_pk, 2);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // kekUser
      System.out.println("\nDecrypt for kekUser:");
      receivedMessage = getEnvelopedDataStream(encodedEnvelopedData, kek, 3);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
    } else {
      // rsaUser1
      System.out.println("\nDecrypt for rsaUser1:");
      receivedMessage = getEnvelopedData(encodedEnvelopedData, rsaUser1_pk, 0);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
       // rsaUser2
      System.out.println("\nDecrypt for rsaUser2:");
      receivedMessage = getEnvelopedData(encodedEnvelopedData, rsaUser2_pk, 1);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // esdhUser1
      System.out.println("\nDecrypt for esdhUser1:");
      receivedMessage = getEnvelopedData(encodedEnvelopedData, esdhUser1_pk, 2);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // esdhUser2
      System.out.println("\nDecrypt for esdhUser2:");
      receivedMessage = getEnvelopedData(encodedEnvelopedData, esdhUser2_pk, 2);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // kekUser
      System.out.println("\nDecrypt for kekUser:");
      receivedMessage = getEnvelopedData(encodedEnvelopedData, kek, 3);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
    }    
  }
  
  /**
   * Parses an EnvelopedData and decrypts the content for all test recipients
   * using their recipient identifiers for identifying the recipient.
   *
   * @param stream whether to use EnvelopedDataStream or EnvelopedData
   * @param encodedEnvelopedData the encoded EnvelopedData object 
   *
   * @throws Exception if some error occurs during decoding/decryption
   */ 
  public void parseEnvelopedDataWithRecipientIdentifier(boolean stream, byte[] encodedEnvelopedData) throws Exception {
    byte[] receivedMessage;
    if (stream) {
      // rsaUser1
      System.out.println("\nDecrypt for rsaUser1:");
      receivedMessage = getEnvelopedDataStream(encodedEnvelopedData, rsaUser1_pk, new IssuerAndSerialNumber(rsaUser1));
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // rsaUser2
      System.out.println("\nDecrypt for rsaUser2:");
      receivedMessage = getEnvelopedDataStream(encodedEnvelopedData, rsaUser2_pk, new SubjectKeyID(rsaUser2));
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // esdhUser1
      System.out.println("\nDecrypt for esdhUser1:");
      receivedMessage = getEnvelopedDataStream(encodedEnvelopedData, esdhUser1_pk, new IssuerAndSerialNumber(esdhUser1));
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // esdhUser2
      System.out.println("\nDecrypt for esdhUser2:");
      receivedMessage = getEnvelopedDataStream(encodedEnvelopedData, esdhUser2_pk, new RecipientKeyIdentifier(esdhUser2));
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // kekUser
      System.out.println("\nDecrypt for kekUser:");
      receivedMessage = getEnvelopedDataStream(encodedEnvelopedData, kek, new KEKIdentifier(kekID));
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
    } else {
      // rsaUser1
      System.out.println("\nDecrypt for rsaUser1:");
      receivedMessage = getEnvelopedData(encodedEnvelopedData, rsaUser1_pk, new IssuerAndSerialNumber(rsaUser1));
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
       // rsaUser2
      System.out.println("\nDecrypt for rsaUser2:");
      receivedMessage = getEnvelopedData(encodedEnvelopedData, rsaUser2_pk, new SubjectKeyID(rsaUser2));
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // esdhUser1
      System.out.println("\nDecrypt for esdhUser1:");
      receivedMessage = getEnvelopedData(encodedEnvelopedData, esdhUser1_pk, new IssuerAndSerialNumber(esdhUser1));
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // esdhUser2
      System.out.println("\nDecrypt for esdhUser2:");
      receivedMessage = getEnvelopedData(encodedEnvelopedData, esdhUser2_pk, new RecipientKeyIdentifier(esdhUser2));
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // kekUser
      System.out.println("\nDecrypt for kekUser:");
      receivedMessage = getEnvelopedData(encodedEnvelopedData, kek, new KEKIdentifier(kekID));
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
    }    
  }
  
  /**
   * Parses an EnvelopedData and decrypts the content for all test recipients
   * using their recipient certificate (for RecipientInfos of type KeyTransRecipientInfo
   * or KeyAgreeRecipientInfo) or key id (for RecipientInfos of type KEKRecipientInfo)
   * for identifying the recipient.
   *
   * @param stream whether to use EnvelopedDataStream or EnvelopedData
   * @param encodedEnvelopedData the encoded EnvelopedData object 
   *
   * @throws Exception if some error occurs during decoding/decryption
   */ 
  public void parseEnvelopedDataWithRecipientCertOrKEKId(boolean stream, byte[] encodedEnvelopedData) throws Exception {
    byte[] receivedMessage;
    if (stream) {
      // rsaUser1
      System.out.println("\nDecrypt for rsaUser1:");
      receivedMessage = getEnvelopedDataStream(encodedEnvelopedData, rsaUser1_pk, rsaUser1, null);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // rsaUser2
      System.out.println("\nDecrypt for rsaUser2:");
      receivedMessage = getEnvelopedDataStream(encodedEnvelopedData, rsaUser2_pk, rsaUser2, null);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // esdhUser1
      System.out.println("\nDecrypt for esdhUser1:");
      receivedMessage = getEnvelopedDataStream(encodedEnvelopedData, esdhUser1_pk, esdhUser1, null);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // esdhUser2
      System.out.println("\nDecrypt for esdhUser2:");
      receivedMessage = getEnvelopedDataStream(encodedEnvelopedData, esdhUser2_pk, esdhUser2, null);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // kekUser
      System.out.println("\nDecrypt for kekUser:");
      receivedMessage = getEnvelopedDataStream(encodedEnvelopedData, kek, null, kekID);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
    } else {
      // rsaUser1
      System.out.println("\nDecrypt for rsaUser1:");
      receivedMessage = getEnvelopedData(encodedEnvelopedData, rsaUser1_pk, rsaUser1, null);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
       // rsaUser2
      System.out.println("\nDecrypt for rsaUser2:");
      receivedMessage = getEnvelopedData(encodedEnvelopedData, rsaUser2_pk, rsaUser2, null);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // esdhUser1
      System.out.println("\nDecrypt for esdhUser1:");
      receivedMessage = getEnvelopedData(encodedEnvelopedData, esdhUser1_pk, esdhUser1, null);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // esdhUser2
      System.out.println("\nDecrypt for esdhUser2:");
      receivedMessage = getEnvelopedData(encodedEnvelopedData, esdhUser2_pk, esdhUser2, null);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
      // kekUser
      System.out.println("\nDecrypt for kekUser:");
      receivedMessage = getEnvelopedData(encodedEnvelopedData, kek, null, kekID);
      System.out.print("\nDecrypted content: ");
      System.out.println(new String(receivedMessage));
    }    
  }
  
  /**
   * Checks the decrypted message.
   * 
   * @param decryptedMessage the decrypted message
   * @param testMessage the original message
   * 
   * @throws CMSException if decrypted and original message do not match
   */
  private void checkDecryptedMessage(byte[] decryptedMessage, byte[] testMessage) throws CMSException {
    if (CryptoUtils.equalsBlock(decryptedMessage, testMessage) == false) {
      throw new CMSException("Decrypted content not equal to original one!");
    }
  }
  
  /**
   * Starts the test.
   */
  public void start() {
   
    // AES-GCM
    AlgorithmID contentAuthEncAlg = (AlgorithmID)AlgorithmID.aes256_GCM.clone();
    start(contentAuthEncAlg);
    
    // AES-CCM
    contentAuthEncAlg = (AlgorithmID)AlgorithmID.aes256_CCM.clone();
    start(contentAuthEncAlg);
    
    // ChaCha20Poly1305
    contentAuthEncAlg = (AlgorithmID)AlgorithmID.chacha20Poly1305.clone();
    start(contentAuthEncAlg);
  }
  
  /**
   * Starts the test for the given content-authenticated encryption algorithm.
   * 
   * @param contentAuthEncAlg the id of the content-authenticated encryption algorithm
   */
  public void start(AlgorithmID contentAuthEncAlg) {
     // the test message
    byte[] message = test_message;

    try {
      byte[] encodedEnvelopedData;
      
      // the stream implementation
      System.out.println("Stream implementation demos");
      System.out.println("===========================");

      //
      // test CMS EnvelopedDataStream
      //
      System.out.println("\nCMS EnvelopedDataStream demo [create]:\n");
      encodedEnvelopedData = createEnvelopedDataStream(message, (AlgorithmID)contentAuthEncAlg.clone());
      // transmit data
      System.out.println("\nCMS EnvelopedDataStream demo [parse]:\n");
      System.out.println("Decrypt for the several recipients using their index into the recipientInfos field.");
      parseEnvelopedDataWithRecipientInfoIndex(true, encodedEnvelopedData);
      System.out.println("Decrypt for the several recipients using their RecipientIdentifier.");
      parseEnvelopedDataWithRecipientIdentifier(true, encodedEnvelopedData);
      System.out.println("Decrypt for the several recipients using their certificate or symmetric kek.");
      parseEnvelopedDataWithRecipientCertOrKEKId(true, encodedEnvelopedData);
      
      // the output stream implementation
      System.out.println("Output Stream implementation demos");
      System.out.println("==================================");

      //
      // test CMS EnvelopedDataOutputStream
      //
      System.out.println("\nCMS EnvelopedDataOutputStream demo [create]:\n");
      encodedEnvelopedData = createEnvelopedDataOutputStream(message, (AlgorithmID)contentAuthEncAlg.clone());
      // transmit data
      System.out.println("\nCMS EnvelopedDataOutputStream demo [parse]:\n");
      System.out.println("Decrypt for the several recipients using their index into the recipientInfos field.");
      parseEnvelopedDataWithRecipientInfoIndex(true, encodedEnvelopedData);
      System.out.println("Decrypt for the several recipients using their RecipientIdentifier.");
      parseEnvelopedDataWithRecipientIdentifier(true, encodedEnvelopedData);
      System.out.println("Decrypt for the several recipients using their certificate or symmetric kek.");
      parseEnvelopedDataWithRecipientCertOrKEKId(true, encodedEnvelopedData);


      // the non-stream implementation
      System.out.println("\nNon-stream implementation demos");
      System.out.println("===============================");

            
      //
      // test CMS EnvelopedData
      //
      System.out.println("\nCMS EnvelopedData demo [create]:\n");
      encodedEnvelopedData = createEnvelopedData(message, (AlgorithmID)contentAuthEncAlg.clone());
      // transmit data
      System.out.println("\nCMS EnvelopedData demo [parse]:\n");
      System.out.println("Decrypt for the several recipients using their index into the recipientInfos field.");
      parseEnvelopedDataWithRecipientInfoIndex(false, encodedEnvelopedData);
      System.out.println("Decrypt for the several recipients using their RecipientIdentifier.");
      parseEnvelopedDataWithRecipientIdentifier(false, encodedEnvelopedData);
      System.out.println("Decrypt for the several recipients using their certificate or symmetric kek.");
      parseEnvelopedDataWithRecipientCertOrKEKId(false, encodedEnvelopedData);
      

        } catch (Exception ex) {
          ex.printStackTrace();
          throw new RuntimeException(ex.toString());
        }
  }
  
  /**
   * Main method.
   *
   * @throws IOException
   *            if an I/O error occurs when reading required keys
   *            and certificates from files
   */
  public static void main(String argv[]) throws Exception {

        DemoUtil.initDemos();

    (new EnvelopedDataDemoAEAD()).start();
    System.out.println("\nReady!");
    DemoUtil.waitKey();
  }
}