Enabling ASM for Java

You can monitor application security for Java apps running in Docker, Kubernetes, AWS ECS, and AWS Fargate.

In general, setting up Application Security Management (ASM) involves:

1. Identifying services that are vulnerable or are under attack, which would most benefit from ASM. Find them on the Security tab of your Service Catalog.
2. Updating to the latest Datadog library (the most recent APM tracing library).
3. Enabling the library to collect the application security data from the services and send it to Datadog.
4. Triggering security signals in your application and seeing how Datadog displays the resulting information.

Prerequisites

• The Datadog Agent is installed and configured for your application’s operating system or container, cloud, or virtual environment.
• Datadog APM is configured for your application or service, and traces are being received by Datadog.
• If your service is running with an Agent with Remote Configuration enabled and a tracing library version that supports it, you can block attackers from the Datadog UI without additional configuration of the Agent or tracing libraries.

Get started

1. Update your Datadog Java library to at least version 0.94.0 (at least version 1.1.4 for Application Vulnerability Management vulnerability detection features):

   wget -O dd-java-agent.jar 'https://github.com/DataDog/dd-trace-java/releases/latest/download/dd-java-agent.jar'
   

   To check that your service’s language and framework versions are supported for ASM capabilities, see Compatibility.

2. Run your Java application with ASM enabled. From the command line:

   java -javaagent:/path/to/dd-java-agent.jar -Ddd.appsec.enabled=true -Ddd.service=<MY SERVICE> -Ddd.env=<MY_ENV> -jar path/to/app.jar
   

   Or one of the following methods, depending on where your application runs:

   Note: Read-only file systems are not currently supported. The application must have access to a writable /tmp directory.

   Update your configuration container for APM by adding the following argument in your docker run command:

   docker run [...] -e DD_APPSEC_ENABLED=true [...]
   

   Add the following environment variable value to your container Dockerfile:

   ENV DD_APPSEC_ENABLED=true
   

   Update your deployment configuration file for APM and add the ASM environment variable:

   spec:
     template:
       spec:
         containers:
           - name: <CONTAINER_NAME>
             image: <CONTAINER_IMAGE>/<TAG>
             env:
               - name: DD_APPSEC_ENABLED
                 value: "true"
   

   Update your ECS task definition JSON file, by adding this in the environment section:

   "environment": [
     ...,
     {
       "name": "DD_APPSEC_ENABLED",
       "value": "true"
     }
   ]
   

   Set the -Ddd.appsec.enabled flag or the DD_APPSEC_ENABLED environment variable to true in your service invocation:

   java -javaagent:dd-java-agent.jar \
        -Ddd.appsec.enabled=true \
        -jar <YOUR_SERVICE>.jar \
        <YOUR_SERVICE_FLAGS>
   

   After this configuration is complete, the library collects security data from your application and sends it to the Agent, which sends it to Datadog, where out-of-the-box detection rules flag attacker techniques and potential misconfigurations so you can take steps to remediate.

3. To see Application Security Management threat detection in action, send known attack patterns to your application. For example, trigger the Security Scanner Detected rule by running a file that contains the following curl script:

   for ((i=1;i<=200;i++)); 
   do
   # Target existing service’s routes
   curl https://your-application-url/existing-route -A dd-test-scanner-log;
   # Target non existing service’s routes
   curl https://your-application-url/non-existing-route -A dd-test-scanner-log;
   done

   Note: The dd-test-scanner-log value is supported in the most recent releases.

   A few minutes after you enable your application and exercise it, threat information appears in the Application Signals Explorer and vulnerability information appears in the Vulnerability Explorer.

Enabling custom code vulnerability detection

If your service runs a tracing library version that supports Vulnerability Management for Custom Code Vulnerability Detection, enable the capability by setting the DD_IAST_ENABLED=true environment variable and restarting your service.

To detect custom code vulnerabilities for your service:

1. Update your Datadog Agent to at least version 7.41.1.

2. Update your tracing library to at least the minimum version needed to turn on custom code vulnerability detection. For details, see ASM capabilities support.

3. Add the DD_IAST_ENABLED=true environment variable to your application configuration.

   From the command line:

   java -javaagent:/path/to/dd-java-agent.jar -Ddd.iast.enabled=true -Ddd.service=<MY SERVICE> -Ddd.env=<MY_ENV> -jar path/to/app.jar
   

   Or one of the following methods, depending on where your application runs:

   Note: Read-only file systems are not supported. The application must have access to a writable /tmp directory.

   Update your configuration container for APM by adding the following argument in your docker run command:

   docker run [...] -e DD_IAST_ENABLED=true [...]
   

   Add the following environment variable value to your container Dockerfile:

   DD_IAST_ENABLED=true
   

   Update your deployment configuration file for APM and add the IAST environment variable:

   spec:
     template:
       spec:
         containers:
           - name: <CONTAINER_NAME>
             image: <CONTAINER_IMAGE>/<TAG>
             env:
               - name: DD_IAST_ENABLED
                 value: "true"
   

   Update your ECS task definition JSON file, by adding this in the environment section:

   "environment": [
     ...,
     {
       "name": "DD_IAST_ENABLED",
       "value": "true"
     }
   ]
   

4. Restart your service.

5. To see Application Vulnerability Management for custom code vulnerabilities in action, browse your service and the custom code vulnerabilities appear in the Vulnerability Explorer. The SOURCE column shows the Custom Code value.

If you need additional assistance, contact Datadog support.

Further Reading

Documentation, liens et articles supplémentaires utiles:

Adding user information to tracesDOCUMENTATION Java Datadog library source codeGITHUB OOTB Application Security Management RulesDOCUMENTATION Troubleshooting Application Security ManagementDOCUMENTATION