Use tdbr claim to route telemetry traffic to EU region, Fixes AB#3200872

changelog.txt

@@ -1,5 +1,6 @@
 vNext
 ----------
+- [MINOR] Use tdbr claim to route telemetry traffic to EU region (#2679)
 - [MAJOR] Add KeyStoreBackedSecretKeyProvider (#2674)
 - [MINOR] Add Open Id configuration issuer validation reporting in OpenIdProviderConfigurationClient (#2751)
 - [MINOR] Add helper method to record elapsed time (#2768)

common4j/src/main/com/microsoft/identity/common/java/flighting/CommonFlight.java

@@ -146,6 +146,11 @@ public enum CommonFlight implements IFlightConfig {
      */
     ENABLE_WEB_CP_IN_WEBVIEW("EnableWebCpInWebView", false),
 
+    /**
+     * Flight to enable using the new EU TDBR Claim sent through ClientInfo
+     */
+    ENABLE_USING_TDBR_CLAIM_FOR_EU_ROUTING("EnableUsingTdbrClaimForEuRouting", true),
+
     /**
      * Flight to enable the Playstore URL launch for broker apps.
      */

common4j/src/main/com/microsoft/identity/common/java/opentelemetry/AttributeName.java

@@ -121,6 +121,13 @@ public enum AttributeName {
      */
     correlation_id,
 
+    /**
+     * The correlation id sent from client app.
+     * This is a second attribute name to denote EUDB compliance.
+     * We will only emit this value when we have a tenant id, or when we are in unauthenticated scenarios.
+     */
+    correlation_id_v2,
+
     /**
      * Indicates if token was return from token cache
      */

common4j/src/main/com/microsoft/identity/common/java/opentelemetry/EUClaimStorageUtil.kt

@@ -0,0 +1,89 @@
+//  Copyright (c) Microsoft Corporation.
+//  All rights reserved.
+//
+//  This code is licensed under the MIT License.
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files(the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions :
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
+package com.microsoft.identity.common.java.opentelemetry
+
+import com.microsoft.identity.common.java.flighting.CommonFlight
+import com.microsoft.identity.common.java.flighting.CommonFlightsManager.getFlightsProvider
+import com.microsoft.identity.common.java.interfaces.IStorageSupplier
+import com.microsoft.identity.common.java.logging.Logger
+import com.microsoft.identity.common.java.providers.microsoft.azureactivedirectory.ClientInfo
+import com.microsoft.identity.common.java.util.StringUtil
+
+/**
+ * Utility class for storing telemetry region TDBR claims by tenant.
+ */
+class EUClaimStorageUtil {
+    companion object {
+        private val TAG = EUClaimStorageUtil::class.java.simpleName
+
+        /**
+         * Store telemetry region by tenant.
+         *
+         * @param clientInfo the client info containing tenant information and tdbr claim
+         */
+        fun storeTelemetryRegionByTenant(
+            supplier: IStorageSupplier,
+            clientInfo: ClientInfo
+        ) {
+            val methodTag = "$TAG:storeTelemetryRegionByTenant"
+
+            if (!getFlightsProvider().isFlightEnabled(CommonFlight.ENABLE_USING_TDBR_CLAIM_FOR_EU_ROUTING)) {
+                // If flight is not enabled, just return, don't store anything
+                return;
+            }
+
+            val tenantId = clientInfo.utid
+            val tdbrClaim = clientInfo.tdbrClaim
+
+            if (StringUtil.isNullOrEmpty(tenantId)) {
+                Logger.warn(
+                    methodTag,
+                    "tenantId is null or empty. Not storing telemetry region by tenant."
+                )
+                return
+            }
+
+            if (StringUtil.isNullOrEmpty(tdbrClaim)) {
+                Logger.warn(
+                    methodTag,
+                    "Received no tdbr claim, not storing anything in shared preferences.."
+                )
+                return
+            }
+
+            // Store the tdbr claim for a specific tenant ID
+            Logger.info(
+                methodTag,
+                "Storing telemetry region by tenant: $tenantId, TDBR Claim: $tdbrClaim"
+            )
+            val tdbrValueStore = supplier.getUnencryptedNameValueStore(
+                ClientInfo.TDBR_CLAIM,
+                String::class.java
+            )
+            tdbrValueStore.put(tenantId, tdbrClaim)
+
+            // Attach tenant id to the current span
+            SpanExtension.current().setAttribute(AttributeName.tenant_id.name, tenantId)
+        }
+    }
+}

common4j/src/main/com/microsoft/identity/common/java/providers/microsoft/azureactivedirectory/ClientInfo.java

@@ -28,6 +28,8 @@
 import com.microsoft.identity.common.java.base64.Base64Util;
 import com.microsoft.identity.common.java.exception.ErrorStrings;
 import com.microsoft.identity.common.java.exception.ServiceException;
+import com.microsoft.identity.common.java.opentelemetry.AttributeName;
+import com.microsoft.identity.common.java.opentelemetry.SpanExtension;
 import com.microsoft.identity.common.java.util.JsonUtil;
 import com.microsoft.identity.common.java.util.StringUtil;
 
@@ -44,6 +46,7 @@ public class ClientInfo implements Serializable {
 
     private static final String UNIQUE_IDENTIFIER = "uid";
     private static final String UNIQUE_TENANT_IDENTIFIER = "utid";
+    public static final String TDBR_CLAIM = "xms_tdbr";
     private static final long serialVersionUID = 3326461566190095403L;
 
     /**
@@ -56,6 +59,11 @@ public class ClientInfo implements Serializable {
      */
     private String mUtid;
 
+    /**
+     * TDBR Claim, denotes what region the user belongs to.
+     */
+    private String mTdbrClaim;
+
     private String mRawClientInfo;
 
     /**
@@ -80,6 +88,8 @@ public ClientInfo(@NonNull String rawClientInfo) throws ServiceException {
 
         mUid = clientInfoItems.get(ClientInfo.UNIQUE_IDENTIFIER);
         mUtid = clientInfoItems.get(ClientInfo.UNIQUE_TENANT_IDENTIFIER);
+        SpanExtension.current().setAttribute(AttributeName.tenant_id.name(), mUtid);
+        mTdbrClaim = clientInfoItems.get(ClientInfo.TDBR_CLAIM);
         mRawClientInfo = rawClientInfo;
     }
 
@@ -101,6 +111,15 @@ public String getUtid() {
         return mUtid;
     }
 
+    /**
+     * Gets the TDBR claim.
+     *
+     * @return The TDBR claim to get.
+     */
+    public String getTdbrClaim() {
+        return mTdbrClaim;
+    }
+
     /**
      * Returns the raw String underlying this object.
      *