Skip to content
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

Jump to bottom

WW-5454 Log warnings on startup for disabled critical security features #1010

Merged
merged 1 commit into from
Aug 6, 2024
Merged

WW-5454 Log warnings on startup for disabled critical security features #1010

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
15 changes: 10 additions & 5 deletions core/src/main/java/com/opensymphony/xwork2/ognl/SecurityMemberAccess.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
import static com.opensymphony.xwork2.util.ConfigParseUtil.toNewPackageNamesSet;
import static com.opensymphony.xwork2.util.ConfigParseUtil.toNewPatternsSet;
import static com.opensymphony.xwork2.util.ConfigParseUtil.toPackageNamesSet;
import static com.opensymphony.xwork2.util.DebugUtils.logWarningForFirstOccurrence;
import static java.text.MessageFormat.format;
import static java.util.Collections.emptySet;
import static org.apache.struts2.StrutsConstants.STRUTS_ALLOWLIST_CLASSES;
Expand Down Expand Up @@ -87,7 +88,6 @@ public class SecurityMemberAccess implements MemberAccess {
private Set<String> excludedPackageNames = emptySet();
private Set<String> excludedPackageExemptClasses = emptySet();

private static volatile boolean isDevModeLogged = false;
private volatile boolean isDevModeInit;
private boolean isDevMode;
private Set<String> devModeExcludedClasses = Set.of(Object.class.getName());
Expand Down Expand Up @@ -459,6 +459,13 @@ public void useExcludedPackageExemptClasses(String commaDelimitedClasses) {
@Inject(value = StrutsConstants.STRUTS_ALLOWLIST_ENABLE, required = false)
public void useEnforceAllowlistEnabled(String enforceAllowlistEnabled) {
this.enforceAllowlistEnabled = BooleanUtils.toBoolean(enforceAllowlistEnabled);
if (!this.enforceAllowlistEnabled) {
String msg = "OGNL allowlist is disabled!" +
" We strongly recommend keeping it enabled to protect against critical vulnerabilities." +
" Set the configuration `{}=true` to enable it." +
" Please refer to the Struts 7.0 migration guide and security documentation for further information.";
logWarningForFirstOccurrence("allowlist", LOG, msg, StrutsConstants.STRUTS_ALLOWLIST_ENABLE);
}
}

@Inject(value = STRUTS_ALLOWLIST_CLASSES, required = false)
Expand Down Expand Up @@ -515,11 +522,9 @@ private void useDevModeConfiguration() {
if (!isDevMode || isDevModeInit) {
return;
}
logWarningForFirstOccurrence("devMode", LOG,
"DevMode enabled, using DevMode excluded classes and packages for OGNL security enforcement!");
isDevModeInit = true;
if (!isDevModeLogged) {
LOG.warn("Working in devMode, using devMode excluded classes and packages!");
isDevModeLogged = true;
}
excludedClasses = devModeExcludedClasses;
excludedPackageNamePatterns = devModeExcludedPackageNamePatterns;
excludedPackageNames = devModeExcludedPackageNames;
Expand Down
13 changes: 13 additions & 0 deletions core/src/main/java/com/opensymphony/xwork2/util/DebugUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,16 @@
import com.opensymphony.xwork2.interceptor.ValidationAware;
import org.apache.logging.log4j.Logger;

import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;

/**
* @since 6.5.0
*/
public final class DebugUtils {

private static final Set<String> IS_LOGGED = ConcurrentHashMap.newKeySet();

public static void notifyDeveloperOfError(Logger log, Object action, String message) {
if (action instanceof TextProvider tp) {
message = tp.getText("devmode.notification", "Developer Notification:\n{0}", new String[]{message});
Expand All @@ -37,4 +42,12 @@ public static void notifyDeveloperOfError(Logger log, Object action, String mess
}
}

/**
* @since 7.0
*/
public static void logWarningForFirstOccurrence(String key, Logger log, String msg, Object... args) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This method isn't really a DebugUtils method but couldn't think of a better home - can create a separate class if you prefer

if (IS_LOGGED.add(key)) {
log.warn(msg, args);
}
}
}
8 changes: 8 additions & 0 deletions core/src/main/java/org/apache/struts2/interceptor/parameter/ParametersInterceptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@

import static com.opensymphony.xwork2.security.DefaultAcceptedPatternsChecker.NESTING_CHARS;
import static com.opensymphony.xwork2.security.DefaultAcceptedPatternsChecker.NESTING_CHARS_STR;
import static com.opensymphony.xwork2.util.DebugUtils.logWarningForFirstOccurrence;
import static com.opensymphony.xwork2.util.DebugUtils.notifyDeveloperOfError;
import static java.lang.String.format;
import static java.util.Collections.unmodifiableSet;
Expand Down Expand Up @@ -115,6 +116,13 @@ public void setDevMode(String mode) {
@Inject(value = StrutsConstants.STRUTS_PARAMETERS_REQUIRE_ANNOTATIONS, required = false)
public void setRequireAnnotations(String requireAnnotations) {
this.requireAnnotations = BooleanUtils.toBoolean(requireAnnotations);
if (!this.requireAnnotations) {
String msg = "@StrutsParameter annotation requirement is disabled!" +
" We strongly recommend keeping it enabled to protect against critical vulnerabilities." +
" Set the configuration `{}=true` to enable it." +
" Please refer to the Struts 7.0 migration guide and security documentation for further information.";
logWarningForFirstOccurrence("strutsParameter", LOG, msg, StrutsConstants.STRUTS_PARAMETERS_REQUIRE_ANNOTATIONS);
}
}

/**
Expand Down
Loading