Skip to content

W-22917333: Rename beacon_child_consumer_{key,secret} to auto_installed_app_org_consumer_{key,secret} #2923

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wmathurin merged 3 commits into from
Jun 11, 2026
Merged

W-22917333: Rename beacon_child_consumer_{key,secret} to auto_installed_app_org_consumer_{key,secret} #2923

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4602aad
W-22917333: Rename token endpoint wire keys beacon_child_consumer_{ke…
wmathurin Jun 10, 2026
dc62d22
W-22917333: Fall back to beacon_child_consumer_{key,secret} if new fi…
wmathurin Jun 10, 2026
113d04f
W-22917333: Redact both old and new consumer secret field names in logs
wmathurin Jun 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion libs/SalesforceAnalytics/src/com/salesforce/androidsdk/analytics/logger/LogRedactor.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,12 @@ package com.salesforce.androidsdk.analytics.logger

private const val VISIBLE_CHARS = 4

// TODO: Remove beacon_child_consumer_secret from pattern once server version 264 has rolled out everywhere.
private val SENSITIVE_JSON_PATTERN = Regex(
pattern = """("(?:access_token|refresh_token|id_token|csrf_token|sid""" +
"""|lightning_sid|visualforce_sid|content_sid|parent_sid""" +
"""|cookie-sid_Client|cookie-clientSrc""" +
"""|beacon_child_consumer_secret)"\s*:\s*")([^"]+)(")""",
"""|auto_installed_app_org_consumer_secret|beacon_child_consumer_secret)"\s*:\s*")([^"]+)(")""",
option = RegexOption.IGNORE_CASE,
)

Expand Down
4 changes: 2 additions & 2 deletions libs/SalesforceSDK/src/com/salesforce/androidsdk/accounts/UserAccount.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ public class UserAccount {
public static final String CLIENT_ID = "clientId";
public static final String PARENT_SID = "parentSid";
public static final String TOKEN_FORMAT = "tokenFormat";
public static final String BEACON_CHILD_CONSUMER_KEY = "beacon_child_consumer_key";
public static final String BEACON_CHILD_CONSUMER_SECRET = "beacon_child_consumer_secret";
public static final String BEACON_CHILD_CONSUMER_KEY = "auto_installed_app_org_consumer_key";
public static final String BEACON_CHILD_CONSUMER_SECRET = "auto_installed_app_org_consumer_secret";
public static final String SCOPE = "scope";

private static final String TAG = "UserAccount";
Expand Down
4 changes: 2 additions & 2 deletions libs/SalesforceSDK/src/com/salesforce/androidsdk/auth/AuthenticatorService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ public class AuthenticatorService extends Service {
public static final String KEY_SID_COOKIE_NAME = "sidCookieName";
public static final String KEY_PARENT_SID = "parentSid";
public static final String KEY_TOKEN_FORMAT = "tokenFormat";
public static final String KEY_BEACON_CHILD_CONSUMER_KEY = "beacon_child_consumer_key";
public static final String KEY_BEACON_CHILD_CONSUMER_SECRET = "beacon_child_consumer_secret";
public static final String KEY_BEACON_CHILD_CONSUMER_KEY = "auto_installed_app_org_consumer_key";
public static final String KEY_BEACON_CHILD_CONSUMER_SECRET = "auto_installed_app_org_consumer_secret";
public static final String KEY_SCOPE = "scope";

private static final String TAG = "AuthenticatorService";
Expand Down
12 changes: 10 additions & 2 deletions libs/SalesforceSDK/src/com/salesforce/androidsdk/auth/OAuth2.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,8 +213,11 @@ public class OAuth2 {
private static final String SID_COOKIE_NAME = "sidCookieName";
private static final String PARENT_SID = "parent_sid";
private static final String TOKEN_FORMAT = "token_format";
private static final String BEACON_CHILD_CONSUMER_SECRET = "beacon_child_consumer_secret";
private static final String BEACON_CHILD_CONSUMER_KEY = "beacon_child_consumer_key";
private static final String BEACON_CHILD_CONSUMER_SECRET = "auto_installed_app_org_consumer_secret";
private static final String BEACON_CHILD_CONSUMER_KEY = "auto_installed_app_org_consumer_key";
// TODO: Remove legacy fallback constants once server version 264 has rolled out everywhere.
private static final String LEGACY_BEACON_CHILD_CONSUMER_SECRET = "beacon_child_consumer_secret";
private static final String LEGACY_BEACON_CHILD_CONSUMER_KEY = "beacon_child_consumer_key";

public static final DateFormat TIMESTAMP_FORMAT;
static {
Expand Down Expand Up @@ -1000,11 +1003,16 @@ public TokenEndpointResponse(Response response, List<String> additionalOauthKeys
tokenFormat = parsedResponse.optString(TOKEN_FORMAT);

// Beacon child fields expected when using a beacon app and web server flow
// TODO: Remove LEGACY_BEACON_CHILD_CONSUMER_* fallback once server version 264 has rolled out everywhere.

@wmathurin wmathurin Jun 10, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That way we can go against older instances and it should still work.

if (parsedResponse.has(BEACON_CHILD_CONSUMER_KEY)) {
beaconChildConsumerKey = parsedResponse.getString(BEACON_CHILD_CONSUMER_KEY);
} else if (parsedResponse.has(LEGACY_BEACON_CHILD_CONSUMER_KEY)) {
beaconChildConsumerKey = parsedResponse.getString(LEGACY_BEACON_CHILD_CONSUMER_KEY);
}
if (parsedResponse.has(BEACON_CHILD_CONSUMER_SECRET)) {
beaconChildConsumerSecret = parsedResponse.getString(BEACON_CHILD_CONSUMER_SECRET);
} else if (parsedResponse.has(LEGACY_BEACON_CHILD_CONSUMER_SECRET)) {
beaconChildConsumerSecret = parsedResponse.getString(LEGACY_BEACON_CHILD_CONSUMER_SECRET);
}
scope = parsedResponse.optString(SCOPE);

Expand Down
12 changes: 12 additions & 0 deletions ...rceAnalyticsTest/src/com/salesforce/androidsdk/analytics/logger/SalesforceLoggerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,8 +236,20 @@ public void testRedactParentSid() {
Assert.assertEquals("parent_sid should be redacted", expected, SalesforceLogger.redact(input));
}

/**
* Test that auto_installed_app_org_consumer_secret is redacted in JSON.
*/
@Test
public void testRedactAutoInstalledAppOrgConsumerSecret() {
final String value = randomString(11);
final String input = "{\"auto_installed_app_org_consumer_secret\":\"" + value + "\"}";
final String expected = "{\"auto_installed_app_org_consumer_secret\":\"" + expectedMask(value) + "\"}";
Assert.assertEquals("auto_installed_app_org_consumer_secret should be redacted", expected, SalesforceLogger.redact(input));
}

/**
* Test that beacon_child_consumer_secret is redacted in JSON.
* TODO: Remove once server version 264 has rolled out everywhere.
*/
@Test
public void testRedactBeaconChildConsumerSecret() {
Expand Down
4 changes: 2 additions & 2 deletions libs/test/SalesforceSDKTest/src/com/salesforce/androidsdk/accounts/UserAccountTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -655,8 +655,8 @@ private OAuth2.TokenEndpointResponse createTokenEndpointResponseLikeUserAgentFlo

private OAuth2.TokenEndpointResponse createTokenEndpointResponseLikeWebServerFlow() {
Map<String, String> params = createTokenEndpointParams();
params.put("beacon_child_consumer_key", TEST_BEACON_CHILD_CONSUMER_KEY);
params.put("beacon_child_consumer_secret", TEST_BEACON_CHILD_CONSUMER_SECRET);
params.put("auto_installed_app_org_consumer_key", TEST_BEACON_CHILD_CONSUMER_KEY);
params.put("auto_installed_app_org_consumer_secret", TEST_BEACON_CHILD_CONSUMER_SECRET);
JSONObject responseJson = new JSONObject(params);
MediaType mediaType = MediaType.parse("application/json");
ResponseBody responseBody = ResponseBody.create(responseJson.toString(), mediaType);
Expand Down
Loading