Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
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
52 changes: 52 additions & 0 deletions java/lang/security/audit/java-logging-from-string-parameter.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
package com.test;

import org.slf4j.*;
import org.springframework.web.bind.annotation.*;

public class Cases {

private static final Logger logger = LoggerFactory.getLogger(Cases.class);

@GetMapping
public void case1(String param, long x) {
//ruleid: java-logging-from-string-parameter
logger.trace("Msg {}",param);
//ruleid: java-logging-from-string-parameter
logger.debug("Msg {}",param);
//ruleid: java-logging-from-string-parameter
logger.info("Msg {}",param);
//ruleid: java-logging-from-string-parameter
logger.warn("Msg {}",param);
//ruleid: java-logging-from-string-parameter
logger.error("Msg {}",param);
}

@PostMapping
public void case2(String param, long x) {
String param_clean = param.replace("<","").replace(">","");
param_clean = param_clean.replace("\n","");
//ok: java-logging-from-string-parameter
logger.trace("Msg {}",param_clean);
//ok: java-logging-from-string-parameter
logger.debug("Msg {}",param_clean);
//ok: java-logging-from-string-parameter
logger.info("Msg {}",param_clean);
//ok: java-logging-from-string-parameter
logger.warn("Msg {}",param_clean);
//ok: java-logging-from-string-parameter
logger.error("Msg {}",param_clean);
}

public void case3(String param, long x) {
//ok: java-logging-from-string-parameter
logger.trace("Msg {}",param);
//ok: java-logging-from-string-parameter
logger.debug("Msg {}",param);
//ok: java-logging-from-string-parameter
logger.info("Msg {}",param);
//ok: java-logging-from-string-parameter
logger.warn("Msg {}",param);
//ok: java-logging-from-string-parameter
logger.error("Msg {}",param);
}
}
44 changes: 44 additions & 0 deletions java/lang/security/audit/java-logging-from-string-parameter.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
rules:
- id: java-logging-from-string-parameter
languages:
- java
severity: WARNING
message: An unsanitized string parameter is passed to a web controller method and subsequently used in a logger call, which could lead to a log injection vulnerability.
patterns:
- pattern-inside: |
@$ANNO(...)
$TYPE $METHOD(..., String $PARAM, ...) {
...
}
- metavariable-pattern:
metavariable: $ANNO
pattern-regex: "(GetMapping|PostMapping|PutMapping|DeleteMapping|PatchMapping|RequestMapping|GET|POST|PUT|DELETE|PATCH|HEAD|OPTIONS|WebMethod)"
- pattern-either:
- pattern: $LOGGER.trace($FORMAT_STRING, $PARAM, ...)
- pattern: $LOGGER.debug($FORMAT_STRING, $PARAM, ...)
- pattern: $LOGGER.info($FORMAT_STRING, $PARAM, ...)
- pattern: $LOGGER.warn($FORMAT_STRING, $PARAM, ...)
- pattern: $LOGGER.error($FORMAT_STRING, $PARAM, ...)
fix: Ensure that a validation is in place prior to use a user-controller information to create a log event.
paths:
include:
- "**/*.java"
metadata:
category: security
owasp:
- A03:2021 Injection
technology:
- java
references:
- https://capec.mitre.org/data/definitions/93.html
- https://vulncat.fortify.com/en/weakness?q=log%20forging
- https://learn.snyk.io/lesson/logging-vulnerabilities/?ecosystem=java
- https://owasp.org/www-project-java-encoder/
- https://cheatsheetseries.owasp.org/cheatsheets/Logging_Cheat_Sheet.html
cwe:
- "CWE-117: Improper Output Neutralization for Logs"
likelihood: LOW
impact: LOW
confidence: LOW
subcategory:
- audit