[improve] improve jndi validation #3358
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
- Added
validateJmxUrlto block unsafe protocols and injection patterns - Introduced
isValidHostnameregex checks and port range enforcement in preCheck and at connection time - Hardened connection setup with security properties and timeouts
Comments suppressed due to low confidence (6)
hertzbeat-collector-basic/src/main/java/org/apache/hertzbeat/collector/collect/jmx/JmxCollectImpl.java:116
- The disallowedPatterns array includes 'rmi:', which will match the valid 'service:jmx:rmi:' prefix and reject legitimate URLs. Refine this check by excluding the JMX prefix or using a more precise protocol matcher.
String[] disallowedPatterns = { "ldap:", "rmi:", "iiop:", "nis:", "dns:", "corbaname:", "http:", "https:" };
hertzbeat-collector-basic/src/main/java/org/apache/hertzbeat/collector/collect/jmx/JmxCollectImpl.java:124
- The check for ':/', which catches '://', is too broad and will flag valid JMX URLs. Limit this pattern detection to only truly unsafe sequences or remove the ':/'.
if (url.contains("${") || url.contains("$[") || url.contains(":#") || url.contains(":/")) {
hertzbeat-collector-basic/src/main/java/org/apache/hertzbeat/collector/collect/jmx/JmxCollectImpl.java:142
- The hostname regex requires at least one dot, so single-label hosts like 'localhost' will be rejected. Adjust the pattern to allow single-label hostnames or common local names.
String hostnameRegex = "^([a-zA-Z0-9][-a-zA-Z0-9]*\\.)+[a-zA-Z0-9][-a-zA-Z0-9]*$|^(\\d{1,3}\\.){3}\\d{1,3}$|^([0-9a-fA-F]{0,4}:){2,7}[0-9a-fA-F]{0,4}$";
hertzbeat-collector-basic/src/main/java/org/apache/hertzbeat/collector/collect/jmx/JmxCollectImpl.java:100
- [nitpick] Host and port validation logic is duplicated between preCheck and getConnectSession. Extract a shared validation helper to reduce duplication and keep checks consistent.
Assert.isTrue(isValidHostname(host), "Invalid hostname format");
hertzbeat-collector-basic/src/main/java/org/apache/hertzbeat/collector/collect/jmx/JmxCollectImpl.java:323
- [nitpick] Logging only the exception message loses stack trace context. Use
log.error("Failed to connect to JMX server", e)to capture the full exception.
log.error("Failed to connect to JMX server: {}", e.getMessage());
hertzbeat-collector-basic/src/main/java/org/apache/hertzbeat/collector/collect/jmx/JmxCollectImpl.java:111
- New validation logic in
validateJmxUrlandisValidHostnameshould have dedicated unit tests covering both allowed and disallowed cases to ensure full test coverage.
private void validateJmxUrl(String url) throws IllegalArgumentException {
tomsun28
reviewed
May 18, 2025
...collector-basic/src/main/java/org/apache/hertzbeat/collector/collect/jmx/JmxCollectImpl.java
Outdated
Show resolved
Hide resolved
tomsun28
reviewed
May 18, 2025
...collector-basic/src/main/java/org/apache/hertzbeat/collector/collect/jmx/JmxCollectImpl.java
Outdated
Show resolved
Hide resolved
tomsun28
reviewed
May 18, 2025
...collector-basic/src/main/java/org/apache/hertzbeat/collector/collect/jmx/JmxCollectImpl.java
Outdated
Show resolved
Hide resolved
…g/apache/hertzbeat/collector/collect/jmx/JmxCollectImpl.java Signed-off-by: tomsun28 <tomsun28@outlook.com>
…g/apache/hertzbeat/collector/collect/jmx/JmxCollectImpl.java Signed-off-by: tomsun28 <tomsun28@outlook.com>
…g/apache/hertzbeat/collector/collect/jmx/JmxCollectImpl.java Signed-off-by: tomsun28 <tomsun28@outlook.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3FD5
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's changed?
Enhanced URL Validation
service:jmx:rmi:protocol${,$[, etc.)Hostname and Port Validation
Connection Hardening
Java Compatibility Fixes
instanceof Type var) with traditional castingChecklist
Add or update API