Skip to content

Add a property to enable the check of control characters or not #9657

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
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add a property to enable the check of control characters or not #9657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions proxy/src/main/java/org/apache/rocketmq/proxy/config/ProxyConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,8 @@ public class ProxyConfig implements ConfigFile {

private boolean enableBatchAck = false;

private boolean enableControlCharacterCheck = true;

@Override
public void initData() {
parseDelayLevel();
Expand Down Expand Up @@ -1537,4 +1539,12 @@ public boolean isEnableMessageBodyEmptyCheck() {
public void setEnableMessageBodyEmptyCheck(boolean enableMessageBodyEmptyCheck) {
this.enableMessageBodyEmptyCheck = enableMessageBodyEmptyCheck;
}

public boolean isEnableControlCharacterCheck() {
return enableControlCharacterCheck;
}

public void setEnableControlCharacterCheck(boolean enableControlCharacterCheck) {
this.enableControlCharacterCheck = enableControlCharacterCheck;
}
}
2 changes: 1 addition & 1 deletion proxy/src/main/java/org/apache/rocketmq/proxy/grpc/v2/common/GrpcValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ public void validateTag(String tag) {
if (tag.contains("|")) {
throw new GrpcProxyException(Code.ILLEGAL_MESSAGE_TAG, "tag cannot contain '|'");
}
if (containControlCharacter(tag)) {
if (ConfigurationManager.getProxyConfig().isEnableControlCharacterCheck() && containControlCharacter(tag)) {
throw new GrpcProxyException(Code.ILLEGAL_MESSAGE_TAG, "tag cannot contain control character");
}
}
Expand Down
8 changes: 4 additions & 4 deletions proxy/src/main/java/org/apache/rocketmq/proxy/grpc/v2/producer/SendMessageActivity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ protected void validateMessageKey(String key) {
if (StringUtils.isBlank(key)) {
throw new GrpcProxyException(Code.ILLEGAL_MESSAGE_KEY, "key cannot be the char sequence of whitespace");
}
if (GrpcValidator.getInstance().containControlCharacter(key)) {
if (ConfigurationManager.getProxyConfig().isEnableControlCharacterCheck() && GrpcValidator.getInstance().containControlCharacter(key)) {
throw new GrpcProxyException(Code.ILLEGAL_MESSAGE_KEY, "key cannot contain control character");
}
}
Expand All @@ -169,7 +169,7 @@ protected void validateMessageGroup(String messageGroup) {
if (messageGroup.getBytes(StandardCharsets.UTF_8).length >= maxSize) {
throw new GrpcProxyException(Code.ILLEGAL_MESSAGE_GROUP, "message group exceed the max size " + maxSize);
}
if (GrpcValidator.getInstance().containControlCharacter(messageGroup)) {
if (ConfigurationManager.getProxyConfig().isEnableControlCharacterCheck() && GrpcValidator.getInstance().containControlCharacter(messageGroup)) {
throw new GrpcProxyException(Code.ILLEGAL_MESSAGE_GROUP, "message group cannot contain control character");
}
}
Expand Down Expand Up @@ -208,10 +208,10 @@ protected Map<String, String> buildMessageProperty(ProxyContext context, apache.
if (MessageConst.STRING_HASH_SET.contains(userPropertiesEntry.getKey())) {
throw new GrpcProxyException(Code.ILLEGAL_MESSAGE_PROPERTY_KEY, "property is used by system: " + userPropertiesEntry.getKey());
}
if (GrpcValidator.getInstance().containControlCharacter(userPropertiesEntry.getKey())) {
if (ConfigurationManager.getProxyConfig().isEnableControlCharacterCheck() && GrpcValidator.getInstance().containControlCharacter(userPropertiesEntry.getKey())) {
throw new GrpcProxyException(Code.ILLEGAL_MESSAGE_PROPERTY_KEY, "the key of property cannot contain control character");
}
if (GrpcValidator.getInstance().containControlCharacter(userPropertiesEntry.getValue())) {
if (ConfigurationManager.getProxyConfig().isEnableControlCharacterCheck() && GrpcValidator.getInstance().containControlCharacter(userPropertiesEntry.getValue())) {
throw new GrpcProxyException(Code.ILLEGAL_MESSAGE_PROPERTY_KEY, "the value of property cannot contain control character");
}
userPropertySize += userPropertiesEntry.getKey().getBytes(StandardCharsets.UTF_8).length;
Expand Down