#268: Resolve all input streams immediately, don't keep references or reuse anymore.

Author: bbottema

modules/core-module/src/main/java/org/simplejavamail/api/email/Email.java

@@ -144,14 +144,10 @@ public class Email implements Serializable {
 
 	/**
 	 * @see EmailPopulatingBuilder#signWithDomainKey(InputStream, String, String)
-	 */
-	// mime message is not serializable, so transient
-	private final transient InputStream dkimPrivateKeyInputStream;
-	
-	/**
+	 * @see EmailPopulatingBuilder#signWithDomainKey(byte[], String, String)
 	 * @see EmailPopulatingBuilder#signWithDomainKey(File, String, String)
 	 */
-	private final File dkimPrivateKeyFile; // supported separately, so we don't have to do resource management ourselves for the InputStream
+	private final byte[] dkimPrivateKeyData;
 
 	/**
 	 * @see EmailPopulatingBuilder#signWithDomainKey(InputStream, String, String)
@@ -271,19 +267,12 @@ public Email(@NotNull final EmailPopulatingBuilder builder) {
 			returnReceiptTo = builder.getReturnReceiptTo();
 		}
 
-		if (builder.getDkimPrivateKeyFile() != null) {
-			this.dkimPrivateKeyInputStream = null;
-			this.dkimPrivateKeyFile = builder.getDkimPrivateKeyFile();
-			this.dkimSigningDomain = builder.getDkimSigningDomain();
-			this.dkimSelector = builder.getDkimSelector();
-		} else if (builder.getDkimPrivateKeyInputStream() != null) {
-			this.dkimPrivateKeyFile = null;
-			this.dkimPrivateKeyInputStream = builder.getDkimPrivateKeyInputStream();
+		if (builder.getDkimPrivateKeyData() != null) {
+			this.dkimPrivateKeyData = builder.getDkimPrivateKeyData();
 			this.dkimSigningDomain = builder.getDkimSigningDomain();
 			this.dkimSelector = builder.getDkimSelector();
 		} else {
-			this.dkimPrivateKeyFile = null;
-			this.dkimPrivateKeyInputStream = null;
+			this.dkimPrivateKeyData = null;
 			this.dkimSigningDomain = null;
 			this.dkimSelector = null;
 		}
@@ -552,16 +541,8 @@ public Map<String, String> getHeaders() {
 	 * @see EmailPopulatingBuilder#signWithDomainKey(InputStream, String, String)
 	 */
 	@Nullable
-	public InputStream getDkimPrivateKeyInputStream() {
-		return dkimPrivateKeyInputStream;
-	}
-	
-	/**
-	 * @see EmailPopulatingBuilder#signWithDomainKey(File, String, String)
-	 */
-	@Nullable
-	public File getDkimPrivateKeyFile() {
-		return dkimPrivateKeyFile;
+	public byte[] getDkimPrivateKeyData() {
+		return dkimPrivateKeyData;
 	}
 
 	/**

modules/core-module/src/main/java/org/simplejavamail/api/email/EmailPopulatingBuilder.java

@@ -1113,8 +1113,7 @@ public interface EmailPopulatingBuilder {
 	 * @see #signWithDomainKey(String, String, String)
 	 * @see #signWithDomainKey(File, String, String)
 	 */
-	EmailPopulatingBuilder signWithDomainKey(@NotNull InputStream dkimPrivateKeyInputStream, @NotNull String signingDomain,
-											 @NotNull String dkimSelector);
+	EmailPopulatingBuilder signWithDomainKey(@NotNull InputStream dkimPrivateKeyInputStream, @NotNull String signingDomain, @NotNull String dkimSelector);
 
 	/**
 	 * As {@link #signWithDomainKey(InputStream, String, String)}, but with a File reference that is later read as {@code InputStream}.
@@ -1148,18 +1147,26 @@ EmailPopulatingBuilder signWithDomainKey(@NotNull InputStream dkimPrivateKeyInpu
 	 */
 	EmailPopulatingBuilder signWithSmime(@NotNull File pkcs12StoreFile, @NotNull String storePassword, @NotNull String keyAlias, @NotNull String keyPassword);
 
+	/**
+	 * Delegates to {@link #signWithSmime(byte[], String, String, String)}.
+	 * <p>
+	 * <strong>Note:</strong> this only works in combination with the {@value org.simplejavamail.internal.modules.SMIMEModule#NAME}.
+	 */
+	@Cli.ExcludeApi(reason = "Is duplicate API from CLI point of view")
+	EmailPopulatingBuilder signWithSmime(@NotNull InputStream pkcs12StoreStream, @NotNull String storePassword, @NotNull String keyAlias, @NotNull String keyPassword);
+
 	/**
 	 * Delegates to {@link #signWithSmime(Pkcs12Config)}.
 	 * <p>
 	 * <strong>Note:</strong> this only works in combination with the {@value org.simplejavamail.internal.modules.SMIMEModule#NAME}.
 	 *
-	 * @param pkcs12StoreStream The key store file to use to find the indicated key
+	 * @param pkcs12StoreData The key store file to use to find the indicated key
 	 * @param storePassword The store's password
 	 * @param keyAlias The name of the certificate in the key store to use
 	 * @param keyPassword The password of the certificate
 	 */
 	@Cli.ExcludeApi(reason = "Is duplicate API from CLI point of view")
-	EmailPopulatingBuilder signWithSmime(@NotNull InputStream pkcs12StoreStream, @NotNull String storePassword, @NotNull String keyAlias, @NotNull String keyPassword);
+	EmailPopulatingBuilder signWithSmime(@NotNull byte[] pkcs12StoreData, @NotNull String storePassword, @NotNull String keyAlias, @NotNull String keyPassword);
 
 	/**
 	 * Delegates to {@link #encryptWithSmime(X509Certificate)} using the provided PEM file.
@@ -1541,17 +1548,13 @@ EmailPopulatingBuilder signWithDomainKey(@NotNull InputStream dkimPrivateKeyInpu
 	@NotNull
 	Map<String, String> getHeaders();
 
-	/**
-	 * @see #signWithDomainKey(File, String, String)
-	 */
-	@Nullable
-	File getDkimPrivateKeyFile();
-	
 	/**
 	 * @see #signWithDomainKey(InputStream, String, String)
+	 * @see #signWithDomainKey(byte[], String, String)
+	 * @see #signWithDomainKey(File, String, String)
 	 */
 	@Nullable
-	InputStream getDkimPrivateKeyInputStream();
+	byte[] getDkimPrivateKeyData();
 
 	/**
 	 * @see #signWithDomainKey(InputStream, String, String)

modules/core-module/src/main/java/org/simplejavamail/api/mailer/config/Pkcs12Config.java

@@ -3,44 +3,49 @@
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
+import org.simplejavamail.internal.util.MiscUtil;
 
 import java.io.File;
 import java.io.FileInputStream;
-import java.io.FileNotFoundException;
+import java.io.IOException;
 import java.io.InputStream;
 import java.util.Arrays;
 import java.util.Objects;
 
 import static java.lang.String.format;
-import static org.simplejavamail.internal.util.MiscUtil.inputStreamEqual;
+import static org.simplejavamail.internal.util.MiscUtil.readInputStreamToBytes;
 
 /**
  * Config holder for PKCS12 store+key info used for S/MIME encrypting / decrypting.
  */
 // FIXME LOMBOK!!
 public final class Pkcs12Config {
 
-	private static final long serialVersionUID = 1234567L;
-
-	@NotNull private final InputStream pkcs12StoreStream;
+	@NotNull private final byte[] pkcs12StoreData;
 	@NotNull private final char[] storePassword;
 	@NotNull private final String keyAlias;
 	@NotNull private final char[] keyPassword;
 
-	private Pkcs12Config(@NotNull InputStream pkcs12StoreStream, @NotNull char[] storePassword, @NotNull String keyAlias, @NotNull char[] keyPassword) {
-		this.pkcs12StoreStream = pkcs12StoreStream;
+	private Pkcs12Config(@NotNull InputStream pkcs12StoreStream, @NotNull char[] storePassword, @NotNull String keyAlias, @NotNull char[] keyPassword)
+			throws IOException {
+		this(readInputStreamToBytes(pkcs12StoreStream), storePassword, keyAlias, keyPassword);
+	}
+
+	private Pkcs12Config(@NotNull byte[] pkcs12StoreData, @NotNull char[] storePassword, @NotNull String keyAlias, @NotNull char[] keyPassword) {
+		this.pkcs12StoreData = pkcs12StoreData;
 		this.storePassword = storePassword;
 		this.keyAlias = keyAlias;
 		this.keyPassword = keyPassword;
 	}
 
+	@NotNull
 	public static Pkcs12ConfigBuilder builder() {
 		return new Pkcs12ConfigBuilder();
 	}
 
 	@NotNull
-	public InputStream getPkcs12StoreStream() {
-		return this.pkcs12StoreStream;
+	public  byte[] getPkcs12StoreData() {
+		return this.pkcs12StoreData;
 	}
 
 	@NotNull
@@ -61,12 +66,11 @@ public char[] getKeyPassword() {
 	@Override
 	public String toString() {
 		@SuppressWarnings("StringBufferReplaceableByString")
-		final StringBuilder sb = new StringBuilder("Pkcs12Config{");
-		sb.append("pkcs12StoreStream=").append(pkcs12StoreStream);
-		sb.append(", storePassword=***");
-		sb.append(", keyAlias='").append(keyAlias).append('\'');
-		sb.append(", keyPassword=***");
-		sb.append('}');
+		final StringBuilder sb = new StringBuilder("Pkcs12Config{")
+				.append("  storePassword=***")
+				.append(", keyAlias='").append(keyAlias).append('\'')
+				.append(", keyPassword=***")
+				.append('}');
 		return sb.toString();
 	}
 
@@ -79,22 +83,22 @@ public boolean equals(@Nullable final Object o) {
 			return false;
 		}
 		final Pkcs12Config that = (Pkcs12Config) o;
-		return inputStreamEqual(pkcs12StoreStream, that.pkcs12StoreStream) &&
+		return Arrays.equals(pkcs12StoreData, that.pkcs12StoreData) &&
 				Arrays.equals(storePassword, that.storePassword) &&
 				keyAlias.equals(that.keyAlias) &&
 				Arrays.equals(keyPassword, that.keyPassword);
 	}
 
 	@Override
 	public int hashCode() {
-		int result = Objects.hash(pkcs12StoreStream, keyAlias);
+		int result = Objects.hash(pkcs12StoreData, keyAlias);
 		result = 31 * result + Arrays.hashCode(storePassword);
 		result = 31 * result + Arrays.hashCode(keyPassword);
 		return result;
 	}
 
 	public static class Pkcs12ConfigBuilder {
-		private InputStream pkcs12StoreStream;
+		private byte[] pkcs12StoreData;
 		private char[] storePassword;
 		private String keyAlias;
 		private char[] keyPassword;
@@ -113,13 +117,19 @@ public Pkcs12ConfigBuilder pkcs12Store(String pkcs12StorePath) {
 		public Pkcs12ConfigBuilder pkcs12Store(File pkcs12StorePath) {
 			try {
 				return pkcs12Store(new FileInputStream(pkcs12StorePath));
-			} catch (FileNotFoundException e) {
+			} catch (IOException e) {
 				throw new IllegalStateException(format("error reading PKCS12 store from File [%s]", pkcs12StorePath), e);
 			}
 		}
 
-		public Pkcs12ConfigBuilder pkcs12Store(InputStream pkcs12StoreStream) {
-			this.pkcs12StoreStream = pkcs12StoreStream;
+		public Pkcs12ConfigBuilder pkcs12Store(InputStream pkcs12StoreStream)
+				throws IOException {
+			this.pkcs12StoreData = MiscUtil.readInputStreamToBytes(pkcs12StoreStream);
+			return this;
+		}
+
+		public Pkcs12ConfigBuilder pkcs12Store(byte[] pkcs12StoreData) {
+			this.pkcs12StoreData = pkcs12StoreData;
 			return this;
 		}
 
@@ -149,7 +159,7 @@ public Pkcs12ConfigBuilder keyPassword(String keyPassword) {
 		}
 
 		public Pkcs12Config build() {
-			return new Pkcs12Config(pkcs12StoreStream, storePassword, keyAlias, keyPassword);
+			return new Pkcs12Config(pkcs12StoreData, storePassword, keyAlias, keyPassword);
 		}
 	}
 }

modules/core-module/src/main/java/org/simplejavamail/internal/util/MiscUtil.java

@@ -14,10 +14,8 @@
 import javax.mail.internet.MimeUtility;
 import javax.mail.util.ByteArrayDataSource;
 import java.io.BufferedInputStream;
-import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.File;
-import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.UnsupportedEncodingException;
@@ -231,47 +229,6 @@ public static String readFileContent(@NotNull final File file) throws IOExceptio
 		return new String(Files.readAllBytes(file.toPath()), UTF_8);
 	}
 
-	public static boolean inputStreamEqual(InputStream inputOrg1, InputStream inputOrg2) {
-		ByteArrayInputStream input1 = copyInputstream(inputOrg1);
-		ByteArrayInputStream input2 = copyInputstream(inputOrg2);
-
-		int ch;
-		ch = input1.read();
-		while (ch != -1) {
-			int ch2 = input2.read();
-			if (ch != ch2) {
-				return false;
-			}
-			ch = input1.read();
-		}
-
-		int ch2 = input2.read();
-		return (ch2 == -1);
-	}
-
-	public static ByteArrayInputStream copyInputstream(InputStream input) {
-		ByteArrayOutputStream baos = new ByteArrayOutputStream();
-
-		byte[] buffer = new byte[1024];
-		int len;
-		try {
-			while ((len = input.read(buffer)) > -1 ) {
-				baos.write(buffer, 0, len);
-			}
-			baos.flush();
-
-			if (input instanceof FileInputStream) {
-				((FileInputStream) input).getChannel().position(0);
-			} else {
-				input.reset();
-			}
-		} catch (IOException e) {
-			throw new RuntimeException(e);
-		}
-
-		return new ByteArrayInputStream(baos.toByteArray());
-	}
-
 	@Nullable
 	public static DataSource tryResolveImageFileDataSourceFromDisk(final @Nullable String baseDir, final boolean allowOutsideBaseDir, final @NotNull String srcLocation) {
 		DataSource dataSource;

modules/dkim-module/src/main/java/org/simplejavamail/internal/dkimsupport/DKIMSigner.java

@@ -11,6 +11,7 @@
 
 import javax.mail.MessagingException;
 import javax.mail.internet.MimeMessage;
+import java.io.ByteArrayInputStream;
 import java.io.IOException;
 import java.security.NoSuchAlgorithmException;
 import java.security.spec.InvalidKeySpecException;
@@ -32,11 +33,9 @@ public MimeMessage signMessageWithDKIM(final MimeMessage messageToSign, final Em
 		LOGGER.debug("signing MimeMessage with DKIM...");
 		try {
 			final String dkimSelector = checkNonEmptyArgument(signingDetails.getDkimSelector(), "dkimSelector");
-			final DkimSigner dkimSigner = signingDetails.getDkimPrivateKeyFile() != null
-					// InputStream is managed by Dkim library
-					? new DkimSigner(signingDetails.getDkimSigningDomain(), dkimSelector, signingDetails.getDkimPrivateKeyFile())
-					// InputStream is managed by SimpleJavaMail user
-					: new DkimSigner(signingDetails.getDkimSigningDomain(), dkimSelector, signingDetails.getDkimPrivateKeyInputStream());
+			// InputStream is managed by Dkim library
+			// InputStream is managed by SimpleJavaMail user
+			final DkimSigner dkimSigner = new DkimSigner(signingDetails.getDkimSigningDomain(), dkimSelector, new ByteArrayInputStream(signingDetails.getDkimPrivateKeyData()));
 			dkimSigner.setIdentity(checkNonEmptyArgument(signingDetails.getFromRecipient(), "fromRecipient").getAddress());
 			dkimSigner.setHeaderCanonicalization(Canonicalization.RELAXED);
 			dkimSigner.setBodyCanonicalization(Canonicalization.RELAXED);

modules/simple-java-mail/src/main/java/org/simplejavamail/email/internal/EmailException.java

@@ -10,6 +10,8 @@ class EmailException extends MailException {
 
 	static final String NAME_MISSING_FOR_EMBEDDED_IMAGE = "No name given for embedded image nor passed inside the data source";
 	static final String ERROR_READING_FROM_FILE = "Error reading from file: %s";
+	static final String ERROR_READING_DKIM_FROM_INPUTSTREAM = "Was unable to read DKIM data from input stream";
+	static final String ERROR_READING_SMIME_FROM_INPUTSTREAM = "Was unable to read S/MIME data from input stream";
 	static final String ERROR_READING_FROM_PEM_INPUTSTREAM = "Was unable to convert PEM data to X509 certificate";
 	static final String ERROR_LOADING_PROVIDER_FOR_SMIME_SUPPORT = "Unable to load certificate (missing bouncy castle), is the S/MIME module on the class path?";
 	static final String ERROR_RESOLVING_IMAGE_DATASOURCE = "Unable to dynamically resolve data source for the following image src: %s";