Skip to content

Mask secret query parameter when it is the last parameter #4055

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

Open
vasiliy-mikhailov wants to merge 2 commits into
base: develop
Choose a base branch
from
+30 −2
Open

Mask secret query parameter when it is the last parameter #4055

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77c9cc6
Mask secret query parameter when it is the last parameter
vasiliy-mikhailov Jun 24, 2026
331949d
Mask the secret query parameter regardless of position and value
vasiliy-mikhailov Jun 26, 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
4 changes: 2 additions & 2 deletions weixin-java-common/src/main/java/me/chanjar/weixin/common/util/DataUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ public class DataUtils {
*/
public static <E> E handleDataWithSecret(E data) {
E dataForLog = data;
if(data instanceof String && StringUtils.contains((String)data, "&secret=")){
dataForLog = (E) RegExUtils.replaceAll((String)data,"&secret=\\w+&","&secret=******&");
if (data instanceof String && StringUtils.contains((String) data, "secret=")) {
dataForLog = (E) RegExUtils.replaceAll((String) data, "(^|[?&])secret=[^&]*", "$1secret=******");
}
return dataForLog;
}
Expand Down
28 changes: 28 additions & 0 deletions weixin-java-common/src/test/java/me/chanjar/weixin/common/util/DataUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,32 @@ public void testHandleDataWithSecret() {
final String s = DataUtils.handleDataWithSecret(data);
assertTrue(s.contains("&secret=******&"));
}

@Test
public void testHandleDataWithSecretAtEnd() {
// Secret is the last parameter in the query string, so there is no trailing &
String data = "appid=wx123&secret=abc123";
final String s = DataUtils.handleDataWithSecret(data);
assertFalse(s.contains("abc123"), "Secret at the end of the string should be masked");
assertTrue(s.contains("secret=******"), "Secret should be replaced with asterisks");
}

@Test
public void testHandleDataWithSecretAsFirstParam() {
// Secret is the first/only parameter, so there is no leading &
String data = "secret=abc123&appid=wx123";
final String s = DataUtils.handleDataWithSecret(data);
assertFalse(s.contains("abc123"), "Secret as the first parameter should be masked");
assertTrue(s.contains("secret=******"), "Secret should be replaced with asterisks");
}

@Test
public void testHandleDataWithSecretEncodedValue() {
// The secret value contains URL-encoded and non-word characters; the whole value must be masked
String data = "appid=wx123&secret=abc%2Fdef-.+ghi&grant_type=client_credential";
final String s = DataUtils.handleDataWithSecret(data);
assertFalse(s.contains("def"), "The full secret value must be masked, including after non-word characters");
assertFalse(s.contains("%2F"), "Encoded characters in the secret must be masked too");
assertTrue(s.contains("&secret=******&"), "Secret should be replaced with asterisks");
}
}