1. Renamed TokenUtils.java's functions to be blatently clear on the input value type

sunnywu · sunnywu · commit 2ae26b1534da · 2024-12-09T19:50:33.000+11:00
2. Fixed the old testIdentityMapForOptOutUser test that was using raw DII as a hash
3. Renamed all uses of IdentityString/IdentityHash variables to rawDii and hashedDii
diff --git a/src/main/java/com/uid2/operator/service/InputUtil.java b/src/main/java/com/uid2/operator/service/InputUtil.java
@@ -197,7 +197,7 @@ public InputVal(String provided, String normalized, DiiType diiType, DiiInputTyp
             this.valid = valid;
             if (valid) {
                 if (this.inputType == DiiInputType.Raw) {
-                    this.diiInput = TokenUtils.getDiiHash(this.normalized);
+                    this.diiInput = TokenUtils.getHashedDii(this.normalized);
                 } else {
                     this.diiInput = EncodingUtils.fromBase64(this.normalized);
                 }
diff --git a/src/main/java/com/uid2/operator/service/TokenUtils.java b/src/main/java/com/uid2/operator/service/TokenUtils.java
@@ -7,36 +7,36 @@
 import java.util.Set;
 
 public class TokenUtils {
-    public static byte[] getDiiHash(String identityString) {
-        return EncodingUtils.getSha256Bytes(identityString);
+    public static byte[] getHashedDii(String rawDii) {
+        return EncodingUtils.getSha256Bytes(rawDii);
     }
 
-    public static String getDiiHashString(String identityString) {
-        return EncodingUtils.toBase64String(getDiiHash(identityString));
+    public static String getHashedDiiString(String rawDii) {
+        return EncodingUtils.toBase64String(getHashedDii(rawDii));
     }
 
-    public static byte[] getFirstLevelHash(byte[] identityHash, String firstLevelSalt) {
-        return getFirstLevelHashFromIdentityHash(EncodingUtils.toBase64String(identityHash), firstLevelSalt);
+    public static byte[] getFirstLevelHashFromHashedDii(byte[] hashedDii, String firstLevelSalt) {
+        return getFirstLevelHashFromHashedDii(EncodingUtils.toBase64String(hashedDii), firstLevelSalt);
     }
 
-    public static byte[] getFirstLevelHashFromIdentity(String identityString, String firstLevelSalt) {
-        return getFirstLevelHash(getDiiHash(identityString), firstLevelSalt);
+    public static byte[] getFirstLevelHashFromRawDii(String rawDii, String firstLevelSalt) {
+        return getFirstLevelHashFromHashedDii(getHashedDii(rawDii), firstLevelSalt);
     }
 
-    public static byte[] getFirstLevelHashFromIdentityHash(String identityHash, String firstLevelSalt) {
-        return EncodingUtils.getSha256Bytes(identityHash, firstLevelSalt);
+    public static byte[] getFirstLevelHashFromHashedDii(String hashedDii, String firstLevelSalt) {
+        return EncodingUtils.getSha256Bytes(hashedDii, firstLevelSalt);
     }
 
     public static byte[] getRawUidV2(byte[] firstLevelHash, String rotatingSalt) {
         return EncodingUtils.getSha256Bytes(EncodingUtils.toBase64String(firstLevelHash), rotatingSalt);
     }
 
-    public static byte[] getRawUidV2FromIdentity(String identityString, String firstLevelSalt, String rotatingSalt) {
-        return getRawUidV2(getFirstLevelHashFromIdentity(identityString, firstLevelSalt), rotatingSalt);
+    public static byte[] getRawUidV2FromRawDii(String rawDii, String firstLevelSalt, String rotatingSalt) {
+        return getRawUidV2(getFirstLevelHashFromRawDii(rawDii, firstLevelSalt), rotatingSalt);
     }
 
-    public static byte[] getRawUidV2FromIdentityHash(String identityString, String firstLevelSalt, String rotatingSalt) {
-        return getRawUidV2(getFirstLevelHashFromIdentityHash(identityString, firstLevelSalt), rotatingSalt);
+    public static byte[] getRawUidV2FromHashedDii(String hashedDii, String firstLevelSalt, String rotatingSalt) {
+        return getRawUidV2(getFirstLevelHashFromHashedDii(hashedDii, firstLevelSalt), rotatingSalt);
     }
 
     public static byte[] getRawUidV3(IdentityScope scope, DiiType type, byte[] firstLevelHash, String rotatingSalt) {
@@ -47,12 +47,12 @@ public static byte[] getRawUidV3(IdentityScope scope, DiiType type, byte[] first
         return rawUid;
     }
 
-    public static byte[] getRawUidV3FromIdentity(IdentityScope scope, DiiType type, String identityString, String firstLevelSalt, String rotatingSalt) {
-        return getRawUidV3(scope, type, getFirstLevelHashFromIdentity(identityString, firstLevelSalt), rotatingSalt);
+    public static byte[] getRawUidV3FromRawDii(IdentityScope scope, DiiType type, String rawDii, String firstLevelSalt, String rotatingSalt) {
+        return getRawUidV3(scope, type, getFirstLevelHashFromRawDii(rawDii, firstLevelSalt), rotatingSalt);
     }
 
-    public static byte[] getRawUidV3FromIdentityHash(IdentityScope scope, DiiType type, String identityString, String firstLevelSalt, String rotatingSalt) {
-        return getRawUidV3(scope, type, getFirstLevelHashFromIdentityHash(identityString, firstLevelSalt), rotatingSalt);
+    public static byte[] getRawUidV3FromHashedDii(IdentityScope scope, DiiType type, String hashedDii, String firstLevelSalt, String rotatingSalt) {
+        return getRawUidV3(scope, type, getFirstLevelHashFromHashedDii(hashedDii, firstLevelSalt), rotatingSalt);
     }
 
     public static byte encodeIdentityScope(IdentityScope identityScope) {
diff --git a/src/main/java/com/uid2/operator/service/UIDOperatorService.java b/src/main/java/com/uid2/operator/service/UIDOperatorService.java
@@ -170,8 +170,8 @@ public IdentityMapResponseItem mapHashedDii(IdentityMapRequestItem request) {
     }
 
     @Override
-    public IdentityMapResponseItem map(HashedDii diiIdentity, Instant asOf) {
-        final FirstLevelHash firstLevelHash = getFirstLevelHashIdentity(diiIdentity, asOf);
+    public IdentityMapResponseItem map(HashedDii hashedDii, Instant asOf) {
+        final FirstLevelHash firstLevelHash = getFirstLevelHashIdentity(hashedDii, asOf);
         return generateRawUid(firstLevelHash, asOf);
     }
 
@@ -233,8 +233,8 @@ private FirstLevelHash getFirstLevelHashIdentity(IdentityScope identityScope, Di
         return new FirstLevelHash(identityScope, diiType, firstLevelHash, null);
     }
 
-    private byte[] getFirstLevelHash(byte[] identityHash, Instant asOf) {
-        return TokenUtils.getFirstLevelHash(identityHash, getSaltProviderSnapshot(asOf).getFirstLevelSalt());
+    private byte[] getFirstLevelHash(byte[] hashedDii, Instant asOf) {
+        return TokenUtils.getFirstLevelHashFromHashedDii(hashedDii, getSaltProviderSnapshot(asOf).getFirstLevelSalt());
     }
 
     private IdentityMapResponseItem generateRawUid(FirstLevelHash firstLevelHash, Instant asOf) {
diff --git a/src/test/java/com/uid2/operator/TokenEncodingTest.java b/src/test/java/com/uid2/operator/TokenEncodingTest.java
@@ -55,7 +55,7 @@ public void testRefreshTokenEncoding(TokenVersion tokenVersion) {
         final EncryptedTokenEncoder encoder = new EncryptedTokenEncoder(this.keyManager);
         final Instant now = EncodingUtils.NowUTCMillis();
 
-        final byte[] firstLevelHash = TokenUtils.getFirstLevelHashFromIdentity("test@example.com", "some-salt");
+        final byte[] firstLevelHash = TokenUtils.getFirstLevelHashFromRawDii("test@example.com", "some-salt");
 
         final TokenRefreshRequest tokenRefreshRequest = new TokenRefreshRequest(tokenVersion,
             now,
diff --git a/src/test/java/com/uid2/operator/UIDOperatorServiceTest.java b/src/test/java/com/uid2/operator/UIDOperatorServiceTest.java
@@ -24,7 +24,7 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
-import static com.uid2.operator.service.TokenUtils.getFirstLevelHash;
+import static com.uid2.operator.service.TokenUtils.getFirstLevelHashFromHashedDii;
 import static org.junit.jupiter.api.Assertions.*;
 
 import org.junit.jupiter.params.ParameterizedTest;
@@ -144,11 +144,11 @@ private void setNow(Instant now) {
         when(clock.instant()).thenAnswer(i -> this.now);
     }
 
-    private HashedDii createHashedDiiIdentity(String rawIdentityHash, IdentityScope scope, DiiType type) {
+    private HashedDii createHashedDii(String hashedDii, IdentityScope scope, DiiType type) {
         return new HashedDii(
                 scope,
                 type,
-                rawIdentityHash.getBytes(StandardCharsets.UTF_8)
+                hashedDii.getBytes(StandardCharsets.UTF_8)
         );
     }
 
@@ -189,7 +189,7 @@ public void testGenerateAndRefresh(int siteId, TokenVersion tokenVersion) {
 
         final TokenGenerateRequest tokenGenerateRequest = new TokenGenerateRequest(
                 new SourcePublisher(siteId, 124, 125),
-                createHashedDiiIdentity("test-email-hash", expectedIdentityScope, expectedDiiType),
+                createHashedDii("test-email-hash", expectedIdentityScope, expectedDiiType),
                 OptoutCheckPolicy.DoNotRespect, PrivacyBits.fromInt(0),
                 this.now.minusSeconds(234)
         );
@@ -214,7 +214,7 @@ public void testGenerateAndRefresh(int siteId, TokenVersion tokenVersion) {
         assertIdentityScopeIdentityType(expectedIdentityScope, expectedDiiType, tokenRefreshRequest.firstLevelHash);
         assertEquals(tokenGenerateRequest.establishedAt, tokenRefreshRequest.firstLevelHash.establishedAt());
 
-        final byte[] firstLevelHash = getFirstLevelHash(tokenGenerateRequest.hashedDii.hashedDii(),
+        final byte[] firstLevelHash = getFirstLevelHashFromHashedDii(tokenGenerateRequest.hashedDii.hashedDii(),
                 saltProvider.getSnapshot(this.now).getFirstLevelSalt() );
         assertArrayEquals(firstLevelHash, tokenRefreshRequest.firstLevelHash.firstLevelHash());
 
@@ -311,7 +311,7 @@ public void testTestOptOutKeyIdentityScopeMismatch() {
             "Phone,+01010101010,UID2",
             "Phone,+01010101010,EUID"})
     public void testGenerateTokenForOptOutUser(DiiType type, String id, IdentityScope scope) {
-        final HashedDii hashedDii = createHashedDiiIdentity(TokenUtils.getDiiHashString(id),
+        final HashedDii hashedDii = createHashedDii(TokenUtils.getHashedDiiString(id),
                 scope, type);
 
         final TokenGenerateRequest tokenGenerateRequestForceGenerate = new TokenGenerateRequest(
@@ -364,7 +364,7 @@ public void testGenerateTokenForOptOutUser(DiiType type, String id, IdentityScop
             "Phone,+01010101010,UID2",
             "Phone,+01010101010,EUID"})
     public void testIdentityMapForOptOutUser(DiiType type, String identity, IdentityScope scope) {
-        final HashedDii hashedDii = createHashedDiiIdentity(identity, scope, type);
+        final HashedDii hashedDii = createHashedDii(TokenUtils.getHashedDiiString(identity), scope, type);
         final Instant now = Instant.now();
 
         final IdentityMapRequestItem mapRequestForceIdentityMapItem = new IdentityMapRequestItem(
diff --git a/src/test/java/com/uid2/operator/UIDOperatorVerticleTest.java b/src/test/java/com/uid2/operator/UIDOperatorVerticleTest.java

Original file line number	Diff line number	Diff line change
`@@ -197,7 +197,7 @@ public InputVal(String provided, String normalized, DiiType diiType, DiiInputTyp`
`197`	`197`	`this.valid = valid;`
`198`	`198`	`if (valid) {`
`199`	`199`	`if (this.inputType == DiiInputType.Raw) {`
`200`		`- this.diiInput = TokenUtils.getDiiHash(this.normalized);`
	`200`	`+ this.diiInput = TokenUtils.getHashedDii(this.normalized);`
`201`	`201`	`} else {`
`202`	`202`	`this.diiInput = EncodingUtils.fromBase64(this.normalized);`
`203`	`203`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,36 +7,36 @@`
`7`	`7`	`import java.util.Set;`
`8`	`8`
`9`	`9`	`public class TokenUtils {`
`10`		`- public static byte[] getDiiHash(String identityString) {`
`11`		`- return EncodingUtils.getSha256Bytes(identityString);`
	`10`	`+ public static byte[] getHashedDii(String rawDii) {`
	`11`	`+ return EncodingUtils.getSha256Bytes(rawDii);`
`12`	`12`	`}`
`13`	`13`
`14`		`- public static String getDiiHashString(String identityString) {`
`15`		`- return EncodingUtils.toBase64String(getDiiHash(identityString));`
	`14`	`+ public static String getHashedDiiString(String rawDii) {`
	`15`	`+ return EncodingUtils.toBase64String(getHashedDii(rawDii));`
`16`	`16`	`}`
`17`	`17`
`18`		`- public static byte[] getFirstLevelHash(byte[] identityHash, String firstLevelSalt) {`
`19`		`- return getFirstLevelHashFromIdentityHash(EncodingUtils.toBase64String(identityHash), firstLevelSalt);`
	`18`	`+ public static byte[] getFirstLevelHashFromHashedDii(byte[] hashedDii, String firstLevelSalt) {`
	`19`	`+ return getFirstLevelHashFromHashedDii(EncodingUtils.toBase64String(hashedDii), firstLevelSalt);`
`20`	`20`	`}`
`21`	`21`
`22`		`- public static byte[] getFirstLevelHashFromIdentity(String identityString, String firstLevelSalt) {`
`23`		`- return getFirstLevelHash(getDiiHash(identityString), firstLevelSalt);`
	`22`	`+ public static byte[] getFirstLevelHashFromRawDii(String rawDii, String firstLevelSalt) {`
	`23`	`+ return getFirstLevelHashFromHashedDii(getHashedDii(rawDii), firstLevelSalt);`
`24`	`24`	`}`
`25`	`25`
`26`		`- public static byte[] getFirstLevelHashFromIdentityHash(String identityHash, String firstLevelSalt) {`
`27`		`- return EncodingUtils.getSha256Bytes(identityHash, firstLevelSalt);`
	`26`	`+ public static byte[] getFirstLevelHashFromHashedDii(String hashedDii, String firstLevelSalt) {`
	`27`	`+ return EncodingUtils.getSha256Bytes(hashedDii, firstLevelSalt);`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`public static byte[] getRawUidV2(byte[] firstLevelHash, String rotatingSalt) {`
`31`	`31`	`return EncodingUtils.getSha256Bytes(EncodingUtils.toBase64String(firstLevelHash), rotatingSalt);`
`32`	`32`	`}`
`33`	`33`
`34`		`- public static byte[] getRawUidV2FromIdentity(String identityString, String firstLevelSalt, String rotatingSalt) {`
`35`		`- return getRawUidV2(getFirstLevelHashFromIdentity(identityString, firstLevelSalt), rotatingSalt);`
	`34`	`+ public static byte[] getRawUidV2FromRawDii(String rawDii, String firstLevelSalt, String rotatingSalt) {`
	`35`	`+ return getRawUidV2(getFirstLevelHashFromRawDii(rawDii, firstLevelSalt), rotatingSalt);`
`36`	`36`	`}`
`37`	`37`
`38`		`- public static byte[] getRawUidV2FromIdentityHash(String identityString, String firstLevelSalt, String rotatingSalt) {`
`39`		`- return getRawUidV2(getFirstLevelHashFromIdentityHash(identityString, firstLevelSalt), rotatingSalt);`
	`38`	`+ public static byte[] getRawUidV2FromHashedDii(String hashedDii, String firstLevelSalt, String rotatingSalt) {`
	`39`	`+ return getRawUidV2(getFirstLevelHashFromHashedDii(hashedDii, firstLevelSalt), rotatingSalt);`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`public static byte[] getRawUidV3(IdentityScope scope, DiiType type, byte[] firstLevelHash, String rotatingSalt) {`
`@@ -47,12 +47,12 @@ public static byte[] getRawUidV3(IdentityScope scope, DiiType type, byte[] first`
`47`	`47`	`return rawUid;`
`48`	`48`	`}`
`49`	`49`
`50`		`- public static byte[] getRawUidV3FromIdentity(IdentityScope scope, DiiType type, String identityString, String firstLevelSalt, String rotatingSalt) {`
`51`		`- return getRawUidV3(scope, type, getFirstLevelHashFromIdentity(identityString, firstLevelSalt), rotatingSalt);`
	`50`	`+ public static byte[] getRawUidV3FromRawDii(IdentityScope scope, DiiType type, String rawDii, String firstLevelSalt, String rotatingSalt) {`
	`51`	`+ return getRawUidV3(scope, type, getFirstLevelHashFromRawDii(rawDii, firstLevelSalt), rotatingSalt);`
`52`	`52`	`}`
`53`	`53`
`54`		`- public static byte[] getRawUidV3FromIdentityHash(IdentityScope scope, DiiType type, String identityString, String firstLevelSalt, String rotatingSalt) {`
`55`		`- return getRawUidV3(scope, type, getFirstLevelHashFromIdentityHash(identityString, firstLevelSalt), rotatingSalt);`
	`54`	`+ public static byte[] getRawUidV3FromHashedDii(IdentityScope scope, DiiType type, String hashedDii, String firstLevelSalt, String rotatingSalt) {`
	`55`	`+ return getRawUidV3(scope, type, getFirstLevelHashFromHashedDii(hashedDii, firstLevelSalt), rotatingSalt);`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`public static byte encodeIdentityScope(IdentityScope identityScope) {`
Original file line number	Diff line number	Diff line change
`@@ -170,8 +170,8 @@ public IdentityMapResponseItem mapHashedDii(IdentityMapRequestItem request) {`
`170`	`170`	`}`
`171`	`171`
`172`	`172`	`@Override`
`173`		`- public IdentityMapResponseItem map(HashedDii diiIdentity, Instant asOf) {`
`174`		`- final FirstLevelHash firstLevelHash = getFirstLevelHashIdentity(diiIdentity, asOf);`
	`173`	`+ public IdentityMapResponseItem map(HashedDii hashedDii, Instant asOf) {`
	`174`	`+ final FirstLevelHash firstLevelHash = getFirstLevelHashIdentity(hashedDii, asOf);`
`175`	`175`	`return generateRawUid(firstLevelHash, asOf);`
`176`	`176`	`}`
`177`	`177`
`@@ -233,8 +233,8 @@ private FirstLevelHash getFirstLevelHashIdentity(IdentityScope identityScope, Di`
`233`	`233`	`return new FirstLevelHash(identityScope, diiType, firstLevelHash, null);`
`234`	`234`	`}`
`235`	`235`
`236`		`- private byte[] getFirstLevelHash(byte[] identityHash, Instant asOf) {`
`237`		`- return TokenUtils.getFirstLevelHash(identityHash, getSaltProviderSnapshot(asOf).getFirstLevelSalt());`
	`236`	`+ private byte[] getFirstLevelHash(byte[] hashedDii, Instant asOf) {`
	`237`	`+ return TokenUtils.getFirstLevelHashFromHashedDii(hashedDii, getSaltProviderSnapshot(asOf).getFirstLevelSalt());`
`238`	`238`	`}`
`239`	`239`
`240`	`240`	`private IdentityMapResponseItem generateRawUid(FirstLevelHash firstLevelHash, Instant asOf) {`
-Original file line number
+Diff line change
         final EncryptedTokenEncoder encoder = new EncryptedTokenEncoder(this.keyManager);
         final Instant now = EncodingUtils.NowUTCMillis();
 -        final byte[] firstLevelHash = TokenUtils.getFirstLevelHashFromIdentity("[email protected]", "some-salt");
 +        final byte[] firstLevelHash = TokenUtils.getFirstLevelHashFromRawDii("[email protected]", "some-salt");
         final TokenRefreshRequest tokenRefreshRequest = new TokenRefreshRequest(tokenVersion,
             now,