Added v4 UIDs

src/main/java/com/uid2/operator/model/IdentityEnvironment.java

@@ -4,7 +4,9 @@
 import com.uid2.operator.vertx.ClientInputValidationException;
 
 public enum IdentityEnvironment {
-    TEST(0), INTEG(1), PROD(2);
+    TEST(0),
+    INTEG(1),
+    PROD(2);
 
     private final int value;
 
@@ -34,4 +36,4 @@ public static IdentityEnvironment fromString(String value) {
             default -> throw new ClientInputValidationException("Invalid valid for IdentityEnvironment: " + value);
         };
     }
-}
+}

src/main/java/com/uid2/operator/model/IdentityRequest.java

@@ -10,8 +10,7 @@ public IdentityRequest(
             PublisherIdentity publisherIdentity,
             UserIdentity userIdentity,
             OptoutCheckPolicy tokenGeneratePolicy,
-            IdentityEnvironment identityEnvironment)
-    {
+            IdentityEnvironment identityEnvironment) {
         this.publisherIdentity = publisherIdentity;
         this.userIdentity = userIdentity;
         this.optoutCheckPolicy = tokenGeneratePolicy;

src/main/java/com/uid2/operator/model/IdentityScope.java

@@ -6,23 +6,29 @@ public enum IdentityScope {
     UID2(0),
     EUID(1);
 
-    public final int value;
+    private final int value;
 
-    IdentityScope(int value) { this.value = value; }
+    IdentityScope(int value) {
+        this.value = value;
+    }
+
+    public int getValue() {
+        return value;
+    }
 
     public static IdentityScope fromValue(int value) {
-        switch (value) {
-            case 0: return UID2;
-            case 1: return EUID;
-            default: throw new ClientInputValidationException("Invalid value for IdentityScope: " + value);
-        }
+        return switch (value) {
+            case 0 -> UID2;
+            case 1 -> EUID;
+            default -> throw new ClientInputValidationException("Invalid value for IdentityScope: " + value);
+        };
     }
 
     public static IdentityScope fromString(String str) {
-        switch (str.toLowerCase()) {
-            case "uid2": return UID2;
-            case "euid": return EUID;
-            default: throw new ClientInputValidationException("Invalid string for IdentityScope: " + str);
-        }
+        return switch (str.toLowerCase()) {
+            case "uid2" -> UID2;
+            case "euid" -> EUID;
+            default -> throw new ClientInputValidationException("Invalid string for IdentityScope: " + str);
+        };
     }
 }

src/main/java/com/uid2/operator/model/IdentityType.java

@@ -3,17 +3,24 @@
 import com.uid2.operator.vertx.ClientInputValidationException;
 
 public enum IdentityType {
-    Email(0), Phone(1);
+    Email(0),
+    Phone(1);
 
-    public final int value;
+    private final int value;
 
-    IdentityType(int value) { this.value = value; }
+    IdentityType(int value) {
+        this.value = value;
+    }
+
+    public int getValue() {
+        return value;
+    }
 
     public static IdentityType fromValue(int value) {
-        switch (value) {
-            case 0: return Email;
-            case 1: return Phone;
-            default: throw new ClientInputValidationException("Invalid valid for IdentityType: " + value);
-        }
+        return switch (value) {
+            case 0 -> Email;
+            case 1 -> Phone;
+            default -> throw new ClientInputValidationException("Invalid valid for IdentityType: " + value);
+        };
     }
 }

src/main/java/com/uid2/operator/model/IdentityVersion.java

@@ -0,0 +1,28 @@
+package com.uid2.operator.model;
+
+import com.uid2.operator.vertx.ClientInputValidationException;
+
+public enum IdentityVersion {
+    V2(-1), // V2 raw UIDs don't encode version
+    V3(0),
+    V4(1);
+
+    private final int value;
+
+    IdentityVersion(int value) {
+        this.value = value;
+    }
+
+    public int getValue() {
+        return value;
+    }
+
+    public static IdentityVersion fromValue(int value) {
+        return switch (value) {
+            case -1 -> V2;
+            case 0 -> V3;
+            case 1 -> V4;
+            default -> throw new ClientInputValidationException("Invalid valid for IdentityVersion: " + value);
+        };
+    }
+}

src/main/java/com/uid2/operator/model/KeyManager.java

@@ -16,7 +16,7 @@
 import java.util.stream.Collectors;
 
 public class KeyManager {
-    private static final Logger LOGGER = LoggerFactory.getLogger(UIDOperatorVerticle.class);
+    private static final Logger LOGGER = LoggerFactory.getLogger(KeyManager.class);
     private final IKeysetKeyStore keysetKeyStore;
     private final RotatingKeysetProvider keysetProvider;
 
@@ -76,7 +76,6 @@ public KeysetKey getKey(int keyId) {
         return this.keysetKeyStore.getSnapshot().getKey(keyId);
     }
 
-
     public List<KeysetKey> getKeysForSharingOrDsps() {
         Map<Integer, Keyset> keysetMap = this.keysetProvider.getSnapshot().getAllKeysets();
         List<KeysetKey> keys = keysetKeyStore.getSnapshot().getAllKeysetKeys();

src/main/java/com/uid2/operator/model/MapRequest.java

@@ -12,8 +12,7 @@ public MapRequest(
             UserIdentity userIdentity,
             OptoutCheckPolicy optoutCheckPolicy,
             Instant asOf,
-            IdentityEnvironment identityEnvironment)
-    {
+            IdentityEnvironment identityEnvironment) {
         this.userIdentity = userIdentity;
         this.optoutCheckPolicy = optoutCheckPolicy;
         this.asOf = asOf;

src/main/java/com/uid2/operator/model/UserIdentity.java

@@ -2,7 +2,6 @@
 
 import java.time.Instant;
 import java.util.Arrays;
-import java.util.Objects;
 
 public class UserIdentity {
     public final IdentityScope identityScope;

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

@@ -8,7 +8,9 @@
 import java.util.Base64;
 import java.util.UUID;
 
-public class EncodingUtils {
+public final class EncodingUtils {
+    private EncodingUtils() {
+    }
 
     public static String toBase64String(byte[] b) {
         return Base64.getEncoder().encodeToString(b);
@@ -18,9 +20,13 @@ public static byte[] toBase64(byte[] b) {
         return Base64.getEncoder().encode(b);
     }
 
-    public static byte[] fromBase64(String s) { return Base64.getDecoder().decode(s); }
+    public static byte[] fromBase64(String s) {
+        return Base64.getDecoder().decode(s);
+    }
 
-    public static byte[] fromBase64(byte[] b) { return Base64.getDecoder().decode(b); }
+    public static byte[] fromBase64(byte[] b) {
+        return Base64.getDecoder().decode(b);
+    }
 
     public static String getSha256(String input, String salt) {
         return toBase64String(getSha256Bytes(input, salt));
@@ -34,10 +40,18 @@ public static byte[] getSha256Bytes(String input) {
         return getSha256Bytes(input, null);
     }
 
+    public static byte[] getSha256Bytes(byte[] input) {
+        return getSha256Bytes(input, null);
+    }
+
     public static byte[] getSha256Bytes(String input, String salt) {
+        return getSha256Bytes(input.getBytes(), salt);
+    }
+
+    public static byte[] getSha256Bytes(byte[] input, String salt) {
         try {
             MessageDigest md = MessageDigest.getInstance("SHA-256");
-            md.update(input.getBytes());
+            md.update(input);
             if (salt != null) {
                 md.update(salt.getBytes());
             }
@@ -47,34 +61,6 @@ public static byte[] getSha256Bytes(String input, String salt) {
         }
     }
 
-    public static String generateIdGuid(String value) {
-        byte[] b = value.getBytes(Charset.forName("UTF8"));
-        long high = 0L;
-        high = high | (long) b[0] << (7 * 8);
-        high = high | (long) b[1] << (6 * 8);
-        high = high | (long) b[2] << (5 * 8);
-        high = high | (long) b[3] << (5 * 8);
-        high = high | (long) b[4] << (3 * 8);
-        high = high | (long) b[5] << (2 * 8);
-        high = high | (long) b[6] << (1 * 8);
-        high = high | (long) b[7];
-
-        long low = 0;
-        low = low | (long) b[8] << (7 * 8);
-        low = low | (long) b[9] << (6 * 8);
-        low = low | (long) b[10] << (5 * 8);
-        low = low | (long) b[11] << (4 * 8);
-        low = low | (long) b[12] << (3 * 8);
-        low = low | (long) b[13] << (2 * 8);
-        low = low | (long) b[14] << (1 * 8);
-        low = low | (long) b[15];
-
-        String uid = new UUID(high, low).toString();
-
-        return uid;
-
-    }
-
     public static Instant NowUTCMillis() {
         return Instant.now().truncatedTo(ChronoUnit.MILLIS);
     }
@@ -84,21 +70,21 @@ public static Instant NowUTCMillis(Clock clock) {
     }
 
     public static byte[] fromHexString(String hs) throws NumberFormatException {
-        if(hs.length() % 2 == 1) {
+        if (hs.length() % 2 == 1) {
             throw new NumberFormatException("input " + hs.substring(0, 5) + "... is not a valid hex string - odd length");
         }
 
         byte[] s = new byte[hs.length() / 2];
-        for(int i = 0; i < hs.length(); i++) {
+        for (int i = 0; i < hs.length(); i++) {
             int v; char c = hs.charAt(i);
-            if(c >= '0' && c <= '9') v = c - '0';
-            else if(c >= 'A' && c <= 'F') v = c - 'A' + 10;
-            else if(c >= 'a' && c <= 'f') v = c - 'a' + 10;
+            if (c >= '0' && c <= '9') v = c - '0';
+            else if (c >= 'A' && c <= 'F') v = c - 'A' + 10;
+            else if (c >= 'a' && c <= 'f') v = c - 'a' + 10;
             else throw new NumberFormatException("input " + hs.substring(0, 5) + "... is not a valid hex string - invalid character");
             if (i % 2 == 0) {
-                s[i / 2] = (byte) (s[i / 2] | (byte)((v << 4) & 0xFF));
+                s[i / 2] = (byte) (s[i / 2] | (byte) ((v << 4) & 0xFF));
             } else {
-                s[i / 2] = (byte) (s[i / 2] | (byte)(v & 0xFF));
+                s[i / 2] = (byte) (s[i / 2] | (byte) (v & 0xFF));
             }
         }
 

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

@@ -231,7 +231,6 @@ public AdvertisingToken decodeAdvertisingTokenV2(Buffer b) {
         } catch (Exception e) {
             throw new RuntimeException("Couldn't decode advertisingTokenV2", e);
         }
-
     }
 
     public AdvertisingToken decodeAdvertisingTokenV3orV4(Buffer b, byte[] bytes, TokenVersion tokenVersion) {
@@ -253,8 +252,7 @@ public AdvertisingToken decodeAdvertisingTokenV3orV4(Buffer b, byte[] bytes, Tok
         final IdentityScope identityScope = id.length == 32 ? IdentityScope.UID2 : decodeIdentityScopeV3(id[0]);
         final IdentityType identityType = id.length == 32 ? IdentityType.Email : decodeIdentityTypeV3(id[0]);
 
-        if (id.length > 32)
-        {
+        if (id.length > 32) {
             if (identityScope != decodeIdentityScopeV3(b.getByte(0))) {
                 throw new ClientInputValidationException("Failed decoding advertisingTokenV3: Identity scope mismatch");
             }
@@ -338,7 +336,6 @@ public static String bytesToBase64Token(byte[] advertisingTokenBytes, TokenVersi
 
     @Override
     public IdentityTokens encode(AdvertisingToken advertisingToken, RefreshToken refreshToken, Instant refreshFrom, Instant asOf) {
-
         final byte[] advertisingTokenBytes = encode(advertisingToken, asOf);
         final String base64AdvertisingToken = bytesToBase64Token(advertisingTokenBytes, advertisingToken.version);
 
@@ -367,16 +364,16 @@ private byte[] encryptIdentityV2(PublisherIdentity publisherIdentity, UserIdenti
         }
     }
 
-    static private byte encodeIdentityTypeV3(UserIdentity userIdentity) {
-        return (byte) (TokenUtils.encodeIdentityScope(userIdentity.identityScope) | (userIdentity.identityType.value << 2) | 3);
+    private static byte encodeIdentityTypeV3(UserIdentity userIdentity) {
+        return (byte) (TokenUtils.encodeIdentityScope(userIdentity.identityScope) | (userIdentity.identityType.getValue() << 2) | 3);
         // "| 3" is used so that the 2nd char matches the version when V3 or higher. Eg "3" for V3 and "4" for V4
     }
 
-    static private IdentityScope decodeIdentityScopeV3(byte value) {
+    private static IdentityScope decodeIdentityScopeV3(byte value) {
         return IdentityScope.fromValue((value & 0x10) >> 4);
     }
 
-    static private IdentityType decodeIdentityTypeV3(byte value) {
+    private static IdentityType decodeIdentityTypeV3(byte value) {
         return IdentityType.fromValue((value & 0xf) >> 2);
     }
 
@@ -392,7 +389,7 @@ static PublisherIdentity decodePublisherIdentityV3(Buffer b, int offset) {
 
     static void encodeOperatorIdentityV3(Buffer b, OperatorIdentity operatorIdentity) {
         b.appendInt(operatorIdentity.siteId);
-        b.appendByte((byte)operatorIdentity.operatorType.value);
+        b.appendByte((byte) operatorIdentity.operatorType.value);
         b.appendInt(operatorIdentity.operatorVersion);
         b.appendInt(operatorIdentity.operatorKeyId);
     }

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

@@ -10,7 +10,6 @@
 import java.util.List;
 
 public interface IUIDOperatorService {
-
     IdentityTokens generateIdentity(IdentityRequest request, Duration refreshIdentityAfter, Duration refreshExpiresAfter, Duration identityExpiresAfter);
 
     RefreshResponse refreshIdentity(RefreshToken token, Duration refreshIdentityAfter, Duration refreshExpiresAfter, Duration identityExpiresAfter, IdentityEnvironment env);
@@ -25,6 +24,4 @@ public interface IUIDOperatorService {
     void invalidateTokensAsync(UserIdentity userIdentity, Instant asOf, String uidTraceId, IdentityEnvironment env, Handler<AsyncResult<Instant>> handler);
 
     boolean advertisingTokenMatches(String advertisingToken, UserIdentity userIdentity, Instant asOf, IdentityEnvironment env);
-
-    Instant getLatestOptoutEntry(UserIdentity userIdentity, Instant asOf);
 }