Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,8 @@ public enum ErrorCodeEnum {

MODULE_NOT_FOUND(6001, "Module does not exist/no operation authority"),
MODULE_INFO_INCORRECT(6002, "Module info was incorrect"),
MODULE_COMMAND_NOT_IN_WHITELIST(6003,
"Command validation failed: '%s'"),
Comment thread
spiritxishi marked this conversation as resolved.
Outdated

PACKAGE_NOT_FOUND(7001, "Package does not exist/no operation authority"),
PACKAGE_INFO_INCORRECT(7002, "Package info was incorrect"),
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,388 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.apache.inlong.manager.service.module;

import org.apache.inlong.manager.pojo.module.ModuleDTO;
import org.apache.inlong.manager.pojo.module.ModuleRequest;

import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Objects;
import java.util.Set;

/**
* Manager-side command whitelist validator. Validates that command names (argv[0]) in module
* commands (start/stop/check/install/uninstall) are in the allowed whitelist. This catches
* misconfiguration at save time rather than waiting until the agent tries to execute.
*
* <p>Unlike the agent-side validator, this class does <b>not</b> perform path-under-root
* checks, which are filesystem-dependent and only meaningful at the agent runtime.
*
* <p>Whitelist baseline:
* <pre>{@code
* cd, sh, bash, ps, grep, awk, kill, rm, mkdir, cp, mv, ln,
* tar, unzip, chmod, chown, echo, cat, test, [, true, false, java
* }</pre>
*
* <p>Extend via {@code module.command.extraWhitelist} (comma-separated) in application
* properties, e.g.: {@code module.command.extraWhitelist=python3,nohup,curl}
*/
@Component
public class ModuleCommandValidator {
Comment thread
spiritxishi marked this conversation as resolved.

private static final Logger LOGGER = LoggerFactory.getLogger(ModuleCommandValidator.class);

/** Baseline argv[0] whitelist — kept in sync with agent-side ModuleCommandValidator. */
private static final Set<String> BASELINE_WHITELIST = buildImmutableSet(
"cd", "sh", "bash", "ps", "grep", "awk", "kill", "rm", "mkdir", "cp", "mv", "ln",
"tar", "unzip", "chmod", "chown", "echo", "cat", "test", "[", "true", "false", "java");

/**
* Metacharacter substring blacklist — kept in sync with agent-side
* {@code ModuleCommandValidator.META_CHAR_BLACKLIST}. These characters indicate shell
* injection attempts (command substitution, chaining, redirection, escaping). Unlike
* path-under-root checks, metacharacter validation is filesystem-independent and
* belongs on both the Manager and Agent side.
*/
private static final String[] META_CHAR_BLACKLIST = new String[]{
"`", "$(", "${", "&&", "||", ">>", ">", "<", "\\", "\u0000",
/*
* glob wildcards — Agent uses ProcessBuilder without shell, so '*' and '?' are NOT expanded. Passing e.g.
* 'rm *.log' as argv[1] would delete a literal file named "*.log" (or silently no-op), which is far more
* dangerous than an explicit error. Reject them here with a clear hint.
*/
"*", "?"
};

/** Extra whitelist entries from Spring config, comma-separated. */
@Value("${module.command.extraWhitelist:}")
private String extraWhitelist;
Comment thread
fuweng11 marked this conversation as resolved.

/** Whitelist enforcement mode: STRICT (block), WARN (log only), OFF (skip). */
@Value("${module.command.whitelistMode:WARN}")
private String whitelistModeConfig;
Comment thread
spiritxishi marked this conversation as resolved.
Outdated

/**
* Whitelist enforcement mode.
*
* <ul>
* <li>{@code STRICT} — save + update both block non-whitelisted commands.</li>
* <li>{@code WARN} — save blocks, update only logs a warning (for
* gradually tightening existing modules).</li>
* <li>{@code OFF} — all validation is skipped.</li>
* </ul>
*/
public enum WhitelistMode {

STRICT, WARN, OFF;

public static WhitelistMode fromConfig(String val) {
if (StringUtils.isBlank(val)) {
return WARN;
}
String upper = val.trim().toUpperCase();
try {
return valueOf(upper);
} catch (IllegalArgumentException e) {
LOGGER.warn("ModuleCommandValidator: invalid module.command.whitelistMode '{}',"
+ " falling back to STRICT", val);
return STRICT;
}
}
}

/** Lazily-computed effective whitelist (baseline + config extras). */
private volatile Set<String> effectiveWhitelist;

private static Set<String> buildImmutableSet(String... items) {
Set<String> s = new HashSet<>(items.length * 2);
Collections.addAll(s, items);
return Collections.unmodifiableSet(s);
}

/**
* Get the effective (merged) whitelist — baseline + config extras. Lazy-init and
* cached after the first call.
*/
private Set<String> getEffectiveWhitelist() {
if (effectiveWhitelist != null) {
return effectiveWhitelist;
}
synchronized (this) {
if (effectiveWhitelist != null) {
return effectiveWhitelist;
}
Set<String> merged = new LinkedHashSet<>(BASELINE_WHITELIST);
if (StringUtils.isNotBlank(extraWhitelist)) {
for (String item : extraWhitelist.split(",")) {
Comment thread
spiritxishi marked this conversation as resolved.
Outdated
String trimmed = item.trim();
if (trimmed.isEmpty()) {
continue;
}
merged.add(trimmed);
}
}
effectiveWhitelist = Collections.unmodifiableSet(new HashSet<>(merged));
LOGGER.info("ModuleCommandValidator initialized: whitelist={}",
new java.util.TreeSet<>(effectiveWhitelist));
}
return effectiveWhitelist;
}

/**
* Get the current whitelist enforcement mode from configuration.
*/
public WhitelistMode getMode() {
Comment thread
spiritxishi marked this conversation as resolved.
Outdated
return WhitelistMode.fromConfig(whitelistModeConfig);
}

/**
* Incremental validation — only validates command fields that have actually changed
* between the existing module config (from DB) and the incoming update request.
* <p>
* This avoids blocking updates for existing modules that only change non-command
* fields (e.g. version number, package id).
*
* @param oldDto the existing ModuleDTO parsed from DB extParams (may be null if
* extParams was empty — all fields are treated as changed)
* @param request the incoming update request
* @return the offending field name + command, or {@code null} if all changed commands pass
*/
public String validateChanged(ModuleDTO oldDto, ModuleRequest request) {
if (oldDto == null) {
// No existing data — validate everything (same as save)
return validateAll(request.getStartCommand(), request.getStopCommand(),
request.getCheckCommand(), request.getInstallCommand(),
request.getUninstallCommand());
}

String[] fields = {"startCommand", "stopCommand", "checkCommand", "installCommand", "uninstallCommand"};
String[] oldValues = {
oldDto.getStartCommand(), oldDto.getStopCommand(), oldDto.getCheckCommand(),
oldDto.getInstallCommand(), oldDto.getUninstallCommand()};
String[] newValues = {
request.getStartCommand(), request.getStopCommand(), request.getCheckCommand(),
request.getInstallCommand(), request.getUninstallCommand()};

for (int i = 0; i < fields.length; i++) {
String oldVal = oldValues[i];
String newVal = newValues[i];
// Skip if unchanged (both null or equal)
if (Objects.equals(oldVal, newVal)) {
continue;
}
String offending = validate(newVal);
if (offending != null) {
Comment thread
spiritxishi marked this conversation as resolved.
Outdated
return fields[i] + ": '" + offending + "'";
Comment thread
spiritxishi marked this conversation as resolved.
Outdated
}
}
return null;
}

/**
* Scan the raw command string for any metacharacter substring from
* {@link #META_CHAR_BLACKLIST}. Returns the first hit, or {@code null} if clean.
* (Same logic as the agent-side validator.)
*/
private static String firstMetaCharHit(String raw) {
for (String meta : META_CHAR_BLACKLIST) {
if (raw.contains(meta)) {
return meta;
}
}
return null;
}

/**
* Validate a raw command string. Returns a descriptive error string if invalid, or
* {@code null} if valid. The error prefix indicates the rejection reason:
* {@code DISALLOWED_META_CHAR}, {@code FORBIDDEN_SH_C_FLAG}, or just the offending
* command name (NOT_IN_WHITELIST).
*
* @param rawCmd the raw command string (may be null or blank — skipped)
* @return error description, or {@code null} if valid
*/
public String validate(String rawCmd) {
if (StringUtils.isBlank(rawCmd)) {
return null;
}

// metacharacter blacklist (whole string, before splitting)
String metaHit = firstMetaCharHit(rawCmd);
if (metaHit != null) {
if ("*".equals(metaHit) || "?".equals(metaHit)) {
Comment thread
spiritxishi marked this conversation as resolved.
Outdated
return "DISALLOWED_META_CHAR: '" + metaHit
+ "' — glob wildcards are not supported (Agent runs commands without a shell,"
+ " so '*' and '?' will NOT be expanded); please specify explicit file paths";
}
return "DISALLOWED_META_CHAR: '" + metaHit + "'";
}
if (rawCmd.indexOf('\n') >= 0 || rawCmd.indexOf('\r') >= 0) {
return "DISALLOWED_META_CHAR: line-break";
}

Set<String> whitelist = getEffectiveWhitelist();

// Split by ';' into sub-commands (quote-aware), then by '|' into pipe segments
List<String> segments = splitTopLevel(rawCmd, ';');
if (segments == null) {
Comment thread
spiritxishi marked this conversation as resolved.
return "DISALLOWED_META_CHAR: unterminated quote";
}
for (String seg : segments) {
String trimmed = seg == null ? "" : seg.trim();
if (trimmed.isEmpty()) {
continue;
}
List<String> pipeSegs = splitTopLevel(trimmed, '|');
if (pipeSegs == null) {
Comment thread
spiritxishi marked this conversation as resolved.
return "DISALLOWED_META_CHAR: unterminated quote in pipe segment";
}
for (String pipeSeg : pipeSegs) {
String pipeTrimmed = pipeSeg == null ? "" : pipeSeg.trim();
if (pipeTrimmed.isEmpty()) {
continue;
}
String[] argv = tokenize(pipeTrimmed);
if (argv.length == 0) {
continue;
}
String cmdName = argv[0];

// argv[0] whitelist
if (!whitelist.contains(cmdName)) {
return cmdName;
}

// forbid sh/bash -c flag (inline script execution)
if (("sh".equals(cmdName) || "bash".equals(cmdName)) && argv.length > 1) {
for (int i = 1; i < argv.length; i++) {
if (argv[i].startsWith("-c")) {
return "FORBIDDEN_SH_C_FLAG: '" + cmdName + " " + argv[i] + "'";
}
}
}
}
}
return null;
}

/**
* Thoroughly validate all commands in a module request. Returns {@code null} if all
* commands pass, or a descriptive message like {@code "startCommand: 'python3'"} if
* one fails.
*/
public String validateAll(String startCommand, String stopCommand, String checkCommand,
Comment thread
spiritxishi marked this conversation as resolved.
Outdated
Comment thread
spiritxishi marked this conversation as resolved.
Outdated
String installCommand, String uninstallCommand) {
String[] fields = {"startCommand", "stopCommand", "checkCommand", "installCommand", "uninstallCommand"};
String[] values = {startCommand, stopCommand, checkCommand, installCommand, uninstallCommand};
for (int i = 0; i < fields.length; i++) {
String offending = validate(values[i]);
if (offending != null) {
return fields[i] + ": '" + offending + "'";
Comment thread
spiritxishi marked this conversation as resolved.
Outdated
Comment thread
spiritxishi marked this conversation as resolved.
Outdated
}
}
return null;
}

/**
* Quote-aware split of {@code raw} on the top-level {@code delim} character. Characters
* inside a single-quoted or double-quoted region are treated as literals and do not
* split the string. Returns {@code null} when the input has an unterminated quote.
*/
static List<String> splitTopLevel(String raw, char delim) {
List<String> out = new ArrayList<>();
if (raw == null) {
Comment thread
spiritxishi marked this conversation as resolved.
Outdated
out.add("");
Comment thread
spiritxishi marked this conversation as resolved.
Outdated
return out;
}
StringBuilder cur = new StringBuilder();
char quote = 0;
for (int i = 0; i < raw.length(); i++) {
char c = raw.charAt(i);
if (quote != 0) {
cur.append(c);
if (c == quote) {
quote = 0;
}
continue;
}
if (c == '\'' || c == '"') {
Comment thread
spiritxishi marked this conversation as resolved.
Outdated
quote = c;
cur.append(c);
continue;
}
if (c == delim) {
out.add(cur.toString());
cur.setLength(0);
continue;
}
cur.append(c);
}
if (quote != 0) {
return null;
}
out.add(cur.toString());
return out;
}

/**
* Whitespace-based tokenizer that honours single/double quotes. (Same logic as the
* agent-side validator.)
*/
private static String[] tokenize(String s) {
List<String> tokens = new ArrayList<>();
Comment thread
spiritxishi marked this conversation as resolved.
StringBuilder cur = new StringBuilder();
char quote = 0;
for (int i = 0; i < s.length(); i++) {
char c = s.charAt(i);
if (quote != 0) {
if (c == quote) {
quote = 0;
} else {
cur.append(c);
}
continue;
}
if (c == '\'' || c == '"') {
quote = c;
continue;
}
if (Character.isWhitespace(c)) {
if (cur.length() > 0) {
tokens.add(cur.toString());
cur.setLength(0);
}
continue;
}
cur.append(c);
}
if (cur.length() > 0) {
tokens.add(cur.toString());
}
return tokens.toArray(new String[0]);
}
}
Loading
Loading