nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/test/java/org/apache/nifi/security/util/crypto/OpenPGPKeyBasedEncryptorTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.nifi.security.util.crypto;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.security.Security;
import org.apache.commons.codec.binary.Hex;
import org.apache.commons.lang3.SystemUtils;
import org.apache.nifi.processor.io.StreamCallback;
import org.apache.nifi.security.util.EncryptionMethod;
import org.bouncycastle.jce.provider.BouncyCastleProvider;
import org.bouncycastle.openpgp.PGPEncryptedData;
import org.bouncycastle.openpgp.PGPUtil;
import org.junit.After;
import org.junit.Assert;
import org.junit.Assume;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class OpenPGPKeyBasedEncryptorTest {
    private static final Logger logger = LoggerFactory.getLogger(OpenPGPKeyBasedEncryptorTest.class);

    private final File plainFile = new File("src/test/resources/TestEncryptContent/text.txt");
    private final File unsignedFile = new File("src/test/resources/TestEncryptContent/text.txt.unsigned.gpg");
    private final File encryptedFile = new File("src/test/resources/TestEncryptContent/text.txt.gpg");

    private static final String SECRET_KEYRING_PATH = "src/test/resources/TestEncryptContent/secring.gpg";
    private static final String PUBLIC_KEYRING_PATH = "src/test/resources/TestEncryptContent/pubring.gpg";
    private static final String USER_ID = "NiFi PGP Test Key (Short test key for NiFi PGP unit tests) <alopresto.apache+test@gmail.com>";

    private static final String PASSWORD = "thisIsABadPassword";

    @BeforeClass
    public static void setUpOnce() throws Exception {
        Assume.assumeTrue("Test only runs on *nix", !SystemUtils.IS_OS_WINDOWS);
        Security.addProvider(new BouncyCastleProvider());
    }

    @Before
    public void setUp() throws Exception {

    }

    @After
    public void tearDown() throws Exception {

    }

    @Test
    public void testShouldEncryptAndDecrypt() throws Exception {
        for (int i = 1; i < 14; i++) {
            if (PGPEncryptedData.SAFER != i) { // SAFER cipher is not supported and therefore its test is skipped
                Integer cipher = i;
                logger.info("Testing PGP encryption with " + PGPUtil.getSymmetricCipherName(cipher) + " cipher.");
                // Arrange
                final String PLAINTEXT = "This is a plaintext message.";
                logger.info("Plaintext: {}", PLAINTEXT);
                InputStream plainStream = new ByteArrayInputStream(PLAINTEXT.getBytes("UTF-8"));
                OutputStream cipherStream = new ByteArrayOutputStream();
                OutputStream recoveredStream = new ByteArrayOutputStream();

                // No file, just streams
                String filename = "tempFile.txt";


                // Encryptor does not require password
                OpenPGPKeyBasedEncryptor encryptor = new OpenPGPKeyBasedEncryptor(
                        EncryptionMethod.PGP.getAlgorithm(), cipher, EncryptionMethod.PGP.getProvider(), PUBLIC_KEYRING_PATH, USER_ID, new char[0], filename);
                StreamCallback encryptionCallback = encryptor.getEncryptionCallback();

                OpenPGPKeyBasedEncryptor decryptor = new OpenPGPKeyBasedEncryptor(
                        EncryptionMethod.PGP.getAlgorithm(), cipher, EncryptionMethod.PGP.getProvider(), SECRET_KEYRING_PATH, USER_ID, PASSWORD.toCharArray(), filename);
                StreamCallback decryptionCallback = decryptor.getDecryptionCallback();

                // Act
                encryptionCallback.process(plainStream, cipherStream);

                final byte[] cipherBytes = ((ByteArrayOutputStream) cipherStream).toByteArray();
                logger.info("Encrypted: {}", Hex.encodeHexString(cipherBytes));
                InputStream cipherInputStream = new ByteArrayInputStream(cipherBytes);

                decryptionCallback.process(cipherInputStream, recoveredStream);

                // Assert
                byte[] recoveredBytes = ((ByteArrayOutputStream) recoveredStream).toByteArray();
                String recovered = new String(recoveredBytes, "UTF-8");
                logger.info("Recovered: {}", recovered);
                assert PLAINTEXT.equals(recovered);
            }
        }
    }

    @Test
    public void testShouldDecryptExternalFile() throws Exception {
        for (int i = 1; i<14; i++) {
            if (PGPEncryptedData.SAFER != i) { // SAFER cipher is not supported and therefore its test is skipped
                Integer cipher = i;
                // Arrange
                byte[] plainBytes = Files.readAllBytes(Paths.get(plainFile.getPath()));
                final String PLAINTEXT = new String(plainBytes, "UTF-8");

                InputStream cipherStream = new FileInputStream(unsignedFile);
                OutputStream recoveredStream = new ByteArrayOutputStream();

                // No file, just streams
                String filename = unsignedFile.getName();

                OpenPGPKeyBasedEncryptor encryptor = new OpenPGPKeyBasedEncryptor(
                        EncryptionMethod.PGP.getAlgorithm(), cipher, EncryptionMethod.PGP.getProvider(), SECRET_KEYRING_PATH, USER_ID, PASSWORD.toCharArray(), filename);

                StreamCallback decryptionCallback = encryptor.getDecryptionCallback();

                // Act
                decryptionCallback.process(cipherStream, recoveredStream);

                // Assert
                byte[] recoveredBytes = ((ByteArrayOutputStream) recoveredStream).toByteArray();
                String recovered = new String(recoveredBytes, "UTF-8");
                logger.info("Recovered: {}", recovered);
                Assert.assertEquals("Recovered text", PLAINTEXT, recovered);
            }
        }
    }
}