Skip to content

feat[common]: add protocol entity check #4060

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
tomsun28 merged 5 commits into from
Mar 11, 2026
Merged

feat[common]: add protocol entity check #4060

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
841b672
feat[common]: add protocol entity check
yuluo-yx Mar 9, 2026
3581ba4
Merge branch 'master' into 0309-yuluo/feat
yuluo-yx Mar 9, 2026
1eab4a6
Merge branch 'master' into 0309-yuluo/feat
tomsun28 Mar 9, 2026
562ad92
Merge branch 'master' into 0309-yuluo/feat
yuluo-yx Mar 10, 2026
b39e9b0
Merge branch 'master' into 0309-yuluo/feat
tomsun28 Mar 11, 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
34 changes: 32 additions & 2 deletions ...mmon-core/src/main/java/org/apache/hertzbeat/common/entity/job/protocol/HttpProtocol.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,17 @@

package org.apache.hertzbeat.common.entity.job.protocol;

import static org.apache.hertzbeat.common.util.IpDomainUtil.validPort;
import static org.apache.hertzbeat.common.util.IpDomainUtil.validateIpDomain;

import java.util.List;
import java.util.Map;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.apache.commons.lang3.StringUtils;
import org.apache.hertzbeat.common.util.CommonUtil;

/**
* http protocol configuration
Expand Down Expand Up @@ -136,8 +141,33 @@ public static class Authorization {

@Override
public boolean isInvalid() {
if (!validateIpDomain(host) || !validPort(port)) {
return true;
}
if (StringUtils.isNotBlank(timeout) && !CommonUtil.isNumeric(timeout)) {
return true;
}
if (StringUtils.isNotBlank(ssl) && !"true".equalsIgnoreCase(ssl) && !"false".equalsIgnoreCase(ssl)) {
return true;
}
if (StringUtils.isNotBlank(method) && !isValidHttpMethod(method)) {
return true;
}
if (StringUtils.isNotBlank(enableUrlEncoding)
&& !"true".equalsIgnoreCase(enableUrlEncoding)
&& !"false".equalsIgnoreCase(enableUrlEncoding)) {
return true;
}
return false;
}

// todo: add
return true;
private boolean isValidHttpMethod(String method) {
return method.equalsIgnoreCase("get")
|| method.equalsIgnoreCase("post")
|| method.equalsIgnoreCase("put")
|| method.equalsIgnoreCase("delete")
|| method.equalsIgnoreCase("patch")
|| method.equalsIgnoreCase("head")
|| method.equalsIgnoreCase("options");
}
}
22 changes: 19 additions & 3 deletions ...mmon-core/src/main/java/org/apache/hertzbeat/common/entity/job/protocol/JdbcProtocol.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,16 @@

package org.apache.hertzbeat.common.entity.job.protocol;

import static org.apache.hertzbeat.common.util.IpDomainUtil.validPort;
import static org.apache.hertzbeat.common.util.IpDomainUtil.validateIpDomain;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.apache.commons.lang3.StringUtils;
import org.apache.hertzbeat.common.entity.job.SshTunnel;
import org.apache.hertzbeat.common.util.CommonUtil;

/**
* Database configuration information implemented by the common jdbc specification
Expand Down Expand Up @@ -82,8 +87,19 @@ public class JdbcProtocol implements CommonRequestProtocol, Protocol {

@Override
public boolean isInvalid() {

// todo: add
return true;
if (StringUtils.isBlank(url)) {
if (!validateIpDomain(host) || !validPort(port)) {
return true;
}
}
if (StringUtils.isNotBlank(timeout) && !CommonUtil.isNumeric(timeout)) {
return true;
}
if (StringUtils.isNotBlank(reuseConnection)
&& !"true".equalsIgnoreCase(reuseConnection)
&& !"false".equalsIgnoreCase(reuseConnection)) {
return true;
}
return false;
}
}
15 changes: 12 additions & 3 deletions ...n-core/src/main/java/org/apache/hertzbeat/common/entity/job/protocol/MongodbProtocol.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,15 @@

package org.apache.hertzbeat.common.entity.job.protocol;

import static org.apache.hertzbeat.common.util.IpDomainUtil.validPort;
import static org.apache.hertzbeat.common.util.IpDomainUtil.validateIpDomain;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.apache.commons.lang3.StringUtils;
import org.apache.hertzbeat.common.util.CommonUtil;

/**
* Mongodb Protocol
Expand Down Expand Up @@ -79,9 +84,13 @@ public class MongodbProtocol implements CommonRequestProtocol, Protocol {

@Override
public boolean isInvalid() {

// todo: add
return true;
if (!validateIpDomain(host) || !validPort(port)) {
return true;
}
if (StringUtils.isNotBlank(timeout) && !CommonUtil.isNumeric(timeout)) {
return true;
}
return false;
}

}
20 changes: 18 additions & 2 deletions ...mon-core/src/main/java/org/apache/hertzbeat/common/entity/job/protocol/RedisProtocol.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,16 @@

package org.apache.hertzbeat.common.entity.job.protocol;

import static org.apache.hertzbeat.common.util.IpDomainUtil.validPort;
import static org.apache.hertzbeat.common.util.IpDomainUtil.validateIpDomain;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.apache.commons.lang3.StringUtils;
import org.apache.hertzbeat.common.entity.job.SshTunnel;
import org.apache.hertzbeat.common.util.CommonUtil;

/**
* Redis Protocol
Expand Down Expand Up @@ -69,9 +74,20 @@ public class RedisProtocol implements CommonRequestProtocol, Protocol {

@Override
public boolean isInvalid() {
if (!validateIpDomain(host) || !validPort(port)) {
return true;
}
if (StringUtils.isNotBlank(timeout) && !CommonUtil.isNumeric(timeout)) {
return true;
}
if (StringUtils.isNotBlank(pattern) && !isValidPattern(pattern)) {
return true;
}
return false;
}

// todo: add
return true;
private boolean isValidPattern(String pattern) {
return "1".equals(pattern) || "2".equals(pattern) || "3".equals(pattern);
}

}
30 changes: 27 additions & 3 deletions ...ommon-core/src/main/java/org/apache/hertzbeat/common/entity/job/protocol/SshProtocol.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,15 @@

package org.apache.hertzbeat.common.entity.job.protocol;

import static org.apache.hertzbeat.common.util.IpDomainUtil.validPort;
import static org.apache.hertzbeat.common.util.IpDomainUtil.validateIpDomain;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.apache.commons.lang3.StringUtils;
import org.apache.hertzbeat.common.util.CommonUtil;

/**
* ssh Protocol parameter configuration
Expand Down Expand Up @@ -113,8 +118,27 @@ public class SshProtocol implements CommonRequestProtocol, Protocol {

@Override
public boolean isInvalid() {

// todo: add
return true;
if (!validateIpDomain(host) || !validPort(port)) {
return true;
}
if (StringUtils.isNotBlank(timeout) && !CommonUtil.isNumeric(timeout)) {
return true;
}
if (StringUtils.isNotBlank(reuseConnection)
&& !"true".equalsIgnoreCase(reuseConnection)
&& !"false".equalsIgnoreCase(reuseConnection)) {
return true;
}
if (StringUtils.isNotBlank(useProxy)
&& !"true".equalsIgnoreCase(useProxy)
&& !"false".equalsIgnoreCase(useProxy)) {
return true;
}
if ("true".equalsIgnoreCase(useProxy)) {
if (!validateIpDomain(proxyHost) || !validPort(proxyPort)) {
return true;
}
}
return false;
}
}
Loading
Loading