INT-3064 Message ID Generation

Use the SPR 4.0.0 Message ID Generation algorithm.

JIRA: https://jira.springsource.org/browse/INT-3064

build.gradle

@@ -56,7 +56,6 @@ subprojects { subproject ->
 		junitVersion = '4.11'
 		log4jVersion = '1.2.12'
 		mockitoVersion = '1.9.5'
-		eaioUUIDVersion = '3.2'
 		ftpServerVersion = '1.0.6'
 
 
@@ -194,7 +193,6 @@ project('spring-integration-core') {
 		compile "org.springframework:spring-context:$springVersion"
 		compile "org.springframework:spring-tx:$springVersion"
 		compile "org.springframework.retry:spring-retry:$springRetryVersion"
-		compile "com.eaio.uuid:uuid:$eaioUUIDVersion"
 		compile("org.codehaus.jackson:jackson-mapper-asl:$jacksonVersion", optional)
 		compile("com.fasterxml.jackson.core:jackson-databind:$jackson2Version", optional)
 		compile('com.jayway.jsonpath:json-path:0.8.1', optional)

spring-integration-core/src/main/java/org/springframework/integration/MessageHeaders.java

@@ -20,12 +20,15 @@ import java.io.IOException;
 import java.io.ObjectInputStream;
 import java.io.ObjectOutputStream;
 import java.io.Serializable;
+import java.math.BigInteger;
+import java.security.SecureRandom;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Random;
 import java.util.Set;
 import java.util.UUID;
 import java.util.concurrent.atomic.AtomicLong;
@@ -33,8 +36,6 @@ import java.util.concurrent.atomic.AtomicLong;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
-import com.eaio.uuid.UUIDGen;
-
 /**
  * The headers for a {@link Message}.<br>
  * IMPORTANT: MessageHeaders are immutable. Any mutating operation (e.g., put(..), putAll(..) etc.)
@@ -55,6 +56,7 @@ import com.eaio.uuid.UUIDGen;
  * @author Mark Fisher
  * @author Oleg Zhurakousky
  * @author Gary Russell
+ * @author Rossen Stoyanchev
  */
 public final class MessageHeaders implements Map<String, Object>, Serializable {
 
@@ -64,6 +66,8 @@ public final class MessageHeaders implements Map<String, Object>, Serializable {
 
 	private static volatile IdGenerator idGenerator = null;
 
+	private static final IdGenerator defaultIdGenerator = new AlternativeJdkIdGenerator();
+
 	/**
 	 * The key for the Message ID. This is an automatically generated UUID and
 	 * should never be explicitly set in the header map <b>except</b> in the
@@ -100,13 +104,8 @@ public final class MessageHeaders implements Map<String, Object>, Serializable {
 
 	public MessageHeaders(Map<String, Object> headers) {
 		this.headers = (headers != null) ? new HashMap<String, Object>(headers) : new HashMap<String, Object>();
-		if (MessageHeaders.idGenerator == null) {
-			UUID uuid = new UUID(UUIDGen.newTime(), UUIDGen.getClockSeqAndNode());
-			this.headers.put(ID, uuid);
-		}
-		else {
-			this.headers.put(ID, MessageHeaders.idGenerator.generateId());
-		}
+		IdGenerator generatorToUse = (idGenerator != null) ? idGenerator : defaultIdGenerator;
+		this.headers.put(ID, generatorToUse.generateId());
 
 		this.headers.put(TIMESTAMP, new Long(System.currentTimeMillis()));
 	}
@@ -285,6 +284,38 @@ public final class MessageHeaders implements Map<String, Object>, Serializable {
 
 	}
 
+    /**
+     * A variation of {@link UUID#randomUUID()} that uses {@link SecureRandom} only for
+     * the initial seed and {@link Random} thereafter, which provides better performance
+     * in exchange for less securely random id's.
+     */
+    public static class AlternativeJdkIdGenerator implements IdGenerator {
+
+            private final Random random;
+
+            public AlternativeJdkIdGenerator() {
+                    byte[] seed = new SecureRandom().generateSeed(8);
+                    this.random = new Random(new BigInteger(seed).longValue());
+            }
+
+            public UUID generateId() {
+
+                    byte[] randomBytes = new byte[16];
+                    this.random.nextBytes(randomBytes);
+
+                    long mostSigBits = 0;
+                    for (int i = 0; i < 8; i++) {
+                            mostSigBits = (mostSigBits << 8) | (randomBytes[i] & 0xff);
+                    }
+                    long leastSigBits = 0;
+                    for (int i = 8; i < 16; i++) {
+                            leastSigBits = (leastSigBits << 8) | (randomBytes[i] & 0xff);
+                    }
+
+                    return new UUID(mostSigBits, leastSigBits);
+            }
+    }
+
 	public static class SimpleIncrementingIdGenerator implements IdGenerator {
 
 		private final AtomicLong topBits = new AtomicLong();

src/reference/docbook/message.xml

@@ -121,10 +121,11 @@
         <para>
           When a message transitions through an application, each time it is
           mutated (e.g. by a transformer) a new message id is assigned. The message id is
-          a <code>UUID</code>. Beginning with Spring Integration 3.0, the default strategy
-          used for id generation is to use the <code>com.eaio.uuid</code> package to
-          generate Type 1 UUIDs. This is much more efficient than the previous
-          <code>java.util.UUID.randomUUID()</code> implementation.
+          a <code>UUID</code>. Beginning with <emphasis>Spring Integration 3.0</emphasis>,
+          the default strategy used for id generation is more efficient than the previous
+          <code>java.util.UUID.randomUUID()</code> implementation. It uses simple random
+          numbers based on a secure random seed, instead of creating a secure random
+          number each time.
         </para>
         <para>
           A different UUID generation strategy can be selected by declaring a bean that implements
@@ -147,11 +148,6 @@
           can be used in cases where a UUID is not really needed and a simple incrementing
           value is sufficient.
         </para>
-        <important>
-          The default strategy of creating Type 1 UUIDs may present security concerns for some users
-          because the UUID contains the MAC address of a network interface on the platform. For these
-          users, an alternate strategy should be selected.
-        </important>
     </section>
   </section>
 

src/reference/docbook/whats-new.xml

@@ -467,8 +467,8 @@
 			<title>Message ID Generation</title>
 			<para>
 				Previously, message ids were generated using the JDK <code>UUID.randomUUID()</code> method. With this
-				release, the default mechanism has been changed to use the <code>com.eaio.uuid</code> package which
-				generates Type 1 UUIDs, and is significantly faster. In addition, the ability to change
+				release, the default mechanism has been changed to use a more efficient algorithm which
+				is significantly faster. In addition, the ability to change
 				the strategy used to generate message ids has been added.
 				For more information see <xref linkend="message-id-generation"/>.
 			</para>