Skip to content

docs: fix description of HAProxy integrations #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

anotherbridge
Copy link

The description was not working with the current version of coraza-spoa. Therefore it was updated to be usable with the current version v0.3.0 of coraza-spoa!

@anotherbridge anotherbridge requested a review from a team as a code owner August 1, 2025 12:33
@fzipi fzipi changed the title Fix description of HAProxy integrations docs: fix description of HAProxy integrations Aug 1, 2025
@fzipi fzipi requested a review from fionera August 1, 2025 20:17
@fzipi
Copy link
Member

fzipi commented Aug 1, 2025

CC: @fionera can you confirm this is good?


spoe-message coraza-req
args id=unique-id src-ip=src method=method path=path query=query version=req.ver headers=req.hdrs body=req.body
# Arguments are required to be in this order
args app=var(txn.coraza.app) src-ip=src src-port=src_port dst-ip=dst dst-port=dst_port method=method path=path query=query version=req.ver headers=req.hdrs body=req.body
event on-frontend-http-request
Copy link

Choose a reason for hiding this comment

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

This has to be removed

Copy link
Author

Choose a reason for hiding this comment

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

@fionera When removing the changed line with the args HAProxy logs a spoa-error and the logs of the coraza-spoa service are logging the error

PNC failed reading kv entry

Could you therefore, please elaborate on why the args for the coraza-req have to be removed?

Copy link

Choose a reason for hiding this comment

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

I meant to mark the event on-frontend-http-request line. I just pushed the current correct version with corazawaf/coraza-spoa#263

# Download the OWASP CRS from https://github.com/coreruleset/coreruleset/releases
# and copy crs-setup.conf, the rules & plugins directories to /etc/coraza-spoa
directives: |
Include /etc/coraza-spoa/coraza.conf
Copy link

Choose a reason for hiding this comment

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

Do we want to recommend that or the built in version?

      Include @coraza.conf-recommended
      Include @crs-setup.conf.example
      Include @owasp_crs/*.conf

Copy link
Author

Choose a reason for hiding this comment

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

If the builtin version is used, then additionally the description referencing that part SHOULD also be adjusted:

https://github.com/corazawaf/coraza.io/blob/main/content/connectors/coraza-spoa.md?plain=1#L206-213

Copy link

Choose a reason for hiding this comment

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

I never committed anything here as I didn't know it exists 😅. The example files at coraza-spoa are basically where I always point to...

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.

3 participants