Skip to content

Conversation

ADubhlaoich
Copy link
Member

@ADubhlaoich ADubhlaoich commented Jan 27, 2025

Proposed changes

Full description pending.

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • I have updated any relevant documentation (README.md and CHANGELOG.md)
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation.

Please refer to our style guide for guidance about placeholder content.

mouraddmeiri and others added 2 commits January 27, 2025 13:47
…109)

As part of the NGINX App Protect WAF 5.5 release, Alpine 1.19 support has been
added. This commit updates the relevant sections of documentation that mention
Alpine support, while also fixing up the metadata for some related pages.
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/112/

@ADubhlaoich ADubhlaoich marked this pull request as ready for review January 28, 2025 09:25
@ADubhlaoich ADubhlaoich requested a review from a team as a code owner January 28, 2025 09:25
Copy link
Contributor

@kudriavitsky kudriavitsky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove "detectDistributedBruteForceAttack" : true, from policy example in v4 and v5

resharp the comment for an upgrade to a specific version of AS/BS/TC
adding a note to upgrade to a specific version
@mjang mjang self-requested a review January 30, 2025 17:17
@mjang mjang merged commit 2df3f9a into main Jan 30, 2025
8 checks passed
@mjang mjang deleted the nap-release-5.5 branch January 30, 2025 19:06

Brute force attacks are attempts to break in to secured areas of a web application by trying exhaustive,
systematic, username/password combinations to discover legitimate authentication credentials.
To prevent brute force attacks, WAF tracks the number of failed attempts to reach login pages

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In most of the other references to "WAF" in this guide it is "Nginx App Protect (NAP) WAF"


bruteForceProtectionForAllLoginPages:
When enabled, enables Brute Force Protection for all configured login URLs.
When disabled, only brute force configurations for specific login pages are applied in case they exist.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the order doesn't matter, put the url entry next to this, and reference the url entry (which is the url to fill in case this is false)
so instead "When disabled, only brute force configurations for specific login pages are applied in case they exist.
"
I think it should be something like:
"When disabled, the url entry below should contain a url that is defined as a login page".

When disabled, only brute force configurations for specific login pages are applied in case they exist.

detectionCriteria:
Specifies configuration for detecting distributed brute force attacks.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we sure that this is only for the distributed attack? If so, there should be more explanation about distributed.
It should be something in the lines of:
"This section describe a distributed attack detection where the system see many failed login but can't detect a specific username or IP address causing this. In this case, since the detection applies to all the users, the only mitigation possible is to alert".


failedLoginAttemptsRateReached:
After configured threshold (number of failed login attempts within measurementPeriod) defined
action will be applied for the next login attempt.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action will not be exactly on the next login applied. (as the decision is happening on a different thread). I would write that a brute force attack will be detected.

action will be applied for the next login attempt.

loginAttemptsFromTheSameUser:
Specifies configuration for detecting brute force attacks for Username.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Username shouldn't be captial letter. Should be "for a specific username".


action:
Specifies action that is applied when defined threshold is reached.
- **alarm**: The system will log the login attempt.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why don't we block in this case.

When enabled, the system counts failed login attempts for each Username.

threshold:
After configured threshold (number of failed login attempts for each Username) defined

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also here, don't write "the next login attempts. It will be one of the next login attempts".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants