Skip to content

Commit 74b7600

Browse files
DOCS-3469 Added info about SSL/TLS certificates
1 parent da63648 commit 74b7600

11 files changed

Lines changed: 80 additions & 3 deletions

File tree

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
--8<-- "latest/admin-en/ssl-certificates.md"

docs/6.x/installation/cloud-platforms/aws/ami.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,5 +36,6 @@
3636
[nginx-native-node]: ../../../installation/nginx-native-node-internals.md
3737
[wallarm-logs]: ../../../admin-en/configure-logging.md
3838
[log-level]: ../../../installation/native-node/all-in-one-conf.md#loglevel
39+
[ssl-certificates]: ../../../admin-en/ssl-certificates.md
3940

4041
--8<-- "latest/installation/inline/compute-instances/aws/aws-ami.md"

docs/6.x/installation/inline/compute-instances/aws/aws-ami.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,6 @@ search:
4343
[wallarm-logs]: ../../../../admin-en/configure-logging.md
4444
[log-level]: ../../../../installation/native-node/all-in-one-conf.md#loglevel
4545
[link-wallarm-health-check]: ../../../../admin-en/uat-checklist-en.md
46-
46+
[ssl-certificates]: ../../../../admin-en/ssl-certificates.md
4747

4848
--8<-- "latest/installation/inline/compute-instances/aws/aws-ami.md"

docs/6.x/installation/inline/compute-instances/gcp/machine-image.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,6 @@ search:
3030
[ip-lists-docs]: ../../../../user-guides/ip-lists/overview.md
3131
[api-spec-enforcement-docs]: ../../../../api-specification-enforcement/overview.md
3232
[inline-docs]: ../../overview.md
33+
[ssl-certificates]: ../../../../admin-en/ssl-certificates.md
3334

3435
--8<-- "latest/installation/inline/compute-instances/gcp/machine-image.md"

docs/6.x/installation/inline/compute-instances/linux/all-in-one.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,5 +44,6 @@ search:
4444
[vuln-detection-docs]: ../../../../about-wallarm/detecting-vulnerabilities.md
4545
[masking-sensitive-data-rule]: ../../../../user-guides/rules/sensitive-data-rule.md
4646
[link-wallarm-health-check]: ../../../../admin-en/uat-checklist-en.md
47+
[ssl-certificates]: ../../../../admin-en/ssl-certificates.md
4748

4849
--8<-- "latest/installation/inline/compute-instances/linux/all-in-one.md"

docs/6.x/installation/nginx/all-in-one.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,6 @@
4141
[vuln-detection-docs]: ../../about-wallarm/detecting-vulnerabilities.md
4242
[masking-sensitive-data-rule]: ../../user-guides/rules/sensitive-data-rule.md
4343
[link-wallarm-health-check]: ../../admin-en/uat-checklist-en.md
44+
[ssl-certificates]: ../../admin-en/ssl-certificates.md
4445

4546
--8<-- "latest/installation/inline/compute-instances/linux/all-in-one.md"

docs/6.x/installation/packages/aws-ami.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,6 @@ search:
4141
[nginx-native-node]: ../../installation/nginx-native-node-internals.md
4242
[wallarm-logs]: ../../admin-en/configure-logging.md
4343
[log-level]: ../../installation/native-node/all-in-one-conf.md#loglevel
44-
44+
[ssl-certificates]: ../../admin-en/ssl-certificates.md
4545

4646
--8<-- "latest/installation/inline/compute-instances/aws/aws-ami.md"

docs/6.x/installation/packages/gcp-machine-image.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,6 @@ search:
3131
[api-spec-enforcement-docs]: ../../api-specification-enforcement/overview.md
3232
[inline-docs]: ../inline/overview.md
3333
[link-wallarm-health-check]: ../../admin-en/uat-checklist-en.md
34+
[ssl-certificates]: ../../admin-en/ssl-certificates.md
3435

3536
--8<-- "latest/installation/inline/compute-instances/gcp/machine-image.md"
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
[nginx-sidecar]: ../installation/kubernetes/sidecar-proxy/deployment.md
2+
[ssl-termination]: ../installation/kubernetes/sidecar-proxy/customization.md#ssltls-termination
3+
[nginx-aio]: ../installation/inline/compute-instances/linux/all-in-one.md
4+
[nginx-docker]: ../admin-en/installation-docker-en.md
5+
6+
7+
# SSL/TLS Certificate Management
8+
9+
This article explains what certificates are required, how to manage certificates, how Wallarm nodes handle HTTPS traffic, and where and how to terminate SSL/TLS.
10+
11+
## Certificate requirements
12+
13+
* Supported format: PEM for both certificate and private key files.
14+
* Key types and sizes: Any key size supported by OpenSSL/NGINX, including 2048-bit, 4096-bit, and ECDSA keys.
15+
* Cipher suites: Defined and managed through standard NGINX/OpenSSL configuration.
16+
17+
## Certificate issuance and management
18+
19+
Wallarm does not issue, manage, or automatically renew certificates. All certificates must be provided and managed by clients.
20+
21+
You need to:
22+
23+
1. Issue a certificate from a trusted Certificate Authority (CA).
24+
1. Deploy the certificate to Wallarm nodes.
25+
1. Renew the certificate before it expires.
26+
27+
To automate these actions, you can use external tools, e.g., [Certbot](https://certbot.eff.org/), [HashiCorp Vault](https://developer.hashicorp.com/vault), [Kubernetes cert-manager](https://cert-manager.io/), [Ansible playbooks](https://docs.ansible.com/projects/ansible/devel/playbook_guide/playbooks_intro.html), or others.
28+
29+
## SSL/TLS termination
30+
31+
SSL/TLS certificates protect network communications between:
32+
33+
* Wallarm nodes and the Wallarm Cloud
34+
* Wallarm administrators (workstations) and the Wallarm Cloud Console UI and API
35+
36+
By securing these channels, SSL/TLS certificates allow Wallarm to safely decrypt and analyze HTTPS traffic to detect and block threats.
37+
38+
SSL/TLS termination is the process of decrypting encrypted HTTPS traffic at a network endpoint.
39+
40+
Wallarm needs to have decrypted HTTPS traffic to inspect HTTP data (URL, headers, body), detect threats, and block malicious requests.
41+
42+
The configuration and location of SSL/TLS termination depend on your Wallarm [deployment type](../installation/nginx-native-node-internals.md).
43+
44+
### SSL/TLS termination in the NGINX Node
45+
46+
* [Sidecar][nginx-sidecar]
47+
48+
By default, the Wallarm Sidecar solution does not handle SSL/TLS termination. It expects an upstream component (e.g., Ingress or Application Gateway) to handle HTTPS while the Sidecar solution receives plain, decrypted HTTP.
49+
50+
However, if your infrastructure cannot terminate SSL/TLS upstream, you can [enable SSL/TLS termination directly in the Wallarm Sidecar][ssl-termination].
51+
52+
* [All-in-one installer][nginx-aio], [Docker image][nginx-docker], and cloud images:
53+
54+
The NGINX Node handles SSL/TLS termination. In this case, the node acts as an HTTPS endpoint and must be configured with an SSL/TLS certificate and private key. To set up SSL/TLS termination, edit the [NGINX configuration ](https://nginx.org/en/docs/http/configuring_https_servers.html):
55+
56+
* [`ssl_certificate`](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_certificate) - specifies the PEM-format certificate file, including the full certificate chain.
57+
* [`ssl_certificate_key`](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_certificate_key) - specifies the PEM-format private key file.
58+
59+
### SSL/TLS termination in the Native Node
60+
61+
The Native Node **does not handle SSL/TLS termination** and never acts as an inline traffic endpoint. It always analyzes a copy of traffic, not the original client connection.
62+
63+
HTTPS traffic must be decrypted before a copy is sent to the Native Node. SSL/TLS termination is performed by an upstream or adjacent component, e.g., a load balancer, reverse proxy, application delivery controller (ADC), ingress controller, a connector.
64+
65+
The terminating component decrypts HTTPS traffic and sends a decrypted traffic copy to the Native Node for analysis. For configuration details, refer to the documentation of the chosen component.
Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
Update targets of your load balancer to send traffic to the Wallarm instance. For details, please refer to the documentation on your load balancer.
1+
1. If you have secured the communications between the Wallarm node and the Wallarm Cloud with an SSL/TLS certificate, edit the [NGINX configuration ](https://nginx.org/en/docs/http/configuring_https_servers.html) to set up [SSL/TLS termination][ssl-certificates]:
2+
3+
* [`ssl_certificate`](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_certificate) - specifies the PEM-format certificate file, including the full certificate chain.
4+
* [`ssl_certificate_key`](https://nginx.org/en/docs/http/ngx_http_ssl_module.html#ssl_certificate_key) - specifies the PEM-format private key file.
5+
6+
1. Update targets of your load balancer to send traffic to the Wallarm instance. For details, refer to the documentation on your load balancer.

0 commit comments

Comments
 (0)