Skip to content
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

chore: update naming and use crs-version where needed #112

Merged
merged 9 commits into from
Feb 14, 2024
Merged

Conversation

fzipi
Copy link
Member

@fzipi fzipi commented Feb 13, 2024

  • use crs-version parameter to generate documentation
  • change naming from owasp-modsecurity-crs to coreruleset

@fzipi fzipi requested a review from RedXanadu February 13, 2024 13:24
@dune73
Copy link
Member

dune73 commented Feb 13, 2024

Why do you do a folder coreruleset instead of crs?

@fzipi
Copy link
Member Author

fzipi commented Feb 13, 2024

That's how we provide our tarballs. If we want to rename everything, we can, but not before tomorrow, right?

We need to rename our main repo from coreruleset/coreruleset to coreruleset/crs, basically. And change everything around (docs, wiki, installer, links).

@dune73
Copy link
Member

dune73 commented Feb 13, 2024

No, that's not what I am talking about. I'm talking about

tar -zxvf v{{< param crs_latest_release >}}.tar.gz -C /etc/httpd/modsecurity.d/coreruleset

If you do this to mirror the repo name, then cool. But it's obviously an arbitrary choice (and better than owasp-modsecurity-crs.

@fzipi
Copy link
Member Author

fzipi commented Feb 13, 2024

What about now?

@dune73
Copy link
Member

dune73 commented Feb 13, 2024

Very good thanks.

What I see still missing is the plugins includes. Going to comment in code.

@dune73
Copy link
Member

dune73 commented Feb 13, 2024

Ah, no, need to comment here, since you did not touch those lines:


Include modsecurity.d/crs/crs-setup.conf

Include modsecurity.d/crs/plugins/*-config.conf
Include modsecurity.d/crs/plugins/*-before.conf

Include modsecurity.d/crs/rules/*.conf

Include modsecurity.d/crs/plugins/*-after.conf


Add plugins syntax.
@fzipi
Copy link
Member Author

fzipi commented Feb 13, 2024

What about the nginx version?

@fzipi
Copy link
Member Author

fzipi commented Feb 13, 2024

ping @dune73

@dune73
Copy link
Member

dune73 commented Feb 13, 2024

Sorry, I do not get the question. What's with nginx? Same layout, I think.

@fzipi
Copy link
Member Author

fzipi commented Feb 13, 2024

So include works the same way in nginx?

@dune73
Copy link
Member

dune73 commented Feb 13, 2024

@airween could you please confirm?

@dune73
Copy link
Member

dune73 commented Feb 14, 2024

There is a problem with the tar now:

tar -zxvf v{{< param crs_latest_release >}}.tar.gz -C /etc/httpd/modsecurity.d/crs

We're likely ending up with something along modsecurity.d/crs/coreruleset-nightly.

Not sure how we want to deal with this.

@dune73
Copy link
Member

dune73 commented Feb 14, 2024

The extended install lacks the extraction step.

I suggest to fix the tar above and then to copy that over to the extended install.

@fzipi fzipi force-pushed the use-crs-version branch 4 times, most recently from 45a028f to 7df71c7 Compare February 14, 2024 14:04
Signed-off-by: Felipe Zipitria <[email protected]>
@dune73
Copy link
Member

dune73 commented Feb 14, 2024

Please update gpg --verify coreruleset-3.3.2.tar.gz.asc v3.3.2.tar.gz to v4. (can't comment in the file since you did not touch this).

dune73
dune73 previously requested changes Feb 14, 2024
config/_default/config.toml Outdated Show resolved Hide resolved
content/deployment/quick_start.md Show resolved Hide resolved
Signed-off-by: Felipe Zipitria <[email protected]>
@fzipi fzipi requested a review from dune73 February 14, 2024 14:40
Signed-off-by: Felipe Zipitria <[email protected]>
@fzipi fzipi dismissed dune73’s stale review February 14, 2024 14:46

we can't until release.

@airween
Copy link
Contributor

airween commented Feb 14, 2024

Ah, no, need to comment here, since you did not touch those lines:


Include modsecurity.d/crs/crs-setup.conf

Include modsecurity.d/crs/plugins/*-config.conf
Include modsecurity.d/crs/plugins/*-before.conf

Include modsecurity.d/crs/rules/*.conf

Include modsecurity.d/crs/plugins/*-after.conf

This works for me with Nginx (with different directory name) - but everything is the same.

Include /PATH/TO/CRS/crs-setup.conf

Include /PATH/TO/CRS/plugins/*-config.conf
Include /PATH/TO/CRS/plugins/*-before.conf

Include /PATH/TO/CRS/rules/*.conf

Include /PATH/TO/CRS/plugins/*-after.conf

@fzipi
Copy link
Member Author

fzipi commented Feb 14, 2024

Then this Include simplifies everything. But there is no IncludeOptional... right? So it may fail if you don't have plugins.

@airween
Copy link
Contributor

airween commented Feb 14, 2024

Then this Include simplifies everything. But there is no IncludeOptional... right? So it may fail if you don't have plugins.

Yes, Nginx does not support IncludeOptional at all.

@dune73
Copy link
Member

dune73 commented Feb 14, 2024

That's why we ship with

dune73@leander plugins>l
total 12K
drwxr-xr-x  2 dune73 dune73 4.0K Nov 23 09:38 .
drwxr-xr-x 10 dune73 dune73 4.0K Feb 14 14:41 ..
-rw-r--r--  1 dune73 dune73    0 Nov 23 09:38 empty-after.conf
-rw-r--r--  1 dune73 dune73    0 Nov 23 09:38 empty-before.conf
-rw-r--r--  1 dune73 dune73    0 Nov 23 09:38 empty-config.conf

@fzipi
Copy link
Member Author

fzipi commented Feb 14, 2024

All reviews addressed now.

@dune73
Copy link
Member

dune73 commented Feb 14, 2024

OK, then let's go. We can always update again for the website.

@dune73 dune73 merged commit 80df015 into main Feb 14, 2024
1 check passed
@fzipi fzipi deleted the use-crs-version branch February 14, 2024 14:59
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