Skip to content
Merged
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
2 changes: 1 addition & 1 deletion content/en/security/application_security/setup/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ Learn how to enable App and API Protection on all the following supported platfo
{{< appsec-integrations >}}
{{< appsec-integration name="NGINX" avatar="nginx" link="./nginx" >}}
{{< appsec-integration name="Envoy" avatar="envoy" link="./envoy" >}}
{{< appsec-integration name="Istio" avatar="istio" link="./istio" >}}
{{< /appsec-integrations >}}

## Hosts
Expand All @@ -52,6 +51,7 @@ Learn how to enable App and API Protection on all the following supported platfo
{{< appsec-integrations >}}
{{< appsec-integration name="Kubernetes" avatar="kubernetes" link="./kubernetes" >}}
{{< appsec-integration name="Istio" avatar="istio" link="./istio" >}}
{{< appsec-integration name="Envoy Gateway" avatar="envoy" link="./envoy-gateway" >}}
{{< appsec-integration name="Gateway API" src="integrations_logos/gateway-api_avatar.svg" link="./gateway-api" >}}
{{< /appsec-integrations >}}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Envoy Gateway Compatibility Requirements
code_lang: envoy-gateway
type: multi-code-lang
code_lang_weight: 40
---

The following table lists App and API Protection capabilities for the Envoy Gateway integration according to the specified Datadog External Processor image version:

| App and API Protection capability | Minimum Datadog External Processor image version |
|------------------------------------------------|---------------------------------------------------|
| Threat Detection | v2.4.0 |
| Threat Protection | v2.4.0 |
| Customize response to blocked requests | v2.4.0 |
| Non blocking asynchronous mode (observability) | not supported |
| API Security | v2.4.0 |
| App and API Protection Standalone | v2.4.0 |
| Automatic user activity event tracking | not supported |

### Body processing support

The Datadog External Processor service supports the processing of request and response bodies for the following payload types:

| Payload type | Minimum Datadog External Processor image version |
|--------------|---------------------------------------------------|
| JSON | v2.4.0 |

## Envoy Gateway version support

### Supported Envoy Gateway versions

Envoy Gateway relies on Envoy Proxy and the Gateway API, and runs within a Kubernetes cluster. Datadog supports only non‑EOL Envoy Gateway versions; see the official [Envoy Gateway Compatibility Matrix][1] for the current list of supported versions and upstream dependencies (Envoy Proxy, Gateway API, Kubernetes).


### Envoy version support

The Datadog Envoy integration for App and API Protection relies on features that might not be present in every Envoy version. The following table shows which Envoy versions support each feature.

| Feature | Minimum Envoy version |
|---------|-----------------------|
| External Processing Filter | v1.27.0 |
| Observability mode | v1.30.0 |

## Datadog Envoy Gateway integration support

<div class="alert alert-info">The Datadog Envoy Gateway integration for App and API Protection is in Preview.</div>

Only the Linux version and both the amd64 and arm64 architectures are supported.

<div class="alert alert-info">If you would like to see support added for any of
the unsupported capabilities, let us know! Fill out <a
href="https://forms.gle/gHrxGQMEnAobukfn7">this short form to send
details</a>.</div>

[1]: https://gateway.envoyproxy.io/news/releases/matrix/
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The Datadog External Processor service supports the processing of request and re

### Supported Envoy Versions

Istios data plane is based on Envoy. The following table shows the relationship between Istio versions and their corresponding Envoy release branches:
Istio's data plane is based on Envoy. The following table shows the relationship between Istio versions and their corresponding Envoy release branches:

| Istio version | Envoy release branch |
|---------------|----------------------|
Expand Down
254 changes: 254 additions & 0 deletions content/en/security/application_security/setup/envoy-gateway.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,254 @@
---
title: Enabling App and API Protection for Envoy Gateway
code_lang: envoy-gateway
code_lang_weight: 50
further_reading:
- link: 'https://github.com/DataDog/dd-trace-go/tree/main/contrib/envoyproxy/go-control-plane/cmd/serviceextensions'
tag: "Source Code"
text: "Envoy integration source code"
- link: "/security/default_rules/?category=cat-application-security"
tag: "Documentation"
text: "OOTB App and API Protection Rules"
- link: "/security/application_security/troubleshooting"
tag: "Documentation"
text: "Troubleshooting App and API Protection"
---

{{< callout url="#" btn_hidden="true" header="App and API Protection for Envoy Gateway is in Preview" >}}
App and API Protection for Envoy Gateway is in Preview. Use the following instructions to try the preview.
{{< /callout >}}

You can enable Datadog App and API Protection for traffic managed by [Envoy Gateway][1]. The Datadog Envoy Gateway integration allows Datadog to inspect and protect your traffic for threat detection and blocking directly at the edge of your infrastructure.

## Prerequisites

1. A running Kubernetes cluster with [Envoy Gateway][1] installed.
2. The [Datadog Agent is installed and configured][2] in your Kubernetes cluster.
- Ensure [Remote Configuration][3] is enabled and configured to enable blocking attackers through the Datadog UI.
- Ensure [APM is enabled][4] in the Agent to allow the external processor service to send its own traces to the Agent.
- Optionally, enable the [Cluster Agent Admission Controller][5] to automatically inject the Datadog Agent host information to the App and API Protection External Processor service.

## Enabling threat detection

To enable App and API Protection with Envoy Gateway, do the following:

1. Deploying the Datadog External Processor service in your cluster.
2. Configure an `EnvoyExtensionPolicy` that points to the processor service. This will direct traffic from your Envoy Gateway to this service.

### 1. Deploy the Datadog External Processor service

This service is a gRPC server that Envoy communicates with to have requests and responses analyzed by App and API Protection.

Create a Kubernetes Deployment and Service for the Datadog External Processor. It's recommended to deploy this service in a namespace accessible by your Envoy Gateway.

The Datadog External Processor Docker image is available on the [Datadog Go tracer GitHub Registry][6].

Here is an example manifest (`datadog-aap-extproc-service.yaml`):

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: datadog-aap-extproc-deployment
namespace: <your-preferred-namespace> # Change to your preferred namespace, ensure it's resolvable by the Envoy Gateway
labels:
app: datadog-aap-extproc
spec:
replicas: 1 # Adjust replica count based on your load
selector:
matchLabels:
app: datadog-aap-extproc
template:
metadata:
labels:
app: datadog-aap-extproc
spec:
containers:
- name: datadog-aap-extproc-container
image: ghcr.io/datadog/dd-trace-go/service-extensions-callout:v2.4.0 # Replace with the latest released version
ports:
- name: grpc
containerPort: 443 # Default gRPC port for the external processor
- name: health
containerPort: 80 # Default health check port
env:
# Optional: Agent Configuration
# If you enabled the Cluster Agent Admission Controller, you can skip this section as the Agent host information is automatically injected.
# Otherwise, configure the address of your Datadog Agent for the external processor
- name: DD_AGENT_HOST
value: "<your-datadog-agent-service>.<your-datadog-agent-namespace>.svc.cluster.local"
- name: DD_TRACE_AGENT_PORT # Optional if your Agent's trace port is the default 8126
value: "8126"

# Disable TLS for communication between Envoy Gateway and the external processor. Default is true.
# By default, the external processor configuration used by Envoy Gateway is configured to not use TLS.
# You can enable TLS and configure it with DD_SERVICE_EXTENSION_TLS_KEY_FILE and DD_SERVICE_EXTENSION_TLS_CERT_FILE
# and apply a BackendTLSPolicy on the Datadog External Processor Service.
- name: DD_SERVICE_EXTENSION_TLS
value: "false"

readinessProbe:
httpGet:
path: /
port: health
initialDelaySeconds: 5
periodSeconds: 10
livenessProbe:
httpGet:
path: /
port: health
initialDelaySeconds: 15
periodSeconds: 20
---
apiVersion: v1
kind: Service
metadata:
name: datadog-aap-extproc-service # This name will be used in the EnvoyExtensionPolicy configuration
namespace: <your-preferred-namespace> # Change to your preferred namespace, ensure it's resolvable by the Envoy Gateway
labels:
app: datadog-aap-extproc
spec:
ports:
- name: grpc
port: 443
targetPort: grpc
protocol: TCP
selector:
app: datadog-aap-extproc
type: ClusterIP
```

#### Configuration options for the External Processor

The Datadog External Processor exposes some settings:

| Environment variable | Default value | Description |
|-------------------------------------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------|
| `DD_SERVICE_EXTENSION_HOST` | `0.0.0.0` | gRPC server listening address. |
| `DD_SERVICE_EXTENSION_PORT` | `443` | gRPC server port. |
| `DD_SERVICE_EXTENSION_HEALTHCHECK_PORT` | `80` | HTTP server port for health checks. |
| `DD_SERVICE_EXTENSION_TLS` | `true` | Enable the gRPC TLS layer. |
| `DD_SERVICE_EXTENSION_TLS_KEY_FILE` | `localhost.key` | Change the default gRPC TLS layer key. |
| `DD_SERVICE_EXTENSION_TLS_CERT_FILE` | `localhost.crt` | Change the default gRPC TLS layer certificate. |
| `DD_APPSEC_BODY_PARSING_SIZE_LIMIT` | `10485760` | Maximum size of the bodies to be processed in bytes. If set to `0`, the bodies are not processed. The recommended value is `10485760` (10MB). (To fully enable body processing, the `allowModeOverride` option should also be set in the External Processing filter configuration.) |
| `DD_SERVICE` | `serviceextensions` | Service name shown in the Datadog UI. |


Configure the connection from the external processor to the Datadog Agent using these environment variables:

| Environment variable | Default value | Description |
|----------------------------------------|---------------|----------------------------------------------------------------------------------|
| `DD_AGENT_HOST` | `localhost` | Hostname or IP of your Datadog Agent. |
| `DD_TRACE_AGENT_PORT` | `8126` | Port of the Datadog Agent for trace collection. |

The External Processor is built on top of the [Datadog Go Tracer][7] and inherits all of its environment variables. See [Configuring the Go Tracing Library][8] and [App and API Protection Library Configuration][9].

<div class="alert alert-danger">
<strong>Note:</strong> As the Datadog External Processor is built on top of the Datadog Go Tracer, it generally follows the same release process as the tracer, and its Docker images are tagged with the corresponding tracer version (for example, <code>v2.2.2</code>). In some cases, early release versions might be published between official tracer releases, and these images are tagged with a suffix such as <code>-docker.1</code>.
</div>

### 2. Configure an EnvoyExtensionPolicy

Use an `EnvoyExtensionPolicy` to instruct Envoy Gateway to call the Datadog external processor. You can attach the policy to a Gateway or to specific HTTPRoute/GRPCRoute resources.

This sends all traffic on the selected Gateway to the external processor. Here is an example manifest (`datadog-aap-extproc-eep.yaml`):

```yaml
apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyExtensionPolicy
metadata:
name: datadog-aap-extproc-eep
namespace: <your-preferred-namespace> # same namespace as the Gateway
spec:
targetRefs:
# Target the entire Gateway
- group: gateway.networking.k8s.io
kind: Gateway
name: <your-gateway-name> # update to your specific gateway name
# Target specific HTTPRoutes/GRPCRoutes
#- group: gateway.networking.k8s.io
# kind: HTTPRoute
# name: <your-http-route-name>
extProc:
- backendRefs:
- group: ""
kind: Service
name: datadog-aap-extproc-service
namespace: <your-preferred-namespace> # namespace of the external processor Service
port: 443

# Optional: Enable fail open mode. Default is false.
# Normally, if the external processor fails or times out, the filter fails and Envoy
# returns a 5xx error to the downstream client. Setting this to true allows requests
# to continue without error if a failure occurs.
failOpen: true

# Optional: Set a timeout by processing message. Default is 200ms.
# There is a maxium of 2 messages per requests with headers only and 4 messages maximum
# with body processing enabled.
# Note: This timeout also includes the data communication between Envoy and the external processor.
# The timeout should be adjusted to accommodate the additional possible processing time.
# Larger payloads will require a longer timeout.
messageTimeout: 200ms

processingMode:
# The external processor can dynamically override the processing mode as needed, instructing
# Envoy to forward request and response bodies to the external processor.
allowModeOverride: true
# Only enable the request and response header modes by default.
request: {}
response: {}
```

#### Cross‑namespace reference

If your external processor `Service` is in a **different namespace** than the policy, add a [ReferenceGrant][10] in the processor’s namespace. For example, you can do this with a manifest such as `datadog-aap-eep-rg.yaml`.

```yaml
apiVersion: gateway.networking.k8s.io/v1beta1
kind: ReferenceGrant
metadata:
name: datadog-aap-eep-rg
namespace: <your-extproc-namespace> # namespace of the external processor Service
spec:
from:
- group: gateway.envoyproxy.io
kind: EnvoyExtensionPolicy
namespace: <your-policy-namespace> # namespace of the EnvoyExtensionPolicy (and the Gateway)
to:
- group: ""
kind: Service
name: datadog-aap-extproc-service
```

### Validation

After applying the policy, traffic through the targeted Gateway/Routes is inspected by App and API Protection.

{{% appsec-getstarted-2-plusrisk %}}

{{< img src="/security/application_security/appsec-getstarted-threat-and-vuln_2.mp4" alt="Video showing Signals explorer and details, and Vulnerabilities explorer and details." video="true" >}}

## Limitations

The Envoy Gateway integration has the following limitations:

* Observability mode (asynchronous analysis) is not available for Envoy Gateway.

For additional details on the Envoy Gateway integration compatibilities, refer to the [Envoy Gateway integration compatibility page][11].

## Further Reading

{{< partial name="whats-next/whats-next.html" >}}

[1]: https://gateway.envoyproxy.io/docs/
[2]: /containers/kubernetes/installation/?tab=datadogoperator
[3]: /agent/remote_config/?tab=helm#enabling-remote-configuration
[4]: /tracing/guide/setting_up_apm_with_kubernetes_service/?tab=datadogoperator
[5]: /tracing/guide/setting_up_apm_with_kubernetes_service/?tab=datadogoperator#cluster-agent-admission-controller
[6]: https://github.com/DataDog/dd-trace-go/pkgs/container/dd-trace-go%2Fservice-extensions-callout
[7]: https://github.com/DataDog/dd-trace-go
[8]: /tracing/trace_collection/library_config/go/
[9]: /security/application_security/policies/library_configuration/
[10]: https://gateway-api.sigs.k8s.io/api-types/referencegrant/
[11]: /security/application_security/setup/compatibility/envoy-gateway
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@ Learn how to set up App and API Protection (AAP) on your Kubernetes services by
<span>Send us a request for your missing environment <a href="https://forms.gle/nMGq2Hhe7Z4sCKdy6">here</a>.</span>
</div>

{{< appsec-integrations >}}
{{< appsec-integration name="Istio" avatar="istio" link="/security/application_security/setup/istio" >}}
{{< appsec-integration name="Envoy Gateway" avatar="envoy" link="/security/application_security/setup/envoy-gateway" >}}
{{< appsec-integration name="Gateway API" src="integrations_logos/gateway-api_avatar.svg" link="/security/application_security/setup/gateway-api" >}}
{{< /appsec-integrations >}}

## Languages

{{< appsec-integrations >}}
{{< appsec-integration name="Python" avatar="python" link="/security/application_security/setup/python/kubernetes" >}}
{{< appsec-integration name="Node.js" avatar="node" link="/security/application_security/setup/nodejs/kubernetes" >}}
Expand All @@ -41,7 +49,6 @@ Learn how to set up App and API Protection (AAP) on your Kubernetes services by
{{< appsec-integrations >}}
{{< appsec-integration name="NGINX" avatar="nginx" link="/security/application_security/setup/nginx/kubernetes" >}}
{{< appsec-integration name="Envoy" avatar="envoy" link="/security/application_security/setup/envoy" >}}
{{< appsec-integration name="Istio" avatar="istio" link="/security/application_security/setup/istio" >}}
{{< /appsec-integrations >}}


Expand Down
Loading