Merge pull request #187 from AriPaaWun/feature/configurable-unique-id-prefix

Add a property for unique ID prefix

Author: pitbulk

README.md

@@ -344,6 +344,11 @@ onelogin.saml2.contacts.technical.given_name = Technical Guy
 onelogin.saml2.contacts.technical.email_address = technical@example.com
 onelogin.saml2.contacts.support.given_name = Support Guy
 onelogin.saml2.contacts.support.email_address = support@example.com
+
+# Prefix used in generated Unique IDs.
+# Optional, defaults to ONELOGIN_ or full ID is like ONELOGIN_ebb0badd-4f60-4b38-b20a-a8e01f0592b1.
+# At minimun, the prefix can be non-numeric character such as "_".
+# onelogin.saml2.unique_id_prefix = _
 ```
 
 ##### Dynamic Settings

core/src/main/java/com/onelogin/saml2/authn/AuthnRequest.java

@@ -86,7 +86,7 @@ public AuthnRequest(Saml2Settings settings) {
 	 *            When true the AuthNReuqest will set a nameIdPolicy
 	 */
 	public AuthnRequest(Saml2Settings settings, boolean forceAuthn, boolean isPassive, boolean setNameIdPolicy) {
-		this.id = Util.generateUniqueID();
+		this.id = Util.generateUniqueID(settings.getUniqueIDPrefix());
 		issueInstant = Calendar.getInstance();
 		this.isPassive = isPassive;
 		this.settings = settings;

core/src/main/java/com/onelogin/saml2/logout/LogoutRequest.java

@@ -132,7 +132,7 @@ public LogoutRequest(Saml2Settings settings, HttpRequest request, String nameId,
 		}
 
 		if (samlLogoutRequest == null) {
-			id = Util.generateUniqueID();
+			id = Util.generateUniqueID(settings.getUniqueIDPrefix());
 			issueInstant = Calendar.getInstance();
 			this.nameId = nameId;
 			this.nameIdFormat = nameIdFormat;

core/src/main/java/com/onelogin/saml2/logout/LogoutResponse.java

@@ -343,7 +343,7 @@ private NodeList query (String query) throws XPathExpressionException {
      *				InResponseTo attribute value to bet set at the Logout Response. 
      */
 	public void build(String inResponseTo) {
-		id = Util.generateUniqueID();
+		id = Util.generateUniqueID(settings.getUniqueIDPrefix());
 		issueInstant = Calendar.getInstance();
 		this.inResponseTo = inResponseTo;
 
@@ -418,4 +418,4 @@ private static StringBuilder getLogoutResponseTemplate() {
 	public String getError() {
 		return error;
 	}
-}
+}

core/src/main/java/com/onelogin/saml2/settings/Metadata.java

@@ -139,7 +139,7 @@ private StrSubstitutor generateSubstitutor(Saml2Settings settings) throws Certif
 		Map<String, String> valueMap = new HashMap<String, String>();
 		Boolean wantsEncrypted = settings.getWantAssertionsEncrypted() || settings.getWantNameIdEncrypted(); 
 
-		valueMap.put("id", Util.generateUniqueID());
+		valueMap.put("id", Util.generateUniqueID(settings.getUniqueIDPrefix()));
 		valueMap.put("validUntilTime", Util.formatDateTime(validUntilTime.getTimeInMillis()));
 		valueMap.put("cacheDuration", String.valueOf(cacheDuration));
 		valueMap.put("spEntityId", settings.getSpEntityId());

core/src/main/java/com/onelogin/saml2/settings/Saml2Settings.java

@@ -73,6 +73,7 @@ public class Saml2Settings {
 	private String signatureAlgorithm = Constants.RSA_SHA1;
 	private String digestAlgorithm = Constants.SHA1;
 	private boolean rejectUnsolicitedResponsesWithInResponseTo = false;
+	private String uniqueIDPrefix = null;
 
 	// Compress
 	private boolean compressRequest = true;
@@ -340,6 +341,13 @@ public Organization getOrganization() {
 		return this.organization;
 	}
 
+	/**
+	 * @return Unique ID prefix
+	 */
+	public String getUniqueIDPrefix() {
+		return this.uniqueIDPrefix;
+	}
+
 	/**
 	 * @return if the debug is active or not
 	 */
@@ -447,6 +455,16 @@ protected final void setSpPrivateKey(PrivateKey spPrivateKey) {
 		this.spPrivateKey = spPrivateKey;
 	}
 
+	/**
+	 * Set the uniqueIDPrefix setting value
+	 *
+	 * @param uniqueIDPrefix
+	 *            the Unique ID prefix used when generating Unique ID
+	 */
+	protected final void setUniqueIDPrefix(String uniqueIDPrefix) {
+		this.uniqueIDPrefix = uniqueIDPrefix;
+	}
+
 	/**
 	 * Set the idpEntityId setting value
 	 *

core/src/main/java/com/onelogin/saml2/settings/SettingsBuilder.java

@@ -103,6 +103,7 @@ public class SettingsBuilder {
 	public final static String ORGANIZATION_DISPLAYNAME = "onelogin.saml2.organization.displayname";
 	public final static String ORGANIZATION_URL = "onelogin.saml2.organization.url";
 	public final static String ORGANIZATION_LANG = "onelogin.saml2.organization.lang";
+	public final static String UNIQUE_ID_PREFIX_PROPERTY_KEY = "onelogin.saml2.unique_id_prefix";
 
 	/**
 	 * Load settings from the file
@@ -206,6 +207,8 @@ public Saml2Settings build(Saml2Settings saml2Setting) {
 
 		saml2Setting.setOrganization(loadOrganization());
 
+		saml2Setting.setUniqueIDPrefix(loadUniqueIDPrefix());
+
 		return saml2Setting;
 	}
 
@@ -379,6 +382,18 @@ private List<Contact> loadContacts() {
 		return contacts;
 	}
 
+	/**
+	 * Loads the unique ID prefix. Uses default if property not set.
+	 */
+	private String loadUniqueIDPrefix() {
+		String uniqueIDPrefix = loadStringProperty(UNIQUE_ID_PREFIX_PROPERTY_KEY);
+		if (StringUtils.isNotEmpty(uniqueIDPrefix)) {
+			return uniqueIDPrefix;
+		} else {
+			return Util.UNIQUE_ID_PREFIX;
+		}
+	}
+
 	/**
 	 * Loads the SP settings from the properties file
 	 */

core/src/main/java/com/onelogin/saml2/util/Util.java

@@ -1528,13 +1528,29 @@ private static SecretKey generateSymmetricKey() throws Exception {
 		return keyGenerator.generateKey();
 	}
 
+	/**
+	 * Generates a unique string (used for example as ID of assertions)
+	 *
+	 * @param prefix
+	 *          Prefix for the Unique ID.
+	 *          Use property <code>onelogin.saml2.unique_id_prefix</code> to set this.
+	 *
+	 * @return A unique string
+	 */
+	public static String generateUniqueID(String prefix) {
+		if (prefix == null || StringUtils.isEmpty(prefix)) {
+			prefix = Util.UNIQUE_ID_PREFIX;
+		}
+		return prefix + UUID.randomUUID();
+	}
+
 	/**
 	 * Generates a unique string (used for example as ID of assertions)
 	 *
 	 * @return A unique string
 	 */
 	public static String generateUniqueID() {
-		return UNIQUE_ID_PREFIX + UUID.randomUUID();
+		return generateUniqueID(null);
 	}
 
 	/**

core/src/test/java/com/onelogin/saml2/test/settings/Saml2SettingsTest.java

@@ -356,7 +356,42 @@ public void testValidateMetadataNoDescriptor() throws Exception {
 		assertFalse(errors.isEmpty());
 		assertTrue(errors.contains("noEntityDescriptor_xml"));
 	}
-	
+
+	/**
+	 * Test that Unique ID prefix is read
+	 *
+	 * @throws Exception
+	 */
+	@Test
+	public void testGivenUniqueIDPrefixIsUsed() throws Exception {
+		Saml2Settings settings = new SettingsBuilder().fromFile("config/config.all.properties").build();
+
+		assertEquals("EXAMPLE", settings.getUniqueIDPrefix());
+	}
+
+	/**
+	 * Test that "_" value is ok for Unique ID prefix
+	 *
+	 * @throws Exception
+	 */
+	@Test
+	public void testUniqueIDPrefixIsUsed() throws Exception {
+		Saml2Settings settings = new SettingsBuilder().fromFile("config/config.min_uniqueid.properties").build();
+
+		assertEquals("_", settings.getUniqueIDPrefix());
+	}
+
+	/**
+	 * Tests that if property Unique ID prefix is unset, default value is used
+	 * @throws Exception
+	 */
+	@Test
+	public void testUniqueIDPrefixUsesDefaultWhenNotSet() throws Exception {
+		Saml2Settings settings = new SettingsBuilder().fromFile("config/config.min.properties").build();
+
+		assertEquals("ONELOGIN_", settings.getUniqueIDPrefix());
+	}
+
 	/**
 	 * Tests the validateMetadata method of the Saml2Settings
 	 * Case Invalid: onlySPSSODescriptor_allowed_xml

core/src/test/java/com/onelogin/saml2/test/settings/SettingBuilderTest.java

@@ -166,6 +166,8 @@ public void testLoadFromFileMinProp() throws IOException, CertificateException,
 
 		assertNull(setting.getOrganization());
 		assertTrue(setting.getContacts().isEmpty());
+
+		assertEquals("ONELOGIN_", setting.getUniqueIDPrefix());
 	}
 
 	/**
@@ -235,6 +237,8 @@ public void testLoadFromFileAllProp() throws IOException, CertificateException,
 		assertEquals("support", c2.getContactType());
 		assertEquals("support@example.com", c2.getEmailAddress());
 		assertEquals("Support Guy", c2.getGivenName());
+
+		assertEquals("EXAMPLE", setting.getUniqueIDPrefix());
 	}
 
 	/**
@@ -522,6 +526,21 @@ public void testLoadFromFileDifferentProp() throws IOException, CertificateExcep
 		assertTrue(c2.getGivenName().isEmpty());
 	}
 
+	/**
+	 * Tests SettingsBuilder fromFile method
+	 * Case: min settings with minimal Unique ID config file
+	 *
+	 * @throws Exception
+	 *
+	 * @see com.onelogin.saml2.settings.SettingsBuilder#fromFile
+	 */
+	@Test
+	public void testLoadFromFileMinUniqueIDProp() throws Exception {
+		Saml2Settings setting = new SettingsBuilder().fromFile("config/config.min_uniqueid.properties").build();
+
+		assertEquals("_", setting.getUniqueIDPrefix());
+	}
+
 	/**
 	 * Tests SettingsBuilder fromProperties method
 	 *
@@ -586,6 +605,8 @@ public void testFromProperties() throws IOException, Error, CertificateException
 
 		assertNull(setting2.getOrganization());
 		assertTrue(setting2.getContacts().isEmpty());
+
+		assertEquals("ONELOGIN_", setting2.getUniqueIDPrefix());
 	}
 
 	/**
@@ -654,6 +675,8 @@ public void testLoadFromValues() throws Exception {
 		samlData.put(CONTACT_TECHNICAL_EMAIL_ADDRESS, "technical@example.org");
 		samlData.put(CONTACT_SUPPORT_GIVEN_NAME, "Support Guy");
 		samlData.put(CONTACT_SUPPORT_EMAIL_ADDRESS, "support@example.org");
+
+		samlData.put(UNIQUE_ID_PREFIX_PROPERTY_KEY, "_");
 
 		Saml2Settings setting = new SettingsBuilder().fromValues(samlData).build();
 
@@ -717,6 +740,8 @@ public void testLoadFromValues() throws Exception {
 		assertEquals("support", c2.getContactType());
 		assertEquals("support@example.org", c2.getEmailAddress());
 		assertEquals("Support Guy", c2.getGivenName());
+
+		assertEquals("_", setting.getUniqueIDPrefix());
 	}
 
 	/**
@@ -840,6 +865,8 @@ public void testLoadFromValuesWithObjects() throws Exception {
 		assertEquals("support", c2.getContactType());
 		assertEquals("support@example.org", c2.getEmailAddress());
 		assertEquals("Support Guy", c2.getGivenName());
+
+		assertEquals("ONELOGIN_", setting.getUniqueIDPrefix());
 	}
 
 	/**