Skip to content

Commit 94550d2

Browse files
committed
feat: Add tech specs details, terminology
1 parent 901c42c commit 94550d2

File tree

9 files changed

+65
-7
lines changed

9 files changed

+65
-7
lines changed

content/waf/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Updating the content of this page will likely be automated in the future, follow
2222

2323
{{</ call-out>}}
2424

25-
This changelog lists all of the information for F5 NGINX App Protect WAF releases in 2025.
25+
This changelog lists all of the information for F5 WAF for NGINX releases in 2025.
2626

2727
For older releases, check the changelogs for previous years: [2024](), [2023]().
2828

content/waf/fundamentals/technical-specifications.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,17 @@ View the [Install section]({{< ref "/waf/install/" >}}) for information on deplo
4040

4141
## Supported operating systems
4242

43-
## Supported NGINX versions
43+
| Distribution | Version |
44+
| ------------------ | ------------ |
45+
| Alpine Linux | 3.19 |
46+
| Amazon Linux | 2023 |
47+
| Debian | 11, 12 |
48+
| Oracle Linux | 8.1 |
49+
| Ubuntu | 22.04, 24.04 |
50+
| RHEL / Rocky Linux | 8, 9 |
51+
52+
For release-specific packages, view the [Changelog]({{< ref "/waf/changelog.md" >}}).
53+
4454

4555
## Supported Security Policy features
4656

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
# We use sentence case and present imperative tone
3+
title: "Terminology"
4+
# Weights are assigned in increments of 100: determines sorting order
5+
weight: 300
6+
# Creates a table of contents and sidebar, useful for large documents
7+
toc: false
8+
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
9+
nd-content-type: reference
10+
# Intended for internal catalogue and search, case sensitive:
11+
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
12+
nd-product: NAP-WAF
13+
---
14+
15+
This page defines terminology used when describing functionality of F5 WAF for NGINX.
16+
17+
It assumes you are familiar with various layer 7 (L7) hypertext transfer protocl (HTTP) concepts such as:
18+
19+
- Uniform Resource Identifier (URI)
20+
- Uniform Resource Location (URL)
21+
- HTTP methods and status codes
22+
- HTTP headings, requests, responses, and parameters
23+
- Cookies
24+
25+
## Terms and definitions
26+
27+
|Term | Definition |
28+
| ---| --- |
29+
|Alarm | If selected, the NGINX App Protect WAF system records requests that trigger the violation in the remote log (depending on the settings of the logging profile). |
30+
|Attack signature | Textual patterns which can be applied to HTTP requests and/or responses by NGINX App Protect WAF to determine if traffic is malicious. For example, the string `<script>` inside an HTTP request triggers an attack signature violation. |
31+
|Attack signature set | A collection of attack signatures designed for a specific purpose (such as Apache). |
32+
|Bot signatures | Textual patterns which can be applied to an HTTP request's User Agent or URI by NGINX App Protect WAF to determine if traffic is coming from a browser or a bot (trusted, untrusted or malicious). For example, the string `googlebot` inside the User-Agent header will be classified as `trusted bot`, and the string `Bichoo Spider` will be classified as `malicious bot`. |
33+
|Block | To prevent a request from reaching a protected web application. If selected (and enforcement mode is set to Blocking), NGINX App Protect WAF blocks requests that trigger the violation. |
34+
|Blocking response page | A blocking response page is displayed to a client when a request from that client has been blocked. Also called blocking page and response page. |
35+
|Enforcement mode | Security policies can be in one of two enforcement modes:<ul><li>**Transparent mode** In Transparent mode, Blocking is disabled for the security policy. Traffic is not blocked even if a violation is triggered with block flag enabled. You can use this mode when you first put a security policy into effect to make sure that no false positives occur that would stop legitimate traffic.</li><li>**Blocking mode** In Blocking mode, Blocking is enabled for the security policy, and you can enable or disable the Block setting for individual violations. Traffic is blocked when a violation occurs if you configure the system to block that type of violation. You can use this mode when you are ready to enforce the security policy. You can change the enforcement mode for a security policy in the security policy JSON file.</li></ul> |
36+
|Entities | The elements of a security policy, such as HTTP methods, as well as file types, URLs, and/or parameters, which have attributes such as byte length. Also refers to elements of a security policy for which enforcement can be turned on or off, such as an attack signature. |
37+
|False positive | An instance when NGINX App Protect WAF treats a legitimate request as a violation. |
38+
|File types | Examples of file types are .php, .asp, .gif, and .txt. They are the extensions for many objects that make up a web application. File Types are one type of entity a NGINX App Protect WAF policy contains. |
39+
|Illegal request | A request which violates a security policy |
40+
|Legal request | A request which has not violated the security policy. |
41+
|Loosening | The process of adapting a security policy to allow specific entities such as File Types, URLs, and Parameters. The term also applies to attack signatures, which can be manually disabled — effectively removing the signature from triggering any violations. |
42+
|Parameters | Parameters consist of "name=value" pairs, such as OrderID=10. The parameters appear in the query string and/or POST data of an HTTP request. Consequently, they are of particular interest to NGINX App Protect WAF because they represent inputs to the web application. |
43+
|TPS/RPS | Transactions per second (TPS)/requests per second (RPS). In NGINX App Protect WAF, these terms are used interchangeably. |
44+
|Tuning | Making manual changes to an existing security policy to reduce false positives and increase the policy’s security level. |
45+
|URI/URL | The Uniform Resource Identifier (URI) specifies the name of a web object in a request. A Uniform Resource Locator (URL) specifies the location of an object on the Internet. For example, in the web address, `http://www.siterequest.com/index.html`, index.html is the URI, and the URL is `http://www.siterequest.com/index.html`. In NGINX App Protect WAF, the terms URI and URL are used interchangeably. |
46+
|Violation | Violations occur when some aspect of a request or response does not comply with the security policy. You can configure the blocking settings for any violation in a security policy. When a violation occurs, the system can Alarm or Block a request (blocking is only available when the enforcement mode is set to Blocking). |

content/waf/kubernetes/build-nic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# We use sentence case and present imperative tone
3-
title: "Build NGINX App Protect WAF with NGINX Ingress Controller"
3+
title: "Build F5 WAF with NGINX Ingress Controller"
44
# Weights are assigned in increments of 100: determines sorting order
55
weight: 200
66
# Creates a table of contents and sidebar, useful for large documents

content/waf/kubernetes/configure-nic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# We use sentence case and present imperative tone
3-
title: "Configure NGINX App Protect WAF with NGINX Ingress Controller"
3+
title: "Configure F5 WAF with NGINX Ingress Controller"
44
# Weights are assigned in increments of 100: determines sorting order
55
weight: 300
66
# Creates a table of contents and sidebar, useful for large documents

content/waf/kubernetes/install-nic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# We use sentence case and present imperative tone
3-
title: "Install NGINX App Protect and NGINX Ingress Controller with Docker and Helm"
3+
title: "Install F5 WAF and NGINX Ingress Controller with Docker and Helm"
44
# Weights are assigned in increments of 100: determines sorting order
55
weight: 100
66
# Creates a table of contents and sidebar, useful for large documents

content/waf/kubernetes/nim-policy-compile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# We use sentence case and present imperative tone
3-
title: "Compile NGINX App Protect WAF policies for NGINX Ingress Controller"
3+
title: "Compile F5 WAF policies for NGINX Ingress Controller"
44
# Weights are assigned in increments of 100: determines sorting order
55
weight: 400
66
# Creates a table of contents and sidebar, useful for large documents

content/waf/policies/configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,6 @@ Outside of the overlapping information for Policy configuration, the existing pa
2020

2121
{{</ call-out>}}
2222

23+
This page describes the security features available with F5 WAF for NGINX and how to enable them.
24+
2325
## Supported Security Policy features

content/waf/support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: "Support"
44
# Weights are assigned in increments of 100: determines sorting order
55
weight: 900
66
# Creates a table of contents and sidebar, useful for large documents
7-
toc: true
7+
toc: false
88
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
99
nd-content-type: how-to
1010
# Intended for internal catalogue and search, case sensitive:

0 commit comments

Comments
 (0)