Changed null advertising ID to throw runtime exception instead

Author: gmsdelmundo

src/main/java/com/uid2/operator/service/TokenUtils.java

@@ -58,16 +58,16 @@ public static byte[] getAdvertisingIdV3FromIdentityHash(IdentityScope scope, Ide
         return getAdvertisingIdV3(scope, type, getFirstLevelHashFromIdentityHash(identityString, firstLevelSalt), rotatingSalt);
     }
 
-    public static byte[] getAdvertisingIdV4(IdentityScope scope, IdentityType type, IdentityEnvironment environment, byte[] firstLevelHash, SaltEntry.KeyMaterial encryptingKey) throws Exception {
+    public static byte[] getAdvertisingIdV4(IdentityScope scope, IdentityType type, IdentityEnvironment environment, byte[] firstLevelHash, SaltEntry.KeyMaterial encryptingKey) {
         byte metadata = encodeV4Metadata(scope, type, environment);
         return V4TokenUtils.buildAdvertisingIdV4(metadata, firstLevelHash, encryptingKey.id(), encryptingKey.key(), encryptingKey.salt());
     }
 
-    public static byte[] getAdvertisingIdV4FromIdentity(IdentityScope scope, IdentityType type, IdentityEnvironment environment, String identityString, String firstLevelSalt, SaltEntry.KeyMaterial encryptingKey) throws Exception {
+    public static byte[] getAdvertisingIdV4FromIdentity(IdentityScope scope, IdentityType type, IdentityEnvironment environment, String identityString, String firstLevelSalt, SaltEntry.KeyMaterial encryptingKey) {
         return getAdvertisingIdV4(scope, type, environment, getFirstLevelHashFromIdentity(identityString, firstLevelSalt), encryptingKey);
     }
 
-    public static byte[] getAdvertisingIdV4FromIdentityHash(IdentityScope scope, IdentityType type, IdentityEnvironment environment, String identityString, String firstLevelSalt, SaltEntry.KeyMaterial encryptingKey) throws Exception {
+    public static byte[] getAdvertisingIdV4FromIdentityHash(IdentityScope scope, IdentityType type, IdentityEnvironment environment, String identityString, String firstLevelSalt, SaltEntry.KeyMaterial encryptingKey) {
         return getAdvertisingIdV4(scope, type, environment, getFirstLevelHashFromIdentityHash(identityString, firstLevelSalt), encryptingKey);
     }
 

src/main/java/com/uid2/operator/service/UIDOperatorService.java

@@ -252,13 +252,8 @@ private byte[] getAdvertisingId(UserIdentity firstLevelHashIdentity, String salt
                 incrementAdvertisingIdVersionCounter(IdentityVersion.V2);
             }
         } else {
-            try {
-                advertisingId = TokenUtils.getAdvertisingIdV4(firstLevelHashIdentity.identityScope, firstLevelHashIdentity.identityType, env, firstLevelHashIdentity.id, key);
-                incrementAdvertisingIdVersionCounter(IdentityVersion.V4);
-            } catch (Exception e) {
-                LOGGER.error("Exception when generating V4 advertising ID", e);
-                advertisingId = null;
-            }
+            advertisingId = TokenUtils.getAdvertisingIdV4(firstLevelHashIdentity.identityScope, firstLevelHashIdentity.identityType, env, firstLevelHashIdentity.id, key);
+            incrementAdvertisingIdVersionCounter(IdentityVersion.V4);
         }
 
         return advertisingId;

src/main/java/com/uid2/operator/service/V4TokenUtils.java

@@ -29,21 +29,25 @@ private static byte[] getKeyIdBytes(int keyId) {
         };
     }
 
-    public static byte[] buildAdvertisingIdV4(byte metadata, byte[] firstLevelHash, int keyId, String key, String salt) throws Exception {
-        byte[] firstLevelHashLast16Bytes = Arrays.copyOfRange(firstLevelHash, firstLevelHash.length - 16, firstLevelHash.length);
-        byte[] iv = V4TokenUtils.generateIV(salt, firstLevelHashLast16Bytes, metadata, keyId);
-        byte[] encryptedFirstLevelHash = V4TokenUtils.encryptHash(key, firstLevelHashLast16Bytes, iv);
+    public static byte[] buildAdvertisingIdV4(byte metadata, byte[] firstLevelHash, int keyId, String key, String salt) {
+        try {
+            byte[] firstLevelHashLast16Bytes = Arrays.copyOfRange(firstLevelHash, firstLevelHash.length - 16, firstLevelHash.length);
+            byte[] iv = V4TokenUtils.generateIV(salt, firstLevelHashLast16Bytes, metadata, keyId);
+            byte[] encryptedFirstLevelHash = V4TokenUtils.encryptHash(key, firstLevelHashLast16Bytes, iv);
 
-        Buffer buffer = Buffer.buffer();
-        buffer.appendByte(metadata);
-        buffer.appendBytes(getKeyIdBytes(keyId));
-        buffer.appendBytes(iv);
-        buffer.appendBytes(encryptedFirstLevelHash);
+            Buffer buffer = Buffer.buffer();
+            buffer.appendByte(metadata);
+            buffer.appendBytes(getKeyIdBytes(keyId));
+            buffer.appendBytes(iv);
+            buffer.appendBytes(encryptedFirstLevelHash);
 
-        byte checksum = generateChecksum(buffer.getBytes());
-        buffer.appendByte(checksum);
+            byte checksum = generateChecksum(buffer.getBytes());
+            buffer.appendByte(checksum);
 
-        return buffer.getBytes();
+            return buffer.getBytes();
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
     }
 
     public static byte[] generateIV(String salt, byte[] firstLevelHashLast16Bytes, byte metadata, int keyId) throws Exception {

src/test/java/com/uid2/operator/EncryptionTest.java

@@ -5,8 +5,7 @@
 import com.uid2.shared.model.EncryptedPayload;
 import com.uid2.shared.encryption.AesGcm;
 import com.uid2.shared.model.KeysetKey;
-import junit.framework.TestCase;
-import org.junit.Assert;
+import org.junit.jupiter.api.Test;
 
 import javax.crypto.SecretKey;
 import javax.crypto.spec.SecretKeySpec;
@@ -16,23 +15,26 @@
 import java.time.Instant;
 import java.util.concurrent.ThreadLocalRandom;
 
-public class EncryptionTest extends TestCase {
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotSame;
 
+class EncryptionTest {
     private int count = 0;
 
-    public void testEncryption() throws Exception {
-
+    @Test
+    void testEncryption() {
         final KeysetKey key = new KeysetKey(1, Random.getRandomKeyBytes(), Instant.now(), Instant.now(), Instant.now(), 10);
         final String testString = "[email protected]";
 
         final EncryptedPayload payload = AesCbc.encrypt(testString, key);
         final byte[] decrypted = AesCbc.decrypt(payload.getPayload(), key);
 
         final String decryptedString = new String(decrypted, StandardCharsets.UTF_8);
-        Assert.assertEquals(testString, decryptedString);
+        assertEquals(testString, decryptedString);
     }
 
-    public void testBenchmark() throws Exception {
+    @Test
+    void testBenchmark() {
         if (System.getenv("SLOW_DEV_URANDOM") != null) {
             System.err.println("ignore this test since environment variable SLOW_DEV_URANDOM is set");
             return;
@@ -73,10 +75,14 @@ public void testBenchmark() throws Exception {
         System.out.println("Decryption Overhead per Entry (ms) = " + overheadPerEntry / (1000000 * 1.0));
 
         // System.out.println("Entries = "+runs+", Base Operation Execution Time (ms) = " + baseTime/(1000000*1.0) + ", With Decryption(ms) = " + decryptTime/(1000000*1.0) + ", Overhead/Entry (ms) = "  + ((decryptTime-baseTime)/(runs*1.0)/(1000000*1.0)));
+    }
 
+    private void doSomething(EncryptedPayload ep) {
+        count++;
     }
 
-    public void testSecureRandom() throws NoSuchAlgorithmException {
+    @Test
+    void testSecureRandom() {
         if (System.getenv("SLOW_DEV_URANDOM") != null) {
             System.err.println("ignore this test since environment variable SLOW_DEV_URANDOM is set");
             return;
@@ -109,17 +115,15 @@ public void testSecureRandom() throws NoSuchAlgorithmException {
         }
     }
 
-    public void testNewInstancesReturned() throws NoSuchAlgorithmException {
+    @Test
+    void testNewInstancesReturned() throws NoSuchAlgorithmException {
         SecureRandom r1 = SecureRandom.getInstance("SHA1PRNG");
         SecureRandom r2 = SecureRandom.getInstance("SHA1PRNG");
         assertNotSame(r1, r2);
     }
 
-    public void doSomething(EncryptedPayload loag) {
-        count++;
-    }
-
-    public void testGCMEncryptionDecryption() {
+    @Test
+    void testGCMEncryptionDecryption() {
         final KeysetKey key = new KeysetKey(1, Random.getRandomKeyBytes(), Instant.now(), Instant.now(), Instant.now(), 10);
         String plaintxt = "hello world";
         EncryptedPayload payload = AesGcm.encrypt(plaintxt.getBytes(StandardCharsets.UTF_8), key);