Merge branch '1-aws-request-id-is-configurable' into 'main'

Resolve "AWS Request ID is configurable"

Closes #2 and #1

See merge request bot-by/slf4j-aws-lambda!2

Author: vitalijr2

.gitlab-ci.yml

@@ -4,6 +4,9 @@ variables:
 
 image: maven:3-openjdk-11
 
+include:
+  - template: Security/SAST.gitlab-ci.yml
+
 cache:
   paths:
     - .m2/repository
@@ -31,17 +34,10 @@ test:
   except:
     - tags
 
-# You can override the included template(s) by including variable overrides
-# SAST customization: https://docs.gitlab.com/ee/user/application_security/sast/#customizing-the-sast-settings
-# Secret Detection customization: https://docs.gitlab.com/ee/user/application_security/secret_detection/#customizing-settings
-# Dependency Scanning customization: https://docs.gitlab.com/ee/user/application_security/dependency_scanning/#customizing-the-dependency-scanning-settings
-# Container Scanning customization: https://docs.gitlab.com/ee/user/application_security/container_scanning/#customizing-the-container-scanning-settings
-# Note that environment variables can be set in several places
-# See https://docs.gitlab.com/ee/ci/variables/#cicd-variable-precedence
 sast:
   stage: test
-include:
-  - template: Security/SAST.gitlab-ci.yml
+  variables:
+    SAST_EXCLUDED_PATHS: jacoco-resources,prism.js
 
 spotbugs-sast:
   variables:

.idea/misc.xml

@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+### Added
+- Name of AWS request ID is configurable
+### Fixed
+- CRLF injection issue #2
 
 ## 1.0.1 - 2022-05-06
 ### Changed

changelog.md

@@ -51,7 +51,7 @@
 
   <properties>
     <!-- version -->
-    <revision>1.0.1</revision>
+    <revision>1.1.0</revision>
     <changelist>-SNAPSHOT</changelist>
     <sha1/>
     <!-- java and maven -->
@@ -64,6 +64,8 @@
     <!-- plugins -->
     <enforcer-plugin.version>3.0.0</enforcer-plugin.version>
     <clean-plugin.version>3.2.0</clean-plugin.version>
+    <templating-plugin.version>1.0.0</templating-plugin.version>
+    <resources-plugin.version>3.2.0</resources-plugin.version>
     <compiler-plugin.version>3.10.1</compiler-plugin.version>
     <surefire-plugin.version>2.22.2</surefire-plugin.version>
     <shade-plugin.version>3.3.0</shade-plugin.version>
@@ -72,7 +74,9 @@
     <lambda-core.version>1.2.1</lambda-core.version>
     <lambda-events.version>3.11.0</lambda-events.version>
     <slf4j.version>1.7.36</slf4j.version>
-    <slf4j-aws-lambda.version>1.0.1</slf4j-aws-lambda.version>
+    <slf4j-aws-lambda.version>1.1.0</slf4j-aws-lambda.version>
+    <!-- other -->
+    <aws-request-id>request#</aws-request-id>
   </properties>
 
   <dependencies>
@@ -105,6 +109,12 @@
 
   <build>
     <defaultGoal>clean verify</defaultGoal>
+    <resources>
+      <resource>
+        <directory>src/main/resources</directory>
+        <filtering>true</filtering>
+      </resource>
+    </resources>
     <plugins>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
@@ -141,6 +151,27 @@
         <artifactId>maven-clean-plugin</artifactId>
         <version>${clean-plugin.version}</version>
       </plugin>
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>templating-maven-plugin</artifactId>
+        <version>${templating-plugin.version}</version>
+        <executions>
+          <execution>
+            <id>filter-sources</id>
+            <goals>
+              <goal>filter-sources</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-resources-plugin</artifactId>
+        <version>${resources-plugin.version}</version>
+        <configuration>
+          <propertiesEncoding>${propertiesEncoding}</propertiesEncoding>
+        </configuration>
+      </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>

example/pom.xml

@@ -1,10 +1,9 @@
 package uk.bot_by.bot.slf4j_demo;
 
-import static uk.bot_by.aws_lambda.slf4j.LambdaLogger.AWS_REQUEST_ID;
-
 import com.amazonaws.services.lambda.runtime.Context;
 import com.amazonaws.services.lambda.runtime.RequestHandler;
 import java.util.Map;
+import java.util.stream.Stream;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.slf4j.MDC;
@@ -13,14 +12,22 @@ public class BotHandler implements RequestHandler<Map<String, Object>, String> {
 
   private final Logger logger = LoggerFactory.getLogger(getClass());
 
+  {
+    logger.info("Load version: @project.version@");
+  }
+
   @Override
   public String handleRequest(Map<String, Object> input, Context context) {
-    MDC.put(AWS_REQUEST_ID, context.getAwsRequestId());
+    MDC.put("@aws-request-id@", context.getAwsRequestId());
     logger.trace("trace message");
     logger.debug("debug message");
     logger.info("info message");
     logger.warn("warning message");
     logger.error("error message");
+    Stream.of("\n", "\r\n", "\r").forEach(injection -> {
+      logger.info("CRLF{}injection", injection);
+    });
+    logger.warn("printable stacktrace", new Throwable("Printable Stacktrace Demo"));
     return "done";
   }
 

example/src/main/java/uk/bot_by/bot/slf4j_demo/BotHandler.java renamed to example/src/main/java-templates/uk/bot_by/bot/slf4j_demo/BotHandler.java

@@ -0,0 +1 @@
+requestId=${aws-request-id}

example/src/main/resources/lambda-logger.properties

@@ -66,7 +66,7 @@
 
   <properties>
     <!-- version -->
-    <revision>1.0.2</revision>
+    <revision>1.1.0</revision>
     <changelist>-SNAPSHOT</changelist>
     <sha1/>
     <!-- java and maven -->
@@ -97,11 +97,13 @@
     <mockito.version>4.6.1</mockito.version>
     <hamcrest.version>2.2</hamcrest.version>
     <system-stubs.version>2.0.1</system-stubs.version>
+    <commons-text.version>1.9</commons-text.version>
     <!-- dependencies -->
     <jetbrains-annotations.version>23.0.0</jetbrains-annotations.version>
     <slf4j.version>1.7.36</slf4j.version>
     <!-- other -->
-    <package.registry.url>https://gitlab.com/bot-by/slf4j-aws-lambda/-/packages</package.registry.url>
+    <package.registry.url>https://gitlab.com/bot-by/slf4j-aws-lambda/-/packages
+    </package.registry.url>
   </properties>
 
   <dependencies>
@@ -164,6 +166,12 @@
       <version>${system-stubs.version}</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.apache.commons</groupId>
+      <artifactId>commons-text</artifactId>
+      <version>${commons-text.version}</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <build>
@@ -457,7 +465,9 @@
 <script type="text/javascript" src="{@docRoot}/resources/prism.js"></script>
 							]]></bottom>
               <additionalJOptions>
-                <additionalJOption>-J-Dhttp.agent=maven-javadoc-plugin-${project.artifactId}</additionalJOption>
+                <additionalJOption>
+                  -J-Dhttp.agent=maven-javadoc-plugin_${project.groupId}:${project.artifactId}
+                </additionalJOption>
               </additionalJOptions>
               <additionalOptions>
                 <additionalOption>--allow-script-in-comments</additionalOption>

pom.xml

@@ -4,6 +4,7 @@ An [SLF4J][] Logger implementation for [AWS Lambda][lambda].
 
 [![Codacy Grade](https://app.codacy.com/project/badge/Grade/dda626a02daf464c94aa10955a6b8f6b)](https://www.codacy.com/gl/bot-by/slf4j-aws-lambda/dashboard?utm_source=gitlab.com&utm_medium=referral&utm_content=bot-by/slf4j-aws-lambda&utm_campaign=Badge_Grade)
 [![Codacy Coverage](https://app.codacy.com/project/badge/Coverage/dda626a02daf464c94aa10955a6b8f6b)](https://www.codacy.com/gl/bot-by/slf4j-aws-lambda/dashboard?utm_source=gitlab.com&utm_medium=referral&utm_content=bot-by/slf4j-aws-lambda&utm_campaign=Badge_Coverage)
+[![Maven Central](https://img.shields.io/maven-central/v/uk.bot-by/slf4j-aws-lambda)](https://search.maven.org/artifact/uk.bot-by/slf4j-aws-lambda)
 
 ## Getting started
 
@@ -16,14 +17,14 @@ The sample code, see the folder **[example](example)** :
 
 ```java
 @Override
-public String handleRequest(Map<String, Object> input,Context context){
-  MDC.put(LambdaLogger.AWS_REQUEST_ID, context.getAwsRequestId());
-  logger.trace("trace message");
-  logger.debug("debug message");
-  logger.info("info message");
-  logger.warn("warning message");
-  logger.error("error message");
-  return"done";
+public String handleRequest(Map<String, Object> input,Context context) {
+    MDC.put("AWS_REQUEST_ID", context.getAwsRequestId());
+    logger.trace("trace message");
+    logger.debug("debug message");
+    logger.info("info message");
+    logger.warn("warning message");
+    logger.error("error message");
+    return"done";
 }
 ```
 
@@ -40,22 +41,6 @@ END RequestId: cc4eb5aa-66b4-42fc-b27a-138bd672b38a
 The footprint of **slf4j-aws-lambda** (68K) is same size as **slf4j-simple** (64K) and much smaller
 than **logback** (716K).
 
-## Acquire
-
-![Maven Central](https://img.shields.io/maven-central/v/uk.bot-by/slf4j-aws-lambda)
-
-Please add dependency to your project:
-
-```xml
-<dependency>
-  <groupId>uk.bot-by</groupId>
-  <artifactId>slf4j-aws-lambda</artifactId>
-  <version>1.0.1</version>
-</dependency>
-```
-
-## Usage
-
 There is a great original [manual][manual].
 
 The configuration is similar to [SLF4J Simple][slf4j-simple].
@@ -69,6 +54,7 @@ It looks for the `lambda-logger.properties` resource and read properties:
   Must be one of (_trace_, _debug_, _info_, _warn_, _error_), a value is case-insensitive.
   If not specified, defaults to _info_.
 * **levelInBrackets** - Should the level string be output in brackets? Defaults to `false`.
+* **requestId** - Set the context name of AWS request ID. Defaults to `AWS_REQUEST_ID`.
 * **showDateTime** - Set to `true` if you want the current date and time to be included in output
   messages. Defaults to `false`.
 * **showLogName** - Set to `true` if you want the Logger instance name to be included in output
@@ -80,9 +66,13 @@ It looks for the `lambda-logger.properties` resource and read properties:
 * **showThreadName** - Set to `true` if you want to output the current thread name.
   Defaults to `false`.
 
-The environment variables overrides the properties: **LOG_DATE_TIME_FORMAT**, **LOG_DEFAULT_LEVEL**,
-**LOG_LEVEL_IN_BRACKETS**, **LOG_SHOW_DATE_TIME**, **LOG_SHOW_NAME**, **LOG_SHOW_SHORT_NAME**,
-**LOG_SHOW_THREAD_ID**, **LOG_SHOW_THREAD_NAME**.
+The environment variables overrides the properties: **LOG_AWS_REQUEST_ID**,
+**LOG_DATE_TIME_FORMAT**, **LOG_DEFAULT_LEVEL**, **LOG_LEVEL_IN_BRACKETS**, **LOG_SHOW_DATE_TIME**,
+**LOG_SHOW_NAME**, **LOG_SHOW_SHORT_NAME**, **LOG_SHOW_THREAD_ID**, **LOG_SHOW_THREAD_NAME**.
+
+More information you can find on site:
+
+https://slf4j-aws-lambda.bot-by.uk/
 
 ## Contributing
 

readme.md

@@ -32,7 +32,7 @@
  * <pre><code class="language-java">
  *   {@literal @}Override
  *   public String handleRequest({@literal Map<String, Object>} input, Context context) {
- *     MDC.put(LambdaLogger.AWS_REQUEST_ID, context.getAwsRequestId());
+ *     MDC.put("AWS_REQUEST_ID", context.getAwsRequestId());
  *     ...
  *     logger.info("info message");
  *     ...
@@ -50,16 +50,6 @@
  */
 public class LambdaLogger extends MarkerIgnoringBase {
 
-  /**
-   * AWS request ID.
-   * <p>
-   * Use to put the request ID to MDC:
-   * <pre><code class="language-java">
-   * MDC.put(LambdaLogger.AWS_REQUEST_ID, context.getAwsRequestId());
-   * </code></pre>
-   */
-  public static final String AWS_REQUEST_ID = "AWS_REQUEST_ID";
-
   private final LambdaLoggerConfiguration configuration;
   private final PrintStream printStream;
 

src/main/java/uk/bot_by/aws_lambda/slf4j/LambdaLogger.java

@@ -39,6 +39,8 @@
  * a value is case-insensitive. If not specified, defaults to <em>info</em>.</li>
  * <li><strong>levelInBrackets</strong> - Should the level string be output in brackets?
  * Defaults to {@code false}.</li>
+ * <li><strong>requestId</strong> - Set the context name of <strong>AWS request ID</strong>.
+ * Defaults to {@code AWS_REQUEST_ID}.</li>
  * <li><strong>showDateTime</strong> - Set to {@code true} if you want the current date and time
  * to be included in output messages. Defaults to {@code false}.</li>
  * <li><strong>showLogName</strong> - Set to {@code true} if you want the Logger instance name
@@ -51,11 +53,11 @@
  * the current thread name. Defaults to {@code false}.</li>
  * </ul>
  * <p>
- * The environment variables overrides the properties: <strong>LOG_DATE_TIME_FORMAT</strong>,
- * <strong>LOG_DEFAULT_LEVEL</strong>, <strong>LOG_LEVEL_IN_BRACKETS</strong>,
- * <strong>LOG_SHOW_DATE_TIME</strong>, <strong>LOG_SHOW_NAME</strong>,
- * <strong>LOG_SHOW_SHORT_NAME</strong>, <strong>LOG_SHOW_THREAD_ID</strong>,
- * <strong>LOG_SHOW_THREAD_NAME</strong>.
+ * The environment variables overrides the properties: <strong>LOG_AWS_REQUEST_ID</strong>,
+ * <strong>LOG_DATE_TIME_FORMAT</strong>, <strong>LOG_DEFAULT_LEVEL</strong>,
+ * <strong>LOG_LEVEL_IN_BRACKETS</strong>, <strong>LOG_SHOW_DATE_TIME</strong>,
+ * <strong>LOG_SHOW_NAME</strong>, <strong>LOG_SHOW_SHORT_NAME</strong>,
+ * <strong>LOG_SHOW_THREAD_ID</strong>, <strong>LOG_SHOW_THREAD_NAME</strong>.
  */
 public class LambdaLoggerConfiguration {
 
@@ -66,6 +68,7 @@ public class LambdaLoggerConfiguration {
   private final Level loggerLevel;
   private final String logName;
   private final String name;
+  private final String requestId;
   private final boolean showDateTime;
   private final boolean showThreadId;
   private final boolean showThreadName;
@@ -82,6 +85,7 @@ private LambdaLoggerConfiguration(Builder builder) {
     } else {
       logName = null;
     }
+    requestId = builder.requestId;
     showDateTime = builder.showDateTime;
     showThreadId = builder.showThreadId;
     showThreadName = builder.showThreadName;
@@ -111,6 +115,10 @@ public String name() {
     return name;
   }
 
+  public String requestId() {
+    return requestId;
+  }
+
   public boolean showDateTime() {
     return showDateTime;
   }
@@ -132,6 +140,7 @@ public static class Builder {
     private boolean levelInBrackets;
     private Level loggerLevel;
     private String name;
+    private String requestId;
     private boolean showDateTime;
     private boolean showLogName;
     private boolean showShortLogName;
@@ -149,6 +158,7 @@ private Builder() {
     public LambdaLoggerConfiguration build() {
       requireNonNull(loggerLevel, "Logger level is null");
       requireNonNull(name, "Logger name is null");
+      requireNonNull(requestId, "AWS request ID is null");
       return new LambdaLoggerConfiguration(this);
     }
 
@@ -205,6 +215,17 @@ public Builder name(@NotNull String name) {
       return this;
     }
 
+    /**
+     * Context name of AWS request ID.
+     *
+     * @param requestId context name of AWS request ID
+     * @return a builder
+     */
+    public Builder requestId(@NotNull String requestId) {
+      this.requestId = requestId;
+      return this;
+    }
+
     /**
      * Set to {@code true} if you want the current date and time to be included in output messages.
      * <p>