HHH-19471 - Hashing a constraint name using SHA-256 if the MD5 algorithm is not available

Co-authored-by: Yitzchak Weiser <[email protected]>
Co-authored-by: Ashwinkumar Rathod <[email protected]>

Author: 3 people

hibernate-core/src/main/java/org/hibernate/boot/model/naming/NamingHelper.java

@@ -12,6 +12,7 @@
 import java.util.List;
 
 import org.hibernate.HibernateException;
+import org.jboss.logging.Logger;
 
 import static java.util.Comparator.comparing;
 
@@ -30,6 +31,8 @@ public static NamingHelper withCharset(String charset) {
 
 	private final String charset;
 
+	private static final Logger log = Logger.getLogger(NamingHelper.class);
+
 	public NamingHelper() {
 		this(null);
 	}
@@ -124,8 +127,8 @@ public String generateHashedConstraintName(
 	}
 
 	/**
-	 * Hash a constraint name using SHA-256. Convert the SHA-256 digest to base 35
-	 * (full alphanumeric), guaranteeing
+	 * Hash a constraint name using MD5. If MD5 is not available, fall back to SHA-256.
+	 * Convert the digest to base 35 (full alphanumeric), guaranteeing
 	 * that the length of the name will always be smaller than the 30
 	 * character identifier restriction enforced by a few dialects.
 	 *
@@ -135,17 +138,36 @@ public String generateHashedConstraintName(
 	 */
 	public String hashedName(String name) {
 		try {
-			final MessageDigest md = MessageDigest.getInstance( "SHA-256" );
-			md.reset();
-			md.update( charset != null ? name.getBytes( charset ) : name.getBytes() );
-			final BigInteger bigInt = new BigInteger( 1, md.digest() );
-			// By converting to base 35 (full alphanumeric), we guarantee
-			// that the length of the name will always be smaller than the 30
-			// character identifier restriction enforced by a few dialects.
-			return bigInt.toString( 35 );
+			return hashWithAlgorithm(name, "MD5");
 		}
-		catch ( NoSuchAlgorithmException | UnsupportedEncodingException e ) {
-			throw new HibernateException( "Unable to generate a hashed name", e );
+		catch (NoSuchAlgorithmException | UnsupportedEncodingException e) {
+			log.warnf("MD5 algorithm failed for hashedName, falling back to SHA-256: %s", e.getMessage());
+			try {
+				return hashWithAlgorithm(name, "SHA-256");
+			}
+			catch (NoSuchAlgorithmException | UnsupportedEncodingException ex) {
+				throw new HibernateException("Unable to generate a hashed name", ex);
+			}
 		}
 	}
+
+	/**
+	 * Helper to hash a name with the given algorithm and convert to base 35.
+	 *
+	 * @param name The name to be hashed.
+	 * @param algorithm The hashing algorithm to use.
+	 *
+	 * @return String The hashed name.
+	 */
+	public String hashWithAlgorithm(String name, String algorithm)
+			throws NoSuchAlgorithmException, UnsupportedEncodingException {
+		final MessageDigest md = MessageDigest.getInstance(algorithm);
+		md.reset();
+		md.update( charset != null ? name.getBytes( charset ) : name.getBytes() );
+		final BigInteger bigInt = new BigInteger( 1, md.digest() );
+		// By converting to base 35 (full alphanumeric), we guarantee
+		// that the length of the name will always be smaller than the 30
+		// character identifier restriction enforced by a few dialects.
+		return bigInt.toString( 35 );
+	}
 }

hibernate-core/src/test/java/org/hibernate/orm/test/annotations/namingstrategy/charset/Iso88591CharsetNamingStrategyTest.java

@@ -23,7 +23,7 @@ protected String expectedUniqueKeyName() {
 			return "UK38xspy14r49kkcmmyltias1j4"; // Non-ASCII, non-alphanumeric identifiers are quoted on HANA
 		}
 		else {
-			return "UK8k5luacfo75uusg9a3fb87wbeub3";
+			return "UKq2jxex2hrvg4139p85npyj71g";
 		}
 	}
 
@@ -33,7 +33,7 @@ protected String expectedForeignKeyName() {
 			return "FKdvmx00nr88d03v6xhrjyujrq2"; // Non-ASCII, non-alphanumeric identifiers are quoted on HANA
 		}
 		else {
-			return "FKgkcc85inbuuppywsp0bxqfbqknno";
+			return "FKdeqq4y6cesc2yfgi97u2hp61g";
 		}
 	}
 
@@ -43,7 +43,7 @@ protected String expectedIndexName() {
 			return "IDX38xspy14r49kkcmmyltias1j4"; // Non-ASCII, non-alphanumeric identifiers are quoted on HANA
 		}
 		else {
-			return "IDX8k5luacfo75uusg9a3fb87wbeub";
+			return "IDXq2jxex2hrvg4139p85npyj71g";
 		}
 	}
 }

hibernate-core/src/test/java/org/hibernate/orm/test/annotations/namingstrategy/charset/Utf8CharsetNamingStrategyTest.java

@@ -23,7 +23,7 @@ protected String expectedUniqueKeyName() {
 			return "UKinnacp0woeltj5l0k4vgabf8k"; // Non-ASCII, non-alphanumeric identifiers are quoted on HANA
 		}
 		else {
-			return "UK3punuckhqfc03ddypdrpeahs9cty";
+			return "UKpm66tdjkgtsca5x2uwux487t5";
 		}
 	}
 
@@ -33,7 +33,7 @@ protected String expectedForeignKeyName() {
 			return "FKe1lr9dd16cmmon53r7m736yev"; // Non-ASCII, non-alphanumeric identifiers are quoted on HANA
 		}
 		else {
-			return "FK6av084md8iluhsdmw8hqv4ep8g98";
+			return "FKgvrnki5fwp3qo0hfp1bu1jj0q";
 		}
 	}
 
@@ -43,7 +43,7 @@ protected String expectedIndexName() {
 			return "IDXinnacp0woeltj5l0k4vgabf8k"; // Non-ASCII, non-alphanumeric identifiers are quoted on HANA
 		}
 		else {
-			return "IDX3punuckhqfc03ddypdrpeahs9ct";
+			return "IDXpm66tdjkgtsca5x2uwux487t5";
 		}
 	}
 }

hibernate-core/src/test/java/org/hibernate/orm/test/bootstrap/binding/naming/NamingHelperTest.java

@@ -9,13 +9,17 @@
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.MethodSource;
+import org.junit.jupiter.api.Test;
 
 import java.nio.charset.StandardCharsets;
+import java.io.UnsupportedEncodingException;
+import java.security.NoSuchAlgorithmException;
 import java.util.List;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.*;
 
 class NamingHelperTest {
 
@@ -57,34 +61,79 @@ void smoke(String charset, String prefix, String tableName, String referencedTab
 				.isEqualTo( expectedConstraintName );
 	}
 
+	@Test
+	void testHashWithAlgorithm_md5_utf8() throws Exception {
+		NamingHelper helper = NamingHelper.withCharset(StandardCharsets.UTF_8.name());
+		String hash = helper.hashWithAlgorithm("table_name", "MD5");
+		assertNotNull(hash);
+		assertFalse(hash.isEmpty());
+		// MD5 hash of "table_name" in base 35 should be deterministic
+		assertEquals("8q6ok4ne4ufel54crtitkq7ir", hash);
+	}
+
+	@Test
+	void testHashWithAlgorithm_sha256_utf8() throws Exception {
+		NamingHelper helper = NamingHelper.withCharset(StandardCharsets.UTF_8.name());
+		String hash = helper.hashWithAlgorithm("table_name", "SHA-256");
+		assertNotNull(hash);
+		assertFalse(hash.isEmpty());
+		// SHA-256 hash of "table_name" in base 35 should be deterministic
+		assertEquals("nie2bx5e7mderevrnl4gkuhtmy45nwfvst7dv6cx3pb3yy9ul1", hash);
+	}
+
+	@Test
+	void testHashWithAlgorithm_md5_iso88591() throws Exception {
+		NamingHelper helper = NamingHelper.withCharset(StandardCharsets.ISO_8859_1.name());
+		String hash = helper.hashWithAlgorithm("café", "MD5");
+		assertNotNull(hash);
+		assertFalse(hash.isEmpty());
+		assertEquals("hgll69c0qdhsjikniholqfcj4", hash);
+	}
+
+	@Test
+	void testHashWithAlgorithm_invalidAlgorithm() {
+		NamingHelper helper = NamingHelper.withCharset(StandardCharsets.UTF_8.name());
+		assertThrows(NoSuchAlgorithmException.class, () -> {
+			helper.hashWithAlgorithm("table_name", "NOPE");
+		});
+	}
+
+	@Test
+	void testHashWithAlgorithm_invalidCharset() {
+		NamingHelper helper = NamingHelper.withCharset("NOPE-CHARSET");
+		assertThrows(UnsupportedEncodingException.class, () -> {
+			helper.hashWithAlgorithm("table_name", "MD5");
+		});
+	}
+
 	private static Stream<Arguments> args() {
 		// String charset, String prefix, String tableName, String referencedTableName,
 		// List<String> columnNames, String expectedFkName, String expectedConstraintName
 		return Stream.of(
 				Arguments.of(
 						StandardCharsets.UTF_8.name(),
 						"fk_", "table_name", "other_table_name", List.of( "col1", "col2", "col3" ),
-						"fk_ka01ji8vk10osbgp6ve604cm1kfsso7byjr6s294jaukhv3ajq", "fk_kv2dq7fp00eyv1vq5yc29rvc3yftq2fmyg9iacv99wrn3nn0l6" ),
+						"fk_f4u43ook9b825fxbm3exb18q6", "fk_1o8k3sa4q2a2wb596v4htt8qf" ),
 				Arguments.of(
 						StandardCharsets.ISO_8859_1.name(),
 						"fk_", "table_name", "other_table_name", List.of( "col1", "col2", "col3" ),
-						"fk_ka01ji8vk10osbgp6ve604cm1kfsso7byjr6s294jaukhv3ajq", "fk_kv2dq7fp00eyv1vq5yc29rvc3yftq2fmyg9iacv99wrn3nn0l6" ),
+						"fk_f4u43ook9b825fxbm3exb18q6", "fk_1o8k3sa4q2a2wb596v4htt8qf" ),
 				Arguments.of(
 						StandardCharsets.UTF_8.name(),
 						"fk_", "café", "le_déjeuner", List.of( "col1", "col2", "col3" ),
-						"fk_ih8sokb1hh74aiucascp5pv0dlecescli8httwu7ca8ggbvxx4", "fk_1mlbg6hqesxj797eo16lo82hd491j5ag67833h3i1k7q99wo9b" ),
+						"fk_jdvsrk14lxab6a829ok160vyj", "fk_h34kugb2bguwmcn1g5h1q3snf" ),
 				Arguments.of(
 						StandardCharsets.ISO_8859_1.name(),
 						"fk_", "café", "le_déjeuner", List.of( "col1", "col2", "col3" ),
-						"fk_i2tnixfnx9ylanksjrn8u41wvg5cdgl8wr7264olc17srxpa95", "fk_h8iedvm0im7uuapsek0b5wsc5goahu7wvjgtc3a5snqi79outg" ),
+						"fk_g1py0mkjd1tu46tr8c2e1vm2l", "fk_1pitt5gtytwpy6ea02o7l5men" ),
 				Arguments.of(
 						StandardCharsets.UTF_8.name(),
 						"fk_", "abcdefghijklmnopqrstuvwxyzäöüß", "stuvwxyzäöüß", List.of( "col1" ),
-						"fk_eh9134y0qw0bck215ws5kixdw8v41w26nuq76p5p6vdheyvbpk", "fk_megnb1o6em9hrlel3dvyomlmo41my964kfvdudonbumofve1jx" ),
+						"fk_q11mlivmrc3sdfnncd2hwkpqp", "fk_gm8xsqu7ayucv5w5w2gj2dfly" ),
 				Arguments.of(
 						StandardCharsets.ISO_8859_1.name(),
 						"fk_", "abcdefghijklmnopqrstuvwxyzäöüß", "stuvwxyzäöüß", List.of( "col1" )
-						, "fk_t8yjwdnsr4el6guwpgnxtlsvcgodr9rtaod8uor849w36552h", "fk_x5u4f3i64gnbca1jxu03q2968mn4b66bb6lbqbtf5apo6ux13" )
+						, "fk_fua9hgc6dn6eno8hlqt58j72o", "fk_3iig3yrgsf5bjlbdo05d7mp2" )
 		);
 	}
 

hibernate-core/src/test/java/org/hibernate/orm/test/constraint/ConstraintTest.java

@@ -31,7 +31,7 @@
  */
 public class ConstraintTest extends BaseNonConfigCoreFunctionalTestCase {
 
-	private static final int MAX_NAME_LENGTH = 170;
+	private static final int MAX_NAME_LENGTH = 30;
 
 	private static final String EXPLICIT_FK_NAME_NATIVE = "fk_explicit_native";